device/usb/usb.h header reference
[Devices support library module]
The source code of this header can be browsed online.
Description [link]
USB spec related definitions
Members [link]
Types [link]
- enum dev_usbdev_state_e
- struct usb_class_descriptor_header_s
- struct usb_configuration_descriptor_s
- enum usb_configuration_parameter_e
- enum usb_control_status_e
- struct usb_ctrl_setup_s
- struct usb_descriptor_header_s
- enum usb_descriptor_type_e
- enum usb_device_application_subclass_e
- enum usb_device_class_code_e
- struct usb_device_descriptor_s
- enum usb_device_misc_multi_protocol_e
- enum usb_device_misc_subclass_e
- struct usb_endpoint_descriptor_s
- enum usb_endpoint_dir_e
- enum usb_endpoint_type_e
- enum usb_feature_selector_e
- struct usb_interface_association_descriptor_s
- struct usb_interface_descriptor_s
- enum usb_standard_request_e
- struct usb_string_descriptor_s
- struct usb_string_descriptor_zero_s
- enum usb_tranfert_recipient_e
- enum usb_tranfert_type_e
- enum usb_transfert_direction_e
Functions [link]
- uint8_t usb_ep_dir_get(const struct usb_endpoint_descriptor_s *ep)
- uint8_t usb_ep_interval_get(const struct usb_endpoint_descriptor_s *ep)
- bool_t usb_ep_is_in(const struct usb_endpoint_descriptor_s *desc)
- bool_t usb_ep_is_out(const struct usb_endpoint_descriptor_s *desc)
- uint16_t usb_ep_mps_get(const struct usb_endpoint_descriptor_s *ep)
- uint8_t usb_ep_num_get(const struct usb_endpoint_descriptor_s *ep)
- uint16_t usb_ep_size_get(const struct usb_endpoint_descriptor_s *ep)
- enum usb_endpoint_type_e usb_ep_type_get(const struct usb_endpoint_descriptor_s *ep)
- uint8_t usb_interface_alt_get(const struct usb_interface_descriptor_s *intf)
- uint8_t usb_interface_ep_count_get(const struct usb_interface_descriptor_s *intf)
- uint8_t usb_interface_number_get(const struct usb_interface_descriptor_s *intf)
- enum usb_transfert_direction_e usb_setup_direction_get(const struct usb_ctrl_setup_s *s)
- uint16_t usb_setup_index_get(const struct usb_ctrl_setup_s *s)
- uint16_t usb_setup_length_get(const struct usb_ctrl_setup_s *s)
- enum usb_tranfert_recipient_e usb_setup_recipient_get(const struct usb_ctrl_setup_s *s)
- uint8_t usb_setup_reqtype_get(const struct usb_ctrl_setup_s *s)
- uint8_t usb_setup_request_get(const struct usb_ctrl_setup_s *s)
- enum usb_tranfert_type_e usb_setup_type_get(const struct usb_ctrl_setup_s *s)
- uint16_t usb_setup_value_get(const struct usb_ctrl_setup_s *s)
Constant [link]
- const char dev_usbdev_state_e[]
Members detail [link]
#define USBDEV_CONFIGURATIONS(...) [link]
This macro is declared in device/usb/usb.h source file, line 450.
#define USBDEV_DESC_CONFIGURATION(length, ifcount, id, icfg, attr, power) [link]
This macro is declared in device/usb/usb.h source file, line 410.
#define USBDEV_DESC_DEVICE(version, class, subclass, prot, packetsize, vendor, product, release, imanufacturer, iproduct, iserial, cfgcount) [link]
This macro is declared in device/usb/usb.h source file, line 422.
#define USBDEV_LANGID(code) [link]
This macro is declared in device/usb/usb.h source file, line 454.
#define USBDEV_LANGID_TABLE(...) [link]
This macro is declared in device/usb/usb.h source file, line 458.
#define USBDEV_STRINGS(...) [link]
This macro is declared in device/usb/usb.h source file, line 446.
#define __USB_H__ [link]
This macro is declared in device/usb/usb.h source file, line 29.
const char dev_usbdev_state_e[] [link]
This constant is declared in ENUM_DESCRIPTOR function like macro expansion, line 1 in device/usb/usb.h source file, line 134.
Alternate declarations with same identifier: [1], [2].
enum dev_usbdev_state_e [link]
This enum is declared in device/usb/usb.h source file, line 137.
Alternate declarations with same identifier: [1], [2].
Identifier | Description |
---|---|
DEV_USBDEV_DETACHED | Detached |
DEV_USBDEV_ATTACHED | Attached |
DEV_USBDEV_POWERED | Attached and powered |
DEV_USBDEV_POWERED_TO_DEFAULT | Reset is on-going |
DEV_USBDEV_WAIT_SERIVCE_READY | |
DEV_USBDEV_DEFAULT | Respond to default address |
DEV_USBDEV_ADDRESS | Unique address assigned |
DEV_USBDEV_ADDRESS_TO_DEFAULT | |
DEV_USBDEV_ADDRESS_TO_DETACHED | |
DEV_USBDEV_ADDRESS_TO_POWERED | |
DEV_USBDEV_CONFIGURED | Configuration done |
DEV_USBDEV_CONFIGURED_TO_DETACHED | |
DEV_USBDEV_CONFIGURED_TO_POWERED | |
DEV_USBDEV_CONFIGURED_TO_DEFAULT | |
DEV_USBDEV_SUSPENDED | No bus traffic for at least 3 ms |
struct usb_class_descriptor_header_s [link]
This struct is declared in device/usb/usb.h source file, line 170.
Field | Description |
---|---|
struct usb_descriptor_header_s head; | |
uint8_t bDescriptorSubtype; |
struct usb_configuration_descriptor_s [link]
This struct is declared in device/usb/usb.h source file, line 257.
Field | Description |
---|---|
struct usb_descriptor_header_s head; | |
uint16_t wTotalLength; | |
uint8_t bNumInterfaces; | |
uint8_t bConfigurationValue; | |
uint8_t iConfiguration; | |
uint8_t bmAttributes; | |
uint8_t bMaxPower; |
enum usb_configuration_parameter_e [link]
This enum is declared in device/usb/usb.h source file, line 36.
Identifier | Description |
---|---|
USB_SELF_POWERED | |
USB_REMOTE_WAKEUP |
enum usb_control_status_e [link]
This enum is declared in device/usb/usb.h source file, line 57.
Identifier | Description |
---|---|
USB_CTRL_STATUS_ACK | |
USB_CTRL_STATUS_STALL | |
USB_CTRL_STATUS_NACK |
struct usb_ctrl_setup_s [link]
This struct is declared in device/class/usbdev.h source file, line 44.
struct usb_descriptor_header_s [link]
This struct is declared in device/usb/usb.h source file, line 164.
Field | Description |
---|---|
uint8_t bLength; | |
uint8_t bDescriptorType; |
enum usb_descriptor_type_e [link]
This enum is declared in device/usb/usb.h source file, line 70.
Identifier | Description |
---|---|
USB_DESC_DEVICE | |
USB_DESC_CONFIGURATION | |
USB_DESC_STRING | |
USB_DESC_INTERFACE | |
USB_DESC_ENDPOINT | |
USB_DESC_DEVICE_QUALIFIER | |
USB_DESC_OTHER_SPEED_CONFIG | |
USB_DESC_INTERFACE_POWER | |
USB_DESC_OTG | |
USB_DESC_DEBUG | |
USB_DESC_INTERFACE_ASSOCIATION |
enum usb_device_application_subclass_e [link]
This enum is declared in device/usb/usb.h source file, line 122.
Identifier | Description |
---|---|
USB_DEV_APP_SUBCLASS_DFU | |
USB_DEV_APP_SUBCLASS_IRDA | |
USB_DEV_APP_SUBCLASS_TEST |
enum usb_device_class_code_e [link]
This enum is declared in device/usb/usb.h source file, line 85.
Identifier | Description |
---|---|
USB_DEV_CLASS_SEE_INTERFACE | |
USB_DEV_CLASS_AUDIO | |
USB_DEV_CLASS_COMM | |
USB_DEV_CLASS_HID | |
USB_DEV_CLASS_PHYSICAL | |
USB_DEV_CLASS_IMAGE | |
USB_DEV_CLASS_PRINTER | |
USB_DEV_CLASS_MASS_STORAGE | |
USB_DEV_CLASS_HUB | |
USB_DEV_CLASS_COMM_DATA | |
USB_DEV_CLASS_SMART_CARD | |
USB_DEV_CLASS_CONTENT_SECURITY | |
USB_DEV_CLASS_VIDEO | |
USB_DEV_CLASS_PERSONAL_HEALTHCARE | |
USB_DEV_CLASS_AUDIO_VIDEO | |
USB_DEV_CLASS_BILLBOARD | |
USB_DEV_CLASS_TYPEC_BRIDGE | |
USB_DEV_CLASS_DIAGNOSTIC | |
USB_DEV_CLASS_WIRELESS | |
USB_DEV_CLASS_MISCELLANEOUS | |
USB_DEV_CLASS_APPLICATION_SPECIFIC | |
USB_DEV_CLASS_VENDOR_SPECIFIC |
struct usb_device_descriptor_s [link]
This struct is declared in device/usb/usb.h source file, line 287.
enum usb_device_misc_multi_protocol_e [link]
This enum is declared in device/usb/usb.h source file, line 129.
Identifier | Description |
---|---|
USB_DEV_MISC_MULTI_PROTO_IAD | |
USB_DEV_MISC_MULTI_PROTO_WAMP |
enum usb_device_misc_subclass_e [link]
This enum is declared in device/usb/usb.h source file, line 111.
Identifier | Description |
---|---|
USB_DEV_MISC_SUBCLASS_SYNC | |
USB_DEV_MISC_SUBCLASS_MULTI | |
USB_DEV_MISC_SUBCLASS_CABLE | |
USB_DEV_MISC_SUBCLASS_RNDIS | |
USB_DEV_MISC_SUBCLASS_USB3 | |
USB_DEV_MISC_SUBCLASS_STEP | |
USB_DEV_MISC_SUBCLASS_CICAM |
struct usb_endpoint_descriptor_s [link]
This struct is declared in device/usb/usb.h source file, line 182.
Field | Description |
---|---|
struct usb_descriptor_header_s head; | |
uint8_t bEndpointAddress; | |
uint8_t bmAttributes; | |
uint16_t wMaxPacketSize; | |
uint8_t bInterval; |
enum usb_endpoint_dir_e [link]
This enum is declared in device/usb/usb.h source file, line 64.
Identifier | Description |
---|---|
USB_EP_OUT | |
USB_EP_IN |
enum usb_endpoint_type_e [link]
This enum is declared in device/usb/usb.h source file, line 49.
Identifier | Description |
---|---|
USB_EP_CONTROL | |
USB_EP_ISOCHRONOUS | |
USB_EP_BULK | |
USB_EP_INTERRUPT |
uint8_t usb_ep_dir_get(const struct usb_endpoint_descriptor_s *ep) [link]
This function is declared in device/usb/usb.h source file, line 192.
uint8_t usb_ep_interval_get(const struct usb_endpoint_descriptor_s *ep) [link]
This function is declared in device/usb/usb.h source file, line 222.
bool_t usb_ep_is_in(const struct usb_endpoint_descriptor_s *desc) [link]
This function is declared in device/usb/usb.h source file, line 330.
bool_t usb_ep_is_out(const struct usb_endpoint_descriptor_s *desc) [link]
This function is declared in device/usb/usb.h source file, line 337.
uint16_t usb_ep_mps_get(const struct usb_endpoint_descriptor_s *ep) [link]
This function is declared in device/usb/usb.h source file, line 210.
uint8_t usb_ep_num_get(const struct usb_endpoint_descriptor_s *ep) [link]
This function is declared in device/usb/usb.h source file, line 198.
uint16_t usb_ep_size_get(const struct usb_endpoint_descriptor_s *ep) [link]
This function is declared in device/usb/usb.h source file, line 204.
enum usb_endpoint_type_e usb_ep_type_get(const struct usb_endpoint_descriptor_s *ep) [link]
This function is declared in device/usb/usb.h source file, line 216.
enum usb_feature_selector_e [link]
This enum is declared in device/usb/usb.h source file, line 42.
Identifier | Description |
---|---|
USB_ENDPOINT_HALT | |
USB_DEVICE_REMOTE_WAKEUP | |
USB_TEST_MODE |
uint8_t usb_interface_alt_get(const struct usb_interface_descriptor_s *intf) [link]
This function is declared in device/usb/usb.h source file, line 246.
struct usb_interface_association_descriptor_s [link]
This struct is declared in device/usb/usb.h source file, line 269.
Field | Description |
---|---|
struct usb_descriptor_header_s head; | |
uint8_t bFirstInterface; | |
uint8_t bInterfaceCount; | |
uint8_t bFunctionClass; | |
uint8_t bFunctionSubClass; | |
uint8_t bFunctionProtocol; | |
uint8_t iFunction; |
struct usb_interface_descriptor_s [link]
This struct is declared in device/usb/usb.h source file, line 227.
Field | Description |
---|---|
struct usb_descriptor_header_s head; | |
uint8_t bInterfaceNumber; | |
uint8_t bAlternateSetting; | |
uint8_t bNumEndpoints; | |
uint8_t bInterfaceClass; | |
uint8_t bInterfaceSubClass; | |
uint8_t bInterfaceProtocol; | |
uint8_t iInterface; |
uint8_t usb_interface_ep_count_get(const struct usb_interface_descriptor_s *intf) [link]
This function is declared in device/usb/usb.h source file, line 240.
uint8_t usb_interface_number_get(const struct usb_interface_descriptor_s *intf) [link]
This function is declared in device/usb/usb.h source file, line 252.
enum usb_transfert_direction_e usb_setup_direction_get(const struct usb_ctrl_setup_s *s) [link]
This function is declared in device/usb/usb.h source file, line 383.
uint16_t usb_setup_index_get(const struct usb_ctrl_setup_s *s) [link]
This function is declared in device/usb/usb.h source file, line 401.
uint16_t usb_setup_length_get(const struct usb_ctrl_setup_s *s) [link]
This function is declared in device/usb/usb.h source file, line 407.
enum usb_tranfert_recipient_e usb_setup_recipient_get(const struct usb_ctrl_setup_s *s) [link]
This function is declared in device/usb/usb.h source file, line 377.
uint8_t usb_setup_reqtype_get(const struct usb_ctrl_setup_s *s) [link]
This function is declared in device/usb/usb.h source file, line 365.
uint8_t usb_setup_request_get(const struct usb_ctrl_setup_s *s) [link]
This function is declared in device/usb/usb.h source file, line 389.
enum usb_tranfert_type_e usb_setup_type_get(const struct usb_ctrl_setup_s *s) [link]
This function is declared in device/usb/usb.h source file, line 371.
uint16_t usb_setup_value_get(const struct usb_ctrl_setup_s *s) [link]
This function is declared in device/usb/usb.h source file, line 395.
enum usb_standard_request_e [link]
This enum is declared in device/usb/usb.h source file, line 314.
Identifier | Description |
---|---|
USB_GET_STATUS | |
USB_CLEAR_FEATURE | |
USB_SET_FEATURE | |
USB_SET_ADDRESS | |
USB_GET_DESCRIPTOR | |
USB_SET_DESCRIPTOR | |
USB_GET_CONFIGURATION | |
USB_SET_CONFIGURATION | |
USB_GET_INTERFACE | |
USB_SET_INTERFACE | |
USB_SYNCH_FRAME |
struct usb_string_descriptor_s [link]
This struct is declared in device/usb/usb.h source file, line 176.
Field | Description |
---|---|
struct usb_descriptor_header_s head; | |
uint16_t wData[0]; |
struct usb_string_descriptor_zero_s [link]
This struct is declared in device/usb/usb.h source file, line 281.
String descriptor for LANGID
Field | Description |
---|---|
struct usb_descriptor_header_s head; | |
uint16_t wlangid[0]; |
enum usb_tranfert_recipient_e [link]
This enum is declared in device/usb/usb.h source file, line 356.
Identifier | Description |
---|---|
USB_DEVICE | |
USB_INTERFACE | |
USB_ENDPOINT | |
USB_OTHER |
enum usb_tranfert_type_e [link]
This enum is declared in device/usb/usb.h source file, line 349.
Identifier | Description |
---|---|
USB_STANDARD | |
USB_CLASS | |
USB_VENDOR |
enum usb_transfert_direction_e [link]
This enum is declared in device/usb/usb.h source file, line 343.
Identifier | Description |
---|---|
USB_HOST_TO_DEVICE | |
USB_DEVICE_TO_HOST |