USB

include/drivers/usb_generic/usb.h

struct `usb_setup_packet`

Member Type	Member Name
`uint8_t`	`bitmap_request_type`
`enum usb_rq_code`	`request`
`uint16_t`	`value`
`union { uint16_t index; uint16_t offset; }`	`None`
`uint16_t`	`length`

struct `usb_device_descriptor`

Member Type	Member Name
`uint8_t`	`length`
`uint8_t`	`type`
`uint16_t`	`usb_num_bcd`
`uint8_t`	`class`
`uint8_t`	`subclass`
`uint8_t`	`protocol`
`uint8_t`	`max_packet_size`
`uint16_t`	`vendor_id`
`uint16_t`	`product_id`
`uint16_t`	`device_num_bcd`
`uint8_t`	`manufacturer`
`uint8_t`	`product`
`uint8_t`	`serial_num`
`uint8_t`	`num_configs`

struct `usb_interface_descriptor`

Member Type	Member Name
`uint8_t`	`length`
`uint8_t`	`type`
`uint8_t`	`interface_number`
`uint8_t`	`alternate_setting`
`uint8_t`	`num_endpoints`
`uint8_t`	`class`
`uint8_t`	`subclass`
`uint8_t`	`protocol`
`uint8_t`	`interface`

struct `usb_config_descriptor`

Member Type	Member Name
`uint8_t`	`length`
`uint8_t`	`descriptor_type`
`uint16_t`	`total_length`
`uint8_t`	`num_interfaces`
`uint8_t`	`configuration_value`
`uint8_t`	`configuration`
`uint8_t`	`bitmap_attributes`
`uint8_t`	`max_power`

struct `usb_endpoint_descriptor`

Member Type	Member Name
`uint8_t`	`length`
`uint8_t`	`type`
`uint8_t`	`address`
`uint8_t`	`attributes`
`uint16_t`	`max_packet_size`
`uint8_t`	`interval`

struct `usb_endpoint`

Member Type	Member Name
`struct usb_endpoint_descriptor`	`*desc`
`uint8_t`	`type`
`uint8_t`	`number`
`bool`	`in`
`uint8_t`	`*transfer_buffer`
`uint16_t`	`transfer_len`
`uint16_t`	`max_packet_size`
`uint8_t`	`address`
`uint8_t`	`attributes`
`uint8_t`	`interval`
`void`	`*hc_data`

struct `usb_controller_ops`

Member Type	Member Name
`enum usb_status`	`(submit_control_transfer)(struct usb_request )`
`enum usb_status`	`(submit_bulk_transfer)(struct usb_request )`
`enum usb_status`	`(submit_interrupt_transfer)(struct usb_request )`
`void`	`(reset_slot)(struct usb_device dev)`
`enum usb_status`	`(configure_endpoint)(struct usb_device dev)`
`void`	`(poll_ports)(struct usb_controller )`

struct `usb_controller`

Member Type	Member Name
`enum usb_controller_type`	`type`
`struct usb_controller_ops`	`ops`
`void`	`*driver_data`

struct `usb_driver`

Member Type	Member Name
`char`	`*name`
`uint8_t`	`class_code`
`uint8_t`	`subclass`
`uint8_t`	`protocol`
`enum usb_status`	`(bringup)(struct usb_device dev)`
`void`	`(teardown)(struct usb_device dev)`
`void`	`(free)(struct usb_device dev)`

struct `usb_device`

Member Type	Member Name
`struct list_head`	`hc_list`
`enum usb_dev_status`	`status`
`char`	`manufacturer[128]`
`char`	`product[128]`
`char`	`config_str[128]`
`uint8_t`	`address`
`uint8_t`	`speed`
`uint8_t`	`port`
`void`	`*slot`
`uint8_t`	`max_packet_size`
`struct usb_device_descriptor`	`*descriptor`
`struct usb_config_descriptor`	`config`
`struct usb_endpoint`	`**endpoints`
`uint8_t`	`num_endpoints`
`struct usb_controller`	`*host`
`struct usb_interface_descriptor`	`**interfaces`
`uint8_t`	`num_interfaces`
`struct usb_driver`	`*driver`
`void`	`*driver_private`
`bool`	`configured`
`refcount_t`	`refcount`
`atomic_bool`	`alive`
`void`	`(teardown)(struct usb_device dev)`
`void`	`(free)(struct usb_device dev)`

struct `usb_request`

