Difference between revisions of "Unit USB"

From Ultibo.org
Jump to: navigation, search
Line 1,081: Line 1,081:
 
| <code>USB_SUBCLASS_VENDOR_SPECIFIC = $ff;</code>
 
| <code>USB_SUBCLASS_VENDOR_SPECIFIC = $ff;</code>
 
| Vendor Specific
 
| Vendor Specific
 +
|-
 +
|}
 +
</div></div>
 +
<br />
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 20px; padding-bottom: 15px;">
 +
<div style="font-size: 14px; padding-left: 12px;">'''USB protocol code constants''' <code> USB_PROTOCOL_* </code></div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
|colspan="2"|bInterfaceProtocol
 +
|-
 +
|colspan="2"|See: http://www.usb.org/developers/defined_class/
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
|colspan="2"|''Communications Devices''
 +
|-
 +
| <code>USB_PROTOCOL_CDC_ACM_NONE = 0;</code>
 +
| Abstract Control Model - No class specific protocol required
 +
|-
 +
| <code>USB_PROTOCOL_CDC_ACM_AT_V25TER = 1;</code>
 +
| Abstract Control Model - AT Commands: V.250 etc
 +
|-
 +
| <code>USB_PROTOCOL_CDC_ACM_AT_PCCA101 = 2;</code>
 +
| Abstract Control Model - AT Commands defined by PCCA-101
 +
|-
 +
| <code>USB_PROTOCOL_CDC_ACM_AT_PCCA101_WAKE = 3;</code>
 +
| Abstract Control Model - AT Commands defined by PCCA-101 & Annex O
 +
|-
 +
| <code>USB_PROTOCOL_CDC_ACM_AT_GSM  = 4;</code>
 +
| Abstract Control Model - AT Commands defined by GSM 07.07
 +
|-
 +
| <code>USB_PROTOCOL_CDC_ACM_AT_3G = 5;</code>
 +
| Abstract Control Model - AT Commands defined by 3GPP 27.007
 +
|-
 +
| <code>USB_PROTOCOL_CDC_ACM_AT_CDMA = 6;</code>
 +
| Abstract Control Model - AT Commands defined by TIA for CDMA
 +
|-
 +
| <code>USB_PROTOCOL_CDC_ACM_VENDOR = $ff;</code>
 +
| Abstract Control Model - Vendor-specific
 +
|-
 +
| <code>USB_PROTOCOL_CDC_EEM = 7;</code>
 +
| Ethernet Emulation Model
 +
|-
 +
| <code>USB_PROTOCOL_CDC_NCM_NTB = 1;</code>
 +
| Network Control Model - Network Transfer Block
 +
|-
 +
| <code>USB_PROTOCOL_CDC_MBIM_NTB = 2;</code>
 +
| Network Transfer Block
 +
|-
 +
|colspan="2"|''Still Image Devices''
 +
|-
 +
| <code>USB_PROTOCOL_IMAGE_DEFAULT = $01;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|''Mass Storage Devices''
 +
|-
 +
| <code>USB_PROTOCOL_MASS_STORAGE_CBI = $00;</code>
 +
| CBI (with command completion interrupt) USB Mass Storage Class Control/Bulk/Interrupt Transport
 +
|-
 +
| <code>USB_PROTOCOL_MASS_STORAGE_CB = $01;</code>
 +
| CBI (with no command completion interrupt) USB Mass Storage Class Control/Bulk/Interrupt Transport
 +
|-
 +
| <code>USB_PROTOCOL_MASS_STORAGE_BBB = $50;</code>
 +
| BBB USB Mass Storage Class Bulk-Only Transport
 +
|-
 +
| <code>USB_PROTOCOL_MASS_STORAGE_UAS = $62;</code>
 +
| UAS
 +
|-
 +
| <code>USB_PROTOCOL_MASS_STORAGE_VENDOR_SPECIFIC = $ff;</code>
 +
| Specific to device vendor, De facto use
 +
|-
 +
|colspan="2"|''Hub Devices''
 +
|-
 +
| <code>USB_PROTOCOL_HUB_FULLSPEED = $00;</code>
 +
| Full speed Hub
 +
|-
 +
| <code>USB_PROTOCOL_HUB_HIGHSPEED_SINGLE_TT = $01;</code>
 +
| Hi-speed hub with single Transaction Translator
 +
|-
 +
| <code>USB_PROTOCOL_HUB_HIGHSPEED_MULTI_TT = $02;</code>
 +
| Hi-speed hub with multiple Transaction Translators
 +
|-
 +
|colspan="2"|''Content Security Devices''
 +
|-
 +
| <code>USB_PROTOCOL_CONTENT_SECURITY_DEFAULT = $00;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|''Audio/Video Devices''
 +
|-
 +
| <code>USB_PROTOCOL_AUDIO_VIDEO_DEFAULT = $00;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|''Billboard Devices''
 +
|-
 +
| <code>USB_PROTOCOL_BILLBOARD_DEFAULT = $00;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|''Diagnostic Device''
 +
|-
 +
| <code>USB_PROTOCOL_DIAGNOSTIC_DEFAULT = $01;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|''Wireless Controller''
 +
|-
 +
| <code>USB_PROTOCOL_WIRELESS_CONTROLLER_BLUETOOTH = $01;</code>
 +
| See: http://www.bluetooth.com/
 +
|-
 +
| <code>USB_PROTOCOL_WIRELESS_CONTROLLER_UWB = $02;</code>
 +
| See: Wireless USB Specification in Chapter 8
 +
|-
 +
| <code>USB_PROTOCOL_WIRELESS_CONTROLLER_NDIS = $03;</code>
 +
| See: http://www.microsoft.com/windowsmobile/mobileoperators/default.mspx
 +
|-
 +
| <code>USB_PROTOCOL_WIRELESS_CONTROLLER_BLUETOOTH_AMP = $04;</code>
 +
| See: http://www.bluetooth.com/
 +
|-
 +
| <code>USB_PROTOCOL_WIRELESS_CONTROLLER_USB_HOST = $01;</code>
 +
| Host Wire Adapter Control/Data interface.  Definition can be found in the Wireless USB Specification in Chapter 8
 +
|-
 +
| <code>USB_PROTOCOL_WIRELESS_CONTROLLER_USB_DEVICE = $02;</code>
 +
| Device Wire Adapter Control/Data interface.  Definition can be found in the Wireless USB Specification in Chapter 8
 +
|-
 +
| <code>USB_PROTOCOL_WIRELESS_CONTROLLER_USB_DEVOCE_ISOC = $03;</code>
 +
| Device Wire Adapter Isochronous interface.  Definition can be found in the Wireless USB Specification in Chapter 8
 +
|-
 +
|colspan="2"|''Miscellaneous''
 +
|-
 +
| <code>USB_PROTOCOL_MISCELLANEOUS_ACTIVESYNC = $01;</code>
 +
| Active Sync device
 +
|-
 +
| <code>USB_PROTOCOL_MISCELLANEOUS_PALMSYNC = $02;</code>
 +
| Palm Sync
 +
|-
 +
| <code>USB_PROTOCOL_MISCELLANEOUS_IAD = $01;</code>
 +
| Interface Association Descriptor. The usage of this class code triple is defined in the Interface Association Descriptor ECN
 +
|-
 +
| <code>USB_PROTOCOL_MISCELLANEOUS_WAMP = $02;</code>
 +
| Wire Adapter Multifunction Peripheral programming interface. Definition can be found in the Wireless USB Specification in Chapter 8.
 +
|-
 +
| <code>USB_PROTOCOL_MISCELLANEOUS_CBAF = $01;</code>
 +
| Cable Based Association Framework. This is defined in the Association Model addendum to the Wireless USB specification.
 +
|-
 +
| <code>USB_PROTOCOL_MISCELLANEOUS_RNDIS_ETHERNET = $01;</code>
 +
| RNDIS over Ethernet
 +
|-
 +
| <code>USB_PROTOCOL_MISCELLANEOUS_RNDIS_WIFI = $02;</code>
 +
| RNDIS over WiFi
 +
|-
 +
| <code>USB_PROTOCOL_MISCELLANEOUS_RNDIS_WIMAX = $03;</code>
 +
| RNDIS over WiMAX
 +
|-
 +
| <code>USB_PROTOCOL_MISCELLANEOUS_RNDIS_WWAN = $04;</code>
 +
| RNDIS over WWAN
 +
|-
 +
| <code>USB_PROTOCOL_MISCELLANEOUS_RNDIS_IPV4 = $05;</code>
 +
| RNDIS for Raw IPv4
 +
|-
 +
| <code>USB_PROTOCOL_MISCELLANEOUS_RNDIS_IPV6 = $06;</code>
 +
| RNDIS for Raw IPv6
 +
|-
 +
| <code>USB_PROTOCOL_MISCELLANEOUS_RNDIS_GPRS = $07;</code>
 +
| RNDIS for GPRS
 +
|-
 +
| <code>USB_PROTOCOL_MISCELLANEOUS_USB3VISION_CONTROL = $00;</code>
 +
| USB3 Vision Control Interface
 +
|-
 +
| <code>USB_PROTOCOL_MISCELLANEOUS_USB3VISION_EVENT = $01;</code>
 +
| USB3 Vision Event Interface
 +
|-
 +
| <code>USB_PROTOCOL_MISCELLANEOUS_USB3VISION_STREAM = $02;</code>
 +
| USB3 Vision Streaming Interface
 +
|-
 +
|colspan="2"|''Application Specific''
 +
|-
 +
| <code>USB_PROTOCOL_APPLICATION_SPECIFIC_DFU_DEFAULT = $01;</code>
 +
| Device Firmware Upgrade
 +
|-
 +
| <code>USB_PROTOCOL_APPLICATION_SPECIFIC_IRDA_DEFAULT = $00;</code>
 +
| IRDA Bridge device
 +
|-
 +
| <code>USB_PROTOCOL_APPLICATION_SPECIFIC_TMC_DEFAULT = $00;</code>
 +
| USB Test and Measurement Device
 +
|-
 +
| <code>USB_PROTOCOL_APPLICATION_SPECIFIC_TMC_488 = $01;</code>
 +
| USB Test and Measurement Device conforming to the USBTMC USB488 Subclass Specification
 +
|-
 +
|}
 +
</div></div>
 +
<br />
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 20px; padding-bottom: 15px;">
 +
<div style="font-size: 14px; padding-left: 12px;">'''USB primary language ID constants''' <code> USB_LANG_* </code></div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
|colspan="2"|See Language Identifiers supplement to the USB 2.0 specification
 +
