URL
https://opencores.org/ocsvn/usb_fpga_2_14/usb_fpga_2_14/trunk
Subversion Repositories usb_fpga_2_14
[/] [usb_fpga_2_14/] [trunk/] [docs/] [java/] [ztex/] [ConfigData.html] - Rev 2
Compare with Previous | Blame | View Log
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="de">
<head>
<!-- Generated by javadoc (version 1.7.0_79) on Wed Mar 22 19:20:12 CET 2017 -->
<title>ConfigData</title>
<meta name="date" content="2017-03-22">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="ConfigData";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../ztex/package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../deprecated-list.html">Deprecated</a></li>
<li><a href="../index-all.html">Index</a></li>
<li><a href="../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../ztex/CapabilityException.html" title="class in ztex"><span class="strong">Prev Class</span></a></li>
<li><a href="../ztex/DeviceLostException.html" title="class in ztex"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../index.html?ztex/ConfigData.html" target="_top">Frames</a></li>
<li><a href="ConfigData.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li><a href="#field_summary">Field</a> | </li>
<li><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li><a href="#field_detail">Field</a> | </li>
<li><a href="#constructor_detail">Constr</a> | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">ztex</div>
<h2 title="Class ConfigData" class="title">Class ConfigData</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>ztex.ConfigData</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="strong">ConfigData</span>
extends java.lang.Object</pre>
<div class="block">This class represents the configuration data space of ZTEX FPGA Boards that support it.
The internal format is (byte order is LE -- least significant byte first)
<pre>
<Address> <Description>
0..2 Signature "CD0"
3 Kind of FPGA Board, see <a href="../ztex/ConfigData.html#boardNames"><code>boardNames</code></a>, e.g. 2 for "ZTEX USB-FPGA Module",
4 FPGA Board series, e.g. 2
5 FPGA Board number (number behind the dot), e.g. 16
6..7 FPGA Board variant (letter), e.g. "b"
8..9 FPGA, see <a href="../ztex/ConfigData.html#fpgas"><code>fpgas</code></a>, e.g. 12 for X7A200T
10 FPGA package, see <a href="../ztex/ConfigData.html#packages"><code>packages</code></a>, e.g. 3 for FBG484
11..13 Speed grade + temperature range, e.g. "2C"
14 RAM size, format is ( n & 0xf0 ) << ( (n & 0xf) + 16 ) bytes
15 RAM type, see <a href="../ztex/ConfigData.html#ramTypes"><code>ramTypes</code></a>
16..25 Serial number, overwrites SN_STRING of the ZTEX descriptor.
If it is equal to "0000000000" (default) it is replaced by the unique MAC address.
26..27 Actual size of Bitstream in 4K sectors; 0 means Bitstream disabled (default)
28..29 Maximum size of Bitstream in 4K sectors; 0 means that either no Flash
is present or that this information is stored in Flash (exchangeable media)
30..31 Start of the Bitstream in 4K sectors
32..33 USB vendor ID, ignored if zero
34..35 USB product ID, ignored if USB vendor ID is zero
36..67 Product string, null-terminated if length is smaller than 32
68..79 Reserved, must be 0
80..127 48 bytes user space
</pre></div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String[]</code></td>
<td class="colLast"><code><strong><a href="../ztex/ConfigData.html#boardNames">boardNames</a></strong></code>
<div class="block">Kinds of FPGA Boards.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.String[]</code></td>
<td class="colLast"><code><strong><a href="../ztex/ConfigData.html#fpgas">fpgas</a></strong></code>
<div class="block">FPGA's used on ZTEX FPGA Boards.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String[]</code></td>
<td class="colLast"><code><strong><a href="../ztex/ConfigData.html#packages">packages</a></strong></code>
<div class="block">FPGA packages used on ZTEX FPGA boards.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.String[]</code></td>
<td class="colLast"><code><strong><a href="../ztex/ConfigData.html#ramTypes">ramTypes</a></strong></code>
<div class="block">RAM types and speed used on ZTEX FPGA boards.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../ztex/ConfigData.html#ConfigData()">ConfigData</a></strong>()</code>
<div class="block">Constructs an empty instance.</div>
</td>
</tr>
<tr class="rowColor">
<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>
<div class="block">Constructs an instance and connects it with z.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<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>
<div class="block">Reads the configuration data (if existent) from a device and connects it to this instance.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>byte[]</code></td>
<td class="colLast"><code><strong><a href="../ztex/ConfigData.html#data()">data</a></strong>()</code>
<div class="block">Returns a copy of the configuration data array.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../ztex/ConfigData.html#defaultBitstreamPath(java.lang.String)">defaultBitstreamPath</a></strong>(java.lang.String name)</code>
<div class="block">Returns the bitstream path if the same directory sheme as for the examples is used.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../ztex/ConfigData.html#disconnect()">disconnect</a></strong>()</code>
<div class="block">Disconnects the currently connected device.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../ztex/ConfigData.html#getBitstreamSize()">getBitstreamSize</a></strong>()</code>
<div class="block">Returns actual size of bitstream in bytes sectors.
0 means that no bitstream is stored.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../ztex/ConfigData.html#getBitstreamStart()">getBitstreamStart</a></strong>()</code>
<div class="block">Returns bitstream start position in bytes.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../ztex/ConfigData.html#getFpga()">getFpga</a></strong>()</code>
<div class="block">Returns FPGA information.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>byte</code></td>
<td class="colLast"><code><strong><a href="../ztex/ConfigData.html#getMajorVersion()">getMajorVersion</a></strong>()</code>
<div class="block">Returns the major version number, e.g. 2 for USB-FPGA Modules 2.14b.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../ztex/ConfigData.html#getMaxBitstreamSize()">getMaxBitstreamSize</a></strong>()</code>
<div class="block">Returns maximum size of bitstream in bytes.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>byte</code></td>
<td class="colLast"><code><strong><a href="../ztex/ConfigData.html#getMinorVersion()">getMinorVersion</a></strong>()</code>
<div class="block">Returns the minor version number, e.g. 14 for USB-FPGA Modules 2.14b.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../ztex/ConfigData.html#getName()">getName</a></strong>()</code>
<div class="block">Returns the name of the FPGA Board.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../ztex/ConfigData.html#getRamSize()">getRamSize</a></strong>()</code>
<div class="block">Returns RAM size in bytes.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../ztex/ConfigData.html#getRamType()">getRamType</a></strong>()</code>
<div class="block">Returns RAM type and speed.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>byte</code></td>
<td class="colLast"><code><strong><a href="../ztex/ConfigData.html#getUserData(int)">getUserData</a></strong>(int i)</code>
<div class="block">Returns user data at index i.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../ztex/ConfigData.html#getVariant()">getVariant</a></strong>()</code>
<div class="block">Returns the variant letter, e.g.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../ztex/ConfigData.html#sendtUserData()">sendtUserData</a></strong>()</code>
<div class="block">Sends the user data to the FPGA Board.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../ztex/ConfigData.html#setBitstreamSize(int)">setBitstreamSize</a></strong>(int size)</code>
<div class="block">Sets the actual size of bitstream in bytes.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../ztex/ConfigData.html#setBitstreamStart(int)">setBitstreamStart</a></strong>(int start4k)</code>
<div class="block">Sets the start position of the bitstream in 4 KByte sectors.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<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,
java.lang.String pckg,
java.lang.String sg)</code>
<div class="block">Sets FPGA information.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../ztex/ConfigData.html#setMaxBitstreamSize(int)">setMaxBitstreamSize</a></strong>(int size4k)</code>
<div class="block">Sets the maximum size of bitstream in 4 KByte sectors.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<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,
int series,
int number,
java.lang.String variant)</code>
<div class="block">Sets the name of the FPGA Board.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../ztex/ConfigData.html#setProductString(java.lang.String)">setProductString</a></strong>(java.lang.String ps)</code>
<div class="block">Sets the product string.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../ztex/ConfigData.html#setRam(int,%20java.lang.String)">setRam</a></strong>(int size,
java.lang.String type)</code>
<div class="block">Sets RAM information.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../ztex/ConfigData.html#setSN(java.lang.String)">setSN</a></strong>(java.lang.String sn)</code>
<div class="block">Sets the serial number.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../ztex/ConfigData.html#setUsbIDs(int,%20int)">setUsbIDs</a></strong>(int vid,
int pid)</code>
<div class="block">Set the USB vendor vendor and product ID.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../ztex/ConfigData.html#setUserData(int,%20byte)">setUserData</a></strong>(int i,
byte v)</code>
<div class="block">Sets user data at index i to value v.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="boardNames">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>boardNames</h4>
<pre>public static final java.lang.String[] boardNames</pre>
<div class="block">Kinds of FPGA Boards.
It's defined as
<pre><code>public static final String boardNames[] = {
"(unknown)" , // 0
"ZTEX FPGA Module" , // 1
"ZTEX USB-FPGA Module" // 2, FX2 based
"ZTEX USB3-FPGA Module" // 3, FX3 based
};</code></pre></div>
</li>
</ul>
<a name="fpgas">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fpgas</h4>
<pre>public static final java.lang.String[] fpgas</pre>
<div class="block">FPGA's used on ZTEX FPGA Boards.
It's defined as
<pre><code>public static final String fpgas[] = {
"(unknown)" , // 0
"XC6SLX9" , // 1
"XC6SLX16" , // 2
"XC6SLX25" , // 3
"XC6SLX45" , // 4
"XC6SLX75" , // 5
"XC6SLX100" , // 6
"XC6SLX150" , // 7
"XC7A35T", // 8
"XC7A50T", // 9
"XC7A75T", // 10
"XC7A100T", // 11
"XC7A200T", // 12
"Quad-XC6SLX150", // 13
"XC7A15T", // 14
};</code></pre></div>
</li>
</ul>
<a name="packages">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>packages</h4>
<pre>public static final java.lang.String[] packages</pre>
<div class="block">FPGA packages used on ZTEX FPGA boards.
It's defined as
<pre><code>public static final String packages[] = {
"(unknown)", // 0
"FTG256" , // 1 256 balls, 1.0mm
"CSG324" , // 2 324 balls, 0.8mm
"CSG484" , // 3 484 balls, 0.8mm
"FBG484" // 4 484 balls, 1.0mm
};</code></pre></div>
</li>
</ul>
<a name="ramTypes">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ramTypes</h4>
<pre>public static final java.lang.String[] ramTypes</pre>
<div class="block">RAM types and speed used on ZTEX FPGA boards.
It's defined as
<pre><code>public static final String ramTypes[] = {
"(unknown)", // 0
"DDR-200 SDRAM", // 1
"DDR-266 SDRAM", // 2
"DDR-333 SDRAM", // 3
"DDR-400 SDRAM", // 4
"DDR2-400 SDRAM", // 5
"DDR2-533 SDRAM", // 6
"DDR2-667 SDRAM", // 7
"DDR2-800 SDRAM", // 8
"DDR2-1066 SDRAM" // 9
};</code></pre></div>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="ConfigData()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ConfigData</h4>
<pre>public ConfigData()</pre>
<div class="block">Constructs an empty instance.</div>
</li>
</ul>
<a name="ConfigData(ztex.Ztex1v1)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ConfigData</h4>
<pre>public ConfigData(<a href="../ztex/Ztex1v1.html" title="class in ztex">Ztex1v1</a> z)
throws <a href="../ztex/InvalidFirmwareException.html" title="class in ztex">InvalidFirmwareException</a>,
<a href="../ztex/UsbException.html" title="class in ztex">UsbException</a>,
<a href="../ztex/CapabilityException.html" title="class in ztex">CapabilityException</a></pre>
<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>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>z</code> - The ztex device to connect with.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../ztex/InvalidFirmwareException.html" title="class in ztex">InvalidFirmwareException</a></code> - if interface 1 is not supported.</dd>
<dd><code><a href="../ztex/UsbException.html" title="class in ztex">UsbException</a></code> - If a communication error occurs.</dd>
<dd><code><a href="../ztex/CapabilityException.html" title="class in ztex">CapabilityException</a></code> - If no MAC-EEPROM support is present.</dd></dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="connect(ztex.Ztex1v1)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>connect</h4>
<pre>public boolean connect(<a href="../ztex/Ztex1v1.html" title="class in ztex">Ztex1v1</a> z)
throws <a href="../ztex/InvalidFirmwareException.html" title="class in ztex">InvalidFirmwareException</a>,
<a href="../ztex/UsbException.html" title="class in ztex">UsbException</a>,
<a href="../ztex/CapabilityException.html" title="class in ztex">CapabilityException</a></pre>
<div class="block">Reads the configuration data (if existent) from a device and connects it to this instance.
After this user defined settings (e.g. serial number, bitstream size) are
stored on device immediately after they are altered.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>z</code> - The ztex device to connect with.</dd>
<dt><span class="strong">Returns:</span></dt><dd>True if configuration data could be read.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../ztex/InvalidFirmwareException.html" title="class in ztex">InvalidFirmwareException</a></code> - If interface 1 is not supported.</dd>
<dd><code><a href="../ztex/UsbException.html" title="class in ztex">UsbException</a></code> - If a communication error occurs.</dd>
<dd><code><a href="../ztex/CapabilityException.html" title="class in ztex">CapabilityException</a></code> - If no MAC-EEPROM support is present.</dd></dl>
</li>
</ul>
<a name="disconnect()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>disconnect</h4>
<pre>public boolean disconnect()</pre>
<div class="block">Disconnects the currently connected device.
After this modified settings are not stored on device anymore.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>True if a device was connected.</dd></dl>
</li>
</ul>
<a name="data()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>data</h4>
<pre>public byte[] data()</pre>
<div class="block">Returns a copy of the configuration data array.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>A copy of the configuration data array.</dd></dl>
</li>
</ul>
<a name="getName()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getName</h4>
<pre>public java.lang.String getName()</pre>
<div class="block">Returns the name of the FPGA Board.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The name of the FPGA Board.</dd></dl>
</li>
</ul>
<a name="getMajorVersion()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMajorVersion</h4>
<pre>public byte getMajorVersion()</pre>
<div class="block">Returns the major version number, e.g. 2 for USB-FPGA Modules 2.14b.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the major version number.</dd></dl>
</li>
</ul>
<a name="getMinorVersion()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMinorVersion</h4>
<pre>public byte getMinorVersion()</pre>
<div class="block">Returns the minor version number, e.g. 14 for USB-FPGA Modules 2.14b.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the minor version number.</dd></dl>
</li>
</ul>
<a name="getVariant()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getVariant</h4>
<pre>public java.lang.String getVariant()</pre>
<div class="block">Returns the variant letter, e.g. "b" for USB-FPGA Modules 2.14b.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the variant letter.</dd></dl>
</li>
</ul>
<a name="setName(java.lang.String, int, int, java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setName</h4>
<pre>public void setName(java.lang.String kind,
int series,
int number,
java.lang.String variant)</pre>
<div class="block">Sets the name of the FPGA Board.
Example: <pre>setName("ZTEX USB-FPGA Module", 2, 16, "b"); // denotes "ZTEX USB-FPGA Module 2.16b"</pre>
This setting is not transferred to the FPGA Board because is should not be altered by the user.</div>
<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>
</li>
</ul>
<a name="getFpga()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFpga</h4>
<pre>public java.lang.String getFpga()</pre>
<div class="block">Returns FPGA information.
Notation of the result is <name>-<package>-<speed grade and temperature range>, e.g. XC7A200T-FBG484-2C.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>FPGA Information.</dd></dl>
</li>
</ul>
<a name="setFpga(java.lang.String, java.lang.String, java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setFpga</h4>
<pre>public void setFpga(java.lang.String name,
java.lang.String pckg,
java.lang.String sg)</pre>
<div class="block">Sets FPGA information.
Example: <pre>setFpga("XC7A200T", "FBG484", "2C"); // denotes Xilinx part number XC7A200T-2FBG484C</pre>
This setting is not transferred to the FPGA Board because is should not be altered by the user.</div>
<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>
</li>
</ul>
<a name="getRamType()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRamType</h4>
<pre>public java.lang.String getRamType()</pre>
<div class="block">Returns RAM type and speed.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>FPGA Information.</dd></dl>
</li>
</ul>
<a name="getRamSize()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRamSize</h4>
<pre>public int getRamSize()</pre>
<div class="block">Returns RAM size in bytes.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>RAM size in bytes.</dd></dl>
</li>
</ul>
<a name="setRam(int, java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setRam</h4>
<pre>public void setRam(int size,
java.lang.String type)</pre>
<div class="block">Sets RAM information.
Example: <pre>setRam(128, "DDR2-800 SDRAM"); // sets RAM info to 128 MB DDR2-800 SDRAM</pre>
This setting is not transferred to the FPGA Board because is should not be altered by the user.</div>
<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>
</li>
</ul>
<a name="getMaxBitstreamSize()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMaxBitstreamSize</h4>
<pre>public int getMaxBitstreamSize()</pre>
<div class="block">Returns maximum size of bitstream in bytes.
This is the amount of flash which should be reserved for the bitstream.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>Maximum size of bitstream in bytes sectors.</dd></dl>
</li>
</ul>
<a name="setMaxBitstreamSize(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMaxBitstreamSize</h4>
<pre>public void setMaxBitstreamSize(int size4k)</pre>
<div class="block">Sets the maximum size of bitstream in 4 KByte sectors.
This setting is not transferred to the FPGA Board because is should not be altered by the user.</div>
<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>
</li>
</ul>
<a name="getBitstreamStart()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBitstreamStart</h4>
<pre>public int getBitstreamStart()</pre>
<div class="block">Returns bitstream start position in bytes.
On devices which boot from flash the first sectors are reserved for the firmware.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>Bitstream start position in bytes.</dd></dl>
</li>
</ul>
<a name="setBitstreamStart(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setBitstreamStart</h4>
<pre>public void setBitstreamStart(int start4k)</pre>
<div class="block">Sets the start position of the bitstream in 4 KByte sectors.
This setting is not transferred to the FPGA Board because is should not be altered by the user.</div>
<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>
</li>
</ul>
<a name="getBitstreamSize()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBitstreamSize</h4>
<pre>public int getBitstreamSize()</pre>
<div class="block">Returns actual size of bitstream in bytes sectors.
0 means that no bitstream is stored. The value is rounded up to a multiples of 4096.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>Actual size of bitstream in byte sectors.</dd></dl>
</li>
</ul>
<a name="setBitstreamSize(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setBitstreamSize</h4>
<pre>public boolean setBitstreamSize(int size)
throws <a href="../ztex/InvalidFirmwareException.html" title="class in ztex">InvalidFirmwareException</a>,
<a href="../ztex/UsbException.html" title="class in ztex">UsbException</a>,
<a href="../ztex/CapabilityException.html" title="class in ztex">CapabilityException</a></pre>
<div class="block">Sets the actual size of bitstream in bytes. The value is rounded up to a multiple of 4096.
If a device is connected, this setting is transferred to the FPGA Board.
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>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>size</code> - Actual size of bitstream in bytes.</dd>
<dt><span class="strong">Returns:</span></dt><dd>True if a device is connected and setting was send.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../ztex/InvalidFirmwareException.html" title="class in ztex">InvalidFirmwareException</a></code> - If interface 1 is not supported.</dd>
<dd><code><a href="../ztex/UsbException.html" title="class in ztex">UsbException</a></code> - If a communication error occurs.</dd>
<dd><code><a href="../ztex/CapabilityException.html" title="class in ztex">CapabilityException</a></code> - If no MAC-EEPROM support is present.</dd></dl>
</li>
</ul>
<a name="setSN(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSN</h4>
<pre>public boolean setSN(java.lang.String sn)
throws <a href="../ztex/InvalidFirmwareException.html" title="class in ztex">InvalidFirmwareException</a>,
<a href="../ztex/UsbException.html" title="class in ztex">UsbException</a>,
<a href="../ztex/CapabilityException.html" title="class in ztex">CapabilityException</a></pre>
<div class="block">Sets the serial number.
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.
If it is equal to "0000000000" (default) it is replaced by the unique MAC address. <p>
This setting is transferred to the FPGA Board.
Change takes effect after the next restart of the firmware.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>sn</code> - Serial number string. Only the first 10 characters are considered.</dd>
<dt><span class="strong">Returns:</span></dt><dd>True if a device is connected and setting was send.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../ztex/InvalidFirmwareException.html" title="class in ztex">InvalidFirmwareException</a></code> - If interface 1 is not supported.</dd>
<dd><code><a href="../ztex/UsbException.html" title="class in ztex">UsbException</a></code> - If a communication error occurs.</dd>
<dd><code><a href="../ztex/CapabilityException.html" title="class in ztex">CapabilityException</a></code> - If no MAC-EEPROM support is present.</dd></dl>
</li>
</ul>
<a name="setUsbIDs(int, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setUsbIDs</h4>
<pre>public boolean setUsbIDs(int vid,
int pid)
throws <a href="../ztex/InvalidFirmwareException.html" title="class in ztex">InvalidFirmwareException</a>,
<a href="../ztex/UsbException.html" title="class in ztex">UsbException</a>,
<a href="../ztex/CapabilityException.html" title="class in ztex">CapabilityException</a></pre>
<div class="block">Set the USB vendor vendor and product ID.
If vendor ID is 0 the default values from the firmware are used.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>vid</code> - USB vendor ID.</dd><dd><code>pid</code> - USB product ID.
<p> This settings are transferred to the FPGA Board.
Change takes effect after the next restart of the firmware.</dd>
<dt><span class="strong">Returns:</span></dt><dd>True if a device is connected and setting was send.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../ztex/InvalidFirmwareException.html" title="class in ztex">InvalidFirmwareException</a></code> - If interface 1 is not supported.</dd>
<dd><code><a href="../ztex/UsbException.html" title="class in ztex">UsbException</a></code> - If a communication error occurs.</dd>
<dd><code><a href="../ztex/CapabilityException.html" title="class in ztex">CapabilityException</a></code> - If no MAC-EEPROM support is present.</dd></dl>
</li>
</ul>
<a name="setProductString(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setProductString</h4>
<pre>public boolean setProductString(java.lang.String ps)
throws <a href="../ztex/InvalidFirmwareException.html" title="class in ztex">InvalidFirmwareException</a>,
<a href="../ztex/UsbException.html" title="class in ztex">UsbException</a>,
<a href="../ztex/CapabilityException.html" title="class in ztex">CapabilityException</a></pre>
<div class="block">Sets the product string.
If string is empty the firmware default is used.
<p> This setting is transferred to the FPGA Board.
Change takes effect after the next restart of the firmware.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>ps</code> - The product string.</dd>
<dt><span class="strong">Returns:</span></dt><dd>True if a device is connected and setting was send.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../ztex/InvalidFirmwareException.html" title="class in ztex">InvalidFirmwareException</a></code> - If interface 1 is not supported.</dd>
<dd><code><a href="../ztex/UsbException.html" title="class in ztex">UsbException</a></code> - If a communication error occurs.</dd>
<dd><code><a href="../ztex/CapabilityException.html" title="class in ztex">CapabilityException</a></code> - If no MAC-EEPROM support is present.</dd></dl>
</li>
</ul>
<a name="getUserData(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getUserData</h4>
<pre>public byte getUserData(int i)</pre>
<div class="block">Returns user data at index i.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>i</code> - the index. Valid values are 0 to 47.</dd>
<dt><span class="strong">Returns:</span></dt><dd>User data.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IndexOutOfBoundsException</code> - If i is smaller than 0 or greater than 47.</dd></dl>
</li>
</ul>
<a name="setUserData(int, byte)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setUserData</h4>
<pre>public void setUserData(int i,
byte v)
throws java.lang.IndexOutOfBoundsException</pre>
<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>
to transfer the data to the FPGA Board.</div>
<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>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IndexOutOfBoundsException</code> - If i is smaller than 0 or greater than 47.</dd></dl>
</li>
</ul>
<a name="sendtUserData()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>sendtUserData</h4>
<pre>public boolean sendtUserData()
throws <a href="../ztex/InvalidFirmwareException.html" title="class in ztex">InvalidFirmwareException</a>,
<a href="../ztex/UsbException.html" title="class in ztex">UsbException</a>,
<a href="../ztex/CapabilityException.html" title="class in ztex">CapabilityException</a></pre>
<div class="block">Sends the user data to the FPGA Board.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>True if a device is connected and data could be send.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../ztex/InvalidFirmwareException.html" title="class in ztex">InvalidFirmwareException</a></code> - If interface 1 is not supported.</dd>
<dd><code><a href="../ztex/UsbException.html" title="class in ztex">UsbException</a></code> - If a communication error occurs.</dd>
<dd><code><a href="../ztex/CapabilityException.html" title="class in ztex">CapabilityException</a></code> - If no MAC-EEPROM support is present.</dd></dl>
</li>
</ul>
<a name="defaultBitstreamPath(java.lang.String)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>defaultBitstreamPath</h4>
<pre>public java.lang.String defaultBitstreamPath(java.lang.String name)</pre>
<div class="block">Returns the bitstream path if the same directory sheme as for the examples is used.
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",
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>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - The project name.</dd>
<dt><span class="strong">Returns:</span></dt><dd>Standard bitstream path.</dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../ztex/package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../deprecated-list.html">Deprecated</a></li>
<li><a href="../index-all.html">Index</a></li>
<li><a href="../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../ztex/CapabilityException.html" title="class in ztex"><span class="strong">Prev Class</span></a></li>
<li><a href="../ztex/DeviceLostException.html" title="class in ztex"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../index.html?ztex/ConfigData.html" target="_top">Frames</a></li>
<li><a href="ConfigData.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li><a href="#field_summary">Field</a> | </li>
<li><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li><a href="#field_detail">Field</a> | </li>
<li><a href="#constructor_detail">Constr</a> | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>