documentation/api/usb_8h_source.html

/*

 * This file is part of the Ultibo project, https://ultibo.org/

 *

 * The MIT License (MIT)

 *

 * Copyright (c) 2026 Garry Wood <garry@softoz.com.au>

 *

 * Permission is hereby granted, free of charge, to any person obtaining a copy

 * of this software and associated documentation files (the "Software"), to deal

 * in the Software without restriction, including without limitation the rights

 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell

 * copies of the Software, and to permit persons to whom the Software is

 * furnished to do so, subject to the following conditions:

 *

 * The above copyright notice and this permission notice shall be included in

 * all copies or substantial portions of the Software.

 *

 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR

 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,

 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE

 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER

 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,

 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN

 * THE SOFTWARE.

 */

#ifndef _ULTIBO_USB_H

#define _ULTIBO_USB_H


#ifdef __cplusplus

extern "C" {

#endif


#include "ultibo/globaltypes.h"

#include "ultibo/globalconst.h"

#include "ultibo/system.h"

#include "ultibo/devices.h"


#define USB_DEVICE_PREFIX   "USB"

#define USB_DRIVER_PREFIX   "USB"

#define USB_HOST_PREFIX "USBHost"


#define USB_TYPE_NONE   0


#define USB_TYPE_MAX    0


#define USB_STATE_DETACHED  0

#define USB_STATE_DETACHING 1

#define USB_STATE_ATTACHING 2

#define USB_STATE_ATTACHED  3


#define USB_STATE_MAX   3


#define USB_STATUS_UNBOUND  0

#define USB_STATUS_BOUND    1


#define USB_STATUS_MAX  1


#define USB_FLAG_NONE   0x00000000


#define USBHOST_TYPE_NONE   0

#define USBHOST_TYPE_EHCI   1

#define USBHOST_TYPE_OHCI   2

#define USBHOST_TYPE_UHCI   3

#define USBHOST_TYPE_XHCI   4

#define USBHOST_TYPE_DWCOTG 5


#define USBHOST_TYPE_MAX    5


#define USBHOST_STATE_DISABLED  0

#define USBHOST_STATE_ENABLED   1


#define USBHOST_STATE_MAX   1


#define USBHOST_FLAG_NONE   0x00000000

#define USBHOST_FLAG_SHARED 0x00000001

#define USBHOST_FLAG_NOCACHE    0x00000002


#define USB_STATUS_SUCCESS  0

#define USB_STATUS_DEVICE_DETACHED  1

#define USB_STATUS_DEVICE_UNSUPPORTED   2

#define USB_STATUS_HARDWARE_ERROR   3

#define USB_STATUS_INVALID_DATA 4

#define USB_STATUS_INVALID_PARAMETER    5

#define USB_STATUS_NOT_PROCESSED    6

#define USB_STATUS_OUT_OF_MEMORY    7

#define USB_STATUS_TIMEOUT  8

#define USB_STATUS_UNSUPPORTED_REQUEST  9

#define USB_STATUS_HARDWARE_STALL   10

#define USB_STATUS_OPERATION_FAILED 11

#define USB_STATUS_NOT_BOUND    12

#define USB_STATUS_ALREADY_BOUND    13

#define USB_STATUS_NOT_READY    14

#define USB_STATUS_NOT_COMPLETED    15

#define USB_STATUS_CANCELLED    16

#define USB_STATUS_NOT_VALID    17


#define USB_REQUEST_FLAG_NONE   0x00000000

#define USB_REQUEST_FLAG_ALLOCATED  0x00000001

#define USB_REQUEST_FLAG_COMPATIBLE 0x00000002

#define USB_REQUEST_FLAG_ALIGNED    0x00000004

#define USB_REQUEST_FLAG_SIZED  0x00000008

#define USB_REQUEST_FLAG_SHARED 0x00000010

#define USB_REQUEST_FLAG_NOCACHE    0x00000020


#define USB_CONTROL_PHASE_SETUP 0

#define USB_CONTROL_PHASE_DATA  1

#define USB_CONTROL_PHASE_STATUS    2


#define USB_CONTROL_GET_TIMEOUT 5000

#define USB_CONTROL_SET_TIMEOUT 5000


#define USB_DEFAULT_MAX_PACKET_SIZE 8

#define USB_ALTERNATE_MAX_PACKET_SIZE   64


#define USB_MAX_PACKET_SIZE 1024


#define USB_FRAMES_PER_MS   1


#define USB_UFRAMES_PER_MS  8


#define USB_CONFIGURATION_ATTRIBUTE_RESERVED_HIGH   0x80

#define USB_CONFIGURATION_ATTRIBUTE_SELF_POWERED    0x40

#define USB_CONFIGURATION_ATTRIBUTE_REMOTE_WAKEUP   0x20

#define USB_CONFIGURATION_ATTRIBUTE_RESERVED_LOW    0x1f


#define USB_DEVICE_STATUS_SELF_POWERED  (1 << 0)

#define USB_DEVICE_STATUS_REMOTE_WAKEUP (1 << 1)


#define USB_ENDPOINT_STATUS_HALT    (1 << 0)


#define USB_SPEED_HIGH  0

#define USB_SPEED_FULL  1

#define USB_SPEED_LOW   2

#define USB_SPEED_SUPER 3

#define USB_SPEED_SUPERPLUS 4


#define USB_TRANSFER_TYPE_CONTROL   0

#define USB_TRANSFER_TYPE_ISOCHRONOUS   1

#define USB_TRANSFER_TYPE_BULK  2

#define USB_TRANSFER_TYPE_INTERRUPT 3

#define USB_TRANSFER_TYPE_MASK  0x03


#define USB_TRANSFER_SIZE_8_BIT 0

#define USB_TRANSFER_SIZE_16_BIT    1

#define USB_TRANSFER_SIZE_32_BIT    2

#define USB_TRANSFER_SIZE_64_BIT    3


#define USB_DESCRIPTOR_TYPE_DEVICE  1

#define USB_DESCRIPTOR_TYPE_CONFIGURATION   2

#define USB_DESCRIPTOR_TYPE_STRING  3

#define USB_DESCRIPTOR_TYPE_INTERFACE   4

#define USB_DESCRIPTOR_TYPE_ENDPOINT    5

#define USB_DESCRIPTOR_TYPE_DEVICE_QUALIFIER    6

#define USB_DESCRIPTOR_TYPE_OTHER_SPEED_CONFIGURATION   7

#define USB_DESCRIPTOR_TYPE_INTERFACE_POWER 8

#define USB_DESCRIPTOR_TYPE_CLASS_DEVICE    0x21

#define USB_DESCRIPTOR_TYPE_CLASS_CONFIGURATION 0x22

#define USB_DESCRIPTOR_TYPE_CLASS_STRING    0x23

#define USB_DESCRIPTOR_TYPE_CLASS_INTERFACE 0x24

#define USB_DESCRIPTOR_TYPE_CLASS_ENDPOINT  0x25

#define USB_DESCRIPTOR_TYPE_HUB 0x29


#define USB_DIRECTION_OUT   0

#define USB_DIRECTION_IN    1


#define USB_REQUEST_TYPE_STANDARD   0

#define USB_REQUEST_TYPE_CLASS  1

#define USB_REQUEST_TYPE_VENDOR 2

#define USB_REQUEST_TYPE_RESERVED   3


#define USB_REQUEST_RECIPIENT_DEVICE    0

#define USB_REQUEST_RECIPIENT_INTERFACE 1

#define USB_REQUEST_RECIPIENT_ENDPOINT  2

#define USB_REQUEST_RECIPIENT_OTHER 3


#define USB_BMREQUESTTYPE_DIR_OUT   (USB_DIRECTION_OUT << 7)

#define USB_BMREQUESTTYPE_DIR_IN    (USB_DIRECTION_IN << 7)

#define USB_BMREQUESTTYPE_DIR_MASK  (0x01 << 7)

#define USB_BMREQUESTTYPE_TYPE_STANDARD (USB_REQUEST_TYPE_STANDARD << 5)

#define USB_BMREQUESTTYPE_TYPE_CLASS    (USB_REQUEST_TYPE_CLASS << 5)

#define USB_BMREQUESTTYPE_TYPE_VENDOR   (USB_REQUEST_TYPE_VENDOR << 5)

#define USB_BMREQUESTTYPE_TYPE_RESERVED (USB_REQUEST_TYPE_RESERVED << 5)

#define USB_BMREQUESTTYPE_TYPE_MASK (0x03 << 5)

#define USB_BMREQUESTTYPE_RECIPIENT_DEVICE  (USB_REQUEST_RECIPIENT_DEVICE << 0)

#define USB_BMREQUESTTYPE_RECIPIENT_INTERFACE   (USB_REQUEST_RECIPIENT_INTERFACE << 0)

#define USB_BMREQUESTTYPE_RECIPIENT_ENDPOINT    (USB_REQUEST_RECIPIENT_ENDPOINT << 0)

#define USB_BMREQUESTTYPE_RECIPIENT_OTHER   (USB_REQUEST_RECIPIENT_OTHER << 0)

#define USB_BMREQUESTTYPE_RECIPIENT_MASK    (0x1f << 0)


#define USB_DEVICE_REQUEST_GET_STATUS   0

#define USB_DEVICE_REQUEST_CLEAR_FEATURE    1

#define USB_DEVICE_REQUEST_SET_FEATURE  3

#define USB_DEVICE_REQUEST_SET_ADDRESS  5

#define USB_DEVICE_REQUEST_GET_DESCRIPTOR   6

#define USB_DEVICE_REQUEST_SET_DESCRIPTOR   7

#define USB_DEVICE_REQUEST_GET_CONFIGURATION    8

#define USB_DEVICE_REQUEST_SET_CONFIGURATION    9

#define USB_DEVICE_REQUEST_GET_INTERFACE    10

#define USB_DEVICE_REQUEST_SET_INTERFACE    11

#define USB_DEVICE_REQUEST_SYNCH_FRAME  12


#define USB_DEVICE_FEATURE_ENDPOINT_HALT    0

#define USB_DEVICE_FEATURE_REMOTE_WAKEUP    1

#define USB_DEVICE_FEATURE_TEST_MODE    2


#define USB_DEVICE_TEST_MODE_J  0x01

#define USB_DEVICE_TEST_MODE_K  0x02

#define USB_DEVICE_TEST_MODE_SE0_NAK    0x03

#define USB_DEVICE_TEST_MODE_PACKET 0x04

#define USB_DEVICE_TEST_MODE_FORCE_ENABLE   0x05


#define USB_PACKETID_UNDEF_0    0xf0

#define USB_PACKETID_OUT    0xe1

#define USB_PACKETID_ACK    0xd2

#define USB_PACKETID_DATA0  0xc3

#define USB_PACKETID_UNDEF_4    0xb4

#define USB_PACKETID_SOF    0xa5

#define USB_PACKETID_UNDEF_6    0x96

#define USB_PACKETID_UNDEF_7    0x87

#define USB_PACKETID_UNDEF_8    0x78

#define USB_PACKETID_IN 0x69

#define USB_PACKETID_NAK    0x5a

#define USB_PACKETID_DATA1  0x4b

#define USB_PACKETID_PREAMBLE   0x3c

#define USB_PACKETID_SETUP  0x2d

#define USB_PACKETID_STALL  0x1e

#define USB_PACKETID_UNDEF_F    0x0f


#define USB_CLASS_CODE_INTERFACE_SPECIFIC   0x00

#define USB_CLASS_CODE_AUDIO    0x01

#define USB_CLASS_CODE_COMMUNICATIONS_AND_CDC_CONTROL   0x02

#define USB_CLASS_CODE_COMMS    USB_CLASS_CODE_COMMUNICATIONS_AND_CDC_CONTROL

#define USB_CLASS_CODE_HID  0x03

#define USB_CLASS_CODE_PHYSICAL 0x05

#define USB_CLASS_CODE_IMAGE    0x06

#define USB_CLASS_CODE_PRINTER  0x07

#define USB_CLASS_CODE_MASS_STORAGE 0x08

#define USB_CLASS_CODE_HUB  0x09

#define USB_CLASS_CODE_CDC_DATA 0x0a

#define USB_CLASS_CODE_SMART_CARD   0x0b

#define USB_CLASS_CODE_CONTENT_SECURITY 0x0d

#define USB_CLASS_CODE_VIDEO    0x0e

#define USB_CLASS_CODE_PERSONAL_HEALTHCARE  0x0f

#define USB_CLASS_CODE_AUDIO_VIDEO  0x10

#define USB_CLASS_CODE_BILLBOARD    0x11

#define USB_CLASS_CODE_DIAGNOSTIC   0xDC

#define USB_CLASS_CODE_WIRELESS_CONTROLLER  0xe0

#define USB_CLASS_CODE_MISCELLANEOUS    0xef

#define USB_CLASS_CODE_APPLICATION_SPECIFIC 0xfe

#define USB_CLASS_CODE_VENDOR_SPECIFIC  0xff


#define USB_SUBCLASS_CDC_DLCM   0x01

#define USB_SUBCLASS_CDC_ACM    0x02

#define USB_SUBCLASS_CDC_TCM    0x03

#define USB_SUBCLASS_CDC_MCCM   0x04

#define USB_SUBCLASS_CDC_CCM    0x05

#define USB_SUBCLASS_CDC_ETHERNET   0x06

#define USB_SUBCLASS_CDC_WHCM   0x08

#define USB_SUBCLASS_CDC_DMM    0x09

#define USB_SUBCLASS_CDC_MDLM   0x0a

#define USB_SUBCLASS_CDC_OBEX   0x0b

#define USB_SUBCLASS_CDC_EEM    0x0c

#define USB_SUBCLASS_CDC_NCM    0x0d

#define USB_SUBCLASS_CDC_MBIM   0x0e

#define USB_SUBCLASS_IMAGE_DEFAULT  0x01

#define USB_SUBCLASS_MASS_STORAGE_DEFAULT   0x00

#define USB_SUBCLASS_MASS_STORAGE_RBC   0x01

#define USB_SUBCLASS_MASS_STORAGE_MMC5  0x02

#define USB_SUBCLASS_MASS_STORAGE_QIC157    0x03

#define USB_SUBCLASS_MASS_STORAGE_UFI   0x04

#define USB_SUBCLASS_MASS_STORAGE_SFF8070I  0x05

#define USB_SUBCLASS_MASS_STORAGE_SCSI  0x06

#define USB_SUBCLASS_MASS_STORAGE_LSDFS 0x07

#define USB_SUBCLASS_MASS_STORAGE_IEEE1667  0x08

#define USB_SUBCLASS_MASS_STORAGE_VENDOR_SPECIFIC   0xff

#define USB_SUBCLASS_CONTENT_SECURITY_DEFAULT   0x00

#define USB_SUBCLASS_AUDIO_VIDEO_CONTROL    0x01

#define USB_SUBCLASS_AUDIO_VIDEO_DATA_VIDEO 0x02

#define USB_SUBCLASS_AUDIO_VIDEO_DATA_AUDIO 0x03

#define USB_SUBCLASS_BILLBOARD_DEFAULT  0x00

#define USB_SUBCLASS_DIAGNOSTIC_DEFAULT 0x01

#define USB_SUBCLASS_WIRELESS_CONTROLLER_BLUETOOTH  0x01

#define USB_SUBCLASS_WIRELESS_CONTROLLER_USB    0x02

#define USB_SUBCLASS_MISCELLANEOUS_SYNC 0x01

#define USB_SUBCLASS_MISCELLANEOUS_IAD_WAMP 0x02

#define USB_SUBCLASS_MISCELLANEOUS_CBAF 0x03

#define USB_SUBCLASS_MISCELLANEOUS_RNDIS    0x04

#define USB_SUBCLASS_MISCELLANEOUS_USB3VISION   0x05

#define USB_SUBCLASS_APPLICATION_SPECIFIC_DFU   0x01

#define USB_SUBCLASS_APPLICATION_SPECIFIC_IRDA  0x02

#define USB_SUBCLASS_APPLICATION_SPECIFIC_TMC   0x02

#define USB_SUBCLASS_VENDOR_SPECIFIC    0xff


#define USB_PROTOCOL_CDC_ACM_NONE   0

#define USB_PROTOCOL_CDC_ACM_AT_V25TER  1

#define USB_PROTOCOL_CDC_ACM_AT_PCCA101 2

#define USB_PROTOCOL_CDC_ACM_AT_PCCA101_WAKE    3

#define USB_PROTOCOL_CDC_ACM_AT_GSM 4

#define USB_PROTOCOL_CDC_ACM_AT_3G  5

#define USB_PROTOCOL_CDC_ACM_AT_CDMA    6

#define USB_PROTOCOL_CDC_ACM_VENDOR 0xff

#define USB_PROTOCOL_CDC_EEM    7

#define USB_PROTOCOL_CDC_NCM_NTB    1

#define USB_PROTOCOL_CDC_MBIM_NTB   2

#define USB_PROTOCOL_IMAGE_DEFAULT  0x01

#define USB_PROTOCOL_MASS_STORAGE_CBI   0x00

#define USB_PROTOCOL_MASS_STORAGE_CB    0x01

#define USB_PROTOCOL_MASS_STORAGE_BBB   0x50

#define USB_PROTOCOL_MASS_STORAGE_UAS   0x62

#define USB_PROTOCOL_MASS_STORAGE_VENDOR_SPECIFIC   0xff

#define USB_PROTOCOL_HUB_FULLSPEED  0x00

#define USB_PROTOCOL_HUB_HIGHSPEED_SINGLE_TT    0x01

#define USB_PROTOCOL_HUB_HIGHSPEED_MULTI_TT 0x02

#define USB_PROTOCOL_CONTENT_SECURITY_DEFAULT   0x00

#define USB_PROTOCOL_AUDIO_VIDEO_DEFAULT    0x00

#define USB_PROTOCOL_BILLBOARD_DEFAULT  0x00

#define USB_PROTOCOL_DIAGNOSTIC_DEFAULT 0x01

#define USB_PROTOCOL_WIRELESS_CONTROLLER_BLUETOOTH  0x01

#define USB_PROTOCOL_WIRELESS_CONTROLLER_UWB    0x02

#define USB_PROTOCOL_WIRELESS_CONTROLLER_NDIS   0x03

#define USB_PROTOCOL_WIRELESS_CONTROLLER_BLUETOOTH_AMP  0x04

#define USB_PROTOCOL_WIRELESS_CONTROLLER_USB_HOST   0x01

#define USB_PROTOCOL_WIRELESS_CONTROLLER_USB_DEVICE 0x02

#define USB_PROTOCOL_WIRELESS_CONTROLLER_USB_DEVICE_ISOC    0x03

#define USB_PROTOCOL_MISCELLANEOUS_ACTIVESYNC   0x01

#define USB_PROTOCOL_MISCELLANEOUS_PALMSYNC 0x02

#define USB_PROTOCOL_MISCELLANEOUS_IAD  0x01

#define USB_PROTOCOL_MISCELLANEOUS_WAMP 0x02

#define USB_PROTOCOL_MISCELLANEOUS_CBAF 0x01

#define USB_PROTOCOL_MISCELLANEOUS_RNDIS_ETHERNET   0x01

#define USB_PROTOCOL_MISCELLANEOUS_RNDIS_WIFI   0x02

#define USB_PROTOCOL_MISCELLANEOUS_RNDIS_WIMAX  0x03

#define USB_PROTOCOL_MISCELLANEOUS_RNDIS_WWAN   0x04

#define USB_PROTOCOL_MISCELLANEOUS_RNDIS_IPV4   0x05

#define USB_PROTOCOL_MISCELLANEOUS_RNDIS_IPV6   0x06

#define USB_PROTOCOL_MISCELLANEOUS_RNDIS_GPRS   0x07

#define USB_PROTOCOL_MISCELLANEOUS_USB3VISION_CONTROL   0x00

#define USB_PROTOCOL_MISCELLANEOUS_USB3VISION_EVENT 0x01

#define USB_PROTOCOL_MISCELLANEOUS_USB3VISION_STREAM    0x02

#define USB_PROTOCOL_APPLICATION_SPECIFIC_DFU_DEFAULT   0x01

#define USB_PROTOCOL_APPLICATION_SPECIFIC_IRDA_DEFAULT  0x00

#define USB_PROTOCOL_APPLICATION_SPECIFIC_TMC_DEFAULT   0x00

#define USB_PROTOCOL_APPLICATION_SPECIFIC_TMC_488   0x01


#define USB_LANG_ARABIC 0x01

#define USB_LANG_BULGARIAN  0x02

#define USB_LANG_CATALAN    0x03

#define USB_LANG_CHINESE    0x04

#define USB_LANG_CZECH  0x05

#define USB_LANG_DANISH 0x06

#define USB_LANG_GERMAN 0x07

#define USB_LANG_GREEK  0x08

#define USB_LANG_ENGLISH    0x09

#define USB_LANG_SPANISH    0x0a

#define USB_LANG_FINNISH    0x0b

#define USB_LANG_FRENCH 0x0c

#define USB_LANG_HEBREW 0x0d

#define USB_LANG_HUNGARIAN  0x0e

#define USB_LANG_ICELANDIC  0x0f

#define USB_LANG_ITALIAN    0x10

#define USB_LANG_JAPANESE   0x11

#define USB_LANG_KOREAN 0x12

#define USB_LANG_DUTCH  0x13

#define USB_LANG_NORWEGIAN  0x14

#define USB_LANG_POLISH 0x15

#define USB_LANG_PORTUGUESE 0x16

#define USB_LANG_ROMANIAN   0x18

#define USB_LANG_RUSSIAN    0x19

#define USB_LANG_CROATIAN   0x1a

#define USB_LANG_SERBIAN    0x1a

#define USB_LANG_SLOVAK 0x1b

#define USB_LANG_ALBANIAN   0x1c

#define USB_LANG_SWEDISH    0x1d

#define USB_LANG_THAI   0x1e

#define USB_LANG_TURKISH    0x1f

#define USB_LANG_URDU   0x20

#define USB_LANG_INDONESIAN 0x21

#define USB_LANG_UKRANIAN   0x22

#define USB_LANG_BELARUSIAN 0x23

#define USB_LANG_SLOVENIAN  0x24

#define USB_LANG_ESTONIAN   0x25

#define USB_LANG_LATVIAN    0x26

#define USB_LANG_LITHUANIAN 0x27

#define USB_LANG_FARSI  0x29

#define USB_LANG_VIETNAMESE 0x2a

#define USB_LANG_ARMENIAN   0x2b

#define USB_LANG_AZERI  0x2c

#define USB_LANG_BASQUE 0x2d

#define USB_LANG_MACEDONIAN 0x2f

#define USB_LANG_AFRIKAANS  0x36

#define USB_LANG_GEORGIAN   0x37

#define USB_LANG_FAEROESE   0x38

#define USB_LANG_HINDI  0x39

#define USB_LANG_MALAY  0x3e

#define USB_LANG_KAZAK  0x3f

#define USB_LANG_SWAHILI    0x41

#define USB_LANG_UZBEK  0x43

#define USB_LANG_TATAR  0x44

#define USB_LANG_BENGALI    0x45

#define USB_LANG_PUNJABI    0x46

#define USB_LANG_GUJARATI   0x47

#define USB_LANG_ORIYA  0x48

#define USB_LANG_TAMIL  0x49

#define USB_LANG_TELUGU 0x4a

#define USB_LANG_KANNADA    0x4b

#define USB_LANG_MALAYALAM  0x4c

#define USB_LANG_ASSAMESE   0x4d

#define USB_LANG_MARATHI    0x4e

#define USB_LANG_SANSKRIT   0x4f

#define USB_LANG_KONKANI    0x57

#define USB_LANG_MANIPURI   0x58

#define USB_LANG_SINDHI 0x59

#define USB_LANG_KASHMIRI   0x60

#define USB_LANG_NEPALI 0x61

#define USB_LANG_HID    0xff


#define USB_PRIMARY_LANGUAGE_MASK   0x3ff


#define USB_SUBLANG_ARABIC_SAUDI_ARABIA 0x01

#define USB_SUBLANG_ARABIC_IRAQ 0x02

#define USB_SUBLANG_ARABIC_EGYPT    0x03

#define USB_SUBLANG_ARABIC_LIBYA    0x04

#define USB_SUBLANG_ARABIC_ALGERIA  0x05

#define USB_SUBLANG_ARABIC_MOROCCO  0x06

#define USB_SUBLANG_ARABIC_TUNISIA  0x07

#define USB_SUBLANG_ARABIC_OMAN 0x08

#define USB_SUBLANG_ARABIC_YEMEN    0x09

#define USB_SUBLANG_ARABIC_SYRIA    0x10

#define USB_SUBLANG_ARABIC_JORDAN   0x11

#define USB_SUBLANG_ARABIC_LEBANON  0x12

#define USB_SUBLANG_ARABIC_KUWAIT   0x13

#define USB_SUBLANG_ARABIC_UAE  0x14

#define USB_SUBLANG_ARABIC_BAHRAIN  0x15

#define USB_SUBLANG_ARABIC_QATAR    0x16

#define USB_SUBLANG_AZERI_CYRILLIC  0x01

#define USB_SUBLANG_AZERI_LATIN 0x02

#define USB_SUBLANG_CHINESE_TRADITIONAL 0x01

#define USB_SUBLANG_CHINESE_SIMPLIFIED  0x02

#define USB_SUBLANG_CHINESE_HONGKONG    0x03

#define USB_SUBLANG_CHINESE_SINGAPORE   0x04

#define USB_SUBLANG_CHINESE_MACAU   0x05

#define USB_SUBLANG_DUTCH   0x01

#define USB_SUBLANG_DUTCH_BELGIAN   0x02

#define USB_SUBLANG_ENGLISH_US  0x01

#define USB_SUBLANG_ENGLISH_UK  0x02

#define USB_SUBLANG_ENGLISH_AUS 0x03

#define USB_SUBLANG_ENGLISH_CAN 0x04

#define USB_SUBLANG_ENGLISH_NZ  0x05

#define USB_SUBLANG_ENGLISH_EIRE    0x06

#define USB_SUBLANG_ENGLISH_SOUTH_AFRICA    0x07

#define USB_SUBLANG_ENGLISH_JAMAICA 0x08

#define USB_SUBLANG_ENGLISH_CARIBBEAN   0x09

#define USB_SUBLANG_ENGLISH_BELIZE  0x0a

#define USB_SUBLANG_ENGLISH_TRINIDAD    0x0b

#define USB_SUBLANG_ENGLISH_PHILIPPINES 0x0c

#define USB_SUBLANG_ENGLISH_ZIMBABWE    0x0d

#define USB_SUBLANG_FRENCH  0x01

#define USB_SUBLANG_FRENCH_BELGIAN  0x02

#define USB_SUBLANG_FRENCH_CANADIAN 0x03

#define USB_SUBLANG_FRENCH_SWISS    0x04

#define USB_SUBLANG_FRENCH_LUXEMBOURG   0x05

#define USB_SUBLANG_FRENCH_MONACO   0x06

#define USB_SUBLANG_GERMAN  0x01

#define USB_SUBLANG_GERMAN_SWISS    0x02

#define USB_SUBLANG_GERMAN_AUSTRIAN 0x03

#define USB_SUBLANG_GERMAN_LUXEMBOURG   0x04

#define USB_SUBLANG_GERMAN_LIECHTENSTEIN    0x05

#define USB_SUBLANG_ITALIAN 0x01

#define USB_SUBLANG_ITALIAN_SWISS   0x02

#define USB_SUBLANG_KASHMIRI_INDIA  0x02

#define USB_SUBLANG_KOREAN  0x01

#define USB_SUBLANG_LITHUANIAN  0x01

#define USB_SUBLANG_MALAY_MALAYSIA  0x01

#define USB_SUBLANG_MALAY_BRUNEI_DARUSSALAM 0x02

#define USB_SUBLANG_NEPALI_INDIA    0x02

#define USB_SUBLANG_NORWEGIAN_BOKMAL    0x01

#define USB_SUBLANG_NORWEGIAN_NYNORSK   0x02

#define USB_SUBLANG_PORTUGUESE  0x01

#define USB_SUBLANG_PORTUGUESE_BRAZILIAN    0x02

#define USB_SUBLANG_SERBIAN_LATIN   0x02

#define USB_SUBLANG_SERBIAN_CYRILLIC    0x03

#define USB_SUBLANG_SPANISH 0x01

#define USB_SUBLANG_SPANISH_MEXICAN 0x02

#define USB_SUBLANG_SPANISH_MODERN  0x03

#define USB_SUBLANG_SPANISH_GUATEMALA   0x04

#define USB_SUBLANG_SPANISH_COSTA_RICA  0x05

#define USB_SUBLANG_SPANISH_PANAMA  0x06

#define USB_SUBLANG_SPANISH_DOMINICAN_REPUBLIC  0x07

#define USB_SUBLANG_SPANISH_VENEZUELA   0x08

#define USB_SUBLANG_SPANISH_COLOMBIA    0x09

#define USB_SUBLANG_SPANISH_PERU    0x0a

#define USB_SUBLANG_SPANISH_ARGENTINA   0x0b

#define USB_SUBLANG_SPANISH_ECUADOR 0x0c

#define USB_SUBLANG_SPANISH_CHILE   0x0d

#define USB_SUBLANG_SPANISH_URUGUAY 0x0e

#define USB_SUBLANG_SPANISH_PARAGUAY    0x0f

#define USB_SUBLANG_SPANISH_BOLIVIA 0x10

#define USB_SUBLANG_SPANISH_EL_SALVADOR 0x11

#define USB_SUBLANG_SPANISH_HONDURAS    0x12

#define USB_SUBLANG_SPANISH_NICARAGUA   0x13

#define USB_SUBLANG_SPANISH_PUERTO_RICO 0x14

#define USB_SUBLANG_SWEDISH 0x01

#define USB_SUBLANG_SWEDISH_FINLAND 0x02

#define USB_SUBLANG_URDU_PAKISTAN   0x01

#define USB_SUBLANG_URDU_INDIA  0x02

#define USB_SUBLANG_UZBEK_LATIN 0x01

#define USB_SUBLANG_UZBEK_CYRILLIC  0x02

#define USB_SUBLANG_HID_USAGE_DATA_DESCRIPTOR   0x01

#define USB_SUBLANG_HID_VENDOR_DEFINED_1    0x3c

#define USB_SUBLANG_HID_VENDOR_DEFINED_2    0x3d

#define USB_SUBLANG_HID_VENDOR_DEFINED_3    0x3e

#define USB_SUBLANG_HID_VENDOR_DEFINED_4    0x3f


#define USB_LANGID_US_ENGLISH   (USB_LANG_ENGLISH | (USB_SUBLANG_ENGLISH_US << 10))

#define USB_LANGID_UK_ENGLISH   (USB_LANG_ENGLISH | (USB_SUBLANG_ENGLISH_UK << 10))

#define USB_LANGID_AUS_ENGLISH  (USB_LANG_ENGLISH | (USB_SUBLANG_ENGLISH_AUS << 10))

#define USB_LANGID_CAN_ENGLISH  (USB_LANG_ENGLISH | (USB_SUBLANG_ENGLISH_CAN << 10))

#define USB_LANGID_NZ_ENGLISH   (USB_LANG_ENGLISH | (USB_SUBLANG_ENGLISH_NZ << 10))

#define USB_LANGID_EIRE_ENGLISH (USB_LANG_ENGLISH | (USB_SUBLANG_ENGLISH_EIRE << 10))

#define USB_LANGID_SOUTH_AFRICA_ENGLISH (USB_LANG_ENGLISH | (USB_SUBLANG_ENGLISH_SOUTH_AFRICA << 10))

#define USB_LANGID_JAMAICA_ENGLISH  (USB_LANG_ENGLISH | (USB_SUBLANG_ENGLISH_JAMAICA << 10))

#define USB_LANGID_CARIBBEAN_ENGLISH    (USB_LANG_ENGLISH | (USB_SUBLANG_ENGLISH_CARIBBEAN << 10))

#define USB_LANGID_BELIZE_ENGLISH   (USB_LANG_ENGLISH | (USB_SUBLANG_ENGLISH_BELIZE << 10))

#define USB_LANGID_TRINIDAD_ENGLISH (USB_LANG_ENGLISH | (USB_SUBLANG_ENGLISH_TRINIDAD << 10))

#define USB_LANGID_PHILIPPINES_ENGLISH  (USB_LANG_ENGLISH | (USB_SUBLANG_ENGLISH_PHILIPPINES << 10))

#define USB_LANGID_ZIMBABWE_ENGLISH (USB_LANG_ENGLISH | (USB_SUBLANG_ENGLISH_ZIMBABWE << 10))


#define USB_LANGID_USAGE_HID    (USB_LANG_HID | (USB_SUBLANG_HID_USAGE_DATA_DESCRIPTOR << 10))

#define USB_LANGID_VENDOR1_HID  (USB_LANG_HID | (USB_SUBLANG_HID_VENDOR_DEFINED_1 << 10))

#define USB_LANGID_VENDOR2_HID  (USB_LANG_HID | (USB_SUBLANG_HID_VENDOR_DEFINED_2 << 10))

#define USB_LANGID_VENDOR3_HID  (USB_LANG_HID | (USB_SUBLANG_HID_VENDOR_DEFINED_3 << 10))

#define USB_LANGID_VENDOR4_HID  (USB_LANG_HID | (USB_SUBLANG_HID_VENDOR_DEFINED_4 << 10))


#define USB_VENDORID_REALTEK    0x0BDA


#define USB_HUB_PREFIX  "USBHub"


#define USBHUB_TYPE_NONE    0


#define USBHUB_TYPE_MAX 0


#define USBHUB_STATE_DETACHED   0

#define USBHUB_STATE_DETACHING  1

#define USBHUB_STATE_ATTACHING  2

#define USBHUB_STATE_ATTACHED   3


#define USBHUB_STATE_MAX    3


#define USBHUB_FLAG_NONE    0x00000000

#define USBHUB_FLAG_COMPOUND    0x00000001

#define USBHUB_FLAG_PORT_POWER  0x00000002

#define USBHUB_FLAG_PORT_PROTECTION 0x00000004

#define USBHUB_FLAG_MULTI_TRANSLATOR    0x00000008


#define USBHUB_THREAD_STACK_SIZE    SIZE_32K

#define USBHUB_THREAD_PRIORITY  THREAD_PRIORITY_HIGHEST

#define USBHUB_THREAD_NAME  "USB Hub"


#define USBHUB_DEVICE_DESCRIPTION   "USB Hub"


#define USBHUB_DRIVER_NAME  "USB Hub Driver"


#define USB_PORT_RESET_TIMEOUT  500

#define USB_PORT_RESET_RECOVERY 30

#define USB_PORT_SHORT_RESET_DELAY  10

#define USB_PORT_LONG_RESET_DELAY   200

#define USB_PORT_ROOT_RESET_DELAY   60


#define USB_ATTACH_DEBOUNCE_INTERVAL    100

#define USB_ADDRESS_COMPLETION_TIME 50


#define USB_HUB_CHARACTERISTIC_LPSM (3 << 0)

#define USB_HUB_CHARACTERISTIC_LPSM_GANGED  (0 << 0)

#define USB_HUB_CHARACTERISTIC_LPSM_PORT    (1 << 0)

#define USB_HUB_CHARACTERISTIC_IS_COMPOUND_DEVICE   (1 << 2)

#define USB_HUB_CHARACTERISTIC_OCPM (3 << 3)

#define USB_HUB_CHARACTERISTIC_OCPM_GLOBAL  (0 << 3)

#define USB_HUB_CHARACTERISTIC_OCPM_PORT    (1 << 3)

#define USB_HUB_CHARACTERISTIC_OCPM_NONE    (2 << 3)

#define USB_HUB_CHARACTERISTIC_TTTT (3 << 5)

#define USB_HUB_CHARACTERISTIC_TTTT_8   (0 << 5)

#define USB_HUB_CHARACTERISTIC_TTTT_16  (1 << 5)

#define USB_HUB_CHARACTERISTIC_TTTT_24  (2 << 5)

#define USB_HUB_CHARACTERISTIC_TTTT_32  (3 << 5)

#define USB_HUB_CHARACTERISTIC_PORT_INDICATOR   (1 << 7)


#define USB_C_HUB_LOCAL_POWER   0

#define USB_C_HUB_OVER_CURRENT  1


#define USB_PORT_CONNECTION 0

#define USB_PORT_ENABLE 1

#define USB_PORT_SUSPEND    2

#define USB_PORT_OVER_CURRENT   3

#define USB_PORT_RESET  4

#define USB_PORT_POWER  8

#define USB_PORT_LOW_SPEED  9

#define USB_C_PORT_CONNECTION   16

#define USB_C_PORT_ENABLE   17

#define USB_C_PORT_SUSPEND  18

#define USB_C_PORT_OVER_CURRENT 19

#define USB_C_PORT_RESET    20

#define USB_PORT_TEST   21

#define USB_PORT_INDICATOR  22


#define USB_HUB_REQUEST_GET_STATUS  0

#define USB_HUB_REQUEST_CLEAR_FEATURE   1

#define USB_HUB_REQUEST_SET_FEATURE 3

#define USB_HUB_REQUEST_GET_DESCRIPTOR  6

#define USB_HUB_REQUEST_SET_DESCRIPTOR  7

#define USB_HUB_REQUEST_CLEAR_TT_BUFFER 8

#define USB_HUB_REQUEST_RESET_TT    9

#define USB_HUB_REQUEST_GET_TT_STATE    10

#define USB_HUB_REQUEST_STOP_TT 11


#define USB_PORT_STATUS_CONNNECTED  (1 << 0)

#define USB_PORT_STATUS_ENABLED (1 << 1)

#define USB_PORT_STATUS_SUSPENDED   (1 << 2)

#define USB_PORT_STATUS_OVERCURRENT (1 << 3)

#define USB_PORT_STATUS_RESET   (1 << 4)

#define USB_PORT_STATUS_POWERED (1 << 8)

#define USB_PORT_STATUS_LOW_SPEED_ATTACHED  (1 << 9)

#define USB_PORT_STATUS_HIGH_SPEED_ATTACHED (1 << 10)

#define USB_PORT_STATUS_TEST_MODE   (1 << 11)

#define USB_PORT_STATUS_INDICATOR_CONTROL   (1 << 12)


#define USB_PORT_CHANGE_CONNECTED   (1 << 0)

#define USB_PORT_CHANGE_ENABLED (1 << 1)

#define USB_PORT_CHANGE_SUSPENDED   (1 << 2)

#define USB_PORT_CHANGE_OVERCURRENT (1 << 3)

#define USB_PORT_CHANGE_RESET   (1 << 4)


#define USB_HUB_STATUS_LOCAL_POWER  (1 << 0)

#define USB_HUB_STATUS_OVERCURRENT  (1 << 1)


#define USB_HUB_CHANGE_LOCAL_POWER  (1 << 0)

#define USB_HUB_CHANGE_OVERCURRENT  (1 << 1)


typedef struct _USB_DEVICE_ID USB_DEVICE_ID;


struct _USB_DEVICE_ID

{

    uint16_t idvendor;

    uint16_t idproduct;

};


typedef struct _USB_INTERFACE_ID USB_INTERFACE_ID;


struct _USB_INTERFACE_ID

{

    uint8_t binterfaceclass;

    uint8_t binterfacesubclass;

    uint8_t binterfaceprotocol;

};


typedef struct _USB_DEVICE_AND_INTERFACE_ID USB_DEVICE_AND_INTERFACE_ID;


struct _USB_DEVICE_AND_INTERFACE_ID

{

    uint16_t idvendor;

    uint16_t idproduct;

    uint8_t binterfaceclass;

    uint8_t binterfacesubclass;

    uint8_t binterfaceprotocol;

};


typedef struct _USB_DEVICE_AND_INTERFACE_NO USB_DEVICE_AND_INTERFACE_NO;


struct _USB_DEVICE_AND_INTERFACE_NO

{

    uint16_t idvendor;

    uint16_t idproduct;

    uint8_t binterfacenumber;

};


typedef struct _USB_CONTROL_SETUP_DATA USB_CONTROL_SETUP_DATA;


struct _USB_CONTROL_SETUP_DATA

{

    uint8_t bmrequesttype;

    uint8_t brequest;

    uint16_t wvalue;

    uint16_t windex;

    uint16_t wlength;

} PACKED;


typedef struct _USB_DESCRIPTOR_HEADER USB_DESCRIPTOR_HEADER;


struct _USB_DESCRIPTOR_HEADER

{

    uint8_t blength;

    uint8_t bdescriptortype;

} PACKED;


typedef struct _USB_DEVICE_DESCRIPTOR USB_DEVICE_DESCRIPTOR;


struct _USB_DEVICE_DESCRIPTOR

{

    uint8_t blength;

    uint8_t bdescriptortype;

    uint16_t bcdusb;

    uint8_t bdeviceclass;

    uint8_t bdevicesubclass;

    uint8_t bdeviceprotocol;

    uint8_t bmaxpacketsize0;

    uint16_t idvendor;

    uint16_t idproduct;

    uint16_t bcddevice;

    uint8_t imanufacturer;

    uint8_t iproduct;

    uint8_t iserialnumber;

    uint8_t bnumconfigurations;

} PACKED;


typedef struct _USB_CONFIGURATION_DESCRIPTOR USB_CONFIGURATION_DESCRIPTOR;


struct _USB_CONFIGURATION_DESCRIPTOR

{

    uint8_t blength;

    uint8_t bdescriptortype;

    uint16_t wtotallength;

    uint8_t bnuminterfaces;

    uint8_t bconfigurationvalue;

    uint8_t iconfiguration;

    uint8_t bmattributes;

    uint8_t bmaxpower;

} PACKED;


typedef struct _USB_INTERFACE_DESCRIPTOR USB_INTERFACE_DESCRIPTOR;


struct _USB_INTERFACE_DESCRIPTOR

{

    uint8_t blength;

    uint8_t bdescriptortype;

    uint8_t binterfacenumber;

    uint8_t balternatesetting;

    uint8_t bnumendpoints;

    uint8_t binterfaceclass;

    uint8_t binterfacesubclass;

    uint8_t binterfaceprotocol;

    uint8_t iinterface;

} PACKED;


typedef struct _USB_ENDPOINT_DESCRIPTOR USB_ENDPOINT_DESCRIPTOR;


struct _USB_ENDPOINT_DESCRIPTOR

{

    uint8_t blength;

    uint8_t bdescriptortype;

    uint8_t bendpointaddress;

    uint8_t bmattributes;

    uint16_t wmaxpacketsize;

    uint8_t binterval;

} PACKED;


typedef struct _USB_STRING_DESCRIPTOR USB_STRING_DESCRIPTOR;


struct _USB_STRING_DESCRIPTOR

{

    uint8_t blength;

    uint8_t bdescriptortype;

    uint16_t bstring[];

} PACKED;


typedef uint16_t USB_STRING_DESCRIPTOR_STRING[126];


typedef uint16_t USB_STRING_DESCRIPTOR_LANGIDS[126];


typedef struct _USB_DEVICE_STATUS USB_DEVICE_STATUS;


struct _USB_DEVICE_STATUS

{

    uint16_t wstatus;

} PACKED;


typedef struct _USB_HOST USB_HOST;

typedef struct _USB_DRIVER USB_DRIVER;

typedef struct _USB_ALTERNATE USB_ALTERNATE;

typedef struct _USB_INTERFACE USB_INTERFACE;

typedef struct _USB_CONFIGURATION USB_CONFIGURATION;

typedef struct _USB_DEVICE USB_DEVICE;


typedef uint32_t STDCALL (*usb_device_bind_proc)(USB_DEVICE *device);

typedef uint32_t STDCALL (*usb_device_unbind_proc)(USB_DEVICE *device, USB_DRIVER *driver);

typedef uint32_t STDCALL (*usb_device_enumerate_cb)(USB_DEVICE *device, void *data);

typedef uint32_t STDCALL (*usb_device_notification_cb)(DEVICE *device, void *data, uint32_t notification);


struct _USB_DEVICE

{

    // Device Properties

    DEVICE device;

    // USB Properties

    uint32_t usbid;

    uint32_t usbstate;

    uint32_t usbstatus;

    USB_HOST *host;

    USB_DEVICE *parent;

    USB_DRIVER *driver;

    // Driver Properties

    MUTEX_HANDLE lock;

    uint32_t address;

    uint32_t speed;

    uint32_t depth;

    uint32_t portnumber;

    uint32_t configurationvalue;

    USB_DEVICE_DESCRIPTOR *descriptor;

    USB_CONFIGURATION *configuration;

    USB_CONFIGURATION *configurations;

    char product[128];

    char manufacturer[128];

    char serialnumber[128];

    void *driverdata;

    uint32_t lasterror;

    uint32_t pendingcount;

    THREAD_ID waiterthread;

    // Statistics Properties

    uint32_t requestcount;

    uint32_t requesterrors;

    // Internal Properties

    USB_DEVICE *prev;

    USB_DEVICE *next;

};


struct _USB_CONFIGURATION

{

    // Driver Properties

    USB_CONFIGURATION_DESCRIPTOR *descriptor;

    USB_INTERFACE *interfaces;

    char description[128];

};


struct _USB_INTERFACE

{

    // USB Properties

    USB_DRIVER *driver;

    // Driver Properties

    uint32_t alternatecount;

    uint32_t alternatesetting;

    USB_INTERFACE_DESCRIPTOR *descriptor;

    USB_ENDPOINT_DESCRIPTOR *endpoints;

    USB_ALTERNATE *alternates;

    char description[128];

    uint8_t *classdata;

    uint32_t classsize;

    void *driverdata;

};


struct _USB_ALTERNATE

{

    // Driver Properties

    USB_INTERFACE_DESCRIPTOR *descriptor;

    USB_ENDPOINT_DESCRIPTOR *endpoints;

    char description[128];

};


typedef uint32_t STDCALL (*usb_driver_enumerate_cb)(USB_DRIVER *driver, void *data);


typedef uint32_t STDCALL (*usb_driver_bind_proc)(USB_DEVICE *device, USB_INTERFACE *interrface);

typedef uint32_t STDCALL (*usb_driver_unbind_proc)(USB_DEVICE *device, USB_INTERFACE *interrface);


struct _USB_DRIVER

{

    // Driver Properties

    DRIVER driver;

    // USB Properties

    usb_driver_bind_proc driverbind;

    usb_driver_unbind_proc driverunbind;

    // Interface Properties

    MUTEX_HANDLE lock;

    // Internal Properties

    USB_DRIVER *prev;

    USB_DRIVER *next;

};


typedef struct _USB_REQUEST USB_REQUEST;


typedef uint32_t STDCALL (*usb_host_enumerate_cb)(USB_HOST *host, void *data);

typedef uint32_t STDCALL (*usb_host_notification_cb)(DEVICE *device, void *data, uint32_t notification);


typedef uint32_t STDCALL (*usb_host_start_proc)(USB_HOST *host);

typedef uint32_t STDCALL (*usb_host_stop_proc)(USB_HOST *host);

typedef uint32_t STDCALL (*usb_host_reset_proc)(USB_HOST *host);

typedef uint32_t STDCALL (*usb_host_submit_proc)(USB_HOST *host, USB_REQUEST *request);

typedef uint32_t STDCALL (*usb_host_cancel_proc)(USB_HOST *host, USB_REQUEST *request);


struct _USB_HOST

{

    // Device Properties

    DEVICE device;

    // USB Properties

    uint32_t hostid;

    uint32_t hoststate;

    usb_host_start_proc hoststart;

    usb_host_stop_proc hoststop;

    usb_host_reset_proc hostreset;

    usb_host_submit_proc hostsubmit;

    usb_host_cancel_proc hostcancel;

    // Driver Properties

    MUTEX_HANDLE lock;

    USB_DEVICE *roothub;

    uint32_t alignment;

    uint32_t multiplier;

    uint32_t maxtransfer;

    // Statistics Properties

    uint32_t requestcount;

    uint32_t requesterrors;

    // Internal Properties

    USB_HOST *prev;

    USB_HOST *next;

};


typedef void STDCALL (*usb_request_completed_cb)(USB_REQUEST *request);


struct _USB_REQUEST

{

    // Request Properties

    USB_DEVICE *device;

    USB_ENDPOINT_DESCRIPTOR *endpoint;

    void *data;

    uint32_t size;

    uint32_t flags;

    usb_request_completed_cb callback;

    void *driverdata;

    // Control Properties

    USB_CONTROL_SETUP_DATA *setupdata;

    uint32_t statusdata;

    // Result Properties

    uint32_t status;

    uint32_t actualsize;

    // Driver Properties

    void *transferdata;

    void *currentdata;

    LONGBOOL isping;

    LONGBOOL issplit;

    LONGBOOL completesplit;

    LONGBOOL shortattempt;

    LONGBOOL startofframe;

    uint32_t controlphase;

    uint32_t nextdatapid;

    uint32_t attemptedpackets;

    uint32_t attemptedbytes;

    uint32_t attemptedpacketsremaining;

    uint32_t attemptedbytesremaining;

    uint32_t totalpacketsattempted;

    uint32_t totalbytesattempted;

    uint32_t packetstransferred;

    uint32_t bytestransferred;

    uint32_t spliterrorcount;

    uint32_t completesplitretries;

    THREAD_HANDLE resubmitthread;

    SEMAPHORE_HANDLE resubmitsemaphore;

#ifdef USB_DEBUG

    // Debug Statistics

    uint32_t startsplitattempts;

    uint32_t completesplitattempts;

    uint32_t completesplitrestarts;

    uint32_t startsplitnaks;

    uint32_t completesplitnyets;

    uint32_t completesplitnaks;

#endif

};


typedef struct _USB_HUB_DESCRIPTOR USB_HUB_DESCRIPTOR;


struct _USB_HUB_DESCRIPTOR

{

    uint8_t bdesclength;

    uint8_t bdescriptortype;

    uint8_t bnbrports;

    uint16_t whubcharacteristics;

    uint8_t bpwron2pwrgood;

    uint8_t bhubcontrcurrent;

    uint8_t vardata[];

} PACKED;


typedef uint8_t USB_HUB_DESCRIPTOR_DATA[64];


typedef struct _USB_PORT_STATUS USB_PORT_STATUS;


struct _USB_PORT_STATUS

{

    uint16_t wportstatus;

    uint16_t wportchange;

} PACKED;


typedef struct _USB_HUB_STATUS USB_HUB_STATUS;


struct _USB_HUB_STATUS

{

    uint16_t whubstatus;

    uint16_t whubchange;

} PACKED;


typedef struct _USB_HUB_DATA USB_HUB_DATA;


struct _USB_HUB_DATA

{

    uint8_t data[8];

};


typedef struct _USB_HUB USB_HUB;

typedef struct _USB_PORT USB_PORT;


struct _USB_PORT

{

    USB_HUB *hub;

    uint8_t number;

    USB_DEVICE *child;

    USB_PORT_STATUS status;

};


typedef uint32_t STDCALL (*usb_hub_enumerate_cb)(USB_HUB *hub, void *data);

typedef uint32_t STDCALL (*usb_hub_notification_cb)(DEVICE *device, void *data, uint32_t notification);


struct _USB_HUB

{

    // Device Properties

    DEVICE device;

    // Hub Properties

    uint32_t hubid;

    uint32_t hubstate;

    // Driver Properties

    MUTEX_HANDLE lock;

    USB_HUB_DESCRIPTOR *descriptor;

    USB_PORT *ports;

    // Statistics Properties

    uint32_t receivecount;

    uint32_t receiveerrors;

    // USB Properties

    USB_HUB_DATA *statusdata;

    USB_REQUEST *statusrequest;

    USB_ENDPOINT_DESCRIPTOR *statusendpoint;

    uint32_t pendingcount;

    THREAD_ID waiterthread;

    // Internal Properties

    USB_HUB *prev;

    USB_HUB *next;

};


typedef void STDCALL (*usb_log_output_proc)(const char *text, void *data);


uint32_t STDCALL usb_start(void);

uint32_t STDCALL usb_stop(void);


void STDCALL usb_async_start(USB_HOST *host);


uint8_t STDCALL usb_device_get_address(USB_DEVICE *device);


uint32_t STDCALL usb_device_set_address(USB_DEVICE *device, uint8_t address);


uint32_t STDCALL usb_device_get_descriptor(USB_DEVICE *device, uint8_t brequest, uint8_t bmrequesttype, uint16_t wvalue, uint16_t windex, void *data, uint16_t length);


uint32_t STDCALL usb_device_get_device_descriptor(USB_DEVICE *device, void *data, uint16_t length);


uint32_t STDCALL usb_device_create_device_descriptor(USB_DEVICE *device, uint16_t length);


uint32_t STDCALL usb_device_read_device_descriptor(USB_DEVICE *device, uint16_t length);


uint32_t STDCALL usb_device_read_device_descriptor_ex(USB_DEVICE *device, uint16_t length, BOOL allowshort);


uint32_t STDCALL usb_device_create_configurations(USB_DEVICE *device);


uint32_t STDCALL usb_device_read_configurations(USB_DEVICE *device);


uint32_t STDCALL usb_device_create_configuration(USB_DEVICE *device, uint8_t index, uint16_t size);


uint32_t STDCALL usb_device_read_configuration(USB_DEVICE *device, uint8_t index);


uint32_t STDCALL usb_device_get_string_descriptor(USB_DEVICE *device, uint8_t index, void *data, uint16_t length);


uint32_t STDCALL usb_device_get_string_descriptor_ex(USB_DEVICE *device, uint8_t index, uint16_t languageid, void *data, uint16_t length);


void STDCALL usb_device_read_string_language_ids(USB_DEVICE *device, USB_STRING_DESCRIPTOR_LANGIDS *languageids);


uint32_t STDCALL usb_device_read_string_descriptor(USB_DEVICE *device, uint8_t index, char *value, uint32_t len);


uint32_t STDCALL usb_device_read_string_descriptor_ex(USB_DEVICE *device, uint8_t index, uint16_t languageid, char *value, uint32_t len);


uint32_t STDCALL usb_device_read_string_descriptor_w(USB_DEVICE *device, uint8_t index, WCHAR *value, uint32_t len);


uint32_t STDCALL usb_device_read_string_descriptor_ex_w(USB_DEVICE *device, uint8_t index, uint16_t languageid, WCHAR *value, uint32_t len);


uint32_t STDCALL usb_device_get_configuration_descriptor(USB_DEVICE *device, uint8_t index, void *data, uint16_t length);


uint32_t STDCALL usb_device_get_configuration(USB_DEVICE *device, uint8_t *configurationvalue);


uint32_t STDCALL usb_device_set_configuration(USB_DEVICE *device, uint8_t configurationvalue);


USB_CONFIGURATION * STDCALL usb_device_find_configuration_by_value(USB_DEVICE *device, uint8_t configurationvalue);


USB_HUB * STDCALL usb_device_get_hub(USB_DEVICE *device);


USB_PORT * STDCALL usb_device_get_port(USB_DEVICE *device);


uint32_t STDCALL usb_device_get_interface(USB_DEVICE *device, uint8_t index, uint8_t *alternatesetting);


uint32_t STDCALL usb_device_set_interface(USB_DEVICE *device, uint8_t index, uint8_t alternatesetting);


USB_INTERFACE * STDCALL usb_device_find_interface_by_index(USB_DEVICE *device, uint8_t index);


USB_INTERFACE * STDCALL usb_device_find_interface_by_class_only(USB_DEVICE *device, uint8_t interfaceclass);


USB_INTERFACE * STDCALL usb_device_find_interface_by_class(USB_DEVICE *device, uint8_t interfaceclass, uint8_t interfacesubclass, uint8_t interfaceprotocol);


USB_ENDPOINT_DESCRIPTOR * STDCALL usb_device_find_endpoint_by_index(USB_DEVICE *device, USB_INTERFACE *interrface, uint8_t index);


USB_ENDPOINT_DESCRIPTOR * STDCALL usb_device_find_endpoint_by_type(USB_DEVICE *device, USB_INTERFACE *interrface, uint8_t direction, uint8_t transfertype);


USB_ENDPOINT_DESCRIPTOR * STDCALL usb_device_find_endpoint_by_type_ex(USB_DEVICE *device, USB_INTERFACE *interrface, uint8_t direction, uint8_t transfertype, uint8_t *index);


uint8_t STDCALL usb_device_count_endpoints_by_type(USB_DEVICE *device, USB_INTERFACE *interrface, uint8_t direction, uint8_t transfertype);


USB_ALTERNATE * STDCALL usb_device_find_alternate_by_index(USB_DEVICE *device, USB_INTERFACE *interrface, uint8_t index);


USB_ALTERNATE * STDCALL usb_device_find_alternate_by_setting(USB_DEVICE *device, USB_INTERFACE *interrface, uint8_t alternatesetting);


USB_ENDPOINT_DESCRIPTOR * STDCALL usb_device_find_alternate_endpoint_by_index(USB_DEVICE *device, USB_INTERFACE *interrface, USB_ALTERNATE *alternate, uint8_t index);


USB_ENDPOINT_DESCRIPTOR * STDCALL usb_device_find_alternate_endpoint_by_type(USB_DEVICE *device, USB_INTERFACE *interrface, USB_ALTERNATE *alternate, uint8_t direction, uint8_t transfertype);


uint32_t STDCALL usb_device_set_feature(USB_DEVICE *device, USB_ENDPOINT_DESCRIPTOR *endpoint, uint16_t feature, uint16_t index);


uint32_t STDCALL usb_device_clear_feature(USB_DEVICE *device, USB_ENDPOINT_DESCRIPTOR *endpoint, uint16_t feature);


uint32_t STDCALL usb_device_set_state(USB_DEVICE *device, uint32_t state);


uint32_t STDCALL usb_device_set_status(USB_DEVICE *device, uint32_t status);


uint32_t STDCALL usb_device_bind(USB_DEVICE *device);


uint32_t STDCALL usb_device_unbind(USB_DEVICE *device, USB_DRIVER *driver);


uint32_t STDCALL usb_device_attach(USB_DEVICE *device);


uint32_t STDCALL usb_device_detach(USB_DEVICE *device);


USB_DEVICE * STDCALL usb_device_allocate(USB_HOST *host, USB_DEVICE *parent);


uint32_t STDCALL usb_device_release(USB_DEVICE *device);


USB_DEVICE * STDCALL usb_device_find(uint32_t usbid);

USB_DEVICE * STDCALL usb_device_find_by_id(uint16_t vendorid, uint16_t productid);

USB_DEVICE * STDCALL usb_device_find_by_name(const char *name);

USB_DEVICE * STDCALL usb_device_find_by_description(const char *description);

uint32_t STDCALL usb_device_enumerate(usb_device_enumerate_cb callback, void *data);


uint32_t STDCALL usb_device_notification(USB_DEVICE *device, usb_device_notification_cb callback, void *data, uint32_t notification, uint32_t flags);


USB_DRIVER * STDCALL usb_driver_create(void);


USB_DRIVER * STDCALL usb_driver_create_ex(uint32_t size);


uint32_t STDCALL usb_driver_destroy(USB_DRIVER *driver);


uint32_t STDCALL usb_driver_register(USB_DRIVER *driver);


uint32_t STDCALL usb_driver_deregister(USB_DRIVER *driver);


USB_DRIVER * STDCALL usb_driver_find(uint32_t driverid);


USB_DRIVER * STDCALL usb_driver_find_by_name(const char *name);


uint32_t STDCALL usb_driver_enumerate(usb_driver_enumerate_cb callback, void *data);


uint32_t STDCALL usb_host_set_state(USB_HOST *host, uint32_t state);


USB_HOST * STDCALL usb_host_create(void);


USB_HOST * STDCALL usb_host_create_ex(uint32_t size);


uint32_t STDCALL usb_host_destroy(USB_HOST *host);


uint32_t STDCALL usb_host_register(USB_HOST *host);


uint32_t STDCALL usb_host_deregister(USB_HOST *host);


USB_HOST * STDCALL usb_host_find(uint32_t hostid);

USB_HOST * STDCALL usb_host_find_by_name(const char *name);

USB_HOST * STDCALL usb_host_find_by_description(const char *description);

uint32_t STDCALL usb_host_enumerate(usb_host_enumerate_cb callback, void *data);


uint32_t STDCALL usb_host_notification(USB_HOST *host, usb_host_notification_cb callback, void *data, uint32_t notification, uint32_t flags);


void * STDCALL usb_buffer_allocate(USB_DEVICE *device, uint32_t size);


void * STDCALL usb_buffer_allocate_ex(USB_DEVICE *device, uint32_t size, uint32_t *flags);


uint32_t STDCALL usb_buffer_validate(USB_DEVICE *device, void *buffer, uint32_t size, uint32_t *flags);


uint32_t STDCALL usb_buffer_release(void *buffer);


USB_REQUEST * STDCALL usb_request_allocate(USB_DEVICE *device, USB_ENDPOINT_DESCRIPTOR *endpoint, usb_request_completed_cb callback, uint32_t size, void *driverdata);


USB_REQUEST * STDCALL usb_request_allocate_ex(USB_DEVICE *device, USB_ENDPOINT_DESCRIPTOR *endpoint, usb_request_completed_cb callback, void *data, uint32_t size, void *driverdata);


uint32_t STDCALL usb_request_release(USB_REQUEST *request);


uint32_t STDCALL usb_request_initialize(USB_REQUEST *request, usb_request_completed_cb callback, void *data, uint32_t size, void *driverdata);


uint32_t STDCALL usb_request_submit(USB_REQUEST *request);


uint32_t STDCALL usb_request_cancel(USB_REQUEST *request);


uint32_t STDCALL usb_control_request(USB_DEVICE *device, USB_ENDPOINT_DESCRIPTOR *endpoint, uint8_t brequest, uint8_t bmrequesttype, uint16_t wvalue, uint16_t windex, void *data, uint16_t wlength);


uint32_t STDCALL usb_control_request_ex(USB_DEVICE *device, USB_ENDPOINT_DESCRIPTOR *endpoint, uint8_t brequest, uint8_t bmrequesttype, uint16_t wvalue, uint16_t windex, void *data, uint16_t wlength, uint32_t timeout, BOOL allowshort);


uint32_t STDCALL usb_control_transfer(USB_DEVICE *device, USB_ENDPOINT_DESCRIPTOR *endpoint, uint8_t brequest, uint8_t bmrequesttype, uint16_t wvalue, uint16_t windex, void *data, uint16_t wlength, uint32_t *count, uint32_t timeout);


uint32_t STDCALL usb_bulk_transfer(USB_DEVICE *device, USB_ENDPOINT_DESCRIPTOR *endpoint, void *data, uint32_t size, uint32_t *count, uint32_t timeout);


uint32_t STDCALL usb_interrupt_transfer(USB_DEVICE *device, USB_ENDPOINT_DESCRIPTOR *endpoint, void *data, uint32_t size, uint32_t *count, uint32_t timeout);


uint32_t STDCALL usb_hub_create_ports(USB_HUB *hub);


uint32_t STDCALL usb_hub_power_on_ports(USB_HUB *hub);


uint32_t STDCALL usb_hub_create_hub_descriptor(USB_HUB *hub);


uint32_t STDCALL usb_hub_read_hub_descriptor(USB_HUB *hub);


uint32_t STDCALL usb_hub_lock(USB_HUB *hub);


uint32_t STDCALL usb_hub_unlock(USB_HUB *hub);


uint32_t STDCALL usb_hub_set_state(USB_HUB *hub, uint32_t state);


USB_HUB * STDCALL usb_hub_allocate(USB_DEVICE *device);


uint32_t STDCALL usb_hub_release(USB_HUB *hub);


USB_HUB * STDCALL usb_hub_find(uint32_t hubid);

USB_HUB * STDCALL usb_hub_find_by_name(const char *name);

USB_HUB * STDCALL usb_hub_find_by_description(const char *description);

uint32_t STDCALL usb_hub_enumerate(usb_hub_enumerate_cb callback, void *data);


uint32_t STDCALL usb_hub_notification(USB_HUB *hub, usb_hub_notification_cb callback, void *data, uint32_t notification, uint32_t flags);


void STDCALL usb_hub_bind_devices(USB_DEVICE *device, usb_device_bind_proc callback);


void STDCALL usb_hub_unbind_devices(USB_DEVICE *device, USB_DRIVER *driver, usb_device_unbind_proc callback);


void STDCALL usb_hub_enumerate_devices(USB_DEVICE *device, usb_device_enumerate_cb callback, void *data);


uint32_t STDCALL usb_hub_port_reset(USB_PORT *port, uint32_t delay);


uint32_t STDCALL usb_hub_port_disable(USB_PORT *port);


uint32_t STDCALL usb_hub_port_power_on(USB_PORT *port);


uint32_t STDCALL usb_hub_port_power_off(USB_PORT *port);


uint32_t STDCALL usb_hub_port_get_status(USB_PORT *port);


uint32_t STDCALL usb_hub_port_set_feature(USB_PORT *port, uint16_t feature);


uint32_t STDCALL usb_hub_port_clear_feature(USB_PORT *port, uint16_t feature);


uint32_t STDCALL usb_hub_port_change_feature(USB_PORT *port, uint16_t feature, BOOL enable);


uint32_t STDCALL usb_hub_port_attach_device(USB_PORT *port);


uint32_t STDCALL usb_hub_port_detach_device(USB_PORT *port);


uint32_t STDCALL usb_hub_port_status_changed(USB_PORT *port);


uint32_t STDCALL usb_device_get_count(void);


USB_DEVICE * STDCALL usb_device_check(USB_DEVICE *device);


uint32_t STDCALL usb_driver_get_count(void);


USB_DRIVER * STDCALL usb_driver_check(USB_DRIVER *driver);


uint32_t STDCALL usb_host_get_count(void);


USB_HOST * STDCALL usb_host_check(USB_HOST *host);


BOOL STDCALL usb_is_hub(USB_DEVICE *device);


BOOL STDCALL usb_is_root_hub(USB_DEVICE *device);


BOOL STDCALL usb_is_control_request(USB_REQUEST *request);


BOOL STDCALL usb_is_bulk_request(USB_REQUEST *request);


BOOL STDCALL usb_is_interrupt_request(USB_REQUEST *request);


BOOL STDCALL usb_is_isochronous_request(USB_REQUEST *request);


BOOL STDCALL usb_is_in_endpoint(USB_ENDPOINT_DESCRIPTOR *endpoint);


BOOL STDCALL usb_is_out_endpoint(USB_ENDPOINT_DESCRIPTOR *endpoint);


BOOL STDCALL usb_is_bulk_endpoint(USB_ENDPOINT_DESCRIPTOR *endpoint);


BOOL STDCALL usb_is_interrupt_endpoint(USB_ENDPOINT_DESCRIPTOR *endpoint);


BOOL STDCALL usb_is_isochronous_endpoint(USB_ENDPOINT_DESCRIPTOR *endpoint);


uint32_t STDCALL usb_status_to_string(uint32_t status, char *string, uint32_t len);


uint32_t STDCALL usb_device_type_to_string(uint32_t usbtype, char *string, uint32_t len);

uint32_t STDCALL usb_device_state_to_string(uint32_t usbstate, char *string, uint32_t len);

uint32_t STDCALL usb_device_status_to_string(uint32_t usbstatus, char *string, uint32_t len);


uint32_t STDCALL usb_device_state_to_notification(uint32_t state);


uint32_t STDCALL usb_device_status_to_notification(uint32_t status);


uint32_t STDCALL usb_host_type_to_string(uint32_t hosttype, char *string, uint32_t len);

uint32_t STDCALL usb_host_state_to_string(uint32_t hoststate, char *string, uint32_t len);


uint32_t STDCALL usb_host_state_to_notification(uint32_t state);


void STDCALL usb_log_device_configuration(USB_DEVICE *device, usb_log_output_proc output, void *data);

void STDCALL usb_log_device_descriptor(USB_DEVICE *device, USB_DEVICE_DESCRIPTOR *descriptor, usb_log_output_proc output, void *data);

void STDCALL usb_log_configuration_descriptor(USB_DEVICE *device, USB_CONFIGURATION_DESCRIPTOR *descriptor, usb_log_output_proc output, void *data);

void STDCALL usb_log_interface_descriptor(USB_DEVICE *device, USB_INTERFACE_DESCRIPTOR *descriptor, usb_log_output_proc output, void *data);

void STDCALL usb_log_endpoint_descriptor(USB_DEVICE *device, USB_ENDPOINT_DESCRIPTOR *descriptor, usb_log_output_proc output, void *data);


uint32_t STDCALL usb_log_devices(void);


uint32_t STDCALL usb_log_devices_ex(USB_DEVICE *device, usb_log_output_proc output, usb_device_enumerate_cb devicecallback, usb_device_enumerate_cb treecallback, void *data);


uint32_t STDCALL usb_log_device_callback(USB_DEVICE *device, void *data);

uint32_t STDCALL usb_log_tree_callback(USB_DEVICE *device, void *data);


uint32_t STDCALL usb_hub_get_count(void);


USB_HUB * STDCALL usb_hub_check(USB_HUB *hub);


BOOL STDCALL usb_hub_is_multi_tt(USB_HUB *hub);


BOOL STDCALL usb_hub_is_compound(USB_HUB *hub);


BOOL STDCALL usb_hub_has_port_indicator(USB_HUB *hub);


BOOL STDCALL usb_hub_has_port_power_switching(USB_HUB *hub);


BOOL STDCALL usb_hub_has_port_current_protection(USB_HUB *hub);


uint8_t STDCALL usb_hub_get_tt_think_time(USB_HUB *hub);


uint32_t STDCALL usb_hub_type_to_string(uint32_t hubtype, char *string, uint32_t len);


uint32_t STDCALL usb_hub_state_to_string(uint32_t hubstate, char *string, uint32_t len);


uint32_t STDCALL usb_hub_state_to_notification(uint32_t state);


#ifdef __cplusplus

}