|-
 +
|colspan="2"|These are the first 10 bits of the 16-bit language identifier
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
|colspan="2"|''Reserved $00''
 +
|-
 +
| <code>USB_LANG_ARABIC = $01;</code>
 +
| Arabic
 +
|-
 +
| <code>USB_LANG_BULGARIAN = $02;</code>
 +
| Bulgarian
 +
|-
 +
| <code>USB_LANG_CATALAN = $03;</code>
 +
| Catalan
 +
|-
 +
| <code>USB_LANG_CHINESE = $04;</code>
 +
| Chinese
 +
|-
 +
| <code>USB_LANG_CZECH = $05;</code>
 +
| Czech
 +
|-
 +
| <code>USB_LANG_DANISH = $06;</code>
 +
| Danish
 +
|-
 +
| <code>USB_LANG_GERMAN = $07;</code>
 +
| German
 +
|-
 +
| <code>USB_LANG_GREEK = $08;</code>
 +
| Greek
 +
|-
 +
| <code>USB_LANG_ENGLISH = $09;</code>
 +
| English
 +
|-
 +
| <code>USB_LANG_SPANISH = $0a;</code>
 +
| Spanish
 +
|-
 +
| <code>USB_LANG_FINNISH = $0b;</code>
 +
| Finnish
 +
|-
 +
| <code>USB_LANG_FRENCH = $0c;</code>
 +
| French
 +
|-
 +
| <code>USB_LANG_HEBREW = $0d;</code>
 +
| Hebrew
 +
|-
 +
| <code>USB_LANG_HUNGARIAN = $0e;</code>
 +
| Hungarian
 +
|-
 +
| <code>USB_LANG_ICELANDIC = $0f;</code>
 +
| Icelandic
 +
|-
 +
| <code>USB_LANG_ITALIAN = $10;</code>
 +
| Italian
 +
|-
 +
| <code>USB_LANG_JAPANESE = $11;</code>
 +
| Japanese
 +
|-
 +
| <code>USB_LANG_KOREAN = $12;</code>
 +
| Korean
 +
|-
 +
| <code>USB_LANG_DUTCH = $13;</code>
 +
| Dutch
 +
|-
 +
| <code>USB_LANG_NORWEGIAN = $14;</code>
 +
| Norwegian
 +
|-
 +
| <code>USB_LANG_POLISH = $15;</code>
 +
| Polish
 +
|-
 +
| <code>USB_LANG_PORTUGUESE = $16;</code>
 +
| Portuguese
 +
|-
 +
| <code>USB_LANG_ROMANIAN = $18;</code>
 +
| Romanian
 +
|-
 +
| <code>USB_LANG_RUSSIAN = $19;</code>
 +
| Russian
 +
|-
 +
| <code>USB_LANG_CROATIAN = $1a;</code>
 +
| Croatian
 +
|-
 +
| <code>USB_LANG_SERBIAN = $1a;</code>
 +
| Serbian
 +
|-
 +
| <code>USB_LANG_SLOVAK = $1b;</code>
 +
| Slovak
 +
|-
 +
| <code>USB_LANG_ALBANIAN = $1c;</code>
 +
| Albanian
 +
|-
 +
| <code>USB_LANG_SWEDISH = $1d;</code>
 +
| Swedish
 +
|-
 +
| <code>USB_LANG_THAI = $1e;</code>
 +
| Thai
 +
|-
 +
| <code>USB_LANG_TURKISH = $1f;</code>
 +
| Turkish
 +
|-
 +
| <code>USB_LANG_URDU = $20;</code>
 +
| Urdu
 +
|-
 +
| <code>USB_LANG_INDONESIAN = $21;</code>
 +
| Indonesian
 +
|-
 +
| <code>USB_LANG_UKRANIAN = $22;</code>
 +
| Ukrainian
 +
|-
 +
| <code>USB_LANG_BELARUSIAN = $23;</code>
 +
| Belarusian
 +
|-
 +
| <code>USB_LANG_SLOVENIAN = $24;</code>
 +
| Slovenian
 +
|-
 +
| <code>USB_LANG_ESTONIAN = $25;</code>
 +
| Estonian
 +
|-
 +
| <code>USB_LANG_LATVIAN = $26;</code>
 +
| Latvian
 +
|-
 +
| <code>USB_LANG_LITHUANIAN = $27;</code>
 +
| Lithuanian
 +
|-
 +
| <code>USB_LANG_FARSI = $29;</code>
 +
| Farsi
 +
|-
 +
| <code>USB_LANG_VIETNAMESE = $2a;</code>
 +
| Vietnamese
 +
|-
 +
| <code>USB_LANG_ARMENIAN = $2b;</code>
 +
| Armenian
 +
|-
 +
| <code>USB_LANG_AZERI = $2c;</code>
 +
| Azeri
 +
|-
 +
| <code>USB_LANG_BASQUE = $2d;</code>
 +
| Basque
 +
|-
 +
| <code>USB_LANG_MACEDONIAN = $2f;</code>
 +
| Macedonian
 +
|-
 +
| <code>USB_LANG_AFRIKAANS = $36;</code>
 +
| Afrikaans
 +
|-
 +
| <code>USB_LANG_GEORGIAN = $37;</code>
 +
| Georgian
 +
|-
 +
| <code>USB_LANG_FAEROESE = $38;</code>
 +
| Faeroese
 +
|-
 +
| <code>USB_LANG_HINDI = $39;</code>
 +
| Hindi
 +
|-
 +
| <code>USB_LANG_MALAY = $3e;</code>
 +
| Malay
 +
|-
 +
| <code>USB_LANG_KAZAK = $3f;</code>
 +
| Kazak
 +
|-
 +
| <code>USB_LANG_SWAHILI = $41;</code>
 +
| Swahili
 +
|-
 +
| <code>USB_LANG_UZBEK = $43;</code>
 +
| Uzbek
 +
|-
 +
| <code>USB_LANG_TATAR = $44;</code>
 +
| Tatar
 +
|-
 +
| <code>USB_LANG_BENGALI = $45;</code>
 +
| Bengali
 +
|-
 +
| <code>USB_LANG_PUNJABI = $46;</code>
 +
| Punjabi
 +
|-
 +
| <code>USB_LANG_GUJARATI = $47;</code>
 +
| Gujarati
 +
|-
 +
| <code>USB_LANG_ORIYA = $48;</code>
 +
| Oriya
 +
|-
 +
| <code>USB_LANG_TAMIL = $49;</code>
 +
| Tamil
 +
|-
 +
| <code>USB_LANG_TELUGU = $4a;</code>
 +
| Telugu
 +
|-
 +
| <code>USB_LANG_KANNADA = $4b;</code>
 +
| Kannada
 +
|-
 +
| <code>USB_LANG_MALAYALAM = $4c;</code>
 +
| Malayalam
 +
|-
 +
| <code>USB_LANG_ASSAMESE = $4d;</code>
 +
| Assamese
 +
|-
 +
| <code>USB_LANG_MARATHI = $4e;</code>
 +
| Marathi
 +
|-
 +
| <code>USB_LANG_SANSKRIT = $4f;</code>
 +
| Sanskrit
 +
|-
 +
| <code>USB_LANG_KONKANI = $57;</code>
 +
| Konkani
 +
|-
 +
| <code>USB_LANG_MANIPURI = $58;</code>
 +
| Manipuri
 +
|-
 +
| <code>USB_LANG_SINDHI = $59;</code>
 +
| Sindhi
 +
|-
 +
| <code>USB_LANG_KASHMIRI = $60;</code>
 +
| Kashmiri
 +
|-
 +
| <code>USB_LANG_NEPALI = $61;</code>
 +
| Nepali
 +
|-
 +
|colspan="2"|''Reserved $62-$fe''
 +
|-
 +
| <code>USB_LANG_HID = $ff;</code>
 +
| Reserved for USB HID Class use
 +
|-
 +
|colspan="2"|''Reserved $100-$3ff''
 +
|-
 +
| <code>USB_PRIMARY_LANGUAGE_MASK = $3ff;</code>
 +
| &nbsp;
 +
|-
 +
|}
 +
</div></div>
 +
<br />
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 20px; padding-bottom: 15px;">
 +
<div style="font-size: 14px; padding-left: 12px;">'''USB sublanguage ID constants''' <code> USB_SUBLANG_* </code></div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
|colspan="2"|See Language Identifiers supplement to the USB 2.0 specification
 +
|-
 +
|colspan="2"|These are the upper 6 bits of the 16-bit language identifier
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
|colspan="2"|''Reserved $00-$02''
 +
|-
 +
| <code>USB_SUBLANG_ARABIC_SAUDI_ARABIA = $01;</code>
 +
| Arabic (Saudi Arabia)
 +
|-
 +
| <code>USB_SUBLANG_ARABIC_IRAQ = $02;</code>
 +
| Arabic (Iraq)
 +
|-
 +
| <code>USB_SUBLANG_ARABIC_EGYPT = $03;</code>
 +
| Arabic (Egypt)
 +
|-
 +
| <code>USB_SUBLANG_ARABIC_LIBYA = $04;</code>
 +
| Arabic (Libya)
 +
|-
 +
| <code>USB_SUBLANG_ARABIC_ALGERIA = $05;</code>
 +
| Arabic (Algeria)
 +
|-
 +
| <code>USB_SUBLANG_ARABIC_MOROCCO = $06;</code>
 +
| Arabic (Morocco)
 +
|-
 +
| <code>USB_SUBLANG_ARABIC_TUNISIA = $07;</code>
 +
| Arabic (Tunisia)
 +
|-
 +
| <code>USB_SUBLANG_ARABIC_OMAN = $08;</code>
 +
| Arabic (Oman)
 +
|-
 +
| <code>USB_SUBLANG_ARABIC_YEMEN = $09;</code>
 +
| Arabic (Yemen)
 +
|-
 +
| <code>USB_SUBLANG_ARABIC_SYRIA = $10;</code>
 +
| Arabic (Syria)
 +
|-
 +
| <code>USB_SUBLANG_ARABIC_JORDAN = $11;</code>
 +
| Arabic (Jordan)
 +
|-
 +
| <code>USB_SUBLANG_ARABIC_LEBANON = $12;</code>
 +
| Arabic (Lebanon)
 +
|-
 +
| <code>USB_SUBLANG_ARABIC_KUWAIT = $13;</code>
 +
| Arabic (Kuwait)
 +
