OpenCores
URL https://opencores.org/ocsvn/usb_fpga_1_2/usb_fpga_1_2/trunk

Subversion Repositories usb_fpga_1_2

[/] [usb_fpga_1_2/] [trunk/] [docs/] [java/] [ztex/] [Ztex1v1.html] - Rev 3

Go to most recent revision | 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_02) on Thu Dec 10 20:53:20 CET 2009 -->
<TITLE>
Ztex1v1
</TITLE>
 
<META NAME="date" CONTENT="2009-12-10">
 
<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="Ztex1v1";
    }
}
</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>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  </TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
 
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../ztex/Ztex1.html" title="class in ztex"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../ztex/ZtexDevice1.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/Ztex1v1.html" target="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="Ztex1v1.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
&nbsp;<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:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<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 Ztex1v1</H2>
<PRE>
java.lang.Object
  <IMG SRC="../resources/inherit.gif" ALT="extended by "><A HREF="../ztex/Ztex1.html" title="class in ztex">ztex.Ztex1</A>
      <IMG SRC="../resources/inherit.gif" ALT="extended by "><B>ztex.Ztex1v1</B>
</PRE>
<HR>
<DL>
<DT><PRE>public class <B>Ztex1v1</B><DT>extends <A HREF="../ztex/Ztex1.html" title="class in ztex">Ztex1</A></DL>
</PRE>
 
<P>
This class implements the communication protocol of the interface version 1 for the interaction with the ZTEX firmware.
 <p>
 The features supported by this interface can be accessed via vendor commands and vendor requests via Endpoint 0.
 Each feature can be enabled or disabled by the firmware and also depends from the hardware.
 The presence of a feature is indicated by a 1 in the corresponding feature bit of the ZTEX descriptor 1, see <A HREF="../ztex/ZtexDevice1.html" title="class in ztex"><CODE>ZtexDevice1</CODE></A>.
 The following table gives an overview about the features
 <table bgcolor="#404040" cellspacing=1 cellpadding=10>
   <tr>
     <td bgcolor="#d0d0d0" valign="bottom"><b>Capability bit</b></td>
     <td bgcolor="#d0d0d0" valign="bottom"><b>Description</b></td>
   </tr>
   <tr>
     <td bgcolor="#ffffff" valign="top">0.0</td>
     <td bgcolor="#ffffff" valign="top" colspan=2>
          EEPROM 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 0x38</td>
           <td bgcolor="#ffffff" valign="top">Read from EEPROM</td>
         </tr>
         <tr>
           <td bgcolor="#ffffff" valign="top">VC 0x39</td>
           <td bgcolor="#ffffff" valign="top">Write to EEPROM</td>
         </tr>
         <tr>
           <td bgcolor="#ffffff" valign="top">VR 0x3a</td>
           <td bgcolor="#ffffff" valign="top">Get EEPROM state. 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 bytes written.</td>
               </tr>
               <tr>
                 <td bgcolor="#ffffff" valign="top">2</td>
                 <td bgcolor="#ffffff" valign="top">Checksum</td>
               </tr>
               <tr>
                 <td bgcolor="#ffffff" valign="top">3</td>
                 <td bgcolor="#ffffff" valign="top">0:idle, 1:busy or error</td>
               </tr>
             </table>
           </td>
         </tr>
       </table>
        </td>
   </tr>
   <tr>
     <td bgcolor="#ffffff" valign="top">0.1</td>
     <td bgcolor="#ffffff" valign="top" colspan=2>
       FPGA Configuration<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 0x30</td>
           <td bgcolor="#ffffff" valign="top">Get FPGA state. 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</td>
                 <td bgcolor="#ffffff" valign="top">1: unconfigured, 0:configured</td>
               </tr>
               <tr>
                 <td bgcolor="#ffffff" valign="top">1</td>
                 <td bgcolor="#ffffff" valign="top">Checksum</td>
               </tr>
               <tr>
                 <td bgcolor="#ffffff" valign="top">2-5</td>
                 <td bgcolor="#ffffff" valign="top">Number of bytes transferred.</td>
               </tr>
               <tr>
                 <td bgcolor="#ffffff" valign="top">6</td>
                 <td bgcolor="#ffffff" valign="top">INIT_B states (Must be 222).</td>
               </tr>
             </table>
           </td>
         </tr>
         <tr>
           <td bgcolor="#ffffff" valign="top">VC 0x31</td>
           <td bgcolor="#ffffff" valign="top">Reset FPGA</td>
         </tr>
         <tr>
           <td bgcolor="#ffffff" valign="top">VR 0x32</td>
           <td bgcolor="#ffffff" valign="top">Send Bitstream</td>
         </tr>
       </table>
     </td>
   </tr>
   <tr>
     <td bgcolor="#ffffff" valign="top">0.2</td>
     <td bgcolor="#ffffff" valign="top" colspan=2>
       Flash memory 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 0x40</td>
           <td bgcolor="#ffffff" valign="top">Get Flash state. 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</td>
                 <td bgcolor="#ffffff" valign="top">1:enabled, 0:disabled</td>
               </tr>
               <tr>
                 <td bgcolor="#ffffff" valign="top">1-2</td>
                 <td bgcolor="#ffffff" valign="top">Sector size</td>
               </tr>
               <tr>
                 <td bgcolor="#ffffff" valign="top">3-6</td>
                 <td bgcolor="#ffffff" valign="top">Number of sectors</td>
               </tr>
               <tr>
                 <td bgcolor="#ffffff" valign="top">7</td>
                 <td bgcolor="#ffffff" valign="top">Error code</td>
               </tr>
             </table>
           </td>
         </tr>
         <tr>
           <td bgcolor="#ffffff" valign="top">VR 0x41</td>
           <td bgcolor="#ffffff" valign="top">Read one sector from Flash</td>
         </tr>
         <tr>
           <td bgcolor="#ffffff" valign="top">VC 0x42</td>
           <td bgcolor="#ffffff" valign="top">Write one sector to Flash</td>
         </tr>
       </table>
     </td>
   </tr>
 </table>
