MPIonCell/documentation/developer/html/d1/d03/moc__dma__spu_8h-source.html

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>MPI On Cell (Documentation): include/spu/moc_dma_spu.h Source File</title>
<link href="../../doxygen.css" rel="stylesheet" type="text/css">
<link href="../../tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.6 -->
<div class="navigation" id="top">
  <div class="tabs">
    <ul>
      <li><a href="../../main.html"><span>Main&nbsp;Page</span></a></li>
      <li><a href="../../modules.html"><span>Modules</span></a></li>
      <li><a href="../../annotated.html"><span>Data&nbsp;Structures</span></a></li>
      <li class="current"><a href="../../files.html"><span>Files</span></a></li>
    </ul>
  </div>
<h1>include/spu/moc_dma_spu.h</h1><a href="../../dd/d9c/moc__dma__spu_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="preprocessor">#ifndef MOC_DATA_TRANSFER_SPU_H_</span>
<a name="l00002"></a>00002 <span class="preprocessor"></span><span class="preprocessor">#define MOC_DATA_TRANSFER_SPU_H_</span>
<a name="l00003"></a>00003 <span class="preprocessor"></span>
<a name="l00004"></a>00004 <span class="preprocessor">#include &lt;stdint.h&gt;</span>
<a name="l00005"></a>00005 <span class="preprocessor">#include "<a class="code" href="../../d0/d1d/moc__datatype__spu_8h.html">moc_datatype_spu.h</a>"</span>
<a name="l00006"></a>00006 <span class="preprocessor">#include "../moc.h"</span>
<a name="l00007"></a>00007 <span class="comment"></span>
<a name="l00008"></a>00008 <span class="comment">/**</span>
<a name="l00009"></a>00009 <span class="comment"> * \addtogroup dma_access</span>
<a name="l00010"></a>00010 <span class="comment"> **/</span><span class="comment"></span>
<a name="l00011"></a>00011 <span class="comment">//@{</span>
<a name="l00012"></a>00012 <span class="comment"></span><span class="comment">/**</span>
<a name="l00013"></a>00013 <span class="comment"> * @name SPU-only</span>
<a name="l00014"></a>00014 <span class="comment"> **/</span><span class="comment"></span>
<a name="l00015"></a>00015 <span class="comment">//@{</span>
<a name="l00016"></a>00016 <span class="comment"></span>
<a name="l00017"></a>00017 <span class="comment"></span>
<a name="l00018"></a>00018 <span class="comment">/**</span>
<a name="l00019"></a>00019 <span class="comment"> * Wrapper-function for a blocking DMA-get operation.</span>
<a name="l00020"></a>00020 <span class="comment"> * Data can be of any size, constraints of low-level DMA-functions</span>
<a name="l00021"></a>00021 <span class="comment"> * are dealt by this function.</span>
<a name="l00022"></a>00022 <span class="comment"> * However data-addresses have to be at least 16-byte aligned.</span>
<a name="l00023"></a>00023 <span class="comment"> *</span>
<a name="l00024"></a>00024 <span class="comment"> * @param target \b out pointer to buffer</span>
<a name="l00025"></a>00025 <span class="comment"> * @param source \b in ea-address of data</span>
<a name="l00026"></a>00026 <span class="comment"> * @param count \b in size of data in byte</span>
<a name="l00027"></a>00027 <span class="comment"> * @param datatype \b in Type of Elements</span>
<a name="l00028"></a>00028 <span class="comment"> * @retval MOC_SUCCESS No error; MPI routine completed successfully.</span>
<a name="l00029"></a>00029 <span class="comment"> * @retval ... error-code</span>
<a name="l00030"></a>00030 <span class="comment"> **/</span>
<a name="l00031"></a>00031 <span class="keywordtype">int</span> <a class="code" href="../../d9/d16/group__dma__access.html#g3716465d42f20379bbf65002ecd9e448" title="Wrapper-function for a blocking DMA-get operation.">MOC_Get_data</a>(<span class="keywordtype">void</span>* target, uint64_t source, <span class="keywordtype">int</span> count,
<a name="l00032"></a>00032         <a class="code" href="../../dc/d6e/group__p2p__datatype.html#gb4e45f15c08578bd3fc97c0cca2a509a" title="Typedef defining MOC_Datatype.">MOC_Datatype</a> datatype);
<a name="l00033"></a>00033 <span class="comment"></span>
<a name="l00034"></a>00034 <span class="comment">/**</span>
<a name="l00035"></a>00035 <span class="comment"> * Wrapper-function for a blocking DMA-put operation.</span>
<a name="l00036"></a>00036 <span class="comment"> * Data-size should be a multiple of 16 because of low-level constraints, but</span>
<a name="l00037"></a>00037 <span class="comment"> * there is no upper limit of transfer-size.</span>
<a name="l00038"></a>00038 <span class="comment"> * Data-addresses have to be at least 16-byte aligned.</span>
<a name="l00039"></a>00039 <span class="comment"> *</span>
<a name="l00040"></a>00040 <span class="comment"> * @param source \b in pointer to data</span>
<a name="l00041"></a>00041 <span class="comment"> * @param target \b in ea-address of buffer</span>
<a name="l00042"></a>00042 <span class="comment"> * @param count \b in size of data in byte</span>
<a name="l00043"></a>00043 <span class="comment"> * @param datatype \b in Type of Elements</span>
<a name="l00044"></a>00044 <span class="comment"> * @retval MOC_SUCCESS No error; MPI routine completed successfully.</span>
<a name="l00045"></a>00045 <span class="comment"> * @retval ... error-code</span>
<a name="l00046"></a>00046 <span class="comment"> **/</span>
<a name="l00047"></a>00047 <span class="keywordtype">int</span> <a class="code" href="../../d9/d16/group__dma__access.html#ge07f4b35da50be472772f9d3a426669e" title="Wrapper-function for a blocking DMA-put operation.">MOC_Put_data</a>(<span class="keywordtype">void</span>* source, uint64_t target, <span class="keywordtype">int</span> count,
<a name="l00048"></a>00048         <a class="code" href="../../dc/d6e/group__p2p__datatype.html#gb4e45f15c08578bd3fc97c0cca2a509a" title="Typedef defining MOC_Datatype.">MOC_Datatype</a> datatype);
<a name="l00049"></a>00049 <span class="comment"></span>
<a name="l00050"></a>00050 <span class="comment">/**</span>
<a name="l00051"></a>00051 <span class="comment"> * Wrapper-function for a non-blocking DMA-get operation.</span>
<a name="l00052"></a>00052 <span class="comment"> * Data can be of any size, constraints of low-level DMA-functions</span>
<a name="l00053"></a>00053 <span class="comment"> * are dealt by this function.</span>
<a name="l00054"></a>00054 <span class="comment"> * However data-addresses have to be at least 16-byte aligned.</span>
<a name="l00055"></a>00055 <span class="comment"> * Operation-completion can be derived with MOC_Test and MOC_Wait.</span>
<a name="l00056"></a>00056 <span class="comment"> *</span>
<a name="l00057"></a>00057 <span class="comment"> * @param target \b out pointer to buffer</span>
<a name="l00058"></a>00058 <span class="comment"> * @param source \b in ea-address of data</span>
<a name="l00059"></a>00059 <span class="comment"> * @param count \b in size of data in byte</span>
<a name="l00060"></a>00060 <span class="comment"> * @param datatype \b in Type of Elements</span>
<a name="l00061"></a>00061 <span class="comment"> * @param request \b out communication request (handle)</span>
<a name="l00062"></a>00062 <span class="comment"> * @retval MOC_SUCCESS No error; MPI routine completed successfully.</span>
<a name="l00063"></a>00063 <span class="comment"> * @retval ... error-code</span>
<a name="l00064"></a>00064 <span class="comment"> **/</span>
<a name="l00065"></a>00065 <span class="keywordtype">int</span> <a class="code" href="../../d9/d16/group__dma__access.html#g08f0af30f2e0e6840ec2be5ca93fd14f" title="Wrapper-function for a non-blocking DMA-get operation.">MOC_IGet_data</a>(<span class="keywordtype">void</span>* target, uint64_t source, <span class="keywordtype">int</span> count,
<a name="l00066"></a>00066         <a class="code" href="../../dc/d6e/group__p2p__datatype.html#gb4e45f15c08578bd3fc97c0cca2a509a" title="Typedef defining MOC_Datatype.">MOC_Datatype</a> datatype, <a class="code" href="../../db/d17/structmoc__request__struct.html" title="Communication-Request (Handle).">MOC_Request</a> *request);
<a name="l00067"></a>00067 <span class="comment"></span>
<a name="l00068"></a>00068 <span class="comment">/**</span>
<a name="l00069"></a>00069 <span class="comment"> * Wrapper-function for a non-blocking DMA-put operation.</span>
<a name="l00070"></a>00070 <span class="comment"> * Data-size should be a multiple of 16 because of low-level constraints, but</span>
<a name="l00071"></a>00071 <span class="comment"> * there is no upper limit of transfer-size.</span>
<a name="l00072"></a>00072 <span class="comment"> * Data-addresses have to be at least 16-byte aligned.</span>
<a name="l00073"></a>00073 <span class="comment"> * Operation-completion can be derived with MOC_Test and MOC_Wait.</span>
<a name="l00074"></a>00074 <span class="comment"> *</span>
<a name="l00075"></a>00075 <span class="comment"> * @param source \b in pointer to data</span>
<a name="l00076"></a>00076 <span class="comment"> * @param target \b in ea-address of buffer</span>
<a name="l00077"></a>00077 <span class="comment"> * @param count \b in size of data in byte</span>
<a name="l00078"></a>00078 <span class="comment"> * @param datatype \b in Type of Elements</span>
<a name="l00079"></a>00079 <span class="comment"> * @param request \b out communication request (handle)</span>
<a name="l00080"></a>00080 <span class="comment"> * @retval MOC_SUCCESS No error; MPI routine completed successfully.</span>
<a name="l00081"></a>00081 <span class="comment"> * @retval ... error-code</span>
<a name="l00082"></a>00082 <span class="comment"> **/</span>
<a name="l00083"></a>00083 <span class="keywordtype">int</span> <a class="code" href="../../d9/d16/group__dma__access.html#g1fd9a141352dd4344e20f1bde778d265" title="Wrapper-function for a non-blocking DMA-put operation.">MOC_IPut_data</a>(<span class="keywordtype">void</span>* source, uint64_t target, <span class="keywordtype">int</span> count,
<a name="l00084"></a>00084         <a class="code" href="../../dc/d6e/group__p2p__datatype.html#gb4e45f15c08578bd3fc97c0cca2a509a" title="Typedef defining MOC_Datatype.">MOC_Datatype</a> datatype, <a class="code" href="../../db/d17/structmoc__request__struct.html" title="Communication-Request (Handle).">MOC_Request</a> *request);
<a name="l00085"></a>00085 <span class="comment"></span>
<a name="l00086"></a>00086 <span class="comment">/**</span>
<a name="l00087"></a>00087 <span class="comment"> * Translates a local-store address of the calling SPU into the corresponding</span>
<a name="l00088"></a>00088 <span class="comment"> * effective-address.</span>
<a name="l00089"></a>00089 <span class="comment"> *</span>
<a name="l00090"></a>00090 <span class="comment"> * @param ls \b in local-store address</span>
<a name="l00091"></a>00091 <span class="comment"> * @param ea \b out effective-address</span>
<a name="l00092"></a>00092 <span class="comment"> **/</span>
<a name="l00093"></a>00093 <span class="keywordtype">int</span> <a class="code" href="../../d9/d16/group__dma__access.html#g1ee1f004fff19c3338f2de9d96471693" title="Translates a local-store address of the calling SPU into the corresponding effective-address...">MOC_Translate_LS_to_EA</a>(<span class="keywordtype">void</span>* ls, uint64_t* ea);
<a name="l00094"></a>00094 <span class="comment"></span>
<a name="l00095"></a>00095 <span class="comment">//@}</span>
<a name="l00096"></a>00096 <span class="comment"></span>
<a name="l00097"></a>00097 <span class="comment"></span>
<a name="l00098"></a>00098 <span class="comment">/**</span>
<a name="l00099"></a>00099 <span class="comment"> * Tests if a MOC_IGet_data or IMOC_IPut_data is completed.</span>
<a name="l00100"></a>00100 <span class="comment"> *</span>
<a name="l00101"></a>00101 <span class="comment"> * @param request \b in request-handle</span>
<a name="l00102"></a>00102 <span class="comment"> * @param flag \b out true if operation is completed</span>
<a name="l00103"></a>00103 <span class="comment"> * @return 0 when success otherwise error-code</span>
<a name="l00104"></a>00104 <span class="comment"> **/</span>
<a name="l00105"></a>00105 <span class="keywordtype">int</span> <a class="code" href="../../d9/d16/group__dma__access.html#g342d07658aae4252a2e2cd6a8cc185dd" title="Tests if a MOC_IGet_data or IMOC_IPut_data is completed.">MOC_Test_data</a>(<a class="code" href="../../db/d17/structmoc__request__struct.html" title="Communication-Request (Handle).">MOC_Request</a>* request, <span class="keywordtype">int</span> *flag);
<a name="l00106"></a>00106 <span class="comment"></span>
<a name="l00107"></a>00107 <span class="comment">/**</span>
<a name="l00108"></a>00108 <span class="comment"> * Waits till a MOC_IGet_data or IMOC_IPut_data is completed.</span>
<a name="l00109"></a>00109 <span class="comment"> *</span>
<a name="l00110"></a>00110 <span class="comment"> * @param request \b in request-handle</span>
<a name="l00111"></a>00111 <span class="comment"> * @return 0 when success otherwise error-code</span>
<a name="l00112"></a>00112 <span class="comment"> **/</span>
<a name="l00113"></a>00113 <span class="keywordtype">int</span> <a class="code" href="../../d9/d16/group__dma__access.html#g0ba7b00fbebaabb8b39737a7c13efc67" title="Waits till a MOC_IGet_data or IMOC_IPut_data is completed.">MOC_Wait_data</a>(<a class="code" href="../../db/d17/structmoc__request__struct.html" title="Communication-Request (Handle).">MOC_Request</a>* request);
<a name="l00114"></a>00114 <span class="comment"></span>
<a name="l00115"></a>00115 <span class="comment">//@}</span>
<a name="l00116"></a>00116 <span class="comment"></span><span class="preprocessor">#endif </span><span class="comment">/*MOC_DATA_TRANSFER_SPU_H_*/</span>
<a name="l00117"></a>00117 
</pre></div></div>
<hr size="1"><address style="text-align: right;"><small>Generated on Thu Feb 12 13:49:47 2009 for MPI On Cell (Documentation) by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="../../doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
</body>
</html>