|-
 +
| <code>USB_SUBLANG_ARABIC_UAE = $14;</code>
 +
| Arabic (U.A.E.)
 +
|-
 +
| <code>USB_SUBLANG_ARABIC_BAHRAIN = $15;</code>
 +
| Arabic (Bahrain)
 +
|-
 +
| <code>USB_SUBLANG_ARABIC_QATAR = $16;</code>
 +
| Arabic (Qatar)
 +
|-
 +
| <code>USB_SUBLANG_AZERI_CYRILLIC = $01;</code>
 +
| Azeri (Cyrillic)
 +
|-
 +
| <code>USB_SUBLANG_AZERI_LATIN = $02;</code>
 +
| Azeri (Latin)
 +
|-
 +
| <code>USB_SUBLANG_CHINESE_TRADITIONAL = $01;</code>
 +
| Chinese (Traditional)
 +
|-
 +
| <code>USB_SUBLANG_CHINESE_SIMPLIFIED = $02;</code>
 +
| Chinese (Simplified)
 +
|-
 +
| <code>USB_SUBLANG_CHINESE_HONGKONG = $03;</code>
 +
| Chinese (Hong Kong SAR, PRC)
 +
|-
 +
| <code>USB_SUBLANG_CHINESE_SINGAPORE = $04;</code>
 +
| Chinese (Singapore)
 +
|-
 +
| <code>USB_SUBLANG_CHINESE_MACAU = $05;</code>
 +
| Chinese (Macau SAR)
 +
|-
 +
| <code>USB_SUBLANG_DUTCH = $01;</code>
 +
| Dutch
 +
|-
 +
| <code>USB_SUBLANG_DUTCH_BELGIAN = $02;</code>
 +
| Dutch (Belgian)
 +
|-
 +
| <code>USB_SUBLANG_ENGLISH_US = $01;</code>
 +
| English (US)
 +
|-
 +
| <code>USB_SUBLANG_ENGLISH_UK = $02;</code>
 +
| English (UK)
 +
|-
 +
| <code>USB_SUBLANG_ENGLISH_AUS = $03;</code>
 +
| English (Australian)
 +
|-
 +
| <code>USB_SUBLANG_ENGLISH_CAN = $04;</code>
 +
| English (Canadian)
 +
|-
 +
| <code>USB_SUBLANG_ENGLISH_NZ = $05;</code>
 +
| English (New Zealand)
 +
|-
 +
| <code>USB_SUBLANG_ENGLISH_EIRE = $06;</code>
 +
| English (Ireland)
 +
|-
 +
| <code>USB_SUBLANG_ENGLISH_SOUTH_AFRICA = $07;</code>
 +
| English (South Africa)
 +
|-
 +
| <code>USB_SUBLANG_ENGLISH_JAMAICA = $08;</code>
 +
| English (Jamaica)
 +
|-
 +
| <code>USB_SUBLANG_ENGLISH_CARIBBEAN = $09;</code>
 +
| English (Caribbean)
 +
|-
 +
| <code>USB_SUBLANG_ENGLISH_BELIZE = $0a;</code>
 +
| English (Belize)
 +
|-
 +
| <code>USB_SUBLANG_ENGLISH_TRINIDAD = $0b;</code>
 +
| English (Trinidad)
 +
|-
 +
| <code>USB_SUBLANG_ENGLISH_PHILIPPINES = $0c;</code>
 +
| English (Zimbabwe)
 +
|-
 +
| <code>USB_SUBLANG_ENGLISH_ZIMBABWE  = $0d;</code>
 +
| English (Philippines)
 +
|-
 +
| <code>USB_SUBLANG_FRENCH  = $01;</code>
 +
| French
 +
|-
 +
| <code>USB_SUBLANG_FRENCH_BELGIAN = $02;</code>
 +
| French (Belgian)
 +
|-
 +
| <code>USB_SUBLANG_FRENCH_CANADIAN = $03;</code>
 +
| French (Canadian)
 +
|-
 +
| <code>USB_SUBLANG_FRENCH_SWISS = $04;</code>
 +
| French (Swiss)
 +
|-
 +
| <code>USB_SUBLANG_FRENCH_LUXEMBOURG = $05;</code>
 +
| French (Luxembourg)
 +
|-
 +
| <code>USB_SUBLANG_FRENCH_MONACO = $06;</code>
 +
| French (Monaco)
 +
|-
 +
| <code>USB_SUBLANG_GERMAN = $01;</code>
 +
| German
 +
|-
 +
| <code>USB_SUBLANG_GERMAN_SWISS = $02;</code>
 +
| German (Swiss)
 +
|-
 +
| <code>USB_SUBLANG_GERMAN_AUSTRIAN = $03;</code>
 +
| German (Austrian)
 +
|-
 +
| <code>USB_SUBLANG_GERMAN_LUXEMBOURG = $04;</code>
 +
| German (Luxembourg)
 +
|-
 +
| <code>USB_SUBLANG_GERMAN_LIECHTENSTEIN = $05;</code>
 +
| German (Liechtenstein)
 +
|-
 +
| <code>USB_SUBLANG_ITALIAN = $01;</code>
 +
| Italian
 +
|-
 +
| <code>USB_SUBLANG_ITALIAN_SWISS = $02;</code>
 +
| Italian (Swiss)
 +
|-
 +
| <code>USB_SUBLANG_KASHMIRI_INDIA = $02;</code>
 +
| Kashmiri (India)
 +
|-
 +
| <code>USB_SUBLANG_KOREAN = $01;</code>
 +
| Korean
 +
|-
 +
| <code>USB_SUBLANG_LITHUANIAN = $01;</code>
 +
| Lithuanian
 +
|-
 +
| <code>USB_SUBLANG_MALAY_MALAYSIA = $01;</code>
 +
| Malay (Malaysia)
 +
|-
 +
| <code>USB_SUBLANG_MALAY_BRUNEI_DARUSSALAM = $02;</code>
 +
| Malay (Brunei Darassalam)
 +
|-
 +
| <code>USB_SUBLANG_NEPALI_INDIA = $02;</code>
 +
| Nepali (India)
 +
|-
 +
| <code>USB_SUBLANG_NORWEGIAN_BOKMAL = $01;</code>
 +
| Norwegian (Bokmal)
 +
|-
 +
| <code>USB_SUBLANG_NORWEGIAN_NYNORSK = $02;</code>
 +
| Norwegian (Nynorsk)
 +
|-
 +
| <code>USB_SUBLANG_PORTUGUESE = $01;</code>
 +
| Portuguese (Brazilian)
 +
|-
 +
| <code>USB_SUBLANG_PORTUGUESE_BRAZILIAN = $02;</code>
 +
| Portuguese
 +
|-
 +
| <code>USB_SUBLANG_SERBIAN_LATIN = $02;</code>
 +
| Serbian (Latin)
 +
|-
 +
| <code>USB_SUBLANG_SERBIAN_CYRILLIC = $03;</code>
 +
| Serbian (Cyrillic)
 +
|-
 +
| <code>USB_SUBLANG_SPANISH = $01;</code>
 +
| Spanish (Castilian)
 +
|-
 +
| <code>USB_SUBLANG_SPANISH_MEXICAN = $02;</code>
 +
| Spanish (Mexican)
 +
|-
 +
| <code>USB_SUBLANG_SPANISH_MODERN = $03;</code>
 +
| Spanish (Modern)
 +
|-
 +
| <code>USB_SUBLANG_SPANISH_GUATEMALA = $04;</code>
 +
| Spanish (Guatemala)
 +
|-
 +
| <code>USB_SUBLANG_SPANISH_COSTA_RICA = $05;</code>
 +
| Spanish (Costa Rica)
 +
|-
 +
| <code>USB_SUBLANG_SPANISH_PANAMA = $06;</code>
 +
| Spanish (Panama)
 +
|-
 +
| <code>USB_SUBLANG_SPANISH_DOMINICAN_REPUBLIC = $07;</code>
 +
| Spanish (Dominican Republic)
 +
|-
 +
| <code>USB_SUBLANG_SPANISH_VENEZUELA = $08;</code>
 +
| Spanish (Venezuela)
 +
|-
 +
| <code>USB_SUBLANG_SPANISH_COLOMBIA = $09;</code>
 +
| Spanish (Colombia)
 +
|-
 +
| <code>USB_SUBLANG_SPANISH_PERU = $0a;</code>
 +
| Spanish (Peru)
 +
|-
 +
| <code>USB_SUBLANG_SPANISH_ARGENTINA = $0b;</code>
 +
| Spanish (Argentina)
 +
|-
 +
| <code>USB_SUBLANG_SPANISH_ECUADOR = $0c;</code>
 +
| Spanish (Ecuador)
 +
|-
 +
| <code>USB_SUBLANG_SPANISH_CHILE = $0d;</code>
 +
| Spanish (Chile)
 +
|-
 +
| <code>USB_SUBLANG_SPANISH_URUGUAY = $0e;</code>
 +
| Spanish (Uruguay)
 +
|-
 +
| <code>USB_SUBLANG_SPANISH_PARAGUAY = $0f;</code>
 +
| Spanish (Paraguay)
 +
|-
 +
| <code>USB_SUBLANG_SPANISH_BOLIVIA = $10;</code>
 +
| Spanish (Bolivia)
 +
|-
 +
| <code>USB_SUBLANG_SPANISH_EL_SALVADOR = $11;</code>
 +
| Spanish (El Salvador)
 +
|-
 +
| <code>USB_SUBLANG_SPANISH_HONDURAS = $12;</code>
 +
| Spanish (Honduras)
 +
|-
 +
| <code>USB_SUBLANG_SPANISH_NICARAGUA = $13;</code>
 +
| Spanish (Nicaragua)
 +
|-
 +
| <code>USB_SUBLANG_SPANISH_PUERTO_RICO = $14;</code>
 +
| Spanish (Puerto Rico)
 +
|-
 +
| <code>USB_SUBLANG_SWEDISH = $01;</code>
 +
| Swedish
 +
|-
 +
| <code>USB_SUBLANG_SWEDISH_FINLAND = $02;</code>
 +
| Swedish (Finland)
 +
|-
 +
| <code>USB_SUBLANG_URDU_PAKISTAN = $01;</code>
 +
| Urdu (Pakistan)
 +
|-
 +
| <code>USB_SUBLANG_URDU_INDIA = $02;</code>
 +
| Urdu (India)
 +
|-
 +
| <code>USB_SUBLANG_UZBEK_LATIN = $01;</code>
 +
