-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathclasscynq_1_1XRTDataMover.html
More file actions
492 lines (462 loc) · 30 KB
/
classcynq_1_1XRTDataMover.html
File metadata and controls
492 lines (462 loc) · 30 KB
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
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
<!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: cynq::XRTDataMover Class Reference</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('classcynq_1_1XRTDataMover.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="summary">
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<div class="title">cynq::XRTDataMover Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><a class="el" href="classcynq_1_1XRTDataMover.html" title="XRTDataMover class Provides the api from which to interact with the data buffers responsable for memo...">XRTDataMover</a> class Provides the api from which to interact with the data buffers responsable for memory operations making use of the Xilinx runtime (XRT) the types are the following: BO (Buffer object) DMA (Direct memory allocation)
<a href="classcynq_1_1XRTDataMover.html#details">More...</a></p>
<p><code>#include <<a class="el" href="xrt_2datamover_8hpp_source.html">datamover.hpp</a>></code></p>
<div class="dynheader">
Inheritance diagram for cynq::XRTDataMover:</div>
<div class="dyncontent">
<div class="center"><img src="classcynq_1_1XRTDataMover__inherit__graph.png" border="0" usemap="#cynq_1_1XRTDataMover_inherit__map" alt="Inheritance graph"/></div>
<map name="cynq_1_1XRTDataMover_inherit__map" id="cynq_1_1XRTDataMover_inherit__map">
<area shape="rect" id="node2" href="classcynq_1_1IDataMover.html" title="Interface for standardising the API of DataMover for a specific device: XRTDataMover. " alt="" coords="17,5,143,32"/>
</map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for cynq::XRTDataMover:</div>
<div class="dyncontent">
<div class="center"><img src="classcynq_1_1XRTDataMover__coll__graph.png" border="0" usemap="#cynq_1_1XRTDataMover_coll__map" alt="Collaboration graph"/></div>
<map name="cynq_1_1XRTDataMover_coll__map" id="cynq_1_1XRTDataMover_coll__map">
<area shape="rect" id="node2" href="classcynq_1_1IDataMover.html" title="Interface for standardising the API of DataMover for a specific device: XRTDataMover. " alt="" coords="17,5,143,32"/>
</map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a13f5c6366c3b69406ab15db760d37c95"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcynq_1_1XRTDataMover.html#a13f5c6366c3b69406ab15db760d37c95">XRTDataMover</a> (const uint64_t addr, std::shared_ptr< <a class="el" href="structcynq_1_1HardwareParameters.html">HardwareParameters</a> > hwparams)</td></tr>
<tr class="memdesc:a13f5c6366c3b69406ab15db760d37c95"><td class="mdescLeft"> </td><td class="mdescRight">Construct a new <a class="el" href="classcynq_1_1XRTDataMover.html" title="XRTDataMover class Provides the api from which to interact with the data buffers responsable for memo...">XRTDataMover</a> object. <a href="#a13f5c6366c3b69406ab15db760d37c95">More...</a><br /></td></tr>
<tr class="separator:a13f5c6366c3b69406ab15db760d37c95"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a856ebfc4aa9e1a3d62d665843cf8640e"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcynq_1_1XRTDataMover.html#a856ebfc4aa9e1a3d62d665843cf8640e">XRTDataMover</a> ()=delete</td></tr>
<tr class="memdesc:a856ebfc4aa9e1a3d62d665843cf8640e"><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <a href="#a856ebfc4aa9e1a3d62d665843cf8640e">More...</a><br /></td></tr>
<tr class="separator:a856ebfc4aa9e1a3d62d665843cf8640e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a944c143f7ccfa28817a112a903f617d2"><td class="memItemLeft" align="right" valign="top"><a id="a944c143f7ccfa28817a112a903f617d2"></a>
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classcynq_1_1XRTDataMover.html#a944c143f7ccfa28817a112a903f617d2">~XRTDataMover</a> ()</td></tr>
<tr class="memdesc:a944c143f7ccfa28817a112a903f617d2"><td class="mdescLeft"> </td><td class="mdescRight">~XRTDatamover destructor method Destroy the XRTDatamover object. <br /></td></tr>
<tr class="separator:a944c143f7ccfa28817a112a903f617d2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2f8151ec78fe5af8a151aaa852dbac5d"><td class="memItemLeft" align="right" valign="top">std::shared_ptr< <a class="el" href="classcynq_1_1IMemory.html">IMemory</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classcynq_1_1XRTDataMover.html#a2f8151ec78fe5af8a151aaa852dbac5d">GetBuffer</a> (const size_t size, const MemoryType type=MemoryType::Dual) override</td></tr>
<tr class="memdesc:a2f8151ec78fe5af8a151aaa852dbac5d"><td class="mdescLeft"> </td><td class="mdescRight">GetBuffer method This method allocates a memory buffer. Depending on the MemoryType, it allocates memory in a contiguous or memory region (non-pageable) or non contiguous memory region depending on the Memory typed past to the method. The memory can be mirrored with pageable memory for its use in the host (or CPU). <a href="#a2f8151ec78fe5af8a151aaa852dbac5d">More...</a><br /></td></tr>
<tr class="separator:a2f8151ec78fe5af8a151aaa852dbac5d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac06d357e8d8f13618f6326afe3e23636"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structcynq_1_1Status.html">Status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcynq_1_1XRTDataMover.html#ac06d357e8d8f13618f6326afe3e23636">Upload</a> (const std::shared_ptr< <a class="el" href="classcynq_1_1IMemory.html">IMemory</a> > mem, const size_t size, const size_t offset, const ExecutionType exetype) override</td></tr>
<tr class="memdesc:ac06d357e8d8f13618f6326afe3e23636"><td class="mdescLeft"> </td><td class="mdescRight">Upload method This method moves the data from the host to the device using a DMA engine. This triggers the AXI Memory Map and AXI Stream Transactions under the hood. <a href="#ac06d357e8d8f13618f6326afe3e23636">More...</a><br /></td></tr>
<tr class="separator:ac06d357e8d8f13618f6326afe3e23636"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a63dca68f7bddc5c4ac03a7513c28b2f7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structcynq_1_1Status.html">Status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcynq_1_1XRTDataMover.html#a63dca68f7bddc5c4ac03a7513c28b2f7">Download</a> (const std::shared_ptr< <a class="el" href="classcynq_1_1IMemory.html">IMemory</a> > mem, const size_t size, const size_t offset, const ExecutionType exetype) override</td></tr>
<tr class="memdesc:a63dca68f7bddc5c4ac03a7513c28b2f7"><td class="mdescLeft"> </td><td class="mdescRight">Download method. <a href="#a63dca68f7bddc5c4ac03a7513c28b2f7">More...</a><br /></td></tr>
<tr class="separator:a63dca68f7bddc5c4ac03a7513c28b2f7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae5229803ac8c0e664f47154f68978978"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structcynq_1_1Status.html">Status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcynq_1_1XRTDataMover.html#ae5229803ac8c0e664f47154f68978978">Sync</a> (const SyncType type) override</td></tr>
<tr class="memdesc:ae5229803ac8c0e664f47154f68978978"><td class="mdescLeft"> </td><td class="mdescRight">Sync method Synchronizes data movements in case of asynchronous Upload/Download. <a href="#ae5229803ac8c0e664f47154f68978978">More...</a><br /></td></tr>
<tr class="separator:ae5229803ac8c0e664f47154f68978978"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a01d6465fb5656a4f2727cc28bc1390f5"><td class="memItemLeft" align="right" valign="top">DeviceStatus </td><td class="memItemRight" valign="bottom"><a class="el" href="classcynq_1_1XRTDataMover.html#a01d6465fb5656a4f2727cc28bc1390f5">GetStatus</a> () override</td></tr>
<tr class="memdesc:a01d6465fb5656a4f2727cc28bc1390f5"><td class="mdescLeft"> </td><td class="mdescRight">GetStatus method Returns the status of the data mover in terms of transactions. <a href="#a01d6465fb5656a4f2727cc28bc1390f5">More...</a><br /></td></tr>
<tr class="separator:a01d6465fb5656a4f2727cc28bc1390f5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_methods_classcynq_1_1IDataMover"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classcynq_1_1IDataMover')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classcynq_1_1IDataMover.html">cynq::IDataMover</a></td></tr>
<tr class="memitem:ac12de65b05dd9e2c0fdfcacec17a4a8f inherit pub_methods_classcynq_1_1IDataMover"><td class="memItemLeft" align="right" valign="top"><a id="ac12de65b05dd9e2c0fdfcacec17a4a8f"></a>
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classcynq_1_1IDataMover.html#ac12de65b05dd9e2c0fdfcacec17a4a8f">~IDataMover</a> ()=default</td></tr>
<tr class="memdesc:ac12de65b05dd9e2c0fdfcacec17a4a8f inherit pub_methods_classcynq_1_1IDataMover"><td class="mdescLeft"> </td><td class="mdescRight">~IDataMover destructor method Destroy the <a class="el" href="classcynq_1_1IDataMover.html" title="Interface for standardising the API of DataMover for a specific device: XRTDataMover. ">IDataMover</a> object. <br /></td></tr>
<tr class="separator:ac12de65b05dd9e2c0fdfcacec17a4a8f inherit pub_methods_classcynq_1_1IDataMover"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pub_types_classcynq_1_1IDataMover"><td colspan="2" onclick="javascript:toggleInherit('pub_types_classcynq_1_1IDataMover')"><img src="closed.png" alt="-"/> Public Types inherited from <a class="el" href="classcynq_1_1IDataMover.html">cynq::IDataMover</a></td></tr>
<tr class="memitem:a49c77afa8a4effaab4d91f0aa8a3fec4 inherit pub_types_classcynq_1_1IDataMover"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="classcynq_1_1IDataMover.html#a49c77afa8a4effaab4d91f0aa8a3fec4">Type</a> { <a class="el" href="classcynq_1_1IDataMover.html#a49c77afa8a4effaab4d91f0aa8a3fec4a8302850dfa953ea5e9ee3663e9966394">None</a> = 0,
<a class="el" href="classcynq_1_1IDataMover.html#a49c77afa8a4effaab4d91f0aa8a3fec4a1b63f9ee7fea8143935a0ffc9649333e">XRT</a>
}<tr class="memdesc:a49c77afa8a4effaab4d91f0aa8a3fec4"><td class="mdescLeft"> </td><td class="mdescRight">Type Type of runtime supported by the <a class="el" href="classcynq_1_1IDataMover.html" title="Interface for standardising the API of DataMover for a specific device: XRTDataMover. ">IDataMover</a>. <a href="classcynq_1_1IDataMover.html#a49c77afa8a4effaab4d91f0aa8a3fec4">More...</a><br /></td></tr>
</td></tr>
<tr class="separator:a49c77afa8a4effaab4d91f0aa8a3fec4 inherit pub_types_classcynq_1_1IDataMover"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_static_methods_classcynq_1_1IDataMover"><td colspan="2" onclick="javascript:toggleInherit('pub_static_methods_classcynq_1_1IDataMover')"><img src="closed.png" alt="-"/> Static Public Member Functions inherited from <a class="el" href="classcynq_1_1IDataMover.html">cynq::IDataMover</a></td></tr>
<tr class="memitem:a54f4f43130fe8e391eaecfc44df36665 inherit pub_static_methods_classcynq_1_1IDataMover"><td class="memItemLeft" align="right" valign="top">static std::shared_ptr< <a class="el" href="classcynq_1_1IDataMover.html">IDataMover</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classcynq_1_1IDataMover.html#a54f4f43130fe8e391eaecfc44df36665">Create</a> (<a class="el" href="classcynq_1_1IDataMover.html#a49c77afa8a4effaab4d91f0aa8a3fec4">IDataMover::Type</a> impl, const uint64_t addr, std::shared_ptr< <a class="el" href="structcynq_1_1HardwareParameters.html">HardwareParameters</a> > hwparams)</td></tr>
<tr class="memdesc:a54f4f43130fe8e391eaecfc44df36665 inherit pub_static_methods_classcynq_1_1IDataMover"><td class="mdescLeft"> </td><td class="mdescRight">Create method Factory method used for creating specific subclasses of <a class="el" href="classcynq_1_1IDataMover.html" title="Interface for standardising the API of DataMover for a specific device: XRTDataMover. ">IDataMover</a>. <a href="classcynq_1_1IDataMover.html#a54f4f43130fe8e391eaecfc44df36665">More...</a><br /></td></tr>
<tr class="separator:a54f4f43130fe8e391eaecfc44df36665 inherit pub_static_methods_classcynq_1_1IDataMover"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p><a class="el" href="classcynq_1_1XRTDataMover.html" title="XRTDataMover class Provides the api from which to interact with the data buffers responsable for memo...">XRTDataMover</a> class Provides the api from which to interact with the data buffers responsable for memory operations making use of the Xilinx runtime (XRT) the types are the following: BO (Buffer object) DMA (Direct memory allocation) </p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="a13f5c6366c3b69406ab15db760d37c95"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a13f5c6366c3b69406ab15db760d37c95">◆ </a></span>XRTDataMover() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">cynq::XRTDataMover::XRTDataMover </td>
<td>(</td>
<td class="paramtype">const uint64_t </td>
<td class="paramname"><em>addr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::shared_ptr< <a class="el" href="structcynq_1_1HardwareParameters.html">HardwareParameters</a> > </td>
<td class="paramname"><em>hwparams</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Construct a new <a class="el" href="classcynq_1_1XRTDataMover.html" title="XRTDataMover class Provides the api from which to interact with the data buffers responsable for memo...">XRTDataMover</a> object. </p>
<p>This constructs a data mover that uses DMA to execute the transfers between the host and the device. Moreover, it uses XRT buffer object as memory buffers. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">addr</td><td>DMA address in the physical memory map </td></tr>
<tr><td class="paramname">hwparams</td><td>Hardware-specific params </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a856ebfc4aa9e1a3d62d665843cf8640e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a856ebfc4aa9e1a3d62d665843cf8640e">◆ </a></span>XRTDataMover() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">cynq::XRTDataMover::XRTDataMover </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">delete</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Default constructor. </p>
<p>The default constructor is deleted since the address is mandatory for the DMA transfer. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a63dca68f7bddc5c4ac03a7513c28b2f7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a63dca68f7bddc5c4ac03a7513c28b2f7">◆ </a></span>Download()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structcynq_1_1Status.html">Status</a> cynq::XRTDataMover::Download </td>
<td>(</td>
<td class="paramtype">const std::shared_ptr< <a class="el" href="classcynq_1_1IMemory.html">IMemory</a> > </td>
<td class="paramname"><em>mem</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const size_t </td>
<td class="paramname"><em>size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const size_t </td>
<td class="paramname"><em>offset</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const ExecutionType </td>
<td class="paramname"><em>exetype</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Download method. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">mem</td><td><a class="el" href="classcynq_1_1IMemory.html" title="Interface for standardising the API of Memory devices: XRTMemory. ">IMemory</a> instance to download.</td></tr>
<tr><td class="paramname">size</td><td>Size in bytes of data being downloaded from the memory device by making use of the buffer.</td></tr>
<tr><td class="paramname">offset</td><td>Offset in bytes where the device pointer should start</td></tr>
<tr><td class="paramname">exetype</td><td>The execution type to use for the download, this is either sync (synchronous) or async (asynchronous) execution.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="structcynq_1_1Status.html" title="Structure to define the return characteristics of each function. ">Status</a> </dd></dl>
<p>Implements <a class="el" href="classcynq_1_1IDataMover.html#afd87fb9395f3d07c6d2ef4ae4bc19b32">cynq::IDataMover</a>.</p>
</div>
</div>
<a id="a2f8151ec78fe5af8a151aaa852dbac5d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2f8151ec78fe5af8a151aaa852dbac5d">◆ </a></span>GetBuffer()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::shared_ptr< <a class="el" href="classcynq_1_1IMemory.html">IMemory</a> > cynq::XRTDataMover::GetBuffer </td>
<td>(</td>
<td class="paramtype">const size_t </td>
<td class="paramname"><em>size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const MemoryType </td>
<td class="paramname"><em>type</em> = <code>MemoryType::Dual</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>GetBuffer method This method allocates a memory buffer. Depending on the MemoryType, it allocates memory in a contiguous or memory region (non-pageable) or non contiguous memory region depending on the Memory typed past to the method. The memory can be mirrored with pageable memory for its use in the host (or CPU). </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">size</td><td>Size in bytes of the buffer.</td></tr>
<tr><td class="paramname">type</td><td>One of the values in the MemoryType enum class which can be one of the following: Dual (DIMM memory) Cacheable (cache) Host (Memory from the host) Device (Memory from the device to be mapped)</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>std::shared_ptr<IMemory> </dd></dl>
<p>Implements <a class="el" href="classcynq_1_1IDataMover.html#a6cf3ccd41bb319c2344258ed7fa81858">cynq::IDataMover</a>.</p>
</div>
</div>
<a id="a01d6465fb5656a4f2727cc28bc1390f5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a01d6465fb5656a4f2727cc28bc1390f5">◆ </a></span>GetStatus()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">DeviceStatus cynq::XRTDataMover::GetStatus </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>GetStatus method Returns the status of the data mover in terms of transactions. </p>
<dl class="section return"><dt>Returns</dt><dd>DeviceStatus </dd></dl>
<p>Implements <a class="el" href="classcynq_1_1IDataMover.html#a885a9424b0fbd4b881a1505c32993f0c">cynq::IDataMover</a>.</p>
</div>
</div>
<a id="ae5229803ac8c0e664f47154f68978978"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae5229803ac8c0e664f47154f68978978">◆ </a></span>Sync()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structcynq_1_1Status.html">Status</a> cynq::XRTDataMover::Sync </td>
<td>(</td>
<td class="paramtype">const SyncType </td>
<td class="paramname"><em>type</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Sync method Synchronizes data movements in case of asynchronous Upload/Download. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">type</td><td>sync type. Depending on the transaction, it will trigger sync </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="structcynq_1_1Status.html" title="Structure to define the return characteristics of each function. ">Status</a> </dd></dl>
<p>Implements <a class="el" href="classcynq_1_1IDataMover.html#a694dce2a4a9d6e150de1dd9992f59df8">cynq::IDataMover</a>.</p>
</div>
</div>
<a id="ac06d357e8d8f13618f6326afe3e23636"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac06d357e8d8f13618f6326afe3e23636">◆ </a></span>Upload()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structcynq_1_1Status.html">Status</a> cynq::XRTDataMover::Upload </td>
<td>(</td>
<td class="paramtype">const std::shared_ptr< <a class="el" href="classcynq_1_1IMemory.html">IMemory</a> > </td>
<td class="paramname"><em>mem</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const size_t </td>
<td class="paramname"><em>size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const size_t </td>
<td class="paramname"><em>offset</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const ExecutionType </td>
<td class="paramname"><em>exetype</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Upload method This method moves the data from the host to the device using a DMA engine. This triggers the AXI Memory Map and AXI Stream Transactions under the hood. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">mem</td><td><a class="el" href="classcynq_1_1XRTMemory.html" title="XRTMemory class Provides the api for configuring the data buffers, this class is based on the Buffer ...">XRTMemory</a> instance to upload.</td></tr>
<tr><td class="paramname">size</td><td>Size in bytes of data being uploaded in the memory device by making use of the buffer.</td></tr>
<tr><td class="paramname">offset</td><td>Offset in bytes where the device pointer should start</td></tr>
<tr><td class="paramname">exetype</td><td>The execution type to use for the upload, this is either sync (synchronous) or async (asynchronous) execution.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="structcynq_1_1Status.html" title="Structure to define the return characteristics of each function. ">Status</a> </dd></dl>
<p>Implements <a class="el" href="classcynq_1_1IDataMover.html#a4b4edd65dab0f80bfce10964c14f4ebd">cynq::IDataMover</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>/media/lleon95/data/Personal/cynq/include/cynq/xrt/<a class="el" href="xrt_2datamover_8hpp_source.html">datamover.hpp</a></li>
<li>/media/lleon95/data/Personal/cynq/src/cynq/xrt/datamover.cpp</li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><b>cynq</b></li><li class="navelem"><a class="el" href="classcynq_1_1XRTDataMover.html">XRTDataMover</a></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>