<P>
 
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../ztex/ZtexDevice1.html" title="class in ztex"><CODE>ZtexDevice1</CODE></A>, 
<A HREF="../ztex/Ztex1.html" title="class in ztex"><CODE>Ztex1</CODE></A></DL>
<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&nbsp;java.lang.String[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="../ztex/Ztex1v1.html#capabilityStrings">capabilityStrings</A></B></CODE>
 
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The names of the capabilities</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../ztex/Ztex1v1.html#eepromBytes">eepromBytes</A></B></CODE>
 
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Number of bytes written to EEPROM.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../ztex/Ztex1v1.html#eepromChecksum">eepromChecksum</A></B></CODE>
 
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Checksum of the last EEPROM transfer.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../ztex/Ztex1v1.html#FLASH_EC_BUSY">FLASH_EC_BUSY</A></B></CODE>
 
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Signals that Flash memory it busy.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../ztex/Ztex1v1.html#FLASH_EC_CMD_ERROR">FLASH_EC_CMD_ERROR</A></B></CODE>
 
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Signals an error while attempting to execute a command.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../ztex/Ztex1v1.html#FLASH_EC_NO_ERROR">FLASH_EC_NO_ERROR</A></B></CODE>
 
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Means no error.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../ztex/Ztex1v1.html#FLASH_EC_PENDING">FLASH_EC_PENDING</A></B></CODE>
 
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Signals that another Flash operation is pending.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../ztex/Ztex1v1.html#FLASH_EC_READ_ERROR">FLASH_EC_READ_ERROR</A></B></CODE>
 
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Signals an error while attempting to read from Flash.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../ztex/Ztex1v1.html#FLASH_EC_TIMEOUT">FLASH_EC_TIMEOUT</A></B></CODE>
 
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Signals that a timeout occurred.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../ztex/Ztex1v1.html#FLASH_EC_WRITE_ERROR">FLASH_EC_WRITE_ERROR</A></B></CODE>
 
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Signals an error while attempting to write to Flash.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../ztex/Ztex1v1.html#flashEC">flashEC</A></B></CODE>
 
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Last Flash error code obtained by <A HREF="../ztex/Ztex1v1.html#flashState()"><CODE>flashState()</CODE></A>.</TD>
</TR>
</TABLE>
&nbsp;<A NAME="fields_inherited_from_class_ztex.Ztex1"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Fields inherited from class ztex.<A HREF="../ztex/Ztex1.html" title="class in ztex">Ztex1</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../ztex/Ztex1.html#certainWorkarounds">certainWorkarounds</A>, <A HREF="../ztex/Ztex1.html#controlMsgTimeout">controlMsgTimeout</A></CODE></TD>
</TR>
</TABLE>
&nbsp;
<!-- ======== 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/Ztex1v1.html#Ztex1v1(ztex.ZtexDevice1)">Ztex1v1</A></B>(<A HREF="../ztex/ZtexDevice1.html" title="class in ztex">ZtexDevice1</A>&nbsp;pDev)</CODE>
 
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructs an instance from a given device.</TD>
</TR>
</TABLE>
&nbsp;
<!-- ========== 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>&nbsp;java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../ztex/Ztex1v1.html#capabilityInfo(java.lang.String)">capabilityInfo</A></B>(java.lang.String&nbsp;pf)</CODE>
 
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates a String with capability information.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../ztex/Ztex1v1.html#checkCapability(int, int)">checkCapability</A></B>(int&nbsp;i,
                int&nbsp;j)</CODE>
 
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;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>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../ztex/Ztex1v1.html#checkCompatible(int, int, int, int)">checkCompatible</A></B>(int&nbsp;productId0,
                int&nbsp;productId1,
                int&nbsp;productId2,
                int&nbsp;productId3)</CODE>
 
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Checks whether the given product ID is compatible to the device corresponding to this class and whether interface 1 is supported.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../ztex/Ztex1v1.html#checkValid()">checkValid</A></B>()</CODE>
 
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Checks whether ZTEX descriptor 1 is available and interface 1 is supported.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../ztex/Ztex1v1.html#compatible(int, int, int, int)">compatible</A></B>(int&nbsp;productId0,
           int&nbsp;productId1,
           int&nbsp;productId2,
           int&nbsp;productId3)</CODE>
 
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Checks whether the given product ID is compatible to the device corresponding to this class and whether interface 1 is supported.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;long</CODE></FONT></TD>
<TD><CODE><B><A HREF="../ztex/Ztex1v1.html#configureFpga(java.lang.String, boolean)">configureFpga</A></B>(java.lang.String&nbsp;fwFileName,
              boolean&nbsp;force)</CODE>
 
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Upload a Bitstream to the FPGA.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../ztex/Ztex1v1.html#eepromDisable()">eepromDisable</A></B>()</CODE>
 
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Disables the firmware stored in the EEPROM.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../ztex/Ztex1v1.html#eepromRead(int, byte[], int)">eepromRead</A></B>(int&nbsp;addr,
           byte[]&nbsp;buf,
           int&nbsp;length)</CODE>
 
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Reads data from the EEPROM.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../ztex/Ztex1v1.html#eepromState()">eepromState</A></B>()</CODE>
 
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Reads the current EEPROM status.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;long</CODE></FONT></TD>
<TD><CODE><B><A HREF="../ztex/Ztex1v1.html#eepromUpload(java.lang.String, boolean)">eepromUpload</A></B>(java.lang.String&nbsp;ihxFileName,
             boolean&nbsp;force)</CODE>
 
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Upload the firmware to the EEPROM.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../ztex/Ztex1v1.html#eepromWrite(int, byte[], int)">eepromWrite</A></B>(int&nbsp;addr,
            byte[]&nbsp;buf,
            int&nbsp;length)</CODE>
 
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Writes data to the EEPROM.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../ztex/Ztex1v1.html#flashEnabled()">flashEnabled</A></B>()</CODE>
 
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns true if Flash memory is installed.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../ztex/Ztex1v1.html#flashFirstFreeSector()">flashFirstFreeSector</A></B>()</CODE>
 
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the first free sector of the Flash memory.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../ztex/Ztex1v1.html#flashReadSector(int, byte[])">flashReadSector</A></B>(int&nbsp;sector,
                byte[]&nbsp;buf)</CODE>
 
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Reads one sector from the Flash.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../ztex/Ztex1v1.html#flashResetBitstream()">flashResetBitstream</A></B>()</CODE>
 
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Clears a Bitstream from the Flash.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../ztex/Ztex1v1.html#flashSectors()">flashSectors</A></B>()</CODE>
 
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the number of sectors of the Flash memory or 0, if no Flash memory is installed.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../ztex/Ztex1v1.html#flashSectorSize()">flashSectorSize</A></B>()</CODE>
 
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the sector size of the Flash memory or 0, if no flash memory is installed.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;long</CODE></FONT></TD>
<TD><CODE><B><A HREF="../ztex/Ztex1v1.html#flashSize()">flashSize</A></B>()</CODE>
 
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the size of Flash memory or 0, if no Flash memory is installed.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../ztex/Ztex1v1.html#flashState()">flashState</A></B>()</CODE>
 
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Reads the the Flash memory status and information.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../ztex/Ztex1v1.html#flashStrError()">flashStrError</A></B>()</CODE>
 
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets the last Flash error from the device.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../ztex/Ztex1v1.html#flashStrError(int)">flashStrError</A></B>(int&nbsp;errNum)</CODE>
 
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Converts a given error code into a String.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;long</CODE></FONT></TD>
<TD><CODE><B><A HREF="../ztex/Ztex1v1.html#flashUploadBitstream(java.lang.String)">flashUploadBitstream</A></B>(java.lang.String&nbsp;fwFileName)</CODE>
 
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Uploads a Bitstream to the Flash.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../ztex/Ztex1v1.html#flashWriteSector(int, byte[])">flashWriteSector</A></B>(int&nbsp;sector,
                 byte[]&nbsp;buf)</CODE>
 
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Writes one sector to the Flash.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../ztex/Ztex1v1.html#getFlashEC()">getFlashEC</A></B>()</CODE>
 
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets the last Flash error from the device.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../ztex/Ztex1v1.html#getFpgaConfiguration()">getFpgaConfiguration</A></B>()</CODE>
 
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns true if the FPGA is configured.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../ztex/Ztex1v1.html#getFpgaConfigurationStr()">getFpgaConfigurationStr</A></B>()</CODE>
 
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a string that indicates the FPGA configuration status.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../ztex/Ztex1v1.html#printFpgaState()">printFpgaState</A></B>()</CODE>
 
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Prints out the FPGA state.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../ztex/Ztex1v1.html#printMmcState()">printMmcState</A></B>()</CODE>
 
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Prints out some debug information about *SD/MMC Flash cards in SPI mode.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../ztex/Ztex1v1.html#resetFpga()">resetFpga</A></B>()</CODE>
 
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Resets the FPGA.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../ztex/Ztex1v1.html#toString()">toString</A></B>()</CODE>
 
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a lot of useful information about the corresponding device.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../ztex/Ztex1v1.html#valid()">valid</A></B>()</CODE>
 
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns true if ZTEX interface 1 is available.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../ztex/Ztex1v1.html#valid(int, int)">valid</A></B>(int&nbsp;i,
      int&nbsp;j)</CODE>
 
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns true if ZTEX interface 1 and capability i.j are available.</TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_ztex.Ztex1"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class ztex.<A HREF="../ztex/Ztex1.html" title="class in ztex">Ztex1</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../ztex/Ztex1.html#dev()">dev</A>, <A HREF="../ztex/Ztex1.html#finalize()">finalize</A>, <A HREF="../ztex/Ztex1.html#handle()">handle</A>, <A HREF="../ztex/Ztex1.html#resetEzUsb()">resetEzUsb</A>, <A HREF="../ztex/Ztex1.html#uploadFirmware(java.lang.String, boolean)">uploadFirmware</A>, <A HREF="../ztex/Ztex1.html#vendorCommand(int, java.lang.String)">vendorCommand</A>, <A HREF="../ztex/Ztex1.html#vendorCommand(int, java.lang.String, int, int)">vendorCommand</A>, <A HREF="../ztex/Ztex1.html#vendorCommand(int, java.lang.String, int, int, byte[], int)">vendorCommand</A>, <A HREF="../ztex/Ztex1.html#vendorCommand2(int, java.lang.String, int, int, byte[], int)">vendorCommand2</A>, <A HREF="../ztex/Ztex1.html#vendorRequest(int, java.lang.String, byte[], int)">vendorRequest</A>, <A HREF="../ztex/Ztex1.html#vendorRequest(int, java.lang.String, int, int, byte[], int)">vendorRequest</A>, <A HREF="../ztex/Ztex1.html#vendorRequest2(int, java.lang.String, byte[], int)">vendorRequest2</A>, <A HREF="../ztex/Ztex1.html#vendorRequest2(int, java.lang.String, int, int, byte[], int)">vendorRequest2</A></CODE></TD>
</TR>
</TABLE>
&nbsp;<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, getClass, hashCode, notify, notifyAll, wait, wait, wait</CODE></TD>
</TR>
</TABLE>
&nbsp;
<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="capabilityStrings"><!-- --></A><H3>
capabilityStrings</H3>
<PRE>
public static final java.lang.String[] <B>capabilityStrings</B></PRE>
<DL>
<DD>The names of the capabilities
<P>
<DL>
</DL>
</DL>
<HR>
 