#endif


#endif // _ULTIBO_USB_H

devices.h

DEVICE
struct _DEVICE DEVICE
Definition devices.h:373

DRIVER
struct _DRIVER DRIVER
Definition devices.h:465

globalconst.h

globaltypes.h

LONGBOOL
int32_t LONGBOOL
Compatibility with FPC LongBool type (4 bytes).
Definition globaltypes.h:56

STDCALL
#define STDCALL
Definition globaltypes.h:45

PACKED
#define PACKED
Definition globaltypes.h:48

BOOL
_Bool BOOL
Built in Boolean type (1 byte) (Redeclared here for flexibility).
Definition globaltypes.h:55

THREAD_HANDLE
HANDLE THREAD_HANDLE
Definition globaltypes.h:113

SEMAPHORE_HANDLE
HANDLE SEMAPHORE_HANDLE
Definition globaltypes.h:107

WCHAR
wchar_t WCHAR
Standard WideChar type (2 bytes) (Redeclared here for flexibility).
Definition globaltypes.h:58

MUTEX_HANDLE
HANDLE MUTEX_HANDLE
Definition globaltypes.h:105

_USB_ALTERNATE
Definition usb.h:942

_USB_ALTERNATE::endpoints
USB_ENDPOINT_DESCRIPTOR * endpoints
All available endpoint descriptors on this alternate setting (Set by USB core).
Definition usb.h:945

