Skip to content

Commit 9764ed9

Browse files
patrislav1patrislav1
committed
deploy: 02e9341 
1 parent ade7edf commit 9764ed9

306 files changed

Lines changed: 2322 additions & 1233 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎example/html/_data_handler_abstract_8hpp_source.html‎

Lines changed: 20 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -140,28 +140,32 @@
140140
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"><a class="line" href="classudmaio_1_1_data_handler_abstract.html#a90d25df268b70ea580559fd0ad7aaa0a"> 37</a></span> <span class="keywordtype">void</span> <a class="code hl_function" href="classudmaio_1_1_data_handler_abstract.html#a90d25df268b70ea580559fd0ad7aaa0a">_start_read</a>();</div>
141141
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"><a class="line" href="classudmaio_1_1_data_handler_abstract.html#a03d3679ad7b54a8c3791005ea69ff711"> 38</a></span> <span class="keywordtype">void</span> <a class="code hl_function" href="classudmaio_1_1_data_handler_abstract.html#a03d3679ad7b54a8c3791005ea69ff711">_handle_input</a>(<span class="keyword">const</span> boost::system::error_code&amp; ec);</div>
142142
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> </div>
143-
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> <span class="keyword">public</span>:</div>
144-
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"><a class="line" href="classudmaio_1_1_data_handler_abstract.html#a5228c5ea1c6a7a4d9f9aad4c38b03f2b"> 45</a></span> <span class="keyword">explicit</span> <a class="code hl_function" href="classudmaio_1_1_data_handler_abstract.html#a5228c5ea1c6a7a4d9f9aad4c38b03f2b">DataHandlerAbstract</a>(std::string name,</div>
145-
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> <a class="code hl_class" href="classudmaio_1_1_uio_axi_dma_if.html">UioAxiDmaIf</a>&amp; dma,</div>
146-
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> <a class="code hl_class" href="classudmaio_1_1_uio_mem_sgdma.html">UioMemSgdma</a>&amp; desc,</div>
147-
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> <a class="code hl_class" href="classudmaio_1_1_dma_buffer_abstract.html">DmaBufferAbstract</a>&amp; mem);</div>
148-
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"><a class="line" href="classudmaio_1_1_data_handler_abstract.html#aad33dd6ad2e4c30ab2da27088c61053b"> 49</a></span> <span class="keyword">virtual</span> <a class="code hl_function" href="classudmaio_1_1_data_handler_abstract.html#aad33dd6ad2e4c30ab2da27088c61053b">~DataHandlerAbstract</a>();</div>
149-
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> </div>
150-
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"><a class="line" href="classudmaio_1_1_data_handler_abstract.html#aa85481c35139a0c2057b332826b32b90"> 52</a></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classudmaio_1_1_data_handler_abstract.html#aa85481c35139a0c2057b332826b32b90">stop</a>();</div>
151-
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> </div>
152-
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"><a class="line" href="classudmaio_1_1_data_handler_abstract.html#a8b3ef758d72527ef0f7f3e4f1d9a068d"> 55</a></span> <span class="keywordtype">void</span> <a class="code hl_function" href="classudmaio_1_1_data_handler_abstract.html#a8b3ef758d72527ef0f7f3e4f1d9a068d">operator()</a>();</div>
153-
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> </div>
154-
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"><a class="line" href="classudmaio_1_1_data_handler_abstract.html#ac61900afc81ade0bb51bfab49bcfe257"> 59</a></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classudmaio_1_1_data_handler_abstract.html#ac61900afc81ade0bb51bfab49bcfe257">process_data</a>(std::vector&lt;uint8_t&gt; bytes) = 0;</div>
155-
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span>};</div>
143+
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> <span class="keyword">protected</span>:</div>
144+
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"><a class="line" href="classudmaio_1_1_data_handler_abstract.html#a0a8f2cedde2cb0d2d4e891fba981c04b"> 41</a></span> <span class="keywordtype">bool</span> <a class="code hl_variable" href="classudmaio_1_1_data_handler_abstract.html#a0a8f2cedde2cb0d2d4e891fba981c04b">_receive_packets</a>; </div>
145+
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> </div>
146+
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> <span class="keyword">public</span>:</div>
147+
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"><a class="line" href="classudmaio_1_1_data_handler_abstract.html#ad3731cb36bac1fb2019eefaae629c833"> 49</a></span> <span class="keyword">explicit</span> <a class="code hl_function" href="classudmaio_1_1_data_handler_abstract.html#ad3731cb36bac1fb2019eefaae629c833">DataHandlerAbstract</a>(std::string name,</div>
148+
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> <a class="code hl_class" href="classudmaio_1_1_uio_axi_dma_if.html">UioAxiDmaIf</a>&amp; dma,</div>
149+
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> <a class="code hl_class" href="classudmaio_1_1_uio_mem_sgdma.html">UioMemSgdma</a>&amp; desc,</div>
150+
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span> <a class="code hl_class" href="classudmaio_1_1_dma_buffer_abstract.html">DmaBufferAbstract</a>&amp; mem,</div>
151+
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> <span class="keywordtype">bool</span> receive_packets = <span class="keyword">true</span>);</div>
152+
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"><a class="line" href="classudmaio_1_1_data_handler_abstract.html#aad33dd6ad2e4c30ab2da27088c61053b"> 54</a></span> <span class="keyword">virtual</span> <a class="code hl_function" href="classudmaio_1_1_data_handler_abstract.html#aad33dd6ad2e4c30ab2da27088c61053b">~DataHandlerAbstract</a>();</div>
153+
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> </div>
154+
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"><a class="line" href="classudmaio_1_1_data_handler_abstract.html#aa85481c35139a0c2057b332826b32b90"> 57</a></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classudmaio_1_1_data_handler_abstract.html#aa85481c35139a0c2057b332826b32b90">stop</a>();</div>
155+
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span> </div>
156+
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"><a class="line" href="classudmaio_1_1_data_handler_abstract.html#a8b3ef758d72527ef0f7f3e4f1d9a068d"> 60</a></span> <span class="keywordtype">void</span> <a class="code hl_function" href="classudmaio_1_1_data_handler_abstract.html#a8b3ef758d72527ef0f7f3e4f1d9a068d">operator()</a>();</div>
156157
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span> </div>
157-
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span>} <span class="comment">// namespace udmaio</span></div>
158+
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"><a class="line" href="classudmaio_1_1_data_handler_abstract.html#ac61900afc81ade0bb51bfab49bcfe257"> 64</a></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classudmaio_1_1_data_handler_abstract.html#ac61900afc81ade0bb51bfab49bcfe257">process_data</a>(std::vector&lt;uint8_t&gt; bytes) = 0;</div>
159+
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span>};</div>
160+
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span> </div>
161+
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span>} <span class="comment">// namespace udmaio</span></div>
158162
<div class="ttc" id="a_logging_8hpp_html"><div class="ttname"><a href="_logging_8hpp.html">Logging.hpp</a></div></div>
159163
<div class="ttc" id="a_u_dma_buf_8hpp_html"><div class="ttname"><a href="_u_dma_buf_8hpp.html">UDmaBuf.hpp</a></div></div>
160164
<div class="ttc" id="a_uio_axi_dma_if_8hpp_html"><div class="ttname"><a href="_uio_axi_dma_if_8hpp.html">UioAxiDmaIf.hpp</a></div></div>
161165
<div class="ttc" id="a_uio_mem_sgdma_8hpp_html"><div class="ttname"><a href="_uio_mem_sgdma_8hpp.html">UioMemSgdma.hpp</a></div></div>
162166
<div class="ttc" id="aclassudmaio_1_1_data_handler_abstract_html"><div class="ttname"><a href="classudmaio_1_1_data_handler_abstract.html">udmaio::DataHandlerAbstract</a></div><div class="ttdoc">Base class to implement a DMA data reception handler.</div><div class="ttdef"><b>Definition:</b> DataHandlerAbstract.hpp:29</div></div>
163167
<div class="ttc" id="aclassudmaio_1_1_data_handler_abstract_html_a03d3679ad7b54a8c3791005ea69ff711"><div class="ttname"><a href="classudmaio_1_1_data_handler_abstract.html#a03d3679ad7b54a8c3791005ea69ff711">udmaio::DataHandlerAbstract::_handle_input</a></div><div class="ttdeci">void _handle_input(const boost::system::error_code &amp;ec)</div></div>
164-
<div class="ttc" id="aclassudmaio_1_1_data_handler_abstract_html_a5228c5ea1c6a7a4d9f9aad4c38b03f2b"><div class="ttname"><a href="classudmaio_1_1_data_handler_abstract.html#a5228c5ea1c6a7a4d9f9aad4c38b03f2b">udmaio::DataHandlerAbstract::DataHandlerAbstract</a></div><div class="ttdeci">DataHandlerAbstract(std::string name, UioAxiDmaIf &amp;dma, UioMemSgdma &amp;desc, DmaBufferAbstract &amp;mem)</div><div class="ttdoc">Construct a Data Handler.</div></div>
168+
<div class="ttc" id="aclassudmaio_1_1_data_handler_abstract_html_a0a8f2cedde2cb0d2d4e891fba981c04b"><div class="ttname"><a href="classudmaio_1_1_data_handler_abstract.html#a0a8f2cedde2cb0d2d4e891fba981c04b">udmaio::DataHandlerAbstract::_receive_packets</a></div><div class="ttdeci">bool _receive_packets</div><div class="ttdoc">Enable segmentation of stream into SOF/EOF delimited frames.</div><div class="ttdef"><b>Definition:</b> DataHandlerAbstract.hpp:41</div></div>
165169
<div class="ttc" id="aclassudmaio_1_1_data_handler_abstract_html_a6dfd98d26b983dbee80af2e8c2f4c8e8"><div class="ttname"><a href="classudmaio_1_1_data_handler_abstract.html#a6dfd98d26b983dbee80af2e8c2f4c8e8">udmaio::DataHandlerAbstract::_sd</a></div><div class="ttdeci">boost::asio::posix::stream_descriptor _sd</div><div class="ttdef"><b>Definition:</b> DataHandlerAbstract.hpp:35</div></div>
166170
<div class="ttc" id="aclassudmaio_1_1_data_handler_abstract_html_a8b3ef758d72527ef0f7f3e4f1d9a068d"><div class="ttname"><a href="classudmaio_1_1_data_handler_abstract.html#a8b3ef758d72527ef0f7f3e4f1d9a068d">udmaio::DataHandlerAbstract::operator()</a></div><div class="ttdeci">void operator()()</div><div class="ttdoc">Run the data reception.</div></div>
167171
<div class="ttc" id="aclassudmaio_1_1_data_handler_abstract_html_a90d25df268b70ea580559fd0ad7aaa0a"><div class="ttname"><a href="classudmaio_1_1_data_handler_abstract.html#a90d25df268b70ea580559fd0ad7aaa0a">udmaio::DataHandlerAbstract::_start_read</a></div><div class="ttdeci">void _start_read()</div></div>
@@ -171,6 +175,7 @@
171175
<div class="ttc" id="aclassudmaio_1_1_data_handler_abstract_html_aac65303521a1386f18b9492938d7768d"><div class="ttname"><a href="classudmaio_1_1_data_handler_abstract.html#aac65303521a1386f18b9492938d7768d">udmaio::DataHandlerAbstract::_dma</a></div><div class="ttdeci">UioAxiDmaIf &amp; _dma</div><div class="ttdoc">AXI DMA interface.</div><div class="ttdef"><b>Definition:</b> DataHandlerAbstract.hpp:30</div></div>
172176
<div class="ttc" id="aclassudmaio_1_1_data_handler_abstract_html_aad33dd6ad2e4c30ab2da27088c61053b"><div class="ttname"><a href="classudmaio_1_1_data_handler_abstract.html#aad33dd6ad2e4c30ab2da27088c61053b">udmaio::DataHandlerAbstract::~DataHandlerAbstract</a></div><div class="ttdeci">virtual ~DataHandlerAbstract()</div></div>
173177
<div class="ttc" id="aclassudmaio_1_1_data_handler_abstract_html_ac61900afc81ade0bb51bfab49bcfe257"><div class="ttname"><a href="classudmaio_1_1_data_handler_abstract.html#ac61900afc81ade0bb51bfab49bcfe257">udmaio::DataHandlerAbstract::process_data</a></div><div class="ttdeci">virtual void process_data(std::vector&lt; uint8_t &gt; bytes)=0</div><div class="ttdoc">Process the received data.</div></div>
178+
<div class="ttc" id="aclassudmaio_1_1_data_handler_abstract_html_ad3731cb36bac1fb2019eefaae629c833"><div class="ttname"><a href="classudmaio_1_1_data_handler_abstract.html#ad3731cb36bac1fb2019eefaae629c833">udmaio::DataHandlerAbstract::DataHandlerAbstract</a></div><div class="ttdeci">DataHandlerAbstract(std::string name, UioAxiDmaIf &amp;dma, UioMemSgdma &amp;desc, DmaBufferAbstract &amp;mem, bool receive_packets=true)</div><div class="ttdoc">Construct a Data Handler.</div></div>
174179
<div class="ttc" id="aclassudmaio_1_1_data_handler_abstract_html_ae2417f2cff337a2d8e0fbf2e4cec3a48"><div class="ttname"><a href="classudmaio_1_1_data_handler_abstract.html#ae2417f2cff337a2d8e0fbf2e4cec3a48">udmaio::DataHandlerAbstract::_desc</a></div><div class="ttdeci">UioMemSgdma &amp; _desc</div><div class="ttdoc">SGDMA data interface.</div><div class="ttdef"><b>Definition:</b> DataHandlerAbstract.hpp:31</div></div>
175180
<div class="ttc" id="aclassudmaio_1_1_dma_buffer_abstract_html"><div class="ttname"><a href="classudmaio_1_1_dma_buffer_abstract.html">udmaio::DmaBufferAbstract</a></div><div class="ttdoc">Base class for DMA data buffer.</div><div class="ttdef"><b>Definition:</b> DmaBufferAbstract.hpp:24</div></div>
176181
<div class="ttc" id="aclassudmaio_1_1_uio_axi_dma_if_html"><div class="ttname"><a href="classudmaio_1_1_uio_axi_dma_if.html">udmaio::UioAxiDmaIf</a></div><div class="ttdoc">Interface to AXI DMA Core.</div><div class="ttdef"><b>Definition:</b> UioAxiDmaIf.hpp:23</div></div>