<A NAME="eepromBytes"><!-- --></A><H3>
eepromBytes</H3>
<PRE>
public int <B>eepromBytes</B></PRE>
<DL>
<DD>Number of bytes written to EEPROM. (Obtained by <A HREF="../ztex/Ztex1v1.html#eepromState()"><CODE>eepromState()</CODE></A>.)
<P>
<DL>
</DL>
</DL>
<HR>
 
<A NAME="eepromChecksum"><!-- --></A><H3>
eepromChecksum</H3>
<PRE>
public int <B>eepromChecksum</B></PRE>
<DL>
<DD>Checksum of the last EEPROM transfer. (Obtained by <A HREF="../ztex/Ztex1v1.html#eepromState()"><CODE>eepromState()</CODE></A>.)
<P>
<DL>
</DL>
</DL>
<HR>
 
<A NAME="flashEC"><!-- --></A><H3>
flashEC</H3>
<PRE>
public int <B>flashEC</B></PRE>
<DL>
<DD>Last Flash error code obtained by <A HREF="../ztex/Ztex1v1.html#flashState()"><CODE>flashState()</CODE></A>. See FLASH_EC_* for possible error codes.
<P>
<DL>
</DL>
</DL>
<HR>
 
<A NAME="FLASH_EC_NO_ERROR"><!-- --></A><H3>
FLASH_EC_NO_ERROR</H3>
<PRE>
public static final int <B>FLASH_EC_NO_ERROR</B></PRE>
<DL>
<DD>Means no error.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../constant-values.html#ztex.Ztex1v1.FLASH_EC_NO_ERROR">Constant Field Values</A></DL>
</DL>
<HR>
 