_USB_ALTERNATE::description
char description[128]
Null terminated description string (ASCII encoded, English if available) of this alternate setting.
Definition usb.h:946

_USB_ALTERNATE::descriptor
USB_INTERFACE_DESCRIPTOR * descriptor
Interface descriptor of this alternate setting (Set by USB core).
Definition usb.h:944

_USB_CONFIGURATION_DESCRIPTOR
Definition usb.h:798

_USB_CONFIGURATION_DESCRIPTOR::iconfiguration
uint8_t iconfiguration
Definition usb.h:804

_USB_CONFIGURATION_DESCRIPTOR::wtotallength
uint16_t wtotallength
Definition usb.h:801

_USB_CONFIGURATION_DESCRIPTOR::bconfigurationvalue
uint8_t bconfigurationvalue
Definition usb.h:803

_USB_CONFIGURATION_DESCRIPTOR::bnuminterfaces
uint8_t bnuminterfaces
Definition usb.h:802

_USB_CONFIGURATION_DESCRIPTOR::bmattributes
uint8_t bmattributes
Definition usb.h:805

_USB_CONFIGURATION_DESCRIPTOR::bmaxpower
uint8_t bmaxpower
Definition usb.h:806

_USB_CONFIGURATION_DESCRIPTOR::bdescriptortype
uint8_t bdescriptortype
Definition usb.h:800

