OpenCores
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/] [Ztex1.html] - Blame information for rev 2

Details | Compare with Previous | View Log

Line No. Rev Author Line
1 2 ZTEX 
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2 
<!-- NewPage -->
3 
<html lang="de">
4 
<head>
5 
<!-- Generated by javadoc (version 1.7.0_79) on Wed Mar 22 19:20:12 CET 2017 -->
6 
<title>Ztex1</title>
7 
<meta name="date" content="2017-03-22">
8 
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
9 
</head>
10 
<body>
11 
<script type="text/javascript"><!--
12 
    if (location.href.indexOf('is-external=true') == -1) {
13 
        parent.document.title="Ztex1";
14 
    }
15 
//-->
16 
</script>
17 
<noscript>
18 
<div>JavaScript is disabled on your browser.</div>
19 
</noscript>
20 
<!-- ========= START OF TOP NAVBAR ======= -->
21 
<div class="topNav"><a name="navbar_top">
22 
<!--   -->
23 
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
24 
<!--   -->
25 
</a>
26 
<ul class="navList" title="Navigation">
27 
<li><a href="../ztex/package-summary.html">Package</a></li>
28 
<li class="navBarCell1Rev">Class</li>
29 
<li><a href="package-tree.html">Tree</a></li>
30 
<li><a href="../deprecated-list.html">Deprecated</a></li>
31 
<li><a href="../index-all.html">Index</a></li>
32 
<li><a href="../help-doc.html">Help</a></li>
33 
</ul>
34 
</div>
35 
<div class="subNav">
36 
<ul class="navList">
37 
<li><a href="../ztex/UsbException.html" title="class in ztex"><span class="strong">Prev Class</span></a></li>
38 
<li><a href="../ztex/Ztex1v1.html" title="class in ztex"><span class="strong">Next Class</span></a></li>
39 
</ul>
40 
<ul class="navList">
41 
<li><a href="../index.html?ztex/Ztex1.html" target="_top">Frames</a></li>
42 
<li><a href="Ztex1.html" target="_top">No Frames</a></li>
43 
</ul>
44 
<ul class="navList" id="allclasses_navbar_top">
45 
<li><a href="../allclasses-noframe.html">All Classes</a></li>
46 
</ul>
47 
<div>
48 
<script type="text/javascript"><!--
49 
  allClassesLink = document.getElementById("allclasses_navbar_top");
50 
  if(window==top) {
51 
    allClassesLink.style.display = "block";
52 
  }
53 
  else {
54 
    allClassesLink.style.display = "none";
55 
  }
56 
  //-->
57 
</script>
58 
</div>
59 
<div>
60 
<ul class="subNavList">
61 
<li>Summary:&nbsp;</li>
62 
<li>Nested&nbsp;|&nbsp;</li>
63 
<li><a href="#field_summary">Field</a>&nbsp;|&nbsp;</li>
64 
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
65 
<li><a href="#method_summary">Method</a></li>
66 
</ul>
67 
<ul class="subNavList">
68 
<li>Detail:&nbsp;</li>
69 
<li><a href="#field_detail">Field</a>&nbsp;|&nbsp;</li>
70 
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
71 
<li><a href="#method_detail">Method</a></li>
72 
</ul>
73 
</div>
74 
<a name="skip-navbar_top">
75 
<!--   -->
76 
</a></div>
77 
<!-- ========= END OF TOP NAVBAR ========= -->
78 
<!-- ======== START OF CLASS DATA ======== -->
79 
<div class="header">
80 
<div class="subTitle">ztex</div>
81 
<h2 title="Class Ztex1" class="title">Class Ztex1</h2>
82 
</div>
83 
<div class="contentContainer">
84 
<ul class="inheritance">
85 
<li>java.lang.Object</li>
86 
<li>
87 
<ul class="inheritance">
88 
<li>ztex.Ztex1</li>
89 
</ul>
90 
</li>
91 
</ul>
92 
<div class="description">
93 
<ul class="blockList">
94 
<li class="blockList">
95 
<dl>
96 
<dt>Direct Known Subclasses:</dt>
97 
<dd><a href="../ztex/Ztex1v1.html" title="class in ztex">Ztex1v1</a></dd>
98 
</dl>
99 
<hr>
100 
<br>
101 
<pre>public class <span class="strong">Ztex1</span>
102 
extends java.lang.Object</pre>
103 
<div class="block">This class implements the interface-independent part of the communication protocol for the interaction with the ZTEX firmware.<p>
104 
 All firmware implementations that provide the ZTEX descriptor 1 are supported.
105 
 A description of this descriptor can be found in <a href="../ztex/ZtexDevice1.html" title="class in ztex"><code>ZtexDevice1</code></a>.
106 
 <p>
107 
 The most important features of this class are the functions for uploading the firmware
108 
 and the renumeration management.
109 
 <p>
110 
 The interface dependent part of the communication protocol (currently only one is supported)
111 
 can be found in <a href="../ztex/Ztex1v1.html" title="class in ztex"><code>Ztex1v1</code></a>.</div>
112 
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../ztex/ZtexDevice1.html" title="class in ztex"><code>ZtexDevice1</code></a>,
113 
<a href="../ztex/Ztex1v1.html" title="class in ztex"><code>Ztex1v1</code></a></dd></dl>
114 
</li>
115 
</ul>
116 
</div>
117 
<div class="summary">
118 
<ul class="blockList">
119 
<li class="blockList">
120 
<!-- =========== FIELD SUMMARY =========== -->
121 
<ul class="blockList">
122 
<li class="blockList"><a name="field_summary">
123 
<!--   -->
124 
</a>
125 
<h3>Field Summary</h3>
126 
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
127 
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
128 
<tr>
129 
<th class="colFirst" scope="col">Modifier and Type</th>
130 
<th class="colLast" scope="col">Field and Description</th>
131 
</tr>
132 
<tr class="altColor">
133 
<td class="colFirst"><code>int</code></td>
134 
<td class="colLast"><code><strong><a href="../ztex/Ztex1.html#controlMsgTimeout">controlMsgTimeout</a></strong></code>
135 
<div class="block">The timeout for  control messages in ms.</div>
136 
</td>
137 
</tr>
138 
</table>
139 
</li>
140 
</ul>
141 
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
142 
<ul class="blockList">
143 
<li class="blockList"><a name="constructor_summary">
144 
<!--   -->
145 
</a>
146 
<h3>Constructor Summary</h3>
147 
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
148 
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
149 
<tr>
150 
<th class="colOne" scope="col">Constructor and Description</th>
151 
</tr>
152 
<tr class="altColor">
153 
<td class="colOne"><code><strong><a href="../ztex/Ztex1.html#Ztex1(ztex.ZtexDevice1)">Ztex1</a></strong>(<a href="../ztex/ZtexDevice1.html" title="class in ztex">ZtexDevice1</a>&nbsp;pDev)</code>
154 
<div class="block">Constructs an instance from a given device.</div>
155 
</td>
156 
</tr>
157 
</table>
158 
</li>
159 
</ul>
160 
<!-- ========== METHOD SUMMARY =========== -->
161 
<ul class="blockList">
162 
<li class="blockList"><a name="method_summary">
163 
<!--   -->
164 
</a>
165 
<h3>Method Summary</h3>
166 
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
167 
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
168 
<tr>
169 
<th class="colFirst" scope="col">Modifier and Type</th>
170 
<th class="colLast" scope="col">Method and Description</th>
171 
</tr>
172 
<tr class="altColor">
173 
<td class="colFirst"><code>static java.nio.ByteBuffer</code></td>
174 
<td class="colLast"><code><strong><a href="../ztex/Ztex1.html#allocateByteBuffer(byte[])">allocateByteBuffer</a></strong>(byte[]&nbsp;buf)</code>
175 
<div class="block">Utility function that creates a ByteBuffer from byte array.</div>
176 
</td>
177 
</tr>
178 
<tr class="rowColor">
179 
<td class="colFirst"><code>static java.nio.ByteBuffer</code></td>
180 
<td class="colLast"><code><strong><a href="../ztex/Ztex1.html#allocateByteBuffer(byte[],%20int,%20int)">allocateByteBuffer</a></strong>(byte[]&nbsp;buf,
181 
                  int&nbsp;offs,
182 
                  int&nbsp;length)</code>
183 
<div class="block">Utility function that creates a ByteBuffer from byte array.</div>
184 
</td>
185 
</tr>
186 
<tr class="altColor">
187 
<td class="colFirst"><code>int</code></td>
188 
<td class="colLast"><code><strong><a href="../ztex/Ztex1.html#bulkRead(int,%20byte[],%20int,%20long)">bulkRead</a></strong>(int&nbsp;ep,
189 
        byte[]&nbsp;buf,
190 
        int&nbsp;maxlen,
191 
        long&nbsp;timeout)</code>
192 
<div class="block">Wrapper method for LibUsb.bulkTransfer(DeviceHandle,byte,ByteBuffer,IntBuffer,long).</div>
193 
</td>
194 
</tr>
195 
<tr class="rowColor">
196 
<td class="colFirst"><code>int</code></td>
197 
<td class="colLast"><code><strong><a href="../ztex/Ztex1.html#bulkRead(int,%20java.nio.ByteBuffer,%20long)">bulkRead</a></strong>(int&nbsp;ep,
198 
        java.nio.ByteBuffer&nbsp;buffer,
199 
        long&nbsp;timeout)</code>
200 
<div class="block">Wrapper method for LibUsb.bulkTransfer(DeviceHandle,byte,ByteBuffer,IntBuffer,long).</div>
201 
</td>
202 
</tr>
203 
<tr class="altColor">
204 
<td class="colFirst"><code>int</code></td>
205 
<td class="colLast"><code><strong><a href="../ztex/Ztex1.html#bulkWrite(int,%20byte[],%20int,%20long)">bulkWrite</a></strong>(int&nbsp;ep,
206 
         byte[]&nbsp;buf,
207 
         int&nbsp;length,
208 
         long&nbsp;timeout)</code>