| Uzbek (Latin)
 +
|-
 +
| <code>USB_SUBLANG_UZBEK_CYRILLIC = $02;</code>
 +
| Uzbek (Cyrillic)
 +
|-
 +
| <code>USB_SUBLANG_HID_USAGE_DATA_DESCRIPTOR = $01;</code>
 +
| HID (Usage Data Descriptor)
 +
|-
 +
| <code>USB_SUBLANG_HID_VENDOR_DEFINED_1 = $3c;</code>
 +
| HID (Vendor Defined 1)
 +
|-
 +
| <code>USB_SUBLANG_HID_VENDOR_DEFINED_2 = $3d;</code>
 +
| HID (Vendor Defined 2)
 +
|-
 +
| <code>USB_SUBLANG_HID_VENDOR_DEFINED_3 = $3e;</code>
 +
| HID (Vendor Defined 3)
 +
|-
 +
| <code>USB_SUBLANG_HID_VENDOR_DEFINED_4 = $3f;</code>
 +
| HID (Vendor Defined 4)
 +
|-
 +
|}
 +
</div></div>
 +
<br />
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 20px; padding-bottom: 15px;">
 +
<div style="font-size: 14px; padding-left: 12px;">'''USB primary language identifier constants''' <code> USB_LANGID_* </code></div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
|colspan="2"|See Language Identifiers supplement to the USB 2.0 specification
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>USB_LANGID_US_ENGLISH = (USB_LANG_ENGLISH or (USB_SUBLANG_ENGLISH_US shl 10));</code>
 +
| English (US)
 +
|-
 +
| <code>USB_LANGID_UK_ENGLISH = (USB_LANG_ENGLISH or (USB_SUBLANG_ENGLISH_UK shl 10));</code>
 +
| English (UK)
 +
|-
 +
| <code>USB_LANGID_AUS_ENGLISH = (USB_LANG_ENGLISH or (USB_SUBLANG_ENGLISH_AUS shl 10));</code>
 +
| English (Australian)
 +
|-
 +
| <code>USB_LANGID_CAN_ENGLISH = (USB_LANG_ENGLISH or (USB_SUBLANG_ENGLISH_CAN shl 10));</code>
 +
| English (Canadian)
 +
|-
 +
| <code>USB_LANGID_NZ_ENGLISH = (USB_LANG_ENGLISH or (USB_SUBLANG_ENGLISH_NZ shl 10));</code>
 +
| English (New Zealand)
 +
|-
 +
| <code>USB_LANGID_EIRE_ENGLISH = (USB_LANG_ENGLISH or (USB_SUBLANG_ENGLISH_EIRE shl 10));</code>
 +
| English (Ireland)
 +
|-
 +
| <code>USB_LANGID_SOUTH_AFRICA_ENGLISH = (USB_LANG_ENGLISH or (USB_SUBLANG_ENGLISH_SOUTH_AFRICA shl 10));</code>
 +
| English (South Africa)
 +
|-
 +
| <code>USB_LANGID_JAMAICA_ENGLISH = (USB_LANG_ENGLISH or (USB_SUBLANG_ENGLISH_JAMAICA shl 10));</code>
 +
| English (Jamaica)
 +
|-
 +
| <code>USB_LANGID_CARIBBEAN_ENGLISH = (USB_LANG_ENGLISH or (USB_SUBLANG_ENGLISH_CARIBBEAN shl 10));</code>
 +
| English (Caribbean)
 +
|-
 +
| <code>USB_LANGID_BELIZE_ENGLISH = (USB_LANG_ENGLISH or (USB_SUBLANG_ENGLISH_BELIZE shl 10));</code>
 +
| English (Belize)
 +
|-
 +
| <code>USB_LANGID_TRINIDAD_ENGLISH = (USB_LANG_ENGLISH or (USB_SUBLANG_ENGLISH_TRINIDAD shl 10));</code>
 +
| English (Trinidad)
 +
|-
 +
| <code>USB_LANGID_PHILIPPINES_ENGLISH = (USB_LANG_ENGLISH or (USB_SUBLANG_ENGLISH_PHILIPPINES shl 10));</code>
 +
| English (Philippines)
 +
|-
 +
| <code>USB_LANGID_ZIMBABWE_ENGLISH = (USB_LANG_ENGLISH or (USB_SUBLANG_ENGLISH_ZIMBABWE shl 10));</code>
 +
| English (Zimbabwe)
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>USB_LANGID_USAGE_HID = (USB_LANG_HID or (USB_SUBLANG_HID_USAGE_DATA_DESCRIPTOR shl 10));</code>
 +
| &nbsp;
 +
|-
 +
| <code>USB_LANGID_VENDOR1_HID = (USB_LANG_HID or (USB_SUBLANG_HID_VENDOR_DEFINED_1 shl 10));</code>
 +
| &nbsp;
 +
|-
 +
| <code>USB_LANGID_VENDOR2_HID = (USB_LANG_HID or (USB_SUBLANG_HID_VENDOR_DEFINED_2 shl 10));</code>
 +
| &nbsp;
 +
|-
 +
| <code>USB_LANGID_VENDOR3_HID = (USB_LANG_HID or (USB_SUBLANG_HID_VENDOR_DEFINED_3 shl 10));</code>
 +
| &nbsp;
 +
|-
 +
| <code>USB_LANGID_VENDOR4_HID = (USB_LANG_HID or (USB_SUBLANG_HID_VENDOR_DEFINED_4 shl 10));</code>
 +
| &nbsp;
 +
|-
 +
|}
 +
</div></div>
 +
<br />
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 20px; padding-bottom: 15px;">
 +
<div style="font-size: 14px; padding-left: 12px;">'''USB vendor ID constants''' <code> USB_VENDORID_* </code></div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
| <code>USB_VENDORID_REALTEK = $0BDA;</code>
 +
| Realtek
 +
|-
 +
|}
 +
</div></div>
 +
<br />
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 20px; padding-bottom: 15px;">
 +
<div style="font-size: 14px; padding-left: 12px;">'''USB tree output constants''' <code> USB_TREE_* </code></div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
| <code>USB_TREE_SPACES_PER_LEVEL = 6;</code>
 +
| style="width: 50%;"|&nbsp;
 +
|-
 +
| <code>USB_TREE_LINES_PER_PORT = 2;</code>
 +
| &nbsp;
 +
|-
 +
|}
 +
</div></div>
 +
<br />
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 20px; padding-bottom: 15px;">
 +
<div style="font-size: 14px; padding-left: 12px;">'''USB logging constants''' <code> USB_LOG_* </code></div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
| <code>USB_LOG_LEVEL_DEBUG = LOG_LEVEL_DEBUG;</code>
 +
| USB debugging messages
 +
|-
 +
| <code>USB_LOG_LEVEL_INFO = LOG_LEVEL_INFO;</code>
 +
| USB informational messages, such as a device being attached or detached
 +
|-
 +
| <code>USB_LOG_LEVEL_ERROR = LOG_LEVEL_ERROR;</code>
 +
| USB error messages
 +
|-
 +
| <code>USB_LOG_LEVEL_NONE = LOG_LEVEL_NONE;</code>
 +
| No USB messages
 +
|-
 +
|}
 +
</div></div>
 +
<br />
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 20px; padding-bottom: 15px;">
 +
<div style="font-size: 14px; padding-left: 12px;">'''USB hub specific constants''' <code> USB_HUB_* </code></div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
| <code>USB_HUB_PREFIX = 'USBHub';</code>
 +
| Name prefix for USB Hubs
 +
|-
 +
|}
 +
</div></div>
 +
<br />
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 20px; padding-bottom: 15px;">
 +
<div style="font-size: 14px; padding-left: 12px;">'''USB hub type constants''' <code> USBHUB_TYPE_* </code></div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
| <code>USBHUB_TYPE_NONE = 0;</code>
 +
| style="width: 50%;"|&nbsp;
 +
|-
 +
|}
 +
</div></div>
 +
<br />
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 20px; padding-bottom: 15px;">
 +
<div style="font-size: 14px; padding-left: 12px;">'''USB hub state constants''' <code> USBHUB_STATE_* </code></div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
| <code>USBHUB_STATE_DETACHED = 0;</code>
 +
| style="width: 50%;"|&nbsp;
 +
|-
 +
| <code>USBHUB_STATE_DETACHING = 1;</code>
 +
| &nbsp;
 +
|-
 +
| <code>USBHUB_STATE_ATTACHING = 2;</code>
 +
| &nbsp;
 +
|-
 +
| <code>USBHUB_STATE_ATTACHED = 3;</code>
 +
| &nbsp;
 +
|-
 +
|}
 +
</div></div>
 +
<br />
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 20px; padding-bottom: 15px;">
 +
<div style="font-size: 14px; padding-left: 12px;">'''USB hub flag constants''' <code> USBHUB_FLAG_* </code></div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
| <code>USBHUB_FLAG_NONE = $00000000;</code>
 +
| style="width: 50%;"|&nbsp;
 +
|-
 +
|}
 +
</div></div>
 +
<br />
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 20px; padding-bottom: 15px;">
 +
<div style="font-size: 14px; padding-left: 12px;">'''USB hub thread constants''' <code> USBHUB_THREAD_* </code></div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
| <code>USBHUB_THREAD_STACK_SIZE = SIZE_32K;</code>
 +
| Stack size of USB hub thread}
 +
|-
 +
| <code>USBHUB_THREAD_PRIORITY = THREAD_PRIORITY_HIGHEST;</code>
 +
| Priority of USB hub thread
 +
|-
 +
| <code>USBHUB_THREAD_NAME = 'USB Hub';</code>
 +
| Name of USB hub thread
 +
|-
 +
|}
 +
</div></div>
 +
<br />
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 20px; padding-bottom: 15px;">
 +
<div style="font-size: 14px; padding-left: 12px;">'''USB hub driver constants''' <code> USBHUB_DRIVER_* </code></div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
| <code>USBHUB_DRIVER_NAME = 'USB Hub Driver';</code>
 +
| Name of USB hub driver
 +
|-
 +
|}
 +
</div></div>
 +
<br />
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 20px; padding-bottom: 15px;">
 +
<div style="font-size: 14px; padding-left: 12px;">'''USB port reset constants''' <code> USB_PORT_RESET_* </code></div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
| <code>USB_PORT_RESET_TIMEOUT = 800;</code>
 +
| Maximum milliseconds to wait for a port to reset (800 is the same value that Linux uses)
 +