‎example/html/_data_handler_sync_8hpp_source.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,7 @@
128128
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"><a class="line" href="classudmaio_1_1_data_handler_sync.html#ac2229f46ef9580c91470316faf836276"> 25</a></span> std::optional&lt;std::thread&gt; <a class="code hl_variable" href="classudmaio_1_1_data_handler_sync.html#ac2229f46ef9580c91470316faf836276">_ioThread</a>; </div>
129129
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> </div>
130130
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> <span class="keyword">public</span>:</div>
131-
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> <span class="keyword">using </span><a class="code hl_function" href="classudmaio_1_1_data_handler_abstract.html#a5228c5ea1c6a7a4d9f9aad4c38b03f2b">DataHandlerAbstract::DataHandlerAbstract</a>;</div>
131+
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> <span class="keyword">using </span><a class="code hl_function" href="classudmaio_1_1_data_handler_abstract.html#ad3731cb36bac1fb2019eefaae629c833">DataHandlerAbstract::DataHandlerAbstract</a>;</div>
132132
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"><a class="line" href="classudmaio_1_1_data_handler_sync.html#a2c99b9d7544ba9e43af2cf0407b08fb2"> 29</a></span> <span class="keyword">virtual</span> <a class="code hl_function" href="classudmaio_1_1_data_handler_sync.html#a2c99b9d7544ba9e43af2cf0407b08fb2">~DataHandlerSync</a>();</div>
133133
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> </div>
134134
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"><a class="line" href="classudmaio_1_1_data_handler_sync.html#af9ef2065d6dcda7af1a6fbf64f2f24ca"> 32</a></span> <span class="keywordtype">void</span> <a class="code hl_function" href="classudmaio_1_1_data_handler_sync.html#af9ef2065d6dcda7af1a6fbf64f2f24ca">operator()</a>();</div>
@@ -147,7 +147,7 @@
147147
<div class="ttc" id="a_data_handler_abstract_8hpp_html"><div class="ttname"><a href="_data_handler_abstract_8hpp.html">DataHandlerAbstract.hpp</a></div></div>
148148
<div class="ttc" id="aclassudmaio_1_1_concurrent_queue_html"><div class="ttname"><a href="classudmaio_1_1_concurrent_queue.html">udmaio::ConcurrentQueue</a></div><div class="ttdoc">Helper class to implement a blocking FIFO between threads.</div><div class="ttdef"><b>Definition:</b> ConcurrentQueue.hpp:24</div></div>
149149
<div class="ttc" id="aclassudmaio_1_1_data_handler_abstract_html"><div class="ttname"><a href="classudmaio_1_1_data_handler_abstract.html">udmaio::DataHandlerAbstract</a></div><div class="ttdoc">Base class to implement a DMA data reception handler.</div><div class="ttdef"><b>Definition:</b> DataHandlerAbstract.hpp:29</div></div>
150-
<div class="ttc" id="aclassudmaio_1_1_data_handler_abstract_html_a5228c5ea1c6a7a4d9f9aad4c38b03f2b"><div class="ttname"><a href="classudmaio_1_1_data_handler_abstract.html#a5228c5ea1c6a7a4d9f9aad4c38b03f2b">udmaio::DataHandlerAbstract::DataHandlerAbstract</a></div><div class="ttdeci">DataHandlerAbstract(std::string name, UioAxiDmaIf &amp;dma, UioMemSgdma &amp;desc, DmaBufferAbstract &amp;mem)</div><div class="ttdoc">Construct a Data Handler.</div></div>
150+
<div class="ttc" id="aclassudmaio_1_1_data_handler_abstract_html_ad3731cb36bac1fb2019eefaae629c833"><div class="ttname"><a href="classudmaio_1_1_data_handler_abstract.html#ad3731cb36bac1fb2019eefaae629c833">udmaio::DataHandlerAbstract::DataHandlerAbstract</a></div><div class="ttdeci">DataHandlerAbstract(std::string name, UioAxiDmaIf &amp;dma, UioMemSgdma &amp;desc, DmaBufferAbstract &amp;mem, bool receive_packets=true)</div><div class="ttdoc">Construct a Data Handler.</div></div>
151151
<div class="ttc" id="aclassudmaio_1_1_data_handler_sync_html"><div class="ttname"><a href="classudmaio_1_1_data_handler_sync.html">udmaio::DataHandlerSync</a></div><div class="ttdoc">Synchronous data handler with blocking read interface.</div><div class="ttdef"><b>Definition:</b> DataHandlerSync.hpp:23</div></div>
152152
<div class="ttc" id="aclassudmaio_1_1_data_handler_sync_html_a2a4c89eccf732b191817ec766bd54f82"><div class="ttname"><a href="classudmaio_1_1_data_handler_sync.html#a2a4c89eccf732b191817ec766bd54f82">udmaio::DataHandlerSync::stop</a></div><div class="ttdeci">virtual void stop() override</div><div class="ttdoc">Stop the data reception.</div></div>
153153
<div class="ttc" id="aclassudmaio_1_1_data_handler_sync_html_a2c99b9d7544ba9e43af2cf0407b08fb2"><div class="ttname"><a href="classudmaio_1_1_data_handler_sync.html#a2c99b9d7544ba9e43af2cf0407b08fb2">udmaio::DataHandlerSync::~DataHandlerSync</a></div><div class="ttdeci">virtual ~DataHandlerSync()</div></div>

0 commit comments

Comments
 (0)