209 
<div class="block">Wrapper method for LibUsb.bulkTransfer(DeviceHandle,byte,ByteBuffer,IntBuffer,long).</div>
210 
</td>
211 
</tr>
212 
<tr class="rowColor">
213 
<td class="colFirst"><code>int</code></td>
214 
<td class="colLast"><code><strong><a href="../ztex/Ztex1.html#bulkWrite(int,%20java.nio.ByteBuffer,%20long)">bulkWrite</a></strong>(int&nbsp;ep,
215 
         java.nio.ByteBuffer&nbsp;buffer,
216 
         long&nbsp;timeout)</code>
217 
<div class="block">Wrapper method for ibUsb.bulkTransfer(DeviceHandle,byte,ByteBuffer,IntBuffer,long).</div>
218 
</td>
219 
</tr>
220 
<tr class="altColor">
221 
<td class="colFirst"><code>void</code></td>
222 
<td class="colLast"><code><strong><a href="../ztex/Ztex1.html#checkValid()">checkValid</a></strong>()</code>
223 
<div class="block">Checks whether ZTEX descriptor 1 is available.</div>
224 
</td>
225 
</tr>
226 
<tr class="rowColor">
227 
<td class="colFirst"><code>void</code></td>
228 
<td class="colLast"><code><strong><a href="../ztex/Ztex1.html#claimInterface(int)">claimInterface</a></strong>(int&nbsp;iface)</code>
229 
<div class="block">Claims an interface.</div>
230 
</td>
231 
</tr>
232 
<tr class="altColor">
233 
<td class="colFirst"><code><a href="../ztex/ZtexDevice1.html" title="class in ztex">ZtexDevice1</a></code></td>
234 
<td class="colLast"><code><strong><a href="../ztex/Ztex1.html#dev()">dev</a></strong>()</code>
235 
<div class="block">Returns the corresponding <a href="../ztex/ZtexDevice1.html" title="class in ztex"><code>ZtexDevice1</code></a>.</div>
236 
</td>
237 
</tr>
238 
<tr class="rowColor">
239 
<td class="colFirst"><code>void</code></td>
240 
<td class="colLast"><code><strong><a href="../ztex/Ztex1.html#dispose()">dispose</a></strong>()</code>
241 
<div class="block">This should be called if the class is not used anymore.</div>
242 
</td>
243 
</tr>
244 
<tr class="altColor">
245 
<td class="colFirst"><code>protected void</code></td>
246 
<td class="colLast"><code><strong><a href="../ztex/Ztex1.html#finalize()">finalize</a></strong>()</code>
247 
<div class="block">Releases all resources.</div>
248 
</td>
249 
</tr>
250 
<tr class="rowColor">
251 
<td class="colFirst"><code>boolean</code></td>
252 
<td class="colLast"><code><strong><a href="../ztex/Ztex1.html#getInterfaceClaimed(int)">getInterfaceClaimed</a></strong>(int&nbsp;iface)</code>
253 
<div class="block">Returns true if interface is claimed.</div>
254 
</td>
255 
</tr>
256 
<tr class="altColor">
257 
<td class="colFirst"><code>org.usb4java.DeviceHandle</code></td>
258 
<td class="colLast"><code><strong><a href="../ztex/Ztex1.html#handle()">handle</a></strong>()</code>
259 
<div class="block">Returns the USB file handle.</div>
260 
</td>
261 
</tr>
262 
<tr class="rowColor">
263 
<td class="colFirst"><code>protected void</code></td>
264 
<td class="colLast"><code><strong><a href="../ztex/Ztex1.html#init()">init</a></strong>()</code>
265 
<div class="block">Initializates the class.</div>
266 
</td>
267 
</tr>
268 
<tr class="altColor">
269 
<td class="colFirst"><code>void</code></td>
270 
<td class="colLast"><code><strong><a href="../ztex/Ztex1.html#releaseInterface(int)">releaseInterface</a></strong>(int&nbsp;iface)</code>
271 
<div class="block">Releases an interface.</div>
272 
</td>
273 
</tr>
274 
<tr class="rowColor">
275 
<td class="colFirst"><code>void</code></td>
276 
<td class="colLast"><code><strong><a href="../ztex/Ztex1.html#resetDevice(boolean)">resetDevice</a></strong>(boolean&nbsp;force)</code>
277 
<div class="block">Performs a configuration or bus reset.</div>
278 
</td>
279 
</tr>
280 
<tr class="altColor">
281 
<td class="colFirst"><code>void</code></td>
282 
<td class="colLast"><code><strong><a href="../ztex/Ztex1.html#resetEzUsb()">resetEzUsb</a></strong>()</code>
283 
<div class="block">Resets the EZ-USB and manages the renumeration process.</div>
284 
</td>
285 
</tr>
286 
<tr class="rowColor">
287 
<td class="colFirst"><code>void</code></td>
288 
<td class="colLast"><code><strong><a href="../ztex/Ztex1.html#setConfiguration(int)">setConfiguration</a></strong>(int&nbsp;config)</code>
289 
<div class="block">Sets the configuration.</div>
290 
</td>
291 
</tr>
292 
<tr class="altColor">
293 
<td class="colFirst"><code>java.lang.String</code></td>
294 
<td class="colLast"><code><strong><a href="../ztex/Ztex1.html#toString()">toString</a></strong>()</code>
295 
<div class="block">Returns a lot of useful information about the corresponding device.</div>
296 
</td>
297 
</tr>
298 
<tr class="rowColor">
299 
<td class="colFirst"><code>void</code></td>
300 
<td class="colLast"><code><strong><a href="../ztex/Ztex1.html#trySetConfiguration(int)">trySetConfiguration</a></strong>(int&nbsp;config)</code>
301 
<div class="block">Tries to set the configuration.</div>
302 
</td>
303 
</tr>
304 
<tr class="altColor">
305 
<td class="colFirst"><code>long</code></td>
306 
<td class="colLast"><code><strong><a href="../ztex/Ztex1.html#uploadFirmware(java.io.InputStream,%20java.lang.String,%20boolean)">uploadFirmware</a></strong>(java.io.InputStream&nbsp;imgIn,
307 
              java.lang.String&nbsp;name,
308 
              boolean&nbsp;force)</code>
309 
<div class="block">Uploads the firmware to the EZ-USB and manages the renumeration process.</div>
310 
</td>
311 
</tr>
312 
<tr class="rowColor">
313 
<td class="colFirst"><code>long</code></td>
314 
<td class="colLast"><code><strong><a href="../ztex/Ztex1.html#uploadFirmware(java.lang.String,%20boolean)">uploadFirmware</a></strong>(java.lang.String&nbsp;imgFileName,
315 
              boolean&nbsp;force)</code>
316 
<div class="block">Uploads the firmware to the EZ-USB and manages the renumeration process.</div>
317 
</td>
318 
</tr>
319 
<tr class="altColor">
320 
<td class="colFirst"><code>long</code></td>
321 
<td class="colLast"><code><strong><a href="../ztex/Ztex1.html#uploadFirmware(ztex.ZtexImgFile1,%20boolean)">uploadFirmware</a></strong>(<a href="../ztex/ZtexImgFile1.html" title="class in ztex">ZtexImgFile1</a>&nbsp;imgFile,
322 
              boolean&nbsp;force)</code>
323 
<div class="block">Uploads the firmware to the EZ-USB and manages the renumeration process.</div>
324 
</td>
325 
</tr>
326 
<tr class="rowColor">
327 
<td class="colFirst"><code>boolean</code></td>
328 
<td class="colLast"><code><strong><a href="../ztex/Ztex1.html#valid()">valid</a></strong>()</code>
329 
<div class="block">Returns true if ZTEX descriptor 1 is available.</div>
330 
</td>
331 
</tr>
332 
<tr class="altColor">
333 
<td class="colFirst"><code>int</code></td>
334 
<td class="colLast"><code><strong><a href="../ztex/Ztex1.html#vendorCommand(int,%20java.lang.String)">vendorCommand</a></strong>(int&nbsp;cmd,
335 
             java.lang.String&nbsp;func)</code>
336 
<div class="block">Sends a vendor command with no payload data and no setup data to Endpoint 0 of the EZ-USB device.</div>
337 
</td>
338 
</tr>
339 
<tr class="rowColor">
340 
<td class="colFirst"><code>int</code></td>
341 
<td class="colLast"><code><strong><a href="../ztex/Ztex1.html#vendorCommand(int,%20java.lang.String,%20int,%20int)">vendorCommand</a></strong>(int&nbsp;cmd,
342 
             java.lang.String&nbsp;func,
343 
             int&nbsp;value,
344 
             int&nbsp;index)</code>
345 
<div class="block">Sends a vendor command with no payload data to Endpoint 0 of the EZ-USB device.</div>
346 
</td>
347 
</tr>
348 
<tr class="altColor">
349 
<td class="colFirst"><code>int</code></td>
350 
<td class="colLast"><code><strong><a href="../ztex/Ztex1.html#vendorCommand(int,%20java.lang.String,%20int,%20int,%20byte[],%20int)">vendorCommand</a></strong>(int&nbsp;cmd,
351 
             java.lang.String&nbsp;func,
352 
             int&nbsp;value,
353 
             int&nbsp;index,
354 
             byte[]&nbsp;buf,
355 
             int&nbsp;length)</code>
356 
<div class="block">Sends a vendor command to Endpoint 0 of the EZ-USB device.</div>
357 
</td>
358 
</tr>
359 
<tr class="rowColor">
360 
<td class="colFirst"><code>int</code></td>
361 
<td class="colLast"><code><strong><a href="../ztex/Ztex1.html#vendorCommand(int,%20java.lang.String,%20int,%20int,%20java.nio.ByteBuffer)">vendorCommand</a></strong>(int&nbsp;cmd,
362 
             java.lang.String&nbsp;func,
363 
             int&nbsp;value,
364 
             int&nbsp;index,
365 
             java.nio.ByteBuffer&nbsp;buf)</code>
