/usr/share/doc/libusb-java-doc/html/ch/ntb/usb/USB.html is in libusb-java-doc 0.8+ztex20090101-7.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.6.0_27) on Sun Nov 24 19:27:23 CET 2013 -->
<title>USB</title>
<meta name="date" content="2013-11-24">
<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="USB";
}
//-->
</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="../../../ch/ntb/usb/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="../../../ch/ntb/usb/LibusbJava.html" title="class in ch.ntb.usb"><span class="strong">PREV CLASS</span></a></li>
<li><a href="../../../ch/ntb/usb/Usb_Bus.html" title="class in ch.ntb.usb"><span class="strong">NEXT CLASS</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?ch/ntb/usb/USB.html" target="_top">FRAMES</a></li>
<li><a href="USB.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="#field_summary">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><a href="#field_detail">FIELD</a> | </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">
<p class="subTitle">ch.ntb.usb</p>
<h2 title="Class USB" class="title">Class USB</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>ch.ntb.usb.USB</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <strong>USB</strong>
extends java.lang.Object</pre>
<div class="block">This class manages all USB devices and defines some USB specific constants.<br></div>
</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>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../ch/ntb/usb/USB.html#FULLSPEED_MAX_BULK_PACKET_SIZE">FULLSPEED_MAX_BULK_PACKET_SIZE</a></strong></code>
<div class="block">The maximum packet size of a bulk transfer when operating in fullspeed
(12 MB/s) mode.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../ch/ntb/usb/USB.html#HIGHSPEED_MAX_BULK_PACKET_SIZE">HIGHSPEED_MAX_BULK_PACKET_SIZE</a></strong></code>
<div class="block">The maximum packet size of a bulk transfer when operating in highspeed
(480 MB/s) mode.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../ch/ntb/usb/USB.html#REQ_CLEAR_FEATURE">REQ_CLEAR_FEATURE</a></strong></code>
<div class="block">This request is used to clear or disable a specific feature (USB spec
9.4.1).</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../ch/ntb/usb/USB.html#REQ_GET_CONFIGURATION">REQ_GET_CONFIGURATION</a></strong></code>
<div class="block">This request returns the current device configuration value (USB spec
9.4.2).</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../ch/ntb/usb/USB.html#REQ_GET_DESCRIPTOR">REQ_GET_DESCRIPTOR</a></strong></code>
<div class="block">This request returns the specified descriptor if the descriptor exists
(USB spec 9.4.3).</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../ch/ntb/usb/USB.html#REQ_GET_INTERFACE">REQ_GET_INTERFACE</a></strong></code>
<div class="block">This request returns the selected alternate setting for the specified
interface (USB spec 9.4.4).</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../ch/ntb/usb/USB.html#REQ_GET_STATUS">REQ_GET_STATUS</a></strong></code>
<div class="block">This request returns status for the specified recipient (USB spec 9.4.5).</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../ch/ntb/usb/USB.html#REQ_SET_ADDRESS">REQ_SET_ADDRESS</a></strong></code>
<div class="block">This request sets the device address for all future device accesses (USB
spec 9.4.6).</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../ch/ntb/usb/USB.html#REQ_SET_CONFIGURATION">REQ_SET_CONFIGURATION</a></strong></code>
<div class="block">This request sets the device configuration (USB spec 9.4.7).</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../ch/ntb/usb/USB.html#REQ_SET_DESCRIPTOR">REQ_SET_DESCRIPTOR</a></strong></code>
<div class="block">This request is optional and may be used to update existing descriptors
or new descriptors may be added (USB spec 9.4.8).</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../ch/ntb/usb/USB.html#REQ_SET_FEATURE">REQ_SET_FEATURE</a></strong></code>
<div class="block">This request is used to set or enable a specific feature (USB spec
9.4.9).</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../ch/ntb/usb/USB.html#REQ_SET_INTERFACE">REQ_SET_INTERFACE</a></strong></code>
<div class="block">This request allows the host to select an alternate setting for the
specified interface (USB spec 9.4.10).</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../ch/ntb/usb/USB.html#REQ_SYNCH_FRAME">REQ_SYNCH_FRAME</a></strong></code>
<div class="block">This request is used to set and then report an endpoint�s synchronization
frame (USB spec 9.4.11).</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../ch/ntb/usb/USB.html#REQ_TYPE_DIR_DEVICE_TO_HOST">REQ_TYPE_DIR_DEVICE_TO_HOST</a></strong></code>
<div class="block">Identifies the direction of data transfer in the second phase of the
control transfer.<br>
The state of the Direction bit is ignored if the wLength field is zero,
signifying there is no Data stage.<br>
Specifies bit 7 of bmRequestType.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../ch/ntb/usb/USB.html#REQ_TYPE_DIR_HOST_TO_DEVICE">REQ_TYPE_DIR_HOST_TO_DEVICE</a></strong></code>
<div class="block">Identifies the direction of data transfer in the second phase of the
control transfer.<br>
The state of the Direction bit is ignored if the wLength field is zero,
signifying there is no Data stage.<br>
Specifies bit 7 of bmRequestType.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../ch/ntb/usb/USB.html#REQ_TYPE_RECIP_DEVICE">REQ_TYPE_RECIP_DEVICE</a></strong></code>
<div class="block">Specifies the intended recipient of the request.<br>
Requests may be directed to the device, an interface on the device, or a
specific endpoint on a device.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../ch/ntb/usb/USB.html#REQ_TYPE_RECIP_ENDPOINT">REQ_TYPE_RECIP_ENDPOINT</a></strong></code>
<div class="block">Specifies the intended recipient of the request.<br>
Requests may be directed to the device, an interface on the device, or a
specific endpoint on a device.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../ch/ntb/usb/USB.html#REQ_TYPE_RECIP_INTERFACE">REQ_TYPE_RECIP_INTERFACE</a></strong></code>
<div class="block">Specifies the intended recipient of the request.<br>
Requests may be directed to the device, an interface on the device, or a
specific endpoint on a device.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../ch/ntb/usb/USB.html#REQ_TYPE_RECIP_OTHER">REQ_TYPE_RECIP_OTHER</a></strong></code>
<div class="block">Specifies the intended recipient of the request.<br>
Requests may be directed to the device, an interface on the device, or a
specific endpoint on a device.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../ch/ntb/usb/USB.html#REQ_TYPE_TYPE_CLASS">REQ_TYPE_TYPE_CLASS</a></strong></code>
<div class="block">Specifies the type of the request.<br>
Specifies bits 6..5 of bmRequestType.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../ch/ntb/usb/USB.html#REQ_TYPE_TYPE_RESERVED">REQ_TYPE_TYPE_RESERVED</a></strong></code>
<div class="block">Specifies the type of the request.<br>
Specifies bits 6..5 of bmRequestType.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../ch/ntb/usb/USB.html#REQ_TYPE_TYPE_STANDARD">REQ_TYPE_TYPE_STANDARD</a></strong></code>
<div class="block">Specifies the type of the request.<br>
Specifies bits 6..5 of bmRequestType.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../ch/ntb/usb/USB.html#REQ_TYPE_TYPE_VENDOR">REQ_TYPE_TYPE_VENDOR</a></strong></code>
<div class="block">Specifies the type of the request.<br>
Specifies bits 6..5 of bmRequestType.</div>
</td>
</tr>
</table>
</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="../../../ch/ntb/usb/USB.html#USB()">USB</a></strong>()</code> </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>static <a href="../../../ch/ntb/usb/Usb_Bus.html" title="class in ch.ntb.usb">Usb_Bus</a></code></td>
<td class="colLast"><code><strong><a href="../../../ch/ntb/usb/USB.html#getBus()">getBus</a></strong>()</code>
<div class="block">Returns the root <a href="../../../ch/ntb/usb/Usb_Bus.html" title="class in ch.ntb.usb"><code>Usb_Bus</code></a> element.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../../ch/ntb/usb/Device.html" title="class in ch.ntb.usb">Device</a></code></td>
<td class="colLast"><code><strong><a href="../../../ch/ntb/usb/USB.html#getDevice(short, short)">getDevice</a></strong>(short idVendor,
short idProduct)</code>
<div class="block">See <a href="../../../ch/ntb/usb/USB.html#getDevice(short, short, java.lang.String)"><code>getDevice(short, short, String)</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../ch/ntb/usb/Device.html" title="class in ch.ntb.usb">Device</a></code></td>
<td class="colLast"><code><strong><a href="../../../ch/ntb/usb/USB.html#getDevice(short, short, java.lang.String)">getDevice</a></strong>(short idVendor,
short idProduct,
java.lang.String filename)</code>
<div class="block">Create a new device an register it in a device queue.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><strong><a href="../../../ch/ntb/usb/USB.html#init()">init</a></strong>()</code>
<div class="block">Explicitly calls <a href="../../../ch/ntb/usb/LibusbJava.html#usb_init()"><code>LibusbJava.usb_init()</code></a>.</div>
</td>
</tr>
</table>
<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, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="REQ_GET_STATUS">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>REQ_GET_STATUS</h4>
<pre>public static final int REQ_GET_STATUS</pre>
<div class="block">This request returns status for the specified recipient (USB spec 9.4.5).</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../ch/ntb/usb/Device.html#controlMsg(int, int, int, int, byte[], int, int, boolean)"><code>Device.controlMsg(int, int, int, int, byte[], int, int,
boolean)</code></a>,
<a href="../../../constant-values.html#ch.ntb.usb.USB.REQ_GET_STATUS">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="REQ_CLEAR_FEATURE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>REQ_CLEAR_FEATURE</h4>
<pre>public static final int REQ_CLEAR_FEATURE</pre>
<div class="block">This request is used to clear or disable a specific feature (USB spec
9.4.1).</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../ch/ntb/usb/Device.html#controlMsg(int, int, int, int, byte[], int, int, boolean)"><code>Device.controlMsg(int, int, int, int, byte[], int, int,
boolean)</code></a>,
<a href="../../../constant-values.html#ch.ntb.usb.USB.REQ_CLEAR_FEATURE">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="REQ_SET_FEATURE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>REQ_SET_FEATURE</h4>
<pre>public static final int REQ_SET_FEATURE</pre>
<div class="block">This request is used to set or enable a specific feature (USB spec
9.4.9).</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../ch/ntb/usb/Device.html#controlMsg(int, int, int, int, byte[], int, int, boolean)"><code>Device.controlMsg(int, int, int, int, byte[], int, int,
boolean)</code></a>,
<a href="../../../constant-values.html#ch.ntb.usb.USB.REQ_SET_FEATURE">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="REQ_SET_ADDRESS">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>REQ_SET_ADDRESS</h4>
<pre>public static final int REQ_SET_ADDRESS</pre>
<div class="block">This request sets the device address for all future device accesses (USB
spec 9.4.6).</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../ch/ntb/usb/Device.html#controlMsg(int, int, int, int, byte[], int, int, boolean)"><code>Device.controlMsg(int, int, int, int, byte[], int, int,
boolean)</code></a>,
<a href="../../../constant-values.html#ch.ntb.usb.USB.REQ_SET_ADDRESS">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="REQ_GET_DESCRIPTOR">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>REQ_GET_DESCRIPTOR</h4>
<pre>public static final int REQ_GET_DESCRIPTOR</pre>
<div class="block">This request returns the specified descriptor if the descriptor exists
(USB spec 9.4.3).</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../ch/ntb/usb/Device.html#controlMsg(int, int, int, int, byte[], int, int, boolean)"><code>Device.controlMsg(int, int, int, int, byte[], int, int,
boolean)</code></a>,
<a href="../../../constant-values.html#ch.ntb.usb.USB.REQ_GET_DESCRIPTOR">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="REQ_SET_DESCRIPTOR">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>REQ_SET_DESCRIPTOR</h4>
<pre>public static final int REQ_SET_DESCRIPTOR</pre>
<div class="block">This request is optional and may be used to update existing descriptors
or new descriptors may be added (USB spec 9.4.8).</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../ch/ntb/usb/Device.html#controlMsg(int, int, int, int, byte[], int, int, boolean)"><code>Device.controlMsg(int, int, int, int, byte[], int, int,
boolean)</code></a>,
<a href="../../../constant-values.html#ch.ntb.usb.USB.REQ_SET_DESCRIPTOR">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="REQ_GET_CONFIGURATION">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>REQ_GET_CONFIGURATION</h4>
<pre>public static final int REQ_GET_CONFIGURATION</pre>
<div class="block">This request returns the current device configuration value (USB spec
9.4.2).</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../ch/ntb/usb/Device.html#controlMsg(int, int, int, int, byte[], int, int, boolean)"><code>Device.controlMsg(int, int, int, int, byte[], int, int,
boolean)</code></a>,
<a href="../../../constant-values.html#ch.ntb.usb.USB.REQ_GET_CONFIGURATION">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="REQ_SET_CONFIGURATION">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>REQ_SET_CONFIGURATION</h4>
<pre>public static final int REQ_SET_CONFIGURATION</pre>
<div class="block">This request sets the device configuration (USB spec 9.4.7).</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../ch/ntb/usb/Device.html#controlMsg(int, int, int, int, byte[], int, int, boolean)"><code>Device.controlMsg(int, int, int, int, byte[], int, int,
boolean)</code></a>,
<a href="../../../constant-values.html#ch.ntb.usb.USB.REQ_SET_CONFIGURATION">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="REQ_GET_INTERFACE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>REQ_GET_INTERFACE</h4>
<pre>public static final int REQ_GET_INTERFACE</pre>
<div class="block">This request returns the selected alternate setting for the specified
interface (USB spec 9.4.4).</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../ch/ntb/usb/Device.html#controlMsg(int, int, int, int, byte[], int, int, boolean)"><code>Device.controlMsg(int, int, int, int, byte[], int, int,
boolean)</code></a>,
<a href="../../../constant-values.html#ch.ntb.usb.USB.REQ_GET_INTERFACE">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="REQ_SET_INTERFACE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>REQ_SET_INTERFACE</h4>
<pre>public static final int REQ_SET_INTERFACE</pre>
<div class="block">This request allows the host to select an alternate setting for the
specified interface (USB spec 9.4.10).</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../ch/ntb/usb/Device.html#controlMsg(int, int, int, int, byte[], int, int, boolean)"><code>Device.controlMsg(int, int, int, int, byte[], int, int,
boolean)</code></a>,
<a href="../../../constant-values.html#ch.ntb.usb.USB.REQ_SET_INTERFACE">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="REQ_SYNCH_FRAME">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>REQ_SYNCH_FRAME</h4>
<pre>public static final int REQ_SYNCH_FRAME</pre>
<div class="block">This request is used to set and then report an endpoint�s synchronization
frame (USB spec 9.4.11).</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../ch/ntb/usb/Device.html#controlMsg(int, int, int, int, byte[], int, int, boolean)"><code>Device.controlMsg(int, int, int, int, byte[], int, int,
boolean)</code></a>,
<a href="../../../constant-values.html#ch.ntb.usb.USB.REQ_SYNCH_FRAME">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="REQ_TYPE_DIR_HOST_TO_DEVICE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>REQ_TYPE_DIR_HOST_TO_DEVICE</h4>
<pre>public static final int REQ_TYPE_DIR_HOST_TO_DEVICE</pre>
<div class="block">Identifies the direction of data transfer in the second phase of the
control transfer.<br>
The state of the Direction bit is ignored if the wLength field is zero,
signifying there is no Data stage.<br>
Specifies bit 7 of bmRequestType.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../ch/ntb/usb/Device.html#controlMsg(int, int, int, int, byte[], int, int, boolean)"><code>Device.controlMsg(int, int, int, int, byte[], int, int,
boolean)</code></a>,
<a href="../../../constant-values.html#ch.ntb.usb.USB.REQ_TYPE_DIR_HOST_TO_DEVICE">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="REQ_TYPE_DIR_DEVICE_TO_HOST">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>REQ_TYPE_DIR_DEVICE_TO_HOST</h4>
<pre>public static final int REQ_TYPE_DIR_DEVICE_TO_HOST</pre>
<div class="block">Identifies the direction of data transfer in the second phase of the
control transfer.<br>
The state of the Direction bit is ignored if the wLength field is zero,
signifying there is no Data stage.<br>
Specifies bit 7 of bmRequestType.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../ch/ntb/usb/Device.html#controlMsg(int, int, int, int, byte[], int, int, boolean)"><code>Device.controlMsg(int, int, int, int, byte[], int, int,
boolean)</code></a>,
<a href="../../../constant-values.html#ch.ntb.usb.USB.REQ_TYPE_DIR_DEVICE_TO_HOST">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="REQ_TYPE_TYPE_STANDARD">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>REQ_TYPE_TYPE_STANDARD</h4>
<pre>public static final int REQ_TYPE_TYPE_STANDARD</pre>
<div class="block">Specifies the type of the request.<br>
Specifies bits 6..5 of bmRequestType.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../ch/ntb/usb/Device.html#controlMsg(int, int, int, int, byte[], int, int, boolean)"><code>Device.controlMsg(int, int, int, int, byte[], int, int,
boolean)</code></a>,
<a href="../../../constant-values.html#ch.ntb.usb.USB.REQ_TYPE_TYPE_STANDARD">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="REQ_TYPE_TYPE_CLASS">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>REQ_TYPE_TYPE_CLASS</h4>
<pre>public static final int REQ_TYPE_TYPE_CLASS</pre>
<div class="block">Specifies the type of the request.<br>
Specifies bits 6..5 of bmRequestType.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../ch/ntb/usb/Device.html#controlMsg(int, int, int, int, byte[], int, int, boolean)"><code>Device.controlMsg(int, int, int, int, byte[], int, int,
boolean)</code></a>,
<a href="../../../constant-values.html#ch.ntb.usb.USB.REQ_TYPE_TYPE_CLASS">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="REQ_TYPE_TYPE_VENDOR">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>REQ_TYPE_TYPE_VENDOR</h4>
<pre>public static final int REQ_TYPE_TYPE_VENDOR</pre>
<div class="block">Specifies the type of the request.<br>
Specifies bits 6..5 of bmRequestType.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../ch/ntb/usb/Device.html#controlMsg(int, int, int, int, byte[], int, int, boolean)"><code>Device.controlMsg(int, int, int, int, byte[], int, int,
boolean)</code></a>,
<a href="../../../constant-values.html#ch.ntb.usb.USB.REQ_TYPE_TYPE_VENDOR">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="REQ_TYPE_TYPE_RESERVED">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>REQ_TYPE_TYPE_RESERVED</h4>
<pre>public static final int REQ_TYPE_TYPE_RESERVED</pre>
<div class="block">Specifies the type of the request.<br>
Specifies bits 6..5 of bmRequestType.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../ch/ntb/usb/Device.html#controlMsg(int, int, int, int, byte[], int, int, boolean)"><code>Device.controlMsg(int, int, int, int, byte[], int, int,
boolean)</code></a>,
<a href="../../../constant-values.html#ch.ntb.usb.USB.REQ_TYPE_TYPE_RESERVED">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="REQ_TYPE_RECIP_DEVICE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>REQ_TYPE_RECIP_DEVICE</h4>
<pre>public static final int REQ_TYPE_RECIP_DEVICE</pre>
<div class="block">Specifies the intended recipient of the request.<br>
Requests may be directed to the device, an interface on the device, or a
specific endpoint on a device. When an interface or endpoint is
specified, the wIndex field identifies the interface or endpoint.<br>
Specifies bits 4..0 of bmRequestType.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../ch/ntb/usb/Device.html#controlMsg(int, int, int, int, byte[], int, int, boolean)"><code>Device.controlMsg(int, int, int, int, byte[], int, int,
boolean)</code></a>,
<a href="../../../constant-values.html#ch.ntb.usb.USB.REQ_TYPE_RECIP_DEVICE">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="REQ_TYPE_RECIP_INTERFACE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>REQ_TYPE_RECIP_INTERFACE</h4>
<pre>public static final int REQ_TYPE_RECIP_INTERFACE</pre>
<div class="block">Specifies the intended recipient of the request.<br>
Requests may be directed to the device, an interface on the device, or a
specific endpoint on a device. When an interface or endpoint is
specified, the wIndex field identifies the interface or endpoint.<br>
Specifies bits 4..0 of bmRequestType.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../ch/ntb/usb/Device.html#controlMsg(int, int, int, int, byte[], int, int, boolean)"><code>Device.controlMsg(int, int, int, int, byte[], int, int,
boolean)</code></a>,
<a href="../../../constant-values.html#ch.ntb.usb.USB.REQ_TYPE_RECIP_INTERFACE">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="REQ_TYPE_RECIP_ENDPOINT">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>REQ_TYPE_RECIP_ENDPOINT</h4>
<pre>public static final int REQ_TYPE_RECIP_ENDPOINT</pre>
<div class="block">Specifies the intended recipient of the request.<br>
Requests may be directed to the device, an interface on the device, or a
specific endpoint on a device. When an interface or endpoint is
specified, the wIndex field identifies the interface or endpoint.<br>
Specifies bits 4..0 of bmRequestType.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../ch/ntb/usb/Device.html#controlMsg(int, int, int, int, byte[], int, int, boolean)"><code>Device.controlMsg(int, int, int, int, byte[], int, int,
boolean)</code></a>,
<a href="../../../constant-values.html#ch.ntb.usb.USB.REQ_TYPE_RECIP_ENDPOINT">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="REQ_TYPE_RECIP_OTHER">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>REQ_TYPE_RECIP_OTHER</h4>
<pre>public static final int REQ_TYPE_RECIP_OTHER</pre>
<div class="block">Specifies the intended recipient of the request.<br>
Requests may be directed to the device, an interface on the device, or a
specific endpoint on a device. When an interface or endpoint is
specified, the wIndex field identifies the interface or endpoint.<br>
Specifies bits 4..0 of bmRequestType.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../ch/ntb/usb/Device.html#controlMsg(int, int, int, int, byte[], int, int, boolean)"><code>Device.controlMsg(int, int, int, int, byte[], int, int,
boolean)</code></a>,
<a href="../../../constant-values.html#ch.ntb.usb.USB.REQ_TYPE_RECIP_OTHER">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="HIGHSPEED_MAX_BULK_PACKET_SIZE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>HIGHSPEED_MAX_BULK_PACKET_SIZE</h4>
<pre>public static int HIGHSPEED_MAX_BULK_PACKET_SIZE</pre>
<div class="block">The maximum packet size of a bulk transfer when operating in highspeed
(480 MB/s) mode.</div>
</li>
</ul>
<a name="FULLSPEED_MAX_BULK_PACKET_SIZE">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>FULLSPEED_MAX_BULK_PACKET_SIZE</h4>
<pre>public static int FULLSPEED_MAX_BULK_PACKET_SIZE</pre>
<div class="block">The maximum packet size of a bulk transfer when operating in fullspeed
(12 MB/s) mode.</div>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="USB()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>USB</h4>
<pre>public USB()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getDevice(short, short, java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDevice</h4>
<pre>public static <a href="../../../ch/ntb/usb/Device.html" title="class in ch.ntb.usb">Device</a> getDevice(short idVendor,
short idProduct,
java.lang.String filename)</pre>
<div class="block">Create a new device an register it in a device queue. If the device is
already registered, a reference to it will be returned.<br></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>idVendor</code> - the vendor id of the USB device</dd><dd><code>idProduct</code> - the product id of the USB device</dd><dd><code>filename</code> - an optional filename which can be used to distinguish multiple
devices with the same vendor and product id.</dd>
<dt><span class="strong">Returns:</span></dt><dd>a newly created device or an already registered device</dd></dl>
</li>
</ul>
<a name="getDevice(short, short)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDevice</h4>
<pre>public static <a href="../../../ch/ntb/usb/Device.html" title="class in ch.ntb.usb">Device</a> getDevice(short idVendor,
short idProduct)</pre>
<div class="block">See <a href="../../../ch/ntb/usb/USB.html#getDevice(short, short, java.lang.String)"><code>getDevice(short, short, String)</code></a>. The parameter
<code>filename</code> is set to null.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>idVendor</code> - </dd><dd><code>idProduct</code> - </dd>
<dt><span class="strong">Returns:</span></dt><dd>a newly created device or an already registered device</dd></dl>
</li>
</ul>
<a name="getBus()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBus</h4>
<pre>public static <a href="../../../ch/ntb/usb/Usb_Bus.html" title="class in ch.ntb.usb">Usb_Bus</a> getBus()
throws <a href="../../../ch/ntb/usb/USBException.html" title="class in ch.ntb.usb">USBException</a></pre>
<div class="block">Returns the root <a href="../../../ch/ntb/usb/Usb_Bus.html" title="class in ch.ntb.usb"><code>Usb_Bus</code></a> element.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the root <a href="../../../ch/ntb/usb/Usb_Bus.html" title="class in ch.ntb.usb"><code>Usb_Bus</code></a> element</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../ch/ntb/usb/USBException.html" title="class in ch.ntb.usb">USBException</a></code></dd></dl>
</li>
</ul>
<a name="init()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>init</h4>
<pre>public static void init()</pre>
<div class="block">Explicitly calls <a href="../../../ch/ntb/usb/LibusbJava.html#usb_init()"><code>LibusbJava.usb_init()</code></a>. Note that you don't need
to call this procedure as it is called implicitly when creating a new
device with <a href="../../../ch/ntb/usb/USB.html#getDevice(short, short, java.lang.String)"><code>getDevice(short, short, String)</code></a>.</div>
</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="../../../ch/ntb/usb/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="../../../ch/ntb/usb/LibusbJava.html" title="class in ch.ntb.usb"><span class="strong">PREV CLASS</span></a></li>
<li><a href="../../../ch/ntb/usb/Usb_Bus.html" title="class in ch.ntb.usb"><span class="strong">NEXT CLASS</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?ch/ntb/usb/USB.html" target="_top">FRAMES</a></li>
<li><a href="USB.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="#field_summary">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><a href="#field_detail">FIELD</a> | </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>
|