_USB_CONFIGURATION_DESCRIPTOR::blength
uint8_t blength
Definition usb.h:799

_USB_CONFIGURATION
Definition usb.h:915

_USB_CONFIGURATION::interfaces
USB_INTERFACE * interfaces
All available interfaces in this configuration (Set by USB core).
Definition usb.h:918

_USB_CONFIGURATION::description
char description[128]
Null terminated description string (ASCII encoded, English if available) of this configuration.
Definition usb.h:919

_USB_CONFIGURATION::descriptor
USB_CONFIGURATION_DESCRIPTOR * descriptor
Configuration descriptor of this configuration (Set by USB core).
Definition usb.h:917

_USB_CONTROL_SETUP_DATA
Definition usb.h:759

_USB_CONTROL_SETUP_DATA::windex
uint16_t windex
Definition usb.h:763

_USB_CONTROL_SETUP_DATA::bmrequesttype
uint8_t bmrequesttype
Definition usb.h:760

_USB_CONTROL_SETUP_DATA::wlength
uint16_t wlength
Definition usb.h:764

_USB_CONTROL_SETUP_DATA::wvalue
uint16_t wvalue
Definition usb.h:762

_USB_CONTROL_SETUP_DATA::brequest
uint8_t brequest
Definition usb.h:761