Member Type	Member Name
`struct usb_device`	`*dev`
`struct usb_endpoint`	`*ep`
`enum usb_transfer_type`	`type`
`struct usb_setup_packet`	`*setup`
`void`	`*buffer`
`size_t`	`length`
`enum usb_status`	`status`
`uint32_t`	`flags`
`uint64_t`	`timeout_ns`
`void`	`(complete)(struct usb_request )`
`void`	`*context`
`bool`	`direction_in`
`void`	`*hc_priv`

enum `usb_rq_code`

Name	Value
`USB_RQ_CODE_GET_STATUS`	`0`
`USB_RQ_CODE_CLEAR_FEATURE`	`1`
`USB_RQ_CODE_SET_FEATURE`	`3`
`USB_RQ_CODE_SET_ADDR`	`5`
`USB_RQ_CODE_GET_DESCRIPTOR`	`6`
`USB_RQ_CODE_SET_DESCRIPTOR`	`7`
`USB_RQ_CODE_GET_CONFIG`	`8`
`USB_RQ_CODE_SET_CONFIG`	`9`
`USB_RQ_CODE_GET_INTERFACE`	`10`
`USB_RQ_CODE_SET_INTERFACE`	`11`
`USB_RQ_CODE_SYNCH_FRAME`	`12`

enum `usb_controller_type`

Name	Value
`USB_CONTROLLER_UHCI`	`None`
`USB_CONTROLLER_EHCI`	`None`
`USB_CONTROLLER_XHCI`	`None`

enum `usb_transfer_type`

Name	Value
`USB_TRANSFER_CONTROL`	`None`
`USB_TRANSFER_BULK`	`None`
`USB_TRANSFER_INTERRUPT`	`None`

enum `usb_status`

Name	Value
`USB_OK`	`0`
`USB_ERR_STALL`	`None`
`USB_ERR_TIMEOUT`	`None`
`USB_ERR_DISCONNECT`	`None`
`USB_ERR_OVERFLOW`	`None`
`USB_ERR_CRC`	`None`
`USB_ERR_IO`	`None`
`USB_ERR_PROTO`	`None`
`USB_ERR_NO_DEVICE`	`None`
`USB_ERR_CANCELLED`	`None`
`USB_ERR_OOM`	`None`
`USB_ERR_INVALID_ARGUMENT`	`None`
`USB_ERR_NO_ENDPOINT`	`None`

enum `usb_dev_status`

Name	Value
`USB_DEV_UNDEF`	`None`
`USB_DEV_DISCONNECTED`	`None`
`USB_DEV_CONNECTED`	`None`
`USB_DEV_ENABLED`	`None`
`USB_DEV_RESETTING`	`None`
`USB_DEV_ERROR`	`None`

void usb_free_device(struct usb_device *dev)
static inline void usb_device_put(struct usb_device *dev)
void usb_teardown_device(struct usb_device *dev)
enum usb_statususb_get_string_descriptor(struct usb_device *dev,uint8_t string_idx,char *out,size_t max_len)
enum usb_statususb_get_device_descriptor(struct usb_device *dev)
enum usb_statususb_parse_config_descriptor(struct usb_device *dev)
enum usb_statususb_set_configuration(struct usb_device *dev)
enum usb_statususb_init_device(struct usb_device *dev)
void usb_try_bind_driver(struct usb_device *dev)
uint8_t usb_construct_rq_bitmap(uint8_t transfer,uint8_t type,uint8_t recip)
enum usb_statususb_transfer_sync(enum usb_status (*fn)(struct usb_request *),struct usb_request *request)
void usb_print_device(struct usb_device *dev)
struct usb_interface_descriptor *usb_find_interface(struct usb_device *dev,uint8_t class,uint8_t subclass,uint8_t protocol)
static inline uint8_t get_ep_index(struct usb_endpoint *ep)
static inline const char * usb_rq_code_str(enum usb_rq_code code)
static inline const char * usb_transfer_type_str(enum usb_transfer_type type)

Defines