<A NAME="FLASH_EC_CMD_ERROR"><!-- --></A><H3>
FLASH_EC_CMD_ERROR</H3>
<PRE>
public static final int <B>FLASH_EC_CMD_ERROR</B></PRE>
<DL>
<DD>Signals an error while attempting to execute a command.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../constant-values.html#ztex.Ztex1v1.FLASH_EC_CMD_ERROR">Constant Field Values</A></DL>
</DL>
<HR>
 
<A NAME="FLASH_EC_TIMEOUT"><!-- --></A><H3>
FLASH_EC_TIMEOUT</H3>
<PRE>
public static final int <B>FLASH_EC_TIMEOUT</B></PRE>
<DL>
<DD>Signals that a timeout occurred.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../constant-values.html#ztex.Ztex1v1.FLASH_EC_TIMEOUT">Constant Field Values</A></DL>
</DL>
<HR>
 
<A NAME="FLASH_EC_BUSY"><!-- --></A><H3>
FLASH_EC_BUSY</H3>
<PRE>
public static final int <B>FLASH_EC_BUSY</B></PRE>
<DL>
<DD>Signals that Flash memory it busy.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../constant-values.html#ztex.Ztex1v1.FLASH_EC_BUSY">Constant Field Values</A></DL>
</DL>
<HR>
 