366 
<div class="block">Sends a vendor command to Endpoint 0 of the EZ-USB device.</div>
367 
</td>
368 
</tr>
369 
<tr class="altColor">
370 
<td class="colFirst"><code>void</code></td>
371 
<td class="colLast"><code><strong><a href="../ztex/Ztex1.html#vendorCommand2(int,%20java.lang.String,%20int,%20int,%20byte[],%20int)">vendorCommand2</a></strong>(int&nbsp;cmd,
372 
              java.lang.String&nbsp;func,
373 
              int&nbsp;value,
374 
              int&nbsp;index,
375 
              byte[]&nbsp;buf,
376 
              int&nbsp;length)</code>
377 
<div class="block">Sends a vendor command to Endpoint 0 of the EZ-USB device and throws an <a href="../ztex/UsbException.html" title="class in ztex"><code>UsbException</code></a> if not all of the payload has been sent.</div>
378 
</td>
379 
</tr>
380 
<tr class="rowColor">
381 
<td class="colFirst"><code>void</code></td>
382 
<td class="colLast"><code><strong><a href="../ztex/Ztex1.html#vendorCommand2(int,%20java.lang.String,%20int,%20int,%20java.nio.ByteBuffer)">vendorCommand2</a></strong>(int&nbsp;cmd,
383 
              java.lang.String&nbsp;func,
384 
              int&nbsp;value,
385 
              int&nbsp;index,
386 
              java.nio.ByteBuffer&nbsp;buf)</code>
387 
<div class="block">Sends a vendor command to Endpoint 0 of the EZ-USB device and throws an <a href="../ztex/UsbException.html" title="class in ztex"><code>UsbException</code></a> if not all of the payload has been sent.</div>
388 
</td>
389 
</tr>
390 
<tr class="altColor">
391 
<td class="colFirst"><code>int</code></td>
392 
<td class="colLast"><code><strong><a href="../ztex/Ztex1.html#vendorRequest(int,%20java.lang.String,%20byte[],%20int)">vendorRequest</a></strong>(int&nbsp;cmd,
393 
             java.lang.String&nbsp;func,
394 
             byte[]&nbsp;buf,
395 
             int&nbsp;maxlen)</code>
396 
<div class="block">Sends a vendor request to Endpoint 0 of the EZ-USB device.</div>
397 
</td>
398 
</tr>
399 
<tr class="rowColor">
400 
<td class="colFirst"><code>int</code></td>
401 
<td class="colLast"><code><strong><a href="../ztex/Ztex1.html#vendorRequest(int,%20java.lang.String,%20java.nio.ByteBuffer)">vendorRequest</a></strong>(int&nbsp;cmd,
402 
             java.lang.String&nbsp;func,
403 
             java.nio.ByteBuffer&nbsp;buf)</code>
404 
<div class="block">Sends a vendor request to Endpoint 0 of the EZ-USB device.</div>
405 
</td>
406 
</tr>
407 
<tr class="altColor">
408 
<td class="colFirst"><code>int</code></td>
409 
<td class="colLast"><code><strong><a href="../ztex/Ztex1.html#vendorRequest(int,%20java.lang.String,%20int,%20int,%20byte[],%20int)">vendorRequest</a></strong>(int&nbsp;cmd,
410 
             java.lang.String&nbsp;func,
411 
             int&nbsp;value,
412 
             int&nbsp;index,
413 
             byte[]&nbsp;buf,
414 
             int&nbsp;maxlen)</code>
415 
<div class="block">Sends a vendor request to Endpoint 0 of the EZ-USB device.</div>
416 
</td>
417 
</tr>
418 
<tr class="rowColor">
419 
<td class="colFirst"><code>int</code></td>
420 
<td class="colLast"><code><strong><a href="../ztex/Ztex1.html#vendorRequest(int,%20java.lang.String,%20int,%20int,%20java.nio.ByteBuffer)">vendorRequest</a></strong>(int&nbsp;cmd,
421 
             java.lang.String&nbsp;func,
422 
             int&nbsp;value,
423 
             int&nbsp;index,
424 
             java.nio.ByteBuffer&nbsp;buf)</code>
425 
<div class="block">Sends a vendor request to Endpoint 0 of the EZ-USB device.</div>
426 
</td>
427 
</tr>
428 
<tr class="altColor">
429 
<td class="colFirst"><code>void</code></td>
430 
<td class="colLast"><code><strong><a href="../ztex/Ztex1.html#vendorRequest2(int,%20java.lang.String,%20byte[],%20int)">vendorRequest2</a></strong>(int&nbsp;cmd,
431 
              java.lang.String&nbsp;func,
432 
              byte[]&nbsp;buf,
433 
              int&nbsp;maxlen)</code>
434 
<div class="block">Sends a vendor request to Endpoint 0 of the EZ-USB device and throws an <a href="../ztex/UsbException.html" title="class in ztex"><code>UsbException</code></a> if not all of the payload has been received.</div>
435 
</td>
436 
</tr>
437 
<tr class="rowColor">
438 
<td class="colFirst"><code>void</code></td>
439 
<td class="colLast"><code><strong><a href="../ztex/Ztex1.html#vendorRequest2(int,%20java.lang.String,%20java.nio.ByteBuffer)">vendorRequest2</a></strong>(int&nbsp;cmd,
440 
              java.lang.String&nbsp;func,
441 
              java.nio.ByteBuffer&nbsp;buf)</code>
442 
<div class="block">Sends a vendor request to Endpoint 0 of the EZ-USB device and throws an <a href="../ztex/UsbException.html" title="class in ztex"><code>UsbException</code></a> if not all of the payload has been received.</div>
443 
</td>
444 
</tr>
445 
<tr class="altColor">
446 
<td class="colFirst"><code>void</code></td>
447 
<td class="colLast"><code><strong><a href="../ztex/Ztex1.html#vendorRequest2(int,%20java.lang.String,%20int,%20int,%20byte[],%20int)">vendorRequest2</a></strong>(int&nbsp;cmd,
448 
              java.lang.String&nbsp;func,
449 
              int&nbsp;value,
450 
              int&nbsp;index,
451 
              byte[]&nbsp;buf,
452 
              int&nbsp;maxlen)</code>
453 
<div class="block">Sends a vendor request to Endpoint 0 of the EZ-USB device and throws an <a href="../ztex/UsbException.html" title="class in ztex"><code>UsbException</code></a> if not all of the payload has been received.</div>
454 
</td>
455 
</tr>
456 
<tr class="rowColor">
457 
<td class="colFirst"><code>void</code></td>
458 
<td class="colLast"><code><strong><a href="../ztex/Ztex1.html#vendorRequest2(int,%20java.lang.String,%20int,%20int,%20java.nio.ByteBuffer)">vendorRequest2</a></strong>(int&nbsp;cmd,
459 
              java.lang.String&nbsp;func,
460 
              int&nbsp;value,
461 
              int&nbsp;index,
462 
              java.nio.ByteBuffer&nbsp;buf)</code>
463 
<div class="block">Sends a vendor request to Endpoint 0 of the EZ-USB device and throws an <a href="../ztex/UsbException.html" title="class in ztex"><code>UsbException</code></a> if not all of the payload has been received.</div>
464 
</td>
465 
</tr>
466 
</table>
467 
<ul class="blockList">
468 
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
469 
<!--   -->
470 
</a>
471 
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
472 
<code>clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li>
473 
</ul>
474 
</li>
475 
</ul>
476 
</li>
477 
</ul>
478 
</div>
479 
<div class="details">
480 
<ul class="blockList">
481 
<li class="blockList">
482 
<!-- ============ FIELD DETAIL =========== -->
483 
<ul class="blockList">
484 
<li class="blockList"><a name="field_detail">
485 
<!--   -->
486 
</a>
487 
<h3>Field Detail</h3>
488 
<a name="controlMsgTimeout">
489 
<!--   -->
490 
</a>
491 
<ul class="blockListLast">
492 
<li class="blockList">
493 
<h4>controlMsgTimeout</h4>
494 
<pre>public&nbsp;int controlMsgTimeout</pre>
495 
<div class="block">The timeout for  control messages in ms.</div>
496 
</li>
497 
</ul>
498 
</li>
499 
</ul>
500 
<!-- ========= CONSTRUCTOR DETAIL ======== -->
501 
<ul class="blockList">
502 
<li class="blockList"><a name="constructor_detail">
503 
<!--   -->
504 
</a>
505 
<h3>Constructor Detail</h3>
506 
<a name="Ztex1(ztex.ZtexDevice1)">
507 
<!--   -->
508 
</a>
509 
<ul class="blockListLast">
510 
<li class="blockList">
511 
<h4>Ztex1</h4>
512 
<pre>public&nbsp;Ztex1(<a href="../ztex/ZtexDevice1.html" title="class in ztex">ZtexDevice1</a>&nbsp;pDev)
513 
      throws <a href="../ztex/UsbException.html" title="class in ztex">UsbException</a></pre>
514 
<div class="block">Constructs an instance from a given device.</div>
515 
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>pDev</code> - The given device.</dd>
516 
<dt><span class="strong">Throws:</span></dt>
517 
<dd><code><a href="../ztex/UsbException.html" title="class in ztex">UsbException</a></code> - if an communication error occurred.</dd></dl>
518 
</li>
519 
</ul>
520 
</li>
521 
</ul>
522 
<!-- ============ METHOD DETAIL ========== -->
523 
<ul class="blockList">
524 
<li class="blockList"><a name="method_detail">
525 
<!--   -->
526 
</a>
527 
<h3>Method Detail</h3>
528 
<a name="init()">
529 
<!--   -->
530 
</a>
531 
<ul class="blockList">
532 
<li class="blockList">
533 
<h4>init</h4>
534 
<pre>protected&nbsp;void&nbsp;init()
535 
             throws <a href="../ztex/UsbException.html" title="class in ztex">UsbException</a></pre>