_USB_DESCRIPTOR_HEADER
Definition usb.h:770

_USB_DESCRIPTOR_HEADER::bdescriptortype
uint8_t bdescriptortype
Definition usb.h:772

_USB_DESCRIPTOR_HEADER::blength
uint8_t blength
Definition usb.h:771

_USB_DEVICE_AND_INTERFACE_ID
Definition usb.h:740

_USB_DEVICE_AND_INTERFACE_ID::idvendor
uint16_t idvendor
Definition usb.h:741

_USB_DEVICE_AND_INTERFACE_ID::idproduct
uint16_t idproduct
Definition usb.h:742

_USB_DEVICE_AND_INTERFACE_ID::binterfaceprotocol
uint8_t binterfaceprotocol
Definition usb.h:745

_USB_DEVICE_AND_INTERFACE_ID::binterfacesubclass
uint8_t binterfacesubclass
Definition usb.h:744

_USB_DEVICE_AND_INTERFACE_ID::binterfaceclass
uint8_t binterfaceclass
Definition usb.h:743

_USB_DEVICE_AND_INTERFACE_NO
Definition usb.h:750

_USB_DEVICE_AND_INTERFACE_NO::idvendor
uint16_t idvendor
Definition usb.h:751

_USB_DEVICE_AND_INTERFACE_NO::binterfacenumber
uint8_t binterfacenumber
Definition usb.h:753

_USB_DEVICE_AND_INTERFACE_NO::idproduct
uint16_t idproduct
Definition usb.h:752

_USB_DEVICE_DESCRIPTOR
Definition usb.h:778

_USB_DEVICE_DESCRIPTOR::imanufacturer
uint8_t imanufacturer
Definition usb.h:789

_USB_DEVICE_DESCRIPTOR::bdeviceprotocol
uint8_t bdeviceprotocol
Definition usb.h:784

_USB_DEVICE_DESCRIPTOR::bdevicesubclass
uint8_t bdevicesubclass
Definition usb.h:783

_USB_DEVICE_DESCRIPTOR::bcddevice
uint16_t bcddevice
Definition usb.h:788

_USB_DEVICE_DESCRIPTOR::bdeviceclass
uint8_t bdeviceclass
Definition usb.h:782

_USB_DEVICE_DESCRIPTOR::iserialnumber
uint8_t iserialnumber
Definition usb.h:791

_USB_DEVICE_DESCRIPTOR::idvendor
uint16_t idvendor
Definition usb.h:786

_USB_DEVICE_DESCRIPTOR::iproduct
uint8_t iproduct
Definition usb.h:790

_USB_DEVICE_DESCRIPTOR::idproduct
uint16_t idproduct
Definition usb.h:787

_USB_DEVICE_DESCRIPTOR::bmaxpacketsize0
uint8_t bmaxpacketsize0
Definition usb.h:785

_USB_DEVICE_DESCRIPTOR::bcdusb
uint16_t bcdusb
Definition usb.h:781

_USB_DEVICE_DESCRIPTOR::bdescriptortype
uint8_t bdescriptortype
Definition usb.h:780

_USB_DEVICE_DESCRIPTOR::bnumconfigurations
uint8_t bnumconfigurations
Definition usb.h:792

_USB_DEVICE_DESCRIPTOR::blength
uint8_t blength
Definition usb.h:779

_USB_DEVICE_ID
Definition usb.h:725

_USB_DEVICE_ID::idvendor
uint16_t idvendor
Definition usb.h:726

_USB_DEVICE_ID::idproduct
uint16_t idproduct
Definition usb.h:727

_USB_DEVICE_STATUS
Definition usb.h:852

_USB_DEVICE_STATUS::wstatus
uint16_t wstatus
Definition usb.h:853

_USB_DEVICE
Definition usb.h:877

_USB_DEVICE::serialnumber
char serialnumber[128]
Null terminated serial number string (ASCII encoded, English if available) of this device.
Definition usb.h:899

_USB_DEVICE::usbstatus
uint32_t usbstatus
USB device status (eg USB_STATUS_BOUND).
Definition usb.h:883

_USB_DEVICE::lock
MUTEX_HANDLE lock
USB device lock.
Definition usb.h:888

_USB_DEVICE::speed
uint32_t speed
Speed at which this device is attached (Set by USB core).
Definition usb.h:890