|-
 +
| <code>USB_PORT_RESET_DELAY = 10;</code>
 +
| Milliseconds between each status check on the port while waiting for it to finish being reset (Linux uses several values, but 10 is the default case)
 +
|-
 +
| <code>USB_PORT_RESET_RECOVERY = 30;</code>
 +
| Milliseconds to wait after port reset to allow the device attached to the port to recover before any data transfers. USB 2.0 spec says 10ms
 +
|-
 +
|}
 +
</div></div>
 +
<br />
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 20px; padding-bottom: 15px;">
 +
<div style="font-size: 14px; padding-left: 12px;">'''USB hub characteristic constants''' <code> USB_HUB_CHARACTERISTIC_* </code></div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
|colspan="2"|Values for wHubCharacteristics in type TUSBHubDescriptor
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>USB_HUB_CHARACTERISTIC_IS_COMPOUND_DEVICE = (1 shl 2);</code>
 +
| style="width: 50%;"|&nbsp;
 +
|-
 +
|}
 +
</div></div>
 +
<br />
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 20px; padding-bottom: 15px;">
 +
<div style="font-size: 14px; padding-left: 12px;">'''USB hub feature constants''' <code> USB_C_HUB_* </code></div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
|colspan="2"|See Table 11-17 in Section 11.24.2 of the USB 2.0 specification
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>USB_C_HUB_LOCAL_POWER = 0;</code>
 +
| style="width: 50%;"|&nbsp;
 +
|-
 +
| <code>USB_C_HUB_OVER_CURRENT = 1;</code>
 +
| &nbsp;
 +
|-
 +
|}
 +
</div></div>
 +
<br />
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 20px; padding-bottom: 15px;">
 +
<div style="font-size: 14px; padding-left: 12px;">'''USB port feature constants''' <code> USB_PORT_* </code></div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
|colspan="2"|See Table 11-17 in Section 11.24.2 of the USB 2.0 specification
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>USB_PORT_CONNECTION = 0;</code>
 +
| style="width: 50%;"|&nbsp;
 +
|-
 +
| <code>USB_PORT_ENABLE = 1;</code>
 +
| &nbsp;
 +
|-
 +
| <code>USB_PORT_SUSPEND = 2;</code>
 +
| &nbsp;
 +
|-
 +
| <code>USB_PORT_OVER_CURRENT = 3;</code>
 +
| &nbsp;
 +
|-
 +
| <code>USB_PORT_RESET = 4;</code>
 +
| &nbsp;
 +
|-
 +
| <code>USB_PORT_POWER = 8;</code>
 +
| &nbsp;
 +
|-
 +
| <code>USB_PORT_LOW_SPEED = 9;</code>
 +
| &nbsp;
 +
|-
 +
| <code>USB_C_PORT_CONNECTION = 16;</code>
 +
| &nbsp;
 +
|-
 +
| <code>USB_C_PORT_ENABLE = 17;</code>
 +
| &nbsp;
 +
|-
 +
| <code>USB_C_PORT_SUSPEND = 18;</code>
 +
| &nbsp;
 +
|-
 +
| <code>USB_C_PORT_OVER_CURRENT = 19;</code>
 +
| &nbsp;
 +
|-
 +
| <code>USB_C_PORT_RESET = 20;</code>
 +
| &nbsp;
 +
|-
 +
| <code>USB_PORT_TEST = 21;</code>
 +
| &nbsp;
 +
|-
 +
| <code>USB_PORT_INDICATOR = 22;</code>
 +
| &nbsp;
 +
|-
 +
|}
 +
</div></div>
 +
<br />
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 20px; padding-bottom: 15px;">
 +
<div style="font-size: 14px; padding-left: 12px;">'''USB hub class request constants''' <code> USB_HUB_REQUEST_* </code></div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
|colspan="2"|See Table 11-16 in Section 11.24.2 of the USB 2.0 specification
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>USB_HUB_REQUEST_GET_STATUS = 0;</code>
 +
| style="width: 50%;"|&nbsp;
 +
|-
 +
| <code>USB_HUB_REQUEST_CLEAR_FEATURE = 1;</code>
 +
| &nbsp;
 +
|-
 +
| <code>USB_HUB_REQUEST_SET_FEATURE = 3;</code>
 +
| &nbsp;
 +
|-
 +
| <code>USB_HUB_REQUEST_GET_DESCRIPTOR = 6;</code>
 +
| &nbsp;
 +
|-
 +
| <code>USB_HUB_REQUEST_SET_DESCRIPTOR = 7;</code>
 +
| &nbsp;
 +
|-
 +
| <code>USB_HUB_REQUEST_CLEAR_TT_BUFFER = 8;</code>
 +
| &nbsp;
 +
|-
 +
| <code>USB_HUB_REQUEST_RESET_TT = 9;</code>
 +
| &nbsp;
 +
|-
 +
| <code>USB_HUB_REQUEST_GET_TT_STATE = 10;</code>
 +
| &nbsp;
 +
|-
 +
| <code>USB_HUB_REQUEST_STOP_TT = 11;</code>
 +
| &nbsp;
 +
|-
 +
|}
 +
</div></div>
 +
<br />
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 20px; padding-bottom: 15px;">
 +
<div style="font-size: 14px; padding-left: 12px;">'''USB port status constants''' <code> USB_PORT_STATUS_* </code></div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
|colspan="2"|See Table 11-21 in Section 11.24.2.7.1 of the USB 2.0 specification
 +
|-
 +
|colspan="2"|Values for wPortStatus in type TUSBPortStatus
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>USB_PORT_STATUS_CONNNECTED = (1 shl 0);</code>
 +
| style="width: 50%;"|&nbsp;
 +
|-
 +
| <code>USB_PORT_STATUS_ENABLED = (1 shl 1);</code>
 +
| &nbsp;
 +
|-
 +
| <code>USB_PORT_STATUS_SUSPENDED = (1 shl 2);</code>
 +
| &nbsp;
 +
|-
 +
| <code>USB_PORT_STATUS_OVERCURRENT = (1 shl 3);</code>
 +
| &nbsp;
 +
|-
 +
| <code>USB_PORT_STATUS_RESET = (1 shl 4);</code>
 +
| &nbsp;
 +
|-
 +
| <code>USB_PORT_STATUS_POWERED = (1 shl 8);</code>
 +
| &nbsp;
 +
|-
 +
| <code>USB_PORT_STATUS_LOW_SPEED_ATTACHED = (1 shl 9);</code>
 +
| &nbsp;
 +
|-
 +
| <code>USB_PORT_STATUS_HIGH_SPEED_ATTACHED = (1 shl 10);</code>
 +
| &nbsp;
 +
|-
 +
| <code>USB_PORT_STATUS_TEST_MODE = (1 shl 11);</code>
 +
| &nbsp;
 +
|-
 +
| <code>USB_PORT_STATUS_INDICATOR_CONTROL = (1 shl 12);</code>
 +
| &nbsp;
 +
|-
 +
|}
 +
</div></div>
 +
<br />
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 20px; padding-bottom: 15px;">
 +
<div style="font-size: 14px; padding-left: 12px;">'''USB port change constants''' <code> USB_PORT_CHANGE_* </code></div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
|colspan="2"|See Table 11-20 in Section 11.24.2.6 of the USB 2.0 specification
 +
|-
 +
|colspan="2"|Values for wPortChange in type TUSBPortStatus
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>USB_PORT_CHANGE_CONNECTED = (1 shl 0);</code>
 +
| style="width: 50%;"|&nbsp;
 +
|-
 +
| <code>USB_PORT_CHANGE_ENABLED = (1 shl 1);</code>
 +
| &nbsp;
 +
|-
 +
| <code>USB_PORT_CHANGE_SUSPENDED = (1 shl 2);</code>
 +
| &nbsp;
 +
|-
 +
| <code>USB_PORT_CHANGE_OVERCURRENT = (1 shl 3);</code>
 +
| &nbsp;
 +
|-
 +
| <code>USB_PORT_CHANGE_RESET = (1 shl 4);</code>
 +
| &nbsp;
 +
|-
 +
|}
 +
</div></div>
 +
<br />
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 20px; padding-bottom: 15px;">
 +
<div style="font-size: 14px; padding-left: 12px;">'''USB hub status constants''' <code> USB_HUB_STATUS_* </code></div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
|colspan="2"|See Table 11-19 in Section 11.24.2.6 of the USB 2.0 specification
 +
|-
 +
|colspan="2"|Values for wHubStatus in type TUSBHubStatus
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>USB_HUB_STATUS_LOCAL_POWER = (1 shl 0);</code>
 +
| &nbsp;
 +
|-
 +
| <code>USB_HUB_STATUS_OVERCURRENT = (1 shl 1);</code>
 +
| &nbsp;
 +
|-
 +
|}
 +
</div></div>
 +
<br />
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 20px; padding-bottom: 15px;">
 +
<div style="font-size: 14px; padding-left: 12px;">'''USB hub change constants''' <code> USB_HUB_CHANGE_* </code></div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
|colspan="2"|See Table 11-20 in Section 11.24.2.6 of the USB 2.0 specification
 +
|-
 +
|colspan="2"|Values for wHubChange in type TUSBHubStatus
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>USB_HUB_CHANGE_LOCAL_POWER = (1 shl 0);</code>
 +
| &nbsp;
 +
|-
 +
| <code>USB_HUB_CHANGE_OVERCURRENT = (1 shl 1);</code>
 +
| &nbsp;
 
|-
 
|-
 
|}
 
|}

Revision as of 03:54, 30 November 2016

Return to Unit Reference


Description

USB

This unit implements the USB core software that does not depend on the specific host controller hardware and is not specific to any single USB device or platform.

Features and limitations:

  • This driver is written to be compatible with USB 2.0. USB 3.0 devices work correctly when operating in USB 2.0 compatible mode, actual support for USB 3.0 host controllers and native super speed modes will require some modification to this driver.
  • Not all USB transfer types and speeds are supported yet. This depends on the Host Controller Driver, see USBRequestSubmit.
  • This driver does not attempt to do any intelligent power management, bandwidth allocation, or transfer scheduling. Devices are always set to their first listed configuration regardless of power requirements. Requests are simply passed to the Host Controller Driver in the order submitted, the Host Controller Driver is responsible for doing any more intelligent scheduling if desired.
  • This driver does not support multiple configurations per USB device. If a device happens to have multiple configurations, the first one will be assigned (see devices below for more information).
  • By design, it is possible to implement a host controller driver for different host controller hardware without changing any of this code, as long as the host controller driver provides the functions declared in TUSBHost (Start, Stop, Reset, Submit and Cancel).
  • By design, this driver has a hard-coded dependency on the USB hub driver because USB is useless without hubs.

