URL
https://opencores.org/ocsvn/usb_fpga_2_14/usb_fpga_2_14/trunk
Subversion Repositories usb_fpga_2_14
[/] [usb_fpga_2_14/] [trunk/] [docs/] [java/] [ztex/] [ZtexImgFile1.html] - Rev 2
Compare with Previous | Blame | View Log
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="de">
<head>
<!-- Generated by javadoc (version 1.7.0_79) on Wed Mar 22 19:20:13 CET 2017 -->
<title>ZtexImgFile1</title>
<meta name="date" content="2017-03-22">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="ZtexImgFile1";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../ztex/package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../deprecated-list.html">Deprecated</a></li>
<li><a href="../index-all.html">Index</a></li>
<li><a href="../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../ztex/ZtexEventHandler.html" title="class in ztex"><span class="strong">Prev Class</span></a></li>
<li><a href="../ztex/ZtexScanBus1.html" title="class in ztex"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../index.html?ztex/ZtexImgFile1.html" target="_top">Frames</a></li>
<li><a href="ZtexImgFile1.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li><a href="#fields_inherited_from_class_ztex.ImgFile">Field</a> | </li>
<li><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor_detail">Constr</a> | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">ztex</div>
<h2 title="Class ZtexImgFile1" class="title">Class ZtexImgFile1</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../ztex/ImgFile.html" title="class in ztex">ztex.ImgFile</a></li>
<li>
<ul class="inheritance">
<li>ztex.ZtexImgFile1</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="strong">ZtexImgFile1</span>
extends <a href="../ztex/ImgFile.html" title="class in ztex">ImgFile</a></pre>
<div class="block">Represents a firmware image with ZTEX descriptor 1. <br>
The ZTEX descriptor is usually located at the position 0x6x of the FX2 firmware image.
In FX3 firmwares the descriptor is located by searching for the signature. <br>
A description of the ZTEX descriptor 1 can be found in <a href="../ztex/ZtexDevice1.html" title="class in ztex"><code>ZtexDevice1</code></a>.</div>
<dl><dt><span class="strong">See Also:</span></dt><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></dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="fields_inherited_from_class_ztex.ImgFile">
<!-- -->
</a>
<h3>Fields inherited from class ztex.<a href="../ztex/ImgFile.html" title="class in ztex">ImgFile</a></h3>
<code><a href="../ztex/ImgFile.html#data">data</a>, <a href="../ztex/ImgFile.html#isFx3">isFx3</a>, <a href="../ztex/ImgFile.html#startVector">startVector</a></code></li>
</ul>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../ztex/ZtexImgFile1.html#ZtexImgFile1(java.io.InputStream,%20java.lang.String)">ZtexImgFile1</a></strong>(java.io.InputStream in,
java.lang.String name)</code>
<div class="block">Constructs an instance from a given file name and descriptor position.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../ztex/ZtexImgFile1.html#ZtexImgFile1(java.lang.String)">ZtexImgFile1</a></strong>(java.lang.String fileName)</code>
<div class="block">Constructs an instance from a given file name.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../ztex/ZtexImgFile1.html#fwVersion()">fwVersion</a></strong>()</code>
<div class="block">Returns the firmware version.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>byte[]</code></td>
<td class="colLast"><code><strong><a href="../ztex/ZtexImgFile1.html#interfaceCapabilities()">interfaceCapabilities</a></strong>()</code>
<div class="block">Returns the interface capabilities (all 6 bytes).</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../ztex/ZtexImgFile1.html#interfaceCapabilities(int)">interfaceCapabilities</a></strong>(int i)</code>
<div class="block">Returns byte i of the interface capabilities.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../ztex/ZtexImgFile1.html#interfaceVersion()">interfaceVersion</a></strong>()</code>
<div class="block">Returns the interface version.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>byte[]</code></td>
<td class="colLast"><code><strong><a href="../ztex/ZtexImgFile1.html#moduleReserved()">moduleReserved</a></strong>()</code>
<div class="block">Returns the application specific information (all 12 bytes).</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../ztex/ZtexImgFile1.html#moduleReserved(int)">moduleReserved</a></strong>(int i)</code>
<div class="block">Returns byte i of the application specific information.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>byte[]</code></td>
<td class="colLast"><code><strong><a href="../ztex/ZtexImgFile1.html#productId()">productId</a></strong>()</code>
<div class="block">Returns the product ID (all 4 bytes).</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../ztex/ZtexImgFile1.html#productId(int)">productId</a></strong>(int i)</code>
<div class="block">Returns byte i of the product ID.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../ztex/ZtexImgFile1.html#setSnString(java.lang.String)">setSnString</a></strong>(java.lang.String s)</code>
<div class="block">Modifies the serial number string.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../ztex/ZtexImgFile1.html#snString()">snString</a></strong>()</code>
<div class="block">Returns the serial number string.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../ztex/ZtexImgFile1.html#toString()">toString</a></strong>()</code>
<div class="block">Returns a string representation if the instance.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_ztex.ImgFile">
<!-- -->
</a>
<h3>Methods inherited from class ztex.<a href="../ztex/ImgFile.html" title="class in ztex">ImgFile</a></h3>
<code><a href="../ztex/ImgFile.html#dataInfo(java.io.PrintStream)">dataInfo</a>, <a href="../ztex/ImgFile.html#uncompressAddr(int)">uncompressAddr</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="ZtexImgFile1(java.io.InputStream, java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ZtexImgFile1</h4>
<pre>public ZtexImgFile1(java.io.InputStream in,
java.lang.String name)
throws java.io.IOException,
<a href="../ztex/ImgFileDamagedException.html" title="class in ztex">ImgFileDamagedException</a>,
<a href="../ztex/IncompatibleFirmwareException.html" title="class in ztex">IncompatibleFirmwareException</a></pre>
<div class="block">Constructs an instance from a given file name and descriptor position.<br>
This method can also read system resources, e.g. files from the current jar archive.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>in</code> - Input stream from which the img file is read.</dd><dd><code>name</code> - Name of the input.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code> - If an read error occurred.</dd>
<dd><code><a href="../ztex/ImgFileDamagedException.html" title="class in ztex">ImgFileDamagedException</a></code> - If the firmware file is damaged.</dd>
<dd><code><a href="../ztex/IncompatibleFirmwareException.html" title="class in ztex">IncompatibleFirmwareException</a></code> - If the firmware image contains no valid ZTEX descriptor 1 at the specified position.</dd></dl>
</li>
</ul>
<a name="ZtexImgFile1(java.lang.String)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ZtexImgFile1</h4>
<pre>public ZtexImgFile1(java.lang.String fileName)
throws java.io.IOException,
<a href="../ztex/ImgFileDamagedException.html" title="class in ztex">ImgFileDamagedException</a>,
<a href="../ztex/IncompatibleFirmwareException.html" title="class in ztex">IncompatibleFirmwareException</a></pre>
<div class="block">Constructs an instance from a given file name.
The ZTEX descriptor 1 is expected to be at the position 0x6c of the firmware image.<br>
This method can also read system resources, e.g. files from the current jar archive.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>fileName</code> - The file name.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code> - If an read error occurred.</dd>
<dd><code><a href="../ztex/ImgFileDamagedException.html" title="class in ztex">ImgFileDamagedException</a></code> - If the firmware file is damaged.</dd>
<dd><code><a href="../ztex/IncompatibleFirmwareException.html" title="class in ztex">IncompatibleFirmwareException</a></code> - If the firmware image contains no valid ZTEX descriptor 1 at the specified position.</dd></dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="productId()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>productId</h4>
<pre>public final byte[] productId()</pre>
<div class="block">Returns the product ID (all 4 bytes).</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>PRODUCT_ID, see <a href="../ztex/ZtexDevice1.html" title="class in ztex"><code>ZtexDevice1</code></a>.</dd></dl>
</li>
</ul>
<a name="productId(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>productId</h4>
<pre>public int productId(int i)</pre>
<div class="block">Returns byte i of the product ID.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>i</code> - index</dd>
<dt><span class="strong">Returns:</span></dt><dd>PRODUCT_ID[i], see <a href="../ztex/ZtexDevice1.html" title="class in ztex"><code>ZtexDevice1</code></a>.</dd></dl>
</li>
</ul>
<a name="fwVersion()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fwVersion</h4>
<pre>public final int fwVersion()</pre>
<div class="block">Returns the firmware version.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>FW_VERSION, see <a href="../ztex/ZtexDevice1.html" title="class in ztex"><code>ZtexDevice1</code></a>.</dd></dl>
</li>
</ul>
<a name="interfaceVersion()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>interfaceVersion</h4>
<pre>public final int interfaceVersion()</pre>
<div class="block">Returns the interface version.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>INTERFACE_VERSION, see <a href="../ztex/ZtexDevice1.html" title="class in ztex"><code>ZtexDevice1</code></a>.</dd></dl>
</li>
</ul>
<a name="interfaceCapabilities()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>interfaceCapabilities</h4>
<pre>public final byte[] interfaceCapabilities()</pre>
<div class="block">Returns the interface capabilities (all 6 bytes).</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>INTERFACE_CAPABILITIES, see <a href="../ztex/ZtexDevice1.html" title="class in ztex"><code>ZtexDevice1</code></a>.</dd></dl>
</li>
</ul>
<a name="interfaceCapabilities(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>interfaceCapabilities</h4>
<pre>public final int interfaceCapabilities(int i)</pre>
<div class="block">Returns byte i of the interface capabilities.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>i</code> - index</dd>
<dt><span class="strong">Returns:</span></dt><dd>INTERFACE_CAPABILITIES[i], see <a href="../ztex/ZtexDevice1.html" title="class in ztex"><code>ZtexDevice1</code></a>.</dd></dl>
</li>
</ul>
<a name="moduleReserved()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>moduleReserved</h4>
<pre>public final byte[] moduleReserved()</pre>
<div class="block">Returns the application specific information (all 12 bytes).</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>MODULE_RESERVED, see <a href="../ztex/ZtexDevice1.html" title="class in ztex"><code>ZtexDevice1</code></a>.</dd></dl>
</li>
</ul>
<a name="moduleReserved(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>moduleReserved</h4>
<pre>public final int moduleReserved(int i)</pre>
<div class="block">Returns byte i of the application specific information.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>i</code> - index</dd>
<dt><span class="strong">Returns:</span></dt><dd>MODULE_RESERVED[i], see <a href="../ztex/ZtexDevice1.html" title="class in ztex"><code>ZtexDevice1</code></a>.</dd></dl>
</li>
</ul>
<a name="snString()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>snString</h4>
<pre>public final java.lang.String snString()</pre>
<div class="block">Returns the serial number string.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>SN_STRING, see <a href="../ztex/ZtexDevice1.html" title="class in ztex"><code>ZtexDevice1</code></a>.</dd></dl>
</li>
</ul>
<a name="setSnString(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSnString</h4>
<pre>public final void setSnString(java.lang.String s)
throws <a href="../ztex/IncompatibleFirmwareException.html" title="class in ztex">IncompatibleFirmwareException</a></pre>
<div class="block">Modifies the serial number string.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>s</code> - The new serial number string which must not be longer then 10 characters.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../ztex/IncompatibleFirmwareException.html" title="class in ztex">IncompatibleFirmwareException</a></code></dd></dl>
</li>
</ul>
<a name="toString()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>toString</h4>
<pre>public java.lang.String toString()</pre>
<div class="block">Returns a string representation if the instance.</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code>toString</code> in class <code>java.lang.Object</code></dd>
<dt><span class="strong">Returns:</span></dt><dd>a string representation if the instance.</dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../ztex/package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../deprecated-list.html">Deprecated</a></li>
<li><a href="../index-all.html">Index</a></li>
<li><a href="../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../ztex/ZtexEventHandler.html" title="class in ztex"><span class="strong">Prev Class</span></a></li>
<li><a href="../ztex/ZtexScanBus1.html" title="class in ztex"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../index.html?ztex/ZtexImgFile1.html" target="_top">Frames</a></li>
<li><a href="ZtexImgFile1.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li><a href="#fields_inherited_from_class_ztex.ImgFile">Field</a> | </li>
<li><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor_detail">Constr</a> | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>