536 
<div class="block">Initializates the class.</div>
537 
<dl><dt><span class="strong">Throws:</span></dt>
538 
<dd><code><a href="../ztex/UsbException.html" title="class in ztex">UsbException</a></code> - if an communication error occurred.</dd></dl>
539 
</li>
540 
</ul>
541 
<a name="dispose()">
542 
<!--   -->
543 
</a>
544 
<ul class="blockList">
545 
<li class="blockList">
546 
<h4>dispose</h4>
547 
<pre>public&nbsp;void&nbsp;dispose()</pre>
548 
<div class="block">This should be called if the class is not used anymore.
549 
 It closes the USB connection and releases all resources</div>
550 
</li>
551 
</ul>
552 
<a name="finalize()">
553 
<!--   -->
554 
</a>
555 
<ul class="blockList">
556 
<li class="blockList">
557 
<h4>finalize</h4>
558 
<pre>protected&nbsp;void&nbsp;finalize()
559 
                 throws java.lang.Throwable</pre>
560 
<div class="block">Releases all resources.</div>
561 
<dl>
562 
<dt><strong>Overrides:</strong></dt>
563 
<dd><code>finalize</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
564 
<dt><span class="strong">Throws:</span></dt>
565 
<dd><code>java.lang.Throwable</code></dd></dl>
566 
</li>
567 
</ul>
568 
<a name="handle()">
569 
<!--   -->
570 
</a>
571 
<ul class="blockList">
572 
<li class="blockList">
573 
<h4>handle</h4>
574 
<pre>public final&nbsp;org.usb4java.DeviceHandle&nbsp;handle()</pre>
575 
<div class="block">Returns the USB file handle.</div>
576 
<dl><dt><span class="strong">Returns:</span></dt><dd>the USB file handle.</dd></dl>
577 
</li>
578 
</ul>
579 
<a name="dev()">
580 
<!--   -->
581 
</a>
582 
<ul class="blockList">
583 
<li class="blockList">
584 
<h4>dev</h4>
585 
<pre>public final&nbsp;<a href="../ztex/ZtexDevice1.html" title="class in ztex">ZtexDevice1</a>&nbsp;dev()</pre>
586 
<div class="block">Returns the corresponding <a href="../ztex/ZtexDevice1.html" title="class in ztex"><code>ZtexDevice1</code></a>.</div>
587 
<dl><dt><span class="strong">Returns:</span></dt><dd>the corresponding <a href="../ztex/ZtexDevice1.html" title="class in ztex"><code>ZtexDevice1</code></a>.</dd></dl>
588 
</li>
589 
</ul>
590 
<a name="valid()">
591 
<!--   -->
592 
</a>
593 
<ul class="blockList">
594 
<li class="blockList">
595 
<h4>valid</h4>
596 
<pre>public&nbsp;boolean&nbsp;valid()</pre>
597 
<div class="block">Returns true if ZTEX descriptor 1 is available.</div>
598 
<dl><dt><span class="strong">Returns:</span></dt><dd>true if ZTEX descriptor 1 is available.</dd></dl>
599 
</li>
600 
</ul>
601 
<a name="checkValid()">
602 
<!--   -->
603 
</a>
604 
<ul class="blockList">
605 
<li class="blockList">
606 
<h4>checkValid</h4>
607 
<pre>public&nbsp;void&nbsp;checkValid()
608 
                throws <a href="../ztex/InvalidFirmwareException.html" title="class in ztex">InvalidFirmwareException</a></pre>
609 
<div class="block">Checks whether ZTEX descriptor 1 is available.</div>
610 
<dl><dt><span class="strong">Throws:</span></dt>
611 
<dd><code><a href="../ztex/InvalidFirmwareException.html" title="class in ztex">InvalidFirmwareException</a></code> - if ZTEX descriptor 1 is not available.</dd></dl>
612 
</li>
613 
</ul>
614 
<a name="vendorCommand(int, java.lang.String, int, int, java.nio.ByteBuffer)">
615 
<!--   -->
616 
</a>
617 
<ul class="blockList">
618 
<li class="blockList">
619 
<h4>vendorCommand</h4>
620 
<pre>public&nbsp;int&nbsp;vendorCommand(int&nbsp;cmd,
621 
                java.lang.String&nbsp;func,
622 
                int&nbsp;value,
623 
                int&nbsp;index,
624 
                java.nio.ByteBuffer&nbsp;buf)
625 
                  throws <a href="../ztex/UsbException.html" title="class in ztex">UsbException</a></pre>
626 
<div class="block">Sends a vendor command to Endpoint 0 of the EZ-USB device.
627 
 The command may be send multiple times until the <a href="../ztex/Ztex1.html#controlMsgTimeout"><code>controlMsgTimeout</code></a> is reached.</div>
628 
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>cmd</code> - The command number (0..255).</dd><dd><code>func</code> - The name of the command. This string is used for the generation of error messages.</dd><dd><code>value</code> - The value (0..65535), i.e bytes 2 and 3 of the setup data.</dd><dd><code>index</code> - The index (0..65535), i.e. bytes 4 and 5 of the setup data.</dd><dd><code>buf</code> - The payload data buffer. The full buffer is sent, i.e. transfer size is equal to buffer capacity.</dd>
629 
<dt><span class="strong">Returns:</span></dt><dd>the number of bytes sent.</dd>
630 
<dt><span class="strong">Throws:</span></dt>
631 
<dd><code><a href="../ztex/UsbException.html" title="class in ztex">UsbException</a></code> - if a communication error occurs.</dd></dl>
632 
</li>
633 
</ul>
634 
<a name="vendorCommand(int, java.lang.String, int, int, byte[], int)">
635 
<!--   -->
636 
</a>
637 
<ul class="blockList">
638 
<li class="blockList">
639 
<h4>vendorCommand</h4>
640 
<pre>public&nbsp;int&nbsp;vendorCommand(int&nbsp;cmd,
641 
                java.lang.String&nbsp;func,
642 
                int&nbsp;value,
643 
                int&nbsp;index,
644 
                byte[]&nbsp;buf,
645 
                int&nbsp;length)
646 
                  throws <a href="../ztex/UsbException.html" title="class in ztex">UsbException</a></pre>
647 
<div class="block">Sends a vendor command to Endpoint 0 of the EZ-USB device.
648 
 The command may be send multiple times until the <a href="../ztex/Ztex1.html#controlMsgTimeout"><code>controlMsgTimeout</code></a> is reached.</div>
649 
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>cmd</code> - The command number (0..255).</dd><dd><code>func</code> - The name of the command. This string is used for the generation of error messages.</dd><dd><code>value</code> - The value (0..65535), i.e bytes 2 and 3 of the setup data.</dd><dd><code>index</code> - The index (0..65535), i.e. bytes 4 and 5 of the setup data.</dd><dd><code>length</code> - The size of the payload data (0..65535), i.e. bytes 6 and 7 of the setup data.</dd><dd><code>buf</code> - The payload data buffer.</dd>
650 
<dt><span class="strong">Returns:</span></dt><dd>the number of bytes sent.</dd>
651 
<dt><span class="strong">Throws:</span></dt>
652 
<dd><code><a href="../ztex/UsbException.html" title="class in ztex">UsbException</a></code> - if a communication error occurs.</dd></dl>
653 
</li>
654 
</ul>
655 
<a name="vendorCommand(int, java.lang.String, int, int)">
656 
<!--   -->
657 
</a>
658 
<ul class="blockList">
659 
<li class="blockList">
660 
<h4>vendorCommand</h4>
661 
<pre>public&nbsp;int&nbsp;vendorCommand(int&nbsp;cmd,
662 
                java.lang.String&nbsp;func,
663 
                int&nbsp;value,
664 
                int&nbsp;index)
665 
                  throws <a href="../ztex/UsbException.html" title="class in ztex">UsbException</a></pre>
666 
<div class="block">Sends a vendor command with no payload data to Endpoint 0 of the EZ-USB device.
667 
 The command may be send multiple times until the <a href="../ztex/Ztex1.html#controlMsgTimeout"><code>controlMsgTimeout</code></a> is reached.</div>
668 
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>cmd</code> - The command number (0..255).</dd><dd><code>func</code> - The name of the command. This string is used for the generation of error messages.</dd><dd><code>value</code> - The value (0..65535), i.e bytes 2 and 3 of the setup data.</dd><dd><code>index</code> - The index (0..65535), i.e. bytes 4 and 5 of the setup data.</dd>
669 
<dt><span class="strong">Returns:</span></dt><dd>the number of bytes sent.</dd>
670 
<dt><span class="strong">Throws:</span></dt>
671 
<dd><code><a href="../ztex/UsbException.html" title="class in ztex">UsbException</a></code> - if a communication error occurs.</dd></dl>
672 
</li>
673 
</ul>
674 
<a name="vendorCommand(int, java.lang.String)">
675 
<!--   -->
676 
</a>
677 
<ul class="blockList">
678 
<li class="blockList">
679 
<h4>vendorCommand</h4>
680 
<pre>public&nbsp;int&nbsp;vendorCommand(int&nbsp;cmd,
681 
                java.lang.String&nbsp;func)
682 
                  throws <a href="../ztex/UsbException.html" title="class in ztex">UsbException</a></pre>
683 
<div class="block">Sends a vendor command with no payload data and no setup data to Endpoint 0 of the EZ-USB device.
684 
 The command may be send multiple times until the <a href="../ztex/Ztex1.html#controlMsgTimeout"><code>controlMsgTimeout</code></a> is reached.</div>
