| 1 |
2 |
ZTEX |
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
|
| 2 |
|
|
<!-- NewPage -->
|
| 3 |
|
|
<html lang="de">
|
| 4 |
|
|
<head>
|
| 5 |
|
|
<!-- Generated by javadoc (version 1.7.0_79) on Wed Mar 22 19:20:12 CET 2017 -->
|
| 6 |
|
|
<title>ConfigData</title>
|
| 7 |
|
|
<meta name="date" content="2017-03-22">
|
| 8 |
|
|
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
|
| 9 |
|
|
</head>
|
| 10 |
|
|
<body>
|
| 11 |
|
|
<script type="text/javascript"><!--
|
| 12 |
|
|
if (location.href.indexOf('is-external=true') == -1) {
|
| 13 |
|
|
parent.document.title="ConfigData";
|
| 14 |
|
|
}
|
| 15 |
|
|
//-->
|
| 16 |
|
|
</script>
|
| 17 |
|
|
<noscript>
|
| 18 |
|
|
<div>JavaScript is disabled on your browser.</div>
|
| 19 |
|
|
</noscript>
|
| 20 |
|
|
<!-- ========= START OF TOP NAVBAR ======= -->
|
| 21 |
|
|
<div class="topNav"><a name="navbar_top">
|
| 22 |
|
|
<!-- -->
|
| 23 |
|
|
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
|
| 24 |
|
|
<!-- -->
|
| 25 |
|
|
</a>
|
| 26 |
|
|
<ul class="navList" title="Navigation">
|
| 27 |
|
|
<li><a href="../ztex/package-summary.html">Package</a></li>
|
| 28 |
|
|
<li class="navBarCell1Rev">Class</li>
|
| 29 |
|
|
<li><a href="package-tree.html">Tree</a></li>
|
| 30 |
|
|
<li><a href="../deprecated-list.html">Deprecated</a></li>
|
| 31 |
|
|
<li><a href="../index-all.html">Index</a></li>
|
| 32 |
|
|
<li><a href="../help-doc.html">Help</a></li>
|
| 33 |
|
|
</ul>
|
| 34 |
|
|
</div>
|
| 35 |
|
|
<div class="subNav">
|
| 36 |
|
|
<ul class="navList">
|
| 37 |
|
|
<li><a href="../ztex/CapabilityException.html" title="class in ztex"><span class="strong">Prev Class</span></a></li>
|
| 38 |
|
|
<li><a href="../ztex/DeviceLostException.html" title="class in ztex"><span class="strong">Next Class</span></a></li>
|
| 39 |
|
|
</ul>
|
| 40 |
|
|
<ul class="navList">
|
| 41 |
|
|
<li><a href="../index.html?ztex/ConfigData.html" target="_top">Frames</a></li>
|
| 42 |
|
|
<li><a href="ConfigData.html" target="_top">No Frames</a></li>
|
| 43 |
|
|
</ul>
|
| 44 |
|
|
<ul class="navList" id="allclasses_navbar_top">
|
| 45 |
|
|
<li><a href="../allclasses-noframe.html">All Classes</a></li>
|
| 46 |
|
|
</ul>
|
| 47 |
|
|
<div>
|
| 48 |
|
|
<script type="text/javascript"><!--
|
| 49 |
|
|
allClassesLink = document.getElementById("allclasses_navbar_top");
|
| 50 |
|
|
if(window==top) {
|
| 51 |
|
|
allClassesLink.style.display = "block";
|
| 52 |
|
|
}
|
| 53 |
|
|
else {
|
| 54 |
|
|
allClassesLink.style.display = "none";
|
| 55 |
|
|
}
|
| 56 |
|
|
//-->
|
| 57 |
|
|
</script>
|
| 58 |
|
|
</div>
|
| 59 |
|
|
<div>
|
| 60 |
|
|
<ul class="subNavList">
|
| 61 |
|
|
<li>Summary: </li>
|
| 62 |
|
|
<li>Nested | </li>
|
| 63 |
|
|
<li><a href="#field_summary">Field</a> | </li>
|
| 64 |
|
|
<li><a href="#constructor_summary">Constr</a> | </li>
|
| 65 |
|
|
<li><a href="#method_summary">Method</a></li>
|
| 66 |
|
|
</ul>
|
| 67 |
|
|
<ul class="subNavList">
|
| 68 |
|
|
<li>Detail: </li>
|
| 69 |
|
|
<li><a href="#field_detail">Field</a> | </li>
|
| 70 |
|
|
<li><a href="#constructor_detail">Constr</a> | </li>
|
| 71 |
|
|
<li><a href="#method_detail">Method</a></li>
|
| 72 |
|
|
</ul>
|
| 73 |
|
|
</div>
|
| 74 |
|
|
<a name="skip-navbar_top">
|
| 75 |
|
|
<!-- -->
|
| 76 |
|
|
</a></div>
|
| 77 |
|
|
<!-- ========= END OF TOP NAVBAR ========= -->
|
| 78 |
|
|
<!-- ======== START OF CLASS DATA ======== -->
|
| 79 |
|
|
<div class="header">
|
| 80 |
|
|
<div class="subTitle">ztex</div>
|
| 81 |
|
|
<h2 title="Class ConfigData" class="title">Class ConfigData</h2>
|
| 82 |
|
|
</div>
|
| 83 |
|
|
<div class="contentContainer">
|
| 84 |
|
|
<ul class="inheritance">
|
| 85 |
|
|
<li>java.lang.Object</li>
|
| 86 |
|
|
<li>
|
| 87 |
|
|
<ul class="inheritance">
|
| 88 |
|
|
<li>ztex.ConfigData</li>
|
| 89 |
|
|
</ul>
|
| 90 |
|
|
</li>
|
| 91 |
|
|
</ul>
|
| 92 |
|
|
<div class="description">
|
| 93 |
|
|
<ul class="blockList">
|
| 94 |
|
|
<li class="blockList">
|
| 95 |
|
|
<hr>
|
| 96 |
|
|
<br>
|
| 97 |
|
|
<pre>public class <span class="strong">ConfigData</span>
|
| 98 |
|
|
extends java.lang.Object</pre>
|
| 99 |
|
|
<div class="block">This class represents the configuration data space of ZTEX FPGA Boards that support it.
|
| 100 |
|
|
The internal format is (byte order is LE -- least significant byte first)
|
| 101 |
|
|
<pre>
|
| 102 |
|
|
<Address> <Description>
|
| 103 |
|
|
0..2 Signature "CD0"
|
| 104 |
|
|
3 Kind of FPGA Board, see <a href="../ztex/ConfigData.html#boardNames"><code>boardNames</code></a>, e.g. 2 for "ZTEX USB-FPGA Module",
|
| 105 |
|
|
4 FPGA Board series, e.g. 2
|
| 106 |
|
|
5 FPGA Board number (number behind the dot), e.g. 16
|
| 107 |
|
|
6..7 FPGA Board variant (letter), e.g. "b"
|
| 108 |
|
|
8..9 FPGA, see <a href="../ztex/ConfigData.html#fpgas"><code>fpgas</code></a>, e.g. 12 for X7A200T
|
| 109 |
|
|
10 FPGA package, see <a href="../ztex/ConfigData.html#packages"><code>packages</code></a>, e.g. 3 for FBG484
|
| 110 |
|
|
11..13 Speed grade + temperature range, e.g. "2C"
|
| 111 |
|
|
14 RAM size, format is ( n & 0xf0 ) << ( (n & 0xf) + 16 ) bytes
|
| 112 |
|
|
15 RAM type, see <a href="../ztex/ConfigData.html#ramTypes"><code>ramTypes</code></a>
|
| 113 |
|
|
16..25 Serial number, overwrites SN_STRING of the ZTEX descriptor.
|
| 114 |
|
|
If it is equal to "0000000000" (default) it is replaced by the unique MAC address.
|
| 115 |
|
|
26..27 Actual size of Bitstream in 4K sectors; 0 means Bitstream disabled (default)
|
| 116 |
|
|
28..29 Maximum size of Bitstream in 4K sectors; 0 means that either no Flash
|
| 117 |
|
|
is present or that this information is stored in Flash (exchangeable media)
|
| 118 |
|
|
30..31 Start of the Bitstream in 4K sectors
|
| 119 |
|
|
32..33 USB vendor ID, ignored if zero
|
| 120 |
|
|
34..35 USB product ID, ignored if USB vendor ID is zero
|
| 121 |
|
|
36..67 Product string, null-terminated if length is smaller than 32
|
| 122 |
|
|
68..79 Reserved, must be 0
|
| 123 |
|
|
80..127 48 bytes user space
|
| 124 |
|
|
</pre></div>
|
| 125 |
|
|
</li>
|
| 126 |
|
|
</ul>
|
| 127 |
|
|
</div>
|
| 128 |
|
|
<div class="summary">
|
| 129 |
|
|
<ul class="blockList">
|
| 130 |
|
|
<li class="blockList">
|
| 131 |
|
|
<!-- =========== FIELD SUMMARY =========== -->
|
| 132 |
|
|
<ul class="blockList">
|
| 133 |
|
|
<li class="blockList"><a name="field_summary">
|
| 134 |
|
|
<!-- -->
|
| 135 |
|
|
</a>
|
| 136 |
|
|
<h3>Field Summary</h3>
|
| 137 |
|
|
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
|
| 138 |
|
|
<caption><span>Fields</span><span class="tabEnd"> </span></caption>
|
| 139 |
|
|
<tr>
|
| 140 |
|
|
<th class="colFirst" scope="col">Modifier and Type</th>
|
| 141 |
|
|
<th class="colLast" scope="col">Field and Description</th>
|
| 142 |
|
|
</tr>
|
| 143 |
|
|
<tr class="altColor">
|
| 144 |
|
|
<td class="colFirst"><code>static java.lang.String[]</code></td>
|
| 145 |
|
|
<td class="colLast"><code><strong><a href="../ztex/ConfigData.html#boardNames">boardNames</a></strong></code>
|
| 146 |
|
|
<div class="block">Kinds of FPGA Boards.</div>
|
| 147 |
|
|
</td>
|
| 148 |
|
|
</tr>
|
| 149 |
|
|
<tr class="rowColor">
|
| 150 |
|
|
<td class="colFirst"><code>static java.lang.String[]</code></td>
|
| 151 |
|
|
<td class="colLast"><code><strong><a href="../ztex/ConfigData.html#fpgas">fpgas</a></strong></code>
|
| 152 |
|
|
<div class="block">FPGA's used on ZTEX FPGA Boards.</div>
|
| 153 |
|
|
</td>
|
| 154 |
|
|
</tr>
|
| 155 |
|
|
<tr class="altColor">
|
| 156 |
|
|
<td class="colFirst"><code>static java.lang.String[]</code></td>
|
| 157 |
|
|
<td class="colLast"><code><strong><a href="../ztex/ConfigData.html#packages">packages</a></strong></code>
|
| 158 |
|
|
<div class="block">FPGA packages used on ZTEX FPGA boards.</div>
|
| 159 |
|
|
</td>
|
| 160 |
|
|
</tr>
|
| 161 |
|
|
<tr class="rowColor">
|
| 162 |
|
|
<td class="colFirst"><code>static java.lang.String[]</code></td>
|
| 163 |
|
|
<td class="colLast"><code><strong><a href="../ztex/ConfigData.html#ramTypes">ramTypes</a></strong></code>
|
| 164 |
|
|
<div class="block">RAM types and speed used on ZTEX FPGA boards.</div>
|
| 165 |
|
|
</td>
|
| 166 |
|
|
</tr>
|
| 167 |
|
|
</table>
|
| 168 |
|
|
</li>
|
| 169 |
|
|
</ul>
|
| 170 |
|
|
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
| 171 |
|
|
<ul class="blockList">
|
| 172 |
|
|
<li class="blockList"><a name="constructor_summary">
|
| 173 |
|
|
<!-- -->
|
| 174 |
|
|
</a>
|
| 175 |
|
|
<h3>Constructor Summary</h3>
|
| 176 |
|
|
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
|
| 177 |
|
|
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
|
| 178 |
|
|
<tr>
|
| 179 |
|
|
<th class="colOne" scope="col">Constructor and Description</th>
|
| 180 |
|
|
</tr>
|
| 181 |
|
|
<tr class="altColor">
|
| 182 |
|
|
<td class="colOne"><code><strong><a href="../ztex/ConfigData.html#ConfigData()">ConfigData</a></strong>()</code>
|
| 183 |
|
|
<div class="block">Constructs an empty instance.</div>
|
| 184 |
|
|
</td>
|
| 185 |
|
|
</tr>
|
| 186 |
|
|
<tr class="rowColor">
|
| 187 |
|
|
<td class="colOne"><code><strong><a href="../ztex/ConfigData.html#ConfigData(ztex.Ztex1v1)">ConfigData</a></strong>(<a href="../ztex/Ztex1v1.html" title="class in ztex">Ztex1v1</a> z)</code>
|
| 188 |
|
|
<div class="block">Constructs an instance and connects it with z.</div>
|
| 189 |
|
|
</td>
|
| 190 |
|
|
</tr>
|
| 191 |
|
|
</table>
|
| 192 |
|
|
</li>
|
| 193 |
|
|
</ul>
|
| 194 |
|
|
<!-- ========== METHOD SUMMARY =========== -->
|
| 195 |
|
|
<ul class="blockList">
|
| 196 |
|
|
<li class="blockList"><a name="method_summary">
|
| 197 |
|
|
<!-- -->
|
| 198 |
|
|
</a>
|
| 199 |
|
|
<h3>Method Summary</h3>
|
| 200 |
|
|
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
|
| 201 |
|
|
<caption><span>Methods</span><span class="tabEnd"> </span></caption>
|
| 202 |
|
|
<tr>
|
| 203 |
|
|
<th class="colFirst" scope="col">Modifier and Type</th>
|
| 204 |
|
|
<th class="colLast" scope="col">Method and Description</th>
|
| 205 |
|
|
</tr>
|
| 206 |
|
|
<tr class="altColor">
|
| 207 |
|
|
<td class="colFirst"><code>boolean</code></td>
|
| 208 |
|
|
<td class="colLast"><code><strong><a href="../ztex/ConfigData.html#connect(ztex.Ztex1v1)">connect</a></strong>(<a href="../ztex/Ztex1v1.html" title="class in ztex">Ztex1v1</a> z)</code>
|
| 209 |
|
|
<div class="block">Reads the configuration data (if existent) from a device and connects it to this instance.</div>
|
| 210 |
|
|
</td>
|
| 211 |
|
|
</tr>
|
| 212 |
|
|
<tr class="rowColor">
|
| 213 |
|
|
<td class="colFirst"><code>byte[]</code></td>
|
| 214 |
|
|
<td class="colLast"><code><strong><a href="../ztex/ConfigData.html#data()">data</a></strong>()</code>
|
| 215 |
|
|
<div class="block">Returns a copy of the configuration data array.</div>
|
| 216 |
|
|
</td>
|
| 217 |
|
|
</tr>
|
| 218 |
|
|
<tr class="altColor">
|
| 219 |
|
|
<td class="colFirst"><code>java.lang.String</code></td>
|
| 220 |
|
|
<td class="colLast"><code><strong><a href="../ztex/ConfigData.html#defaultBitstreamPath(java.lang.String)">defaultBitstreamPath</a></strong>(java.lang.String name)</code>
|
| 221 |
|
|
<div class="block">Returns the bitstream path if the same directory sheme as for the examples is used.</div>
|
| 222 |
|
|
</td>
|
| 223 |
|
|
</tr>
|
| 224 |
|
|
<tr class="rowColor">
|
| 225 |
|
|
<td class="colFirst"><code>boolean</code></td>
|
| 226 |
|
|
<td class="colLast"><code><strong><a href="../ztex/ConfigData.html#disconnect()">disconnect</a></strong>()</code>
|
| 227 |
|
|
<div class="block">Disconnects the currently connected device.</div>
|
| 228 |
|
|
</td>
|
| 229 |
|
|
</tr>
|
| 230 |
|
|
<tr class="altColor">
|
| 231 |
|
|
<td class="colFirst"><code>int</code></td>
|
| 232 |
|
|
<td class="colLast"><code><strong><a href="../ztex/ConfigData.html#getBitstreamSize()">getBitstreamSize</a></strong>()</code>
|
| 233 |
|
|
<div class="block">Returns actual size of bitstream in bytes sectors.
|
| 234 |
|
|
|
| 235 |
|
|
</td>
|
| 236 |
|
|
</tr>
|
| 237 |
|
|
<tr class="rowColor">
|
| 238 |
|
|
<td class="colFirst"><code>int</code></td>
|
| 239 |
|
|
<td class="colLast"><code><strong><a href="../ztex/ConfigData.html#getBitstreamStart()">getBitstreamStart</a></strong>()</code>
|
| 240 |
|
|
<div class="block">Returns bitstream start position in bytes.</div>
|
| 241 |
|
|
</td>
|
| 242 |
|
|
</tr>
|
| 243 |
|
|
<tr class="altColor">
|
| 244 |
|
|
<td class="colFirst"><code>java.lang.String</code></td>
|
| 245 |
|
|
<td class="colLast"><code><strong><a href="../ztex/ConfigData.html#getFpga()">getFpga</a></strong>()</code>
|
| 246 |
|
|
<div class="block">Returns FPGA information.</div>
|
| 247 |
|
|
</td>
|
| 248 |
|
|
</tr>
|
| 249 |
|
|
<tr class="rowColor">
|
| 250 |
|
|
<td class="colFirst"><code>byte</code></td>
|
| 251 |
|
|
<td class="colLast"><code><strong><a href="../ztex/ConfigData.html#getMajorVersion()">getMajorVersion</a></strong>()</code>
|
| 252 |
|
|
<div class="block">Returns the major version number, e.g. 2 for USB-FPGA Modules 2.14b.</div>
|
| 253 |
|
|
</td>
|
| 254 |
|
|
</tr>
|
| 255 |
|
|
<tr class="altColor">
|
| 256 |
|
|
<td class="colFirst"><code>int</code></td>
|
| 257 |
|
|
<td class="colLast"><code><strong><a href="../ztex/ConfigData.html#getMaxBitstreamSize()">getMaxBitstreamSize</a></strong>()</code>
|
| 258 |
|
|
<div class="block">Returns maximum size of bitstream in bytes.</div>
|
| 259 |
|
|
</td>
|
| 260 |
|
|
</tr>
|
| 261 |
|
|
<tr class="rowColor">
|
| 262 |
|
|
<td class="colFirst"><code>byte</code></td>
|
| 263 |
|
|
<td class="colLast"><code><strong><a href="../ztex/ConfigData.html#getMinorVersion()">getMinorVersion</a></strong>()</code>
|
| 264 |
|
|
<div class="block">Returns the minor version number, e.g. 14 for USB-FPGA Modules 2.14b.</div>
|
| 265 |
|
|
</td>
|
| 266 |
|
|
</tr>
|
| 267 |
|
|
<tr class="altColor">
|
| 268 |
|
|
<td class="colFirst"><code>java.lang.String</code></td>
|
| 269 |
|
|
<td class="colLast"><code><strong><a href="../ztex/ConfigData.html#getName()">getName</a></strong>()</code>
|
| 270 |
|
|
<div class="block">Returns the name of the FPGA Board.</div>
|
| 271 |
|
|
</td>
|
| 272 |
|
|
</tr>
|
| 273 |
|
|
<tr class="rowColor">
|
| 274 |
|
|
<td class="colFirst"><code>int</code></td>
|
| 275 |
|
|
<td class="colLast"><code><strong><a href="../ztex/ConfigData.html#getRamSize()">getRamSize</a></strong>()</code>
|
| 276 |
|
|
<div class="block">Returns RAM size in bytes.</div>
|
| 277 |
|
|
</td>
|
| 278 |
|
|
</tr>
|
| 279 |
|
|
<tr class="altColor">
|
| 280 |
|
|
<td class="colFirst"><code>java.lang.String</code></td>
|
| 281 |
|
|
<td class="colLast"><code><strong><a href="../ztex/ConfigData.html#getRamType()">getRamType</a></strong>()</code>
|
| 282 |
|
|
<div class="block">Returns RAM type and speed.</div>
|
| 283 |
|
|
</td>
|
| 284 |
|
|
</tr>
|
| 285 |
|
|
<tr class="rowColor">
|
| 286 |
|
|
<td class="colFirst"><code>byte</code></td>
|
| 287 |
|
|
<td class="colLast"><code><strong><a href="../ztex/ConfigData.html#getUserData(int)">getUserData</a></strong>(int i)</code>
|
| 288 |
|
|
<div class="block">Returns user data at index i.</div>
|
| 289 |
|
|
</td>
|
| 290 |
|
|
</tr>
|
| 291 |
|
|
<tr class="altColor">
|
| 292 |
|
|
<td class="colFirst"><code>java.lang.String</code></td>
|
| 293 |
|
|
<td class="colLast"><code><strong><a href="../ztex/ConfigData.html#getVariant()">getVariant</a></strong>()</code>
|
| 294 |
|
|
<div class="block">Returns the variant letter, e.g.</div>
|
| 295 |
|
|
</td>
|
| 296 |
|
|
</tr>
|
| 297 |
|
|
<tr class="rowColor">
|
| 298 |
|
|
<td class="colFirst"><code>boolean</code></td>
|
| 299 |
|
|
<td class="colLast"><code><strong><a href="../ztex/ConfigData.html#sendtUserData()">sendtUserData</a></strong>()</code>
|
| 300 |
|
|
<div class="block">Sends the user data to the FPGA Board.</div>
|
| 301 |
|
|
</td>
|
| 302 |
|
|
</tr>
|
| 303 |
|
|
<tr class="altColor">
|
| 304 |
|
|
<td class="colFirst"><code>boolean</code></td>
|
| 305 |
|
|
<td class="colLast"><code><strong><a href="../ztex/ConfigData.html#setBitstreamSize(int)">setBitstreamSize</a></strong>(int size)</code>
|
| 306 |
|
|
<div class="block">Sets the actual size of bitstream in bytes.</div>
|
| 307 |
|
|
</td>
|
| 308 |
|
|
</tr>
|
| 309 |
|
|
<tr class="rowColor">
|
| 310 |
|
|
<td class="colFirst"><code>void</code></td>
|
| 311 |
|
|
<td class="colLast"><code><strong><a href="../ztex/ConfigData.html#setBitstreamStart(int)">setBitstreamStart</a></strong>(int start4k)</code>
|
| 312 |
|
|
<div class="block">Sets the start position of the bitstream in 4 KByte sectors.</div>
|
| 313 |
|
|
</td>
|
| 314 |
|
|
</tr>
|
| 315 |
|
|
<tr class="altColor">
|
| 316 |
|
|
<td class="colFirst"><code>void</code></td>
|
| 317 |
|
|
<td class="colLast"><code><strong><a href="../ztex/ConfigData.html#setFpga(java.lang.String,%20java.lang.String,%20java.lang.String)">setFpga</a></strong>(java.lang.String name,
|
| 318 |
|
|
java.lang.String pckg,
|
| 319 |
|
|
java.lang.String sg)</code>
|
| 320 |
|
|
<div class="block">Sets FPGA information.</div>
|
| 321 |
|
|
</td>
|
| 322 |
|
|
</tr>
|
| 323 |
|
|
<tr class="rowColor">
|
| 324 |
|
|
<td class="colFirst"><code>void</code></td>
|
| 325 |
|
|
<td class="colLast"><code><strong><a href="../ztex/ConfigData.html#setMaxBitstreamSize(int)">setMaxBitstreamSize</a></strong>(int size4k)</code>
|
| 326 |
|
|
<div class="block">Sets the maximum size of bitstream in 4 KByte sectors.</div>
|
| 327 |
|
|
</td>
|
| 328 |
|
|
</tr>
|
| 329 |
|
|
<tr class="altColor">
|
| 330 |
|
|
<td class="colFirst"><code>void</code></td>
|
| 331 |
|
|
<td class="colLast"><code><strong><a href="../ztex/ConfigData.html#setName(java.lang.String,%20int,%20int,%20java.lang.String)">setName</a></strong>(java.lang.String kind,
|
| 332 |
|
|
int series,
|
| 333 |
|
|
int number,
|
| 334 |
|
|
java.lang.String variant)</code>
|
| 335 |
|
|
<div class="block">Sets the name of the FPGA Board.</div>
|
| 336 |
|
|
</td>
|
| 337 |
|
|
</tr>
|
| 338 |
|
|
<tr class="rowColor">
|
| 339 |
|
|
<td class="colFirst"><code>boolean</code></td>
|
| 340 |
|
|
<td class="colLast"><code><strong><a href="../ztex/ConfigData.html#setProductString(java.lang.String)">setProductString</a></strong>(java.lang.String ps)</code>
|
| 341 |
|
|
<div class="block">Sets the product string.</div>
|
| 342 |
|
|
</td>
|
| 343 |
|
|
</tr>
|
| 344 |
|
|
<tr class="altColor">
|
| 345 |
|
|
<td class="colFirst"><code>void</code></td>
|
| 346 |
|
|
<td class="colLast"><code><strong><a href="../ztex/ConfigData.html#setRam(int,%20java.lang.String)">setRam</a></strong>(int size,
|
| 347 |
|
|
java.lang.String type)</code>
|
| 348 |
|
|
<div class="block">Sets RAM information.</div>
|
| 349 |
|
|
</td>
|
| 350 |
|
|
</tr>
|
| 351 |
|
|
<tr class="rowColor">
|
| 352 |
|
|
<td class="colFirst"><code>boolean</code></td>
|
| 353 |
|
|
<td class="colLast"><code><strong><a href="../ztex/ConfigData.html#setSN(java.lang.String)">setSN</a></strong>(java.lang.String sn)</code>
|
| 354 |
|
|
<div class="block">Sets the serial number.</div>
|
| 355 |
|
|
</td>
|
| 356 |
|
|
</tr>
|
| 357 |
|
|
<tr class="altColor">
|
| 358 |
|
|
<td class="colFirst"><code>boolean</code></td>
|
| 359 |
|
|
<td class="colLast"><code><strong><a href="../ztex/ConfigData.html#setUsbIDs(int,%20int)">setUsbIDs</a></strong>(int vid,
|
| 360 |
|
|
int pid)</code>
|
| 361 |
|
|
<div class="block">Set the USB vendor vendor and product ID.</div>
|
| 362 |
|
|
</td>
|
| 363 |
|
|
</tr>
|
| 364 |
|
|
<tr class="rowColor">
|
| 365 |
|
|
<td class="colFirst"><code>void</code></td>
|
| 366 |
|
|
<td class="colLast"><code><strong><a href="../ztex/ConfigData.html#setUserData(int,%20byte)">setUserData</a></strong>(int i,
|
| 367 |
|
|
byte v)</code>
|
| 368 |
|
|
<div class="block">Sets user data at index i to value v.</div>
|
| 369 |
|
|
</td>
|
| 370 |
|
|
</tr>
|
| 371 |
|
|
</table>
|
| 372 |
|
|
<ul class="blockList">
|
| 373 |
|
|
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
|
| 374 |
|
|
<!-- -->
|
| 375 |
|
|
</a>
|
| 376 |
|
|
<h3>Methods inherited from class java.lang.Object</h3>
|
| 377 |
|
|
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
|
| 378 |
|
|
</ul>
|
| 379 |
|
|
</li>
|
| 380 |
|
|
</ul>
|
| 381 |
|
|
</li>
|
| 382 |
|
|
</ul>
|
| 383 |
|
|
</div>
|
| 384 |
|
|
<div class="details">
|
| 385 |
|
|
<ul class="blockList">
|
| 386 |
|
|
<li class="blockList">
|
| 387 |
|
|
<!-- ============ FIELD DETAIL =========== -->
|
| 388 |
|
|
<ul class="blockList">
|
| 389 |
|
|
<li class="blockList"><a name="field_detail">
|
| 390 |
|
|
<!-- -->
|
| 391 |
|
|
</a>
|
| 392 |
|
|
<h3>Field Detail</h3>
|
| 393 |
|
|
<a name="boardNames">
|
| 394 |
|
|
<!-- -->
|
| 395 |
|
|
</a>
|
| 396 |
|
|
<ul class="blockList">
|
| 397 |
|
|
<li class="blockList">
|
| 398 |
|
|
<h4>boardNames</h4>
|
| 399 |
|
|
<pre>public static final java.lang.String[] boardNames</pre>
|
| 400 |
|
|
<div class="block">Kinds of FPGA Boards.
|
| 401 |
|
|
It's defined as
|
| 402 |
|
|
<pre><code>public static final String boardNames[] = {
|
| 403 |
|
|
"(unknown)" , // 0
|
| 404 |
|
|
"ZTEX FPGA Module" , // 1
|
| 405 |
|
|
"ZTEX USB-FPGA Module" // 2, FX2 based
|
| 406 |
|
|
"ZTEX USB3-FPGA Module" // 3, FX3 based
|
| 407 |
|
|
};</code></pre></div>
|
| 408 |
|
|
</li>
|
| 409 |
|
|
</ul>
|
| 410 |
|
|
<a name="fpgas">
|
| 411 |
|
|
<!-- -->
|
| 412 |
|
|
</a>
|
| 413 |
|
|
<ul class="blockList">
|
| 414 |
|
|
<li class="blockList">
|
| 415 |
|
|
<h4>fpgas</h4>
|
| 416 |
|
|
<pre>public static final java.lang.String[] fpgas</pre>
|
| 417 |
|
|
<div class="block">FPGA's used on ZTEX FPGA Boards.
|
| 418 |
|
|
It's defined as
|
| 419 |
|
|
<pre><code>public static final String fpgas[] = {
|
| 420 |
|
|
"(unknown)" , // 0
|
| 421 |
|
|
"XC6SLX9" , // 1
|
| 422 |
|
|
"XC6SLX16" , // 2
|
| 423 |
|
|
"XC6SLX25" , // 3
|
| 424 |
|
|
"XC6SLX45" , // 4
|
| 425 |
|
|
"XC6SLX75" , // 5
|
| 426 |
|
|
"XC6SLX100" , // 6
|
| 427 |
|
|
"XC6SLX150" , // 7
|
| 428 |
|
|
"XC7A35T", // 8
|
| 429 |
|
|
"XC7A50T", // 9
|
| 430 |
|
|
"XC7A75T", // 10
|
| 431 |
|
|
"XC7A100T", // 11
|
| 432 |
|
|
"XC7A200T", // 12
|
| 433 |
|
|
"Quad-XC6SLX150", // 13
|
| 434 |
|
|
"XC7A15T", // 14
|
| 435 |
|
|
};</code></pre></div>
|
| 436 |
|
|
</li>
|
| 437 |
|
|
</ul>
|
| 438 |
|
|
<a name="packages">
|
| 439 |
|
|
<!-- -->
|
| 440 |
|
|
</a>
|
| 441 |
|
|
<ul class="blockList">
|
| 442 |
|
|
<li class="blockList">
|
| 443 |
|
|
<h4>packages</h4>
|
| 444 |
|
|
<pre>public static final java.lang.String[] packages</pre>
|
| 445 |
|
|
<div class="block">FPGA packages used on ZTEX FPGA boards.
|
| 446 |
|
|
It's defined as
|
| 447 |
|
|
<pre><code>public static final String packages[] = {
|
| 448 |
|
|
"(unknown)", // 0
|
| 449 |
|
|
"FTG256" , // 1 256 balls, 1.0mm
|
| 450 |
|
|
"CSG324" , // 2 324 balls, 0.8mm
|
| 451 |
|
|
"CSG484" , // 3 484 balls, 0.8mm
|
| 452 |
|
|
"FBG484" // 4 484 balls, 1.0mm
|
| 453 |
|
|
};</code></pre></div>
|
| 454 |
|
|
</li>
|
| 455 |
|
|
</ul>
|
| 456 |
|
|
<a name="ramTypes">
|
| 457 |
|
|
<!-- -->
|
| 458 |
|
|
</a>
|
| 459 |
|
|
<ul class="blockListLast">
|
| 460 |
|
|
<li class="blockList">
|
| 461 |
|
|
<h4>ramTypes</h4>
|
| 462 |
|
|
<pre>public static final java.lang.String[] ramTypes</pre>
|
| 463 |
|
|
<div class="block">RAM types and speed used on ZTEX FPGA boards.
|
| 464 |
|
|
It's defined as
|
| 465 |
|
|
<pre><code>public static final String ramTypes[] = {
|
| 466 |
|
|
"(unknown)", // 0
|
| 467 |
|
|
"DDR-200 SDRAM", // 1
|
| 468 |
|
|
"DDR-266 SDRAM", // 2
|
| 469 |
|
|
"DDR-333 SDRAM", // 3
|
| 470 |
|
|
"DDR-400 SDRAM", // 4
|
| 471 |
|
|
"DDR2-400 SDRAM", // 5
|
| 472 |
|
|
"DDR2-533 SDRAM", // 6
|
| 473 |
|
|
"DDR2-667 SDRAM", // 7
|
| 474 |
|
|
"DDR2-800 SDRAM", // 8
|
| 475 |
|
|
"DDR2-1066 SDRAM" // 9
|
| 476 |
|
|
};</code></pre></div>
|
| 477 |
|
|
</li>
|
| 478 |
|
|
</ul>
|
| 479 |
|
|
</li>
|
| 480 |
|
|
</ul>
|
| 481 |
|
|
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
| 482 |
|
|
<ul class="blockList">
|
| 483 |
|
|
<li class="blockList"><a name="constructor_detail">
|
| 484 |
|
|
<!-- -->
|
| 485 |
|
|
</a>
|
| 486 |
|
|
<h3>Constructor Detail</h3>
|
| 487 |
|
|
<a name="ConfigData()">
|
| 488 |
|
|
<!-- -->
|
| 489 |
|
|
</a>
|
| 490 |
|
|
<ul class="blockList">
|
| 491 |
|
|
<li class="blockList">
|
| 492 |
|
|
<h4>ConfigData</h4>
|
| 493 |
|
|
<pre>public ConfigData()</pre>
|
| 494 |
|
|
<div class="block">Constructs an empty instance.</div>
|
| 495 |
|
|
</li>
|
| 496 |
|
|
</ul>
|
| 497 |
|
|
<a name="ConfigData(ztex.Ztex1v1)">
|
| 498 |
|
|
<!-- -->
|
| 499 |
|
|
</a>
|
| 500 |
|
|
<ul class="blockListLast">
|
| 501 |
|
|
<li class="blockList">
|
| 502 |
|
|
<h4>ConfigData</h4>
|
| 503 |
|
|
<pre>public ConfigData(<a href="../ztex/Ztex1v1.html" title="class in ztex">Ztex1v1</a> z)
|
| 504 |
|
|
throws <a href="../ztex/InvalidFirmwareException.html" title="class in ztex">InvalidFirmwareException</a>,
|
| 505 |
|
|
<a href="../ztex/UsbException.html" title="class in ztex">UsbException</a>,
|
| 506 |
|
|
<a href="../ztex/CapabilityException.html" title="class in ztex">CapabilityException</a></pre>
|
| 507 |
|
|
<div class="block">Constructs an instance and connects it with z. Also see <a href="../ztex/ConfigData.html#connect(ztex.Ztex1v1)"><code>connect(Ztex1v1)</code></a>.</div>
|
| 508 |
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>z</code> - The ztex device to connect with.</dd>
|
| 509 |
|
|
<dt><span class="strong">Throws:</span></dt>
|
| 510 |
|
|
<dd><code><a href="../ztex/InvalidFirmwareException.html" title="class in ztex">InvalidFirmwareException</a></code> - if interface 1 is not supported.</dd>
|
| 511 |
|
|
<dd><code><a href="../ztex/UsbException.html" title="class in ztex">UsbException</a></code> - If a communication error occurs.</dd>
|
| 512 |
|
|
<dd><code><a href="../ztex/CapabilityException.html" title="class in ztex">CapabilityException</a></code> - If no MAC-EEPROM support is present.</dd></dl>
|
| 513 |
|
|
</li>
|
| 514 |
|
|
</ul>
|
| 515 |
|
|
</li>
|
| 516 |
|
|
</ul>
|
| 517 |
|
|
<!-- ============ METHOD DETAIL ========== -->
|
| 518 |
|
|
<ul class="blockList">
|
| 519 |
|
|
<li class="blockList"><a name="method_detail">
|
| 520 |
|
|
<!-- -->
|
| 521 |
|
|
</a>
|
| 522 |
|
|
<h3>Method Detail</h3>
|
| 523 |
|
|
<a name="connect(ztex.Ztex1v1)">
|
| 524 |
|
|
<!-- -->
|
| 525 |
|
|
</a>
|
| 526 |
|
|
<ul class="blockList">
|
| 527 |
|
|
<li class="blockList">
|
| 528 |
|
|
<h4>connect</h4>
|
| 529 |
|
|
<pre>public boolean connect(<a href="../ztex/Ztex1v1.html" title="class in ztex">Ztex1v1</a> z)
|
| 530 |
|
|
throws <a href="../ztex/InvalidFirmwareException.html" title="class in ztex">InvalidFirmwareException</a>,
|
| 531 |
|
|
<a href="../ztex/UsbException.html" title="class in ztex">UsbException</a>,
|
| 532 |
|
|
<a href="../ztex/CapabilityException.html" title="class in ztex">CapabilityException</a></pre>
|
| 533 |
|
|
<div class="block">Reads the configuration data (if existent) from a device and connects it to this instance.
|
| 534 |
|
|
After this user defined settings (e.g. serial number, bitstream size) are
|
| 535 |
|
|
stored on device immediately after they are altered.</div>
|
| 536 |
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>z</code> - The ztex device to connect with.</dd>
|
| 537 |
|
|
<dt><span class="strong">Returns:</span></dt><dd>True if configuration data could be read.</dd>
|
| 538 |
|
|
<dt><span class="strong">Throws:</span></dt>
|
| 539 |
|
|
<dd><code><a href="../ztex/InvalidFirmwareException.html" title="class in ztex">InvalidFirmwareException</a></code> - If interface 1 is not supported.</dd>
|
| 540 |
|
|
<dd><code><a href="../ztex/UsbException.html" title="class in ztex">UsbException</a></code> - If a communication error occurs.</dd>
|
| 541 |
|
|
<dd><code><a href="../ztex/CapabilityException.html" title="class in ztex">CapabilityException</a></code> - If no MAC-EEPROM support is present.</dd></dl>
|
| 542 |
|
|
</li>
|
| 543 |
|
|
</ul>
|
| 544 |
|
|
<a name="disconnect()">
|
| 545 |
|
|
<!-- -->
|
| 546 |
|
|
</a>
|
| 547 |
|
|
<ul class="blockList">
|
| 548 |
|
|
<li class="blockList">
|
| 549 |
|
|
<h4>disconnect</h4>
|
| 550 |
|
|
<pre>public boolean disconnect()</pre>
|
| 551 |
|
|
<div class="block">Disconnects the currently connected device.
|
| 552 |
|
|
After this modified settings are not stored on device anymore.</div>
|
| 553 |
|
|
<dl><dt><span class="strong">Returns:</span></dt><dd>True if a device was connected.</dd></dl>
|
| 554 |
|
|
</li>
|
| 555 |
|
|
</ul>
|
| 556 |
|
|
<a name="data()">
|
| 557 |
|
|
<!-- -->
|
| 558 |
|
|
</a>
|
| 559 |
|
|
<ul class="blockList">
|
| 560 |
|
|
<li class="blockList">
|
| 561 |
|
|
<h4>data</h4>
|
| 562 |
|
|
<pre>public byte[] data()</pre>
|
| 563 |
|
|
<div class="block">Returns a copy of the configuration data array.</div>
|
| 564 |
|
|
<dl><dt><span class="strong">Returns:</span></dt><dd>A copy of the configuration data array.</dd></dl>
|
| 565 |
|
|
</li>
|
| 566 |
|
|
</ul>
|
| 567 |
|
|
<a name="getName()">
|
| 568 |
|
|
<!-- -->
|
| 569 |
|
|
</a>
|
| 570 |
|
|
<ul class="blockList">
|
| 571 |
|
|
<li class="blockList">
|
| 572 |
|
|
<h4>getName</h4>
|
| 573 |
|
|
<pre>public java.lang.String getName()</pre>
|
| 574 |
|
|
<div class="block">Returns the name of the FPGA Board.</div>
|
| 575 |
|
|
<dl><dt><span class="strong">Returns:</span></dt><dd>The name of the FPGA Board.</dd></dl>
|
| 576 |
|
|
</li>
|
| 577 |
|
|
</ul>
|
| 578 |
|
|
<a name="getMajorVersion()">
|
| 579 |
|
|
<!-- -->
|
| 580 |
|
|
</a>
|
| 581 |
|
|
<ul class="blockList">
|
| 582 |
|
|
<li class="blockList">
|
| 583 |
|
|
<h4>getMajorVersion</h4>
|
| 584 |
|
|
<pre>public byte getMajorVersion()</pre>
|
| 585 |
|
|
<div class="block">Returns the major version number, e.g. 2 for USB-FPGA Modules 2.14b.</div>
|
| 586 |
|
|
<dl><dt><span class="strong">Returns:</span></dt><dd>the major version number.</dd></dl>
|
| 587 |
|
|
</li>
|
| 588 |
|
|
</ul>
|
| 589 |
|
|
<a name="getMinorVersion()">
|
| 590 |
|
|
<!-- -->
|
| 591 |
|
|
</a>
|
| 592 |
|
|
<ul class="blockList">
|
| 593 |
|
|
<li class="blockList">
|
| 594 |
|
|
<h4>getMinorVersion</h4>
|
| 595 |
|
|
<pre>public byte getMinorVersion()</pre>
|
| 596 |
|
|
<div class="block">Returns the minor version number, e.g. 14 for USB-FPGA Modules 2.14b.</div>
|
| 597 |
|
|
<dl><dt><span class="strong">Returns:</span></dt><dd>the minor version number.</dd></dl>
|
| 598 |
|
|
</li>
|
| 599 |
|
|
</ul>
|
| 600 |
|
|
<a name="getVariant()">
|
| 601 |
|
|
<!-- -->
|
| 602 |
|
|
</a>
|
| 603 |
|
|
<ul class="blockList">
|
| 604 |
|
|
<li class="blockList">
|
| 605 |
|
|
<h4>getVariant</h4>
|
| 606 |
|
|
<pre>public java.lang.String getVariant()</pre>
|
| 607 |
|
|
<div class="block">Returns the variant letter, e.g. "b" for USB-FPGA Modules 2.14b.</div>
|
| 608 |
|
|
<dl><dt><span class="strong">Returns:</span></dt><dd>the variant letter.</dd></dl>
|
| 609 |
|
|
</li>
|
| 610 |
|
|
</ul>
|
| 611 |
|
|
<a name="setName(java.lang.String, int, int, java.lang.String)">
|
| 612 |
|
|
<!-- -->
|
| 613 |
|
|
</a>
|
| 614 |
|
|
<ul class="blockList">
|
| 615 |
|
|
<li class="blockList">
|
| 616 |
|
|
<h4>setName</h4>
|
| 617 |
|
|
<pre>public void setName(java.lang.String kind,
|
| 618 |
|
|
int series,
|
| 619 |
|
|
int number,
|
| 620 |
|
|
java.lang.String variant)</pre>
|
| 621 |
|
|
<div class="block">Sets the name of the FPGA Board.
|
| 622 |
|
|
Example: <pre>setName("ZTEX USB-FPGA Module", 2, 16, "b"); // denotes "ZTEX USB-FPGA Module 2.16b"</pre>
|
| 623 |
|
|
This setting is not transferred to the FPGA Board because is should not be altered by the user.</div>
|
| 624 |
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>kind</code> - Kind of FPGA Board, see <a href="../ztex/ConfigData.html#boardNames"><code>boardNames</code></a> for possible values, e.g. "ZTEX USB-FPGA Module"</dd><dd><code>series</code> - FPGA Board series, e.g. 2</dd><dd><code>number</code> - FPGA Board number (number behind the dot), e.g. 16</dd><dd><code>variant</code> - FPGA Board variant (letter), e.g. "b"</dd></dl>
|
| 625 |
|
|
</li>
|
| 626 |
|
|
</ul>
|
| 627 |
|
|
<a name="getFpga()">
|
| 628 |
|
|
<!-- -->
|
| 629 |
|
|
</a>
|
| 630 |
|
|
<ul class="blockList">
|
| 631 |
|
|
<li class="blockList">
|
| 632 |
|
|
<h4>getFpga</h4>
|
| 633 |
|
|
<pre>public java.lang.String getFpga()</pre>
|
| 634 |
|
|
<div class="block">Returns FPGA information.
|
| 635 |
|
|
Notation of the result is <name>-<package>-<speed grade and temperature range>, e.g. XC7A200T-FBG484-2C.</div>
|
| 636 |
|
|
<dl><dt><span class="strong">Returns:</span></dt><dd>FPGA Information.</dd></dl>
|
| 637 |
|
|
</li>
|
| 638 |
|
|
</ul>
|
| 639 |
|
|
<a name="setFpga(java.lang.String, java.lang.String, java.lang.String)">
|
| 640 |
|
|
<!-- -->
|
| 641 |
|
|
</a>
|
| 642 |
|
|
<ul class="blockList">
|
| 643 |
|
|
<li class="blockList">
|
| 644 |
|
|
<h4>setFpga</h4>
|
| 645 |
|
|
<pre>public void setFpga(java.lang.String name,
|
| 646 |
|
|
java.lang.String pckg,
|
| 647 |
|
|
java.lang.String sg)</pre>
|
| 648 |
|
|
<div class="block">Sets FPGA information.
|
| 649 |
|
|
Example: <pre>setFpga("XC7A200T", "FBG484", "2C"); // denotes Xilinx part number XC7A200T-2FBG484C</pre>
|
| 650 |
|
|
This setting is not transferred to the FPGA Board because is should not be altered by the user.</div>
|
| 651 |
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - Name of the FPGA, see <a href="../ztex/ConfigData.html#fpgas"><code>fpgas</code></a> for possible values, e.g. "XC7A200T"</dd><dd><code>pckg</code> - FPGA package, see <a href="../ztex/ConfigData.html#packages"><code>packages</code></a> for possible values, e.g. "FBG484"</dd><dd><code>sg</code> - Speed grade and temperature range, e.g. "2C"</dd></dl>
|
| 652 |
|
|
</li>
|
| 653 |
|
|
</ul>
|
| 654 |
|
|
<a name="getRamType()">
|
| 655 |
|
|
<!-- -->
|
| 656 |
|
|
</a>
|
| 657 |
|
|
<ul class="blockList">
|
| 658 |
|
|
<li class="blockList">
|
| 659 |
|
|
<h4>getRamType</h4>
|
| 660 |
|
|
<pre>public java.lang.String getRamType()</pre>
|
| 661 |
|
|
<div class="block">Returns RAM type and speed.</div>
|
| 662 |
|
|
<dl><dt><span class="strong">Returns:</span></dt><dd>FPGA Information.</dd></dl>
|
| 663 |
|
|
</li>
|
| 664 |
|
|
</ul>
|
| 665 |
|
|
<a name="getRamSize()">
|
| 666 |
|
|
<!-- -->
|
| 667 |
|
|
</a>
|
| 668 |
|
|
<ul class="blockList">
|
| 669 |
|
|
<li class="blockList">
|
| 670 |
|
|
<h4>getRamSize</h4>
|
| 671 |
|
|
<pre>public int getRamSize()</pre>
|
| 672 |
|
|
<div class="block">Returns RAM size in bytes.</div>
|
| 673 |
|
|
<dl><dt><span class="strong">Returns:</span></dt><dd>RAM size in bytes.</dd></dl>
|
| 674 |
|
|
</li>
|
| 675 |
|
|
</ul>
|
| 676 |
|
|
<a name="setRam(int, java.lang.String)">
|
| 677 |
|
|
<!-- -->
|
| 678 |
|
|
</a>
|
| 679 |
|
|
<ul class="blockList">
|
| 680 |
|
|
<li class="blockList">
|
| 681 |
|
|
<h4>setRam</h4>
|
| 682 |
|
|
<pre>public void setRam(int size,
|
| 683 |
|
|
java.lang.String type)</pre>
|
| 684 |
|
|
<div class="block">Sets RAM information.
|
| 685 |
|
|
Example: <pre>setRam(128, "DDR2-800 SDRAM"); // sets RAM info to 128 MB DDR2-800 SDRAM</pre>
|
| 686 |
|
|
This setting is not transferred to the FPGA Board because is should not be altered by the user.</div>
|
| 687 |
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>size</code> - RAM size in MBytes, e.g. 128</dd><dd><code>type</code> - RAM type and speed, see <a href="../ztex/ConfigData.html#ramTypes"><code>ramTypes</code></a> for possible values, e.g. "DDR2-800 SDRAM"</dd></dl>
|
| 688 |
|
|
</li>
|
| 689 |
|
|
</ul>
|
| 690 |
|
|
<a name="getMaxBitstreamSize()">
|
| 691 |
|
|
<!-- -->
|
| 692 |
|
|
</a>
|
| 693 |
|
|
<ul class="blockList">
|
| 694 |
|
|
<li class="blockList">
|
| 695 |
|
|
<h4>getMaxBitstreamSize</h4>
|
| 696 |
|
|
<pre>public int getMaxBitstreamSize()</pre>
|
| 697 |
|
|
<div class="block">Returns maximum size of bitstream in bytes.
|
| 698 |
|
|
This is the amount of flash which should be reserved for the bitstream.</div>
|
| 699 |
|
|
<dl><dt><span class="strong">Returns:</span></dt><dd>Maximum size of bitstream in bytes sectors.</dd></dl>
|
| 700 |
|
|
</li>
|
| 701 |
|
|
</ul>
|
| 702 |
|
|
<a name="setMaxBitstreamSize(int)">
|
| 703 |
|
|
<!-- -->
|
| 704 |
|
|
</a>
|
| 705 |
|
|
<ul class="blockList">
|
| 706 |
|
|
<li class="blockList">
|
| 707 |
|
|
<h4>setMaxBitstreamSize</h4>
|
| 708 |
|
|
<pre>public void setMaxBitstreamSize(int size4k)</pre>
|
| 709 |
|
|
<div class="block">Sets the maximum size of bitstream in 4 KByte sectors.
|
| 710 |
|
|
This setting is not transferred to the FPGA Board because is should not be altered by the user.</div>
|
| 711 |
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>size4k</code> - Maximum size of bitstream in 4 KByte sectors. E.g. a value of 256 reserves 1 MByte for the bitstream.</dd></dl>
|
| 712 |
|
|
</li>
|
| 713 |
|
|
</ul>
|
| 714 |
|
|
<a name="getBitstreamStart()">
|
| 715 |
|
|
<!-- -->
|
| 716 |
|
|
</a>
|
| 717 |
|
|
<ul class="blockList">
|
| 718 |
|
|
<li class="blockList">
|
| 719 |
|
|
<h4>getBitstreamStart</h4>
|
| 720 |
|
|
<pre>public int getBitstreamStart()</pre>
|
| 721 |
|
|
<div class="block">Returns bitstream start position in bytes.
|
| 722 |
|
|
On devices which boot from flash the first sectors are reserved for the firmware.</div>
|
| 723 |
|
|
<dl><dt><span class="strong">Returns:</span></dt><dd>Bitstream start position in bytes.</dd></dl>
|
| 724 |
|
|
</li>
|
| 725 |
|
|
</ul>
|
| 726 |
|
|
<a name="setBitstreamStart(int)">
|
| 727 |
|
|
<!-- -->
|
| 728 |
|
|
</a>
|
| 729 |
|
|
<ul class="blockList">
|
| 730 |
|
|
<li class="blockList">
|
| 731 |
|
|
<h4>setBitstreamStart</h4>
|
| 732 |
|
|
<pre>public void setBitstreamStart(int start4k)</pre>
|
| 733 |
|
|
<div class="block">Sets the start position of the bitstream in 4 KByte sectors.
|
| 734 |
|
|
This setting is not transferred to the FPGA Board because is should not be altered by the user.</div>
|
| 735 |
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>start4k</code> - Bitstream start position in 4 KByte sectors. E.g. a value of 128 reserves 512 KByte for the bitstream.</dd></dl>
|
| 736 |
|
|
</li>
|
| 737 |
|
|
</ul>
|
| 738 |
|
|
<a name="getBitstreamSize()">
|
| 739 |
|
|
<!-- -->
|
| 740 |
|
|
</a>
|
| 741 |
|
|
<ul class="blockList">
|
| 742 |
|
|
<li class="blockList">
|
| 743 |
|
|
<h4>getBitstreamSize</h4>
|
| 744 |
|
|
<pre>public int getBitstreamSize()</pre>
|
| 745 |
|
|
<div class="block">Returns actual size of bitstream in bytes sectors.
|
| 746 |
|
|
|
| 747 |
|
|
<dl><dt><span class="strong">Returns:</span></dt><dd>Actual size of bitstream in byte sectors.</dd></dl>
|
| 748 |
|
|
</li>
|
| 749 |
|
|
</ul>
|
| 750 |
|
|
<a name="setBitstreamSize(int)">
|
| 751 |
|
|
<!-- -->
|
| 752 |
|
|
</a>
|
| 753 |
|
|
<ul class="blockList">
|
| 754 |
|
|
<li class="blockList">
|
| 755 |
|
|
<h4>setBitstreamSize</h4>
|
| 756 |
|
|
<pre>public boolean setBitstreamSize(int size)
|
| 757 |
|
|
throws <a href="../ztex/InvalidFirmwareException.html" title="class in ztex">InvalidFirmwareException</a>,
|
| 758 |
|
|
<a href="../ztex/UsbException.html" title="class in ztex">UsbException</a>,
|
| 759 |
|
|
<a href="../ztex/CapabilityException.html" title="class in ztex">CapabilityException</a></pre>
|
| 760 |
|
|
<div class="block">Sets the actual size of bitstream in bytes. The value is rounded up to a multiple of 4096.
|
| 761 |
|
|
If a device is connected, this setting is transferred to the FPGA Board.
|
| 762 |
|
|
A warning is printed if bitstream size is larger then the reserved size (see <a href="../ztex/ConfigData.html#getMaxBitstreamSize()"><code>getMaxBitstreamSize()</code></a>).</div>
|
| 763 |
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>size</code> - Actual size of bitstream in bytes.</dd>
|
| 764 |
|
|
<dt><span class="strong">Returns:</span></dt><dd>True if a device is connected and setting was send.</dd>
|
| 765 |
|
|
<dt><span class="strong">Throws:</span></dt>
|
| 766 |
|
|
<dd><code><a href="../ztex/InvalidFirmwareException.html" title="class in ztex">InvalidFirmwareException</a></code> - If interface 1 is not supported.</dd>
|
| 767 |
|
|
<dd><code><a href="../ztex/UsbException.html" title="class in ztex">UsbException</a></code> - If a communication error occurs.</dd>
|
| 768 |
|
|
<dd><code><a href="../ztex/CapabilityException.html" title="class in ztex">CapabilityException</a></code> - If no MAC-EEPROM support is present.</dd></dl>
|
| 769 |
|
|
</li>
|
| 770 |
|
|
</ul>
|
| 771 |
|
|
<a name="setSN(java.lang.String)">
|
| 772 |
|
|
<!-- -->
|
| 773 |
|
|
</a>
|
| 774 |
|
|
<ul class="blockList">
|
| 775 |
|
|
<li class="blockList">
|
| 776 |
|
|
<h4>setSN</h4>
|
| 777 |
|
|
<pre>public boolean setSN(java.lang.String sn)
|
| 778 |
|
|
throws <a href="../ztex/InvalidFirmwareException.html" title="class in ztex">InvalidFirmwareException</a>,
|
| 779 |
|
|
<a href="../ztex/UsbException.html" title="class in ztex">UsbException</a>,
|
| 780 |
|
|
<a href="../ztex/CapabilityException.html" title="class in ztex">CapabilityException</a></pre>
|
| 781 |
|
|
<div class="block">Sets the serial number.
|
| 782 |
|
|
During start-up the firmware overwrites SN_STRING from the ZTEX descriptor (see <a href="../ztex/ZtexDevice1.html" title="class in ztex"><code>ZtexDevice1</code></a>) by this value.
|
| 783 |
|
|
If it is equal to "0000000000" (default) it is replaced by the unique MAC address. <p>
|
| 784 |
|
|
This setting is transferred to the FPGA Board.
|
| 785 |
|
|
Change takes effect after the next restart of the firmware.</div>
|
| 786 |
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>sn</code> - Serial number string. Only the first 10 characters are considered.</dd>
|
| 787 |
|
|
<dt><span class="strong">Returns:</span></dt><dd>True if a device is connected and setting was send.</dd>
|
| 788 |
|
|
<dt><span class="strong">Throws:</span></dt>
|
| 789 |
|
|
<dd><code><a href="../ztex/InvalidFirmwareException.html" title="class in ztex">InvalidFirmwareException</a></code> - If interface 1 is not supported.</dd>
|
| 790 |
|
|
<dd><code><a href="../ztex/UsbException.html" title="class in ztex">UsbException</a></code> - If a communication error occurs.</dd>
|
| 791 |
|
|
<dd><code><a href="../ztex/CapabilityException.html" title="class in ztex">CapabilityException</a></code> - If no MAC-EEPROM support is present.</dd></dl>
|
| 792 |
|
|
</li>
|
| 793 |
|
|
</ul>
|
| 794 |
|
|
<a name="setUsbIDs(int, int)">
|
| 795 |
|
|
<!-- -->
|
| 796 |
|
|
</a>
|
| 797 |
|
|
<ul class="blockList">
|
| 798 |
|
|
<li class="blockList">
|
| 799 |
|
|
<h4>setUsbIDs</h4>
|
| 800 |
|
|
<pre>public boolean setUsbIDs(int vid,
|
| 801 |
|
|
int pid)
|
| 802 |
|
|
throws <a href="../ztex/InvalidFirmwareException.html" title="class in ztex">InvalidFirmwareException</a>,
|
| 803 |
|
|
<a href="../ztex/UsbException.html" title="class in ztex">UsbException</a>,
|
| 804 |
|
|
<a href="../ztex/CapabilityException.html" title="class in ztex">CapabilityException</a></pre>
|
| 805 |
|
|
<div class="block">Set the USB vendor vendor and product ID.
|
| 806 |
|
|
If vendor ID is 0 the default values from the firmware are used.</div>
|
| 807 |
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>vid</code> - USB vendor ID.</dd><dd><code>pid</code> - USB product ID.
|
| 808 |
|
|
<p> This settings are transferred to the FPGA Board.
|
| 809 |
|
|
Change takes effect after the next restart of the firmware.</dd>
|
| 810 |
|
|
<dt><span class="strong">Returns:</span></dt><dd>True if a device is connected and setting was send.</dd>
|
| 811 |
|
|
<dt><span class="strong">Throws:</span></dt>
|
| 812 |
|
|
<dd><code><a href="../ztex/InvalidFirmwareException.html" title="class in ztex">InvalidFirmwareException</a></code> - If interface 1 is not supported.</dd>
|
| 813 |
|
|
<dd><code><a href="../ztex/UsbException.html" title="class in ztex">UsbException</a></code> - If a communication error occurs.</dd>
|
| 814 |
|
|
<dd><code><a href="../ztex/CapabilityException.html" title="class in ztex">CapabilityException</a></code> - If no MAC-EEPROM support is present.</dd></dl>
|
| 815 |
|
|
</li>
|
| 816 |
|
|
</ul>
|
| 817 |
|
|
<a name="setProductString(java.lang.String)">
|
| 818 |
|
|
<!-- -->
|
| 819 |
|
|
</a>
|
| 820 |
|
|
<ul class="blockList">
|
| 821 |
|
|
<li class="blockList">
|
| 822 |
|
|
<h4>setProductString</h4>
|
| 823 |
|
|
<pre>public boolean setProductString(java.lang.String ps)
|
| 824 |
|
|
throws <a href="../ztex/InvalidFirmwareException.html" title="class in ztex">InvalidFirmwareException</a>,
|
| 825 |
|
|
<a href="../ztex/UsbException.html" title="class in ztex">UsbException</a>,
|
| 826 |
|
|
<a href="../ztex/CapabilityException.html" title="class in ztex">CapabilityException</a></pre>
|
| 827 |
|
|
<div class="block">Sets the product string.
|
| 828 |
|
|
If string is empty the firmware default is used.
|
| 829 |
|
|
<p> This setting is transferred to the FPGA Board.
|
| 830 |
|
|
Change takes effect after the next restart of the firmware.</div>
|
| 831 |
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>ps</code> - The product string.</dd>
|
| 832 |
|
|
<dt><span class="strong">Returns:</span></dt><dd>True if a device is connected and setting was send.</dd>
|
| 833 |
|
|
<dt><span class="strong">Throws:</span></dt>
|
| 834 |
|
|
<dd><code><a href="../ztex/InvalidFirmwareException.html" title="class in ztex">InvalidFirmwareException</a></code> - If interface 1 is not supported.</dd>
|
| 835 |
|
|
<dd><code><a href="../ztex/UsbException.html" title="class in ztex">UsbException</a></code> - If a communication error occurs.</dd>
|
| 836 |
|
|
<dd><code><a href="../ztex/CapabilityException.html" title="class in ztex">CapabilityException</a></code> - If no MAC-EEPROM support is present.</dd></dl>
|
| 837 |
|
|
</li>
|
| 838 |
|
|
</ul>
|
| 839 |
|
|
<a name="getUserData(int)">
|
| 840 |
|
|
<!-- -->
|
| 841 |
|
|
</a>
|
| 842 |
|
|
<ul class="blockList">
|
| 843 |
|
|
<li class="blockList">
|
| 844 |
|
|
<h4>getUserData</h4>
|
| 845 |
|
|
<pre>public byte getUserData(int i)</pre>
|
| 846 |
|
|
<div class="block">Returns user data at index i.</div>
|
| 847 |
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>i</code> - the index. Valid values are 0 to 47.</dd>
|
| 848 |
|
|
<dt><span class="strong">Returns:</span></dt><dd>User data.</dd>
|
| 849 |
|
|
<dt><span class="strong">Throws:</span></dt>
|
| 850 |
|
|
<dd><code>java.lang.IndexOutOfBoundsException</code> - If i is smaller than 0 or greater than 47.</dd></dl>
|
| 851 |
|
|
</li>
|
| 852 |
|
|
</ul>
|
| 853 |
|
|
<a name="setUserData(int, byte)">
|
| 854 |
|
|
<!-- -->
|
| 855 |
|
|
</a>
|
| 856 |
|
|
<ul class="blockList">
|
| 857 |
|
|
<li class="blockList">
|
| 858 |
|
|
<h4>setUserData</h4>
|
| 859 |
|
|
<pre>public void setUserData(int i,
|
| 860 |
|
|
byte v)
|
| 861 |
|
|
throws java.lang.IndexOutOfBoundsException</pre>
|
| 862 |
|
|
<div class="block">Sets user data at index i to value v. Use the method <a href="../ztex/ConfigData.html#getMaxBitstreamSize()"><code>getMaxBitstreamSize()</code></a>
|
| 863 |
|
|
to transfer the data to the FPGA Board.</div>
|
| 864 |
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>i</code> - The index. Valid values are 0 to 47.</dd><dd><code>v</code> - The value.</dd>
|
| 865 |
|
|
<dt><span class="strong">Throws:</span></dt>
|
| 866 |
|
|
<dd><code>java.lang.IndexOutOfBoundsException</code> - If i is smaller than 0 or greater than 47.</dd></dl>
|
| 867 |
|
|
</li>
|
| 868 |
|
|
</ul>
|
| 869 |
|
|
<a name="sendtUserData()">
|
| 870 |
|
|
<!-- -->
|
| 871 |
|
|
</a>
|
| 872 |
|
|
<ul class="blockList">
|
| 873 |
|
|
<li class="blockList">
|
| 874 |
|
|
<h4>sendtUserData</h4>
|
| 875 |
|
|
<pre>public boolean sendtUserData()
|
| 876 |
|
|
throws <a href="../ztex/InvalidFirmwareException.html" title="class in ztex">InvalidFirmwareException</a>,
|
| 877 |
|
|
<a href="../ztex/UsbException.html" title="class in ztex">UsbException</a>,
|
| 878 |
|
|
<a href="../ztex/CapabilityException.html" title="class in ztex">CapabilityException</a></pre>
|
| 879 |
|
|
<div class="block">Sends the user data to the FPGA Board.</div>
|
| 880 |
|
|
<dl><dt><span class="strong">Returns:</span></dt><dd>True if a device is connected and data could be send.</dd>
|
| 881 |
|
|
<dt><span class="strong">Throws:</span></dt>
|
| 882 |
|
|
<dd><code><a href="../ztex/InvalidFirmwareException.html" title="class in ztex">InvalidFirmwareException</a></code> - If interface 1 is not supported.</dd>
|
| 883 |
|
|
<dd><code><a href="../ztex/UsbException.html" title="class in ztex">UsbException</a></code> - If a communication error occurs.</dd>
|
| 884 |
|
|
<dd><code><a href="../ztex/CapabilityException.html" title="class in ztex">CapabilityException</a></code> - If no MAC-EEPROM support is present.</dd></dl>
|
| 885 |
|
|
</li>
|
| 886 |
|
|
</ul>
|
| 887 |
|
|
<a name="defaultBitstreamPath(java.lang.String)">
|
| 888 |
|
|
<!-- -->
|
| 889 |
|
|
</a>
|
| 890 |
|
|
<ul class="blockListLast">
|
| 891 |
|
|
<li class="blockList">
|
| 892 |
|
|
<h4>defaultBitstreamPath</h4>
|
| 893 |
|
|
<pre>public java.lang.String defaultBitstreamPath(java.lang.String name)</pre>
|
| 894 |
|
|
<div class="block">Returns the bitstream path if the same directory sheme as for the examples is used.
|
| 895 |
|
|
For USB-FPGA Modules 1.* and 2.0* (Spartan 6 FPGA) it is "usb-fpga-<major version number>.<minor version number><variant letter>/<project name>.bit",
|
| 896 |
|
|
for later FPGA Boards it is "usb-fpga-<major version number>.<minor version number>/<project name>.runs/impl_<major version number>.<minor version number><variant letter>/<project name>.bit".</div>
|
| 897 |
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - The project name.</dd>
|
| 898 |
|
|
<dt><span class="strong">Returns:</span></dt><dd>Standard bitstream path.</dd></dl>
|
| 899 |
|
|
</li>
|
| 900 |
|
|
</ul>
|
| 901 |
|
|
</li>
|
| 902 |
|
|
</ul>
|
| 903 |
|
|
</li>
|
| 904 |
|
|
</ul>
|
| 905 |
|
|
</div>
|
| 906 |
|
|
</div>
|
| 907 |
|
|
<!-- ========= END OF CLASS DATA ========= -->
|
| 908 |
|
|
<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
| 909 |
|
|
<div class="bottomNav"><a name="navbar_bottom">
|
| 910 |
|
|
<!-- -->
|
| 911 |
|
|
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
|
| 912 |
|
|
<!-- -->
|
| 913 |
|
|
</a>
|
| 914 |
|
|
<ul class="navList" title="Navigation">
|
| 915 |
|
|
<li><a href="../ztex/package-summary.html">Package</a></li>
|
| 916 |
|
|
<li class="navBarCell1Rev">Class</li>
|
| 917 |
|
|
<li><a href="package-tree.html">Tree</a></li>
|
| 918 |
|
|
<li><a href="../deprecated-list.html">Deprecated</a></li>
|
| 919 |
|
|
<li><a href="../index-all.html">Index</a></li>
|
| 920 |
|
|
<li><a href="../help-doc.html">Help</a></li>
|
| 921 |
|
|
</ul>
|
| 922 |
|
|
</div>
|
| 923 |
|
|
<div class="subNav">
|
| 924 |
|
|
<ul class="navList">
|
| 925 |
|
|
<li><a href="../ztex/CapabilityException.html" title="class in ztex"><span class="strong">Prev Class</span></a></li>
|
| 926 |
|
|
<li><a href="../ztex/DeviceLostException.html" title="class in ztex"><span class="strong">Next Class</span></a></li>
|
| 927 |
|
|
</ul>
|
| 928 |
|
|
<ul class="navList">
|
| 929 |
|
|
<li><a href="../index.html?ztex/ConfigData.html" target="_top">Frames</a></li>
|
| 930 |
|
|
<li><a href="ConfigData.html" target="_top">No Frames</a></li>
|
| 931 |
|
|
</ul>
|
| 932 |
|
|
<ul class="navList" id="allclasses_navbar_bottom">
|
| 933 |
|
|
<li><a href="../allclasses-noframe.html">All Classes</a></li>
|
| 934 |
|
|
</ul>
|
| 935 |
|
|
<div>
|
| 936 |
|
|
<script type="text/javascript"><!--
|
| 937 |
|
|
allClassesLink = document.getElementById("allclasses_navbar_bottom");
|
| 938 |
|
|
if(window==top) {
|
| 939 |
|
|
allClassesLink.style.display = "block";
|
| 940 |
|
|
}
|
| 941 |
|
|
else {
|
| 942 |
|
|
allClassesLink.style.display = "none";
|
| 943 |
|
|
}
|
| 944 |
|
|
//-->
|
| 945 |
|
|
</script>
|
| 946 |
|
|
</div>
|
| 947 |
|
|
<div>
|
| 948 |
|
|
<ul class="subNavList">
|
| 949 |
|
|
<li>Summary: </li>
|
| 950 |
|
|
<li>Nested | </li>
|
| 951 |
|
|
<li><a href="#field_summary">Field</a> | </li>
|
| 952 |
|
|
<li><a href="#constructor_summary">Constr</a> | </li>
|
| 953 |
|
|
<li><a href="#method_summary">Method</a></li>
|
| 954 |
|
|
</ul>
|
| 955 |
|
|
<ul class="subNavList">
|
| 956 |
|
|
<li>Detail: </li>
|
| 957 |
|
|
<li><a href="#field_detail">Field</a> | </li>
|
| 958 |
|
|
<li><a href="#constructor_detail">Constr</a> | </li>
|
| 959 |
|
|
<li><a href="#method_detail">Method</a></li>
|
| 960 |
|
|
</ul>
|
| 961 |
|
|
</div>
|
| 962 |
|
|
<a name="skip-navbar_bottom">
|
| 963 |
|
|
<!-- -->
|
| 964 |
|
|
</a></div>
|
| 965 |
|
|
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
| 966 |
|
|
</body>
|
| 967 |
|
|
</html>
|
