Update docs:

- 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.
2016-03-23 23:11:15 -05:00
@@ -84,19 +84,19 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
 <table class="memberdecls">
 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
 Functions</h2></td></tr>
-<tr class="memitem:gaf2382e3cc6632332a8983a0f58e43494"><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="group__Stream.html#gaf2382e3cc6632332a8983a0f58e43494">hipStreamCreateWithFlags</a> (<a class="el" href="structihipStream__t.html">hipStream_t</a> *stream, unsigned int flags)</td></tr>
+<tr class="memitem:gaf2382e3cc6632332a8983a0f58e43494"><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="group__Stream.html#gaf2382e3cc6632332a8983a0f58e43494">hipStreamCreateWithFlags</a> (hipStream_t *stream, unsigned int flags)</td></tr>
 <tr class="memdesc:gaf2382e3cc6632332a8983a0f58e43494"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create an asynchronous stream.  <a href="#gaf2382e3cc6632332a8983a0f58e43494">More...</a><br/></td></tr>
 <tr class="separator:gaf2382e3cc6632332a8983a0f58e43494"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:gacdd84c8f8ef1539c96c57c1d5bcae633"><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="group__Stream.html#gacdd84c8f8ef1539c96c57c1d5bcae633">hipStreamWaitEvent</a> (<a class="el" href="structihipStream__t.html">hipStream_t</a> stream, <a class="el" href="structhipEvent__t.html">hipEvent_t</a> event, unsigned int flags)</td></tr>
+<tr class="memitem:gacdd84c8f8ef1539c96c57c1d5bcae633"><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="group__Stream.html#gacdd84c8f8ef1539c96c57c1d5bcae633">hipStreamWaitEvent</a> (hipStream_t stream, <a class="el" href="structhipEvent__t.html">hipEvent_t</a> event, unsigned int flags)</td></tr>
 <tr class="memdesc:gacdd84c8f8ef1539c96c57c1d5bcae633"><td class="mdescLeft">&#160;</td><td class="mdescRight">Make the specified compute stream wait for an event.  <a href="#gacdd84c8f8ef1539c96c57c1d5bcae633">More...</a><br/></td></tr>
 <tr class="separator:gacdd84c8f8ef1539c96c57c1d5bcae633"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:gabbfb9f573a6ebe8c478605ecb5504a74"><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="group__Stream.html#gabbfb9f573a6ebe8c478605ecb5504a74">hipStreamSynchronize</a> (<a class="el" href="structihipStream__t.html">hipStream_t</a> stream)</td></tr>
+<tr class="memitem:gabbfb9f573a6ebe8c478605ecb5504a74"><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="group__Stream.html#gabbfb9f573a6ebe8c478605ecb5504a74">hipStreamSynchronize</a> (hipStream_t stream)</td></tr>
 <tr class="memdesc:gabbfb9f573a6ebe8c478605ecb5504a74"><td class="mdescLeft">&#160;</td><td class="mdescRight">Wait for all commands in stream to complete.  <a href="#gabbfb9f573a6ebe8c478605ecb5504a74">More...</a><br/></td></tr>
 <tr class="separator:gabbfb9f573a6ebe8c478605ecb5504a74"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:ga3076a3499ed2c7821311006100bb95ec"><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="group__Stream.html#ga3076a3499ed2c7821311006100bb95ec">hipStreamDestroy</a> (<a class="el" href="structihipStream__t.html">hipStream_t</a> stream)</td></tr>
+<tr class="memitem:ga3076a3499ed2c7821311006100bb95ec"><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="group__Stream.html#ga3076a3499ed2c7821311006100bb95ec">hipStreamDestroy</a> (hipStream_t stream)</td></tr>
 <tr class="memdesc:ga3076a3499ed2c7821311006100bb95ec"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destroys the specified stream.  <a href="#ga3076a3499ed2c7821311006100bb95ec">More...</a><br/></td></tr>
 <tr class="separator:ga3076a3499ed2c7821311006100bb95ec"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:ga3249555a26439591b8873f70b39bb116"><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="group__Stream.html#ga3249555a26439591b8873f70b39bb116">hipStreamGetFlags</a> (<a class="el" href="structihipStream__t.html">hipStream_t</a> stream, unsigned int *flags)</td></tr>
+<tr class="memitem:ga3249555a26439591b8873f70b39bb116"><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="group__Stream.html#ga3249555a26439591b8873f70b39bb116">hipStreamGetFlags</a> (hipStream_t stream, unsigned int *flags)</td></tr>
 <tr class="memdesc:ga3249555a26439591b8873f70b39bb116"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return flags associated with this stream.  <a href="#ga3249555a26439591b8873f70b39bb116">More...</a><br/></td></tr>
 <tr class="separator:ga3249555a26439591b8873f70b39bb116"><td class="memSeparator" colspan="2">&#160;</td></tr>
 </table>
