138 lines
13 KiB
HTML
Executable File
138 lines
13 KiB
HTML
Executable File
<!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/internal/spu/imoc_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 Page</span></a></li>
|
|
<li><a href="../../modules.html"><span>Modules</span></a></li>
|
|
<li><a href="../../annotated.html"><span>Data Structures</span></a></li>
|
|
<li class="current"><a href="../../files.html"><span>Files</span></a></li>
|
|
</ul>
|
|
</div>
|
|
<h1>include/internal/spu/imoc_dma_spu.h</h1><a href="../../d4/dce/imoc__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_INTERNAL_GET_DATA_H_</span>
|
|
<a name="l00002"></a>00002 <span class="preprocessor"></span><span class="preprocessor">#define MOC_INTERNAL_GET_DATA_H_</span>
|
|
<a name="l00003"></a>00003 <span class="preprocessor"></span>
|
|
<a name="l00004"></a>00004 <span class="preprocessor">#include <stdint.h></span>
|
|
<a name="l00005"></a>00005 <span class="preprocessor">#include "../../moc.h"</span>
|
|
<a name="l00006"></a>00006 <span class="comment"></span>
|
|
<a name="l00007"></a>00007 <span class="comment">/**</span>
|
|
<a name="l00008"></a>00008 <span class="comment"> * \addtogroup internal_p2p_dma</span>
|
|
<a name="l00009"></a>00009 <span class="comment"> **/</span><span class="comment"></span>
|
|
<a name="l00010"></a>00010 <span class="comment">//@{</span>
|
|
<a name="l00011"></a>00011 <span class="comment"></span><span class="comment">/**</span>
|
|
<a name="l00012"></a>00012 <span class="comment"> * @name SPU-only</span>
|
|
<a name="l00013"></a>00013 <span class="comment"> **/</span><span class="comment"></span>
|
|
<a name="l00014"></a>00014 <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"> * Internal wrapper-function for a blocking DMA-get operation.</span>
|
|
<a name="l00019"></a>00019 <span class="comment"> * Data can be of any size, constraints of low-level DMA-functions</span>
|
|
<a name="l00020"></a>00020 <span class="comment"> * are dealt by this function.</span>
|
|
<a name="l00021"></a>00021 <span class="comment"> * However data-addresses have to be at least 16-byte aligned.</span>
|
|
<a name="l00022"></a>00022 <span class="comment"> * </span>
|
|
<a name="l00023"></a>00023 <span class="comment"> * This function actually always reads a multiple of 16 from the source, </span>
|
|
<a name="l00024"></a>00024 <span class="comment"> * but copies only size bytes of it to target. This means however that up</span>
|
|
<a name="l00025"></a>00025 <span class="comment"> * to 15 bytes are read from an invalid location. As it is never written to</span>
|
|
<a name="l00026"></a>00026 <span class="comment"> * them this should always be safe. </span>
|
|
<a name="l00027"></a>00027 <span class="comment"> * </span>
|
|
<a name="l00028"></a>00028 <span class="comment"> * @param target \b in ls-address of buffer</span>
|
|
<a name="l00029"></a>00029 <span class="comment"> * @param source \b in ea-address of data</span>
|
|
<a name="l00030"></a>00030 <span class="comment"> * @param size \b in size of data in byte</span>
|
|
<a name="l00031"></a>00031 <span class="comment"> * @return 0 when success otherwise error-code</span>
|
|
<a name="l00032"></a>00032 <span class="comment"> **/</span>
|
|
<a name="l00033"></a>00033 <span class="keywordtype">int</span> <a class="code" href="../../d2/de2/group__internal__p2p__dma.html#g53d36c567e4c98e5d258a7857096e7ab" title="Internal wrapper-function for a blocking DMA-get operation.">IMOC_get_data</a>(<span class="keywordtype">void</span>* target, uint64_t source, uint32_t size);
|
|
<a name="l00034"></a>00034
|
|
<a name="l00035"></a>00035 <span class="comment"></span>
|
|
<a name="l00036"></a>00036 <span class="comment">/**</span>
|
|
<a name="l00037"></a>00037 <span class="comment"> * Internal wrapper-function for a blocking DMA-put operation.</span>
|
|
<a name="l00038"></a>00038 <span class="comment"> * Data-size should be a multiple of 16 because of low-level constraints, but </span>
|
|
<a name="l00039"></a>00039 <span class="comment"> * there is no upper limit of transfer-size.</span>
|
|
<a name="l00040"></a>00040 <span class="comment"> * Data-addresses have to be at least 16-byte aligned.</span>
|
|
<a name="l00041"></a>00041 <span class="comment"> * </span>
|
|
<a name="l00042"></a>00042 <span class="comment"> * This function actually always reads a multiple of 16 from the source, and copies </span>
|
|
<a name="l00043"></a>00043 <span class="comment"> * it to target. This means however that up to 15 bytes are written to and invalid </span>
|
|
<a name="l00044"></a>00044 <span class="comment"> * location, so if one wants to use it with invalid sizes precautions have to be taken </span>
|
|
<a name="l00045"></a>00045 <span class="comment"> * in order to make it safe.</span>
|
|
<a name="l00046"></a>00046 <span class="comment"> * </span>
|
|
<a name="l00047"></a>00047 <span class="comment"> * @param source \b in ls-address of data</span>
|
|
<a name="l00048"></a>00048 <span class="comment"> * @param target \b in ea-address of buffer</span>
|
|
<a name="l00049"></a>00049 <span class="comment"> * @param size \b in size of data in byte</span>
|
|
<a name="l00050"></a>00050 <span class="comment"> * @return 0 when success otherwise error-code</span>
|
|
<a name="l00051"></a>00051 <span class="comment"> **/</span>
|
|
<a name="l00052"></a>00052 <span class="keywordtype">int</span> <a class="code" href="../../d2/de2/group__internal__p2p__dma.html#gb48c58191a7cf4d3e502d1c7a6c0ab9c" title="Internal wrapper-function for a blocking DMA-put operation.">IMOC_put_data</a>(<span class="keywordtype">void</span>* source, uint64_t target, uint32_t size);
|
|
<a name="l00053"></a>00053 <span class="comment"></span>
|
|
<a name="l00054"></a>00054 <span class="comment">/**</span>
|
|
<a name="l00055"></a>00055 <span class="comment"> * Internal wrapper-function for a non-blocking DMA-get operation.</span>
|
|
<a name="l00056"></a>00056 <span class="comment"> * Data can be of any size, constraints of low-level DMA-functions</span>
|
|
<a name="l00057"></a>00057 <span class="comment"> * are dealt by this function.</span>
|
|
<a name="l00058"></a>00058 <span class="comment"> * However data-addresses have to be at least 16-byte aligned.</span>
|
|
<a name="l00059"></a>00059 <span class="comment"> * </span>
|
|
<a name="l00060"></a>00060 <span class="comment"> * This function actually always reads a multiple of 16 from the source, </span>
|
|
<a name="l00061"></a>00061 <span class="comment"> * but copies only size bytes of it to target. This means however that up</span>
|
|
<a name="l00062"></a>00062 <span class="comment"> * to 15 bytes are read from an invalid location. As it is never written to</span>
|
|
<a name="l00063"></a>00063 <span class="comment"> * them this should always be safe. </span>
|
|
<a name="l00064"></a>00064 <span class="comment"> * </span>
|
|
<a name="l00065"></a>00065 <span class="comment"> * @param target \b in ls-address of buffer</span>
|
|
<a name="l00066"></a>00066 <span class="comment"> * @param source \b in ea-address of data</span>
|
|
<a name="l00067"></a>00067 <span class="comment"> * @param size \b in size of data in byte</span>
|
|
<a name="l00068"></a>00068 <span class="comment"> * @param request \b out request-handle</span>
|
|
<a name="l00069"></a>00069 <span class="comment"> * @return 0 when success otherwise error-code</span>
|
|
<a name="l00070"></a>00070 <span class="comment"> **/</span>
|
|
<a name="l00071"></a>00071 <span class="keywordtype">int</span> <a class="code" href="../../d2/de2/group__internal__p2p__dma.html#g0c76eeaa08ac299e19dc2758d4142cd9" title="Internal wrapper-function for a non-blocking DMA-get operation.">IMOC_iget_data</a>(<span class="keywordtype">void</span>* target, uint64_t source, uint32_t size, <a class="code" href="../../d4/da3/structimoc__dma__request__struct.html">imoc_dma_request</a>* request);
|
|
<a name="l00072"></a>00072 <span class="comment"></span>
|
|
<a name="l00073"></a>00073 <span class="comment">/**</span>
|
|
<a name="l00074"></a>00074 <span class="comment"> * Internal wrapper-function for a blocking DMA-put operation.</span>
|
|
<a name="l00075"></a>00075 <span class="comment"> * Data-size should be a multiple of 16 because of low-level constraints, but </span>
|
|
<a name="l00076"></a>00076 <span class="comment"> * there is no upper limit of transfer-size.</span>
|
|
<a name="l00077"></a>00077 <span class="comment"> * Data-addresses have to be at least 16-byte aligned.</span>
|
|
<a name="l00078"></a>00078 <span class="comment"> * </span>
|
|
<a name="l00079"></a>00079 <span class="comment"> * This function actually always reads a multiple of 16 from the source, and copies </span>
|
|
<a name="l00080"></a>00080 <span class="comment"> * it to target. This means however that up to 15 bytes are written to and invalid </span>
|
|
<a name="l00081"></a>00081 <span class="comment"> * location, so if one wants to use it with invalid sizes precautions have to be taken </span>
|
|
<a name="l00082"></a>00082 <span class="comment"> * in order to make it safe.</span>
|
|
<a name="l00083"></a>00083 <span class="comment"> * </span>
|
|
<a name="l00084"></a>00084 <span class="comment"> * @param source \b in ls-address of data</span>
|
|
<a name="l00085"></a>00085 <span class="comment"> * @param target \b in ea-address of buffer</span>
|
|
<a name="l00086"></a>00086 <span class="comment"> * @param size \b in size of data in byte</span>
|
|
<a name="l00087"></a>00087 <span class="comment"> * @param request \b out request-handle</span>
|
|
<a name="l00088"></a>00088 <span class="comment"> * @return 0 when success otherwise error-code</span>
|
|
<a name="l00089"></a>00089 <span class="comment"> **/</span>
|
|
<a name="l00090"></a>00090 <span class="keywordtype">int</span> <a class="code" href="../../d2/de2/group__internal__p2p__dma.html#gc181bb2e3eb058990534c71355af3443" title="Internal wrapper-function for a non-blocking DMA-put operation.">IMOC_iput_data</a>(<span class="keywordtype">void</span>* source, uint64_t target, uint32_t size, <a class="code" href="../../d4/da3/structimoc__dma__request__struct.html">imoc_dma_request</a>* request);
|
|
<a name="l00091"></a>00091
|
|
<a name="l00092"></a>00092 <span class="comment"></span>
|
|
<a name="l00093"></a>00093 <span class="comment">/**</span>
|
|
<a name="l00094"></a>00094 <span class="comment"> * Waits till a IMOC_iget_data or IMOC_iput_data is completed.</span>
|
|
<a name="l00095"></a>00095 <span class="comment"> * </span>
|
|
<a name="l00096"></a>00096 <span class="comment"> * @param request \b in request-handle</span>
|
|
<a name="l00097"></a>00097 <span class="comment"> * @return 0 when success otherwise error-code</span>
|
|
<a name="l00098"></a>00098 <span class="comment"> **/</span>
|
|
<a name="l00099"></a>00099 <span class="keywordtype">int</span> <a class="code" href="../../d2/de2/group__internal__p2p__dma.html#g57b89667357146b299f32bd114e0e5ad" title="Waits till a IMOC_iget_data or IMOC_iput_data is completed.">IMOC_wait_dma</a>(<a class="code" href="../../d4/da3/structimoc__dma__request__struct.html">imoc_dma_request</a>* request);
|
|
<a name="l00100"></a>00100 <span class="comment"></span>
|
|
<a name="l00101"></a>00101 <span class="comment">/**</span>
|
|
<a name="l00102"></a>00102 <span class="comment"> * Tests if a IMOC_iget_data or IMOC_iput_data is completed.</span>
|
|
<a name="l00103"></a>00103 <span class="comment"> * </span>
|
|
<a name="l00104"></a>00104 <span class="comment"> * @param request \b in request-handle</span>
|
|
<a name="l00105"></a>00105 <span class="comment"> * @param flag \b out true if operation is completed</span>
|
|
<a name="l00106"></a>00106 <span class="comment"> * @return 0 when success otherwise error-code</span>
|
|
<a name="l00107"></a>00107 <span class="comment"> **/</span>
|
|
<a name="l00108"></a>00108 <span class="keywordtype">int</span> <a class="code" href="../../d2/de2/group__internal__p2p__dma.html#gdc3d91a083a9dc3aa539aee4d56616f0" title="Tests if a IMOC_iget_data or IMOC_iput_data is completed.">IMOC_test_dma</a>(<a class="code" href="../../d4/da3/structimoc__dma__request__struct.html">imoc_dma_request</a>* request, <span class="keywordtype">int</span> *flag);
|
|
<a name="l00109"></a>00109
|
|
<a name="l00110"></a>00110
|
|
<a name="l00111"></a>00111
|
|
<a name="l00112"></a>00112 <span class="comment"></span>
|
|
<a name="l00113"></a>00113 <span class="comment">//@}</span>
|
|
<a name="l00114"></a>00114 <span class="comment"></span><span class="comment">//@}</span>
|
|
<a name="l00115"></a>00115 <span class="comment"></span><span class="preprocessor">#endif </span><span class="comment">/*MOC_INTERNAL_GET_DATA_H_*/</span>
|
|
</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
|
|
<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>
|