USB_DESC_TYPE_DEVICE: 1
USB_DESC_TYPE_CONFIG: 2
USB_DESC_TYPE_STRING: 3
USB_DESC_TYPE_INTERFACE: 4
USB_DESC_TYPE_ENDPOINT: 5
USB_DESC_TYPE_DEV_QUALIFIER: 6
USB_DESC_TYPE_OTHER_SPEED_CONFIG: 7
USB_DESC_TYPE_INTERFACE_POWER: 8
USB_DESC_TYPE_SHIFT: 8
USB_REQUEST_TRANS_HTD: 0
USB_REQUEST_TRANS_DTH: 1
USB_REQUEST_TYPE_STANDARD: 0
USB_REQUEST_TYPE_CLASS: 1
USB_REQUEST_TYPE_VENDOR: 2
USB_REQUEST_RECIPIENT_DEVICE: 0
USB_REQUEST_RECIPIENT_INTERFACE: 1
USB_REQUEST_RECIPIENT_ENDPOINT: 2
USB_REQUEST_RECIPIENT_OTHER: 3
USB_REQUEST_TRANSFER_SHIFT: 7
USB_REQUEST_TRANSFER_MASK: 1
USB_REQUEST_TYPE_SHIFT: 5
USB_REQUEST_TYPE_MASK: 3
USB_REQUEST_RECIPIENT_MASK: 0x1F
USB_CONFIG_SELF_POWERED: (1 << 7)
USB_CONFIG_REMOTE_WAKEUP: (1 << 6)
USB_ENDPOINT_ADDR_EP_DIRECTION_OUT: 0
USB_ENDPOINT_ADDR_EP_DIRECTION_IN: 1
USB_ENDPOINT_ATTR_TRANS_TYPE_CONTROL: 0
USB_ENDPOINT_ATTR_TRANS_TYPE_ISOCHRONOUS: 1
USB_ENDPOINT_ATTR_TRANS_TYPE_BULK: 2
USB_ENDPOINT_ATTR_TRANS_TYPE_INTERRUPT: 3
USB_ENDPOINT_ATTR_SYNC_TYPE_NO_SYNC: 0
USB_ENDPOINT_ATTR_SYNC_TYPE_ASYNC: 1
USB_ENDPOINT_ATTR_SYNC_TYPE_ADAPTIVE: 2
USB_ENDPOINT_ATTR_SYNC_TYPE_SYNC: 3
USB_ENDPOINT_ATTR_USAGE_TYPE_DATA: 0
USB_ENDPOINT_ATTR_USAGE_TYPE_FEEDBACK: 1
USB_ENDPOINT_ATTR_USAGE_TYPE_IMPLICIT_FEEDBACK_DATA: 2
USB_CLASS_AUDIO: 0x1
USB_CLASS_COMMS: 0x2
USB_CLASS_HID: 0x3
USB_SUBCLASS_HID_NONE: 0x0
USB_SUBCLASS_HID_BOOT_INTERFACE: 0x1
USB_PROTOCOL_HID_NONE: 0x0
USB_PROTOCOL_HID_KEYBOARD: 0x1
USB_PROTOCOL_HID_MOUSE: 0x2
USB_CLASS_PHYSICAL: 0x5
USB_CLASS_IMAGE: 0x6
USB_CLASS_PRINTER: 0x7
USB_CLASS_MASS_STORAGE: 0x8
USB_CLASS_HUB: 0x9
USB_CLASS_DATA: 0xA
USB_CLASS_SMART_CARD: 0xB
USB_CLASS_CONTENT_SECURITY: 0xD
USB_CLASS_VIDEO: 0xE
USB_CLASS_PERSONAL_HEALTHCARE: 0xF
USB_CLASS_AUDIO_VIDEO: 0x10
USB_CLASS_BILLBOARD: 0x11
USB_CLASS_USB_TYPE_C: 0x12
USB_CLASS_BULK_DISPLAY: 0x13
USB_CLASS_MCTP_OVER_USB: 0x14
USB_CLASS_I3C_DEVICE: 0x3C
USB_CLASS_DIAGNOSTIC_DEVICE: 0xDC
USB_CLASS_WIRELESS: 0xE0
USB_CLASS_MISC: 0xEF
USB_CLASS_APPLICATION_SPECIFIC: 0xFE
USB_CLASS_VENDOR_SPECIFIC: 0xFF

USB

include/drivers/usb_generic/usb.h

struct usb_setup_packet

struct usb_device_descriptor

struct usb_interface_descriptor

struct usb_config_descriptor

struct usb_endpoint_descriptor

struct usb_endpoint

struct usb_controller_ops

struct usb_controller

struct usb_driver

struct usb_device

struct usb_request

enum usb_rq_code

enum usb_controller_type

enum usb_transfer_type

enum usb_status

enum usb_dev_status

Defines

struct `usb_setup_packet`

struct `usb_device_descriptor`

struct `usb_interface_descriptor`

struct `usb_config_descriptor`

struct `usb_endpoint_descriptor`

struct `usb_endpoint`

struct `usb_controller_ops`

struct `usb_controller`

struct `usb_driver`

struct `usb_device`

struct `usb_request`

enum `usb_rq_code`

enum `usb_controller_type`

enum `usb_transfer_type`

enum `usb_status`

enum `usb_dev_status`