@@ -115,7 +115,7 @@ Functions</h2></td></tr>
        <tr>
          <td class="memname"><a class="el" href="group__GlobalDefs.html#gadf5010f6e140a53ecbdf949e73e87594">hipError_t</a> hipStreamCreateWithFlags </td>
          <td>(</td>
-          <td class="paramtype"><a class="el" href="structihipStream__t.html">hipStream_t</a> *&#160;</td>
+          <td class="paramtype">hipStream_t *&#160;</td>
          <td class="paramname"><em>stream</em>, </td>
        </tr>
        <tr>
@@ -141,7 +141,8 @@ Functions</h2></td></tr>
  </dd>
 </dl>
 <dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__GlobalDefs.html#ggadf5010f6e140a53ecbdf949e73e87594aadfbdb847b149723c684ebd764556063" title="Successful completion. ">hipSuccess</a>, <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>
-<p>Create a new asynchronous stream. Flags controls behavior of the stream. See <a class="el" href="group__GlobalDefs.html#ga6df5f70eb976836ab3598cacf0ffcdf9" title="Flags that can be used with hipStreamCreateWithFlags. ">hipStreamDefault</a>, <a class="el" href="group__GlobalDefs.html#gaaba9ae995d9b43b7d1ee70c6fa12c57d" title="Stream does not implicitly synchronize with null stream. ">hipStreamNonBlocking</a>.  hipStream_t are under development - with current HIP use the NULL stream. </p>
+<p>Create a new asynchronous stream. <code>stream</code> returns an opaque handle that can be used to reference the newly created stream in subsequent hipStream* commands. The stream is allocated on the heap and will remain allocated</p>
+<p>even if the handle goes out-of-scope. To release the memory used by the stream, applicaiton must call hipStreamDestroy. Flags controls behavior of the stream. See <a class="el" href="group__GlobalDefs.html#ga6df5f70eb976836ab3598cacf0ffcdf9" title="Flags that can be used with hipStreamCreateWithFlags. ">hipStreamDefault</a>, <a class="el" href="group__GlobalDefs.html#gaaba9ae995d9b43b7d1ee70c6fa12c57d" title="Stream does not implicitly synchronize with null stream. ">hipStreamNonBlocking</a>.  hipStream_t are under development - with current HIP use the NULL stream. </p>

 </div>
 </div>
@@ -152,7 +153,7 @@ Functions</h2></td></tr>
        <tr>
          <td class="memname"><a class="el" href="group__GlobalDefs.html#gadf5010f6e140a53ecbdf949e73e87594">hipError_t</a> hipStreamDestroy </td>
          <td>(</td>
-          <td class="paramtype"><a class="el" href="structihipStream__t.html">hipStream_t</a>&#160;</td>
+          <td class="paramtype">hipStream_t&#160;</td>
          <td class="paramname"><em>stream</em></td><td>)</td>
          <td></td>
        </tr>
@@ -181,7 +182,7 @@ Functions</h2></td></tr>
        <tr>
          <td class="memname"><a class="el" href="group__GlobalDefs.html#gadf5010f6e140a53ecbdf949e73e87594">hipError_t</a> hipStreamGetFlags </td>
          <td>(</td>
-          <td class="paramtype"><a class="el" href="structihipStream__t.html">hipStream_t</a>&#160;</td>
+          <td class="paramtype">hipStream_t&#160;</td>
          <td class="paramname"><em>stream</em>, </td>
        </tr>
        <tr>
@@ -220,7 +221,7 @@ Functions</h2></td></tr>
        <tr>
          <td class="memname"><a class="el" href="group__GlobalDefs.html#gadf5010f6e140a53ecbdf949e73e87594">hipError_t</a> hipStreamSynchronize </td>
          <td>(</td>
-          <td class="paramtype"><a class="el" href="structihipStream__t.html">hipStream_t</a>&#160;</td>
+          <td class="paramtype">hipStream_t&#160;</td>
          <td class="paramname"><em>stream</em></td><td>)</td>
          <td></td>
        </tr>
@@ -242,7 +243,7 @@ Functions</h2></td></tr>
        <tr>
          <td class="memname"><a class="el" href="group__GlobalDefs.html#gadf5010f6e140a53ecbdf949e73e87594">hipError_t</a> hipStreamWaitEvent </td>
          <td>(</td>
-          <td class="paramtype"><a class="el" href="structihipStream__t.html">hipStream_t</a>&#160;</td>
+          <td class="paramtype">hipStream_t&#160;</td>
          <td class="paramname"><em>stream</em>, </td>
        </tr>
        <tr>
@@ -277,13 +278,14 @@ Functions</h2></td></tr>
 <dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__GlobalDefs.html#ggadf5010f6e140a53ecbdf949e73e87594aadfbdb847b149723c684ebd764556063" title="Successful completion. ">hipSuccess</a>, <a class="el" href="group__GlobalDefs.html#ggadf5010f6e140a53ecbdf949e73e87594a88e525a7c8f35552dfada58e9f2f6d3a" title="Resource handle (hipEvent_t or hipStream_t) invalid. ">hipErrorInvalidResourceHandle</a></dd></dl>
 <p>This function inserts a wait operation into the specified stream. All future work submitted to <code>stream</code> will wait until <code>event</code> reports completion before beginning execution. This function is host-asynchronous and the function may return before the wait has completed.</p>
 <dl class="bug"><dt><b><a class="el" href="bug.html#_bug000003">Bug:</a></b></dt><dd>This function conservatively waits for all work in the specified stream to complete. </dd></dl>
+<dl class="bug"><dt><b><a class="el" href="bug.html#_bug000006">Bug:</a></b></dt><dd>This function conservatively waits for all work in the specified stream to complete. </dd></dl>

 </div>
 </div>
 </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>