<A NAME="FLASH_EC_PENDING"><!-- --></A><H3>
FLASH_EC_PENDING</H3>
<PRE>
public static final int <B>FLASH_EC_PENDING</B></PRE>
<DL>
<DD>Signals that another Flash operation is pending.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../constant-values.html#ztex.Ztex1v1.FLASH_EC_PENDING">Constant Field Values</A></DL>
</DL>
<HR>
 
<A NAME="FLASH_EC_READ_ERROR"><!-- --></A><H3>
FLASH_EC_READ_ERROR</H3>
<PRE>
public static final int <B>FLASH_EC_READ_ERROR</B></PRE>
<DL>
<DD>Signals an error while attempting to read from Flash.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../constant-values.html#ztex.Ztex1v1.FLASH_EC_READ_ERROR">Constant Field Values</A></DL>
</DL>
<HR>
 
<A NAME="FLASH_EC_WRITE_ERROR"><!-- --></A><H3>
FLASH_EC_WRITE_ERROR</H3>
<PRE>
public static final int <B>FLASH_EC_WRITE_ERROR</B></PRE>
<DL>
<DD>Signals an error while attempting to write to Flash.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../constant-values.html#ztex.Ztex1v1.FLASH_EC_WRITE_ERROR">Constant Field Values</A></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="Ztex1v1(ztex.ZtexDevice1)"><!-- --></A><H3>
Ztex1v1</H3>
<PRE>
public <B>Ztex1v1</B>(<A HREF="../ztex/ZtexDevice1.html" title="class in ztex">ZtexDevice1</A>&nbsp;pDev)
        throws <A HREF="../ztex/UsbException.html" title="class in ztex">UsbException</A></PRE>
<DL>
<DD>Constructs an instance from a given device.
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>pDev</CODE> - The given device.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../ztex/UsbException.html" title="class in ztex">UsbException</A></CODE> - if an communication error occurred.</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="valid()"><!-- --></A><H3>
valid</H3>
<PRE>
public boolean <B>valid</B>()</PRE>
<DL>
<DD>Returns true if ZTEX interface 1 is available.
<P>
<DD><DL>
<DT><B>Overrides:</B><DD><CODE><A HREF="../ztex/Ztex1.html#valid()">valid</A></CODE> in class <CODE><A HREF="../ztex/Ztex1.html" title="class in ztex">Ztex1</A></CODE></DL>
</DD>
<DD><DL>
 
<DT><B>Returns:</B><DD>true if ZTEX interface 1 is available.</DL>
</DD>
</DL>
<HR>
 
<A NAME="valid(int, int)"><!-- --></A><H3>
valid</H3>
<PRE>
public boolean <B>valid</B>(int&nbsp;i,
                     int&nbsp;j)</PRE>
<DL>
<DD>Returns true if ZTEX interface 1 and capability i.j are available.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>i</CODE> - byte index of the capability<DD><CODE>j</CODE> - bit index of the capability
<DT><B>Returns:</B><DD>true if ZTEX interface 1 and capability i.j are available.</DL>
</DD>
</DL>
<HR>
 
<A NAME="compatible(int, int, int, int)"><!-- --></A><H3>
compatible</H3>
<PRE>
public boolean <B>compatible</B>(int&nbsp;productId0,
                          int&nbsp;productId1,
                          int&nbsp;productId2,
                          int&nbsp;productId3)</PRE>
<DL>
<DD>Checks whether the given product ID is compatible to the device corresponding to this class and whether interface 1 is supported.<br>
 The given product ID is compatible
 <pre>if ( this.productId(0)==0 || productId0<=0 || this.productId(0)==productId0 ) && 
   ( this.productId(0)==0 || productId1<=0 || this.productId(1)==productId1 ) && 
   ( this.productId(2)==0 || productId2<=0 || this.productId(2)==productId2 ) && 
   ( this.productId(3)==0 || productId3<=0 || this.productId(3)==productId3 ) </pre>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>productId0</CODE> - Byte 0 of the given product ID<DD><CODE>productId1</CODE> - Byte 1 of the given product ID<DD><CODE>productId2</CODE> - Byte 2 of the given product ID<DD><CODE>productId3</CODE> - Byte 3 of the given product ID
<DT><B>Returns:</B><DD>true if the given product ID is compatible and interface 1 is supported.</DL>
</DD>
</DL>
<HR>
 
<A NAME="checkValid()"><!-- --></A><H3>
checkValid</H3>
<PRE>
public void <B>checkValid</B>()
                throws <A HREF="../ztex/InvalidFirmwareException.html" title="class in ztex">InvalidFirmwareException</A></PRE>
<DL>
<DD>Checks whether ZTEX descriptor 1 is available and interface 1 is supported.
<P>
<DD><DL>
<DT><B>Overrides:</B><DD><CODE><A HREF="../ztex/Ztex1.html#checkValid()">checkValid</A></CODE> in class <CODE><A HREF="../ztex/Ztex1.html" title="class in ztex">Ztex1</A></CODE></DL>
</DD>
<DD><DL>
 