685 
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>cmd</code> - The command number (0..255).</dd><dd><code>func</code> - The name of the command. This string is used for the generation of error messages.</dd>
686 
<dt><span class="strong">Returns:</span></dt><dd>the number of bytes sent.</dd>
687 
<dt><span class="strong">Throws:</span></dt>
688 
<dd><code><a href="../ztex/UsbException.html" title="class in ztex">UsbException</a></code> - if a communication error occurs.</dd></dl>
689 
</li>
690 
</ul>
691 
<a name="vendorRequest(int, java.lang.String, int, int, java.nio.ByteBuffer)">
692 
<!--   -->
693 
</a>
694 
<ul class="blockList">
695 
<li class="blockList">
696 
<h4>vendorRequest</h4>
697 
<pre>public&nbsp;int&nbsp;vendorRequest(int&nbsp;cmd,
698 
                java.lang.String&nbsp;func,
699 
                int&nbsp;value,
700 
                int&nbsp;index,
701 
                java.nio.ByteBuffer&nbsp;buf)
702 
                  throws <a href="../ztex/UsbException.html" title="class in ztex">UsbException</a></pre>
703 
<div class="block">Sends a vendor request to Endpoint 0 of the EZ-USB device.
704 
 The request may be send multiple times until the <a href="../ztex/Ztex1.html#controlMsgTimeout"><code>controlMsgTimeout</code></a> is reached.</div>
705 
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>cmd</code> - The request number (0..255).</dd><dd><code>func</code> - The name of the request. This string is used for the generation of error messages.</dd><dd><code>value</code> - The value (0..65535), i.e bytes 2 and 3 of the setup data.</dd><dd><code>index</code> - The index (0..65535), i.e. bytes 4 and 5 of the setup data.</dd><dd><code>buf</code> - The payload data buffer. Buffer capacity determines the length of the transfer.</dd>
706 
<dt><span class="strong">Returns:</span></dt><dd>the number of bytes received.</dd>
707 
<dt><span class="strong">Throws:</span></dt>
708 
<dd><code><a href="../ztex/UsbException.html" title="class in ztex">UsbException</a></code> - if a communication error occurs.</dd></dl>
709 
</li>
710 
</ul>
711 
<a name="vendorRequest(int, java.lang.String, int, int, byte[], int)">
712 
<!--   -->
713 
</a>
714 
<ul class="blockList">
715 
<li class="blockList">
716 
<h4>vendorRequest</h4>
717 
<pre>public&nbsp;int&nbsp;vendorRequest(int&nbsp;cmd,
718 
                java.lang.String&nbsp;func,
719 
                int&nbsp;value,
720 
                int&nbsp;index,
721 
                byte[]&nbsp;buf,
722 
                int&nbsp;maxlen)
723 
                  throws <a href="../ztex/UsbException.html" title="class in ztex">UsbException</a></pre>
724 
<div class="block">Sends a vendor request to Endpoint 0 of the EZ-USB device.
725 
 The request may be send multiple times until the <a href="../ztex/Ztex1.html#controlMsgTimeout"><code>controlMsgTimeout</code></a> is reached.</div>
726 
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>cmd</code> - The request number (0..255).</dd><dd><code>func</code> - The name of the request. This string is used for the generation of error messages.</dd><dd><code>value</code> - The value (0..65535), i.e bytes 2 and 3 of the setup data.</dd><dd><code>index</code> - The index (0..65535), i.e. bytes 4 and 5 of the setup data.</dd><dd><code>maxlen</code> - The size of the requested payload data (0..65535), i.e. bytes 6 and 7 of the setup data.</dd><dd><code>buf</code> - The payload data buffer.</dd>
727 
<dt><span class="strong">Returns:</span></dt><dd>the number of bytes received.</dd>
728 
<dt><span class="strong">Throws:</span></dt>
729 
<dd><code><a href="../ztex/UsbException.html" title="class in ztex">UsbException</a></code> - if a communication error occurs.</dd></dl>
730 
</li>
731 
</ul>
732 
<a name="vendorRequest(int, java.lang.String, java.nio.ByteBuffer)">
733 
<!--   -->
734 
</a>
735 
<ul class="blockList">
736 
<li class="blockList">
737 
<h4>vendorRequest</h4>
738 
<pre>public&nbsp;int&nbsp;vendorRequest(int&nbsp;cmd,
739 
                java.lang.String&nbsp;func,
740 
                java.nio.ByteBuffer&nbsp;buf)
741 
                  throws <a href="../ztex/UsbException.html" title="class in ztex">UsbException</a></pre>
742 
<div class="block">Sends a vendor request to Endpoint 0 of the EZ-USB device.
743 
 The request may be send multiple times until the <a href="../ztex/Ztex1.html#controlMsgTimeout"><code>controlMsgTimeout</code></a> is reached.</div>
744 
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>cmd</code> - The request number (0..255).</dd><dd><code>func</code> - The name of the request. This string is used for the generation of error messages.</dd><dd><code>buf</code> - The payload data buffer.</dd>
745 
<dt><span class="strong">Returns:</span></dt><dd>the number of bytes sent.</dd>
746 
<dt><span class="strong">Throws:</span></dt>
747 
<dd><code><a href="../ztex/UsbException.html" title="class in ztex">UsbException</a></code> - if a communication error occurs.</dd></dl>
748 
</li>
749 
</ul>
750 
<a name="vendorRequest(int, java.lang.String, byte[], int)">
751 
<!--   -->
752 
</a>
753 
<ul class="blockList">
754 
<li class="blockList">
755 
<h4>vendorRequest</h4>
756 
<pre>public&nbsp;int&nbsp;vendorRequest(int&nbsp;cmd,
757 
                java.lang.String&nbsp;func,
758 
                byte[]&nbsp;buf,
759 
                int&nbsp;maxlen)
760 
                  throws <a href="../ztex/UsbException.html" title="class in ztex">UsbException</a></pre>
761 
<div class="block">Sends a vendor request to Endpoint 0 of the EZ-USB device.
762 
 The request may be send multiple times until the <a href="../ztex/Ztex1.html#controlMsgTimeout"><code>controlMsgTimeout</code></a> is reached.</div>
763 
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>cmd</code> - The request number (0..255).</dd><dd><code>func</code> - The name of the request. This string is used for the generation of error messages.</dd><dd><code>maxlen</code> - The size of the requested payload data (0..65535), i.e. bytes 6 and 7 of the setup data.</dd><dd><code>buf</code> - The payload data buffer.</dd>
764 
<dt><span class="strong">Returns:</span></dt><dd>the number of bytes sent.</dd>
765 
<dt><span class="strong">Throws:</span></dt>
766 
<dd><code><a href="../ztex/UsbException.html" title="class in ztex">UsbException</a></code> - if a communication error occurs.</dd></dl>
767 
</li>
768 
</ul>
769 
<a name="vendorCommand2(int, java.lang.String, int, int, java.nio.ByteBuffer)">
770 
<!--   -->
771 
</a>
772 
<ul class="blockList">
773 
<li class="blockList">
774 
<h4>vendorCommand2</h4>
775 
<pre>public&nbsp;void&nbsp;vendorCommand2(int&nbsp;cmd,
776 
                  java.lang.String&nbsp;func,
777 
                  int&nbsp;value,
778 
                  int&nbsp;index,
779 
                  java.nio.ByteBuffer&nbsp;buf)
780 
                    throws <a href="../ztex/UsbException.html" title="class in ztex">UsbException</a></pre>
781 
<div class="block">Sends a vendor command to Endpoint 0 of the EZ-USB device and throws an <a href="../ztex/UsbException.html" title="class in ztex"><code>UsbException</code></a> if not all of the payload has been sent.
782 
 The command may be send multiple times until the <a href="../ztex/Ztex1.html#controlMsgTimeout"><code>controlMsgTimeout</code></a> is reached.</div>
783 
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>cmd</code> - The command number (0..255).</dd><dd><code>func</code> - The name of the command. This string is used for the generation of error messages.</dd><dd><code>value</code> - The value (0..65535), i.e bytes 2 and 3 of the setup data.</dd><dd><code>index</code> - The index (0..65535), i.e. bytes 4 and 5 of the setup data.</dd><dd><code>buf</code> - The payload data buffer. The full buffer is sent, i.e. transfer size is equal to buffer capacity.</dd>
784 
<dt><span class="strong">Throws:</span></dt>
785 
<dd><code><a href="../ztex/UsbException.html" title="class in ztex">UsbException</a></code> - if a communication error occurs or if not all of the payload has been sent.</dd></dl>
786 
</li>
787 
</ul>
788 
<a name="vendorCommand2(int, java.lang.String, int, int, byte[], int)">
789 
<!--   -->
790 
</a>
791 
<ul class="blockList">
792 
<li class="blockList">
793 
<h4>vendorCommand2</h4>
794 
<pre>public&nbsp;void&nbsp;vendorCommand2(int&nbsp;cmd,
795 
                  java.lang.String&nbsp;func,
796 
                  int&nbsp;value,
797 
                  int&nbsp;index,
798 
                  byte[]&nbsp;buf,
799 
                  int&nbsp;length)
800 
                    throws <a href="../ztex/UsbException.html" title="class in ztex">UsbException</a></pre>
801 
<div class="block">Sends a vendor command to Endpoint 0 of the EZ-USB device and throws an <a href="../ztex/UsbException.html" title="class in ztex"><code>UsbException</code></a> if not all of the payload has been sent.
802 
 The command may be send multiple times until the <a href="../ztex/Ztex1.html#controlMsgTimeout"><code>controlMsgTimeout</code></a> is reached.</div>
803 
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>cmd</code> - The command number (0..255).</dd><dd><code>func</code> - The name of the command. This string is used for the generation of error messages.</dd><dd><code>value</code> - The value (0..65535), i.e bytes 2 and 3 of the setup data.</dd><dd><code>index</code> - The index (0..65535), i.e. bytes 4 and 5 of the setup data.</dd><dd><code>length</code> - The size of the payload data (0..65535), i.e. bytes 6 and 7 of the setup data.</dd><dd><code>buf</code> - The payload data buffer.</dd>
804 
<dt><span class="strong">Throws:</span></dt>
805 
<dd><code><a href="../ztex/UsbException.html" title="class in ztex">UsbException</a></code> - if a communication error occurs or if not all of the payload has been sent.</dd></dl>
806 
</li>
807 
</ul>
808 
<a name="vendorRequest2(int, java.lang.String, int, int, java.nio.ByteBuffer)">
809 
<!--   -->
810 
</a>
811 
<ul class="blockList">
812 
<li class="blockList">
813 
<h4>vendorRequest2</h4>
814 
<pre>public&nbsp;void&nbsp;vendorRequest2(int&nbsp;cmd,
815 
                  java.lang.String&nbsp;func,
816 
                  int&nbsp;value,
817 
                  int&nbsp;index,
818 
                  java.nio.ByteBuffer&nbsp;buf)
