-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathclasscynq_1_1XRTMemory.html
433 lines (405 loc) · 26.8 KB
/
classcynq_1_1XRTMemory.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
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
<!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::XRTMemory 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_1XRTMemory.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> |
<a href="#pro-methods">Protected Member Functions</a> |
<a href="#friends">Friends</a> </div>
<div class="headertitle">
<div class="title">cynq::XRTMemory Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><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> class Provides the api for configuring the data buffers, this class is based on the Buffer object from the xilinx runtime.
<a href="classcynq_1_1XRTMemory.html#details">More...</a></p>
<p><code>#include <<a class="el" href="xrt_2memory_8hpp_source.html">memory.hpp</a>></code></p>
<div class="dynheader">
Inheritance diagram for cynq::XRTMemory:</div>
<div class="dyncontent">
<div class="center"><img src="classcynq_1_1XRTMemory__inherit__graph.png" border="0" usemap="#cynq_1_1XRTMemory_inherit__map" alt="Inheritance graph"/></div>
<map name="cynq_1_1XRTMemory_inherit__map" id="cynq_1_1XRTMemory_inherit__map">
<area shape="rect" id="node2" href="classcynq_1_1IMemory.html" title="Interface for standardising the API of Memory devices: XRTMemory. " alt="" coords="17,5,126,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::XRTMemory:</div>
<div class="dyncontent">
<div class="center"><img src="classcynq_1_1XRTMemory__coll__graph.png" border="0" usemap="#cynq_1_1XRTMemory_coll__map" alt="Collaboration graph"/></div>
<map name="cynq_1_1XRTMemory_coll__map" id="cynq_1_1XRTMemory_coll__map">
<area shape="rect" id="node2" href="classcynq_1_1IMemory.html" title="Interface for standardising the API of Memory devices: XRTMemory. " alt="" coords="17,5,126,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:a06af580d684d4d37f8b322bba00dfbf7"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcynq_1_1XRTMemory.html#a06af580d684d4d37f8b322bba00dfbf7">XRTMemory</a> (const std::size_t size, uint8_t *hostptr, uint8_t *devptr, void *moverptr)</td></tr>
<tr class="memdesc:a06af580d684d4d37f8b322bba00dfbf7"><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="#a06af580d684d4d37f8b322bba00dfbf7">More...</a><br /></td></tr>
<tr class="separator:a06af580d684d4d37f8b322bba00dfbf7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad43bccecb20bc1e948f827cbb18cc60d"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcynq_1_1XRTMemory.html#ad43bccecb20bc1e948f827cbb18cc60d">XRTMemory</a> ()=delete</td></tr>
<tr class="memdesc:ad43bccecb20bc1e948f827cbb18cc60d"><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <a href="#ad43bccecb20bc1e948f827cbb18cc60d">More...</a><br /></td></tr>
<tr class="separator:ad43bccecb20bc1e948f827cbb18cc60d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5e9279bd77018f1b71bd69be1b9ed5dd"><td class="memItemLeft" align="right" valign="top"><a id="a5e9279bd77018f1b71bd69be1b9ed5dd"></a>
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classcynq_1_1XRTMemory.html#a5e9279bd77018f1b71bd69be1b9ed5dd">~XRTMemory</a> ()</td></tr>
<tr class="memdesc:a5e9279bd77018f1b71bd69be1b9ed5dd"><td class="mdescLeft"> </td><td class="mdescRight">~XRTMemory destructor method Destroy the <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> object. <br /></td></tr>
<tr class="separator:a5e9279bd77018f1b71bd69be1b9ed5dd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a247779e9603dfca48e3042c2003ceb3c"><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_1XRTMemory.html#a247779e9603dfca48e3042c2003ceb3c">Sync</a> (const SyncType type) override</td></tr>
<tr class="memdesc:a247779e9603dfca48e3042c2003ceb3c"><td class="mdescLeft"> </td><td class="mdescRight">Sync method Synchronizes the memory in terms of transactions. <a href="#a247779e9603dfca48e3042c2003ceb3c">More...</a><br /></td></tr>
<tr class="separator:a247779e9603dfca48e3042c2003ceb3c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2c0db868180ea65b574331b0360bc507"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classcynq_1_1XRTMemory.html#a2c0db868180ea65b574331b0360bc507">Size</a> () override</td></tr>
<tr class="memdesc:a2c0db868180ea65b574331b0360bc507"><td class="mdescLeft"> </td><td class="mdescRight">Size method Gives the value for the memory size in bytes. <a href="#a2c0db868180ea65b574331b0360bc507">More...</a><br /></td></tr>
<tr class="separator:a2c0db868180ea65b574331b0360bc507"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_methods_classcynq_1_1IMemory"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classcynq_1_1IMemory')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classcynq_1_1IMemory.html">cynq::IMemory</a></td></tr>
<tr class="memitem:a15d660f6982fdfa3f875cb66fbeb0a5c inherit pub_methods_classcynq_1_1IMemory"><td class="memItemLeft" align="right" valign="top"><a id="a15d660f6982fdfa3f875cb66fbeb0a5c"></a>
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classcynq_1_1IMemory.html#a15d660f6982fdfa3f875cb66fbeb0a5c">~IMemory</a> ()=default</td></tr>
<tr class="memdesc:a15d660f6982fdfa3f875cb66fbeb0a5c inherit pub_methods_classcynq_1_1IMemory"><td class="mdescLeft"> </td><td class="mdescRight">~IMemory destructor method Destroy the <a class="el" href="classcynq_1_1IMemory.html" title="Interface for standardising the API of Memory devices: XRTMemory. ">IMemory</a> object. <br /></td></tr>
<tr class="separator:a15d660f6982fdfa3f875cb66fbeb0a5c inherit pub_methods_classcynq_1_1IMemory"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aea8ef51b4c376b58e3e143dd270d92ac inherit pub_methods_classcynq_1_1IMemory"><td class="memTemplParams" colspan="2">template<typename T > </td></tr>
<tr class="memitem:aea8ef51b4c376b58e3e143dd270d92ac inherit pub_methods_classcynq_1_1IMemory"><td class="memTemplItemLeft" align="right" valign="top">std::shared_ptr< T > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classcynq_1_1IMemory.html#aea8ef51b4c376b58e3e143dd270d92ac">HostAddress</a> ()</td></tr>
<tr class="memdesc:aea8ef51b4c376b58e3e143dd270d92ac inherit pub_methods_classcynq_1_1IMemory"><td class="mdescLeft"> </td><td class="mdescRight">HostAddress method Getter for the address of the host. <a href="classcynq_1_1IMemory.html#aea8ef51b4c376b58e3e143dd270d92ac">More...</a><br /></td></tr>
<tr class="separator:aea8ef51b4c376b58e3e143dd270d92ac inherit pub_methods_classcynq_1_1IMemory"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6dc8b6724c7528ea743a2898d6c5ec11 inherit pub_methods_classcynq_1_1IMemory"><td class="memTemplParams" colspan="2">template<typename T > </td></tr>
<tr class="memitem:a6dc8b6724c7528ea743a2898d6c5ec11 inherit pub_methods_classcynq_1_1IMemory"><td class="memTemplItemLeft" align="right" valign="top">std::shared_ptr< T > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classcynq_1_1IMemory.html#a6dc8b6724c7528ea743a2898d6c5ec11">DeviceAddress</a> ()</td></tr>
<tr class="memdesc:a6dc8b6724c7528ea743a2898d6c5ec11 inherit pub_methods_classcynq_1_1IMemory"><td class="mdescLeft"> </td><td class="mdescRight">DeviceAddress method Getter for the address of the device. <a href="classcynq_1_1IMemory.html#a6dc8b6724c7528ea743a2898d6c5ec11">More...</a><br /></td></tr>
<tr class="separator:a6dc8b6724c7528ea743a2898d6c5ec11 inherit pub_methods_classcynq_1_1IMemory"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:a13ec029b094be07b48842927ddf80997"><td class="memItemLeft" align="right" valign="top">std::shared_ptr< uint8_t > </td><td class="memItemRight" valign="bottom"><a class="el" href="classcynq_1_1XRTMemory.html#a13ec029b094be07b48842927ddf80997">GetHostAddress</a> () override</td></tr>
<tr class="memdesc:a13ec029b094be07b48842927ddf80997"><td class="mdescLeft"> </td><td class="mdescRight">GetHostAddress method Get the Address that belongs to the host. [Reference] shared memory pointer with reference counting. <a href="#a13ec029b094be07b48842927ddf80997">More...</a><br /></td></tr>
<tr class="separator:a13ec029b094be07b48842927ddf80997"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af5b243dc52df37cf4dc71c611a124bdf"><td class="memItemLeft" align="right" valign="top">std::shared_ptr< uint8_t > </td><td class="memItemRight" valign="bottom"><a class="el" href="classcynq_1_1XRTMemory.html#af5b243dc52df37cf4dc71c611a124bdf">GetDeviceAddress</a> () override</td></tr>
<tr class="memdesc:af5b243dc52df37cf4dc71c611a124bdf"><td class="mdescLeft"> </td><td class="mdescRight">GetDeviceAddress method Get the Address that belongs to the device. [Reference] shared memory pointer with reference counting. <a href="#af5b243dc52df37cf4dc71c611a124bdf">More...</a><br /></td></tr>
<tr class="separator:af5b243dc52df37cf4dc71c611a124bdf"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
Friends</h2></td></tr>
<tr class="memitem:a396ad56304d1cff148a5728b6dc0af89"><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classcynq_1_1XRTMemory.html#a396ad56304d1cff148a5728b6dc0af89">XRTDataMover</a></td></tr>
<tr class="separator:a396ad56304d1cff148a5728b6dc0af89"><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_1IMemory"><td colspan="2" onclick="javascript:toggleInherit('pub_types_classcynq_1_1IMemory')"><img src="closed.png" alt="-"/> Public Types inherited from <a class="el" href="classcynq_1_1IMemory.html">cynq::IMemory</a></td></tr>
<tr class="memitem:add4032f8b90c3b6fb2eb48ddacd95b7f inherit pub_types_classcynq_1_1IMemory"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="classcynq_1_1IMemory.html#add4032f8b90c3b6fb2eb48ddacd95b7f">Type</a> { <a class="el" href="classcynq_1_1IMemory.html#add4032f8b90c3b6fb2eb48ddacd95b7fa7f99b4fcc3f3b95dac96ee4d1aec3e8c">None</a> = 0,
<a class="el" href="classcynq_1_1IMemory.html#add4032f8b90c3b6fb2eb48ddacd95b7fa6da6376df60753ff3cfad73f85a4c4c1">XRT</a>
}<tr class="memdesc:add4032f8b90c3b6fb2eb48ddacd95b7f"><td class="mdescLeft"> </td><td class="mdescRight">Type Type of runtime supported by the <a class="el" href="classcynq_1_1IMemory.html" title="Interface for standardising the API of Memory devices: XRTMemory. ">IMemory</a>. <a href="classcynq_1_1IMemory.html#add4032f8b90c3b6fb2eb48ddacd95b7f">More...</a><br /></td></tr>
</td></tr>
<tr class="separator:add4032f8b90c3b6fb2eb48ddacd95b7f inherit pub_types_classcynq_1_1IMemory"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_static_methods_classcynq_1_1IMemory"><td colspan="2" onclick="javascript:toggleInherit('pub_static_methods_classcynq_1_1IMemory')"><img src="closed.png" alt="-"/> Static Public Member Functions inherited from <a class="el" href="classcynq_1_1IMemory.html">cynq::IMemory</a></td></tr>
<tr class="memitem:a72d8234980a09a5d258aecf9eed31be0 inherit pub_static_methods_classcynq_1_1IMemory"><td class="memItemLeft" align="right" valign="top">static 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_1IMemory.html#a72d8234980a09a5d258aecf9eed31be0">Create</a> (<a class="el" href="classcynq_1_1IMemory.html#add4032f8b90c3b6fb2eb48ddacd95b7f">IMemory::Type</a> impl, const std::size_t size, uint8_t *hostptr, uint8_t *devptr, void *moverptr)</td></tr>
<tr class="memdesc:a72d8234980a09a5d258aecf9eed31be0 inherit pub_static_methods_classcynq_1_1IMemory"><td class="mdescLeft"> </td><td class="mdescRight">Create method Factory method to create specific subclasses of <a class="el" href="classcynq_1_1IMemory.html" title="Interface for standardising the API of Memory devices: XRTMemory. ">IMemory</a>. <a href="classcynq_1_1IMemory.html#a72d8234980a09a5d258aecf9eed31be0">More...</a><br /></td></tr>
<tr class="separator:a72d8234980a09a5d258aecf9eed31be0 inherit pub_static_methods_classcynq_1_1IMemory"><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_1XRTMemory.html" title="XRTMemory class Provides the api for configuring the data buffers, this class is based on the Buffer ...">XRTMemory</a> class Provides the api for configuring the data buffers, this class is based on the Buffer object from the xilinx runtime. </p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="a06af580d684d4d37f8b322bba00dfbf7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a06af580d684d4d37f8b322bba00dfbf7">◆ </a></span>XRTMemory() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">cynq::XRTMemory::XRTMemory </td>
<td>(</td>
<td class="paramtype">const std::size_t </td>
<td class="paramname"><em>size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t * </td>
<td class="paramname"><em>hostptr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t * </td>
<td class="paramname"><em>devptr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>moverptr</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>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">size</td><td>size of the memory region in bytes </td></tr>
<tr><td class="paramname">hostptr</td><td>host pointer where to store the host related memory. It can be null in case of using moverptr. </td></tr>
<tr><td class="paramname">devptr</td><td>host pointer where to store the device related memory. It can be null in case of using moverptr. </td></tr>
<tr><td class="paramname">moverptr</td><td>data mover specific metadata </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ad43bccecb20bc1e948f827cbb18cc60d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad43bccecb20bc1e948f827cbb18cc60d">◆ </a></span>XRTMemory() <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::XRTMemory::XRTMemory </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 because the Memory depends on the mover </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="af5b243dc52df37cf4dc71c611a124bdf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af5b243dc52df37cf4dc71c611a124bdf">◆ </a></span>GetDeviceAddress()</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< uint8_t > cynq::XRTMemory::GetDeviceAddress </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">protected</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>GetDeviceAddress method Get the Address that belongs to the device. [Reference] shared memory pointer with reference counting. </p>
<dl class="section return"><dt>Returns</dt><dd>std::shared_ptr<uint8_t> </dd></dl>
<p>Implements <a class="el" href="classcynq_1_1IMemory.html#a11abd454f8a45418eac9ad5125520715">cynq::IMemory</a>.</p>
</div>
</div>
<a id="a13ec029b094be07b48842927ddf80997"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a13ec029b094be07b48842927ddf80997">◆ </a></span>GetHostAddress()</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< uint8_t > cynq::XRTMemory::GetHostAddress </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">protected</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>GetHostAddress method Get the Address that belongs to the host. [Reference] shared memory pointer with reference counting. </p>
<dl class="section return"><dt>Returns</dt><dd>std::shared_ptr<uint8_t> </dd></dl>
<p>Implements <a class="el" href="classcynq_1_1IMemory.html#a86af42a27d66082f7592b53ecb2eb208">cynq::IMemory</a>.</p>
</div>
</div>
<a id="a2c0db868180ea65b574331b0360bc507"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2c0db868180ea65b574331b0360bc507">◆ </a></span>Size()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">size_t cynq::XRTMemory::Size </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>Size method Gives the value for the memory size in bytes. </p>
<dl class="section return"><dt>Returns</dt><dd>size_t </dd></dl>
<p>Implements <a class="el" href="classcynq_1_1IMemory.html#ac4f53b6c33a1c05c1eec2ea4e7921ae4">cynq::IMemory</a>.</p>
</div>
</div>
<a id="a247779e9603dfca48e3042c2003ceb3c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a247779e9603dfca48e3042c2003ceb3c">◆ </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::XRTMemory::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 the memory in terms of transactions. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">type</td><td>The orientation of the Synchronizaton this can be host to host to device (HostToDevice) or device to host (DeviceToHost).</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_1IMemory.html#a6a95840bb02441ca7d1269086d69f266">cynq::IMemory</a>.</p>
</div>
</div>
<h2 class="groupheader">Friends And Related Function Documentation</h2>
<a id="a396ad56304d1cff148a5728b6dc0af89"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a396ad56304d1cff148a5728b6dc0af89">◆ </a></span>XRTDataMover</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">friend class <a class="el" href="classcynq_1_1XRTDataMover.html">XRTDataMover</a></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">friend</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Define the friend relacionship between the mover and the memory </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_2memory_8hpp_source.html">memory.hpp</a></li>
<li>/media/lleon95/data/Personal/cynq/src/cynq/xrt/memory.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_1XRTMemory.html">XRTMemory</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>