f052f43b3b
Change-Id: If04d1155173fba8d3e050f3259da8b3edc60e076
751 خطوط
42 KiB
HTML
751 خطوط
42 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
|
<meta name="generator" content="Doxygen 1.8.6"/>
|
|
<title>HIP: Heterogenous-computing Interface for Portability: Initialization and Version</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<script type="text/javascript">
|
|
$(document).ready(function() { searchBox.OnSelectItem(0); });
|
|
</script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr style="height: 56px;">
|
|
<td style="padding-left: 0.5em;">
|
|
<div id="projectname">HIP: Heterogenous-computing Interface for Portability
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.6 -->
|
|
<script type="text/javascript">
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
</script>
|
|
<div id="navrow1" class="tabs">
|
|
<ul class="tablist">
|
|
<li><a href="index.html"><span>Main Page</span></a></li>
|
|
<li><a href="pages.html"><span>Related Pages</span></a></li>
|
|
<li><a href="modules.html"><span>Modules</span></a></li>
|
|
<li><a href="annotated.html"><span>Classes</span></a></li>
|
|
<li><a href="files.html"><span>Files</span></a></li>
|
|
<li>
|
|
<div id="MSearchBox" class="MSearchBoxInactive">
|
|
<span class="left">
|
|
<img id="MSearchSelect" src="search/mag_sel.png"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
alt=""/>
|
|
<input type="text" id="MSearchField" value="Search" accesskey="S"
|
|
onfocus="searchBox.OnSearchFieldFocus(true)"
|
|
onblur="searchBox.OnSearchFieldFocus(false)"
|
|
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
|
</span><span class="right">
|
|
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
|
|
</span>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(11)"><span class="SelectionMark"> </span>Pages</a></div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</div>
|
|
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#groups">Modules</a> |
|
|
<a href="#func-members">Functions</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">Initialization and Version<div class="ingroups"><a class="el" href="group__API.html">HIP API</a></div></div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="groups"></a>
|
|
Modules</h2></td></tr>
|
|
<tr class="memitem:group__Context"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Context.html">Management</a></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
|
|
Functions</h2></td></tr>
|
|
<tr class="memitem:ga01baa652dda5815c594d047060496caa"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__GlobalDefs.html#gadf5010f6e140a53ecbdf949e73e87594">hipError_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Driver.html#ga01baa652dda5815c594d047060496caa">hipInit</a> (unsigned int flags)</td></tr>
|
|
<tr class="memdesc:ga01baa652dda5815c594d047060496caa"><td class="mdescLeft"> </td><td class="mdescRight">Explicitly initializes the HIP runtime. <a href="#ga01baa652dda5815c594d047060496caa">More...</a><br/></td></tr>
|
|
<tr class="separator:ga01baa652dda5815c594d047060496caa"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gadf6c74aaf7c22fea80e9ac3400d43704"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__GlobalDefs.html#gadf5010f6e140a53ecbdf949e73e87594">hipError_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Driver.html#gadf6c74aaf7c22fea80e9ac3400d43704">hipDeviceGet</a> (<a class="el" href="classihipDevice__t.html">hipDevice_t</a> *device, int ordinal)</td></tr>
|
|
<tr class="memdesc:gadf6c74aaf7c22fea80e9ac3400d43704"><td class="mdescLeft"> </td><td class="mdescRight">Returns a handle to a compute device. <a href="#gadf6c74aaf7c22fea80e9ac3400d43704">More...</a><br/></td></tr>
|
|
<tr class="separator:gadf6c74aaf7c22fea80e9ac3400d43704"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga0a1cf94d2b571ca3279577d5af0d1672"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__GlobalDefs.html#gadf5010f6e140a53ecbdf949e73e87594">hipError_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Driver.html#ga0a1cf94d2b571ca3279577d5af0d1672">hipDeviceComputeCapability</a> (int *major, int *minor, <a class="el" href="classihipDevice__t.html">hipDevice_t</a> device)</td></tr>
|
|
<tr class="memdesc:ga0a1cf94d2b571ca3279577d5af0d1672"><td class="mdescLeft"> </td><td class="mdescRight">Returns the compute capability of the device. <a href="#ga0a1cf94d2b571ca3279577d5af0d1672">More...</a><br/></td></tr>
|
|
<tr class="separator:ga0a1cf94d2b571ca3279577d5af0d1672"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga24df15e180a7b2b351cd362e5b7d2dac"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__GlobalDefs.html#gadf5010f6e140a53ecbdf949e73e87594">hipError_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Driver.html#ga24df15e180a7b2b351cd362e5b7d2dac">hipDeviceGetName</a> (char *name, int len, <a class="el" href="classihipDevice__t.html">hipDevice_t</a> device)</td></tr>
|
|
<tr class="memdesc:ga24df15e180a7b2b351cd362e5b7d2dac"><td class="mdescLeft"> </td><td class="mdescRight">Returns an identifer string for the device. <a href="#ga24df15e180a7b2b351cd362e5b7d2dac">More...</a><br/></td></tr>
|
|
<tr class="separator:ga24df15e180a7b2b351cd362e5b7d2dac"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gaaa961c8ec8047903617f4245fa50256a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__GlobalDefs.html#gadf5010f6e140a53ecbdf949e73e87594">hipError_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Driver.html#gaaa961c8ec8047903617f4245fa50256a">hipDeviceGetPCIBusId</a> (char *pciBusId, int len, int device)</td></tr>
|
|
<tr class="memdesc:gaaa961c8ec8047903617f4245fa50256a"><td class="mdescLeft"> </td><td class="mdescRight">Returns a PCI Bus Id string for the device, overloaded to take int device ID. <a href="#gaaa961c8ec8047903617f4245fa50256a">More...</a><br/></td></tr>
|
|
<tr class="separator:gaaa961c8ec8047903617f4245fa50256a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gafe08d5632ebd24edc26a19da380b2120"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__GlobalDefs.html#gadf5010f6e140a53ecbdf949e73e87594">hipError_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Driver.html#gafe08d5632ebd24edc26a19da380b2120">hipDeviceGetByPCIBusId</a> (int *device, const int *pciBusId)</td></tr>
|
|
<tr class="memdesc:gafe08d5632ebd24edc26a19da380b2120"><td class="mdescLeft"> </td><td class="mdescRight">Returns a handle to a compute device. <a href="#gafe08d5632ebd24edc26a19da380b2120">More...</a><br/></td></tr>
|
|
<tr class="separator:gafe08d5632ebd24edc26a19da380b2120"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga8991e535d0ef1ead0524e73364623041"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__GlobalDefs.html#gadf5010f6e140a53ecbdf949e73e87594">hipError_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Driver.html#ga8991e535d0ef1ead0524e73364623041">hipDeviceTotalMem</a> (size_t *bytes, <a class="el" href="classihipDevice__t.html">hipDevice_t</a> device)</td></tr>
|
|
<tr class="memdesc:ga8991e535d0ef1ead0524e73364623041"><td class="mdescLeft"> </td><td class="mdescRight">Returns the total amount of memory on the device. <a href="#ga8991e535d0ef1ead0524e73364623041">More...</a><br/></td></tr>
|
|
<tr class="separator:ga8991e535d0ef1ead0524e73364623041"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gaf6c342f52d2a29a0aca5cdd89b4dd47c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__GlobalDefs.html#gadf5010f6e140a53ecbdf949e73e87594">hipError_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Driver.html#gaf6c342f52d2a29a0aca5cdd89b4dd47c">hipDriverGetVersion</a> (int *driverVersion)</td></tr>
|
|
<tr class="memdesc:gaf6c342f52d2a29a0aca5cdd89b4dd47c"><td class="mdescLeft"> </td><td class="mdescRight">Returns the approximate HIP driver version. <a href="#gaf6c342f52d2a29a0aca5cdd89b4dd47c">More...</a><br/></td></tr>
|
|
<tr class="separator:gaf6c342f52d2a29a0aca5cdd89b4dd47c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gae8b7ba34d2e11e334650aa51a4dd87ee"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__GlobalDefs.html#gadf5010f6e140a53ecbdf949e73e87594">hipError_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Driver.html#gae8b7ba34d2e11e334650aa51a4dd87ee">hipRuntimeGetVersion</a> (int *runtimeVersion)</td></tr>
|
|
<tr class="memdesc:gae8b7ba34d2e11e334650aa51a4dd87ee"><td class="mdescLeft"> </td><td class="mdescRight">Returns the approximate HIP Runtime version. <a href="#gae8b7ba34d2e11e334650aa51a4dd87ee">More...</a><br/></td></tr>
|
|
<tr class="separator:gae8b7ba34d2e11e334650aa51a4dd87ee"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga31d806d976e91d36bd990ae3004d8760"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__GlobalDefs.html#gadf5010f6e140a53ecbdf949e73e87594">hipError_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Driver.html#ga31d806d976e91d36bd990ae3004d8760">hipModuleLoad</a> (<a class="el" href="classihipModule__t.html">hipModule_t</a> *module, const char *fname)</td></tr>
|
|
<tr class="memdesc:ga31d806d976e91d36bd990ae3004d8760"><td class="mdescLeft"> </td><td class="mdescRight">Loads code object from file into a hipModule_t. <a href="#ga31d806d976e91d36bd990ae3004d8760">More...</a><br/></td></tr>
|
|
<tr class="separator:ga31d806d976e91d36bd990ae3004d8760"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gae58e345f55bb3ec13dca80d2df88e0ed"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__GlobalDefs.html#gadf5010f6e140a53ecbdf949e73e87594">hipError_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Driver.html#gae58e345f55bb3ec13dca80d2df88e0ed">hipModuleUnload</a> (<a class="el" href="classihipModule__t.html">hipModule_t</a> module)</td></tr>
|
|
<tr class="memdesc:gae58e345f55bb3ec13dca80d2df88e0ed"><td class="mdescLeft"> </td><td class="mdescRight">Frees the module. <a href="#gae58e345f55bb3ec13dca80d2df88e0ed">More...</a><br/></td></tr>
|
|
<tr class="separator:gae58e345f55bb3ec13dca80d2df88e0ed"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga9648b457bb837838cb936b417b56a65d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__GlobalDefs.html#gadf5010f6e140a53ecbdf949e73e87594">hipError_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Driver.html#ga9648b457bb837838cb936b417b56a65d">hipModuleGetFunction</a> (<a class="el" href="classihipFunction__t.html">hipFunction_t</a> *function, <a class="el" href="classihipModule__t.html">hipModule_t</a> module, const char *kname)</td></tr>
|
|
<tr class="memdesc:ga9648b457bb837838cb936b417b56a65d"><td class="mdescLeft"> </td><td class="mdescRight">Function with kname will be extracted if present in module. <a href="#ga9648b457bb837838cb936b417b56a65d">More...</a><br/></td></tr>
|
|
<tr class="separator:ga9648b457bb837838cb936b417b56a65d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga3e425a680285f495e776f096e9632c89"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__GlobalDefs.html#gadf5010f6e140a53ecbdf949e73e87594">hipError_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Driver.html#ga3e425a680285f495e776f096e9632c89">hipModuleGetGlobal</a> (hipDeviceptr_t *dptr, size_t *bytes, <a class="el" href="classihipModule__t.html">hipModule_t</a> hmod, const char *name)</td></tr>
|
|
<tr class="memdesc:ga3e425a680285f495e776f096e9632c89"><td class="mdescLeft"> </td><td class="mdescRight">returns device memory pointer and size of the kernel present in the module with symbol <code>name</code> <a href="#ga3e425a680285f495e776f096e9632c89">More...</a><br/></td></tr>
|
|
<tr class="separator:ga3e425a680285f495e776f096e9632c89"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gaabdbd73e952a741e861d01109c4790f3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__GlobalDefs.html#gadf5010f6e140a53ecbdf949e73e87594">hipError_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Driver.html#gaabdbd73e952a741e861d01109c4790f3">hipModuleLoadData</a> (<a class="el" href="classihipModule__t.html">hipModule_t</a> *module, const void *image)</td></tr>
|
|
<tr class="memdesc:gaabdbd73e952a741e861d01109c4790f3"><td class="mdescLeft"> </td><td class="mdescRight">builds module from code object which resides in host memory. Image is pointer to that location. <a href="#gaabdbd73e952a741e861d01109c4790f3">More...</a><br/></td></tr>
|
|
<tr class="separator:gaabdbd73e952a741e861d01109c4790f3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga2e4de5937aa8171e9eda16c881ed0674"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__GlobalDefs.html#gadf5010f6e140a53ecbdf949e73e87594">hipError_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Driver.html#ga2e4de5937aa8171e9eda16c881ed0674">hipModuleLaunchKernel</a> (<a class="el" href="classihipFunction__t.html">hipFunction_t</a> f, unsigned int gridDimX, unsigned int gridDimY, unsigned int gridDimZ, unsigned int blockDimX, unsigned int blockDimY, unsigned int blockDimZ, unsigned int sharedMemBytes, <a class="el" href="classihipStream__t.html">hipStream_t</a> stream, void **kernelParams, void **extra)</td></tr>
|
|
<tr class="memdesc:ga2e4de5937aa8171e9eda16c881ed0674"><td class="mdescLeft"> </td><td class="mdescRight">launches kernel f with launch parameters and shared memory on stream with arguments passed to kernelparams or extra <a href="#ga2e4de5937aa8171e9eda16c881ed0674">More...</a><br/></td></tr>
|
|
<tr class="separator:ga2e4de5937aa8171e9eda16c881ed0674"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<h2>----------------------------------------------------------------------------------------------— </h2>
|
|
<h2 class="groupheader">Function Documentation</h2>
|
|
<a class="anchor" id="ga0a1cf94d2b571ca3279577d5af0d1672"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="group__GlobalDefs.html#gadf5010f6e140a53ecbdf949e73e87594">hipError_t</a> hipDeviceComputeCapability </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int * </td>
|
|
<td class="paramname"><em>major</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int * </td>
|
|
<td class="paramname"><em>minor</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="classihipDevice__t.html">hipDevice_t</a> </td>
|
|
<td class="paramname"><em>device</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns the compute capability of the device. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">major</td><td></td></tr>
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">minor</td><td></td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">device</td><td></td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__GlobalDefs.html#ggadf5010f6e140a53ecbdf949e73e87594aadfbdb847b149723c684ebd764556063" title="Successful completion. ">hipSuccess</a>, #hipErrorInavlidDevice </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gadf6c74aaf7c22fea80e9ac3400d43704"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="group__GlobalDefs.html#gadf5010f6e140a53ecbdf949e73e87594">hipError_t</a> hipDeviceGet </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classihipDevice__t.html">hipDevice_t</a> * </td>
|
|
<td class="paramname"><em>device</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>ordinal</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns a handle to a compute device. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">device</td><td></td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">ordinal</td><td></td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__GlobalDefs.html#ggadf5010f6e140a53ecbdf949e73e87594aadfbdb847b149723c684ebd764556063" title="Successful completion. ">hipSuccess</a>, #hipErrorInavlidDevice </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gafe08d5632ebd24edc26a19da380b2120"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="group__GlobalDefs.html#gadf5010f6e140a53ecbdf949e73e87594">hipError_t</a> hipDeviceGetByPCIBusId </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int * </td>
|
|
<td class="paramname"><em>device</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const int * </td>
|
|
<td class="paramname"><em>pciBusId</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns a handle to a compute device. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">device</td><td>handle </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">PCI</td><td>Bus ID</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__GlobalDefs.html#ggadf5010f6e140a53ecbdf949e73e87594aadfbdb847b149723c684ebd764556063" title="Successful completion. ">hipSuccess</a>, #hipErrorInavlidDevice, <a class="el" href="group__GlobalDefs.html#ggadf5010f6e140a53ecbdf949e73e87594a1e8215fe1108a508bad3944bce7b4d83" title="One or more of the parameters passed to the API call is NULL or not in an acceptable range...">hipErrorInvalidValue</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga24df15e180a7b2b351cd362e5b7d2dac"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="group__GlobalDefs.html#gadf5010f6e140a53ecbdf949e73e87594">hipError_t</a> hipDeviceGetName </td>
|
|
<td>(</td>
|
|
<td class="paramtype">char * </td>
|
|
<td class="paramname"><em>name</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>len</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="classihipDevice__t.html">hipDevice_t</a> </td>
|
|
<td class="paramname"><em>device</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns an identifer string for the device. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">name</td><td></td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">len</td><td></td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">device</td><td></td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__GlobalDefs.html#ggadf5010f6e140a53ecbdf949e73e87594aadfbdb847b149723c684ebd764556063" title="Successful completion. ">hipSuccess</a>, #hipErrorInavlidDevice </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gaaa961c8ec8047903617f4245fa50256a"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="group__GlobalDefs.html#gadf5010f6e140a53ecbdf949e73e87594">hipError_t</a> hipDeviceGetPCIBusId </td>
|
|
<td>(</td>
|
|
<td class="paramtype">char * </td>
|
|
<td class="paramname"><em>pciBusId</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>len</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>device</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns a PCI Bus Id string for the device, overloaded to take int device ID. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">pciBusId</td><td></td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">len</td><td></td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">device</td><td></td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__GlobalDefs.html#ggadf5010f6e140a53ecbdf949e73e87594aadfbdb847b149723c684ebd764556063" title="Successful completion. ">hipSuccess</a>, #hipErrorInavlidDevice </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga8991e535d0ef1ead0524e73364623041"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="group__GlobalDefs.html#gadf5010f6e140a53ecbdf949e73e87594">hipError_t</a> hipDeviceTotalMem </td>
|
|
<td>(</td>
|
|
<td class="paramtype">size_t * </td>
|
|
<td class="paramname"><em>bytes</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="classihipDevice__t.html">hipDevice_t</a> </td>
|
|
<td class="paramname"><em>device</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns the total amount of memory on the device. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">bytes</td><td></td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">device</td><td></td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__GlobalDefs.html#ggadf5010f6e140a53ecbdf949e73e87594aadfbdb847b149723c684ebd764556063" title="Successful completion. ">hipSuccess</a>, #hipErrorInavlidDevice </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gaf6c342f52d2a29a0aca5cdd89b4dd47c"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="group__GlobalDefs.html#gadf5010f6e140a53ecbdf949e73e87594">hipError_t</a> hipDriverGetVersion </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int * </td>
|
|
<td class="paramname"><em>driverVersion</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns the approximate HIP driver version. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">driverVersion</td><td></td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__GlobalDefs.html#ggadf5010f6e140a53ecbdf949e73e87594aadfbdb847b149723c684ebd764556063" title="Successful completion. ">hipSuccess</a>, #hipErrorInavlidValue</dd></dl>
|
|
<dl class="section warning"><dt>Warning</dt><dd>The HIP feature set does not correspond to an exact CUDA SDK driver revision. This function always set *driverVersion to 4 as an approximation though HIP supports some features which were introduced in later CUDA SDK revisions. HIP apps code should not rely on the driver revision number here and should use arch feature flags to test device capabilities or conditional compilation.</dd></dl>
|
|
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__Driver.html#gae8b7ba34d2e11e334650aa51a4dd87ee" title="Returns the approximate HIP Runtime version. ">hipRuntimeGetVersion</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga01baa652dda5815c594d047060496caa"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="group__GlobalDefs.html#gadf5010f6e140a53ecbdf949e73e87594">hipError_t</a> hipInit </td>
|
|
<td>(</td>
|
|
<td class="paramtype">unsigned int </td>
|
|
<td class="paramname"><em>flags</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Explicitly initializes the HIP runtime. </p>
|
|
<p>Most HIP APIs implicitly initialize the HIP runtime. This API provides control over the timing of the initialization. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga9648b457bb837838cb936b417b56a65d"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="group__GlobalDefs.html#gadf5010f6e140a53ecbdf949e73e87594">hipError_t</a> hipModuleGetFunction </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classihipFunction__t.html">hipFunction_t</a> * </td>
|
|
<td class="paramname"><em>function</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="classihipModule__t.html">hipModule_t</a> </td>
|
|
<td class="paramname"><em>module</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>kname</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Function with kname will be extracted if present in module. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">module</td><td></td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">kname</td><td></td></tr>
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">function</td><td></td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>hipSuccess, hipErrorInvalidValue, hipErrorInvalidContext, hipErrorNotInitialized, hipErrorNotFound, </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga3e425a680285f495e776f096e9632c89"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="group__GlobalDefs.html#gadf5010f6e140a53ecbdf949e73e87594">hipError_t</a> hipModuleGetGlobal </td>
|
|
<td>(</td>
|
|
<td class="paramtype">hipDeviceptr_t * </td>
|
|
<td class="paramname"><em>dptr</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">size_t * </td>
|
|
<td class="paramname"><em>bytes</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="classihipModule__t.html">hipModule_t</a> </td>
|
|
<td class="paramname"><em>hmod</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>name</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>returns device memory pointer and size of the kernel present in the module with symbol <code>name</code> </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">dptr</td><td></td></tr>
|
|
<tr><td class="paramdir"></td><td class="paramname">[out[</td><td>bytes </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">hmod</td><td></td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">name</td><td></td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>hipSuccess, hipErrorInvalidValue, hipErrorNotInitialized </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga2e4de5937aa8171e9eda16c881ed0674"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="group__GlobalDefs.html#gadf5010f6e140a53ecbdf949e73e87594">hipError_t</a> hipModuleLaunchKernel </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classihipFunction__t.html">hipFunction_t</a> </td>
|
|
<td class="paramname"><em>f</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">unsigned int </td>
|
|
<td class="paramname"><em>gridDimX</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">unsigned int </td>
|
|
<td class="paramname"><em>gridDimY</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">unsigned int </td>
|
|
<td class="paramname"><em>gridDimZ</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">unsigned int </td>
|
|
<td class="paramname"><em>blockDimX</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">unsigned int </td>
|
|
<td class="paramname"><em>blockDimY</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">unsigned int </td>
|
|
<td class="paramname"><em>blockDimZ</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">unsigned int </td>
|
|
<td class="paramname"><em>sharedMemBytes</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="classihipStream__t.html">hipStream_t</a> </td>
|
|
<td class="paramname"><em>stream</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">void ** </td>
|
|
<td class="paramname"><em>kernelParams</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">void ** </td>
|
|
<td class="paramname"><em>extra</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>launches kernel f with launch parameters and shared memory on stream with arguments passed to kernelparams or extra </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir"></td><td class="paramname">[in[</td><td>f </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">gridDimX</td><td></td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">gridDimY</td><td></td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">gridDimZ</td><td></td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">blockDimX</td><td></td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">blockDimY</td><td></td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">blockDimZ</td><td></td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">sharedMemBytes</td><td></td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">stream</td><td></td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">kernelParams</td><td></td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">extraa</td><td>The function takes the above arguments and run the kernel in hipFunction_t f. with launch parameters specified in gridDimX, gridDimY, gridDimZ, blockDimX, blockDimY and blockDimmZ. The amount of shared memory is specificed and can be used with HIP_DYNAMIC_SHARED. The arguemt extra is used to pass in the arguments for the kernel. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>hipSuccess, hipInvalidDevice, hipErrorNotInitialized, hipErrorInvalidValue</dd></dl>
|
|
<dl class="section warning"><dt>Warning</dt><dd>kernellParams argument is not yet implemented in HIP. Please use extra instead. Please refer to hip_porting_driver_api.md for sample usage. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga31d806d976e91d36bd990ae3004d8760"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="group__GlobalDefs.html#gadf5010f6e140a53ecbdf949e73e87594">hipError_t</a> hipModuleLoad </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classihipModule__t.html">hipModule_t</a> * </td>
|
|
<td class="paramname"><em>module</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>fname</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Loads code object from file into a hipModule_t. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">fname</td><td></td></tr>
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">module</td><td></td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>hipSuccess, hipErrorInvalidValue, hipErrorInvalidContext, hipErrorFileNotFound, hipErrorOutOfMemory, hipErrorSharedObjectInitFailed, hipErrorNotInitialized </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gaabdbd73e952a741e861d01109c4790f3"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="group__GlobalDefs.html#gadf5010f6e140a53ecbdf949e73e87594">hipError_t</a> hipModuleLoadData </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classihipModule__t.html">hipModule_t</a> * </td>
|
|
<td class="paramname"><em>module</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const void * </td>
|
|
<td class="paramname"><em>image</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>builds module from code object which resides in host memory. Image is pointer to that location. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">image</td><td></td></tr>
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">module</td><td></td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>hipSuccess, hipErrorNotInitialized, hipErrorOutOfMemory, hipErrorNotInitialized </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gae58e345f55bb3ec13dca80d2df88e0ed"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="group__GlobalDefs.html#gadf5010f6e140a53ecbdf949e73e87594">hipError_t</a> hipModuleUnload </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classihipModule__t.html">hipModule_t</a> </td>
|
|
<td class="paramname"><em>module</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Frees the module. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">module</td><td></td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>hipSuccess, hipInvalidValue module is freed and the code objects associated with it are destroyed </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gae8b7ba34d2e11e334650aa51a4dd87ee"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="group__GlobalDefs.html#gadf5010f6e140a53ecbdf949e73e87594">hipError_t</a> hipRuntimeGetVersion </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int * </td>
|
|
<td class="paramname"><em>runtimeVersion</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns the approximate HIP Runtime version. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">runtimeVersion</td><td></td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__GlobalDefs.html#ggadf5010f6e140a53ecbdf949e73e87594aadfbdb847b149723c684ebd764556063" title="Successful completion. ">hipSuccess</a>, #hipErrorInavlidValue</dd></dl>
|
|
<dl class="section warning"><dt>Warning</dt><dd>On HIP/HCC path this function returns HIP runtime patch version however on HIP/NVCC path this function return CUDA runtime version.</dd></dl>
|
|
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__Driver.html#gaf6c342f52d2a29a0aca5cdd89b4dd47c" title="Returns the approximate HIP driver version. ">hipDriverGetVersion</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated on Mon Dec 19 2016 04:03:44 for HIP: Heterogenous-computing Interface for Portability by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.6
|
|
</small></address>
|
|
</body>
|
|
</html>
|