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/] [Ztex1.html] - Diff between revs 5 and 8

Go to most recent revision | Show entire file | Details | Blame | View Log

Rev 5 Rev 8
Line 1... Line 1...
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<!--NewPage-->
<HTML>
<HTML>
<HEAD>
<HEAD>
<!-- Generated by javadoc (build 1.6.0_02) on Wed Sep 29 21:04:05 CEST 2010 -->
<!-- Generated by javadoc (build 1.6.0_02) on Mon Jul 18 15:52:41 CEST 2011 -->
<TITLE>
<TITLE>
Ztex1
Ztex1
</TITLE>
</TITLE>
 
 
<META NAME="date" CONTENT="2010-09-29">
<META NAME="date" CONTENT="2011-07-18">
 
 
<LINK REL ="stylesheet" TYPE="text/css" HREF="../stylesheet.css" TITLE="Style">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../stylesheet.css" TITLE="Style">
 
 
<SCRIPT type="text/javascript">
<SCRIPT type="text/javascript">
function windowTitle()
function windowTitle()
Line 203... Line 203...
<BR>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The destructor closes the USB file handle.</TD>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The destructor closes the USB file handle.</TD>
</TR>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;int</CODE></FONT></TD>
<CODE>&nbsp;boolean</CODE></FONT></TD>
 
<TD><CODE><B><A HREF="../ztex/Ztex1.html#getInterfaceClaimed(int)">getInterfaceClaimed</A></B>(int&nbsp;iface)</CODE>
 
 
 
<BR>
 
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns true if interface is claimed.</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/Ztex1.html#handle()">handle</A></B>()</CODE>
<TD><CODE><B><A HREF="../ztex/Ztex1.html#handle()">handle</A></B>()</CODE>
 
 
<BR>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the USB file handle.</TD>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the USB file handle.</TD>
</TR>
</TR>
Line 260... Line 268...
<BR>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Uploads the firmware to the EZ-USB and manages the renumeration process.</TD>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Uploads the firmware to the EZ-USB and manages the renumeration process.</TD>
</TR>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 
<CODE>&nbsp;long</CODE></FONT></TD>
 
<TD><CODE><B><A HREF="../ztex/Ztex1.html#uploadFirmware(ztex.ZtexIhxFile1, boolean)">uploadFirmware</A></B>(<A HREF="../ztex/ZtexIhxFile1.html" title="class in ztex">ZtexIhxFile1</A>&nbsp;ihxFile,
 
               boolean&nbsp;force)</CODE>
 
 
 
<BR>
 
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Uploads the firmware to the EZ-USB and manages the renumeration process.</TD>
 
</TR>
 
<TR BGCOLOR="white" CLASS="TableRowColor">
 
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;boolean</CODE></FONT></TD>
<CODE>&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../ztex/Ztex1.html#valid()">valid</A></B>()</CODE>
<TD><CODE><B><A HREF="../ztex/Ztex1.html#valid()">valid</A></B>()</CODE>
 
 
<BR>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns true if ZTEX descriptor 1 is available.</TD>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns true if ZTEX descriptor 1 is available.</TD>
Line 459... Line 476...
<HR>
<HR>
 
 
<A NAME="handle()"><!-- --></A><H3>
<A NAME="handle()"><!-- --></A><H3>
handle</H3>
handle</H3>
<PRE>
<PRE>
public final int <B>handle</B>()</PRE>
public final long <B>handle</B>()</PRE>
<DL>
<DL>
<DD>Returns the USB file handle.
<DD>Returns the USB file handle.
<P>
<P>
<DD><DL>
<DD><DL>
</DL>
</DL>
Line 714... Line 731...
<DT><B>Parameters:</B><DD><CODE>config</CODE> - The configuration number (usually 1)</DL>
<DT><B>Parameters:</B><DD><CODE>config</CODE> - The configuration number (usually 1)</DL>
</DD>
</DD>
</DL>
</DL>
<HR>
<HR>
 
 
 
