URL
https://opencores.org/ocsvn/usb_fpga_1_11/usb_fpga_1_11/trunk
Subversion Repositories usb_fpga_1_11
Compare Revisions
- This comparison shows the changes necessary to convert path
/usb_fpga_1_11/trunk/docs/java/ztex
- from Rev 2 to Rev 3
- ↔ Reverse comparison
Rev 2 → Rev 3
/BitstreamUploadException.html
2,12 → 2,12
<!--NewPage--> |
<HTML> |
<HEAD> |
<!-- Generated by javadoc (build 1.6.0_02) on Fri Jun 11 14:15:44 CEST 2010 --> |
<!-- Generated by javadoc (build 1.6.0_02) on Wed Sep 29 21:04:05 CEST 2010 --> |
<TITLE> |
BitstreamUploadException |
</TITLE> |
|
<META NAME="date" CONTENT="2010-06-11"> |
<META NAME="date" CONTENT="2010-09-29"> |
|
<LINK REL ="stylesheet" TYPE="text/css" HREF="../stylesheet.css" TITLE="Style"> |
|
/DeviceLostException.html
2,12 → 2,12
<!--NewPage--> |
<HTML> |
<HEAD> |
<!-- Generated by javadoc (build 1.6.0_02) on Fri Jun 11 14:15:44 CEST 2010 --> |
<!-- Generated by javadoc (build 1.6.0_02) on Wed Sep 29 21:04:05 CEST 2010 --> |
<TITLE> |
DeviceLostException |
</TITLE> |
|
<META NAME="date" CONTENT="2010-06-11"> |
<META NAME="date" CONTENT="2010-09-29"> |
|
<LINK REL ="stylesheet" TYPE="text/css" HREF="../stylesheet.css" TITLE="Style"> |
|
/IncompatibleFirmwareException.html
2,12 → 2,12
<!--NewPage--> |
<HTML> |
<HEAD> |
<!-- Generated by javadoc (build 1.6.0_02) on Fri Jun 11 14:15:44 CEST 2010 --> |
<!-- Generated by javadoc (build 1.6.0_02) on Wed Sep 29 21:04:05 CEST 2010 --> |
<TITLE> |
IncompatibleFirmwareException |
</TITLE> |
|
<META NAME="date" CONTENT="2010-06-11"> |
<META NAME="date" CONTENT="2010-09-29"> |
|
<LINK REL ="stylesheet" TYPE="text/css" HREF="../stylesheet.css" TITLE="Style"> |
|
/Ztex1v1.html
2,12 → 2,12
<!--NewPage--> |
<HTML> |
<HEAD> |
<!-- Generated by javadoc (build 1.6.0_02) on Fri Jun 11 14:15:44 CEST 2010 --> |
<!-- Generated by javadoc (build 1.6.0_02) on Wed Sep 29 21:04:05 CEST 2010 --> |
<TITLE> |
Ztex1v1 |
</TITLE> |
|
<META NAME="date" CONTENT="2010-06-11"> |
<META NAME="date" CONTENT="2010-09-29"> |
|
<LINK REL ="stylesheet" TYPE="text/css" HREF="../stylesheet.css" TITLE="Style"> |
|
249,6 → 249,45
</table> |
</td> |
</tr> |
<tr> |
<td bgcolor="#ffffff" valign="top">0.3</td> |
<td bgcolor="#ffffff" valign="top" colspan=2> |
Debug helper support<p> |
<table bgcolor="#404040" cellspacing=1 cellpadding=6> |
<tr> |
<td bgcolor="#d0d0d0" valign="bottom"><b>Vendor request (VR)<br> or command (VC)</b></td> |
<td bgcolor="#d0d0d0" valign="bottom"><b>Description</b></td> |
</tr> |
<tr> |
<td bgcolor="#ffffff" valign="top">VR 0x28</td> |
<td bgcolor="#ffffff" valign="top">Get debug data. Returns: |
<table bgcolor="#404040" cellspacing=1 cellpadding=4> |
<tr> |
<td bgcolor="#d0d0d0" valign="bottom"><b>Bytes</b></td> |
<td bgcolor="#d0d0d0" valign="bottom"><b>Description</b></td> |
</tr> |
<tr> |
<td bgcolor="#ffffff" valign="top">0-1</td> |
<td bgcolor="#ffffff" valign="top">Number of the last message</td> |
</tr> |
<tr> |
<td bgcolor="#ffffff" valign="top">2</td> |
<td bgcolor="#ffffff" valign="top">Stack size in messages</td> |
</tr> |
<tr> |
<td bgcolor="#ffffff" valign="top">3</td> |
<td bgcolor="#ffffff" valign="top">Message size in bytes</td> |
</tr> |
<tr> |
<td bgcolor="#ffffff" valign="top">≥4</td> |
<td bgcolor="#ffffff" valign="top">Message stack</td> |
</tr> |
</table> |
</td> |
</tr> |
</table> |
</td> |
</tr> |
</table> |
<P> |
|
269,6 → 308,46
</TR> |
<TR BGCOLOR="white" CLASS="TableRowColor"> |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
<CODE>static int</CODE></FONT></TD> |
<TD><CODE><B><A HREF="../ztex/Ztex1v1.html#CAPABILITY_DEBUG">CAPABILITY_DEBUG</A></B></CODE> |
|
<BR> |
Capability index for DEBUG helper support.</TD> |
</TR> |
<TR BGCOLOR="white" CLASS="TableRowColor"> |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
<CODE>static int</CODE></FONT></TD> |
<TD><CODE><B><A HREF="../ztex/Ztex1v1.html#CAPABILITY_EEPROM">CAPABILITY_EEPROM</A></B></CODE> |
|
<BR> |
Capability index for EEPROM support.</TD> |
</TR> |
<TR BGCOLOR="white" CLASS="TableRowColor"> |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
<CODE>static int</CODE></FONT></TD> |
<TD><CODE><B><A HREF="../ztex/Ztex1v1.html#CAPABILITY_FLASH">CAPABILITY_FLASH</A></B></CODE> |
|
<BR> |
Capability index for FLASH memory support.</TD> |
</TR> |
<TR BGCOLOR="white" CLASS="TableRowColor"> |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
<CODE>static int</CODE></FONT></TD> |
<TD><CODE><B><A HREF="../ztex/Ztex1v1.html#CAPABILITY_FPGA">CAPABILITY_FPGA</A></B></CODE> |
|
<BR> |
Capability index for FPGA configuration support.</TD> |
</TR> |
<TR BGCOLOR="white" CLASS="TableRowColor"> |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
<CODE>static int</CODE></FONT></TD> |
<TD><CODE><B><A HREF="../ztex/Ztex1v1.html#CAPABILITY_XMEGA">CAPABILITY_XMEGA</A></B></CODE> |
|
<BR> |
Capability index for AVR XMEGA support.</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/Ztex1v1.html#capabilityStrings">capabilityStrings</A></B></CODE> |
|
278,6 → 357,14
<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/Ztex1v1.html#debugNewMessages">debugNewMessages</A></B></CODE> |
|
<BR> |
Is set by <A HREF="../ztex/Ztex1v1.html#debugReadMessages(boolean, byte[])"><CODE>debugReadMessages(boolean,byte[])</CODE></A> and conains the number of new messages.</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/Ztex1v1.html#eepromBytes">eepromBytes</A></B></CODE> |
|
<BR> |
318,6 → 405,14
<TR BGCOLOR="white" CLASS="TableRowColor"> |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
<CODE>static int</CODE></FONT></TD> |
<TD><CODE><B><A HREF="../ztex/Ztex1v1.html#FLASH_EC_NOTSUPPORTED">FLASH_EC_NOTSUPPORTED</A></B></CODE> |
|
<BR> |
Signals the the installed Flash memeory is not supported.</TD> |
</TR> |
<TR BGCOLOR="white" CLASS="TableRowColor"> |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
<CODE>static int</CODE></FONT></TD> |
<TD><CODE><B><A HREF="../ztex/Ztex1v1.html#FLASH_EC_PENDING">FLASH_EC_PENDING</A></B></CODE> |
|
<BR> |
401,6 → 496,14
<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/Ztex1v1.html#checkCapability(int)">checkCapability</A></B>(int i)</CODE> |
|
<BR> |
Checks whether ZTEX descriptor 1 is available and interface 1 and a given capability are supported.</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/Ztex1v1.html#checkCapability(int, int)">checkCapability</A></B>(int i, |
int j)</CODE> |
|
448,6 → 551,49
</TR> |
<TR BGCOLOR="white" CLASS="TableRowColor"> |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
<CODE> long</CODE></FONT></TD> |
<TD><CODE><B><A HREF="../ztex/Ztex1v1.html#configureFpga(java.lang.String, boolean, int)">configureFpga</A></B>(java.lang.String fwFileName, |
boolean force, |
int bs)</CODE> |
|
<BR> |
Upload a Bitstream to the FPGA.</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/Ztex1v1.html#debugLastMsg()">debugLastMsg</A></B>()</CODE> |
|
<BR> |
Returns the number of the last message read out by <A HREF="../ztex/Ztex1v1.html#debugReadMessages(boolean, byte[])"><CODE>debugReadMessages(boolean,byte[])</CODE></A></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/Ztex1v1.html#debugMsgSize()">debugMsgSize</A></B>()</CODE> |
|
<BR> |
Returns the size of messages in bytes.</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/Ztex1v1.html#debugReadMessages(boolean, byte[])">debugReadMessages</A></B>(boolean all, |
byte[] buf)</CODE> |
|
<BR> |
Reads debug messages from message stack.</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/Ztex1v1.html#debugStackSize()">debugStackSize</A></B>()</CODE> |
|
<BR> |
Returns the size of message stack in messages.</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/Ztex1v1.html#eepromDisable()">eepromDisable</A></B>()</CODE> |
|
582,6 → 728,15
</TR> |
<TR BGCOLOR="white" CLASS="TableRowColor"> |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
<CODE> long</CODE></FONT></TD> |
<TD><CODE><B><A HREF="../ztex/Ztex1v1.html#flashUploadBitstream(java.lang.String, int)">flashUploadBitstream</A></B>(java.lang.String fwFileName, |
int bs)</CODE> |
|
<BR> |
Uploads a Bitstream to the Flash.</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/Ztex1v1.html#flashWriteSector(int, byte[])">flashWriteSector</A></B>(int sector, |
byte[] buf)</CODE> |
694,6 → 849,66
</TR> |
</TABLE> |
|
<A NAME="CAPABILITY_EEPROM"><!-- --></A><H3> |
CAPABILITY_EEPROM</H3> |
<PRE> |
public static final int <B>CAPABILITY_EEPROM</B></PRE> |
<DL> |
<DD>Capability index for EEPROM support. |
<P> |
<DL> |
<DT><B>See Also:</B><DD><A HREF="../constant-values.html#ztex.Ztex1v1.CAPABILITY_EEPROM">Constant Field Values</A></DL> |
</DL> |
<HR> |
|
<A NAME="CAPABILITY_FPGA"><!-- --></A><H3> |
CAPABILITY_FPGA</H3> |
<PRE> |
public static final int <B>CAPABILITY_FPGA</B></PRE> |
<DL> |
<DD>Capability index for FPGA configuration support. |
<P> |
<DL> |
<DT><B>See Also:</B><DD><A HREF="../constant-values.html#ztex.Ztex1v1.CAPABILITY_FPGA">Constant Field Values</A></DL> |
</DL> |
<HR> |
|
<A NAME="CAPABILITY_FLASH"><!-- --></A><H3> |
CAPABILITY_FLASH</H3> |
<PRE> |
public static final int <B>CAPABILITY_FLASH</B></PRE> |
<DL> |
<DD>Capability index for FLASH memory support. |
<P> |
<DL> |
<DT><B>See Also:</B><DD><A HREF="../constant-values.html#ztex.Ztex1v1.CAPABILITY_FLASH">Constant Field Values</A></DL> |
</DL> |
<HR> |
|
<A NAME="CAPABILITY_DEBUG"><!-- --></A><H3> |
CAPABILITY_DEBUG</H3> |
<PRE> |
public static final int <B>CAPABILITY_DEBUG</B></PRE> |
<DL> |
<DD>Capability index for DEBUG helper support. |
<P> |
<DL> |
<DT><B>See Also:</B><DD><A HREF="../constant-values.html#ztex.Ztex1v1.CAPABILITY_DEBUG">Constant Field Values</A></DL> |
</DL> |
<HR> |
|
<A NAME="CAPABILITY_XMEGA"><!-- --></A><H3> |
CAPABILITY_XMEGA</H3> |
<PRE> |
public static final int <B>CAPABILITY_XMEGA</B></PRE> |
<DL> |
<DD>Capability index for AVR XMEGA support. |
<P> |
<DL> |
<DT><B>See Also:</B><DD><A HREF="../constant-values.html#ztex.Ztex1v1.CAPABILITY_XMEGA">Constant Field Values</A></DL> |
</DL> |
<HR> |
|
<A NAME="capabilityStrings"><!-- --></A><H3> |
capabilityStrings</H3> |
<PRE> |
824,7 → 1039,31
<DL> |
<DT><B>See Also:</B><DD><A HREF="../constant-values.html#ztex.Ztex1v1.FLASH_EC_WRITE_ERROR">Constant Field Values</A></DL> |
</DL> |
<HR> |
|
<A NAME="FLASH_EC_NOTSUPPORTED"><!-- --></A><H3> |
FLASH_EC_NOTSUPPORTED</H3> |
<PRE> |
public static final int <B>FLASH_EC_NOTSUPPORTED</B></PRE> |
<DL> |
<DD>Signals the the installed Flash memeory is not supported. |
<P> |
<DL> |
<DT><B>See Also:</B><DD><A HREF="../constant-values.html#ztex.Ztex1v1.FLASH_EC_NOTSUPPORTED">Constant Field Values</A></DL> |
</DL> |
<HR> |
|
<A NAME="debugNewMessages"><!-- --></A><H3> |
debugNewMessages</H3> |
<PRE> |
public int <B>debugNewMessages</B></PRE> |
<DL> |
<DD>Is set by <A HREF="../ztex/Ztex1v1.html#debugReadMessages(boolean, byte[])"><CODE>debugReadMessages(boolean,byte[])</CODE></A> and conains the number of new messages. |
<P> |
<DL> |
</DL> |
</DL> |
|
<!-- ========= CONSTRUCTOR DETAIL ======== --> |
|
<A NAME="constructor_detail"><!-- --></A> |
951,6 → 1190,24
</DL> |
<HR> |
|
<A NAME="checkCapability(int)"><!-- --></A><H3> |
checkCapability</H3> |
<PRE> |
public void <B>checkCapability</B>(int i) |
throws <A HREF="../ztex/InvalidFirmwareException.html" title="class in ztex">InvalidFirmwareException</A>, |
<A HREF="../ztex/CapabilityException.html" title="class in ztex">CapabilityException</A></PRE> |
<DL> |
<DD>Checks whether ZTEX descriptor 1 is available and interface 1 and a given capability are supported. |
<P> |
<DD><DL> |
<DT><B>Parameters:</B><DD><CODE>i</CODE> - capability index (0..47) |
<DT><B>Throws:</B> |
<DD><CODE><A HREF="../ztex/InvalidFirmwareException.html" title="class in ztex">InvalidFirmwareException</A></CODE> - if ZTEX descriptor 1 is not available or interface 1 is not supported. |
<DD><CODE><A HREF="../ztex/CapabilityException.html" title="class in ztex">CapabilityException</A></CODE> - if the given capability is not supported.</DL> |
</DD> |
</DL> |
<HR> |
|
<A NAME="checkCompatible(int, int, int, int)"><!-- --></A><H3> |
checkCompatible</H3> |
<PRE> |
1053,6 → 1310,34
</DL> |
<HR> |
|
<A NAME="configureFpga(java.lang.String, boolean, int)"><!-- --></A><H3> |
configureFpga</H3> |
<PRE> |
public long <B>configureFpga</B>(java.lang.String fwFileName, |
boolean force, |
int bs) |
throws <A HREF="../ztex/BitstreamReadException.html" title="class in ztex">BitstreamReadException</A>, |
<A HREF="../ztex/UsbException.html" title="class in ztex">UsbException</A>, |
<A HREF="../ztex/BitstreamUploadException.html" title="class in ztex">BitstreamUploadException</A>, |
<A HREF="../ztex/AlreadyConfiguredException.html" title="class in ztex">AlreadyConfiguredException</A>, |
<A HREF="../ztex/InvalidFirmwareException.html" title="class in ztex">InvalidFirmwareException</A>, |
<A HREF="../ztex/CapabilityException.html" title="class in ztex">CapabilityException</A></PRE> |
<DL> |
<DD>Upload a Bitstream to the FPGA. |
<P> |
<DD><DL> |
<DT><B>Parameters:</B><DD><CODE>fwFileName</CODE> - The file name of the Bitstream. The file can be a regular file or a system resource (e.g. a file from the current jar archive).<DD><CODE>force</CODE> - If set to true existing configurations will be overwritten. (By default an <A HREF="../ztex/AlreadyConfiguredException.html" title="class in ztex"><CODE>AlreadyConfiguredException</CODE></A> is thrown).<DD><CODE>bs</CODE> - 0: disable bit swapping, 1: enable bit swapping, all other values: automatic detection of bit order. |
<DT><B>Throws:</B> |
<DD><CODE><A HREF="../ztex/BitstreamReadException.html" title="class in ztex">BitstreamReadException</A></CODE> - if an error occurred while attempting to read the Bitstream. |
<DD><CODE><A HREF="../ztex/BitstreamUploadException.html" title="class in ztex">BitstreamUploadException</A></CODE> - if an error occurred while attempting to upload the Bitstream. |
<DD><CODE><A HREF="../ztex/AlreadyConfiguredException.html" title="class in ztex">AlreadyConfiguredException</A></CODE> - if the FPGA is already configured. |
<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 FPGA configuration is not supported by the firmware.</DL> |
</DD> |
</DL> |
<HR> |
|
<A NAME="configureFpga(java.lang.String, boolean)"><!-- --></A><H3> |
configureFpga</H3> |
<PRE> |
1253,6 → 1538,7
<P> |
<DD><DL> |
|
<DT><B>Returns:</B><DD>The last error code. |
<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. |
1411,10 → 1697,11
</DL> |
<HR> |
|
<A NAME="flashUploadBitstream(java.lang.String)"><!-- --></A><H3> |
<A NAME="flashUploadBitstream(java.lang.String, int)"><!-- --></A><H3> |
flashUploadBitstream</H3> |
<PRE> |
public long <B>flashUploadBitstream</B>(java.lang.String fwFileName) |
public long <B>flashUploadBitstream</B>(java.lang.String fwFileName, |
int bs) |
throws <A HREF="../ztex/BitstreamReadException.html" title="class in ztex">BitstreamReadException</A>, |
<A HREF="../ztex/UsbException.html" title="class in ztex">UsbException</A>, |
<A HREF="../ztex/InvalidFirmwareException.html" title="class in ztex">InvalidFirmwareException</A>, |
1455,6 → 1742,31
The first sector of the Bitstream is sector 1. |
<P> |
<DD><DL> |
<DT><B>Parameters:</B><DD><CODE>fwFileName</CODE> - The file name of the Bitstream. The file can be a regular file or a system resource (e.g. a file from the current jar archive).<DD><CODE>bs</CODE> - 0: disable bit swapping, 1: enable bit swapping, all other values: automatic detection of bit order. |
<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 Flash memory access is not possible. |
<DD><CODE><A HREF="../ztex/BitstreamReadException.html" title="class in ztex">BitstreamReadException</A></CODE> - if an error occurred while attempting to read the Bitstream.</DL> |
</DD> |
</DL> |
<HR> |
|
<A NAME="flashUploadBitstream(java.lang.String)"><!-- --></A><H3> |
flashUploadBitstream</H3> |
<PRE> |
public long <B>flashUploadBitstream</B>(java.lang.String fwFileName) |
throws <A HREF="../ztex/BitstreamReadException.html" title="class in ztex">BitstreamReadException</A>, |
<A HREF="../ztex/UsbException.html" title="class in ztex">UsbException</A>, |
<A HREF="../ztex/InvalidFirmwareException.html" title="class in ztex">InvalidFirmwareException</A>, |
<A HREF="../ztex/CapabilityException.html" title="class in ztex">CapabilityException</A></PRE> |
<DL> |
<DD>Uploads a Bitstream to the Flash. |
This allows the firmware to load the Bitstream from Flash. Together with installation of the firmware in EEPROM |
it is possible to construct fully autonomous devices. |
See <A HREF="../ztex/Ztex1v1.html#flashUploadBitstream(java.lang.String, int)"><CODE>flashUploadBitstream(String,int)</CODE></A> for further details. |
<P> |
<DD><DL> |
<DT><B>Parameters:</B><DD><CODE>fwFileName</CODE> - The file name of the Bitstream. The file can be a regular file or a system resource (e.g. a file from the current jar archive). |
<DT><B>Throws:</B> |
<DD><CODE><A HREF="../ztex/InvalidFirmwareException.html" title="class in ztex">InvalidFirmwareException</A></CODE> - if interface 1 is not supported. |
1509,6 → 1821,86
</DL> |
<HR> |
|
<A NAME="debugStackSize()"><!-- --></A><H3> |
debugStackSize</H3> |
<PRE> |
public int <B>debugStackSize</B>() |
throws <A HREF="../ztex/UsbException.html" title="class in ztex">UsbException</A>, |
<A HREF="../ztex/InvalidFirmwareException.html" title="class in ztex">InvalidFirmwareException</A>, |
<A HREF="../ztex/CapabilityException.html" title="class in ztex">CapabilityException</A></PRE> |
<DL> |
<DD>Returns the size of message stack in messages. |
<P> |
<DD><DL> |
|
<DT><B>Returns:</B><DD>the size of message stack in messages. |
<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 Flash memory access is not possible.</DL> |
</DD> |
</DL> |
<HR> |
|
<A NAME="debugMsgSize()"><!-- --></A><H3> |
debugMsgSize</H3> |
<PRE> |
public int <B>debugMsgSize</B>() |
throws <A HREF="../ztex/UsbException.html" title="class in ztex">UsbException</A>, |
<A HREF="../ztex/InvalidFirmwareException.html" title="class in ztex">InvalidFirmwareException</A>, |
<A HREF="../ztex/CapabilityException.html" title="class in ztex">CapabilityException</A></PRE> |
<DL> |
<DD>Returns the size of messages in bytes. |
<P> |
<DD><DL> |
|
<DT><B>Returns:</B><DD>the size of messages in bytes. |
<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 Flash memory access is not possible.</DL> |
</DD> |
</DL> |
<HR> |
|
<A NAME="debugLastMsg()"><!-- --></A><H3> |
debugLastMsg</H3> |
<PRE> |
public final int <B>debugLastMsg</B>()</PRE> |
<DL> |
<DD>Returns the number of the last message read out by <A HREF="../ztex/Ztex1v1.html#debugReadMessages(boolean, byte[])"><CODE>debugReadMessages(boolean,byte[])</CODE></A> |
<P> |
<DD><DL> |
|
<DT><B>Returns:</B><DD>the number of the last message read out by <A HREF="../ztex/Ztex1v1.html#debugReadMessages(boolean, byte[])"><CODE>debugReadMessages(boolean,byte[])</CODE></A></DL> |
</DD> |
</DL> |
<HR> |
|
<A NAME="debugReadMessages(boolean, byte[])"><!-- --></A><H3> |
debugReadMessages</H3> |
<PRE> |
public int <B>debugReadMessages</B>(boolean all, |
byte[] buf) |
throws <A HREF="../ztex/UsbException.html" title="class in ztex">UsbException</A>, |
<A HREF="../ztex/InvalidFirmwareException.html" title="class in ztex">InvalidFirmwareException</A>, |
<A HREF="../ztex/CapabilityException.html" title="class in ztex">CapabilityException</A></PRE> |
<DL> |
<DD>Reads debug messages from message stack. |
The number of messages stored in buf is returned. The total number of new messages is stored in <A HREF="../ztex/Ztex1v1.html#debugNewMessages"><CODE>debugNewMessages</CODE></A>. |
The number of the latest message is returned by <A HREF="../ztex/Ztex1v1.html#debugLastMsg()"><CODE>debugLastMsg()</CODE></A>. |
<P> |
<DD><DL> |
<DT><B>Parameters:</B><DD><CODE>all</CODE> - If true, all messages from stack are written to buf. If it is false, only the new messages are written to buf.<DD><CODE>buf</CODE> - The buffer to store the messages. |
<DT><B>Returns:</B><DD>the size of messages stored in buffer. |
<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 Flash memory access is not possible.</DL> |
</DD> |
</DL> |
<HR> |
|
<A NAME="toString()"><!-- --></A><H3> |
toString</H3> |
<PRE> |
/package-frame.html
2,12 → 2,12
<!--NewPage--> |
<HTML> |
<HEAD> |
<!-- Generated by javadoc (build 1.6.0_02) on Fri Jun 11 14:15:44 CEST 2010 --> |
<!-- Generated by javadoc (build 1.6.0_02) on Wed Sep 29 21:04:05 CEST 2010 --> |
<TITLE> |
ztex |
</TITLE> |
|
<META NAME="date" CONTENT="2010-06-11"> |
<META NAME="date" CONTENT="2010-09-29"> |
|
<LINK REL ="stylesheet" TYPE="text/css" HREF="../stylesheet.css" TITLE="Style"> |
|
/ZtexIhxFile1.html
2,12 → 2,12
<!--NewPage--> |
<HTML> |
<HEAD> |
<!-- Generated by javadoc (build 1.6.0_02) on Fri Jun 11 14:15:44 CEST 2010 --> |
<!-- Generated by javadoc (build 1.6.0_02) on Wed Sep 29 21:04:05 CEST 2010 --> |
<TITLE> |
ZtexIhxFile1 |
</TITLE> |
|
<META NAME="date" CONTENT="2010-06-11"> |
<META NAME="date" CONTENT="2010-09-29"> |
|
<LINK REL ="stylesheet" TYPE="text/css" HREF="../stylesheet.css" TITLE="Style"> |
|
/JInputStream.html
2,12 → 2,12
<!--NewPage--> |
<HTML> |
<HEAD> |
<!-- Generated by javadoc (build 1.6.0_02) on Fri Jun 11 14:15:44 CEST 2010 --> |
<!-- Generated by javadoc (build 1.6.0_02) on Wed Sep 29 21:04:05 CEST 2010 --> |
<TITLE> |
JInputStream |
</TITLE> |
|
<META NAME="date" CONTENT="2010-06-11"> |
<META NAME="date" CONTENT="2010-09-29"> |
|
<LINK REL ="stylesheet" TYPE="text/css" HREF="../stylesheet.css" TITLE="Style"> |
|
/package-summary.html
2,12 → 2,12
<!--NewPage--> |
<HTML> |
<HEAD> |
<!-- Generated by javadoc (build 1.6.0_02) on Fri Jun 11 14:15:44 CEST 2010 --> |
<!-- Generated by javadoc (build 1.6.0_02) on Wed Sep 29 21:04:05 CEST 2010 --> |
<TITLE> |
ztex |
</TITLE> |
|
<META NAME="date" CONTENT="2010-06-11"> |
<META NAME="date" CONTENT="2010-09-29"> |
|
<LINK REL ="stylesheet" TYPE="text/css" HREF="../stylesheet.css" TITLE="Style"> |
|
/package-tree.html
2,12 → 2,12
<!--NewPage--> |
<HTML> |
<HEAD> |
<!-- Generated by javadoc (build 1.6.0_02) on Fri Jun 11 14:15:44 CEST 2010 --> |
<!-- Generated by javadoc (build 1.6.0_02) on Wed Sep 29 21:04:05 CEST 2010 --> |
<TITLE> |
ztex Class Hierarchy |
</TITLE> |
|
<META NAME="date" CONTENT="2010-06-11"> |
<META NAME="date" CONTENT="2010-09-29"> |
|
<LINK REL ="stylesheet" TYPE="text/css" HREF="../stylesheet.css" TITLE="Style"> |
|
/EzUsb.html
2,12 → 2,12
<!--NewPage--> |
<HTML> |
<HEAD> |
<!-- Generated by javadoc (build 1.6.0_02) on Fri Jun 11 14:15:44 CEST 2010 --> |
<!-- Generated by javadoc (build 1.6.0_02) on Wed Sep 29 21:04:05 CEST 2010 --> |
<TITLE> |
EzUsb |
</TITLE> |
|
<META NAME="date" CONTENT="2010-06-11"> |
<META NAME="date" CONTENT="2010-09-29"> |
|
<LINK REL ="stylesheet" TYPE="text/css" HREF="../stylesheet.css" TITLE="Style"> |
|
218,7 → 218,7
<P> |
<DD><DL> |
<DT><B>Parameters:</B><DD><CODE>handle</CODE> - The handle of the device.<DD><CODE>ihxFile</CODE> - The firmware image. |
<DT><B>Returns:</B><DD>The upload time in ms. |
<DT><B>Returns:</B><DD>the upload time in ms. |
<DT><B>Throws:</B> |
<DD><CODE><A HREF="../ztex/FirmwareUploadException.html" title="class in ztex">FirmwareUploadException</A></CODE> - if an error occurred while attempting to upload the firmware.</DL> |
</DD> |
/IhxFile.html
2,12 → 2,12
<!--NewPage--> |
<HTML> |
<HEAD> |
<!-- Generated by javadoc (build 1.6.0_02) on Fri Jun 11 14:15:44 CEST 2010 --> |
<!-- Generated by javadoc (build 1.6.0_02) on Wed Sep 29 21:04:05 CEST 2010 --> |
<TITLE> |
IhxFile |
</TITLE> |
|
<META NAME="date" CONTENT="2010-06-11"> |
<META NAME="date" CONTENT="2010-09-29"> |
|
<LINK REL ="stylesheet" TYPE="text/css" HREF="../stylesheet.css" TITLE="Style"> |
|
/ZtexScanBus1.html
2,12 → 2,12
<!--NewPage--> |
<HTML> |
<HEAD> |
<!-- Generated by javadoc (build 1.6.0_02) on Fri Jun 11 14:15:44 CEST 2010 --> |
<!-- Generated by javadoc (build 1.6.0_02) on Wed Sep 29 21:04:05 CEST 2010 --> |
<TITLE> |
ZtexScanBus1 |
</TITLE> |
|
<META NAME="date" CONTENT="2010-06-11"> |
<META NAME="date" CONTENT="2010-09-29"> |
|
<LINK REL ="stylesheet" TYPE="text/css" HREF="../stylesheet.css" TITLE="Style"> |
|
/ZtexDevice1.html
2,12 → 2,12
<!--NewPage--> |
<HTML> |
<HEAD> |
<!-- Generated by javadoc (build 1.6.0_02) on Fri Jun 11 14:15:44 CEST 2010 --> |
<!-- Generated by javadoc (build 1.6.0_02) on Wed Sep 29 21:04:05 CEST 2010 --> |
<TITLE> |
ZtexDevice1 |
</TITLE> |
|
<META NAME="date" CONTENT="2010-06-11"> |
<META NAME="date" CONTENT="2010-09-29"> |
|
<LINK REL ="stylesheet" TYPE="text/css" HREF="../stylesheet.css" TITLE="Style"> |
|
/CapabilityException.html
2,12 → 2,12
<!--NewPage--> |
<HTML> |
<HEAD> |
<!-- Generated by javadoc (build 1.6.0_02) on Fri Jun 11 14:15:44 CEST 2010 --> |
<!-- Generated by javadoc (build 1.6.0_02) on Wed Sep 29 21:04:05 CEST 2010 --> |
<TITLE> |
CapabilityException |
</TITLE> |
|
<META NAME="date" CONTENT="2010-06-11"> |
<META NAME="date" CONTENT="2010-09-29"> |
|
<LINK REL ="stylesheet" TYPE="text/css" HREF="../stylesheet.css" TITLE="Style"> |
|
/FirmwareUploadException.html
2,12 → 2,12
<!--NewPage--> |
<HTML> |
<HEAD> |
<!-- Generated by javadoc (build 1.6.0_02) on Fri Jun 11 14:15:44 CEST 2010 --> |
<!-- Generated by javadoc (build 1.6.0_02) on Wed Sep 29 21:04:05 CEST 2010 --> |
<TITLE> |
FirmwareUploadException |
</TITLE> |
|
<META NAME="date" CONTENT="2010-06-11"> |
<META NAME="date" CONTENT="2010-09-29"> |
|
<LINK REL ="stylesheet" TYPE="text/css" HREF="../stylesheet.css" TITLE="Style"> |
|
/InvalidFirmwareException.html
2,12 → 2,12
<!--NewPage--> |
<HTML> |
<HEAD> |
<!-- Generated by javadoc (build 1.6.0_02) on Fri Jun 11 14:15:44 CEST 2010 --> |
<!-- Generated by javadoc (build 1.6.0_02) on Wed Sep 29 21:04:05 CEST 2010 --> |
<TITLE> |
InvalidFirmwareException |
</TITLE> |
|
<META NAME="date" CONTENT="2010-06-11"> |
<META NAME="date" CONTENT="2010-09-29"> |
|
<LINK REL ="stylesheet" TYPE="text/css" HREF="../stylesheet.css" TITLE="Style"> |
|
/IhxParseException.html
2,12 → 2,12
<!--NewPage--> |
<HTML> |
<HEAD> |
<!-- Generated by javadoc (build 1.6.0_02) on Fri Jun 11 14:15:44 CEST 2010 --> |
<!-- Generated by javadoc (build 1.6.0_02) on Wed Sep 29 21:04:05 CEST 2010 --> |
<TITLE> |
IhxParseException |
</TITLE> |
|
<META NAME="date" CONTENT="2010-06-11"> |
<META NAME="date" CONTENT="2010-09-29"> |
|
<LINK REL ="stylesheet" TYPE="text/css" HREF="../stylesheet.css" TITLE="Style"> |
|
/BitstreamReadException.html
2,12 → 2,12
<!--NewPage--> |
<HTML> |
<HEAD> |
<!-- Generated by javadoc (build 1.6.0_02) on Fri Jun 11 14:15:44 CEST 2010 --> |
<!-- Generated by javadoc (build 1.6.0_02) on Wed Sep 29 21:04:05 CEST 2010 --> |
<TITLE> |
BitstreamReadException |
</TITLE> |
|
<META NAME="date" CONTENT="2010-06-11"> |
<META NAME="date" CONTENT="2010-09-29"> |
|
<LINK REL ="stylesheet" TYPE="text/css" HREF="../stylesheet.css" TITLE="Style"> |
|
/AlreadyConfiguredException.html
2,12 → 2,12
<!--NewPage--> |
<HTML> |
<HEAD> |
<!-- Generated by javadoc (build 1.6.0_02) on Fri Jun 11 14:15:44 CEST 2010 --> |
<!-- Generated by javadoc (build 1.6.0_02) on Wed Sep 29 21:04:05 CEST 2010 --> |
<TITLE> |
AlreadyConfiguredException |
</TITLE> |
|
<META NAME="date" CONTENT="2010-06-11"> |
<META NAME="date" CONTENT="2010-09-29"> |
|
<LINK REL ="stylesheet" TYPE="text/css" HREF="../stylesheet.css" TITLE="Style"> |
|
/UsbException.html
2,12 → 2,12
<!--NewPage--> |
<HTML> |
<HEAD> |
<!-- Generated by javadoc (build 1.6.0_02) on Fri Jun 11 14:15:44 CEST 2010 --> |
<!-- Generated by javadoc (build 1.6.0_02) on Wed Sep 29 21:04:05 CEST 2010 --> |
<TITLE> |
UsbException |
</TITLE> |
|
<META NAME="date" CONTENT="2010-06-11"> |
<META NAME="date" CONTENT="2010-09-29"> |
|
<LINK REL ="stylesheet" TYPE="text/css" HREF="../stylesheet.css" TITLE="Style"> |
|
/IhxFileDamagedException.html
2,12 → 2,12
<!--NewPage--> |
<HTML> |
<HEAD> |
<!-- Generated by javadoc (build 1.6.0_02) on Fri Jun 11 14:15:44 CEST 2010 --> |
<!-- Generated by javadoc (build 1.6.0_02) on Wed Sep 29 21:04:05 CEST 2010 --> |
<TITLE> |
IhxFileDamagedException |
</TITLE> |
|
<META NAME="date" CONTENT="2010-06-11"> |
<META NAME="date" CONTENT="2010-09-29"> |
|
<LINK REL ="stylesheet" TYPE="text/css" HREF="../stylesheet.css" TITLE="Style"> |
|
/Ztex1.html
2,12 → 2,12
<!--NewPage--> |
<HTML> |
<HEAD> |
<!-- Generated by javadoc (build 1.6.0_02) on Fri Jun 11 14:15:44 CEST 2010 --> |
<!-- Generated by javadoc (build 1.6.0_02) on Wed Sep 29 21:04:05 CEST 2010 --> |
<TITLE> |
Ztex1 |
</TITLE> |
|
<META NAME="date" CONTENT="2010-06-11"> |
<META NAME="date" CONTENT="2010-09-29"> |
|
<LINK REL ="stylesheet" TYPE="text/css" HREF="../stylesheet.css" TITLE="Style"> |
|
765,6 → 765,7
<P> |
<DD><DL> |
<DT><B>Parameters:</B><DD><CODE>ihxFileName</CODE> - The file name of the firmware image in ihx format. The file can be a regular file or a system resource (e.g. a file from the current jar archive).<DD><CODE>force</CODE> - The compatibility check is skipped if true. |
<DT><B>Returns:</B><DD>the upload time in ms. |
<DT><B>Throws:</B> |
<DD><CODE><A HREF="../ztex/IncompatibleFirmwareException.html" title="class in ztex">IncompatibleFirmwareException</A></CODE> - if the given firmware is not compatible to the installed one, see <A HREF="../ztex/ZtexDevice1.html#compatible(int, int, int, int)"><CODE>ZtexDevice1.compatible(int,int,int,int)</CODE></A> (Upload can be enforced using the <tt>force</tt> parameter) |
<DD><CODE><A HREF="../ztex/FirmwareUploadException.html" title="class in ztex">FirmwareUploadException</A></CODE> - If an error occurred while attempting to upload the firmware. |