_USB_DEVICE::portnumber
uint32_t portnumber
1 based index of the USB port on the parent hub this device is plugged into (0 for the Root Hub) (Set...
Definition usb.h:892

_USB_DEVICE::requestcount
uint32_t requestcount
Number of USB requests that have been submitted to this device.
Definition usb.h:905

_USB_DEVICE::usbid
uint32_t usbid
Unique Id of this USB in the USB device table.
Definition usb.h:881

_USB_DEVICE::configurationvalue
uint32_t configurationvalue
The current configuration value of this USB device (Set by USB core).
Definition usb.h:893

_USB_DEVICE::device
DEVICE device
The Device entry for this USB device.
Definition usb.h:879

_USB_DEVICE::lasterror
uint32_t lasterror
Last error to occur on this device.
Definition usb.h:901

_USB_DEVICE::configuration
USB_CONFIGURATION * configuration
Currently selected configuration of this USB device (Set by USB core).
Definition usb.h:895

_USB_DEVICE::host
USB_HOST * host
Host controller this USB device is connected to (Set by USB core).
Definition usb.h:884

_USB_DEVICE::pendingcount
uint32_t pendingcount
Number of USB requests pending for this device (Set by USB core).
Definition usb.h:902

_USB_DEVICE::driverdata
void * driverdata
Private data for the driver of this USB device.
Definition usb.h:900

_USB_DEVICE::driver
USB_DRIVER * driver
Driver this USB device is bound to, if any (Set by USB core).
Definition usb.h:886

_USB_DEVICE::parent
USB_DEVICE * parent
Hub this USB device is connected to, or nil if this is the Root Hub (Set by USB core).
Definition usb.h:885

_USB_DEVICE::descriptor
USB_DEVICE_DESCRIPTOR * descriptor
Device descriptor of this device (Set by USB core).
Definition usb.h:894

_USB_DEVICE::address
uint32_t address
Address of this device (Set by USB core).
Definition usb.h:889

_USB_DEVICE::waiterthread
THREAD_ID waiterthread
Thread waiting for pending requests to complete (for device detachment) (Set by USB core).
Definition usb.h:903

_USB_DEVICE::manufacturer
char manufacturer[128]
Null terminated manufacturer string (ASCII encoded, English if available) of this device.
Definition usb.h:898

_USB_DEVICE::configurations
USB_CONFIGURATION * configurations
All available configurations on this device (Set by USB core).
Definition usb.h:896

_USB_DEVICE::prev
USB_DEVICE * prev
Previous entry in USB device table.
Definition usb.h:908

_USB_DEVICE::usbstate
uint32_t usbstate
USB device state (eg USB_STATE_ATTACHED).
Definition usb.h:882

_USB_DEVICE::product
char product[128]
Null terminated product string (ASCII encoded, English if available) of this device.
Definition usb.h:897

_USB_DEVICE::requesterrors
uint32_t requesterrors
Number of USB requests that have failed on this device.
Definition usb.h:906

_USB_DEVICE::next
USB_DEVICE * next
Next entry in USB device table.
Definition usb.h:909

_USB_DEVICE::depth
uint32_t depth
Depth of this device (Root Hub is 0, next level hub is 1 etc) (Set by USB core).
Definition usb.h:891

_USB_DRIVER
Definition usb.h:960

_USB_DRIVER::lock
MUTEX_HANDLE lock
Driver lock.
Definition usb.h:967

_USB_DRIVER::driver
DRIVER driver
The Driver entry for this USB Driver.
Definition usb.h:962

_USB_DRIVER::driverbind
usb_driver_bind_proc driverbind
A Driver specific DriverBind method implementing the standard USB driver interface.
Definition usb.h:964

_USB_DRIVER::driverunbind
usb_driver_unbind_proc driverunbind
A Driver specific DriverUnbind method implementing the standard USB driver interface.
Definition usb.h:965

_USB_DRIVER::next
USB_DRIVER * next
Next entry in Driver table.
Definition usb.h:970

_USB_DRIVER::prev
USB_DRIVER * prev
Previous entry in Driver table.
Definition usb.h:969

_USB_ENDPOINT_DESCRIPTOR
Definition usb.h:827

_USB_ENDPOINT_DESCRIPTOR::bendpointaddress
uint8_t bendpointaddress
Definition usb.h:830

_USB_ENDPOINT_DESCRIPTOR::bmattributes
uint8_t bmattributes
Definition usb.h:831

_USB_ENDPOINT_DESCRIPTOR::binterval
uint8_t binterval
Definition usb.h:833

_USB_ENDPOINT_DESCRIPTOR::bdescriptortype
uint8_t bdescriptortype
Definition usb.h:829

_USB_ENDPOINT_DESCRIPTOR::wmaxpacketsize
uint16_t wmaxpacketsize
Definition usb.h:832

_USB_ENDPOINT_DESCRIPTOR::blength
uint8_t blength
Definition usb.h:828

_USB_HOST
Definition usb.h:989

_USB_HOST::multiplier
uint32_t multiplier
Host data buffer multiplier (for DMA requests etc).
Definition usb.h:1004

_USB_HOST::lock
MUTEX_HANDLE lock
Host lock.
Definition usb.h:1001

_USB_HOST::hoststate
uint32_t hoststate
Host state (eg USBHOST_STATE_ENABLED).
Definition usb.h:994

_USB_HOST::next
USB_HOST * next
Next entry in Host table.
Definition usb.h:1011

_USB_HOST::requestcount
uint32_t requestcount
Number of USB requests that have been submitted to this host.
Definition usb.h:1007

_USB_HOST::hoststart
usb_host_start_proc hoststart
A Host specific HostStart method implementing the standard USB host interface.
Definition usb.h:995

_USB_HOST::maxtransfer
uint32_t maxtransfer
Host maximum transfer size.
Definition usb.h:1005

_USB_HOST::device
DEVICE device
The Device entry for this USB Host.
Definition usb.h:991

_USB_HOST::hostreset
usb_host_reset_proc hostreset
A Host specific HostReset method implementing the standard USB host interface.
Definition usb.h:997

_USB_HOST::hostid
uint32_t hostid
Unique Id of this Host in the Host table.
Definition usb.h:993

_USB_HOST::prev
USB_HOST * prev
Previous entry in Host table.
Definition usb.h:1010

_USB_HOST::roothub
USB_DEVICE * roothub
The Root hub for this Host (or nil if the Host has not yet been started).
Definition usb.h:1002

_USB_HOST::hostsubmit
usb_host_submit_proc hostsubmit
A Host specific HostSubmit method implementing the standard USB host interface.
Definition usb.h:998

_USB_HOST::hoststop
usb_host_stop_proc hoststop
A Host specific HostStop method implementing the standard USB host interface.
Definition usb.h:996

_USB_HOST::hostcancel
usb_host_cancel_proc hostcancel
A Host specific HostCancel method implementing the standard USB host interface.
Definition usb.h:999

_USB_HOST::requesterrors
uint32_t requesterrors
Number of USB requests that have failed on this host.
Definition usb.h:1008

_USB_HOST::alignment
uint32_t alignment
Host data buffer alignment (for DMA requests etc).
Definition usb.h:1003

_USB_HUB_DATA
Definition usb.h:1104

_USB_HUB_DATA::data
uint8_t data[8]
Definition usb.h:1105

_USB_HUB_DESCRIPTOR
Definition usb.h:1073

_USB_HUB_DESCRIPTOR::bdesclength
uint8_t bdesclength
Definition usb.h:1074

_USB_HUB_DESCRIPTOR::bpwron2pwrgood
uint8_t bpwron2pwrgood
Definition usb.h:1078

_USB_HUB_DESCRIPTOR::vardata
uint8_t vardata[]
Variable length field, 64 should be the maximum possible length (255 ports = 2 x 32 bytes of data).
Definition usb.h:1080

_USB_HUB_DESCRIPTOR::bnbrports
uint8_t bnbrports
Definition usb.h:1076

_USB_HUB_DESCRIPTOR::bdescriptortype
uint8_t bdescriptortype
Definition usb.h:1075

_USB_HUB_DESCRIPTOR::bhubcontrcurrent
uint8_t bhubcontrcurrent
Definition usb.h:1079

_USB_HUB_DESCRIPTOR::whubcharacteristics
uint16_t whubcharacteristics
Definition usb.h:1077

_USB_HUB_STATUS
Definition usb.h:1096

_USB_HUB_STATUS::whubstatus
uint16_t whubstatus
See: USB_HUB_STATUS values above.
Definition usb.h:1097

_USB_HUB_STATUS::whubchange
uint16_t whubchange
See: USB_HUB_CHANGE values above.
Definition usb.h:1098

_USB_HUB
Definition usb.h:1130

_USB_HUB::hubid
uint32_t hubid
Unique Id of this Hub in the Hub table.
Definition usb.h:1134

_USB_HUB::ports
USB_PORT * ports
Ports on this hub (Set by USBHubCreatePorts using the value in Descriptor.bNbrPorts).
Definition usb.h:1139

_USB_HUB::lock
MUTEX_HANDLE lock
Hub lock.
Definition usb.h:1137

_USB_HUB::receiveerrors
uint32_t receiveerrors
Definition usb.h:1142

_USB_HUB::statusrequest
USB_REQUEST * statusrequest
Hub status change request.
Definition usb.h:1145

_USB_HUB::device
DEVICE device
The Device entry for this Hub.
Definition usb.h:1132

_USB_HUB::hubstate
uint32_t hubstate
Hub state (eg USBHUB_STATE_ATTACHED).
Definition usb.h:1135

_USB_HUB::receivecount
uint32_t receivecount
Definition usb.h:1141

_USB_HUB::next
USB_HUB * next
Next entry in Hub table.
Definition usb.h:1151

_USB_HUB::descriptor
USB_HUB_DESCRIPTOR * descriptor
Class specific Descriptor for this hub.
Definition usb.h:1138

_USB_HUB::pendingcount
uint32_t pendingcount
Number of USB requests pending for this hub.
Definition usb.h:1147

_USB_HUB::prev
USB_HUB * prev
Previous entry in Hub table.
Definition usb.h:1150

_USB_HUB::waiterthread
THREAD_ID waiterthread
Thread waiting for pending requests to complete (for hub detachment).
Definition usb.h:1148

_USB_HUB::statusendpoint
USB_ENDPOINT_DESCRIPTOR * statusendpoint
Hub Interrupt IN Endpoint.
Definition usb.h:1146

_USB_HUB::statusdata
USB_HUB_DATA * statusdata
Hub status change data buffer.
Definition usb.h:1144

_USB_INTERFACE_DESCRIPTOR
Definition usb.h:812

_USB_INTERFACE_DESCRIPTOR::iinterface
uint8_t iinterface
Definition usb.h:821

_USB_INTERFACE_DESCRIPTOR::binterfacenumber
uint8_t binterfacenumber
Definition usb.h:815

_USB_INTERFACE_DESCRIPTOR::binterfaceprotocol
uint8_t binterfaceprotocol
Definition usb.h:820

_USB_INTERFACE_DESCRIPTOR::balternatesetting
uint8_t balternatesetting
Definition usb.h:816

_USB_INTERFACE_DESCRIPTOR::binterfacesubclass
uint8_t binterfacesubclass
Definition usb.h:819

_USB_INTERFACE_DESCRIPTOR::bnumendpoints
uint8_t bnumendpoints
Definition usb.h:817

_USB_INTERFACE_DESCRIPTOR::bdescriptortype
uint8_t bdescriptortype
Definition usb.h:814

_USB_INTERFACE_DESCRIPTOR::blength
uint8_t blength
Definition usb.h:813

_USB_INTERFACE_DESCRIPTOR::binterfaceclass
uint8_t binterfaceclass
Definition usb.h:818

_USB_INTERFACE_ID
Definition usb.h:732

_USB_INTERFACE_ID::binterfaceprotocol
uint8_t binterfaceprotocol
Definition usb.h:735

_USB_INTERFACE_ID::binterfacesubclass
uint8_t binterfacesubclass
Definition usb.h:734

_USB_INTERFACE_ID::binterfaceclass
uint8_t binterfaceclass
Definition usb.h:733

_USB_INTERFACE
Definition usb.h:925

_USB_INTERFACE::classdata
uint8_t * classdata
Pointer to the start of any class specific descriptors for this interface (Set by USB core).
Definition usb.h:935

_USB_INTERFACE::classsize
uint32_t classsize
Size of any class specific descriptors for this interface (Set by USB core).
Definition usb.h:936

_USB_INTERFACE::alternatecount
uint32_t alternatecount
The number of alternate settings available for this interface (Set by USB core).
Definition usb.h:929

_USB_INTERFACE::endpoints
USB_ENDPOINT_DESCRIPTOR * endpoints
All available endpoint descriptors on this interface (Set by USB core).
Definition usb.h:932

_USB_INTERFACE::alternates
USB_ALTERNATE * alternates
All available alternate settings for this interface (Set by USB core).
Definition usb.h:933

_USB_INTERFACE::driverdata
void * driverdata
Private data for the driver of this USB interface.
Definition usb.h:937

_USB_INTERFACE::description
char description[128]
Null terminated description string (ASCII encoded, English if available) of this interface.
Definition usb.h:934

_USB_INTERFACE::driver
USB_DRIVER * driver
Driver this USB interface is bound to, if any (Set by USB core).
Definition usb.h:927

_USB_INTERFACE::descriptor
USB_INTERFACE_DESCRIPTOR * descriptor
Interface descriptor of this interface (Set by USB core).
Definition usb.h:931

_USB_INTERFACE::alternatesetting
uint32_t alternatesetting
The currently selected alternate setting for this interface (Set by USB core).
Definition usb.h:930

_USB_PORT_STATUS
Definition usb.h:1088

_USB_PORT_STATUS::wportstatus
uint16_t wportstatus
See: USB_PORT_STATUS values above.
Definition usb.h:1089

_USB_PORT_STATUS::wportchange
uint16_t wportchange
See: USB_PORT_CHANGE values above.
Definition usb.h:1090

_USB_PORT
Definition usb.h:1112

_USB_PORT::status
USB_PORT_STATUS status
Status of this port.
Definition usb.h:1116

_USB_PORT::child
USB_DEVICE * child
Pointer to the USB device attached to this port, or nil if there is none.
Definition usb.h:1115

_USB_PORT::hub
USB_HUB * hub
Pointer to the USB hub this port is attached to.
Definition usb.h:1113

_USB_PORT::number
uint8_t number
Number of this port (1-based).
Definition usb.h:1114

_USB_REQUEST
Definition usb.h:1020

_USB_REQUEST::shortattempt
LONGBOOL shortattempt
The current transaction for this request is a short read or write.
Definition usb.h:1041

_USB_REQUEST::completesplit
LONGBOOL completesplit
On a split transaction indicates if the request is on the start split or complete split phase.
Definition usb.h:1040

_USB_REQUEST::attemptedbytesremaining
uint32_t attemptedbytesremaining
The number of bytes remaining in the current transaction.
Definition usb.h:1048

_USB_REQUEST::actualsize
uint32_t actualsize
Actual size of the data transferred (Should be checked after a successful IN request).
Definition usb.h:1034

_USB_REQUEST::attemptedpacketsremaining
uint32_t attemptedpacketsremaining
The number of packets remaining in the current transaction.
Definition usb.h:1047

_USB_REQUEST::attemptedbytes
uint32_t attemptedbytes
The number of bytes attempted in the current transaction.
Definition usb.h:1046

_USB_REQUEST::issplit
LONGBOOL issplit
Request is a split transaction due to full or low speed device.
Definition usb.h:1039

_USB_REQUEST::totalbytesattempted
uint32_t totalbytesattempted
The total number of bytes attempted for this request.
Definition usb.h:1050

_USB_REQUEST::isping
LONGBOOL isping
Ping request in progress as part of request processing.
Definition usb.h:1038

_USB_REQUEST::data
void * data
Data buffer for the request (IN or OUT).
Definition usb.h:1024

_USB_REQUEST::flags
uint32_t flags
Flags for the request (eg USB_REQUEST_FLAG_ALIGNED).
Definition usb.h:1026

_USB_REQUEST::device
USB_DEVICE * device
USB Device to send this request to.
Definition usb.h:1022

_USB_REQUEST::completesplitretries
uint32_t completesplitretries
The number of complete split retries for this request.
Definition usb.h:1054

_USB_REQUEST::attemptedpackets
uint32_t attemptedpackets
The number of packets attempted in the current transaction.
Definition usb.h:1045

_USB_REQUEST::totalpacketsattempted
uint32_t totalpacketsattempted
The total number of packets attempted for this request.
Definition usb.h:1049

_USB_REQUEST::packetstransferred
uint32_t packetstransferred
The number of packets transferred for this request.
Definition usb.h:1051

_USB_REQUEST::driverdata
void * driverdata
USB device driver private data for the completion callback (Optional).
Definition usb.h:1028

_USB_REQUEST::bytestransferred
uint32_t bytestransferred
The number of bytes transferred for this request.
Definition usb.h:1052

_USB_REQUEST::startofframe
LONGBOOL startofframe
The request needs to wait for the next start of frame to be started.
Definition usb.h:1042

_USB_REQUEST::size
uint32_t size
Size of data buffer (For IN requests, the maximum number of bytes of data to receive) (For OUT reques...
Definition usb.h:1025

_USB_REQUEST::statusdata
uint32_t statusdata
Data for the Status phase of a USB control request (For safety only as no data is normally transferre...
Definition usb.h:1031

_USB_REQUEST::setupdata
USB_CONTROL_SETUP_DATA * setupdata
Data for the Setup phase of a USB control request (Must be provided for control requests,...
Definition usb.h:1030

_USB_REQUEST::currentdata
void * currentdata
Host driver data pointer during transaction processing.
Definition usb.h:1037

_USB_REQUEST::controlphase
uint32_t controlphase
The currently processing phase of a control request.
Definition usb.h:1043

_USB_REQUEST::resubmitsemaphore
SEMAPHORE_HANDLE resubmitsemaphore
The handle of the semaphore used to signal the resubmit thread (or INVALID_HANDLE_VALUE).
Definition usb.h:1056

_USB_REQUEST::transferdata
void * transferdata
Host driver private data for transfer handling.
Definition usb.h:1036

_USB_REQUEST::nextdatapid
uint32_t nextdatapid
The next Data PID for the data toggle during IN or OUT (Data0/Data1 etc).
Definition usb.h:1044

_USB_REQUEST::spliterrorcount
uint32_t spliterrorcount
The number of split transaction errors for this request.
Definition usb.h:1053

_USB_REQUEST::callback
usb_request_completed_cb callback
Callback function that will be called when this USB request has been successfully completed or has fa...
Definition usb.h:1027

_USB_REQUEST::status
uint32_t status
Status of the transfer (USB_STATUS_SUCCESS if successful, or another error code if the transfer faile...
Definition usb.h:1033

_USB_REQUEST::resubmitthread
THREAD_HANDLE resubmitthread
The handle of the thread performing resubmit for this request (or INVALID_HANDLE_VALUE).
Definition usb.h:1055

_USB_REQUEST::endpoint
USB_ENDPOINT_DESCRIPTOR * endpoint
Endpoint descriptor on the device to send this request to.
Definition usb.h:1023

_USB_STRING_DESCRIPTOR
Definition usb.h:839

_USB_STRING_DESCRIPTOR::bstring
uint16_t bstring[]
UTF-16LE encoded string (specification says "UNICODE").
Definition usb.h:842

_USB_STRING_DESCRIPTOR::bdescriptortype
uint8_t bdescriptortype
Definition usb.h:841

_USB_STRING_DESCRIPTOR::blength
uint8_t blength
Definition usb.h:840

system.h

THREAD_ID
HANDLE THREAD_ID
Type for Thread-IDs.
Definition system.h:63

usb_interrupt_transfer
uint32_t STDCALL usb_interrupt_transfer(USB_DEVICE *device, USB_ENDPOINT_DESCRIPTOR *endpoint, void *data, uint32_t size, uint32_t *count, uint32_t timeout)
Perform a synchronous interrupt transfer to a USB device and endpoint.

usb_driver_create
USB_DRIVER *STDCALL usb_driver_create(void)
Driver Methods.

usb_hub_unlock
uint32_t STDCALL usb_hub_unlock(USB_HUB *hub)
Unlock the specified Hub to allow changes.

usb_device_read_string_descriptor_ex
uint32_t STDCALL usb_device_read_string_descriptor_ex(USB_DEVICE *device, uint8_t index, uint16_t languageid, char *value, uint32_t len)
Get the content of the specified string descriptor from the specified device.

usb_device_status_to_notification
uint32_t STDCALL usb_device_status_to_notification(uint32_t status)
Convert a Device status value into the notification code for device notifications.

usb_hub_has_port_indicator
BOOL STDCALL usb_hub_has_port_indicator(USB_HUB *hub)
Returns True if Hub supports Port Indicators or False if not.

usb_log_device_configuration
void STDCALL usb_log_device_configuration(USB_DEVICE *device, usb_log_output_proc output, void *data)

usb_host_find_by_name
USB_HOST *STDCALL usb_host_find_by_name(const char *name)

usb_host_find
USB_HOST *STDCALL usb_host_find(uint32_t hostid)

usb_hub_find
USB_HUB *STDCALL usb_hub_find(uint32_t hubid)

USB_DRIVER
struct _USB_DRIVER USB_DRIVER
Forward declared to satisfy USBDevice.
Definition usb.h:858

USB_PORT_STATUS
struct _USB_PORT_STATUS USB_PORT_STATUS
Definition usb.h:1086

usb_start
uint32_t STDCALL usb_start(void)
Starts all registered USB hosts, starts the USB hub thread and begins the USB enumeration process....

usb_host_create
USB_HOST *STDCALL usb_host_create(void)
Create a new Host entry.

usb_device_attach
uint32_t STDCALL usb_device_attach(USB_DEVICE *device)
Configure and initialize a newly attached USB device.

usb_host_enumerate
uint32_t STDCALL usb_host_enumerate(usb_host_enumerate_cb callback, void *data)

usb_device_enumerate_cb
uint32_t STDCALL(* usb_device_enumerate_cb)(USB_DEVICE *device, void *data)
Definition usb.h:869

usb_driver_check
USB_DRIVER *STDCALL usb_driver_check(USB_DRIVER *driver)
Check if the supplied USB Driver is in the driver table.

USB_CONFIGURATION_DESCRIPTOR
struct _USB_CONFIGURATION_DESCRIPTOR USB_CONFIGURATION_DESCRIPTOR
Definition usb.h:796

usb_log_devices
uint32_t STDCALL usb_log_devices(void)
Print information about all devices attached to the USB.

usb_device_find
USB_DEVICE *STDCALL usb_device_find(uint32_t usbid)

usb_hub_enumerate_devices
void STDCALL usb_hub_enumerate_devices(USB_DEVICE *device, usb_device_enumerate_cb callback, void *data)
Enumerate each device in the USB tree and call an enumerate callback for each one.

usb_request_cancel
uint32_t STDCALL usb_request_cancel(USB_REQUEST *request)
Cancel a USB request previously submitted to a host controller.

usb_is_in_endpoint
BOOL STDCALL usb_is_in_endpoint(USB_ENDPOINT_DESCRIPTOR *endpoint)
Returns True if Endpoint is an IN endpoint or False if not.

usb_hub_is_multi_tt
BOOL STDCALL usb_hub_is_multi_tt(USB_HUB *hub)
Returns True if Hub has multiple Transaction Translators or False if not.

usb_driver_get_count
uint32_t STDCALL usb_driver_get_count(void)
Get the current USB driver count.

usb_device_get_interface
uint32_t STDCALL usb_device_get_interface(USB_DEVICE *device, uint8_t index, uint8_t *alternatesetting)
Get the interface alternate setting for the specified device.

usb_log_devices_ex
uint32_t STDCALL usb_log_devices_ex(USB_DEVICE *device, usb_log_output_proc output, usb_device_enumerate_cb devicecallback, usb_device_enumerate_cb treecallback, void *data)
Print information about one or all devices attached to the USB with custom output and callbacks.

usb_bulk_transfer
uint32_t STDCALL usb_bulk_transfer(USB_DEVICE *device, USB_ENDPOINT_DESCRIPTOR *endpoint, void *data, uint32_t size, uint32_t *count, uint32_t timeout)
Perform a synchronous bulk transfer to a USB device and endpoint.

usb_hub_unbind_devices
void STDCALL usb_hub_unbind_devices(USB_DEVICE *device, USB_DRIVER *driver, usb_device_unbind_proc callback)
Enumerate each device in the USB tree and call an unbind callback for each one.

usb_device_set_status
uint32_t STDCALL usb_device_set_status(USB_DEVICE *device, uint32_t status)
Set the status of the specified device and send a notification.

usb_hub_port_reset
uint32_t STDCALL usb_hub_port_reset(USB_PORT *port, uint32_t delay)
Hub Port Methods.

usb_device_read_configuration
uint32_t STDCALL usb_device_read_configuration(USB_DEVICE *device, uint8_t index)
Read and parse the specified configuration for this device.

usb_log_tree_callback
uint32_t STDCALL usb_log_tree_callback(USB_DEVICE *device, void *data)

usb_hub_create_ports
uint32_t STDCALL usb_hub_create_ports(USB_HUB *hub)
Hub Methods.

usb_host_notification
uint32_t STDCALL usb_host_notification(USB_HOST *host, usb_host_notification_cb callback, void *data, uint32_t notification, uint32_t flags)

usb_request_completed_cb
void STDCALL(* usb_request_completed_cb)(USB_REQUEST *request)
Definition usb.h:1017

usb_control_request_ex
uint32_t STDCALL usb_control_request_ex(USB_DEVICE *device, USB_ENDPOINT_DESCRIPTOR *endpoint, uint8_t brequest, uint8_t bmrequesttype, uint16_t wvalue, uint16_t windex, void *data, uint16_t wlength, uint32_t timeout, BOOL allowshort)
Send a USB control request to the specified device and wait for the request to complete.

usb_device_find_by_id
USB_DEVICE *STDCALL usb_device_find_by_id(uint16_t vendorid, uint16_t productid)

usb_device_get_port
USB_PORT *STDCALL usb_device_get_port(USB_DEVICE *device)
Get the USB Port that the specified device is connected to.

usb_device_find_by_description
USB_DEVICE *STDCALL usb_device_find_by_description(const char *description)

usb_hub_has_port_current_protection
BOOL STDCALL usb_hub_has_port_current_protection(USB_HUB *hub)
Returns True if Hub supports per port Over Current Power Protection or False if not.

USB_DEVICE_ID
struct _USB_DEVICE_ID USB_DEVICE_ID
USB Device Id record for driver device identification (Not part of USB specification).
Definition usb.h:723

usb_driver_bind_proc
uint32_t STDCALL(* usb_driver_bind_proc)(USB_DEVICE *device, USB_INTERFACE *interrface)
Definition usb.h:956

usb_control_request
uint32_t STDCALL usb_control_request(USB_DEVICE *device, USB_ENDPOINT_DESCRIPTOR *endpoint, uint8_t brequest, uint8_t bmrequesttype, uint16_t wvalue, uint16_t windex, void *data, uint16_t wlength)
Control Methods.

usb_device_read_string_descriptor_ex_w
uint32_t STDCALL usb_device_read_string_descriptor_ex_w(USB_DEVICE *device, uint8_t index, uint16_t languageid, WCHAR *value, uint32_t len)
Get the content of the specified string descriptor from the specified device.

USB_PORT
struct _USB_PORT USB_PORT
Definition usb.h:1110

usb_buffer_release
uint32_t STDCALL usb_buffer_release(void *buffer)
Release a data buffer from a USB request.

usb_hub_bind_devices
void STDCALL usb_hub_bind_devices(USB_DEVICE *device, usb_device_bind_proc callback)
Enumerate each device in the USB tree and call a bind callback for each one.

usb_driver_find_by_name
USB_DRIVER *STDCALL usb_driver_find_by_name(const char *name)
Find a driver by name in the Driver table.

usb_device_find_alternate_endpoint_by_type
USB_ENDPOINT_DESCRIPTOR *STDCALL usb_device_find_alternate_endpoint_by_type(USB_DEVICE *device, USB_INTERFACE *interrface, USB_ALTERNATE *alternate, uint8_t direction, uint8_t transfertype)
Find an endpoint of the specified type and direction on the specified alternate setting interface of ...

usb_device_bind
uint32_t STDCALL usb_device_bind(USB_DEVICE *device)
Attempt to bind a device to one of the registered drivers.

usb_device_read_device_descriptor
uint32_t STDCALL usb_device_read_device_descriptor(USB_DEVICE *device, uint16_t length)
Read all or part of the device descriptor from the specified device using USBControlRequest.

usb_device_find_endpoint_by_type_ex
USB_ENDPOINT_DESCRIPTOR *STDCALL usb_device_find_endpoint_by_type_ex(USB_DEVICE *device, USB_INTERFACE *interrface, uint8_t direction, uint8_t transfertype, uint8_t *index)
Find the next endpoint of the specified type and direction on the specified interface of the specifie...

usb_device_release
uint32_t STDCALL usb_device_release(USB_DEVICE *device)
Deregister and Destroy a Device from the Device table.

usb_hub_port_power_off
uint32_t STDCALL usb_hub_port_power_off(USB_PORT *port)
Power off the specified USB port.

usb_hub_set_state
uint32_t STDCALL usb_hub_set_state(USB_HUB *hub, uint32_t state)
Set the state of the specified hub and send a notification.

usb_hub_is_compound
BOOL STDCALL usb_hub_is_compound(USB_HUB *hub)
Returns True if Hub is part of a Compound Device or False if not.

usb_device_clear_feature
uint32_t STDCALL usb_device_clear_feature(USB_DEVICE *device, USB_ENDPOINT_DESCRIPTOR *endpoint, uint16_t feature)
Disable a feature on the specified endpoint on the specified device.

usb_hub_enumerate
uint32_t STDCALL usb_hub_enumerate(usb_hub_enumerate_cb callback, void *data)

usb_device_read_string_language_ids
void STDCALL usb_device_read_string_language_ids(USB_DEVICE *device, USB_STRING_DESCRIPTOR_LANGIDS *languageids)
Get the list of supported string language identifiers from the specified device.

usb_device_get_device_descriptor
uint32_t STDCALL usb_device_get_device_descriptor(USB_DEVICE *device, void *data, uint16_t length)
Read all or part of the device descriptor from the specified device using USBControlRequest.

usb_is_root_hub
BOOL STDCALL usb_is_root_hub(USB_DEVICE *device)
Returns True if Device is a Root Hub or False if not.

USB_INTERFACE_ID
struct _USB_INTERFACE_ID USB_INTERFACE_ID
USB Interface Id record for driver device identification (Not part of USB specification).
Definition usb.h:730

usb_device_read_string_descriptor_w
uint32_t STDCALL usb_device_read_string_descriptor_w(USB_DEVICE *device, uint8_t index, WCHAR *value, uint32_t len)
Get the content of the specified string descriptor from the specified device.

usb_host_start_proc
uint32_t STDCALL(* usb_host_start_proc)(USB_HOST *host)
Definition usb.h:982

usb_device_notification
uint32_t STDCALL usb_device_notification(USB_DEVICE *device, usb_device_notification_cb callback, void *data, uint32_t notification, uint32_t flags)

usb_log_interface_descriptor
void STDCALL usb_log_interface_descriptor(USB_DEVICE *device, USB_INTERFACE_DESCRIPTOR *descriptor, usb_log_output_proc output, void *data)

usb_hub_create_hub_descriptor
uint32_t STDCALL usb_hub_create_hub_descriptor(USB_HUB *hub)
Allocate the hub descriptor for the specified hub.

usb_host_state_to_notification
uint32_t STDCALL usb_host_state_to_notification(uint32_t state)
Convert a Host state value into the notification code for device notifications.

usb_host_create_ex
USB_HOST *STDCALL usb_host_create_ex(uint32_t size)
Create a new Host entry.

usb_host_register
uint32_t STDCALL usb_host_register(USB_HOST *host)
Register a new Host in the Host table.

usb_is_isochronous_endpoint
BOOL STDCALL usb_is_isochronous_endpoint(USB_ENDPOINT_DESCRIPTOR *endpoint)
Returns True if Endpoint is a ISOCHRONOUS endpoint or False if not.

usb_device_count_endpoints_by_type
uint8_t STDCALL usb_device_count_endpoints_by_type(USB_DEVICE *device, USB_INTERFACE *interrface, uint8_t direction, uint8_t transfertype)
Count the number of endpoints of the specified type and direction on the specified interface of the s...

USB_ENDPOINT_DESCRIPTOR
struct _USB_ENDPOINT_DESCRIPTOR USB_ENDPOINT_DESCRIPTOR
Definition usb.h:825

USB_DEVICE
struct _USB_DEVICE USB_DEVICE
Definition usb.h:862

USB_INTERFACE
struct _USB_INTERFACE USB_INTERFACE
Forward declared to satisfy USBDevice.
Definition usb.h:860

usb_hub_port_change_feature
uint32_t STDCALL usb_hub_port_change_feature(USB_PORT *port, uint16_t feature, BOOL enable)
Enable or disable a feature on the specified USB port.

usb_host_notification_cb
uint32_t STDCALL(* usb_host_notification_cb)(DEVICE *device, void *data, uint32_t notification)
Definition usb.h:979

usb_hub_enumerate_cb
uint32_t STDCALL(* usb_hub_enumerate_cb)(USB_HUB *hub, void *data)
Definition usb.h:1122

usb_buffer_allocate_ex
void *STDCALL usb_buffer_allocate_ex(USB_DEVICE *device, uint32_t size, uint32_t *flags)
Allocate a data buffer for a USB request.

usb_device_set_configuration
uint32_t STDCALL usb_device_set_configuration(USB_DEVICE *device, uint8_t configurationvalue)
Set the configuration for the specified device.

usb_hub_lock
uint32_t STDCALL usb_hub_lock(USB_HUB *hub)
Lock the specified Hub to prevent changes.

usb_driver_destroy
uint32_t STDCALL usb_driver_destroy(USB_DRIVER *driver)
Destroy an existing USB Driver entry.

usb_hub_port_attach_device
uint32_t STDCALL usb_hub_port_attach_device(USB_PORT *port)
Attach a newly connected USB device to the specified USB port.

USB_HUB_DESCRIPTOR
struct _USB_HUB_DESCRIPTOR USB_HUB_DESCRIPTOR
Definition usb.h:1071

usb_host_find_by_description
USB_HOST *STDCALL usb_host_find_by_description(const char *description)

usb_device_set_interface
uint32_t STDCALL usb_device_set_interface(USB_DEVICE *device, uint8_t index, uint8_t alternatesetting)
Set the interface alternate setting for the specified device.

USB_HUB_STATUS
struct _USB_HUB_STATUS USB_HUB_STATUS
Definition usb.h:1094

usb_device_unbind_proc
uint32_t STDCALL(* usb_device_unbind_proc)(USB_DEVICE *device, USB_DRIVER *driver)
Definition usb.h:867

usb_hub_power_on_ports
uint32_t STDCALL usb_hub_power_on_ports(USB_HUB *hub)
Power on all ports on a Hub.

usb_device_get_count
uint32_t STDCALL usb_device_get_count(void)
Get the current device count.

USB_DEVICE_STATUS
struct _USB_DEVICE_STATUS USB_DEVICE_STATUS
Definition usb.h:850

usb_device_get_configuration
uint32_t STDCALL usb_device_get_configuration(USB_DEVICE *device, uint8_t *configurationvalue)
Get the current configuration for the specified device.

usb_host_state_to_string
uint32_t STDCALL usb_host_state_to_string(uint32_t hoststate, char *string, uint32_t len)

usb_host_cancel_proc
uint32_t STDCALL(* usb_host_cancel_proc)(USB_HOST *host, USB_REQUEST *request)
Definition usb.h:986

usb_driver_enumerate
uint32_t STDCALL usb_driver_enumerate(usb_driver_enumerate_cb callback, void *data)
Enumerate all drivers in the USB Driver table.

usb_host_check
USB_HOST *STDCALL usb_host_check(USB_HOST *host)
Check if the supplied Host is in the host table.

usb_async_start
void STDCALL usb_async_start(USB_HOST *host)

usb_hub_has_port_power_switching
BOOL STDCALL usb_hub_has_port_power_switching(USB_HUB *hub)
Returns True if Hub supports per port Power Switching or False if not.

USB_DEVICE_DESCRIPTOR
struct _USB_DEVICE_DESCRIPTOR USB_DEVICE_DESCRIPTOR
Definition usb.h:776

usb_hub_port_clear_feature
uint32_t STDCALL usb_hub_port_clear_feature(USB_PORT *port, uint16_t feature)
Disable a feature on the specified USB port.

usb_device_status_to_string
uint32_t STDCALL usb_device_status_to_string(uint32_t usbstatus, char *string, uint32_t len)

usb_device_find_interface_by_class_only
USB_INTERFACE *STDCALL usb_device_find_interface_by_class_only(USB_DEVICE *device, uint8_t interfaceclass)
Find an interface of the specified class on the specified device.

usb_device_set_address
uint32_t STDCALL usb_device_set_address(USB_DEVICE *device, uint8_t address)
Set the bus address for the specified device.

usb_device_bind_proc
uint32_t STDCALL(* usb_device_bind_proc)(USB_DEVICE *device)
Definition usb.h:865

usb_device_state_to_notification
uint32_t STDCALL usb_device_state_to_notification(uint32_t state)
Convert a Device state value into the notification code for device notifications.

usb_hub_find_by_name
USB_HUB *STDCALL usb_hub_find_by_name(const char *name)

usb_device_find_alternate_by_setting
USB_ALTERNATE *STDCALL usb_device_find_alternate_by_setting(USB_DEVICE *device, USB_INTERFACE *interrface, uint8_t alternatesetting)
Find the alternate setting with the specified value on the specified interface of the specified devic...

USB_CONFIGURATION
struct _USB_CONFIGURATION USB_CONFIGURATION
Forward declared to satisfy USBDevice.
Definition usb.h:861

usb_log_endpoint_descriptor
void STDCALL usb_log_endpoint_descriptor(USB_DEVICE *device, USB_ENDPOINT_DESCRIPTOR *descriptor, usb_log_output_proc output, void *data)

usb_hub_state_to_string
uint32_t STDCALL usb_hub_state_to_string(uint32_t hubstate, char *string, uint32_t len)
Return a string describing the supplied Hub state value.

USB_DEVICE_AND_INTERFACE_NO
struct _USB_DEVICE_AND_INTERFACE_NO USB_DEVICE_AND_INTERFACE_NO
USB Device and Interface No record for driver device identification (Not part of USB specification).
Definition usb.h:748

usb_is_interrupt_request
BOOL STDCALL usb_is_interrupt_request(USB_REQUEST *request)
Returns True if Request is an interrupt request or False if not.

USB_STRING_DESCRIPTOR_STRING
uint16_t USB_STRING_DESCRIPTOR_STRING[126]
Array type to allow typecasting of bString element in TUSBStringDescriptor (Maximum size of descripto...
Definition usb.h:845

usb_device_check
USB_DEVICE *STDCALL usb_device_check(USB_DEVICE *device)
Check if the supplied Device is in the device table.

usb_device_get_string_descriptor
uint32_t STDCALL usb_device_get_string_descriptor(USB_DEVICE *device, uint8_t index, void *data, uint16_t length)
Read all or part of the specified string descriptor from the specified device using USBControlRequest...

usb_is_bulk_request
BOOL STDCALL usb_is_bulk_request(USB_REQUEST *request)
Returns True if Request is a bulk request or False if not.

usb_device_create_configuration
uint32_t STDCALL usb_device_create_configuration(USB_DEVICE *device, uint8_t index, uint16_t size)
Allocate the specified configuration for this device.

usb_host_destroy
uint32_t STDCALL usb_host_destroy(USB_HOST *host)
Destroy an existing Host entry.

usb_device_type_to_string
uint32_t STDCALL usb_device_type_to_string(uint32_t usbtype, char *string, uint32_t len)

usb_device_get_string_descriptor_ex
uint32_t STDCALL usb_device_get_string_descriptor_ex(USB_DEVICE *device, uint8_t index, uint16_t languageid, void *data, uint16_t length)
Read all or part of the specified string descriptor from the specified device using USBControlRequest...

usb_host_stop_proc
uint32_t STDCALL(* usb_host_stop_proc)(USB_HOST *host)
Definition usb.h:983

usb_device_read_device_descriptor_ex
uint32_t STDCALL usb_device_read_device_descriptor_ex(USB_DEVICE *device, uint16_t length, BOOL allowshort)
Read all or part of the device descriptor from the specified device using USBControlRequest.

usb_status_to_string
uint32_t STDCALL usb_status_to_string(uint32_t status, char *string, uint32_t len)
Translates a USB status code into a string.

usb_request_allocate_ex
USB_REQUEST *STDCALL usb_request_allocate_ex(USB_DEVICE *device, USB_ENDPOINT_DESCRIPTOR *endpoint, usb_request_completed_cb callback, void *data, uint32_t size, void *driverdata)
Allocate a new USB request.

usb_log_configuration_descriptor
void STDCALL usb_log_configuration_descriptor(USB_DEVICE *device, USB_CONFIGURATION_DESCRIPTOR *descriptor, usb_log_output_proc output, void *data)

usb_stop
uint32_t STDCALL usb_stop(void)

usb_driver_register
uint32_t STDCALL usb_driver_register(USB_DRIVER *driver)
Register a new Driver in the USB Driver table.

usb_hub_port_get_status
uint32_t STDCALL usb_hub_port_get_status(USB_PORT *port)
Read the status of the specified USB port.

usb_hub_find_by_description
USB_HUB *STDCALL usb_hub_find_by_description(const char *description)

usb_hub_port_set_feature
uint32_t STDCALL usb_hub_port_set_feature(USB_PORT *port, uint16_t feature)
Enable a feature on the specified USB port.

usb_hub_read_hub_descriptor
uint32_t STDCALL usb_hub_read_hub_descriptor(USB_HUB *hub)
Read the hub descriptor for the specified hub.

usb_driver_create_ex
USB_DRIVER *STDCALL usb_driver_create_ex(uint32_t size)
Create a new USB Driver entry.

usb_device_unbind
uint32_t STDCALL usb_device_unbind(USB_DEVICE *device, USB_DRIVER *driver)
Unbind a device from a driver.

USB_DEVICE_AND_INTERFACE_ID
struct _USB_DEVICE_AND_INTERFACE_ID USB_DEVICE_AND_INTERFACE_ID
USB Device and Interface Id record for driver device identification (Not part of USB specification).
Definition usb.h:738

usb_buffer_allocate
void *STDCALL usb_buffer_allocate(USB_DEVICE *device, uint32_t size)
Buffer Methods.

USB_HUB_DESCRIPTOR_DATA
uint8_t USB_HUB_DESCRIPTOR_DATA[64]
Array type to allow typecasting of varData element in TUSBHubDescriptor.
Definition usb.h:1083

USB_HUB_DATA
struct _USB_HUB_DATA USB_HUB_DATA
Definition usb.h:1102

usb_host_type_to_string
uint32_t STDCALL usb_host_type_to_string(uint32_t hosttype, char *string, uint32_t len)

usb_hub_port_power_on
uint32_t STDCALL usb_hub_port_power_on(USB_PORT *port)
Power on the specified USB port.

usb_hub_port_status_changed
uint32_t STDCALL usb_hub_port_status_changed(USB_PORT *port)
Process a status change for the specified USB port.

USB_REQUEST
struct _USB_REQUEST USB_REQUEST
Forward declared to satisfy USBHost.
Definition usb.h:974

usb_device_find_interface_by_index
USB_INTERFACE *STDCALL usb_device_find_interface_by_index(USB_DEVICE *device, uint8_t index)
Find the interface with the specified index on the specified device.

usb_device_enumerate
uint32_t STDCALL usb_device_enumerate(usb_device_enumerate_cb callback, void *data)

usb_request_initialize
uint32_t STDCALL usb_request_initialize(USB_REQUEST *request, usb_request_completed_cb callback, void *data, uint32_t size, void *driverdata)
Initialize or Reinitialize an existing USB request.

usb_request_release
uint32_t STDCALL usb_request_release(USB_REQUEST *request)
Release and destroy a USB request.

usb_device_allocate
USB_DEVICE *STDCALL usb_device_allocate(USB_HOST *host, USB_DEVICE *parent)
Create and Register a new Device entry in the Device table.

usb_hub_get_count
uint32_t STDCALL usb_hub_get_count(void)
Get the current hub count.

usb_host_enumerate_cb
uint32_t STDCALL(* usb_host_enumerate_cb)(USB_HOST *host, void *data)
Definition usb.h:977

usb_device_find_by_name
USB_DEVICE *STDCALL usb_device_find_by_name(const char *name)

usb_request_submit
uint32_t STDCALL usb_request_submit(USB_REQUEST *request)
Submit a USB request to a host controller for execution.

usb_device_get_descriptor
uint32_t STDCALL usb_device_get_descriptor(USB_DEVICE *device, uint8_t brequest, uint8_t bmrequesttype, uint16_t wvalue, uint16_t windex, void *data, uint16_t length)
Read any descriptor from the specified device using USBControlRequest.

usb_device_detach
uint32_t STDCALL usb_device_detach(USB_DEVICE *device)
Shutdown and detach a USB device.

usb_host_get_count
uint32_t STDCALL usb_host_get_count(void)
Get the current host count.

usb_device_read_string_descriptor
uint32_t STDCALL usb_device_read_string_descriptor(USB_DEVICE *device, uint8_t index, char *value, uint32_t len)
Get the content of the specified string descriptor from the specified device.

usb_driver_find
USB_DRIVER *STDCALL usb_driver_find(uint32_t driverid)
Find a driver by Id in the USB Driver table.

USB_STRING_DESCRIPTOR
struct _USB_STRING_DESCRIPTOR USB_STRING_DESCRIPTOR
Definition usb.h:837

usb_hub_allocate
USB_HUB *STDCALL usb_hub_allocate(USB_DEVICE *device)
Create and Register a new Hub device.

usb_device_create_configurations
uint32_t STDCALL usb_device_create_configurations(USB_DEVICE *device)
Allocate the available configurations for this device.

usb_hub_notification
uint32_t STDCALL usb_hub_notification(USB_HUB *hub, usb_hub_notification_cb callback, void *data, uint32_t notification, uint32_t flags)

usb_hub_port_disable
uint32_t STDCALL usb_hub_port_disable(USB_PORT *port)
Disable the specified USB port.

usb_device_find_alternate_by_index
USB_ALTERNATE *STDCALL usb_device_find_alternate_by_index(USB_DEVICE *device, USB_INTERFACE *interrface, uint8_t index)
Find the alternate setting with the specified index on the specified interface of the specified devic...

usb_control_transfer
uint32_t STDCALL usb_control_transfer(USB_DEVICE *device, USB_ENDPOINT_DESCRIPTOR *endpoint, uint8_t brequest, uint8_t bmrequesttype, uint16_t wvalue, uint16_t windex, void *data, uint16_t wlength, uint32_t *count, uint32_t timeout)
Synchronous Transfer Methods.

usb_host_set_state
uint32_t STDCALL usb_host_set_state(USB_HOST *host, uint32_t state)
Host Methods.

usb_device_get_hub
USB_HUB *STDCALL usb_device_get_hub(USB_DEVICE *device)
Get the USB Hub that the specified device is connected to.

usb_hub_release
uint32_t STDCALL usb_hub_release(USB_HUB *hub)
Deregister and Destroy a Hub device.

usb_device_state_to_string
uint32_t STDCALL usb_device_state_to_string(uint32_t usbstate, char *string, uint32_t len)

usb_hub_state_to_notification
uint32_t STDCALL usb_hub_state_to_notification(uint32_t state)
Convert a Hub state value into the notification code for device notifications.

USB_INTERFACE_DESCRIPTOR
struct _USB_INTERFACE_DESCRIPTOR USB_INTERFACE_DESCRIPTOR
Definition usb.h:810

usb_is_interrupt_endpoint
BOOL STDCALL usb_is_interrupt_endpoint(USB_ENDPOINT_DESCRIPTOR *endpoint)
Returns True if Endpoint is a INTERRUPT endpoint or False if not.

usb_device_find_configuration_by_value
USB_CONFIGURATION *STDCALL usb_device_find_configuration_by_value(USB_DEVICE *device, uint8_t configurationvalue)
Find the configuration represented by configuration value for the specified device.

usb_is_control_request
BOOL STDCALL usb_is_control_request(USB_REQUEST *request)
Returns True if Request is a control request or False if not.

usb_hub_get_tt_think_time
uint8_t STDCALL usb_hub_get_tt_think_time(USB_HUB *hub)
Get the TT Think Time from a Hub.

usb_device_find_alternate_endpoint_by_index
USB_ENDPOINT_DESCRIPTOR *STDCALL usb_device_find_alternate_endpoint_by_index(USB_DEVICE *device, USB_INTERFACE *interrface, USB_ALTERNATE *alternate, uint8_t index)
Find the endpoint with the specified index on the specified alternate setting interface of the specif...

usb_is_out_endpoint
BOOL STDCALL usb_is_out_endpoint(USB_ENDPOINT_DESCRIPTOR *endpoint)
Returns True if Endpoint is an OUT endpoint or False if not.

usb_device_get_configuration_descriptor
uint32_t STDCALL usb_device_get_configuration_descriptor(USB_DEVICE *device, uint8_t index, void *data, uint16_t length)
Read all or part of the specified configuration descriptor from the specified device using USBControl...

usb_log_device_callback
uint32_t STDCALL usb_log_device_callback(USB_DEVICE *device, void *data)

usb_log_device_descriptor
void STDCALL usb_log_device_descriptor(USB_DEVICE *device, USB_DEVICE_DESCRIPTOR *descriptor, usb_log_output_proc output, void *data)

usb_log_output_proc
void STDCALL(* usb_log_output_proc)(const char *text, void *data)
Definition usb.h:1155

usb_device_find_endpoint_by_type
USB_ENDPOINT_DESCRIPTOR *STDCALL usb_device_find_endpoint_by_type(USB_DEVICE *device, USB_INTERFACE *interrface, uint8_t direction, uint8_t transfertype)
Find an endpoint of the specified type and direction on the specified interface of the specified devi...

usb_host_deregister
uint32_t STDCALL usb_host_deregister(USB_HOST *host)
Deregister a Host from the Host table.

USB_ALTERNATE
struct _USB_ALTERNATE USB_ALTERNATE
Forward declared to satisfy USBDevice.
Definition usb.h:859

usb_device_set_feature
uint32_t STDCALL usb_device_set_feature(USB_DEVICE *device, USB_ENDPOINT_DESCRIPTOR *endpoint, uint16_t feature, uint16_t index)
Enable a feature on the specified endpoint on the specified device.

usb_is_bulk_endpoint
BOOL STDCALL usb_is_bulk_endpoint(USB_ENDPOINT_DESCRIPTOR *endpoint)
Returns True if Endpoint is a BULK endpoint or False if not.

usb_device_notification_cb
uint32_t STDCALL(* usb_device_notification_cb)(DEVICE *device, void *data, uint32_t notification)
Definition usb.h:871

usb_driver_deregister
uint32_t STDCALL usb_driver_deregister(USB_DRIVER *driver)
Deregister a Driver from the USB Driver table.

usb_driver_unbind_proc
uint32_t STDCALL(* usb_driver_unbind_proc)(USB_DEVICE *device, USB_INTERFACE *interrface)
Definition usb.h:957

usb_hub_notification_cb
uint32_t STDCALL(* usb_hub_notification_cb)(DEVICE *device, void *data, uint32_t notification)
Definition usb.h:1124

usb_hub_port_detach_device
uint32_t STDCALL usb_hub_port_detach_device(USB_PORT *port)
Detach a disconnected USB device from the specified USB port.

USB_HUB
struct _USB_HUB USB_HUB
Forward declared to satisfy USBPort.
Definition usb.h:1109

USB_STRING_DESCRIPTOR_LANGIDS
uint16_t USB_STRING_DESCRIPTOR_LANGIDS[126]
Array type to allow typecasting of bString element in TUSBStringDescriptor (Maximum size of descripto...
Definition usb.h:847

usb_is_isochronous_request
BOOL STDCALL usb_is_isochronous_request(USB_REQUEST *request)
Returns True if Request is an isochronous request or False if not.

usb_device_set_state
uint32_t STDCALL usb_device_set_state(USB_DEVICE *device, uint32_t state)
Set the state of the specified device and send a notification.

usb_hub_check
USB_HUB *STDCALL usb_hub_check(USB_HUB *hub)
Check if the supplied Hub is in the hub table.

usb_hub_type_to_string
uint32_t STDCALL usb_hub_type_to_string(uint32_t hubtype, char *string, uint32_t len)
Return a string describing the supplied Hub type value.

USB_HOST
struct _USB_HOST USB_HOST
Forward declared to satisfy USBDevice.
Definition usb.h:857

usb_host_reset_proc
uint32_t STDCALL(* usb_host_reset_proc)(USB_HOST *host)
Definition usb.h:984

usb_device_create_device_descriptor
uint32_t STDCALL usb_device_create_device_descriptor(USB_DEVICE *device, uint16_t length)
Allocate a device descriptor for the specified device.

USB_DESCRIPTOR_HEADER
struct _USB_DESCRIPTOR_HEADER USB_DESCRIPTOR_HEADER
Definition usb.h:768

usb_driver_enumerate_cb
uint32_t STDCALL(* usb_driver_enumerate_cb)(USB_DRIVER *driver, void *data)
Definition usb.h:953

usb_buffer_validate
uint32_t STDCALL usb_buffer_validate(USB_DEVICE *device, void *buffer, uint32_t size, uint32_t *flags)
Validate a data buffer for a USB request against the USB host requirements.

usb_device_find_interface_by_class
USB_INTERFACE *STDCALL usb_device_find_interface_by_class(USB_DEVICE *device, uint8_t interfaceclass, uint8_t interfacesubclass, uint8_t interfaceprotocol)
Find an interface of the specified class on the specified device.

usb_device_get_address
uint8_t STDCALL usb_device_get_address(USB_DEVICE *device)
Device Methods.

usb_request_allocate
USB_REQUEST *STDCALL usb_request_allocate(USB_DEVICE *device, USB_ENDPOINT_DESCRIPTOR *endpoint, usb_request_completed_cb callback, uint32_t size, void *driverdata)
Request Methods.

usb_device_read_configurations
uint32_t STDCALL usb_device_read_configurations(USB_DEVICE *device)
Read and parse the available configurations for this device.

usb_device_find_endpoint_by_index
USB_ENDPOINT_DESCRIPTOR *STDCALL usb_device_find_endpoint_by_index(USB_DEVICE *device, USB_INTERFACE *interrface, uint8_t index)
Find the endpoint with the specified index on the specified interface of the specified device.

usb_host_submit_proc
uint32_t STDCALL(* usb_host_submit_proc)(USB_HOST *host, USB_REQUEST *request)
Definition usb.h:985

USB_CONTROL_SETUP_DATA
struct _USB_CONTROL_SETUP_DATA USB_CONTROL_SETUP_DATA
Definition usb.h:757

usb_is_hub
BOOL STDCALL usb_is_hub(USB_DEVICE *device)
Returns True if Device is a Hub or False if not.