<A NAME="getInterfaceClaimed(int)"><!-- --></A><H3>
 
getInterfaceClaimed</H3>
 
<PRE>
 
public boolean <B>getInterfaceClaimed</B>(int&nbsp;iface)</PRE>
 
<DL>
 
<DD>Returns true if interface is claimed.
 
<P>
 
<DD><DL>
 
<DT><B>Parameters:</B><DD><CODE>iface</CODE> - The interface number
 
<DT><B>Returns:</B><DD>true if interface is claimed</DL>
 
</DD>
 
</DL>
 
<HR>
 
 
<A NAME="claimInterface(int)"><!-- --></A><H3>
<A NAME="claimInterface(int)"><!-- --></A><H3>
claimInterface</H3>
claimInterface</H3>
<PRE>
<PRE>
public void <B>claimInterface</B>(int&nbsp;iface)
public void <B>claimInterface</B>(int&nbsp;iface)
                    throws <A HREF="../ztex/UsbException.html" title="class in ztex">UsbException</A></PRE>
                    throws <A HREF="../ztex/UsbException.html" title="class in ztex">UsbException</A></PRE>
Line 743... Line 774...
<DT><B>Parameters:</B><DD><CODE>iface</CODE> - The interface number (usually 0)</DL>
<DT><B>Parameters:</B><DD><CODE>iface</CODE> - The interface number (usually 0)</DL>
</DD>
</DD>
</DL>
</DL>
<HR>
<HR>
 
 
 
<A NAME="uploadFirmware(ztex.ZtexIhxFile1, boolean)"><!-- --></A><H3>
 
uploadFirmware</H3>
 
<PRE>
 
public long <B>uploadFirmware</B>(<A HREF="../ztex/ZtexIhxFile1.html" title="class in ztex">ZtexIhxFile1</A>&nbsp;ihxFile,
 
                           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/UsbException.html" title="class in ztex">UsbException</A>,
 
                           <A HREF="../ztex/InvalidFirmwareException.html" title="class in ztex">InvalidFirmwareException</A>,
 
                           <A HREF="../ztex/DeviceLostException.html" title="class in ztex">DeviceLostException</A></PRE>
 
<DL>
 
<DD>Uploads the firmware to the EZ-USB and manages the renumeration process.
 
 <p>
 
 Before the firmware is uploaded the device is set into a reset state.
 
 After the upload the firmware is booted and the renumeration starts.
 
 During this process the device disappears from the bus and a new one
 
 occurs which will be assigned to this class automatically (instead of the disappeared one).
 
<P>
 
<DD><DL>
 
<DT><B>Parameters:</B><DD><CODE>ihxFile</CODE> - The firmware image.<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.
 
<DD><CODE><A HREF="../ztex/UsbException.html" title="class in ztex">UsbException</A></CODE> - if a communication error occurs.
 
<DD><CODE><A HREF="../ztex/InvalidFirmwareException.html" title="class in ztex">InvalidFirmwareException</A></CODE> - if ZTEX descriptor 1 is not available.
 
<DD><CODE><A HREF="../ztex/DeviceLostException.html" title="class in ztex">DeviceLostException</A></CODE> - if a device went lost after renumeration.</DL>
 
</DD>
 
</DL>
 
<HR>
 
 
<A NAME="uploadFirmware(java.lang.String, boolean)"><!-- --></A><H3>
<A NAME="uploadFirmware(java.lang.String, boolean)"><!-- --></A><H3>
uploadFirmware</H3>
uploadFirmware</H3>
<PRE>
<PRE>
public long <B>uploadFirmware</B>(java.lang.String&nbsp;ihxFileName,
public long <B>uploadFirmware</B>(java.lang.String&nbsp;ihxFileName,
                           boolean&nbsp;force)
                           boolean&nbsp;force)

powered by: WebSVN 2.1.0

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