URL
https://opencores.org/ocsvn/usb_fpga_2_13/usb_fpga_2_13/trunk
Subversion Repositories usb_fpga_2_13
[/] [usb_fpga_2_13/] [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>
<HEAD>
<!-- Generated by javadoc (build 1.6.0_18) on Wed Oct 30 21:18:13 CET 2013 -->
<TITLE>
ConfigData
</TITLE>
<META NAME="date" CONTENT="2013-10-30">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="ConfigData";
}
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<HR>
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../ztex/CapabilityException.html" title="class in ztex"><B>PREV CLASS</B></A>
<A HREF="../ztex/DeviceLostException.html" title="class in ztex"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../index.html?ztex/ConfigData.html" target="_top"><B>FRAMES</B></A>
<A HREF="ConfigData.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
ztex</FONT>
<BR>
Class ConfigData</H2>
<PRE>
java.lang.Object
<IMG SRC="../resources/inherit.gif" ALT="extended by "><B>ztex.ConfigData</B>
</PRE>
<HR>
<DL>
<DT><PRE>public class <B>ConfigData</B><DT>extends java.lang.Object</DL>
</PRE>
<P>
This class represents the configuration data space of ZTEX FPGA Boards that support it.
The internal format is
<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..79 Reserved
80..127 48 bytes user space
</pre>
<P>
<P>
<HR>
<P>
<!-- =========== FIELD SUMMARY =========== -->
<A NAME="field_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Field Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static java.lang.String[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="../ztex/ConfigData.html#boardNames">boardNames</A></B></CODE>
<BR>
Kinds of FPGA Boards.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static java.lang.String[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="../ztex/ConfigData.html#fpgas">fpgas</A></B></CODE>
<BR>
FPGA's used on ZTEX FPGA Boards.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static java.lang.String[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="../ztex/ConfigData.html#packages">packages</A></B></CODE>
<BR>
FPGA packages used on ZTEX FPGA boards.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static java.lang.String[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="../ztex/ConfigData.html#ramTypes">ramTypes</A></B></CODE>
<BR>
RAM types and speed used on ZTEX FPGA boards.</TD>
</TR>
</TABLE>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<A NAME="constructor_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Constructor Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../ztex/ConfigData.html#ConfigData()">ConfigData</A></B>()</CODE>
<BR>
Constructs an empty instance.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../ztex/ConfigData.html#ConfigData(ztex.Ztex1v1)">ConfigData</A></B>(<A HREF="../ztex/Ztex1v1.html" title="class in ztex">Ztex1v1</A> z)</CODE>
<BR>
Constructs an instance and connects it with z.</TD>
</TR>
</TABLE>
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../ztex/ConfigData.html#connect(ztex.Ztex1v1)">connect</A></B>(<A HREF="../ztex/Ztex1v1.html" title="class in ztex">Ztex1v1</A> z)</CODE>
<BR>
Reads the configuration data (if existent) from a device and connects it to this instance.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> byte[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="../ztex/ConfigData.html#data()">data</A></B>()</CODE>
<BR>
Returns a copy of the configuration data array.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../ztex/ConfigData.html#disconnect()">disconnect</A></B>()</CODE>
<BR>
Disconnects the currently connected device.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../ztex/ConfigData.html#getBitstreamSize()">getBitstreamSize</A></B>()</CODE>
<BR>
Returns actual size of bitstream in bytes sectors.
0 means that no bitstream is stored.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../ztex/ConfigData.html#getFpga()">getFpga</A></B>()</CODE>
<BR>
Returns FPGA information.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../ztex/ConfigData.html#getMaxBitstreamSize()">getMaxBitstreamSize</A></B>()</CODE>
<BR>
Returns maximum size of bitstream in bytes.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../ztex/ConfigData.html#getName()">getName</A></B>()</CODE>
<BR>
Returns the name of the FPGA Board.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../ztex/ConfigData.html#getRamSize()">getRamSize</A></B>()</CODE>
<BR>
Returns RAM size in bytes.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../ztex/ConfigData.html#getRamType()">getRamType</A></B>()</CODE>
<BR>
Returns RAM type and speed.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../ztex/ConfigData.html#getSN()">getSN</A></B>()</CODE>
<BR>
Returns the serial number.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> byte</CODE></FONT></TD>
<TD><CODE><B><A HREF="../ztex/ConfigData.html#getUserData(int)">getUserData</A></B>(int i)</CODE>
<BR>
Returns user data at index i.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../ztex/ConfigData.html#sendtUserData()">sendtUserData</A></B>()</CODE>
<BR>
Sends the user data to the FPGA Board.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../ztex/ConfigData.html#setBitstreamSize(int)">setBitstreamSize</A></B>(int size)</CODE>
<BR>
Sets the actual size of bitstream in bytes.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../ztex/ConfigData.html#setFpga(java.lang.String, java.lang.String, java.lang.String)">setFpga</A></B>(java.lang.String name,
java.lang.String pckg,
java.lang.String sg)</CODE>
<BR>
Sets FPGA information.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../ztex/ConfigData.html#setMaxBitstreamSize(int)">setMaxBitstreamSize</A></B>(int size4k)</CODE>
<BR>
Sets the maximum size of bitstream in 4 KByte sectors.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../ztex/ConfigData.html#setName(java.lang.String, int, int, java.lang.String)">setName</A></B>(java.lang.String kind,
int series,
int number,
java.lang.String variant)</CODE>
<BR>
Sets the name of the FPGA Board.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../ztex/ConfigData.html#setRam(int, java.lang.String)">setRam</A></B>(int size,
java.lang.String type)</CODE>
<BR>
Sets RAM information.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../ztex/ConfigData.html#setSN(java.lang.String)">setSN</A></B>(java.lang.String sn)</CODE>
<BR>
Sets the serial number.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../ztex/ConfigData.html#setUserData(int, byte)">setUserData</A></B>(int i,
byte v)</CODE>
<BR>
Sets user data at index i to value v.</TD>
</TR>
</TABLE>
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
</TR>
</TABLE>
<P>
<!-- ============ FIELD DETAIL =========== -->
<A NAME="field_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Field Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="boardNames"><!-- --></A><H3>
boardNames</H3>
<PRE>
public static final java.lang.String[] <B>boardNames</B></PRE>
<DL>
<DD>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
};</code></pre>
<P>
<DL>
</DL>
</DL>
<HR>
<A NAME="fpgas"><!-- --></A><H3>
fpgas</H3>
<PRE>
public static final java.lang.String[] <B>fpgas</B></PRE>
<DL>
<DD>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
};</code></pre>
<P>
<DL>
</DL>
</DL>
<HR>
<A NAME="packages"><!-- --></A><H3>
packages</H3>
<PRE>
public static final java.lang.String[] <B>packages</B></PRE>
<DL>
<DD>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>
<P>
<DL>
</DL>
</DL>
<HR>
<A NAME="ramTypes"><!-- --></A><H3>
ramTypes</H3>
<PRE>
public static final java.lang.String[] <B>ramTypes</B></PRE>
<DL>
<DD>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>
<P>
<DL>
</DL>
</DL>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<A NAME="constructor_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Constructor Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="ConfigData()"><!-- --></A><H3>
ConfigData</H3>
<PRE>
public <B>ConfigData</B>()</PRE>
<DL>
<DD>Constructs an empty instance.
<P>
</DL>
<HR>
<A NAME="ConfigData(ztex.Ztex1v1)"><!-- --></A><H3>
ConfigData</H3>
<PRE>
public <B>ConfigData</B>(<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>
<DL>
<DD>Constructs an instance and connects it with z. Also see <A HREF="../ztex/ConfigData.html#connect(ztex.Ztex1v1)"><CODE>connect(Ztex1v1)</CODE></A>.
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>z</CODE> - The ztex device to connect with.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../ztex/InvalidFirmwareException.html" title="class in ztex">InvalidFirmwareException</A></CODE> - if interface 1 is not supported.
<DD><CODE><A HREF="../ztex/UsbException.html" title="class in ztex">UsbException</A></CODE> - If a communication error occurs.
<DD><CODE><A HREF="../ztex/CapabilityException.html" title="class in ztex">CapabilityException</A></CODE> - If no MAC-EEPROM support is present.</DL>
</DL>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="connect(ztex.Ztex1v1)"><!-- --></A><H3>
connect</H3>
<PRE>
public boolean <B>connect</B>(<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>
<DL>
<DD>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.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>z</CODE> - The ztex device to connect with.
<DT><B>Returns:</B><DD>True if configuration data could be read.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../ztex/InvalidFirmwareException.html" title="class in ztex">InvalidFirmwareException</A></CODE> - If interface 1 is not supported.
<DD><CODE><A HREF="../ztex/UsbException.html" title="class in ztex">UsbException</A></CODE> - If a communication error occurs.
<DD><CODE><A HREF="../ztex/CapabilityException.html" title="class in ztex">CapabilityException</A></CODE> - If no MAC-EEPROM support is present.</DL>
</DD>
</DL>
<HR>
<A NAME="disconnect()"><!-- --></A><H3>
disconnect</H3>
<PRE>
public boolean <B>disconnect</B>()</PRE>
<DL>
<DD>Disconnects the currently connected device.
After this modified settings are not stored on device anymore.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>True if a device was connected.</DL>
</DD>
</DL>
<HR>
<A NAME="data()"><!-- --></A><H3>
data</H3>
<PRE>
public byte[] <B>data</B>()</PRE>
<DL>
<DD>Returns a copy of the configuration data array.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>A copy of the configuration data array.</DL>
</DD>
</DL>
<HR>
<A NAME="getName()"><!-- --></A><H3>
getName</H3>
<PRE>
public java.lang.String <B>getName</B>()</PRE>
<DL>
<DD>Returns the name of the FPGA Board.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>The name of the FPGA Board.</DL>
</DD>
</DL>
<HR>
<A NAME="setName(java.lang.String, int, int, java.lang.String)"><!-- --></A><H3>
setName</H3>
<PRE>
public void <B>setName</B>(java.lang.String kind,
int series,
int number,
java.lang.String variant)</PRE>
<DL>
<DD>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.
<P>
<DD><DL>
<DT><B>Parameters:</B><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><CODE>series</CODE> - FPGA Board series, e.g. 2<DD><CODE>number</CODE> - FPGA Board number (number behind the dot), e.g. 16<DD><CODE>variant</CODE> - FPGA Board variant (letter), e.g. "b"</DL>
</DD>
</DL>
<HR>
<A NAME="getFpga()"><!-- --></A><H3>
getFpga</H3>
<PRE>
public java.lang.String <B>getFpga</B>()</PRE>
<DL>
<DD>Returns FPGA information.
Notation of the result is <name>-<package>-<speed grade and temperature range>, e.g. XC7A200T-FBG484-2C.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>FPGA Information.</DL>
</DD>
</DL>
<HR>
<A NAME="setFpga(java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
setFpga</H3>
<PRE>
public void <B>setFpga</B>(java.lang.String name,
java.lang.String pckg,
java.lang.String sg)</PRE>
<DL>
<DD>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.
<P>
<DD><DL>
<DT><B>Parameters:</B><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><CODE>pckg</CODE> - FPGA package, see <A HREF="../ztex/ConfigData.html#packages"><CODE>packages</CODE></A> for possible values, e.g. "FBG484"<DD><CODE>sg</CODE> - Speed grade and temperature range, e.g. "2C"</DL>
</DD>
</DL>
<HR>
<A NAME="getRamType()"><!-- --></A><H3>
getRamType</H3>
<PRE>
public java.lang.String <B>getRamType</B>()</PRE>
<DL>
<DD>Returns RAM type and speed.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>FPGA Information.</DL>
</DD>
</DL>
<HR>
<A NAME="getRamSize()"><!-- --></A><H3>
getRamSize</H3>
<PRE>
public int <B>getRamSize</B>()</PRE>
<DL>
<DD>Returns RAM size in bytes.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>RAM size in bytes.</DL>
</DD>
</DL>
<HR>
<A NAME="setRam(int, java.lang.String)"><!-- --></A><H3>
setRam</H3>
<PRE>
public void <B>setRam</B>(int size,
java.lang.String type)</PRE>
<DL>
<DD>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.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>size</CODE> - RAM size in MBytes, e.g. 128<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"</DL>
</DD>
</DL>
<HR>
<A NAME="getMaxBitstreamSize()"><!-- --></A><H3>
getMaxBitstreamSize</H3>
<PRE>
public int <B>getMaxBitstreamSize</B>()</PRE>
<DL>
<DD>Returns maximum size of bitstream in bytes.
This is the amount of flash which should be reserved for the bitstream.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>Maximum size of bitstream in bytes sectors.</DL>
</DD>
</DL>
<HR>
<A NAME="setMaxBitstreamSize(int)"><!-- --></A><H3>
setMaxBitstreamSize</H3>
<PRE>
public void <B>setMaxBitstreamSize</B>(int size4k)</PRE>
<DL>
<DD>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.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>size4k</CODE> - Maximum size of bitstream in 4 KByte sectors. E.g. a value of 256 reserves 1 MByte for the bitstream.</DL>
</DD>
</DL>
<HR>
<A NAME="getBitstreamSize()"><!-- --></A><H3>
getBitstreamSize</H3>
<PRE>
public int <B>getBitstreamSize</B>()</PRE>
<DL>
<DD>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.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>Actual size of bitstream in byte sectors.</DL>
</DD>
</DL>
<HR>
<A NAME="setBitstreamSize(int)"><!-- --></A><H3>
setBitstreamSize</H3>
<PRE>
public boolean <B>setBitstreamSize</B>(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>
<DL>
<DD>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>).
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>size</CODE> - Actual size of bitstream in bytes.
<DT><B>Returns:</B><DD>True if a device is connected and setting was send.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../ztex/InvalidFirmwareException.html" title="class in ztex">InvalidFirmwareException</A></CODE> - If interface 1 is not supported.
<DD><CODE><A HREF="../ztex/UsbException.html" title="class in ztex">UsbException</A></CODE> - If a communication error occurs.
<DD><CODE><A HREF="../ztex/CapabilityException.html" title="class in ztex">CapabilityException</A></CODE> - If no MAC-EEPROM support is present.</DL>
</DD>
</DL>
<HR>
<A NAME="getSN()"><!-- --></A><H3>
getSN</H3>
<PRE>
public java.lang.String <B>getSN</B>()</PRE>
<DL>
<DD>Returns the serial number. This is not necessarily the serial number
returned by the FPGA board according to the USB specification, see <A HREF="../ztex/ConfigData.html#setSN(java.lang.String)"><CODE>setSN(String)</CODE></A>
<P>
<DD><DL>
<DT><B>Returns:</B><DD>Serial number as stored in the configuration data space.</DL>
</DD>
</DL>
<HR>
<A NAME="setSN(java.lang.String)"><!-- --></A><H3>
setSN</H3>
<PRE>
public boolean <B>setSN</B>(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>
<DL>
<DD>Sets the serial number.
During startup 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.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>sn</CODE> - Serial number string. Only the first 10 characters are considered.
<DT><B>Returns:</B><DD>True if a device is connected and setting was send.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../ztex/InvalidFirmwareException.html" title="class in ztex">InvalidFirmwareException</A></CODE> - If interface 1 is not supported.
<DD><CODE><A HREF="../ztex/UsbException.html" title="class in ztex">UsbException</A></CODE> - If a communication error occurs.
<DD><CODE><A HREF="../ztex/CapabilityException.html" title="class in ztex">CapabilityException</A></CODE> - If no MAC-EEPROM support is present.</DL>
</DD>
</DL>
<HR>
<A NAME="getUserData(int)"><!-- --></A><H3>
getUserData</H3>
<PRE>
public byte <B>getUserData</B>(int i)</PRE>
<DL>
<DD>Returns user data at index i.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>i</CODE> - the index. Valid values are 0 to 47.
<DT><B>Returns:</B><DD>User data.
<DT><B>Throws:</B>
<DD><CODE>java.lang.IndexOutOfBoundsException</CODE> - If i is smaller than 0 or greater than 47.</DL>
</DD>
</DL>
<HR>
<A NAME="setUserData(int, byte)"><!-- --></A><H3>
setUserData</H3>
<PRE>
public void <B>setUserData</B>(int i,
byte v)
throws java.lang.IndexOutOfBoundsException</PRE>
<DL>
<DD>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.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>i</CODE> - The index. Valid values are 0 to 47.<DD><CODE>v</CODE> - The value.
<DT><B>Throws:</B>
<DD><CODE>java.lang.IndexOutOfBoundsException</CODE> - If i is smaller than 0 or greater than 47.</DL>
</DD>
</DL>
<HR>
<A NAME="sendtUserData()"><!-- --></A><H3>
sendtUserData</H3>
<PRE>
public boolean <B>sendtUserData</B>()
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>
<DL>
<DD>Sends the user data to the FPGA Board.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>True if a device is connected and data could be send.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../ztex/InvalidFirmwareException.html" title="class in ztex">InvalidFirmwareException</A></CODE> - If interface 1 is not supported.
<DD><CODE><A HREF="../ztex/UsbException.html" title="class in ztex">UsbException</A></CODE> - If a communication error occurs.
<DD><CODE><A HREF="../ztex/CapabilityException.html" title="class in ztex">CapabilityException</A></CODE> - If no MAC-EEPROM support is present.</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../ztex/CapabilityException.html" title="class in ztex"><B>PREV CLASS</B></A>
<A HREF="../ztex/DeviceLostException.html" title="class in ztex"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../index.html?ztex/ConfigData.html" target="_top"><B>FRAMES</B></A>
<A HREF="ConfigData.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
</BODY>
</HTML>