-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathclasscynq_1_1IAccelerator.html
More file actions
581 lines (545 loc) · 31 KB
/
classcynq_1_1IAccelerator.html
File metadata and controls
581 lines (545 loc) · 31 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
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
<!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::IAccelerator 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_1IAccelerator.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-types">Public Types</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-methods">Static Public Member Functions</a> |
<a href="#pro-methods">Protected Member Functions</a> </div>
<div class="headertitle">
<div class="title">cynq::IAccelerator Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p>Interface for standardising the API for any Accelerator device: <a class="el" href="classcynq_1_1XRTAccelerator.html" title="XRTAccelerator class This class provides the api to operate the accelerator. ">XRTAccelerator</a>.
<a href="classcynq_1_1IAccelerator.html#details">More...</a></p>
<p><code>#include <<a class="el" href="accelerator_8hpp_source.html">accelerator.hpp</a>></code></p>
<div class="dynheader">
Inheritance diagram for cynq::IAccelerator:</div>
<div class="dyncontent">
<div class="center"><img src="classcynq_1_1IAccelerator__inherit__graph.png" border="0" usemap="#cynq_1_1IAccelerator_inherit__map" alt="Inheritance graph"/></div>
<map name="cynq_1_1IAccelerator_inherit__map" id="cynq_1_1IAccelerator_inherit__map">
<area shape="rect" id="node2" href="classcynq_1_1XRTAccelerator.html" title="XRTAccelerator class This class provides the api to operate the accelerator. " alt="" coords="5,80,156,107"/>
</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-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:a4c25efe8acfb1a6e01908dbdfbacfd6d"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="classcynq_1_1IAccelerator.html#a4c25efe8acfb1a6e01908dbdfbacfd6d">Type</a> { <a class="el" href="classcynq_1_1IAccelerator.html#a4c25efe8acfb1a6e01908dbdfbacfd6dacc4ba19f629441f35b484b09b16b2332">None</a> = 0,
<a class="el" href="classcynq_1_1IAccelerator.html#a4c25efe8acfb1a6e01908dbdfbacfd6da8be0a941dc809f299c00fcc1787e04a0">XRT</a>
}<tr class="memdesc:a4c25efe8acfb1a6e01908dbdfbacfd6d"><td class="mdescLeft"> </td><td class="mdescRight">Type Type of runtime supported by the <a class="el" href="classcynq_1_1IAccelerator.html" title="Interface for standardising the API for any Accelerator device: XRTAccelerator. ">IAccelerator</a>. <a href="classcynq_1_1IAccelerator.html#a4c25efe8acfb1a6e01908dbdfbacfd6d">More...</a><br /></td></tr>
</td></tr>
<tr class="separator:a4c25efe8acfb1a6e01908dbdfbacfd6d"><td class="memSeparator" colspan="2"> </td></tr>
</table><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:a48a1cffcd45a81f55ac18e0f108b2941"><td class="memItemLeft" align="right" valign="top"><a id="a48a1cffcd45a81f55ac18e0f108b2941"></a>
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classcynq_1_1IAccelerator.html#a48a1cffcd45a81f55ac18e0f108b2941">~IAccelerator</a> ()=default</td></tr>
<tr class="memdesc:a48a1cffcd45a81f55ac18e0f108b2941"><td class="mdescLeft"> </td><td class="mdescRight">~IAccelerator destructor method Destroy the <a class="el" href="classcynq_1_1IAccelerator.html" title="Interface for standardising the API for any Accelerator device: XRTAccelerator. ">IAccelerator</a> object. <br /></td></tr>
<tr class="separator:a48a1cffcd45a81f55ac18e0f108b2941"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac2b6ce03ee4e29d86e5abf2bc76b79e5"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="structcynq_1_1Status.html">Status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcynq_1_1IAccelerator.html#ac2b6ce03ee4e29d86e5abf2bc76b79e5">Start</a> (const StartMode mode)=0</td></tr>
<tr class="memdesc:ac2b6ce03ee4e29d86e5abf2bc76b79e5"><td class="mdescLeft"> </td><td class="mdescRight">Start method This method starts the accelerator in either once or continuous mode (with the autorestart). Under the hood, this writes the control register to turn on the accelerator with/without the autorestart bit. <a href="#ac2b6ce03ee4e29d86e5abf2bc76b79e5">More...</a><br /></td></tr>
<tr class="separator:ac2b6ce03ee4e29d86e5abf2bc76b79e5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a77b8b797e26fa0fed24bc994e35e54cc"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="structcynq_1_1Status.html">Status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcynq_1_1IAccelerator.html#a77b8b797e26fa0fed24bc994e35e54cc">Stop</a> ()=0</td></tr>
<tr class="memdesc:a77b8b797e26fa0fed24bc994e35e54cc"><td class="mdescLeft"> </td><td class="mdescRight">Stop method This asynchronously turns off the accelerator by removing the autorestart and start bits from the control registers. Please, note that the accelerator will turn off once it finishes its current task. <a href="#a77b8b797e26fa0fed24bc994e35e54cc">More...</a><br /></td></tr>
<tr class="separator:a77b8b797e26fa0fed24bc994e35e54cc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aec8a15b14e4a5f8659aa0082789f3fe5"><td class="memItemLeft" align="right" valign="top">virtual DeviceStatus </td><td class="memItemRight" valign="bottom"><a class="el" href="classcynq_1_1IAccelerator.html#aec8a15b14e4a5f8659aa0082789f3fe5">GetStatus</a> ()=0</td></tr>
<tr class="memdesc:aec8a15b14e4a5f8659aa0082789f3fe5"><td class="mdescLeft"> </td><td class="mdescRight">GetStatus method This returns the accelerator state by using the DeviceStatus. This reads the control register flags. <a href="#aec8a15b14e4a5f8659aa0082789f3fe5">More...</a><br /></td></tr>
<tr class="separator:aec8a15b14e4a5f8659aa0082789f3fe5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a307ed966bd1f4488e3f9c5f67c0e40f3"><td class="memTemplParams" colspan="2">template<typename T > </td></tr>
<tr class="memitem:a307ed966bd1f4488e3f9c5f67c0e40f3"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="structcynq_1_1Status.html">Status</a> </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classcynq_1_1IAccelerator.html#a307ed966bd1f4488e3f9c5f67c0e40f3">Write</a> (const uint64_t address, const T *data, const size_t elements)</td></tr>
<tr class="memdesc:a307ed966bd1f4488e3f9c5f67c0e40f3"><td class="mdescLeft"> </td><td class="mdescRight">Write method Performs a write operation to the accelerator through a register. <a href="#a307ed966bd1f4488e3f9c5f67c0e40f3">More...</a><br /></td></tr>
<tr class="separator:a307ed966bd1f4488e3f9c5f67c0e40f3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a82dd2d116dc7078e45576c4b4bbcb3a2"><td class="memTemplParams" colspan="2">template<typename T > </td></tr>
<tr class="memitem:a82dd2d116dc7078e45576c4b4bbcb3a2"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="structcynq_1_1Status.html">Status</a> </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classcynq_1_1IAccelerator.html#a82dd2d116dc7078e45576c4b4bbcb3a2">Read</a> (const uint64_t address, T *data, const size_t elements)</td></tr>
<tr class="memdesc:a82dd2d116dc7078e45576c4b4bbcb3a2"><td class="mdescLeft"> </td><td class="mdescRight">Read method Performs a write operation to the accelerator through a register. <a href="#a82dd2d116dc7078e45576c4b4bbcb3a2">More...</a><br /></td></tr>
<tr class="separator:a82dd2d116dc7078e45576c4b4bbcb3a2"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a84bbc0afe4f8e8147790f7c6a8e74c06"><td class="memItemLeft" align="right" valign="top">static std::shared_ptr< <a class="el" href="classcynq_1_1IAccelerator.html">IAccelerator</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classcynq_1_1IAccelerator.html#a84bbc0afe4f8e8147790f7c6a8e74c06">Create</a> (<a class="el" href="classcynq_1_1IAccelerator.html#a4c25efe8acfb1a6e01908dbdfbacfd6d">IAccelerator::Type</a> impl, const uint64_t addr)</td></tr>
<tr class="memdesc:a84bbc0afe4f8e8147790f7c6a8e74c06"><td class="mdescLeft"> </td><td class="mdescRight">Create method Factory method used for creating specific subclasses of <a class="el" href="classcynq_1_1IAccelerator.html" title="Interface for standardising the API for any Accelerator device: XRTAccelerator. ">IAccelerator</a>. <a href="#a84bbc0afe4f8e8147790f7c6a8e74c06">More...</a><br /></td></tr>
<tr class="separator:a84bbc0afe4f8e8147790f7c6a8e74c06"><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:a2345b427daaef05033e9f66202210bf2"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="structcynq_1_1Status.html">Status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcynq_1_1IAccelerator.html#a2345b427daaef05033e9f66202210bf2">WriteRegister</a> (const uint64_t address, const uint8_t *data, const size_t size)=0</td></tr>
<tr class="memdesc:a2345b427daaef05033e9f66202210bf2"><td class="mdescLeft"> </td><td class="mdescRight">WriteRegister method Writes to the register of the accelerator. <a href="#a2345b427daaef05033e9f66202210bf2">More...</a><br /></td></tr>
<tr class="separator:a2345b427daaef05033e9f66202210bf2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3f3a93792eeea45fba841818dbef6a62"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="structcynq_1_1Status.html">Status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcynq_1_1IAccelerator.html#a3f3a93792eeea45fba841818dbef6a62">ReadRegister</a> (const uint64_t address, uint8_t *data, const size_t size)=0</td></tr>
<tr class="memdesc:a3f3a93792eeea45fba841818dbef6a62"><td class="mdescLeft"> </td><td class="mdescRight">ReadRegister method. <a href="#a3f3a93792eeea45fba841818dbef6a62">More...</a><br /></td></tr>
<tr class="separator:a3f3a93792eeea45fba841818dbef6a62"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Interface for standardising the API for any Accelerator device: <a class="el" href="classcynq_1_1XRTAccelerator.html" title="XRTAccelerator class This class provides the api to operate the accelerator. ">XRTAccelerator</a>. </p>
</div><h2 class="groupheader">Member Enumeration Documentation</h2>
<a id="a4c25efe8acfb1a6e01908dbdfbacfd6d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4c25efe8acfb1a6e01908dbdfbacfd6d">◆ </a></span>Type</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classcynq_1_1IAccelerator.html#a4c25efe8acfb1a6e01908dbdfbacfd6d">cynq::IAccelerator::Type</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Type Type of runtime supported by the <a class="el" href="classcynq_1_1IAccelerator.html" title="Interface for standardising the API for any Accelerator device: XRTAccelerator. ">IAccelerator</a>. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a4c25efe8acfb1a6e01908dbdfbacfd6dacc4ba19f629441f35b484b09b16b2332"></a>None </td><td class="fielddoc"><p>No runtime </p>
</td></tr>
<tr><td class="fieldname"><a id="a4c25efe8acfb1a6e01908dbdfbacfd6da8be0a941dc809f299c00fcc1787e04a0"></a>XRT </td><td class="fielddoc"><p>Xilinx runtime </p>
</td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a84bbc0afe4f8e8147790f7c6a8e74c06"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a84bbc0afe4f8e8147790f7c6a8e74c06">◆ </a></span>Create()</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_1IAccelerator.html">IAccelerator</a> > cynq::IAccelerator::Create </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classcynq_1_1IAccelerator.html#a4c25efe8acfb1a6e01908dbdfbacfd6d">IAccelerator::Type</a> </td>
<td class="paramname"><em>impl</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const uint64_t </td>
<td class="paramname"><em>addr</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">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Create method Factory method used for creating specific subclasses of <a class="el" href="classcynq_1_1IAccelerator.html" title="Interface for standardising the API for any Accelerator device: XRTAccelerator. ">IAccelerator</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">impl</td><td>Used for establishing if the object is dependent on a runtime, use None if this is not the case.</td></tr>
<tr><td class="paramname">addr</td><td>A 64 bit unsigned integer establishing the address from which the address space of the accelerator starts.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>std::shared_ptr<IAccelerator> This is a shared_ptr with reference counting, the type will depend on the value of impl, the options are the following: XRT -> <a class="el" href="classcynq_1_1XRTAccelerator.html" title="XRTAccelerator class This class provides the api to operate the accelerator. ">XRTAccelerator</a> None -> nullptr </dd></dl>
</div>
</div>
<a id="aec8a15b14e4a5f8659aa0082789f3fe5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aec8a15b14e4a5f8659aa0082789f3fe5">◆ </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">virtual DeviceStatus cynq::IAccelerator::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">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>GetStatus method This returns the accelerator state by using the DeviceStatus. This reads the control register flags. </p>
<dl class="section return"><dt>Returns</dt><dd>DeviceStatus </dd></dl>
<p>Implemented in <a class="el" href="classcynq_1_1XRTAccelerator.html#a05bdb7daa557fb351fa77b310f6dceb4">cynq::XRTAccelerator</a>.</p>
</div>
</div>
<a id="a82dd2d116dc7078e45576c4b4bbcb3a2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a82dd2d116dc7078e45576c4b4bbcb3a2">◆ </a></span>Read()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T > </div>
<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::IAccelerator::Read </td>
<td>(</td>
<td class="paramtype">const uint64_t </td>
<td class="paramname"><em>address</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">T * </td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const size_t </td>
<td class="paramname"><em>elements</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">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Read method Performs a write operation to the accelerator through a register. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">T</td><td>Datatype used as the individual unit of information being read from the device.</td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">address</td><td>Address of the accelerator.</td></tr>
<tr><td class="paramname">data</td><td>Raw pointer of type T used by the register to access the data.</td></tr>
<tr><td class="paramname">elements</td><td>Number of elements being read from the device.</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>
</div>
</div>
<a id="a3f3a93792eeea45fba841818dbef6a62"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3f3a93792eeea45fba841818dbef6a62">◆ </a></span>ReadRegister()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="structcynq_1_1Status.html">Status</a> cynq::IAccelerator::ReadRegister </td>
<td>(</td>
<td class="paramtype">const uint64_t </td>
<td class="paramname"><em>address</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t * </td>
<td class="paramname"><em>data</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></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>ReadRegister method. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">address</td><td>a unsiged integer of 64 bits representing an address.</td></tr>
<tr><td class="paramname">data</td><td>a pointer to a unsigned 8 bits variable which holds the data to read from the register.</td></tr>
<tr><td class="paramname">size</td><td>size in bytes of the data to read.</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>Implemented in <a class="el" href="classcynq_1_1XRTAccelerator.html#a7ee45972a2807076e7ca049e9fd74efd">cynq::XRTAccelerator</a>.</p>
</div>
</div>
<a id="ac2b6ce03ee4e29d86e5abf2bc76b79e5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac2b6ce03ee4e29d86e5abf2bc76b79e5">◆ </a></span>Start()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="structcynq_1_1Status.html">Status</a> cynq::IAccelerator::Start </td>
<td>(</td>
<td class="paramtype">const StartMode </td>
<td class="paramname"><em>mode</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Start method This method starts the accelerator in either once or continuous mode (with the autorestart). Under the hood, this writes the control register to turn on the accelerator with/without the autorestart bit. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">mode</td><td>One of the values in the StartMode enum class present in the <a class="el" href="enums_8hpp_source.html">enums.hpp</a> file.</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>Implemented in <a class="el" href="classcynq_1_1XRTAccelerator.html#a14b3491eee88ee63e14f34d3b37900cf">cynq::XRTAccelerator</a>.</p>
</div>
</div>
<a id="a77b8b797e26fa0fed24bc994e35e54cc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a77b8b797e26fa0fed24bc994e35e54cc">◆ </a></span>Stop()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="structcynq_1_1Status.html">Status</a> cynq::IAccelerator::Stop </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Stop method This asynchronously turns off the accelerator by removing the autorestart and start bits from the control registers. Please, note that the accelerator will turn off once it finishes its current task. </p>
<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>Implemented in <a class="el" href="classcynq_1_1XRTAccelerator.html#a30c865d80fda396f99712a1c48861165">cynq::XRTAccelerator</a>.</p>
</div>
</div>
<a id="a307ed966bd1f4488e3f9c5f67c0e40f3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a307ed966bd1f4488e3f9c5f67c0e40f3">◆ </a></span>Write()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T > </div>
<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::IAccelerator::Write </td>
<td>(</td>
<td class="paramtype">const uint64_t </td>
<td class="paramname"><em>address</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const T * </td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const size_t </td>
<td class="paramname"><em>elements</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">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Write method Performs a write operation to the accelerator through a register. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">T</td><td>Datatype used as the individual unit of information being written to the device.</td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">address</td><td>Address of the accelerator.</td></tr>
<tr><td class="paramname">data</td><td>Raw pointer of type T used by the register to access the data.</td></tr>
<tr><td class="paramname">elements</td><td>Number of elements being written to the device.</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>
</div>
</div>
<a id="a2345b427daaef05033e9f66202210bf2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2345b427daaef05033e9f66202210bf2">◆ </a></span>WriteRegister()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="structcynq_1_1Status.html">Status</a> cynq::IAccelerator::WriteRegister </td>
<td>(</td>
<td class="paramtype">const uint64_t </td>
<td class="paramname"><em>address</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const uint8_t * </td>
<td class="paramname"><em>data</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></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>WriteRegister method Writes to the register of the accelerator. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">address</td><td>a unsigned integer of 64 bits representing an address.</td></tr>
<tr><td class="paramname">data</td><td>a pointer to a unsigned 8 bits variable which holds the data to write to the register.</td></tr>
<tr><td class="paramname">size</td><td>size in bytes of the data to write.</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>Implemented in <a class="el" href="classcynq_1_1XRTAccelerator.html#a5523f65637502496574afd594bd5b938">cynq::XRTAccelerator</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/<a class="el" href="accelerator_8hpp_source.html">accelerator.hpp</a></li>
<li>/media/lleon95/data/Personal/cynq/src/cynq/accelerator.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_1IAccelerator.html">IAccelerator</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>