<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.</DL>
</DD>
</DL>
<HR>
 
<A NAME="checkCapability(int, int)"><!-- --></A><H3>
checkCapability</H3>
<PRE>
public void <B>checkCapability</B>(int&nbsp;i,
                            int&nbsp;j)
                     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> - byte index of the capability<DD><CODE>j</CODE> - bit index of the capability
<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>
public void <B>checkCompatible</B>(int&nbsp;productId0,
                            int&nbsp;productId1,
                            int&nbsp;productId2,
                            int&nbsp;productId3)
                     throws <A HREF="../ztex/InvalidFirmwareException.html" title="class in ztex">InvalidFirmwareException</A></PRE>
<DL>
<DD>Checks whether the given product ID is compatible to the device corresponding to this class and whether interface 1 is supported.
 See <A HREF="../ztex/Ztex1v1.html#compatible(int, int, int, int)"><CODE>compatible(int,int,int,int)</CODE></A>.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>productId0</CODE> - Byte 0 of the given product ID<DD><CODE>productId1</CODE> - Byte 1 of the given product ID<DD><CODE>productId2</CODE> - Byte 2 of the given product ID<DD><CODE>productId3</CODE> - Byte 3 of the given product ID
<DT><B>Throws:</B>
<DD><CODE><A HREF="../ztex/InvalidFirmwareException.html" title="class in ztex">InvalidFirmwareException</A></CODE> - if the given product ID is not compatible or interface 1 is not supported.</DL>
</DD>
</DL>
<HR>
 
<A NAME="printFpgaState()"><!-- --></A><H3>
printFpgaState</H3>
<PRE>
public void <B>printFpgaState</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>Prints out the FPGA state.
<P>
<DD><DL>
 
<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 FPGA configuration is not supported by the firmware.</DL>
</DD>
</DL>
<HR>
 
<A NAME="getFpgaConfiguration()"><!-- --></A><H3>
getFpgaConfiguration</H3>
<PRE>
public boolean <B>getFpgaConfiguration</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 true if the FPGA is configured.
<P>
<DD><DL>
 
<DT><B>Returns:</B><DD>true if the FPGA is configured.
<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 FPGA configuration is not supported by the firmware.</DL>
</DD>
</DL>
<HR>
 
<A NAME="getFpgaConfigurationStr()"><!-- --></A><H3>
getFpgaConfigurationStr</H3>
<PRE>
public java.lang.String <B>getFpgaConfigurationStr</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 a string that indicates the FPGA configuration status.
<P>
<DD><DL>
 
<DT><B>Returns:</B><DD>a string that indicates the FPGA configuration status.
<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 FPGA configuration is not supported by the firmware.</DL>
</DD>
</DL>
<HR>
 
<A NAME="resetFpga()"><!-- --></A><H3>
resetFpga</H3>
<PRE>
public void <B>resetFpga</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>Resets the FPGA.
<P>
<DD><DL>
 
<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 FPGA configuration is not supported by the firmware.</DL>
</DD>
</DL>
<HR>
 
<A NAME="configureFpga(java.lang.String, boolean)"><!-- --></A><H3>
configureFpga</H3>
<PRE>
public long <B>configureFpga</B>(java.lang.String&nbsp;fwFileName,
                          boolean&nbsp;force)
                   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).
<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="eepromState()"><!-- --></A><H3>
eepromState</H3>
<PRE>
public boolean <B>eepromState</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>Reads the current EEPROM status.
 This method also sets the varibles <A HREF="../ztex/Ztex1v1.html#eepromBytes"><CODE>eepromBytes</CODE></A> and <A HREF="../ztex/Ztex1v1.html#eepromChecksum"><CODE>eepromChecksum</CODE></A>.
<P>
<DD><DL>
 
<DT><B>Returns:</B><DD>true if EEPROM is ready.
<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 EEPROM access is not supported by the firmware.</DL>
</DD>
</DL>
<HR>
 
<A NAME="eepromWrite(int, byte[], int)"><!-- --></A><H3>
eepromWrite</H3>
<PRE>
public void <B>eepromWrite</B>(int&nbsp;addr,
                        byte[]&nbsp;buf,
                        int&nbsp;length)
                 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>Writes data to the EEPROM.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>addr</CODE> - The destination address of the EEPROM.<DD><CODE>buf</CODE> - The data.<DD><CODE>length</CODE> - The amount of bytes to be sent.
<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 EEPROM access is not supported by the firmware.</DL>
</DD>
</DL>
<HR>
 
<A NAME="eepromRead(int, byte[], int)"><!-- --></A><H3>
eepromRead</H3>
<PRE>
public void <B>eepromRead</B>(int&nbsp;addr,
                       byte[]&nbsp;buf,
                       int&nbsp;length)
                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 data from the EEPROM.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>addr</CODE> - The source address of the EEPROM.<DD><CODE>buf</CODE> - A buffer for the storage of the data.<DD><CODE>length</CODE> - The amount of bytes to 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 EEPROM access is not supported by the firmware.</DL>