To initialize this core USB driver, USBInit must be called by the system startup code. See that function for details.

If the flag USB_AUTOSTART is not set then USBStart must be called to start the USB core. See that function for details.

The other functions exported by this core USB driver are mostly intended to be used by USB device drivers.

Debugging messages in this driver can be enabled by changing the value of USB_DEFAULT_LOG_LEVEL and by enabling the USB_DEBUG define in GlobalDefines.

Be careful when enabling USB debugging as the USB core can generate a lot of messages due to constant polling of interrupt endpoints on devices such as hubs, keyboards and mice.

USB Device

USB devices are the generic implementation of anything that can be connected to the USB bus. All USB devices require a driver to implement the specific behaviour of the device but at the generic level each device will have:

  • One or more configurations available. The USB core will first offer the device to drivers without a configuration being selected, the driver may choose a specific configuration if required otherwise the core will simply select the first available configuration.
  • One or more interfaces available. On devices with multiple interfaces, the USB core supports different drivers binding to different interfaces. This way combination devices are supported.
  • One or more endpoints available. All devices must have a control endpoint and most devices will have one or more bulk, interrupt or isochronous endpoints as well. The USB core will only communicate with the control endpoint to perform generic operations like reading the desriptors and assigning a device addresss.

Drivers are expected to understand which endpoints they need to communicate with to provide the device specific functionality.

Devices are considered dynamic by the USB core and can be connected or disconnected at any time. The hub driver is responsible for attaching and detaching devices in response to hub status change events and for binding or unbinding drivers as devices are added or removed.

USB Host

USB hosts implement the hardware level interface that supports sending USB requests to the hardware and receiving responses. All handling of interrupts, DMA, transaction sequence, errors and resubmitting/retrying requests is done by the USB host driver. All host drivers must implement the functions defined in TUSBHost (Start, Stop, Reset, Submit and Cancel) and must register themselves with the USB core by calling USBHostRegister. When the USB core is started each registered host driver will be called via the Start function so it can initialize itself and allocate locks, buffers and other resources required to interact with the hardware.

A host driver can also be registered after the USB core has been started and it will be given the opportunity to start itself immediately. In this way USB hosts can potentially be hot pluggable.

Each host driver must also implement a root hub which respresents the port or ports that are directly connected to the controller hardware. In many cases this will not be a real hub but will be simulated in the host driver so that the hub driver can interact with it as though it was a standard hub device.

Constants


[Expand]
USB device, driver and host specific constants USB_*_PREFIX


[Expand]
USB device type constants USB_TYPE_*


[Expand]
USB device state constants USB_STATE_*


[Expand]
USB device status constants USB_STATUS_*


[Expand]
USB device flag constants USB_FLAG_*


[Expand]
USB host type constants USBHOST_TYPE_*


[Expand]
USB host state constants USBHOST_STATE_*


[Expand]
USB host flag constants USBHOST_FLAG_*


[Expand]
USB status code constants USB_STATUS_*


[Expand]
USB request flag constants USB_REQUEST_FLAG_*


[Expand]
USB control phase constants USB_CONTROL_PHASE_*


[Expand]
USB control timeout constants USB_CONTROL_*


[Expand]
USB packet size constants USB_*_*_PACKET_SIZE


[Expand]
USB frame constants USB_FRAMES_*


[Expand]
USB microframe constants USB_UFRAMES_*


[Expand]
USB configuration attribute constants USB_CONFIGURATION_ATTRIBUTE_*


[Expand]
USB device status constants USB_DEVICE_STATUS_*


[Expand]
USB endpoint status constants USB_ENDPOINT_STATUS_*


[Expand]
USB device speed constants USB_SPEED_*


[Expand]
USB transfer type constants USB_TRANSFER_TYPE_*


[Expand]
USB transfer size constants USB_TRANSFER_SIZE_*


[Expand]
USB descriptor type constants USB_DESCRIPTOR_TYPE_*


[Expand]
USB transfer direction constants USB_DIRECTION_*


[Expand]
USB request type constants USB_REQUEST_TYPE_*


[Expand]
USB request recipient constants USB_REQUEST_RECIPIENT_*


[Expand]
USB bmrequest type constants USB_BMREQUESTTYPE_*


[Expand]
USB device request constants USB_DEVICE_REQUEST_*


[Expand]
USB device feature constants USB_DEVICE_FEATURE_*


[Expand]
USB test mode constants USB_DEVICE_TEST_MODE_*


[Expand]
USB packet ID value constants USB_PACKETID_*


[Expand]
USB class code constants USB_CLASS_CODE_*


[Expand]
USB subclass code constants USB_SUBCLASS_*


[Expand]
USB protocol code constants USB_PROTOCOL_*


[Expand]
USB primary language ID constants USB_LANG_*


[Expand]
USB sublanguage ID constants USB_SUBLANG_*


[Expand]
USB primary language identifier constants USB_LANGID_*


[Expand]
USB vendor ID constants USB_VENDORID_*


[Expand]
USB tree output constants USB_TREE_*


[Expand]
USB logging constants USB_LOG_*


[Expand]
USB hub specific constants USB_HUB_*


[Expand]
USB hub type constants USBHUB_TYPE_*


[Expand]
USB hub state constants USBHUB_STATE_*


[Expand]
USB hub flag constants USBHUB_FLAG_*


[Expand]
USB hub thread constants USBHUB_THREAD_*


[Expand]
USB hub driver constants USBHUB_DRIVER_*


[Expand]
USB port reset constants USB_PORT_RESET_*


[Expand]
USB hub characteristic constants USB_HUB_CHARACTERISTIC_*


[Expand]
USB hub feature constants USB_C_HUB_*


[Expand]
USB port feature constants USB_PORT_*


[Expand]
USB hub class request constants USB_HUB_REQUEST_*


[Expand]
USB port status constants USB_PORT_STATUS_*


[Expand]
USB port change constants USB_PORT_CHANGE_*


[Expand]
USB hub status constants USB_HUB_STATUS_*


[Expand]
USB hub change constants USB_HUB_CHANGE_*


Type definitions

To be documented

Public variables

To be documented

Function declarations


Initialization functions

[Expand] 
procedure USBInit;
Description: Performs basic initialization of the USB core driver, after this devices, hosts and drivers can be registered however nothing will work until USBStart is called


[Expand] 
function USBStart:LongWord;
Description: Starts all registered USB hosts, starts the USB hub thread and begins the USB enumeration process. USB enumeration will continue after this function returns as devices are discovered by changes in hub status.


[Expand] 
function USBStop:LongWord;
Description: To be documented


[Expand] 
procedure USBAsyncStart(Host:PUSBHost);
Description: To be documented


USB device, driver and host functions

[Expand] 
function USBDeviceGetAddress(Device:PUSBDevice):Byte;
Description: Get the bus address for the specified device


[Expand] 
function USBDeviceSetAddress(Device:PUSBDevice; Address:Byte):LongWord;
Description: Set the bus address for the specified device


[Expand] 
function USBDeviceGetDescriptor(Device:PUSBDevice; bRequest,bmRequestType:Byte; wValue,wIndex:Word; Data:Pointer; Length:Word):LongWord;
Description: Read any descriptor ?rom the specified device using USBControlRequest


[Expand] 
function USBDeviceGetDeviceDescriptor(Device:PUSBDevice; Data:Pointer; Length:Word):LongWord;
Description: Read all or part of the device descriptor ?rom the specified device using USBControlRequest


[Expand] 
function USBDeviceCreateDeviceDescriptor(Device:PUSBDevice; Length:Word):LongWord;
Description: Allocate a device descriptor for the specified device


[Expand] 
function USBDeviceReadDeviceDescriptor(Device:PUSBDevice; Length:Word):LongWord; inline;
Description: Read all or part of the device descriptor ?rom the specified device using USBControlRequest


[Expand] 
function USBDeviceReadDeviceDescriptorEx(Device:PUSBDevice; Length:Word; AllowShort:Boolean):LongWord;
Description: Read all or part of the device descriptor ?rom the specified device using USBControlRequest


[Expand] 
function USBDeviceCreateConfigurations(Device:PUSBDevice):LongWord;
Description: Allocate the available configurations for this device


[Expand] 
function USBDeviceReadConfigurations(Device:PUSBDevice):LongWord;
Description: Read and parse the available configurations for this device


[Expand] 
function USBDeviceCreateConfiguration(Device:PUSBDevice; Index:Byte; Size:Word):LongWord;
Description: Allocate the specified configuration for this device


[Expand] 
function USBDeviceReadConfiguration(Device:PUSBDevice; Index:Byte):LongWord;
Description: Read and parse the specified configuration for this device


[Expand] 
function USBDeviceGetStringDescriptor(Device:PUSBDevice; Index:Byte; Data:Pointer; Length:Word):LongWord;
Description: Read all or part of the specified string descriptor ?rom the specified device using USBControlRequest


[Expand] 
function USBDeviceReadStringDescriptor(Device:PUSBDevice; Index:Byte):String;
Description: To be documented


[Expand] 
function USBDeviceReadStringDescriptorW(Device:PUSBDevice; Index:Byte):UnicodeString;
Description: To be documented


[Expand] 
function USBDeviceGetConfigurationDescriptor(Device:PUSBDevice; Index:Byte;Data:Pointer; Length:Word):LongWord;
Description: Read all or part of the specified configuration descriptor ?rom the specified device using USBControlRequest


[Expand] 
function USBDeviceGetConfiguration(Device:PUSBDevice; var ConfigurationValue:Byte):LongWord;
Description: Get the current configuration for the specified device


[Expand] 
function USBDeviceSetConfiguration(Device:PUSBDevice; ConfigurationValue:Byte):LongWord;
Description: Set the configuration for the specified device


[Expand] 
function USBDeviceFindConfigurationByValue(Device:PUSBDevice; ConfigurationValue:Byte):PUSBConfiguration;
Description: Find the configuration represented by configuration value for the specified device


[Expand] 
function USBDeviceGetInterface(Device:PUSBDevice; Index:Byte; var AlternateSetting:Byte):LongWord;
Description: Get the interface alternate setting for the specified device


[Expand] 
function USBDeviceFindInterfaceByIndex(Device:PUSBDevice; Index:Byte):PUSBInterface;
Description: Find the interface with the specified index on the specified device


