AI/rocm-systems
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update docs:

Browse Source 
- Some comments in hip_hcc.cpp
 - document hipHostRegister* flags.
 - expand docs on hipHostRegister/Unregister. Use "register" rather than
   "pin" to describe action these take.
 - change required CUDA version to 6 (require unified memory)
 - remake doxygen.
This commit is contained in:
Ben Sander
2016-03-23 23:11:15 -05:00
parent 362867d325
commit eced013ae4
107 changed files with 2766 additions and 1646 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/RuntimeAPI/html/structihipDevice__t.html
+60 -12
View File
@@ -94,9 +94,26 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a3386b9e312c0bf133174e7a0e602aca1"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3386b9e312c0bf133174e7a0e602aca1"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>ihipDevice_t</b> (unsigned device_index, hc::accelerator acc)</td></tr>
<tr class="separator:a3386b9e312c0bf133174e7a0e602aca1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aea2d2e0094f6dd26ec8012bdf3106117"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aea2d2e0094f6dd26ec8012bdf3106117"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>init</b> (unsigned device_index, hc::accelerator acc)</td></tr>
<tr class="separator:aea2d2e0094f6dd26ec8012bdf3106117"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a58de2d307c8bc6c12ebdc44452b85fdc"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a58de2d307c8bc6c12ebdc44452b85fdc"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>reset</b> ()</td></tr>
<tr class="separator:a58de2d307c8bc6c12ebdc44452b85fdc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0abb382f1bcdda80028f9a8307e50561"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__GlobalDefs.html#gadf5010f6e140a53ecbdf949e73e87594">hipError_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structihipDevice__t.html#a0abb382f1bcdda80028f9a8307e50561">getProperties</a> (<a class="el" href="structhipDeviceProp__t.html">hipDeviceProp_t</a> *prop)</td></tr>
<tr class="separator:a0abb382f1bcdda80028f9a8307e50561"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4fd4cadb60a0cea6b43fbcdc5ba77319"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4fd4cadb60a0cea6b43fbcdc5ba77319"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>waitAllStreams</b> ()</td></tr>
<tr class="separator:a4fd4cadb60a0cea6b43fbcdc5ba77319"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adb511b316efd53a967f2add063c3e4ed"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="adb511b316efd53a967f2add063c3e4ed"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>syncDefaultStream</b> (bool waitOnSelf)</td></tr>
<tr class="separator:adb511b316efd53a967f2add063c3e4ed"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a58de2d307c8bc6c12ebdc44452b85fdc"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a58de2d307c8bc6c12ebdc44452b85fdc"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>reset</b> ()</td></tr>
<tr class="separator:a58de2d307c8bc6c12ebdc44452b85fdc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aea2d2e0094f6dd26ec8012bdf3106117"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aea2d2e0094f6dd26ec8012bdf3106117"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>init</b> (unsigned device_index, hc::accelerator acc)</td></tr>
<tr class="separator:aea2d2e0094f6dd26ec8012bdf3106117"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0abb382f1bcdda80028f9a8307e50561"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0abb382f1bcdda80028f9a8307e50561"></a>
<a class="el" href="group__GlobalDefs.html#gadf5010f6e140a53ecbdf949e73e87594">hipError_t</a>&#160;</td><td class="memItemRight" valign="bottom"><b>getProperties</b> (<a class="el" href="structhipDeviceProp__t.html">hipDeviceProp_t</a> *prop)</td></tr>
<tr class="separator:a0abb382f1bcdda80028f9a8307e50561"><td class="memSeparator" colspan="2">&#160;</td></tr>
@@ -115,23 +132,54 @@ hc::accelerator&#160;</td><td class="memItemRight" valign="bottom"><b>_acc</b></
<tr class="memitem:af7db5d9ad862aa04136726a0826c9e70"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af7db5d9ad862aa04136726a0826c9e70"></a>
hsa_agent_t&#160;</td><td class="memItemRight" valign="bottom"><b>_hsa_agent</b></td></tr>
<tr class="separator:af7db5d9ad862aa04136726a0826c9e70"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afb46e1e38da2fe9fcb690505852da391"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afb46e1e38da2fe9fcb690505852da391"></a>
<a class="el" href="structihipStream__t.html">ihipStream_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><b>_null_stream</b></td></tr>
<tr class="separator:afb46e1e38da2fe9fcb690505852da391"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae43a87234b4663c1266fa5ea2569e8a4"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae43a87234b4663c1266fa5ea2569e8a4"></a>
std::list&lt; <a class="el" href="structihipStream__t.html">ihipStream_t</a> * &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>_streams</b></td></tr>
<tr class="separator:ae43a87234b4663c1266fa5ea2569e8a4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a30a23d131e8db5b37695cd6be3428ed2"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a30a23d131e8db5b37695cd6be3428ed2"></a>
<a class="el" href="classihipStream__t.html">ihipStream_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><b>_default_stream</b></td></tr>
<tr class="separator:a30a23d131e8db5b37695cd6be3428ed2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa348a3cd0d5d04a61f894b83d2f59d4e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa348a3cd0d5d04a61f894b83d2f59d4e"></a>
std::list&lt; <a class="el" href="classihipStream__t.html">ihipStream_t</a> * &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>_streams</b></td></tr>
<tr class="separator:aa348a3cd0d5d04a61f894b83d2f59d4e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3b7e2064036500f5609053c562963724"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3b7e2064036500f5609053c562963724"></a>
unsigned&#160;</td><td class="memItemRight" valign="bottom"><b>_compute_units</b></td></tr>
<tr class="separator:a3b7e2064036500f5609053c562963724"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a39b83e44ea0e7a711c715caa515b814b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a39b83e44ea0e7a711c715caa515b814b"></a>
<a class="el" href="structStagingBuffer.html">StagingBuffer</a> *&#160;</td><td class="memItemRight" valign="bottom"><b>_staging_buffer</b> [2]</td></tr>
<tr class="separator:a39b83e44ea0e7a711c715caa515b814b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af2b34aca902f3ec1d3fc3075d38d2470"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af2b34aca902f3ec1d3fc3075d38d2470"></a>
ihipStream_t::SeqNum_t&#160;</td><td class="memItemRight" valign="bottom"><b>_stream_id</b></td></tr>
<tr class="separator:af2b34aca902f3ec1d3fc3075d38d2470"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afb46e1e38da2fe9fcb690505852da391"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afb46e1e38da2fe9fcb690505852da391"></a>
<a class="el" href="classihipStream__t.html">ihipStream_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><b>_null_stream</b></td></tr>
<tr class="separator:afb46e1e38da2fe9fcb690505852da391"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af7ec5ffb29aee3ca1b8ea6ac66eb335c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af7ec5ffb29aee3ca1b8ea6ac66eb335c"></a>
std::mutex&#160;</td><td class="memItemRight" valign="bottom"><b>_copy_lock</b> [2]</td></tr>
<tr class="separator:af7ec5ffb29aee3ca1b8ea6ac66eb335c"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>/home/bensander/HIP.public/src/<a class="el" href="hip__hcc_8cpp.html">hip_hcc.cpp</a></li>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a0abb382f1bcdda80028f9a8307e50561"></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> ihipDevice_t::getProperties </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structhipDeviceProp__t.html">hipDeviceProp_t</a> *&#160;</td>
<td class="paramname"><em>prop</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="bug"><dt><b><a class="el" href="bug.html#_bug000001">Bug:</a></b></dt><dd>: on HCC, isMultiGpuBoard returns True if system contains multiple GPUS (rather than if GPU is on a multi-ASIC board) </dd></dl>
</div>
</div>
<hr/>The documentation for this struct was generated from the following files:<ul>
<li>/home/bensander/HIP-privatestaging/src/<a class="el" href="hip__hcc_8cpp.html">hip_hcc.cpp</a></li>
<li>/home/bensander/HIP-privatestaging/src/hip_hcc2.cpp</li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Feb 18 2016 20:42:16 for HIP: Heterogenous-computing Interface for Portability by &#160;<a href="http://www.doxygen.org/index.html">
Generated on Wed Mar 23 2016 23:11:07 for HIP: Heterogenous-computing Interface for Portability by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.6
</small></address>