</DD>
</DL>
<HR>
 
<A NAME="eepromUpload(java.lang.String, boolean)"><!-- --></A><H3>
eepromUpload</H3>
<PRE>
public long <B>eepromUpload</B>(java.lang.String&nbsp;ihxFileName,
                         boolean&nbsp;force)
                  throws <A HREF="../ztex/IncompatibleFirmwareException.html" title="class in ztex">IncompatibleFirmwareException</A>,
                         <A HREF="../ztex/FirmwareUploadException.html" title="class in ztex">FirmwareUploadException</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 the firmware to the EEPROM.
 In order to start the uploaded firmware the device must be reset.
<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> - Skips the compatibility check if true.
<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/Ztex1v1.html#compatible(int, int, int, int)"><CODE>compatible(int,int,int,int)</CODE></A> (Upload can be enforced using the <tt>force</tt> parameter.)
<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/CapabilityException.html" title="class in ztex">CapabilityException</A></CODE> - if EEPROM access is not supported by the firmware.
<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>
</DL>
<HR>
 
<A NAME="eepromDisable()"><!-- --></A><H3>
eepromDisable</H3>
<PRE>
public void <B>eepromDisable</B>()
                   throws <A HREF="../ztex/FirmwareUploadException.html" title="class in ztex">FirmwareUploadException</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>Disables the firmware stored in the EEPROM.
 This is achived by writing a "0" to the address 0 of the EEPROM.
<P>
<DD><DL>
 
<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/CapabilityException.html" title="class in ztex">CapabilityException</A></CODE> - if EEPROM access is not supported by the firmware.
<DD><CODE><A HREF="../ztex/FirmwareUploadException.html" title="class in ztex">FirmwareUploadException</A></CODE> - if an error occurred while attempting to disable the firmware.</DL>
</DD>
</DL>
<HR>
 
<A NAME="flashStrError(int)"><!-- --></A><H3>
flashStrError</H3>
<PRE>
public static java.lang.String <B>flashStrError</B>(int&nbsp;errNum)</PRE>
<DL>
<DD>Converts a given error code into a String.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>errNum</CODE> - The error code.
<DT><B>Returns:</B><DD>an error message.</DL>
</DD>
</DL>
<HR>
 
<A NAME="flashStrError()"><!-- --></A><H3>
flashStrError</H3>
<PRE>
public java.lang.String <B>flashStrError</B>()</PRE>
<DL>
<DD>Gets the last Flash error from the device.
<P>
<DD><DL>
 
<DT><B>Returns:</B><DD>an error message.</DL>
</DD>
</DL>
<HR>
 
<A NAME="flashState()"><!-- --></A><H3>
flashState</H3>
<PRE>
public boolean <B>flashState</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>Reads the the Flash memory status and information.
 This method also sets the variables <A HREF="../ztex/Ztex1v1.html#flashEnabled"><CODE>flashEnabled</CODE></A>, <A HREF="../ztex/Ztex1v1.html#flashSectorSize"><CODE>flashSectorSize</CODE></A> and <A HREF="../ztex/Ztex1v1.html#flashSectors"><CODE>flashSectors</CODE></A>.
<P>
<DD><DL>
 
<DT><B>Returns:</B><DD>true if Flash memory is installed.
<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 supported by the firmware.</DL>
</DD>
</DL>
<HR>
 
<A NAME="getFlashEC()"><!-- --></A><H3>
getFlashEC</H3>
<PRE>
public int <B>getFlashEC</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>Gets the last Flash error from the device.
<P>
<DD><DL>
 
<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 supported by the firmware.</DL>
</DD>
</DL>
<HR>
 