[Expand] 
function USBDeviceFindInterfaceByClass(Device:PUSBDevice; InterfaceClass,InterfaceSubClass,InterfaceProtocol:Byte):PUSBInterface;
Description: Find an interface of the specified class, subclass and protocol on the specified device


[Expand] 
function USBDeviceFindEndpointByIndex(Device:PUSBDevice; Interrface:PUSBInterface; Index:Byte):PUSBEndpointDescriptor;
Description: Find the endpoint with the specified index on the specified interface of the specified device


[Expand] 
function USBDeviceFindEndpointByType(Device:PUSBDevice; Interrface:PUSBInterface; Direction,TransferType:Byte):PUSBEndpointDescriptor;
Description: Find an endpoint of the specified type and direction on the specified interface of the specified device


[Expand] 
function USBDeviceFindEndpointByTypeEx(Device:PUSBDevice; Interrface:PUSBInterface; Direction,TransferType:Byte; var Index:Byte):PUSBEndpointDescriptor;
Description: Find the next endpoint of the specified type and direction on the specified interface of the specified device


[Expand] 
function USBDeviceCountEndpointsByType(Device:PUSBDevice; Interrface:PUSBInterface; Direction,TransferType:Byte):Byte;
Description: Count the number of endpoints of the specified type and direction on the specified interface of the specified device


[Expand] 
function USBDeviceFindAlternateByIndex(Device:PUSBDevice; Interrface:PUSBInterface; Index:Byte):PUSBAlternate;
Description: Find the alternate setting with the specified index on the specified interface of the specified device


[Expand] 
function USBDeviceFindAlternateEndpointByIndex(Device:PUSBDevice; Interrface:PUSBInterface; Alternate:PUSBAlternate; Index:Byte):PUSBEndpointDescriptor;
Description: Find the endpoint with the specified index on the specified alternate setting interface of the specified device


[Expand] 
function USBDeviceFindAlternateEndpointByType(Device:PUSBDevice; Interrface:PUSBInterface; Alternate:PUSBAlternate; Direction,TransferType:Byte):PUSBEndpointDescriptor;
Description: Find an endpoint of the specified type and direction on the specified alternate setting interface of the specified device


[Expand] 
function USBDeviceSetInterface(Device:PUSBDevice; Index,AlternateSetting:Byte):LongWord;
Description: Set the interface alternate setting for the specified device


[Expand] 
function USBDeviceSetFeature(Device:PUSBDevice; Endpoint:PUSBEndpointDescriptor; Feature,Index:Word):LongWord;
Description: Enable a feature on the specified endpoint on the specified device


[Expand] 
function USBDeviceClearFeature(Device:PUSBDevice; Endpoint:PUSBEndpointDescriptor; Feature:Word):LongWord;
Description: Disable a feature on the specified endpoint on the specified device


[Expand] 
function USBDeviceSetState(Device:PUSBDevice; State:LongWord):LongWord;
Description: Set the state of the specified device and send a notification


[Expand] 
function USBDeviceSetStatus(Device:PUSBDevice; Status:LongWord):LongWord;
Description: Set the status of the specified device and send a notification


[Expand] 
function USBDeviceBind(Device:PUSBDevice):LongWord;
Description: Attempt to bind a device to one of the registered drivers


[Expand] 
function USBDeviceUnbind(Device:PUSBDevice; Driver:PUSBDriver):LongWord;
Description: Unbind a device ?rom a driver


[Expand] 
function USBDeviceAttach(Device:PUSBDevice):LongWord;
Description: Configure and initialize a newly attached USB device


[Expand] 
function USBDeviceDetach(Device:PUSBDevice):LongWord;
Description: Shutdown and detach a USB device


[Expand] 
function USBDeviceAllocate(Host:PUSBHost; Parent:PUSBDevice):PUSBDevice;
Description: Create and Register a new Device entry in the Device table}


[Expand] 
function USBDeviceRelease(Device:PUSBDevice):LongWord;
Description: Deregister and Destroy a Device ?rom the Device table


[Expand] 
function USBDeviceFind(USBId:LongWord):PUSBDevice;
Description: To be documented


[Expand] 
function USBDeviceFindByName(const Name:String):PUSBDevice; inline;
Description: To be documented


[Expand] 
function USBDeviceFindByDescription(const Description:String):PUSBDevice; inline;
Description: To be documented


[Expand] 
function USBDeviceEnumerate(Callback:TUSBDeviceEnumerate; Data:Pointer):LongWord;
Description: To be documented


[Expand] 
function USBDeviceNotification(Device:PUSBDevice; Callback:TUSBDeviceNotification; Data:Pointer; Notification,Flags:LongWord):LongWord;
Description: To be documented


[Expand] 
function USBDriverCreate:PUSBDriver;
Description: Create a new Driver entry


[Expand] 
function USBDriverCreateEx(Size:LongWord):PUSBDriver;
Description: Create a new Driver entry}


[Expand] 
function USBDriverDestroy(Driver:PUSBDriver):LongWord;
Description: Destroy an existing Driver entry


[Expand] 
function USBDriverRegister(Driver:PUSBDriver):LongWord;
Description: Register a new Driver in the Driver table


[Expand] 
function USBDriverDeregister(Driver:PUSBDriver):LongWord;
Description: Deregister a Driver ?rom the Driver table


[Expand] 
function USBDriverFind(DriverId:LongWord):PUSBDriver;
Description: To be documented


[Expand] 
function USBDriverFindByName(const Name:String):PUSBDriver; inline;
Description: To be documented


[Expand] 
function USBDriverEnumerate(Callback:TUSBDriverEnumerate; Data:Pointer):LongWord;
Description: To be documented


[Expand] 
function USBHostSetState(Host:PUSBHost; State:LongWord):LongWord;
Description: Set the state of the specified host and send a notification}


[Expand] 
function USBHostCreate:PUSBHost;
Description: Create a new Host entry


[Expand] 
function USBHostCreateEx(Size:LongWord):PUSBHost;
Description: Create a new Host entry


[Expand] 
function USBHostDestroy(Host:PUSBHost):LongWord;
Description: Destroy an existing Host entry


[Expand] 
function USBHostRegister(Host:PUSBHost):LongWord;
Description: Register a new Host in the Host table


[Expand] 
function USBHostDeregister(Host:PUSBHost):LongWord;
Description: Deregister a Host ?rom the Host table


[Expand] 
function USBHostFind(HostId:LongWord):PUSBHost;
Description: To be documented


[Expand] 
function USBHostFindByName(const Name:String):PUSBHost; inline;
Description: To be documented


[Expand] 
function USBHostFindByDescription(const Description:String):PUSBHost; inline;
Description: To be documented


[Expand] 
function USBHostEnumerate(Callback:TUSBHostEnumerate; Data:Pointer):LongWord;
Description: To be documented


[Expand] 
function USBHostNotification(Host:PUSBHost; Callback:TUSBHostNotification; Data:Pointer; Notification,Flags:LongWord):LongWord;
Description: To be documented


[Expand] 
function USBBufferAllocate(Device:PUSBDevice; Size:LongWord):Pointer; inline;
Description: Allocate a data buffer for a USB request


[Expand] 
function USBBufferAllocateEx(Device:PUSBDevice; Size:LongWord; var Flags:LongWord):Pointer;
Description: Allocate a data buffer for a USB request


[Expand] 
function USBBufferValidate(Device:PUSBDevice; Buffer:Pointer; Size:LongWord; var Flags:LongWord):LongWord;
Description: Validate a data buffer for a USB request against the USB host requirements


[Expand] 
function USBBufferRelease(Buffer:Pointer):LongWord;
Description: Release a data buffer ?rom a USB request


[Expand] 
function USBRequestAllocate(Device:PUSBDevice; Endpoint:PUSBEndpointDescriptor; Callback:TUSBRequestCompleted; Size:LongWord; DriverData:Pointer):PUSBRequest; inline;
Description: Allocate a new USB request


[Expand] 
function USBRequestAllocateEx(Device:PUSBDevice; Endpoint:PUSBEndpointDescriptor; Callback:TUSBRequestCompleted; var Data:Pointer; Size:LongWord; DriverData:Pointer):PUSBRequest;
Description: Allocate a new USB request


[Expand] 
function USBRequestRelease(Request:PUSBRequest):LongWord;
Description: Release and destroy a USB request


[Expand] 
function USBRequestInitialize(Request:PUSBRequest; Callback:TUSBRequestCompleted; Data:Pointer; Size:LongWord; DriverData:Pointer):LongWord;
Description: Initialize or Reinitialize an existing USB request


[Expand] 
function USBRequestSubmit(Request:PUSBRequest):LongWord;
Description: Submit a USB request to a host controller for execution


[Expand] 
function USBRequestCancel(Request:PUSBRequest):LongWord;
Description: Cancel a USB request previously submitted to a host controller


[Expand] 
procedure USBRequestComplete(Request:PUSBRequest);
Description: Called by a host controller when a USB request completes


[Expand] 
function USBControlRequest(Device:PUSBDevice; Endpoint:PUSBEndpointDescriptor; bRequest,bmRequestType:Byte; wValue,wIndex:Word; Data:Pointer; wLength:Word):LongWord; inline;
Description: Send of USB control request to the specified device and wait for the request to complete


[Expand] 
function USBControlRequestEx(Device:PUSBDevice; Endpoint:PUSBEndpointDescriptor; bRequest,bmRequestType:Byte; wValue,wIndex:Word; Data:Pointer; wLength:Word; Timeout:LongWord; AllowShort:Boolean):LongWord;
Description: Send of USB control request to the specified device and wait for the request to complete


[Expand] 
procedure USBControlRequestComplete(Request:PUSBRequest);
Description: Called when a USB request ?rom a USB control endpoint completes


USB hub functions

[Expand] 
function USBHubCreatePorts(Hub:PUSBHub):LongWord;
Description: Create and initialize the ports for a Hub


[Expand] 
function USBHubPowerOnPorts(Hub:PUSBHub):LongWord;
Description: Power on all ports on a Hub


[Expand] 
function USBHubCreateHubDescriptor(Hub:PUSBHub):LongWord;
Description: Allocate the hub descriptor for the specified hub


[Expand] 
function USBHubReadHubDescriptor(Hub:PUSBHub):LongWord;
Description: Read the hub descriptor for the specified hub


[Expand] 
function USBHubLock(Hub:PUSBHub):LongWord;
Description: Lock the specified Hub to prevent changes


