-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathclasscynq_1_1IHardware.html
349 lines (328 loc) · 20.5 KB
/
classcynq_1_1IHardware.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
<!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::IHardware 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_1IHardware.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> </div>
<div class="headertitle">
<div class="title">cynq::IHardware Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p>Interface for standardising the API of Hardware Devices:
<a href="classcynq_1_1IHardware.html#details">More...</a></p>
<p><code>#include <<a class="el" href="hardware_8hpp_source.html">hardware.hpp</a>></code></p>
<div class="dynheader">
Inheritance diagram for cynq::IHardware:</div>
<div class="dyncontent">
<div class="center"><img src="classcynq_1_1IHardware__inherit__graph.png" border="0" usemap="#cynq_1_1IHardware_inherit__map" alt="Inheritance graph"/></div>
<map name="cynq_1_1IHardware_inherit__map" id="cynq_1_1IHardware_inherit__map">
<area shape="rect" id="node2" href="classcynq_1_1UltraScale.html" title="UltraScale class Provides an interface to access IP Cores in Xilinx FPGAs, the compatible devices are..." alt="" coords="5,80,124,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:aa34f15214af5df9acb1436734e0c7500"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="classcynq_1_1IHardware.html#aa34f15214af5df9acb1436734e0c7500">Type</a> { <a class="el" href="classcynq_1_1IHardware.html#aa34f15214af5df9acb1436734e0c7500adac2bc8f9a5faf2862f54d491d7fbf58">None</a> = 0,
<a class="el" href="classcynq_1_1IHardware.html#aa34f15214af5df9acb1436734e0c7500ae451a00b789d124dccff366b46ee7f08">XRT</a>
}<tr class="memdesc:aa34f15214af5df9acb1436734e0c7500"><td class="mdescLeft"> </td><td class="mdescRight">Type Type of runtime supported by the <a class="el" href="classcynq_1_1IHardware.html" title="Interface for standardising the API of Hardware Devices: ">IHardware</a>. <a href="classcynq_1_1IHardware.html#aa34f15214af5df9acb1436734e0c7500">More...</a><br /></td></tr>
</td></tr>
<tr class="separator:aa34f15214af5df9acb1436734e0c7500"><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:aa752c0a2d2effe32203e84f3802ec201"><td class="memItemLeft" align="right" valign="top"><a id="aa752c0a2d2effe32203e84f3802ec201"></a>
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classcynq_1_1IHardware.html#aa752c0a2d2effe32203e84f3802ec201">~IHardware</a> ()=default</td></tr>
<tr class="memdesc:aa752c0a2d2effe32203e84f3802ec201"><td class="mdescLeft"> </td><td class="mdescRight">~IHardware destructor method Destroy the <a class="el" href="classcynq_1_1IHardware.html" title="Interface for standardising the API of Hardware Devices: ">IHardware</a> object. <br /></td></tr>
<tr class="separator:aa752c0a2d2effe32203e84f3802ec201"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4d4cab7fa109789a63af9a7bcbf869e3"><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_1IHardware.html#a4d4cab7fa109789a63af9a7bcbf869e3">Reset</a> ()=0</td></tr>
<tr class="memdesc:a4d4cab7fa109789a63af9a7bcbf869e3"><td class="mdescLeft"> </td><td class="mdescRight">Reset method Sets the <a class="el" href="classcynq_1_1IHardware.html" title="Interface for standardising the API of Hardware Devices: ">IHardware</a> instance to its initial state. <a href="#a4d4cab7fa109789a63af9a7bcbf869e3">More...</a><br /></td></tr>
<tr class="separator:a4d4cab7fa109789a63af9a7bcbf869e3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aeb117ff0c548a15e35df8c10e85cf3f2"><td class="memItemLeft" align="right" valign="top">virtual 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_1IHardware.html#aeb117ff0c548a15e35df8c10e85cf3f2">GetDataMover</a> (const uint64_t address)=0</td></tr>
<tr class="memdesc:aeb117ff0c548a15e35df8c10e85cf3f2"><td class="mdescLeft"> </td><td class="mdescRight">GetDataMover method Used for accessing the <a class="el" href="classcynq_1_1IDataMover.html" title="Interface for standardising the API of DataMover for a specific device: XRTDataMover. ">IDataMover</a> instance of <a class="el" href="classcynq_1_1IHardware.html" title="Interface for standardising the API of Hardware Devices: ">IHardware</a> inheritors for decoupling the DataMovement separating the hardware logic from the data movement logic. <a href="#aeb117ff0c548a15e35df8c10e85cf3f2">More...</a><br /></td></tr>
<tr class="separator:aeb117ff0c548a15e35df8c10e85cf3f2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a84cd7cd5d469f7cafb9c67229a8bf720"><td class="memItemLeft" align="right" valign="top">virtual 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_1IHardware.html#a84cd7cd5d469f7cafb9c67229a8bf720">GetAccelerator</a> (const uint64_t address)=0</td></tr>
<tr class="memdesc:a84cd7cd5d469f7cafb9c67229a8bf720"><td class="mdescLeft"> </td><td class="mdescRight">GetAcceleratorMover method <a class="el" href="classcynq_1_1IDataMover.html" title="Interface for standardising the API of DataMover for a specific device: XRTDataMover. ">IDataMover</a> instance of <a class="el" href="classcynq_1_1IAccelerator.html" title="Interface for standardising the API for any Accelerator device: XRTAccelerator. ">IAccelerator</a> inheritors separating the hardware logic from the specific logic of the accelerator. <a href="#a84cd7cd5d469f7cafb9c67229a8bf720">More...</a><br /></td></tr>
<tr class="separator:a84cd7cd5d469f7cafb9c67229a8bf720"><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:ab3cc41fbed5a6da306d8ae51153a3065"><td class="memItemLeft" align="right" valign="top">static std::shared_ptr< <a class="el" href="classcynq_1_1IHardware.html">IHardware</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classcynq_1_1IHardware.html#ab3cc41fbed5a6da306d8ae51153a3065">Create</a> (const HardwareArchitecture hw, const std::string &bitstream, const std::string &xclbin)</td></tr>
<tr class="memdesc:ab3cc41fbed5a6da306d8ae51153a3065"><td class="mdescLeft"> </td><td class="mdescRight">Create method Factory method to create a hardware-specific subclasses for accelerators and data movers. <a href="#ab3cc41fbed5a6da306d8ae51153a3065">More...</a><br /></td></tr>
<tr class="separator:ab3cc41fbed5a6da306d8ae51153a3065"><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 of Hardware Devices: </p>
<ul>
<li>no inheritors - </li>
</ul>
</div><h2 class="groupheader">Member Enumeration Documentation</h2>
<a id="aa34f15214af5df9acb1436734e0c7500"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa34f15214af5df9acb1436734e0c7500">◆ </a></span>Type</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classcynq_1_1IHardware.html#aa34f15214af5df9acb1436734e0c7500">cynq::IHardware::Type</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Type Type of runtime supported by the <a class="el" href="classcynq_1_1IHardware.html" title="Interface for standardising the API of Hardware Devices: ">IHardware</a>. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="aa34f15214af5df9acb1436734e0c7500adac2bc8f9a5faf2862f54d491d7fbf58"></a>None </td><td class="fielddoc"><p>No runtime </p>
</td></tr>
<tr><td class="fieldname"><a id="aa34f15214af5df9acb1436734e0c7500ae451a00b789d124dccff366b46ee7f08"></a>XRT </td><td class="fielddoc"><p>Xilinx runtime </p>
</td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="ab3cc41fbed5a6da306d8ae51153a3065"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab3cc41fbed5a6da306d8ae51153a3065">◆ </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_1IHardware.html">IHardware</a> > cynq::IHardware::Create </td>
<td>(</td>
<td class="paramtype">const HardwareArchitecture </td>
<td class="paramname"><em>hw</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>bitstream</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>xclbin</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 to create a hardware-specific subclasses for accelerators and data movers. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">hw</td><td>One of the values in the HardwareArchitecture enum class present in the <a class="el" href="enums_8hpp_source.html">enums.hpp</a> file that should correspond to the device being used.</td></tr>
<tr><td class="paramname">bitstream</td><td>string that represents the name of the file with the bitstream.</td></tr>
<tr><td class="paramname">xclbin</td><td>string that represents the name of the xcl.bin file.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>std::shared_ptr<IHardware> Returns an <a class="el" href="classcynq_1_1IAccelerator.html" title="Interface for standardising the API for any Accelerator device: XRTAccelerator. ">IAccelerator</a> pointer with reference counting. It should be thread-safe. </dd></dl>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="basic-example_8cpp-example.html#a0">basic-example.cpp</a>.</dd>
</dl>
</div>
</div>
<a id="a84cd7cd5d469f7cafb9c67229a8bf720"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a84cd7cd5d469f7cafb9c67229a8bf720">◆ </a></span>GetAccelerator()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual std::shared_ptr<<a class="el" href="classcynq_1_1IAccelerator.html">IAccelerator</a>> cynq::IHardware::GetAccelerator </td>
<td>(</td>
<td class="paramtype">const uint64_t </td>
<td class="paramname"><em>address</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>GetAcceleratorMover method <a class="el" href="classcynq_1_1IDataMover.html" title="Interface for standardising the API of DataMover for a specific device: XRTDataMover. ">IDataMover</a> instance of <a class="el" href="classcynq_1_1IAccelerator.html" title="Interface for standardising the API for any Accelerator device: XRTAccelerator. ">IAccelerator</a> inheritors separating the hardware logic from the specific logic 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>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>std::shared_ptr<IAccelerator> Returns an <a class="el" href="classcynq_1_1IAccelerator.html" title="Interface for standardising the API for any Accelerator device: XRTAccelerator. ">IAccelerator</a> pointer with reference counting. It should be thread-safe. </dd></dl>
<p>Implemented in <a class="el" href="classcynq_1_1UltraScale.html#a384efeadd0bdc12b71d409594ff64006">cynq::UltraScale</a>.</p>
</div>
</div>
<a id="aeb117ff0c548a15e35df8c10e85cf3f2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aeb117ff0c548a15e35df8c10e85cf3f2">◆ </a></span>GetDataMover()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual std::shared_ptr<<a class="el" href="classcynq_1_1IDataMover.html">IDataMover</a>> cynq::IHardware::GetDataMover </td>
<td>(</td>
<td class="paramtype">const uint64_t </td>
<td class="paramname"><em>address</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>GetDataMover method Used for accessing the <a class="el" href="classcynq_1_1IDataMover.html" title="Interface for standardising the API of DataMover for a specific device: XRTDataMover. ">IDataMover</a> instance of <a class="el" href="classcynq_1_1IHardware.html" title="Interface for standardising the API of Hardware Devices: ">IHardware</a> inheritors for decoupling the DataMovement separating the hardware logic from the data movement logic. </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>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>std::shared_ptr<IDataMover> Returns an <a class="el" href="classcynq_1_1IDataMover.html" title="Interface for standardising the API of DataMover for a specific device: XRTDataMover. ">IDataMover</a> pointer with reference counting. It should be thread-safe. </dd></dl>
<p>Implemented in <a class="el" href="classcynq_1_1UltraScale.html#a78a305f728676f7d425fdeaf76faf79e">cynq::UltraScale</a>.</p>
</div>
</div>
<a id="a4d4cab7fa109789a63af9a7bcbf869e3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4d4cab7fa109789a63af9a7bcbf869e3">◆ </a></span>Reset()</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::IHardware::Reset </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>Reset method Sets the <a class="el" href="classcynq_1_1IHardware.html" title="Interface for standardising the API of Hardware Devices: ">IHardware</a> instance to its initial state. </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_1UltraScale.html#ae9d76a7941e23575bc0457b775515cff">cynq::UltraScale</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="hardware_8hpp_source.html">hardware.hpp</a></li>
<li>/media/lleon95/data/Personal/cynq/src/cynq/hardware.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_1IHardware.html">IHardware</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>