819 
                    throws <a href="../ztex/UsbException.html" title="class in ztex">UsbException</a></pre>
820 
<div class="block">Sends a vendor request to Endpoint 0 of the EZ-USB device and throws an <a href="../ztex/UsbException.html" title="class in ztex"><code>UsbException</code></a> if not all of the payload has been received.
821 
 The request may be send multiple times until the <a href="../ztex/Ztex1.html#controlMsgTimeout"><code>controlMsgTimeout</code></a> is reached.</div>
822 
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>cmd</code> - The request number (0..255).</dd><dd><code>func</code> - The name of the request. This string is used for the generation of error messages.</dd><dd><code>value</code> - The value (0..65535), i.e bytes 2 and 3 of the setup data.</dd><dd><code>index</code> - The index (0..65535), i.e. bytes 4 and 5 of the setup data.</dd><dd><code>buf</code> - The payload data buffer. Buffer capacity determines the length of the transfer.</dd>
823 
<dt><span class="strong">Throws:</span></dt>
824 
<dd><code><a href="../ztex/UsbException.html" title="class in ztex">UsbException</a></code> - if a communication error occurs or not all of the payload has been received.</dd></dl>
825 
</li>
826 
</ul>
827 
<a name="vendorRequest2(int, java.lang.String, java.nio.ByteBuffer)">
828 
<!--   -->
829 
</a>
830 
<ul class="blockList">
831 
<li class="blockList">
832 
<h4>vendorRequest2</h4>
833 
<pre>public&nbsp;void&nbsp;vendorRequest2(int&nbsp;cmd,
834 
                  java.lang.String&nbsp;func,
835 
                  java.nio.ByteBuffer&nbsp;buf)
836 
                    throws <a href="../ztex/UsbException.html" title="class in ztex">UsbException</a></pre>
837 
<div class="block">Sends a vendor request to Endpoint 0 of the EZ-USB device and throws an <a href="../ztex/UsbException.html" title="class in ztex"><code>UsbException</code></a> if not all of the payload has been received.
838 
 The request may be send multiple times until the <a href="../ztex/Ztex1.html#controlMsgTimeout"><code>controlMsgTimeout</code></a> is reached.</div>
839 
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>cmd</code> - The request number (0..255).</dd><dd><code>func</code> - The name of the request. This string is used for the generation of error messages.</dd><dd><code>buf</code> - The payload data buffer.</dd>
840 
<dt><span class="strong">Throws:</span></dt>
841 
<dd><code><a href="../ztex/UsbException.html" title="class in ztex">UsbException</a></code> - if a communication error occurs or not all of the payload has been received.</dd></dl>
842 
</li>
843 
</ul>
844 
<a name="vendorRequest2(int, java.lang.String, int, int, byte[], int)">
845 
<!--   -->
846 
</a>
847 
<ul class="blockList">
848 
<li class="blockList">
849 
<h4>vendorRequest2</h4>
850 
<pre>public&nbsp;void&nbsp;vendorRequest2(int&nbsp;cmd,
851 
                  java.lang.String&nbsp;func,
852 
                  int&nbsp;value,
853 
                  int&nbsp;index,
854 
                  byte[]&nbsp;buf,
855 
                  int&nbsp;maxlen)
856 
                    throws <a href="../ztex/UsbException.html" title="class in ztex">UsbException</a></pre>
857 
<div class="block">Sends a vendor request to Endpoint 0 of the EZ-USB device and throws an <a href="../ztex/UsbException.html" title="class in ztex"><code>UsbException</code></a> if not all of the payload has been received.
858 
 The request may be send multiple times until the <a href="../ztex/Ztex1.html#controlMsgTimeout"><code>controlMsgTimeout</code></a> is reached.</div>
859 
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>cmd</code> - The request number (0..255).</dd><dd><code>func</code> - The name of the request. This string is used for the generation of error messages.</dd><dd><code>value</code> - The value (0..65535), i.e bytes 2 and 3 of the setup data.</dd><dd><code>index</code> - The index (0..65535), i.e. bytes 4 and 5 of the setup data.</dd><dd><code>maxlen</code> - The size of the requested payload data (0..65535), i.e. bytes 6 and 7 of the setup data.</dd><dd><code>buf</code> - The payload data buffer.</dd>
860 
<dt><span class="strong">Throws:</span></dt>
861 
<dd><code><a href="../ztex/UsbException.html" title="class in ztex">UsbException</a></code> - if a communication error occurs or not all of the payload has been received.</dd></dl>
862 
</li>
863 
</ul>
864 
<a name="vendorRequest2(int, java.lang.String, byte[], int)">
865 
<!--   -->
866 
</a>
867 
<ul class="blockList">
868 
<li class="blockList">
869 
<h4>vendorRequest2</h4>
870 
<pre>public&nbsp;void&nbsp;vendorRequest2(int&nbsp;cmd,
871 
                  java.lang.String&nbsp;func,
872 
                  byte[]&nbsp;buf,
873 
                  int&nbsp;maxlen)
874 
                    throws <a href="../ztex/UsbException.html" title="class in ztex">UsbException</a></pre>
875 
<div class="block">Sends a vendor request to Endpoint 0 of the EZ-USB device and throws an <a href="../ztex/UsbException.html" title="class in ztex"><code>UsbException</code></a> if not all of the payload has been received.
876 
 The request may be send multiple times until the <a href="../ztex/Ztex1.html#controlMsgTimeout"><code>controlMsgTimeout</code></a> is reached.</div>
877 
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>cmd</code> - The request number (0..255).</dd><dd><code>func</code> - The name of the request. This string is used for the generation of error messages.</dd><dd><code>maxlen</code> - The size of the requested payload data (0..65535), i.e. bytes 6 and 7 of the setup data.</dd><dd><code>buf</code> - The payload data buffer.</dd>
878 
<dt><span class="strong">Throws:</span></dt>
879 
<dd><code><a href="../ztex/UsbException.html" title="class in ztex">UsbException</a></code> - if a communication error occurs or not all of the payload has been received.</dd></dl>
880 
</li>
881 
</ul>
882 
<a name="bulkWrite(int, java.nio.ByteBuffer, long)">
883 
<!--   -->
884 
</a>
885 
<ul class="blockList">
886 
<li class="blockList">
887 
<h4>bulkWrite</h4>
888 
<pre>public&nbsp;int&nbsp;bulkWrite(int&nbsp;ep,
889 
            java.nio.ByteBuffer&nbsp;buffer,
890 
            long&nbsp;timeout)</pre>
891 
<div class="block">Wrapper method for ibUsb.bulkTransfer(DeviceHandle,byte,ByteBuffer,IntBuffer,long).</div>
892 
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>ep</code> - The endpoint number.</dd><dd><code>buffer</code> - The payload data buffer. The whole buffer is transferred, i.e. transfer legth is equal to buffer capacity</dd><dd><code>timeout</code> - The timeout in ms</dd>
893 
<dt><span class="strong">Returns:</span></dt><dd>The error code (<0) if an error occurred, otherwise the amount of transferred date</dd></dl>
894 
</li>
895 
</ul>
896 
<a name="bulkWrite(int, byte[], int, long)">
897 
<!--   -->
898 
</a>
899 
<ul class="blockList">
900 
<li class="blockList">
901 
<h4>bulkWrite</h4>
902 
<pre>public&nbsp;int&nbsp;bulkWrite(int&nbsp;ep,
903 
            byte[]&nbsp;buf,
904 
            int&nbsp;length,
905 
            long&nbsp;timeout)</pre>
906 
<div class="block">Wrapper method for LibUsb.bulkTransfer(DeviceHandle,byte,ByteBuffer,IntBuffer,long).</div>
907 
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>ep</code> - The endpoint number.</dd><dd><code>buf</code> - The payload data buffer.</dd><dd><code>length</code> - The size of the payload data</dd><dd><code>timeout</code> - The timeout in ms</dd>
908 
<dt><span class="strong">Returns:</span></dt><dd>The error code (<0) if an error occurred, otherwise the amount of transferred date</dd></dl>
909 
</li>
910 
</ul>
911 
<a name="bulkRead(int, java.nio.ByteBuffer, long)">
912 
<!--   -->
913 
</a>
914 
<ul class="blockList">
915 
<li class="blockList">
916 
<h4>bulkRead</h4>
917 
<pre>public&nbsp;int&nbsp;bulkRead(int&nbsp;ep,
918 
           java.nio.ByteBuffer&nbsp;buffer,
919 
           long&nbsp;timeout)</pre>
920 
<div class="block">Wrapper method for LibUsb.bulkTransfer(DeviceHandle,byte,ByteBuffer,IntBuffer,long).</div>
921 
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>ep</code> - The endpoint number.</dd><dd><code>buffer</code> - The payload data buffer. The transfer length is determined by buffer capacity.</dd><dd><code>timeout</code> - The timeout in ms</dd>
922 
<dt><span class="strong">Returns:</span></dt><dd>The error code (<0) if an error occurred, otherwise the amount of transferred date</dd></dl>
923 
</li>
924 
</ul>
925 
<a name="bulkRead(int, byte[], int, long)">
926 
<!--   -->
927 
</a>
928 
<ul class="blockList">
929 
<li class="blockList">
930 
<h4>bulkRead</h4>
931 
<pre>public&nbsp;int&nbsp;bulkRead(int&nbsp;ep,
932 
           byte[]&nbsp;buf,
933 
           int&nbsp;maxlen,
934 
           long&nbsp;timeout)</pre>