<A NAME="flashReadSector(int, byte[])"><!-- --></A><H3>
flashReadSector</H3>
<PRE>
public void <B>flashReadSector</B>(int&nbsp;sector,
                            byte[]&nbsp;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 one sector from the Flash.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>sector</CODE> - The sector number to be read.<DD><CODE>buf</CODE> - A buffer for the storage of the data.
<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="flashWriteSector(int, byte[])"><!-- --></A><H3>
flashWriteSector</H3>
<PRE>
public void <B>flashWriteSector</B>(int&nbsp;sector,
                             byte[]&nbsp;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>Writes one sector to the Flash.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>sector</CODE> - The sector number to be written.<DD><CODE>buf</CODE> - The data.
<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="flashEnabled()"><!-- --></A><H3>
flashEnabled</H3>
<PRE>
public boolean <B>flashEnabled</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 true if Flash memory is installed.
<P>
<DD><DL>
 
<DT><B>Returns:</B><DD>true if Flash memory is installed.
<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 supported by the firmware.</DL>
</DD>
</DL>
<HR>
 
<A NAME="flashSectorSize()"><!-- --></A><H3>
flashSectorSize</H3>
<PRE>
public int <B>flashSectorSize</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 sector size of the Flash memory or 0, if no flash memory is installed.
 If required, the sector size is determined form the device first.
<P>
<DD><DL>
 
<DT><B>Returns:</B><DD>the sector size of the Flash memory.
<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 supported by the firmware.</DL>
</DD>
</DL>
<HR>
 
<A NAME="flashSectors()"><!-- --></A><H3>
flashSectors</H3>
<PRE>
public int <B>flashSectors</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 number of sectors of the Flash memory or 0, if no Flash memory is installed.
 If required, the number of sectors is determined form the device first.
<P>
<DD><DL>
 
<DT><B>Returns:</B><DD>the number of sectors of the Flash memory.
<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 supported by the firmware.</DL>
</DD>
</DL>
<HR>
 
<A NAME="flashSize()"><!-- --></A><H3>
flashSize</H3>
<PRE>
public long <B>flashSize</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 Flash memory or 0, if no Flash memory is installed.
 If required, the Flash size is determined form the device first.
<P>
<DD><DL>
 
<DT><B>Returns:</B><DD>the size of Flash memory.
<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 supported by the firmware.</DL>
</DD>
</DL>
<HR>
 
<A NAME="printMmcState()"><!-- --></A><H3>
printMmcState</H3>
<PRE>
public boolean <B>printMmcState</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>Prints out some debug information about *SD/MMC Flash cards in SPI mode.<br>
 <b>Only use this method if such kind of Flash is installed.</b>
<P>
<DD><DL>
 
<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 supported by the firmware.</DL>
</DD>
</DL>
<HR>
 
<A NAME="flashUploadBitstream(java.lang.String)"><!-- --></A><H3>
flashUploadBitstream</H3>
<PRE>
public long <B>flashUploadBitstream</B>(java.lang.String&nbsp;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.
 <p>
 Information about the bitstream is stored in sector 0.
 This so called boot sector has the following format:
 <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..7</td>
     <td bgcolor="#ffffff" valign="top">ID, must be "ZTEXBS",1,1</td>
   </tr>
   <tr>
     <td bgcolor="#ffffff" valign="top">8..9</td>
     <td bgcolor="#ffffff" valign="top">The number of sectors used to store the Bitstream. 0 means no Bitstream.</td>
   </tr>
   <tr>
     <td bgcolor="#ffffff" valign="top">10..11</td>
     <td bgcolor="#ffffff" valign="top">The number of bytes in the last sector.</td>
   </tr>
   <tr>
     <td bgcolor="#ffffff" valign="top">12..sectorSize-1</td>
     <td bgcolor="#ffffff" valign="top">This data is reserved for future use and preserved by this method.</td>
   </tr>
 </table>
 <p>
 The total size of the Bitstream is computed as ((bs[8] | (bs[9]<<8) - 1) * flash_sector_size + ((bs[10] | (bs[11]<<8))
 where bs[i] denotes byte i of the boot sector.
 <p>
 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).
<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="flashResetBitstream()"><!-- --></A><H3>
flashResetBitstream</H3>
<PRE>
public void <B>flashResetBitstream</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>Clears a Bitstream from the Flash.
 This is achieved by writing 0 to bytes 8..9 of the boot sector, see <A HREF="../ztex/Ztex1v1.html#flashUploadBitstream(java.lang.String)"><CODE>flashUploadBitstream(String)</CODE></A>.
 If no boot sector is installed the method returns without any write action.
<P>
<DD><DL>
 
<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="flashFirstFreeSector()"><!-- --></A><H3>
flashFirstFreeSector</H3>
<PRE>
public int <B>flashFirstFreeSector</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 first free sector of the Flash memory.
 This is the first sector behind the Bitstream, or 0 if no boot sector is installed (or 1 if a boot sector but no Bitstream is installed).
<P>
<DD><DL>
 
<DT><B>Returns:</B><DD>the first free sector of the Flash memory.
<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>
public java.lang.String <B>toString</B>()</PRE>
<DL>
<DD>Returns a lot of useful information about the corresponding device.
<P>
<DD><DL>
<DT><B>Overrides:</B><DD><CODE><A HREF="../ztex/Ztex1.html#toString()">toString</A></CODE> in class <CODE><A HREF="../ztex/Ztex1.html" title="class in ztex">Ztex1</A></CODE></DL>
</DD>
<DD><DL>
 
<DT><B>Returns:</B><DD>a lot of useful information about the corresponding device.</DL>
</DD>
</DL>
<HR>
 
<A NAME="capabilityInfo(java.lang.String)"><!-- --></A><H3>
capabilityInfo</H3>
<PRE>
public java.lang.String <B>capabilityInfo</B>(java.lang.String&nbsp;pf)</PRE>
<DL>
<DD>Creates a String with capability information.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>pf</CODE> - A separator between the single capabilities, e.g. ", "
<DT><B>Returns:</B><DD>a string of the supported capabilities.</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>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  </TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
 
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../ztex/Ztex1.html" title="class in ztex"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../ztex/ZtexDevice1.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/Ztex1v1.html" target="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="Ztex1v1.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
&nbsp;<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:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
 
<HR>
 
</BODY>
</HTML>
 

Go to most recent revision | Compare with Previous | Blame | View Log

powered by: WebSVN 2.1.0

© copyright 1999-2024 OpenCores.org, equivalent to Oliscience, all rights reserved. OpenCores®, registered trademark.