-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathdatamover_8hpp_source.html
118 lines (116 loc) · 14.8 KB
/
datamover_8hpp_source.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>CYNQ: /media/lleon95/data/Personal/cynq/include/cynq/datamover.hpp Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { init_search(); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="logo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">CYNQ
 <span id="projectnumber">0.1.0</span>
</div>
<div id="projectbrief">Framework to develop FPGA applications in C++ with the easiness of PYNQ</div>
</td>
<td> <div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('datamover_8hpp_source.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="headertitle">
<div class="title">datamover.hpp</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/*</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * See LICENSE for more information about licensing</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> *</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> * Copyright 2023</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * Author: Luis G. Leon-Vega <[email protected]></span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * Diego Arturo Avila Torres <[email protected]></span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> *</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> */</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="preprocessor">#pragma once</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="preprocessor">#include <memory></span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> </div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="preprocessor">#include "cynq/enums.hpp"</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor">#include "cynq/memory.hpp"</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="preprocessor">#include "cynq/status.hpp"</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> </div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="keyword">namespace </span><a class="code" href="namespacecynq.html">cynq</a> {</div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> </div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="keyword">struct </span>HardwareParameters;</div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> </div><div class="line"><a name="l00024"></a><span class="lineno"><a class="line" href="structcynq_1_1DataMoverParameters.html"> 24</a></span> <span class="keyword">struct </span><a class="code" href="structcynq_1_1DataMoverParameters.html">DataMoverParameters</a> {</div><div class="line"><a name="l00026"></a><span class="lineno"><a class="line" href="structcynq_1_1DataMoverParameters.html#a4826f69395bce006ef83647284d5a98a"> 26</a></span>  std::shared_ptr<HardwareParameters> <a class="code" href="structcynq_1_1DataMoverParameters.html#a4826f69395bce006ef83647284d5a98a">hw_params_</a>;</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  <span class="keyword">virtual</span> <a class="code" href="structcynq_1_1DataMoverParameters.html#ab32a95eebb5e34b188406003cf13f296">~DataMoverParameters</a>() = <span class="keywordflow">default</span>;</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> };</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> </div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="keyword">struct </span><a class="code" href="structcynq_1_1HardwareParameters.html">HardwareParameters</a>;</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> </div><div class="line"><a name="l00039"></a><span class="lineno"><a class="line" href="classcynq_1_1IDataMover.html"> 39</a></span> <span class="keyword">class </span><a class="code" href="classcynq_1_1IDataMover.html">IDataMover</a> {</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <span class="keyword">virtual</span> ~<a class="code" href="classcynq_1_1IDataMover.html">IDataMover</a>() = <span class="keywordflow">default</span>;</div><div class="line"><a name="l00052"></a><span class="lineno"><a class="line" href="classcynq_1_1IDataMover.html#a49c77afa8a4effaab4d91f0aa8a3fec4"> 52</a></span>  <span class="keyword">enum</span> <a class="code" href="classcynq_1_1IDataMover.html#a49c77afa8a4effaab4d91f0aa8a3fec4">Type</a> {</div><div class="line"><a name="l00054"></a><span class="lineno"><a class="line" href="classcynq_1_1IDataMover.html#a49c77afa8a4effaab4d91f0aa8a3fec4a8302850dfa953ea5e9ee3663e9966394"> 54</a></span>  None = 0,</div><div class="line"><a name="l00056"></a><span class="lineno"><a class="line" href="classcynq_1_1IDataMover.html#a49c77afa8a4effaab4d91f0aa8a3fec4a1b63f9ee7fea8143935a0ffc9649333e"> 56</a></span>  XRT</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  };</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <span class="keyword">virtual</span> std::shared_ptr<IMemory> GetBuffer(</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <span class="keyword">const</span> <span class="keywordtype">size_t</span> size, <span class="keyword">const</span> MemoryType type = MemoryType::Dual) = 0;</div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  <span class="keyword">virtual</span> <a class="code" href="structcynq_1_1Status.html">Status</a> Upload(<span class="keyword">const</span> std::shared_ptr<IMemory> mem, <span class="keyword">const</span> <span class="keywordtype">size_t</span> size,</div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  <span class="keyword">const</span> <span class="keywordtype">size_t</span> offset, <span class="keyword">const</span> ExecutionType exetype) = 0;</div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  <span class="keyword">virtual</span> <a class="code" href="structcynq_1_1Status.html">Status</a> Download(<span class="keyword">const</span> std::shared_ptr<IMemory> mem, <span class="keyword">const</span> <span class="keywordtype">size_t</span> size,</div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span>  <span class="keyword">const</span> <span class="keywordtype">size_t</span> offset, <span class="keyword">const</span> ExecutionType exetype) = 0;</div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span>  <span class="keyword">virtual</span> <a class="code" href="structcynq_1_1Status.html">Status</a> Sync(<span class="keyword">const</span> SyncType type) = 0;</div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span>  <span class="keyword">virtual</span> DeviceStatus GetStatus() = 0;</div><div class="line"><a name="l00152"></a><span class="lineno"> 152</span>  <span class="keyword">static</span> std::shared_ptr<IDataMover> Create(</div><div class="line"><a name="l00153"></a><span class="lineno"> 153</span>  <a class="code" href="classcynq_1_1IDataMover.html#a49c77afa8a4effaab4d91f0aa8a3fec4">IDataMover::Type</a> impl, <span class="keyword">const</span> uint64_t addr,</div><div class="line"><a name="l00154"></a><span class="lineno"> 154</span>  std::shared_ptr<HardwareParameters> hwparams);</div><div class="line"><a name="l00155"></a><span class="lineno"> 155</span> };</div><div class="line"><a name="l00156"></a><span class="lineno"> 156</span> } <span class="comment">// namespace cynq</span></div><div class="ttc" id="classcynq_1_1IDataMover_html_a49c77afa8a4effaab4d91f0aa8a3fec4"><div class="ttname"><a href="classcynq_1_1IDataMover.html#a49c77afa8a4effaab4d91f0aa8a3fec4">cynq::IDataMover::Type</a></div><div class="ttdeci">Type</div><div class="ttdoc">Type Type of runtime supported by the IDataMover. </div><div class="ttdef"><b>Definition:</b> datamover.hpp:52</div></div>
<div class="ttc" id="namespacecynq_html"><div class="ttname"><a href="namespacecynq.html">cynq</a></div><div class="ttdef"><b>Definition:</b> accelerator.hpp:16</div></div>
<div class="ttc" id="structcynq_1_1DataMoverParameters_html_ab32a95eebb5e34b188406003cf13f296"><div class="ttname"><a href="structcynq_1_1DataMoverParameters.html#ab32a95eebb5e34b188406003cf13f296">cynq::DataMoverParameters::~DataMoverParameters</a></div><div class="ttdeci">virtual ~DataMoverParameters()=default</div></div>
<div class="ttc" id="structcynq_1_1DataMoverParameters_html_a4826f69395bce006ef83647284d5a98a"><div class="ttname"><a href="structcynq_1_1DataMoverParameters.html#a4826f69395bce006ef83647284d5a98a">cynq::DataMoverParameters::hw_params_</a></div><div class="ttdeci">std::shared_ptr< HardwareParameters > hw_params_</div><div class="ttdef"><b>Definition:</b> datamover.hpp:26</div></div>
<div class="ttc" id="structcynq_1_1HardwareParameters_html"><div class="ttname"><a href="structcynq_1_1HardwareParameters.html">cynq::HardwareParameters</a></div><div class="ttdoc">Define an abstract representation of the hardware parameters with some prefilled fields. </div><div class="ttdef"><b>Definition:</b> hardware.hpp:24</div></div>
<div class="ttc" id="structcynq_1_1Status_html"><div class="ttname"><a href="structcynq_1_1Status.html">cynq::Status</a></div><div class="ttdoc">Structure to define the return characteristics of each function. </div><div class="ttdef"><b>Definition:</b> status.hpp:19</div></div>
<div class="ttc" id="structcynq_1_1DataMoverParameters_html"><div class="ttname"><a href="structcynq_1_1DataMoverParameters.html">cynq::DataMoverParameters</a></div><div class="ttdoc">Define an abstract representation of the data mover parameters with some prefilled fields...</div><div class="ttdef"><b>Definition:</b> datamover.hpp:24</div></div>
<div class="ttc" id="classcynq_1_1IDataMover_html"><div class="ttname"><a href="classcynq_1_1IDataMover.html">cynq::IDataMover</a></div><div class="ttdoc">Interface for standardising the API of DataMover for a specific device: XRTDataMover. </div><div class="ttdef"><b>Definition:</b> datamover.hpp:39</div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_26279e7f67743b8ec91d21bfaeccecf7.html">cynq</a></li><li class="navelem"><b>datamover.hpp</b></li>
<li class="footer">Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
</ul>
</div>
</body>
</html>