935 
<div class="block">Wrapper method for LibUsb.bulkTransfer(DeviceHandle,byte,ByteBuffer,IntBuffer,long).</div>
936 
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>ep</code> - The endpoint number.</dd><dd><code>buf</code> - The payload data buffer.</dd><dd><code>maxlen</code> - The size of the transfer.</dd><dd><code>timeout</code> - The timeout in ms</dd>
937 
<dt><span class="strong">Returns:</span></dt><dd>The error code (<0) if an error occurred, otherwise the amount of transferred date</dd></dl>
938 
</li>
939 
</ul>
940 
<a name="allocateByteBuffer(byte[])">
941 
<!--   -->
942 
</a>
943 
<ul class="blockList">
944 
<li class="blockList">
945 
<h4>allocateByteBuffer</h4>
946 
<pre>public static&nbsp;java.nio.ByteBuffer&nbsp;allocateByteBuffer(byte[]&nbsp;buf)</pre>
947 
<div class="block">Utility function that creates a ByteBuffer from byte array.</div>
948 
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>buf</code> - The byte array.</dd>
949 
<dt><span class="strong">Returns:</span></dt><dd>A ByteBuffer.</dd></dl>
950 
</li>
951 
</ul>
952 
<a name="allocateByteBuffer(byte[], int, int)">
953 
<!--   -->
954 
</a>
955 
<ul class="blockList">
956 
<li class="blockList">
957 
<h4>allocateByteBuffer</h4>
958 
<pre>public static&nbsp;java.nio.ByteBuffer&nbsp;allocateByteBuffer(byte[]&nbsp;buf,
959 
                                     int&nbsp;offs,
960 
                                     int&nbsp;length)</pre>
961 
<div class="block">Utility function that creates a ByteBuffer from byte array.</div>
962 
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>buf</code> - The byte array.</dd><dd><code>offs</code> - The offset of the first data in the byte array.</dd><dd><code>length</code> - Length of the The byte array.</dd>
963 
<dt><span class="strong">Returns:</span></dt><dd>A ByteBuffer.</dd></dl>
964 
</li>
965 
</ul>
966 
<a name="setConfiguration(int)">
967 
<!--   -->
968 
</a>
969 
<ul class="blockList">
970 
<li class="blockList">
971 
<h4>setConfiguration</h4>
972 
<pre>public&nbsp;void&nbsp;setConfiguration(int&nbsp;config)
973 
                      throws <a href="../ztex/UsbException.html" title="class in ztex">UsbException</a></pre>
974 
<div class="block">Sets the configuration.</div>
975 
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>config</code> - The configuration number (usually 1)</dd>
976 
<dt><span class="strong">Throws:</span></dt>
977 
<dd><code><a href="../ztex/UsbException.html" title="class in ztex">UsbException</a></code> - if an error occurs while attempting to set the configuration.</dd></dl>
978 
</li>
979 
</ul>
980 
<a name="trySetConfiguration(int)">
981 
<!--   -->
982 
</a>
983 
<ul class="blockList">
984 
<li class="blockList">
985 
<h4>trySetConfiguration</h4>
986 
<pre>public&nbsp;void&nbsp;trySetConfiguration(int&nbsp;config)</pre>
987 
<div class="block">Tries to set the configuration.
988 
 If an error occurs while attempting to set the configuration, a warning message is printed to stderr.</div>
989 
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>config</code> - The configuration number (usually 1)</dd></dl>
990 
</li>
991 
</ul>
992 
<a name="getInterfaceClaimed(int)">
993 
<!--   -->
994 
</a>
995 
<ul class="blockList">
996 
<li class="blockList">
997 
<h4>getInterfaceClaimed</h4>
998 
<pre>public&nbsp;boolean&nbsp;getInterfaceClaimed(int&nbsp;iface)</pre>
999 
<div class="block">Returns true if interface is claimed.</div>
1000 
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>iface</code> - The interface number</dd>
1001 
<dt><span class="strong">Returns:</span></dt><dd>true if interface is claimed</dd></dl>
1002 
</li>
1003 
</ul>
1004 
<a name="claimInterface(int)">
1005 
<!--   -->
1006 
</a>
1007 
<ul class="blockList">
1008 
<li class="blockList">
1009 
<h4>claimInterface</h4>
1010 
<pre>public&nbsp;void&nbsp;claimInterface(int&nbsp;iface)
1011 
                    throws <a href="../ztex/UsbException.html" title="class in ztex">UsbException</a></pre>
1012 
<div class="block">Claims an interface.</div>
1013 
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>iface</code> - The interface number (usually 0)</dd>
1014 
<dt><span class="strong">Throws:</span></dt>
1015 
<dd><code><a href="../ztex/UsbException.html" title="class in ztex">UsbException</a></code> - if an error occurs while attempting to claim the interface.</dd></dl>
1016 
</li>
1017 
</ul>
1018 
<a name="releaseInterface(int)">
1019 
<!--   -->
1020 
</a>
1021 
<ul class="blockList">
1022 
<li class="blockList">
1023 
<h4>releaseInterface</h4>
1024 
<pre>public&nbsp;void&nbsp;releaseInterface(int&nbsp;iface)</pre>
1025 
<div class="block">Releases an interface.</div>
1026 
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>iface</code> - The interface number (usually 0)</dd></dl>
1027 
</li>
1028 
</ul>
1029 
<a name="uploadFirmware(ztex.ZtexImgFile1, boolean)">
1030 
<!--   -->
1031 
</a>
1032 
<ul class="blockList">
1033 
<li class="blockList">
1034 
<h4>uploadFirmware</h4>
1035 
<pre>public&nbsp;long&nbsp;uploadFirmware(<a href="../ztex/ZtexImgFile1.html" title="class in ztex">ZtexImgFile1</a>&nbsp;imgFile,
1036 
                  boolean&nbsp;force)
1037 
                    throws <a href="../ztex/IncompatibleFirmwareException.html" title="class in ztex">IncompatibleFirmwareException</a>,
1038 
                           <a href="../ztex/FirmwareUploadException.html" title="class in ztex">FirmwareUploadException</a>,
1039 
                           <a href="../ztex/UsbException.html" title="class in ztex">UsbException</a>,
1040 
                           <a href="../ztex/InvalidFirmwareException.html" title="class in ztex">InvalidFirmwareException</a>,
1041 
                           <a href="../ztex/DeviceLostException.html" title="class in ztex">DeviceLostException</a></pre>
1042 
<div class="block">Uploads the firmware to the EZ-USB and manages the renumeration process.
1043 
 <p>
1044 
 Before the firmware is uploaded the device is set into a reset state.
1045 
 After the upload the firmware is booted and the renumeration starts.
1046 
 During this process the device disappears from the bus and a new one
1047 
 occurs which will be assigned to this class automatically (instead of the disappeared one).</div>
1048 
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>imgFile</code> - The firmware image.</dd><dd><code>force</code> - The compatibility check is skipped if true.</dd>
1049 
<dt><span class="strong">Returns:</span></dt><dd>the upload time in ms.</dd>
1050 
<dt><span class="strong">Throws:</span></dt>
1051 
<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,%20int,%20int,%20int)"><code>ZtexDevice1.compatible(int,int,int,int)</code></a> (Upload can be enforced using the <tt>force</tt> parameter)</dd>
1052 
<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>
1053 
<dd><code><a href="../ztex/UsbException.html" title="class in ztex">UsbException</a></code> - if a communication error occurs.</dd>
1054 
<dd><code><a href="../ztex/InvalidFirmwareException.html" title="class in ztex">InvalidFirmwareException</a></code> - if ZTEX descriptor 1 is not available.</dd>
1055 
<dd><code><a href="../ztex/DeviceLostException.html" title="class in ztex">DeviceLostException</a></code> - if a device went lost after renumeration.</dd></dl>
1056 
</li>
1057 
</ul>
1058 
<a name="uploadFirmware(java.lang.String, boolean)">
1059 
<!--   -->
1060 
</a>
1061 
<ul class="blockList">
1062 
<li class="blockList">
1063 
<h4>uploadFirmware</h4>
1064 
<pre>public&nbsp;long&nbsp;uploadFirmware(java.lang.String&nbsp;imgFileName,
1065 
                  boolean&nbsp;force)
1066 
                    throws <a href="../ztex/IncompatibleFirmwareException.html" title="class in ztex">IncompatibleFirmwareException</a>,
1067 
                           <a href="../ztex/FirmwareUploadException.html" title="class in ztex">FirmwareUploadException</a>,
1068 
                           <a href="../ztex/UsbException.html" title="class in ztex">UsbException</a>,
1069 
                           <a href="../ztex/InvalidFirmwareException.html" title="class in ztex">InvalidFirmwareException</a>,
1070 
                           <a href="../ztex/DeviceLostException.html" title="class in ztex">DeviceLostException</a></pre>
1071 
<div class="block">Uploads the firmware to the EZ-USB and manages the renumeration process.
1072 
 <p>
1073 
 Before the firmware is uploaded the device is set into a reset state.
1074 
 After the upload the firmware is booted and the renumeration starts.
1075 
 During this process the device disappears from the bus and a new one
1076 
 occurs which will be assigned to this class automatically (instead of the disappeared one).</div>