[Expand] 
function USBHubUnlock(Hub:PUSBHub):LongWord;
Description: Unlock the specified Hub to allow changes


[Expand] 
function USBHubSetState(Hub:PUSBHub; State:LongWord):LongWord;
Description: Set the state of the specified hub and send a notification


[Expand] 
function USBHubAllocate(Device:PUSBDevice):PUSBHub;
Description: Create and Register a new Hub device


[Expand] 
function USBHubRelease(Hub:PUSBHub):LongWord;
Description: Deregister and Destroy a Hub device


[Expand] 
function USBHubFind(HubId:LongWord):PUSBHub;
Description: To be documented


[Expand] 
function USBHubFindByName(const Name:String):PUSBHub; inline;
Description: To be documented


[Expand] 
function USBHubFindByDescription(const Description:String):PUSBHub; inline;
Description: To be documented


[Expand] 
function USBHubEnumerate(Callback:TUSBHubEnumerate; Data:Pointer):LongWord;
Description: To be documented


[Expand] 
function USBHubNotification(Hub:PUSBHub; Callback:TUSBHubNotification; Data:Pointer; Notification,Flags:LongWord):LongWord;
Description: To be documented


[Expand] 
procedure USBHubBindDevices(Device:PUSBDevice; Callback:TUSBDeviceBind);
Description: Enumerate each device in the USB tree and call a bind callback for each one


[Expand] 
procedure USBHubUnbindDevices(Device:PUSBDevice; Driver:PUSBDriver; Callback:TUSBDeviceUnbind);
Description: Enumerate each device in the USB tree and call an unbind callback for each one


[Expand] 
procedure USBHubEnumerateDevices(Device:PUSBDevice; Callback:TUSBDeviceEnumerate; Data:Pointer);
Description: Enumerate each device in the USB tree and call an enumerate callback for each one


[Expand] 
function USBHubPortReset(Port:PUSBPort):LongWord;
Description: Reset a the specified USB port


[Expand] 
function USBHubPortGetStatus(Port:PUSBPort):LongWord;
Description: Read the status of the specified USB port


[Expand] 
function USBHubPortSetFeature(Port:PUSBPort; Feature:Word):LongWord;
Description: Enable a feature on the specified USB port


[Expand] 
function USBHubPortClearFeature(Port:PUSBPort; Feature:Word):LongWord;
Description: Disable a feature on the specified USB port


[Expand] 
function USBHubPortChangeFeature(Port:PUSBPort; Feature:Word; Enable:Boolean):LongWord;
Description: Enable or disable a feature on the specified USB port


[Expand] 
function USBHubPortAttachDevice(Port:PUSBPort):LongWord;
Description: Attach a newly connected USB device to the specified USB port


[Expand] 
function USBHubPortDetachDevice(Port:PUSBPort):LongWord;
Description: Detach a disconnected USB device ?rom the specified USB port


[Expand] 
function USBHubPortStatusChanged(Port:PUSBPort):LongWord;
Description: Process a status change for the specified USB port


[Expand] 
function USBHubExecute(Parameter:Pointer):PtrInt;
Description: The Hub thread procedure which is responsible for receiving completed hub status change requests, processing them for changes and then resubmitting the request


[Expand] 
procedure USBHubStatusComplete(Request:PUSBRequest);
Description: Called when the USB request ?rom a USB hub IN interrupt endpoint completes


[Expand] 
function USBHubDriverBind(Device:PUSBDevice; Interrface:PUSBInterface):LongWord;
Description: Bind the Hub driver to a USB device if it is suitable}


[Expand] 
function USBHubDriverUnbind(Device:PUSBDevice; Interrface:PUSBInterface):LongWord;
Description: Unbind the Hub driver ?rom a USB device


USB device, driver and host helper functions

[Expand] 
function USBDeviceGetCount:LongWord; inline;
Description: Get the current device count


[Expand] 
function USBDeviceCheck(Device:PUSBDevice):PUSBDevice;
Description: Check if the supplied Device is in the device table


[Expand] 
function USBDriverGetCount:LongWord; inline;
Description: Get the current driver count


[Expand] 
function USBDriverCheck(Driver:PUSBDriver):PUSBDriver;
Description: Check if the supplied Driver is in the driver table


[Expand] 
function USBHostGetCount:LongWord; inline;
Description: Get the current host count


[Expand] 
function USBHostCheck(Host:PUSBHost):PUSBHost;
Description: Check if the supplied Host is in the host table


[Expand] 
function USBIsHub(Device:PUSBDevice):Boolean;
Description: Returns True if Device is a Hub or False if not


[Expand] 
function USBIsRootHub(Device:PUSBDevice):Boolean;
Description: Returns True if Device is a Root Hub or False if not


[Expand] 
function USBIsControlRequest(Request:PUSBRequest):Boolean;
Description: Returns True if Request is a control request or False if not


[Expand] 
function USBIsBulkRequest(Request:PUSBRequest):Boolean;
Description: Returns True if Request is a bulk request or False if not


[Expand] 
function USBIsInterruptRequest(Request:PUSBRequest):Boolean;
Description: Returns True if Request is an interrupt request or False if not


[Expand] 
function USBIsIsochronousRequest(Request:PUSBRequest):Boolean;
Description: Returns True if Request is an isochronous request or False if not


[Expand] 
function USBIsInEndpoint(Endpoint:PUSBEndpointDescriptor):Boolean;
Description: Returns True is Endpoint is an IN endpoint or False if not


[Expand] 
function USBIsOutEndpoint(Endpoint:PUSBEndpointDescriptor):Boolean;
Description: Returns True is Endpoint is an OUT endpoint or False if not


[Expand] 
function USBIsBulkEndpoint(Endpoint:PUSBEndpointDescriptor):Boolean;
Description: Returns True is Endpoint is a BULK endpoint or False if not


[Expand] 
function USBIsInterruptEndpoint(Endpoint:PUSBEndpointDescriptor):Boolean;
Description: Returns True is Endpoint is a INTERRUPT endpoint or False if not


[Expand] 
function USBIsIsochronousEndpoint(Endpoint:PUSBEndpointDescriptor):Boolean;
Description: Returns True is Endpoint is a ISOCHRONOUS endpoint or False if not


[Expand] 
function USBDeviceToString(Device:PUSBDevice):String;
Description: Return a description of a USB device


[Expand] 
function USBStatusToString(Status:LongWord):String;
Description: Translates a USB status code into a string


[Expand] 
function USBClassCodeToString(ClassCode:Integer):String;
Description: Translates a USB class code into a string


[Expand] 
function USBSubClassCodeToString(ClassCode,SubClassCode:Integer):String;
Description: Translates a USB sub class code into a string


[Expand] 
function USBProtocolCodeToString(ClassCode,ProtocolCode:Integer):String;
Description: Translates a USB protocol code into a string


[Expand] 
function USBSpeedToString(Speed:Integer):String;
Description: Translates a USB speed constant into a string


[Expand] 
function USBTransferTypeToString(TransferType:Integer):String;
Description: Translates a USB transfer type constant into a string


[Expand] 
function USBDirectionToString(Direction:Integer):String;
Description: Translates a USB direction constant into a string


[Expand] 
function USBBCDVersionToString(BCDVersion:Word):String;
Description: Translates a bcdUSB (binary-coded-decimal USB version) value into a human-readable string


[Expand] 
function USBPortStatusConnectedToString(Status:Word):String;
Description: To be documented


[Expand] 
function USBHubCharacteristicsToString(HubCharacteristics:Word):String;
Description: To be documented


[Expand] 
function USBDeviceTypeToString(USBType:LongWord):String;
Description: To be documented


[Expand] 
function USBDeviceStateToString(USBState:LongWord):String;
Description: To be documented


[Expand] 
function USBDeviceStatusToString(USBStatus:LongWord):String;
Description: To be documented


[Expand] 
function USBDeviceStateToNotification(State:LongWord):LongWord;
Description: Convert a Device state value into the notification code for device notifications


[Expand] 
function USBDeviceStatusToNotification(Status:LongWord):LongWord;
Description: Convert a Device status value into the notification code for device notifications


[Expand] 
function USBHostTypeToString(HostType:LongWord):String;
Description: To be documented


[Expand] 
function USBHostStateToString(HostState:LongWord):String;
Description: To be documented


[Expand] 
function USBHostStateToNotification(State:LongWord):LongWord;
Description: Convert a Host state value into the notification code for device notifications


[Expand] 
procedure USBLog(Level:LongWord; Device:PUSBDevice; const AText:String);
Description: To be documented


[Expand] 
procedure USBLogInfo(Device:PUSBDevice;const AText:String);
Description: To be documented


[Expand] 
procedure USBLogError(Device:PUSBDevice;const AText:String);
Description: To be documented


[Expand] 
procedure USBLogDebug(Device:PUSBDevice;const AText:String);
Description: To be documented


[Expand] 
procedure USBLogDeviceConfiguration(Device:PUSBDevice);
Description: To be documented


[Expand] 
procedure USBLogDeviceDescriptor(Device:PUSBDevice; Descriptor:PUSBDeviceDescriptor);
Description: To be documented


[Expand] 
procedure USBLogConfigurationDescriptor(Device:PUSBDevice; Descriptor:PUSBConfigurationDescriptor);
Description: To be documented


[Expand] 
procedure USBLogInterfaceDescriptor(Device:PUSBDevice; Descriptor:PUSBInterfaceDescriptor);
Description: To be documented


[Expand] 
procedure USBLogEndpointDescriptor(Device:PUSBDevice; Descriptor:PUSBEndpointDescriptor);
Description: To be documented


[Expand] 
function USBLogDevices:LongWord;
Description: Print information about all devices attached to the USB


[Expand] 
function USBLogDeviceCallback(Device:PUSBDevice; Data:Pointer):LongWord;
Description: To be documented


[Expand] 
function USBLogTreeCallback(Device:PUSBDevice; Data:Pointer):LongWord;
Description: To be documented


USB hub helper functions

[Expand] 
function USBHubGetCount:LongWord; inline;
Description: Get the current hub count


[Expand] 
function USBHubCheck(Hub:PUSBHub):PUSBHub;
Description: Check if the supplied Hub is in the hub table


[Expand] 
function USBHubStateToNotification(State:LongWord):LongWord;
Description: Convert a Hub state value into the notification code for device notifications


Return to Unit Reference

Retrieved from "https://ultibo.org/mediawiki_ultibo_org/index.php?title=Unit_USB&oldid=1803"