1077 
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>imgFileName</code> - The file name of the firmware image in ihx or img format. The file can be a regular file or a system resource (e.g. a file from the current jar archive).</dd><dd><code>force</code> - The compatibility check is skipped if true.</dd>
1078 
<dt><span class="strong">Returns:</span></dt><dd>the upload time in ms.</dd>
1079 
<dt><span class="strong">Throws:</span></dt>
1080 
<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,%20int,%20int,%20int)"><code>ZtexDevice1.compatible(int,int,int,int)</code></a> (Upload can be enforced using the <tt>force</tt> parameter)</dd>
1081 
<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>
1082 
<dd><code><a href="../ztex/UsbException.html" title="class in ztex">UsbException</a></code> - if a communication error occurs.</dd>
1083 
<dd><code><a href="../ztex/InvalidFirmwareException.html" title="class in ztex">InvalidFirmwareException</a></code> - if ZTEX descriptor 1 is not available.</dd>
1084 
<dd><code><a href="../ztex/DeviceLostException.html" title="class in ztex">DeviceLostException</a></code> - if a device went lost after renumeration.</dd></dl>
1085 
</li>
1086 
</ul>
1087 
<a name="uploadFirmware(java.io.InputStream, java.lang.String, boolean)">
1088 
<!--   -->
1089 
</a>
1090 
<ul class="blockList">
1091 
<li class="blockList">
1092 
<h4>uploadFirmware</h4>
1093 
<pre>public&nbsp;long&nbsp;uploadFirmware(java.io.InputStream&nbsp;imgIn,
1094 
                  java.lang.String&nbsp;name,
1095 
                  boolean&nbsp;force)
1096 
                    throws <a href="../ztex/IncompatibleFirmwareException.html" title="class in ztex">IncompatibleFirmwareException</a>,
1097 
                           <a href="../ztex/FirmwareUploadException.html" title="class in ztex">FirmwareUploadException</a>,
1098 
                           <a href="../ztex/UsbException.html" title="class in ztex">UsbException</a>,
1099 
                           <a href="../ztex/InvalidFirmwareException.html" title="class in ztex">InvalidFirmwareException</a>,
1100 
                           <a href="../ztex/DeviceLostException.html" title="class in ztex">DeviceLostException</a></pre>
1101 
<div class="block">Uploads the firmware to the EZ-USB and manages the renumeration process.
1102 
 <p>
1103 
 Before the firmware is uploaded the device is set into a reset state.
1104 
 After the upload the firmware is booted and the renumeration starts.
1105 
 During this process the device disappears from the bus and a new one
1106 
 occurs which will be assigned to this class automatically (instead of the disappeared one).</div>
1107 
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>imgIn</code> - Input stream from which the img file is read.</dd><dd><code>name</code> - Name of the input.</dd><dd><code>force</code> - The compatibility check is skipped if true.</dd>
1108 
<dt><span class="strong">Returns:</span></dt><dd>the upload time in ms.</dd>
1109 
<dt><span class="strong">Throws:</span></dt>
1110 
<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,%20int,%20int,%20int)"><code>ZtexDevice1.compatible(int,int,int,int)</code></a> (Upload can be enforced using the <tt>force</tt> parameter)</dd>
1111 
<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>
1112 
<dd><code><a href="../ztex/UsbException.html" title="class in ztex">UsbException</a></code> - if a communication error occurs.</dd>
1113 
<dd><code><a href="../ztex/InvalidFirmwareException.html" title="class in ztex">InvalidFirmwareException</a></code> - if ZTEX descriptor 1 is not available.</dd>
1114 
<dd><code><a href="../ztex/DeviceLostException.html" title="class in ztex">DeviceLostException</a></code> - if a device went lost after renumeration.</dd></dl>
1115 
</li>
1116 
</ul>
1117 
<a name="resetEzUsb()">
1118 
<!--   -->
1119 
</a>
1120 
<ul class="blockList">
1121 
<li class="blockList">
1122 
<h4>resetEzUsb</h4>
1123 
<pre>public&nbsp;void&nbsp;resetEzUsb()
1124 
                throws <a href="../ztex/FirmwareUploadException.html" title="class in ztex">FirmwareUploadException</a>,
1125 
                       <a href="../ztex/UsbException.html" title="class in ztex">UsbException</a>,
1126 
                       <a href="../ztex/InvalidFirmwareException.html" title="class in ztex">InvalidFirmwareException</a>,
1127 
                       <a href="../ztex/DeviceLostException.html" title="class in ztex">DeviceLostException</a></pre>
1128 
<div class="block">Resets the EZ-USB and manages the renumeration process.
1129 
 <p>
1130 
 After the reset the renumeration starts.
1131 
 During this process the device disappears from the bus and a new one
1132 
 occurs which will be assigned to this class automatically (instead of the disappeared one).</div>
1133 
<dl><dt><span class="strong">Throws:</span></dt>
1134 
<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>
1135 
<dd><code><a href="../ztex/UsbException.html" title="class in ztex">UsbException</a></code> - if a communication error occurs.</dd>
1136 
<dd><code><a href="../ztex/InvalidFirmwareException.html" title="class in ztex">InvalidFirmwareException</a></code> - if ZTEX descriptor 1 is not available.</dd>
1137 
<dd><code><a href="../ztex/DeviceLostException.html" title="class in ztex">DeviceLostException</a></code> - if a device went lost after renumeration.</dd></dl>
1138 
</li>
1139 
</ul>
1140 
<a name="resetDevice(boolean)">
1141 
<!--   -->
1142 
</a>
1143 
<ul class="blockList">
1144 
<li class="blockList">
1145 
<h4>resetDevice</h4>
1146 
<pre>public&nbsp;void&nbsp;resetDevice(boolean&nbsp;force)
1147 
                 throws <a href="../ztex/FirmwareUploadException.html" title="class in ztex">FirmwareUploadException</a>,
1148 
                        <a href="../ztex/UsbException.html" title="class in ztex">UsbException</a>,
1149 
                        <a href="../ztex/InvalidFirmwareException.html" title="class in ztex">InvalidFirmwareException</a>,
1150 
                        <a href="../ztex/DeviceLostException.html" title="class in ztex">DeviceLostException</a></pre>
1151 
<div class="block">Performs a configuration or bus reset. This method is used to synchronize data toggles at start-up of the host software.</div>
1152 
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>force</code> - True enforces a bus reset. By default a configuration reset is tried first and if it fails, a bus reset is performed.</dd>
1153 
<dt><span class="strong">Throws:</span></dt>
1154 
<dd><code><a href="../ztex/UsbException.html" title="class in ztex">UsbException</a></code> - if a communication error occurs.</dd>
1155 
<dd><code><a href="../ztex/FirmwareUploadException.html" title="class in ztex">FirmwareUploadException</a></code></dd>
1156 
<dd><code><a href="../ztex/InvalidFirmwareException.html" title="class in ztex">InvalidFirmwareException</a></code></dd>
1157 
<dd><code><a href="../ztex/DeviceLostException.html" title="class in ztex">DeviceLostException</a></code></dd></dl>
1158 
</li>
1159 
</ul>
1160 
<a name="toString()">
1161 
<!--   -->
1162 
</a>
1163 
<ul class="blockListLast">
1164 
<li class="blockList">
1165 
<h4>toString</h4>
1166 
<pre>public&nbsp;java.lang.String&nbsp;toString()</pre>
1167 
<div class="block">Returns a lot of useful information about the corresponding device.</div>
1168 
<dl>
1169 
<dt><strong>Overrides:</strong></dt>
1170 
<dd><code>toString</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
1171 
<dt><span class="strong">Returns:</span></dt><dd>a lot of useful information about the corresponding device.</dd></dl>
1172 
</li>
1173 
</ul>
1174 
</li>
1175 
</ul>
1176 
</li>
1177 
</ul>
1178 
</div>
1179 
</div>
1180 
<!-- ========= END OF CLASS DATA ========= -->
1181 
<!-- ======= START OF BOTTOM NAVBAR ====== -->
1182 
<div class="bottomNav"><a name="navbar_bottom">
1183 
<!--   -->
1184 
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
1185 
<!--   -->
1186 
</a>
1187 
<ul class="navList" title="Navigation">
1188 
<li><a href="../ztex/package-summary.html">Package</a></li>
1189 
<li class="navBarCell1Rev">Class</li>
1190 
<li><a href="package-tree.html">Tree</a></li>
1191 
<li><a href="../deprecated-list.html">Deprecated</a></li>
1192 
<li><a href="../index-all.html">Index</a></li>
1193 
<li><a href="../help-doc.html">Help</a></li>
1194 
</ul>
1195 
</div>
1196 
<div class="subNav">
1197 
<ul class="navList">
1198 
<li><a href="../ztex/UsbException.html" title="class in ztex"><span class="strong">Prev Class</span></a></li>
1199 
<li><a href="../ztex/Ztex1v1.html" title="class in ztex"><span class="strong">Next Class</span></a></li>
1200 
</ul>
1201 
<ul class="navList">
1202 
<li><a href="../index.html?ztex/Ztex1.html" target="_top">Frames</a></li>
1203 
<li><a href="Ztex1.html" target="_top">No Frames</a></li>
1204 
</ul>
1205 
<ul class="navList" id="allclasses_navbar_bottom">
1206 
<li><a href="../allclasses-noframe.html">All Classes</a></li>
1207 
</ul>
1208 
<div>
1209 
<script type="text/javascript"><!--
1210 
  allClassesLink = document.getElementById("allclasses_navbar_bottom");
1211 
  if(window==top) {
1212 
    allClassesLink.style.display = "block";
1213 
  }
1214 
  else {
1215 
    allClassesLink.style.display = "none";
1216 
  }
1217 
  //-->
1218 
</script>
1219 
</div>
1220 
<div>
1221 
<ul class="subNavList">
1222 
<li>Summary:&nbsp;</li>
1223 
<li>Nested&nbsp;|&nbsp;</li>
1224 
<li><a href="#field_summary">Field</a>&nbsp;|&nbsp;</li>
1225 
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
1226 
<li><a href="#method_summary">Method</a></li>
1227 
</ul>
1228 
<ul class="subNavList">
1229 
<li>Detail:&nbsp;</li>
1230 
<li><a href="#field_detail">Field</a>&nbsp;|&nbsp;</li>
1231 
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
1232 
<li><a href="#method_detail">Method</a></li>
1233 
</ul>
1234 
</div>
1235 
<a name="skip-navbar_bottom">
1236 
<!--   -->
1237 
</a></div>
1238 
<!-- ======== END OF BOTTOM NAVBAR ======= -->
1239 
</body>
1240 
</html>

powered by: WebSVN 2.1.0

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