Universal Serial Bus (USB). More...

#include <byteswap.h>
#include <ipxe/list.h>
#include <ipxe/device.h>
#include <ipxe/process.h>
#include <ipxe/iobuf.h>
#include <ipxe/tables.h>

Data Structures
struct	usb_setup_packet
	A USB setup data packet. More...
struct	usb_class
	A USB class code tuple. More...
struct	usb_descriptor_header
	A USB descriptor header. More...
struct	usb_device_descriptor
	A USB device descriptor. More...
struct	usb_configuration_descriptor
	A USB configuration descriptor. More...
struct	usb_string_descriptor
	A USB string descriptor. More...
struct	usb_interface_descriptor
	A USB interface descriptor. More...
struct	usb_endpoint_descriptor
	A USB endpoint descriptor. More...
struct	usb_endpoint_companion_descriptor
	A USB endpoint companion descriptor. More...
struct	usb_interface_association_descriptor
	A USB interface association descriptor. More...
struct	usb_endpoint
	A USB endpoint. More...
struct	usb_endpoint_host_operations
	USB endpoint host controller operations. More...
struct	usb_endpoint_driver_operations
	USB endpoint driver operations. More...
union	usb_class_descriptor
	A USB class descriptor. More...
struct	usb_function_descriptor
	A USB function descriptor. More...
struct	usb_function
	A USB function. More...
struct	usb_device
	A USB device. More...
struct	usb_device_host_operations
	USB device host controller operations. More...
struct	usb_port
	A USB port. More...
struct	usb_hub
	A USB hub. More...
struct	usb_hub_host_operations
	USB hub host controller operations. More...
struct	usb_hub_driver_operations
	USB hub driver operations. More...
struct	usb_bus
	A USB bus. More...
struct	usb_bus_host_operations
	USB bus host controller operations. More...
struct	usb_host_operations
	USB host controller operations. More...
struct	usb_device_id
	A USB device ID. More...
struct	usb_class_id
	A USB class ID. More...
struct	usb_driver
	A USB driver. More...

Macros
#define	USB_SPEED(mantissa, exponent)
	Define a USB speed.
#define	USB_SPEED_MANTISSA(speed)
	Extract USB speed mantissa.
#define	USB_SPEED_EXPONENT(speed)
	Extract USB speed exponent.
#define	USB_BUSDEV(bus, dev)
	Define a USB bus:device address.
#define	USB_BUS(busdev)
	Extract USB bus address.
#define	USB_DEV(busdev)
	Extract USB device address.
#define	USB_DIR_OUT ( 0 << 7 )
	Data transfer is from host to device.
#define	USB_DIR_IN ( 1 << 7 )
	Data transfer is from device to host.
#define	USB_TYPE_STANDARD ( 0 << 5 )
	Standard request type.
#define	USB_TYPE_CLASS ( 1 << 5 )
	Class-specific request type.
#define	USB_TYPE_VENDOR ( 2 << 5 )
	Vendor-specific request type.
#define	USB_RECIP_MASK ( 0x1f << 0 )
	Request recipient mask.
#define	USB_RECIP_DEVICE ( 0 << 0 )
	Request recipient is the device.
#define	USB_RECIP_INTERFACE ( 1 << 0 )
	Request recipient is an interface.
#define	USB_RECIP_ENDPOINT ( 2 << 0 )
	Request recipient is an endpoint.
#define	USB_REQUEST_TYPE(type)
	Construct USB request type.
#define	USB_GET_STATUS ( USB_DIR_IN \| USB_REQUEST_TYPE ( 0 ) )
	Get status.
#define	USB_CLEAR_FEATURE ( USB_DIR_OUT \| USB_REQUEST_TYPE ( 1 ) )
	Clear feature.
#define	USB_SET_FEATURE ( USB_DIR_OUT \| USB_REQUEST_TYPE ( 3 ) )
	Set feature.
#define	USB_SET_ADDRESS ( USB_DIR_OUT \| USB_REQUEST_TYPE ( 5 ) )
	Set address.
#define	USB_GET_DESCRIPTOR ( USB_DIR_IN \| USB_REQUEST_TYPE ( 6 ) )
	Get descriptor.
#define	USB_SET_DESCRIPTOR ( USB_DIR_OUT \| USB_REQUEST_TYPE ( 7 ) )
	Set descriptor.
#define	USB_GET_CONFIGURATION ( USB_DIR_IN \| USB_REQUEST_TYPE ( 8 ) )
	Get configuration.
#define	USB_SET_CONFIGURATION ( USB_DIR_OUT \| USB_REQUEST_TYPE ( 9 ) )
	Set configuration.
#define	USB_GET_INTERFACE ( USB_DIR_IN \| USB_RECIP_INTERFACE \| USB_REQUEST_TYPE ( 10 ) )
	Get interface.
#define	USB_SET_INTERFACE ( USB_DIR_OUT \| USB_RECIP_INTERFACE \| USB_REQUEST_TYPE ( 11 ) )
	Set interface.
#define	USB_ENDPOINT_HALT 0
	Endpoint halt feature.
#define	USB_CLASS_HUB 9
	Class code for USB hubs.
#define	USB_DEVICE_DESCRIPTOR 1
	A USB device descriptor.
#define	USB_CONFIGURATION_DESCRIPTOR 2
	A USB configuration descriptor.
#define	USB_STRING_DESCRIPTOR 3
	A USB string descriptor.
#define	USB_LANG_ENGLISH 0x0409
	Language ID for English.
#define	USB_INTERFACE_DESCRIPTOR 4
	A USB interface descriptor.
#define	USB_ENDPOINT_DESCRIPTOR 5
	A USB endpoint descriptor.
#define	USB_ENDPOINT_ATTR_TYPE_MASK 0x03
	Endpoint attribute transfer type mask.
#define	USB_ENDPOINT_ATTR_PERIODIC 0x01
	Endpoint periodic type.
#define	USB_ENDPOINT_ATTR_CONTROL 0x00
	Control endpoint transfer type.
#define	USB_ENDPOINT_ATTR_BULK 0x02
	Bulk endpoint transfer type.
#define	USB_ENDPOINT_ATTR_INTERRUPT 0x03
	Interrupt endpoint transfer type.
#define	USB_BULK_OUT ( USB_ENDPOINT_ATTR_BULK \| USB_DIR_OUT )
	Bulk OUT endpoint (internal) type.
#define	USB_BULK_IN ( USB_ENDPOINT_ATTR_BULK \| USB_DIR_IN )
	Bulk IN endpoint (internal) type.
#define	USB_INTERRUPT_IN ( USB_ENDPOINT_ATTR_INTERRUPT \| USB_DIR_IN )
	Interrupt IN endpoint (internal) type.
#define	USB_INTERRUPT_OUT ( USB_ENDPOINT_ATTR_INTERRUPT \| USB_DIR_OUT )
	Interrupt OUT endpoint (internal) type.
#define	USB_ENDPOINT_MTU(sizes)
	USB endpoint MTU.
#define	USB_ENDPOINT_BURST(sizes)
	USB endpoint maximum burst size.
#define	USB_ENDPOINT_COMPANION_DESCRIPTOR 48
	A USB endpoint companion descriptor.
#define	USB_INTERFACE_ASSOCIATION_DESCRIPTOR 11
	A USB interface association descriptor.
#define	USB_CS_INTERFACE_DESCRIPTOR 36
	A class-specific interface descriptor.
#define	USB_CS_ENDPOINT_DESCRIPTOR 37
	A class-specific endpoint descriptor.
#define	for_each_config_descriptor(desc, config, typeval)
	Iterate over all configuration descriptors.
#define	for_each_interface_descriptor(desc, config, interface, typeval)
	Iterate over all configuration descriptors within an interface descriptor.
#define	USB_EP0_ADDRESS 0x00
	Control endpoint address.
#define	USB_EP0_ATTRIBUTES 0x00
	Control endpoint attributes.
#define	USB_EP0_DEFAULT_MTU(speed)
	Calculate default MTU based on device speed.
#define	USB_EP0_BURST 0
	Control endpoint maximum burst size.
#define	USB_EP0_INTERVAL 0
	Control endpoint interval.
#define	USB_ENDPOINT_MAX 0x0f
	Maximum endpoint number.
#define	USB_ENDPOINT_IN 0x80
	Endpoint direction is in.
#define	USB_ENDPOINT_IDX(address)
	Construct endpoint index from endpoint address.
#define	for_each_usb_bus(bus)
	Iterate over all USB buses.
#define	USB_RESET_DELAY_MS 50
	Minimum reset time.
#define	USB_RESET_RECOVER_DELAY_MS 10
	Reset recovery time.
#define	USB_CONTROL_MAX_WAIT_MS 5000
	Maximum time to wait for a control transaction to complete.
#define	USB_SET_ADDRESS_RECOVER_DELAY_MS 2
	Set address recovery time.
#define	USB_PORT_DELAY_MS 200
	Time to wait for ports to stabilise.
#define	USB_ID(_vendor, _product, _name, _description, _data)
#define	USB_ROM(_vendor, _product, _name, _description, _data)
#define	USB_ANY_ID 0xffff
	Match-anything ID.
#define	USB_CLASS_ID(base, subclass, protocol)
	Construct USB class ID.
#define	USB_DRIVERS __table ( struct usb_driver, "usb_drivers" )
	USB driver table.
#define	__usb_driver __table_entry ( USB_DRIVERS, 01 )
	Declare a USB driver.
#define	__usb_fallback_driver __table_entry ( USB_DRIVERS, 02 )
	Declare a USB fallback driver.

Enumerations
enum	usb_protocol { USB_PROTO_2_0 = 0x0200 , USB_PROTO_3_0 = 0x0300 , USB_PROTO_3_1 = 0x0301 }
	USB protocols. More...
enum	usb_speed { USB_SPEED_NONE = 0 , USB_SPEED_LOW = USB_SPEED ( 1500, 1 ) , USB_SPEED_FULL = USB_SPEED ( 12, 2 ) , USB_SPEED_HIGH = USB_SPEED ( 480, 2 ) , USB_SPEED_SUPER = USB_SPEED ( 5, 3 ) }
	USB device speeds. More...
enum	usb_pid { USB_PID_IN = 0x69 , USB_PID_OUT = 0xe1 , USB_PID_SETUP = 0x2d }
	USB packet IDs. More...
enum	usb_driver_score { USB_SCORE_FALLBACK = 0 , USB_SCORE_DEPRECATED = 1 , USB_SCORE_NORMAL = 2 }
	USB driver scores. More...

Functions
	FILE_LICENCE (GPL2_OR_LATER_OR_UBDL)
	FILE_SECBOOT (PERMITTED)
static struct usb_descriptor_header *	usb_next_descriptor (struct usb_descriptor_header *desc)
	Get next USB descriptor.
static int	usb_is_within_config (struct usb_configuration_descriptor config, struct usb_descriptor_header desc)
	Check that descriptor lies within a configuration descriptor.
static void	usb_endpoint_init (struct usb_endpoint ep, struct usb_device usb, struct usb_endpoint_driver_operations *driver)
	Initialise USB endpoint.
static void	usb_endpoint_describe (struct usb_endpoint *ep, unsigned int address, unsigned int attributes, size_t mtu, unsigned int burst, unsigned int interval)
	Describe USB endpoint.
static void	usb_endpoint_set_hostdata (struct usb_endpoint ep, void priv)
	Set USB endpoint host controller private data.
static void *	usb_endpoint_get_hostdata (struct usb_endpoint *ep)
	Get USB endpoint host controller private data.
const char *	usb_endpoint_name (struct usb_endpoint *ep)
	Get USB endpoint name (for debugging).
int	usb_endpoint_described (struct usb_endpoint ep, struct usb_configuration_descriptor config, struct usb_interface_descriptor *interface, unsigned int type, unsigned int index)
	Describe USB endpoint from device configuration.
int	usb_endpoint_open (struct usb_endpoint *ep)
	Open USB endpoint.
int	usb_endpoint_clear_halt (struct usb_endpoint *ep)
	Clear endpoint halt (if applicable).
void	usb_endpoint_close (struct usb_endpoint *ep)
	Close USB endpoint.
int	usb_message (struct usb_endpoint ep, unsigned int request, unsigned int value, unsigned int index, struct io_buffer iobuf)
	Enqueue USB message transfer.
int	usb_stream (struct usb_endpoint ep, struct io_buffer iobuf, int terminate)
	Enqueue USB stream transfer.
void	usb_complete_err (struct usb_endpoint ep, struct io_buffer iobuf, int rc)
	Complete transfer (possibly with error).
static void	usb_refill_init (struct usb_endpoint *ep, size_t reserve, size_t len, unsigned int max)
	Initialise USB endpoint refill.
static void	usb_recycle (struct usb_endpoint ep, struct io_buffer iobuf)
	Recycle I/O buffer.
int	usb_prefill (struct usb_endpoint *ep)
	Prefill endpoint recycled buffer list.
int	usb_refill_limit (struct usb_endpoint *ep, unsigned int max)
	Refill endpoint up to specified limit.
int	usb_refill (struct usb_endpoint *ep)
	Refill endpoint.
void	usb_flush (struct usb_endpoint *ep)
	Discard endpoint recycled buffer list.
static void	usb_func_set_drvdata (struct usb_function func, void priv)
	Set USB function driver private data.
static void *	usb_func_get_drvdata (struct usb_function *func)
	Get USB function driver private data.
static void	usb_set_hostdata (struct usb_device usb, void priv)
	Set USB device host controller private data.
static void *	usb_get_hostdata (struct usb_device *usb)
	Get USB device host controller private data.
static struct usb_endpoint *	usb_endpoint (struct usb_device *usb, unsigned int address)
	Get USB endpoint.
static void	usb_hub_set_drvdata (struct usb_hub hub, void priv)
	Set USB hub driver private data.
static void *	usb_hub_get_drvdata (struct usb_hub *hub)
	Get USB hub driver private data.
static struct usb_port *	usb_port (struct usb_hub *hub, unsigned int address)
	Get USB port.
static void	usb_bus_set_hostdata (struct usb_bus bus, void priv)
	Set USB bus host controller private data.
static void *	usb_bus_get_hostdata (struct usb_bus *bus)
	Get USB bus host controller private data.
static void	usb_poll (struct usb_bus *bus)
	Poll USB bus.
static void	usb_complete (struct usb_endpoint ep, struct io_buffer iobuf)
	Complete transfer (without error).
int	usb_control (struct usb_device usb, unsigned int request, unsigned int value, unsigned int index, void data, size_t len)
	Issue USB control transaction.
int	usb_get_string_descriptor (struct usb_device usb, unsigned int index, unsigned int language, char buf, size_t len)
	Get USB string descriptor.
static int	usb_get_status (struct usb_device usb, unsigned int type, unsigned int index, void data, size_t len)
	Get status.
static int	usb_clear_feature (struct usb_device *usb, unsigned int type, unsigned int feature, unsigned int index)
	Clear feature.
static int	usb_set_feature (struct usb_device *usb, unsigned int type, unsigned int feature, unsigned int index)
	Set feature.
static int	usb_set_address (struct usb_device *usb, unsigned int address)
	Set address.
static int	usb_get_descriptor (struct usb_device usb, unsigned int type, unsigned int desc, unsigned int index, unsigned int language, struct usb_descriptor_header data, size_t len)
	Get USB descriptor.
static int	usb_get_mtu (struct usb_device usb, struct usb_device_descriptor data)
	Get first part of USB device descriptor (up to and including MTU).
static int	usb_get_device_descriptor (struct usb_device usb, struct usb_device_descriptor data)
	Get USB device descriptor.
static int	usb_get_config_descriptor (struct usb_device usb, unsigned int index, struct usb_configuration_descriptor data, size_t len)
	Get USB configuration descriptor.
static int	usb_set_configuration (struct usb_device *usb, unsigned int index)
	Set USB configuration.
static int	usb_set_interface (struct usb_device *usb, unsigned int interface, unsigned int alternate)
	Set USB interface alternate setting.
static unsigned int	usb_depth (struct usb_device *usb)
	Get USB depth.
struct usb_interface_descriptor *	usb_interface_descriptor (struct usb_configuration_descriptor *config, unsigned int interface, unsigned int alternate)
	Locate USB interface descriptor.
struct usb_endpoint_descriptor *	usb_endpoint_descriptor (struct usb_configuration_descriptor config, struct usb_interface_descriptor interface, unsigned int type, unsigned int index)
	Locate USB endpoint descriptor.
struct usb_endpoint_companion_descriptor *	usb_endpoint_companion_descriptor (struct usb_configuration_descriptor config, struct usb_endpoint_descriptor desc)
	Locate USB endpoint companion descriptor.
struct usb_device *	find_usb (struct usb_bus *bus, unsigned int address)
	Find USB device by address.
struct usb_hub *	alloc_usb_hub (struct usb_bus bus, struct usb_device usb, unsigned int ports, struct usb_hub_driver_operations *op)
	Allocate USB hub.
int	register_usb_hub (struct usb_hub *hub)
	Register USB hub.
void	unregister_usb_hub (struct usb_hub *hub)
	Unregister USB hub.
void	free_usb_hub (struct usb_hub *hub)
	Free USB hub.
void	usb_port_changed (struct usb_port *port)
	Report port status change.
struct usb_bus *	alloc_usb_bus (struct device dev, unsigned int ports, size_t mtu, struct usb_host_operations op)
	Allocate USB bus.
int	register_usb_bus (struct usb_bus *bus)
	Register USB bus.
void	unregister_usb_bus (struct usb_bus *bus)
	Unregister USB bus.
void	free_usb_bus (struct usb_bus *bus)
	Free USB bus.
struct usb_bus *	find_usb_bus (unsigned int address)
	Find USB bus by address.
struct usb_bus *	find_usb_bus_by_location (unsigned int bus_type, unsigned int location)
	Find USB bus by device location.
int	usb_alloc_address (struct usb_bus *bus)
	Allocate device address.
void	usb_free_address (struct usb_bus *bus, unsigned int address)
	Free device address.
int	usb_find_next (struct usb_device *usb, uint16_t busdev)
	Find next USB device.
unsigned int	usb_route_string (struct usb_device *usb)
	Get USB route string.
struct usb_port *	usb_root_hub_port (struct usb_device *usb)
	Get USB root hub port.
struct usb_port *	usb_transaction_translator (struct usb_device *usb)
	Get USB transaction translator.
struct usb_driver *	usb_find_driver (struct usb_function_descriptor desc, struct usb_device_id *id)
	Find USB device driver.

Variables
struct list_head	usb_buses
	List of USB buses.

Detailed Description

Universal Serial Bus (USB).

Definition in file usb.h.

Macro Definition Documentation

◆ USB_SPEED

#define USB_SPEED	(		mantissa,
			exponent )

Value:

( (exponent << 16) | (mantissa) )

Define a USB speed.

Parameters

mantissa	Mantissa
exponent	Exponent (in engineering terms: 1=k, 2=M, 3=G)

Return values

speed USB speed

Definition at line 36 of file usb.h.

Referenced by xhci_port_psiv(), and xhci_port_speed().

◆ USB_SPEED_MANTISSA

#define USB_SPEED_MANTISSA ( speed )

Value:

( (speed) & 0xffff )

Extract USB speed mantissa.

Definition at line 39 of file usb.h.

Referenced by usb_speed_name().

◆ USB_SPEED_EXPONENT

#define USB_SPEED_EXPONENT ( speed )

Value:

( ( (speed) >> 16 ) & 0x3 )

Extract USB speed exponent.

Definition at line 42 of file usb.h.

Referenced by usb_speed_name().

◆ USB_BUSDEV

#define USB_BUSDEV	(		bus,
			dev )

Value:

( ( (bus) << 8 ) | (dev) )

bus

uint8_t bus

Bus.

Definition edd.h:1

Define a USB bus:device address.

Parameters

bus	Bus address
dev	Device address

Return values

busdev Bus:device address

Definition at line 64 of file usb.h.

Referenced by usb_probe_all().

◆ USB_BUS

#define USB_BUS ( busdev )

Value:

( (busdev) >> 8 )

Extract USB bus address.

Definition at line 67 of file usb.h.

Referenced by usb_find_next(), and usb_settings_fetch().

◆ USB_DEV

#define USB_DEV ( busdev )

Value:

( (busdev) & 0xff )

Extract USB device address.

Definition at line 70 of file usb.h.

Referenced by usb_find_next(), and usb_settings_fetch().

◆ USB_DIR_OUT

#define USB_DIR_OUT ( 0 << 7 )

Data transfer is from host to device.

Definition at line 95 of file usb.h.

◆ USB_DIR_IN

#define USB_DIR_IN ( 1 << 7 )

Data transfer is from device to host.

Definition at line 98 of file usb.h.

Referenced by ehci_endpoint_message(), ehci_endpoint_stream(), uhci_endpoint_message(), uhci_endpoint_stream(), usb_control(), usb_endpoint_descriptor(), usb_message(), usbblk_out_command(), usbio_control_poll(), usbio_endpoint_open(), xhci_endpoint_message(), xhci_endpoint_open(), and xhci_endpoint_stream().

◆ USB_TYPE_STANDARD

#define USB_TYPE_STANDARD ( 0 << 5 )

Standard request type.

Definition at line 101 of file usb.h.

◆ USB_TYPE_CLASS

#define USB_TYPE_CLASS ( 1 << 5 )

Class-specific request type.

Definition at line 104 of file usb.h.

Referenced by usb_hub_clear_port_feature(), usb_hub_get_descriptor(), usb_hub_get_port_status(), and usb_hub_set_port_feature().

◆ USB_TYPE_VENDOR

#define USB_TYPE_VENDOR ( 2 << 5 )

Vendor-specific request type.

Definition at line 107 of file usb.h.

◆ USB_RECIP_MASK

#define USB_RECIP_MASK ( 0x1f << 0 )

Request recipient mask.

Definition at line 110 of file usb.h.

Referenced by usbio_control_poll().

◆ USB_RECIP_DEVICE

#define USB_RECIP_DEVICE ( 0 << 0 )

Request recipient is the device.

Definition at line 113 of file usb.h.

◆ USB_RECIP_INTERFACE

#define USB_RECIP_INTERFACE ( 1 << 0 )

Request recipient is an interface.

Definition at line 116 of file usb.h.

Referenced by usbio_control_poll().

◆ USB_RECIP_ENDPOINT

#define USB_RECIP_ENDPOINT ( 2 << 0 )

Request recipient is an endpoint.

Definition at line 119 of file usb.h.

Referenced by usb_endpoint_clear_halt().

◆ USB_REQUEST_TYPE

#define USB_REQUEST_TYPE ( type )

Value:

( (type) << 8 )

type

uint32_t type

Operating system type.

Definition ena.h:1

Construct USB request type.

Definition at line 122 of file usb.h.

Referenced by efi_usb_control_transfer().

◆ USB_GET_STATUS

#define USB_GET_STATUS ( USB_DIR_IN | USB_REQUEST_TYPE ( 0 ) )

Get status.

Definition at line 125 of file usb.h.

Referenced by usb_get_status().

◆ USB_CLEAR_FEATURE

#define USB_CLEAR_FEATURE ( USB_DIR_OUT | USB_REQUEST_TYPE ( 1 ) )

Clear feature.

Definition at line 128 of file usb.h.

Referenced by usb_clear_feature().

◆ USB_SET_FEATURE

#define USB_SET_FEATURE ( USB_DIR_OUT | USB_REQUEST_TYPE ( 3 ) )

Set feature.

Definition at line 131 of file usb.h.

Referenced by usb_set_feature().

◆ USB_SET_ADDRESS

#define USB_SET_ADDRESS ( USB_DIR_OUT | USB_REQUEST_TYPE ( 5 ) )

Set address.

Definition at line 134 of file usb.h.

Referenced by usb_set_address().

◆ USB_GET_DESCRIPTOR

#define USB_GET_DESCRIPTOR ( USB_DIR_IN | USB_REQUEST_TYPE ( 6 ) )

Get descriptor.

Definition at line 137 of file usb.h.

Referenced by usb_get_descriptor(), and usbio_config().

◆ USB_SET_DESCRIPTOR

#define USB_SET_DESCRIPTOR ( USB_DIR_OUT | USB_REQUEST_TYPE ( 7 ) )

Set descriptor.

Definition at line 140 of file usb.h.

◆ USB_GET_CONFIGURATION

#define USB_GET_CONFIGURATION ( USB_DIR_IN | USB_REQUEST_TYPE ( 8 ) )

Get configuration.

Definition at line 143 of file usb.h.

◆ USB_SET_CONFIGURATION

#define USB_SET_CONFIGURATION ( USB_DIR_OUT | USB_REQUEST_TYPE ( 9 ) )

Set configuration.

Definition at line 146 of file usb.h.

Referenced by efi_usb_control_transfer(), usb_set_configuration(), and usbio_control_poll().

◆ USB_GET_INTERFACE

#define USB_GET_INTERFACE ( USB_DIR_IN | USB_RECIP_INTERFACE | USB_REQUEST_TYPE ( 10 ) )

Get interface.

Definition at line 149 of file usb.h.

149#define USB_GET_INTERFACE \

150 ( USB_DIR_IN | USB_RECIP_INTERFACE | USB_REQUEST_TYPE ( 10 ) )

◆ USB_SET_INTERFACE

#define USB_SET_INTERFACE ( USB_DIR_OUT | USB_RECIP_INTERFACE | USB_REQUEST_TYPE ( 11 ) )

Set interface.

Definition at line 153 of file usb.h.

153#define USB_SET_INTERFACE \

154 ( USB_DIR_OUT | USB_RECIP_INTERFACE | USB_REQUEST_TYPE ( 11 ) )

Referenced by efi_usb_control_transfer(), and usb_set_interface().

◆ USB_ENDPOINT_HALT

#define USB_ENDPOINT_HALT 0

Endpoint halt feature.

Definition at line 157 of file usb.h.

Referenced by usb_endpoint_clear_halt().

◆ USB_CLASS_HUB

#define USB_CLASS_HUB 9

Class code for USB hubs.

Definition at line 170 of file usb.h.

◆ USB_DEVICE_DESCRIPTOR

#define USB_DEVICE_DESCRIPTOR 1

A USB device descriptor.

Definition at line 207 of file usb.h.

Referenced by usb_get_device_descriptor(), and usb_get_mtu().

◆ USB_CONFIGURATION_DESCRIPTOR

#define USB_CONFIGURATION_DESCRIPTOR 2

A USB configuration descriptor.

Definition at line 228 of file usb.h.

Referenced by usb_get_config_descriptor(), and usbio_config().

◆ USB_STRING_DESCRIPTOR

#define USB_STRING_DESCRIPTOR 3

A USB string descriptor.

Definition at line 239 of file usb.h.

Referenced by efi_usb_get_string_descriptor(), efi_usb_probe(), usb_get_default_language(), and usb_get_string_descriptor().

◆ USB_LANG_ENGLISH

#define USB_LANG_ENGLISH 0x0409

Language ID for English.

Definition at line 242 of file usb.h.

Referenced by usb_get_default_language().

◆ USB_INTERFACE_DESCRIPTOR

#define USB_INTERFACE_DESCRIPTOR 4

A USB interface descriptor.

Definition at line 261 of file usb.h.

Referenced by usb_interface_descriptor(), and usbio_interface().

◆ USB_ENDPOINT_DESCRIPTOR

#define USB_ENDPOINT_DESCRIPTOR 5

A USB endpoint descriptor.

Definition at line 278 of file usb.h.

Referenced by efi_usb_get_endpoint_descriptor(), efi_usb_mtu(), usb_endpoint_descriptor(), and usbio_interface().

◆ USB_ENDPOINT_ATTR_TYPE_MASK

#define USB_ENDPOINT_ATTR_TYPE_MASK 0x03

Endpoint attribute transfer type mask.

Definition at line 281 of file usb.h.

Referenced by ehci_endpoint_capabilities(), ehci_endpoint_characteristics(), ehci_schedule_add(), ehci_schedule_del(), uhci_schedule_add(), uhci_schedule_del(), usb_endpoint_clear_halt(), usb_endpoint_described(), usb_endpoint_descriptor(), usb_hub_clear_tt_buffer(), usbio_endpoint_open(), and xhci_endpoint_open().

◆ USB_ENDPOINT_ATTR_PERIODIC

#define USB_ENDPOINT_ATTR_PERIODIC 0x01

Endpoint periodic type.

Definition at line 284 of file usb.h.

Referenced by usb_endpoint_clear_tt().

◆ USB_ENDPOINT_ATTR_CONTROL

#define USB_ENDPOINT_ATTR_CONTROL 0x00

Control endpoint transfer type.

Definition at line 287 of file usb.h.

Referenced by ehci_endpoint_characteristics(), usb_endpoint_clear_halt(), usbio_endpoint_open(), and xhci_endpoint_open().

◆ USB_ENDPOINT_ATTR_BULK

#define USB_ENDPOINT_ATTR_BULK 0x02

Bulk endpoint transfer type.

Definition at line 290 of file usb.h.

Referenced by efi_usb_bulk_transfer(), and usbio_endpoint_open().

◆ USB_ENDPOINT_ATTR_INTERRUPT

#define USB_ENDPOINT_ATTR_INTERRUPT 0x03

Interrupt endpoint transfer type.

Definition at line 293 of file usb.h.

Referenced by efi_usb_async_start(), efi_usb_sync_interrupt_transfer(), ehci_endpoint_capabilities(), ehci_schedule_add(), ehci_schedule_del(), uhci_schedule_add(), uhci_schedule_del(), usb_endpoint_described(), and usbio_endpoint_open().

◆ USB_BULK_OUT

#define USB_BULK_OUT ( USB_ENDPOINT_ATTR_BULK | USB_DIR_OUT )

Bulk OUT endpoint (internal) type.

Definition at line 296 of file usb.h.

Referenced by usbblk_probe(), and usbnet_data_describe().

◆ USB_BULK_IN

#define USB_BULK_IN ( USB_ENDPOINT_ATTR_BULK | USB_DIR_IN )

Bulk IN endpoint (internal) type.

Definition at line 299 of file usb.h.

Referenced by usbblk_probe(), and usbnet_data_describe().

◆ USB_INTERRUPT_IN

#define USB_INTERRUPT_IN ( USB_ENDPOINT_ATTR_INTERRUPT | USB_DIR_IN )

Interrupt IN endpoint (internal) type.

Definition at line 302 of file usb.h.

Referenced by hub_probe(), usbhid_describe(), and usbnet_comms_describe().

◆ USB_INTERRUPT_OUT

#define USB_INTERRUPT_OUT ( USB_ENDPOINT_ATTR_INTERRUPT | USB_DIR_OUT )

Interrupt OUT endpoint (internal) type.

Definition at line 305 of file usb.h.

Referenced by usbhid_describe().

◆ USB_ENDPOINT_MTU

#define USB_ENDPOINT_MTU ( sizes )

Value:

( ( (sizes) >> 0 ) & 0x07ff )

USB endpoint MTU.

Definition at line 308 of file usb.h.

Referenced by efi_usb_mtu(), and usb_endpoint_described().

◆ USB_ENDPOINT_BURST

#define USB_ENDPOINT_BURST ( sizes )

Value:

( ( (sizes) >> 11 ) & 0x0003 )

USB endpoint maximum burst size.

Definition at line 311 of file usb.h.

Referenced by usb_endpoint_described().

◆ USB_ENDPOINT_COMPANION_DESCRIPTOR

#define USB_ENDPOINT_COMPANION_DESCRIPTOR 48

A USB endpoint companion descriptor.

Definition at line 326 of file usb.h.

Referenced by usb_endpoint_companion_descriptor().

◆ USB_INTERFACE_ASSOCIATION_DESCRIPTOR

#define USB_INTERFACE_ASSOCIATION_DESCRIPTOR 11

A USB interface association descriptor.

Definition at line 343 of file usb.h.

Referenced by usb_interface_association_descriptor().

◆ USB_CS_INTERFACE_DESCRIPTOR

#define USB_CS_INTERFACE_DESCRIPTOR 36

A class-specific interface descriptor.

Definition at line 346 of file usb.h.

Referenced by cdc_union_descriptor(), and ecm_ethernet_descriptor().

◆ USB_CS_ENDPOINT_DESCRIPTOR

#define USB_CS_ENDPOINT_DESCRIPTOR 37

A class-specific endpoint descriptor.

Definition at line 349 of file usb.h.

◆ for_each_config_descriptor

#define for_each_config_descriptor	(	desc,
		config,
		typeval )

Value:

for ( desc = container_of ( &(config)->header,                     \
                            typeof ( *desc ), header ) ;           \
      ( usb_is_within_config ( (config), &desc->header ) &&        \
        ( desc->header.len >= sizeof ( desc->header ) ) ) ;        \
      desc = container_of ( usb_next_descriptor ( &desc->header ), \
                            typeof ( *desc ), header ) )           \
        if ( ( desc->header.len < sizeof ( *desc ) ) ||            \
             ( desc->header.type != (typeval) ) )                  \
                continue;                                          \
        else

Iterate over all configuration descriptors.

Definition at line 386 of file usb.h.

#define for_each_config_descriptor( desc, config, typeval )                \
        for ( desc = container_of ( &(config)->header,                     \
                                    typeof ( *desc ), header ) ;           \
              ( usb_is_within_config ( (config), &desc->header ) &&        \
                ( desc->header.len >= sizeof ( desc->header ) ) ) ;        \
              desc = container_of ( usb_next_descriptor ( &desc->header ), \
                                    typeof ( *desc ), header ) )           \
                if ( ( desc->header.len < sizeof ( *desc ) ) ||            \
                     ( desc->header.type != (typeval) ) )                  \
                        continue;                                          \
                else

Referenced by usb_interface_association_descriptor(), usb_interface_descriptor(), and usbio_interface().

◆ for_each_interface_descriptor

#define for_each_interface_descriptor	(	desc,
		config,
		interface,
		typeval )

Value:

for ( desc = container_of ( usb_next_descriptor ( &(interface)->   \
                                                  header ),        \
                            typeof ( *desc ), header ) ;           \
      ( usb_is_within_config ( (config), &desc->header ) &&        \
        ( desc->header.len >= sizeof ( desc->header ) ) &&         \
        ( desc->header.type != USB_INTERFACE_DESCRIPTOR ) ) ;      \
      desc = container_of ( usb_next_descriptor ( &desc->header ), \
                            typeof ( *desc ), header ) )           \
        if ( ( desc->header.len < sizeof ( *desc ) ) ||            \
             ( desc->header.type != (typeval) ) )                  \
                continue;                                          \
        else

Iterate over all configuration descriptors within an interface descriptor.

Definition at line 399 of file usb.h.

#define for_each_interface_descriptor( desc, config, interface, typeval )  \
        for ( desc = container_of ( usb_next_descriptor ( &(interface)->   \
                                                          header ),        \
                                    typeof ( *desc ), header ) ;           \
              ( usb_is_within_config ( (config), &desc->header ) &&        \
                ( desc->header.len >= sizeof ( desc->header ) ) &&         \
                ( desc->header.type != USB_INTERFACE_DESCRIPTOR ) ) ;      \
              desc = container_of ( usb_next_descriptor ( &desc->header ), \
                                    typeof ( *desc ), header ) )           \
                if ( ( desc->header.len < sizeof ( *desc ) ) ||            \
                     ( desc->header.type != (typeval) ) )                  \
                        continue;                                          \
                else

Referenced by cdc_union_descriptor(), ecm_ethernet_descriptor(), efi_usb_get_endpoint_descriptor(), efi_usb_mtu(), usb_endpoint_descriptor(), and usbio_interface().

◆ USB_EP0_ADDRESS

#define USB_EP0_ADDRESS 0x00

Control endpoint address.

Definition at line 511 of file usb.h.

Referenced by ehci_device_address(), register_usb(), uhci_device_address(), usb_deconfigure(), and usbio_interface().

◆ USB_EP0_ATTRIBUTES

#define USB_EP0_ATTRIBUTES 0x00

Control endpoint attributes.

Definition at line 514 of file usb.h.

Referenced by register_usb().

◆ USB_EP0_DEFAULT_MTU

#define USB_EP0_DEFAULT_MTU ( speed )

Value:

( ( (speed) >= USB_SPEED_SUPER ) ? 512 : \

( ( (speed) >= USB_SPEED_FULL ) ? 64 : 8 ) )

USB_SPEED_FULL

@ USB_SPEED_FULL

Full speed (12Mbps).

Definition usb.h:51

USB_SPEED_SUPER

@ USB_SPEED_SUPER

Super speed (5Gbps).

Definition usb.h:55

Calculate default MTU based on device speed.

Parameters

speed Device speed

Return values

mtu	Default MTU

Definition at line 521 of file usb.h.

#define USB_EP0_DEFAULT_MTU(speed)                      \
        ( ( (speed) >= USB_SPEED_SUPER ) ? 512 :        \
          ( ( (speed) >= USB_SPEED_FULL ) ? 64 : 8 ) )

Referenced by register_usb().

◆ USB_EP0_BURST

#define USB_EP0_BURST 0

Control endpoint maximum burst size.

Definition at line 526 of file usb.h.

Referenced by register_usb().

◆ USB_EP0_INTERVAL

#define USB_EP0_INTERVAL 0

Control endpoint interval.

Definition at line 529 of file usb.h.

Referenced by register_usb().

◆ USB_ENDPOINT_MAX

#define USB_ENDPOINT_MAX 0x0f

Maximum endpoint number.

Definition at line 532 of file usb.h.

Referenced by usb_endpoint_name(), and usb_hub_clear_tt_buffer().

◆ USB_ENDPOINT_IN

#define USB_ENDPOINT_IN 0x80

Endpoint direction is in.

Definition at line 535 of file usb.h.

Referenced by efi_usb_async_interrupt_transfer(), efi_usb_async_isochronous_transfer(), efi_usb_bulk_transfer(), efi_usb_isochronous_transfer(), efi_usb_sync_interrupt_transfer(), efi_usb_sync_transfer(), usb_endpoint_name(), and usb_hub_clear_tt_buffer().

◆ USB_ENDPOINT_IDX

#define USB_ENDPOINT_IDX ( address )

Value:

( ( (address) & USB_ENDPOINT_MAX ) | \

( ( (address) & USB_ENDPOINT_IN ) >> 3 ) )

address

uint64_t address

Base address.

Definition ena.h:13

USB_ENDPOINT_MAX

#define USB_ENDPOINT_MAX

Maximum endpoint number.

Definition usb.h:532

USB_ENDPOINT_IN

#define USB_ENDPOINT_IN

Endpoint direction is in.

Definition usb.h:535

Construct endpoint index from endpoint address.

Definition at line 538 of file usb.h.

#define USB_ENDPOINT_IDX(address)                                       \
        ( ( (address) & USB_ENDPOINT_MAX ) |                            \
          ( ( (address) & USB_ENDPOINT_IN ) >> 3 ) )

Referenced by efi_usb_async_start(), efi_usb_async_stop(), efi_usb_close(), efi_usb_is_open(), efi_usb_open(), efi_usb_sync_transfer(), usb_deconfigure(), usb_endpoint(), usb_endpoint_close(), and usb_endpoint_open().

◆ for_each_usb_bus

#define for_each_usb_bus ( bus )

Value:

list_for_each_entry ( (bus), &usb_buses, list )

list_for_each_entry

#define list_for_each_entry(pos, head, member)

Iterate over entries in a list.

Definition list.h:432

usb_buses

struct list_head usb_buses

List of USB buses.

Definition usb.c:45

Iterate over all USB buses.

Definition at line 1087 of file usb.h.

1087#define for_each_usb_bus( bus ) \

1088 list_for_each_entry ( (bus), &usb_buses, list )

Referenced by ehci_poll_companions(), find_usb_bus(), find_usb_bus_by_location(), and usb_step().

◆ USB_RESET_DELAY_MS

#define USB_RESET_DELAY_MS 50

Minimum reset time.

Section 7.1.7.5 of the USB2 specification states that root hub ports should assert reset signalling for at least 50ms.

Definition at line 1338 of file usb.h.

Referenced by ehci_root_enable(), and uhci_root_enable().

◆ USB_RESET_RECOVER_DELAY_MS

#define USB_RESET_RECOVER_DELAY_MS 10

Reset recovery time.

Section 9.2.6.2 of the USB2 specification states that the "recovery" interval after a port reset is 10ms.

Definition at line 1345 of file usb.h.

Referenced by register_usb(), and uhci_root_enable().

◆ USB_CONTROL_MAX_WAIT_MS

#define USB_CONTROL_MAX_WAIT_MS 5000

Maximum time to wait for a control transaction to complete.

Section 9.2.6.1 of the USB2 specification states that the upper limit for commands to be processed is 5 seconds.

Definition at line 1352 of file usb.h.

Referenced by usb_control().

◆ USB_SET_ADDRESS_RECOVER_DELAY_MS

#define USB_SET_ADDRESS_RECOVER_DELAY_MS 2

Set address recovery time.

Section 9.2.6.3 of the USB2 specification states that devices are allowed a 2ms recovery interval after receiving a new address.

Definition at line 1359 of file usb.h.

Referenced by register_usb().

◆ USB_PORT_DELAY_MS

#define USB_PORT_DELAY_MS 200

Time to wait for ports to stabilise.

Section 7.1.7.3 of the USB specification states that we must allow 100ms for devices to signal attachment, and an additional 100ms for connection debouncing. (This delay is parallelised across all ports on a hub; we do not delay separately for each port.)

Definition at line 1368 of file usb.h.

Referenced by register_usb_hub().

◆ USB_ID

#define USB_ID	(	_vendor,
		_product,
		_name,
		_description,
		_data )

Value:

        {       \
        .vendor = _vendor,                                              \
        .product = _product,                                            \
        .name = _name,                                                  \
        .driver_data = _data                                            \
}

Definition at line 1383 of file usb.h.

#define USB_ID( _vendor, _product, _name, _description, _data ) {       \
        .vendor = _vendor,                                              \
        .product = _product,                                            \
        .name = _name,                                                  \
        .driver_data = _data                                            \
}

◆ USB_ROM

#define USB_ROM	(	_vendor,
		_product,
		_name,
		_description,
		_data )

Value:

USB_ID ( _vendor, _product, _name, _description, _data )

USB_ID

#define USB_ID(_vendor, _product, _name, _description, _data)

Definition usb.h:1383

Definition at line 1391 of file usb.h.

1391#define USB_ROM( _vendor, _product, _name, _description, _data ) \

1392 USB_ID ( _vendor, _product, _name, _description, _data )

◆ USB_ANY_ID

#define USB_ANY_ID 0xffff

Match-anything ID.

Definition at line 1395 of file usb.h.

Referenced by usb_find_driver().

◆ USB_CLASS_ID

#define USB_CLASS_ID	(	base,
		subclass,
		protocol )

Value:

{                       \
.class = {                                                      \
        .class = {                                              \
                ( (base) & 0xff ),                              \
                ( (subclass) & 0xff ),                          \
                ( (protocol) & 0xff ),                          \
        },                                                      \
},                                                              \
.mask = {                                                       \
        .class = {                                              \
                ( ( (base) == USB_ANY_ID ) ? 0x00 : 0xff ),     \
                ( ( (subclass) == USB_ANY_ID ) ? 0x00 : 0xff ), \
                ( ( (protocol) == USB_ANY_ID ) ? 0x00 : 0xff ), \
        },                                                      \
        },                                                      \
}

Construct USB class ID.

Parameters

base	Base class code (or USB_ANY_ID)
subclass	Subclass code (or USB_ANY_ID)
protocol	Protocol code (or USB_ANY_ID)

Definition at line 1411 of file usb.h.

#define USB_CLASS_ID( base, subclass, protocol ) {                      \
        .class = {                                                      \
                .class = {                                              \
                        ( (base) & 0xff ),                              \
                        ( (subclass) & 0xff ),                          \
                        ( (protocol) & 0xff ),                          \
                },                                                      \
        },                                                              \
        .mask = {                                                       \
                .class = {                                              \
                        ( ( (base) == USB_ANY_ID ) ? 0x00 : 0xff ),     \
                        ( ( (subclass) == USB_ANY_ID ) ? 0x00 : 0xff ), \
                        ( ( (protocol) == USB_ANY_ID ) ? 0x00 : 0xff ), \
                },                                                      \
                },                                                      \
        }

◆ USB_DRIVERS

#define USB_DRIVERS __table ( struct usb_driver, "usb_drivers" )

USB driver table.

Definition at line 1460 of file usb.h.

Referenced by usb_find_driver().

◆ __usb_driver

struct usb_driver iphone_driver __usb_driver __table_entry ( USB_DRIVERS, 01 )

Declare a USB driver.

iPhone driver

USB RF-RNDIS driver.

Definition at line 1463 of file usb.h.

◆ __usb_fallback_driver

#define __usb_fallback_driver __table_entry ( USB_DRIVERS, 02 )

Declare a USB fallback driver.

Definition at line 1466 of file usb.h.

Enumeration Type Documentation

◆ usb_protocol

enum usb_protocol

USB protocols.

Enumerator
USB_PROTO_2_0	USB 2.0.
USB_PROTO_3_0	USB 3.0.
USB_PROTO_3_1	USB 3.1.

Definition at line 21 of file usb.h.

                  {
        /** USB 2.0 */
        USB_PROTO_2_0 = 0x0200,
        /** USB 3.0 */
        USB_PROTO_3_0 = 0x0300,
        /** USB 3.1 */
        USB_PROTO_3_1 = 0x0301,
};

◆ usb_speed

enum usb_speed

USB device speeds.

Enumerator
USB_SPEED_NONE	Not connected.
USB_SPEED_LOW	Low speed (1.5Mbps).
USB_SPEED_FULL	Full speed (12Mbps).
USB_SPEED_HIGH	High speed (480Mbps).
USB_SPEED_SUPER	Super speed (5Gbps).

Definition at line 45 of file usb.h.

               {
        /** Not connected */
        USB_SPEED_NONE = 0,
        /** Low speed (1.5Mbps) */
        USB_SPEED_LOW = USB_SPEED ( 1500, 1 ),
        /** Full speed (12Mbps) */
        USB_SPEED_FULL = USB_SPEED ( 12, 2 ),
        /** High speed (480Mbps) */
        USB_SPEED_HIGH = USB_SPEED ( 480, 2 ),
        /** Super speed (5Gbps) */
        USB_SPEED_SUPER = USB_SPEED ( 5, 3 ),
};

◆ usb_pid

enum usb_pid

USB packet IDs.

Enumerator
USB_PID_IN	IN PID.
USB_PID_OUT	OUT PID.
USB_PID_SETUP	SETUP PID.

Definition at line 73 of file usb.h.

             {
        /** IN PID */
        USB_PID_IN = 0x69,
        /** OUT PID */
        USB_PID_OUT = 0xe1,
        /** SETUP PID */
        USB_PID_SETUP = 0x2d,
};

◆ usb_driver_score

enum usb_driver_score

USB driver scores.

Enumerator
USB_SCORE_FALLBACK	Fallback driver (has no effect on overall score).
USB_SCORE_DEPRECATED	Deprecated driver.
USB_SCORE_NORMAL	Normal driver.

Definition at line 1469 of file usb.h.

                      {
        /** Fallback driver (has no effect on overall score) */
        USB_SCORE_FALLBACK = 0,
        /** Deprecated driver */
        USB_SCORE_DEPRECATED = 1,
        /** Normal driver */
        USB_SCORE_NORMAL = 2,
};

Function Documentation

◆ FILE_LICENCE()

FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL )

◆ FILE_SECBOOT()

FILE_SECBOOT ( PERMITTED )

◆ usb_next_descriptor()

struct usb_descriptor_header * usb_next_descriptor ( struct usb_descriptor_header * desc )

inlinestatic

Get next USB descriptor.

Parameters

desc	USB descriptor header

Return values

next	Next USB descriptor header

Definition at line 358 of file usb.h.

                                                           {
 
        return ( ( ( void * ) desc ) + desc->len );
}

References desc.

Referenced by usb_endpoint_companion_descriptor(), and usb_is_within_config().

◆ usb_is_within_config()

int usb_is_within_config	(	struct usb_configuration_descriptor *	config,
		struct usb_descriptor_header *	desc )

inlinestatic

Check that descriptor lies within a configuration descriptor.

Parameters

config	Configuration descriptor
desc	Descriptor header
is_within	Descriptor is within the configuration descriptor

Definition at line 371 of file usb.h.

                                                            {
        struct usb_descriptor_header *end =
                ( ( ( void * ) config ) + le16_to_cpu ( config->len ) );
 
        /* Check that descriptor starts within the configuration
         * descriptor, and that the length does not exceed the
         * configuration descriptor.  This relies on the fact that
         * usb_next_descriptor() needs to access only the first byte
         * of the descriptor in order to determine the length.
         */
        return ( ( desc < end ) && ( usb_next_descriptor ( desc ) <= end ) );
}

References desc, end, le16_to_cpu, usb_configuration_descriptor::len, and usb_next_descriptor().

Referenced by usb_endpoint_companion_descriptor().

◆ usb_endpoint_init()

void usb_endpoint_init	(	struct usb_endpoint *	ep,
		struct usb_device *	usb,
		struct usb_endpoint_driver_operations *	driver )

inlinestatic

Initialise USB endpoint.

Parameters

ep	USB endpoint
usb	USB device
driver	Driver operations

Definition at line 550 of file usb.h.

                                                                    {
 
        ep->usb = usb;
        ep->driver = driver;
}

References usb_endpoint::driver, and usb_endpoint::usb.

Referenced by alloc_usb(), efi_usb_open(), hub_probe(), usbblk_probe(), usbhid_init(), and usbnet_init().

◆ usb_endpoint_describe()

void usb_endpoint_describe	(	struct usb_endpoint *	ep,
		unsigned int	address,
		unsigned int	attributes,
		size_t	mtu,
		unsigned int	burst,
		unsigned int	interval )

inlinestatic

Describe USB endpoint.

Parameters

ep	USB endpoint
address	Endpoint address
attributes	Attributes
mtu	Maximum packet size
burst	Maximum burst size
interval	Interval (in microframes)

Definition at line 568 of file usb.h.

                                                                    {
 
        ep->address = address;
        ep->attributes = attributes;
        ep->mtu = mtu;
        ep->burst = burst;
        ep->interval = interval;
}

References address, usb_endpoint::address, usb_endpoint::attributes, burst, usb_endpoint::burst, usb_endpoint::interval, mtu, and usb_endpoint::mtu.

Referenced by efi_usb_open(), register_usb(), and usb_endpoint_described().

◆ usb_endpoint_set_hostdata()

void usb_endpoint_set_hostdata	(	struct usb_endpoint *	ep,
		void *	priv )

inlinestatic

Set USB endpoint host controller private data.

Parameters

ep	USB endpoint
priv	Host controller private data

Definition at line 586 of file usb.h.

                                                                  {
        ep->priv = priv;
}

References priv, and usb_endpoint::priv.

Referenced by ehci_endpoint_open(), uhci_endpoint_open(), usbio_endpoint_open(), and xhci_endpoint_open().

◆ usb_endpoint_get_hostdata()

void * usb_endpoint_get_hostdata ( struct usb_endpoint * ep )

inlinestatic

Get USB endpoint host controller private data.

Parameters

ep	USB endpoint

Return values

priv	Host controller private data

Definition at line 597 of file usb.h.

                                                      {
        return ep->priv;
}

References usb_endpoint::priv.

Referenced by ehci_endpoint_close(), ehci_endpoint_message(), ehci_endpoint_reset(), ehci_endpoint_stream(), ehci_endpoint_update(), uhci_device_address(), uhci_endpoint_close(), uhci_endpoint_message(), uhci_endpoint_mtu(), uhci_endpoint_reset(), uhci_endpoint_stream(), usbio_endpoint_close(), usbio_endpoint_enqueue(), xhci_endpoint_close(), xhci_endpoint_message(), xhci_endpoint_mtu(), xhci_endpoint_reset(), and xhci_endpoint_stream().

◆ usb_endpoint_name()

const char * usb_endpoint_name ( struct usb_endpoint * ep )

extern

Get USB endpoint name (for debugging).

Parameters

ep	USB endpoint

Return values

name	Endpoint name

Definition at line 220 of file usb.c.

                                                           {
        static char buf[ 9 /* "EPxx OUT" + NUL */ ];
        unsigned int address = ep->address;
 
        snprintf ( buf, sizeof ( buf ), "EP%d%s",
                   ( address & USB_ENDPOINT_MAX ),
                   ( address ?
                     ( ( address & USB_ENDPOINT_IN ) ? " IN" : " OUT" ) : "" ));
        return buf;
}

References address, usb_endpoint::address, snprintf(), USB_ENDPOINT_IN, and USB_ENDPOINT_MAX.

Referenced by efi_usb_async_start(), efi_usb_close(), efi_usb_open(), efi_usb_sync_transfer(), ehci_endpoint_close(), ehci_endpoint_poll(), ehci_root_clear_tt(), uhci_endpoint_poll(), uhci_root_clear_tt(), usb_complete_err(), usb_endpoint_clear_halt(), usb_endpoint_clear_tt(), usb_endpoint_mtu(), usb_endpoint_open(), usb_endpoint_reset(), usb_message(), usb_stream(), usbio_bulk_in_poll(), usbio_bulk_out_poll(), usbio_control_poll(), usbio_endpoint_open(), usbio_interface(), usbio_interrupt_callback(), usbio_interrupt_open(), usbkbd_probe(), and xhci_root_clear_tt().

◆ usb_endpoint_described()

int usb_endpoint_described	(	struct usb_endpoint *	ep,
		struct usb_configuration_descriptor *	config,
		struct usb_interface_descriptor *	interface,
		unsigned int	type,
		unsigned int	index )

extern

Describe USB endpoint from device configuration.

Parameters

ep	USB endpoint
config	Configuration descriptor
interface	Interface descriptor
type	Endpoint (internal) type
index	Endpoint index

Return values

rc	Return status code

Definition at line 241 of file usb.c.

                                                                     {
        struct usb_device *usb = ep->usb;
        struct usb_endpoint_descriptor *desc;
        struct usb_endpoint_companion_descriptor *descx;
        unsigned int sizes;
        unsigned int burst;
        unsigned int interval;
        size_t mtu;
 
        /* Locate endpoint descriptor */
        desc = usb_endpoint_descriptor ( config, interface, type, index );
        if ( ! desc )
                return -ENOENT;
 
        /* Locate companion descriptor, if any */
        descx = usb_endpoint_companion_descriptor ( config, desc );
 
        /* Calculate MTU and burst size */
        sizes = le16_to_cpu ( desc->sizes );
        mtu = USB_ENDPOINT_MTU ( sizes );
        burst = ( descx ? descx->burst : USB_ENDPOINT_BURST ( sizes ) );
 
        /* Calculate interval */
        if ( ( type & USB_ENDPOINT_ATTR_TYPE_MASK ) ==
             USB_ENDPOINT_ATTR_INTERRUPT ) {
                if ( usb->speed >= USB_SPEED_HIGH ) {
                        /* 2^(desc->interval-1) is a microframe count */
                        interval = ( 1 << ( desc->interval - 1 ) );
                } else {
                        /* desc->interval is a (whole) frame count */
                        interval = ( desc->interval << 3 );
                }
        } else {
                /* desc->interval is a microframe count */
                interval = desc->interval;
        }
 
        /* Describe endpoint */
        usb_endpoint_describe ( ep, desc->endpoint, desc->attributes,
                                mtu, burst, interval );
        return 0;
}

References burst, usb_endpoint_companion_descriptor::burst, desc, ENOENT, usb_device::ep, index, le16_to_cpu, mtu, usb_device::speed, type, usb_endpoint::usb, USB_ENDPOINT_ATTR_INTERRUPT, USB_ENDPOINT_ATTR_TYPE_MASK, USB_ENDPOINT_BURST, usb_endpoint_companion_descriptor(), usb_endpoint_describe(), usb_endpoint_descriptor(), USB_ENDPOINT_MTU, and USB_SPEED_HIGH.

Referenced by hub_probe(), usbblk_probe(), usbhid_describe(), usbnet_comms_describe(), and usbnet_data_describe().

◆ usb_endpoint_open()

int usb_endpoint_open ( struct usb_endpoint * ep )

extern

Open USB endpoint.

Parameters

ep	USB endpoint

Return values

rc	Return status code

Definition at line 293 of file usb.c.

                                                  {
        struct usb_device *usb = ep->usb;
        unsigned int idx = USB_ENDPOINT_IDX ( ep->address );
        int rc;
 
        /* Populate host controller operations */
        ep->host = &usb->port->hub->bus->op->endpoint;
 
        /* Add to endpoint list */
        if ( usb->ep[idx] != NULL ) {
                DBGC ( usb, "USB %s %s is already open\n",
                       usb->name, usb_endpoint_name ( ep ) );
                rc = -EALREADY;
                goto err_already;
        }
        usb->ep[idx] = ep;
        INIT_LIST_HEAD ( &ep->halted );
 
        /* Open endpoint */
        if ( ( rc = ep->host->open ( ep ) ) != 0 ) {
                DBGC ( usb, "USB %s %s could not open: %s\n", usb->name,
                       usb_endpoint_name ( ep ), strerror ( rc ) );
                goto err_open;
        }
        ep->open = 1;
 
        DBGC2 ( usb, "USB %s %s opened with MTU %zd, burst %d, interval %d\n",
                usb->name, usb_endpoint_name ( ep ), ep->mtu, ep->burst,
                ep->interval );
        return 0;
 
        ep->open = 0;
        ep->host->close ( ep );
 err_open:
        usb->ep[idx] = NULL;
 err_already:
        if ( ep->max )
                usb_flush ( ep );
        return rc;
}

References usb_endpoint::address, usb_endpoint::burst, usb_hub::bus, usb_endpoint_host_operations::close, DBGC, DBGC2, EALREADY, usb_host_operations::endpoint, usb_device::ep, usb_endpoint::halted, usb_endpoint::host, usb_port::hub, INIT_LIST_HEAD, usb_endpoint::interval, usb_endpoint::max, usb_endpoint::mtu, usb_device::name, NULL, usb_bus::op, usb_endpoint::open, usb_endpoint_host_operations::open, usb_device::port, rc, strerror(), usb_endpoint::usb, USB_ENDPOINT_IDX, usb_endpoint_name(), and usb_flush().

Referenced by efi_usb_open(), hub_open(), register_usb(), usbblk_open(), usbhid_open(), and usbnet_open().

◆ usb_endpoint_clear_halt()

int usb_endpoint_clear_halt ( struct usb_endpoint * ep )

extern

Clear endpoint halt (if applicable).

Parameters

ep	USB endpoint

Return values

rc	Return status code

Definition at line 371 of file usb.c.

                                                        {
        struct usb_device *usb = ep->usb;
        unsigned int type;
        int rc;
 
        /* Clear transaction translator, if applicable */
        if ( ( rc = usb_endpoint_clear_tt ( ep ) ) != 0 )
                return rc;
 
        /* Clear endpoint halt (if applicable) */
        type = ( ep->attributes & USB_ENDPOINT_ATTR_TYPE_MASK );
        if ( ( type != USB_ENDPOINT_ATTR_CONTROL ) &&
             ( ( rc = usb_clear_feature ( usb, USB_RECIP_ENDPOINT,
                                          USB_ENDPOINT_HALT,
                                          ep->address ) ) != 0 ) ) {
                DBGC ( usb, "USB %s %s could not clear endpoint halt: %s\n",
                       usb->name, usb_endpoint_name ( ep ), strerror ( rc ) );
                return rc;
        }
 
        return 0;
}

References usb_endpoint::address, usb_endpoint::attributes, DBGC, usb_device::ep, usb_device::name, rc, strerror(), type, usb_endpoint::usb, usb_clear_feature(), USB_ENDPOINT_ATTR_CONTROL, USB_ENDPOINT_ATTR_TYPE_MASK, usb_endpoint_clear_tt(), USB_ENDPOINT_HALT, usb_endpoint_name(), and USB_RECIP_ENDPOINT.

Referenced by usb_endpoint_reset(), and usbblk_open().

◆ usb_endpoint_close()

void usb_endpoint_close ( struct usb_endpoint * ep )

extern

Close USB endpoint.

Parameters

ep	USB endpoint

Definition at line 399 of file usb.c.

                                                    {
        struct usb_device *usb = ep->usb;
        unsigned int idx = USB_ENDPOINT_IDX ( ep->address );
 
        /* Sanity checks */
        assert ( usb->ep[idx] == ep );
 
        /* Close endpoint */
        ep->open = 0;
        ep->host->close ( ep );
        assert ( ep->fill == 0 );
 
        /* Remove from endpoint list */
        usb->ep[idx] = NULL;
        list_del ( &ep->halted );
 
        /* Discard any recycled buffers, if applicable */
        if ( ep->max )
                usb_flush ( ep );
 
        /* Clear transaction translator, if applicable */
        usb_endpoint_clear_tt ( ep );
}

References usb_endpoint::address, assert, usb_endpoint_host_operations::close, usb_device::ep, usb_endpoint::fill, usb_endpoint::halted, usb_endpoint::host, list_del, usb_endpoint::max, NULL, usb_endpoint::open, usb_endpoint::usb, usb_endpoint_clear_tt(), USB_ENDPOINT_IDX, and usb_flush().

Referenced by efi_usb_close(), efi_usb_open(), hub_close(), hub_open(), register_usb(), unregister_usb(), usbblk_close(), usbblk_open(), usbhid_close(), usbhid_open(), usbnet_close(), and usbnet_open().

◆ usb_message()

int usb_message	(	struct usb_endpoint *	ep,
		unsigned int	request,
		unsigned int	value,
		unsigned int	index,
		struct io_buffer *	iobuf )

extern

Enqueue USB message transfer.

Parameters

ep	USB endpoint
request	Request
value	Value parameter
index	Index parameter
iobuf	I/O buffer

Return values

rc	Return status code

The I/O buffer must have sufficient headroom to contain a setup packet.

Definition at line 491 of file usb.c.

                                            {
        struct usb_device *usb = ep->usb;
        struct usb_port *port = usb->port;
        struct usb_setup_packet *packet;
        size_t len = iob_len ( iobuf );
        int rc;
 
        /* Sanity check */
        assert ( iob_headroom ( iobuf ) >= sizeof ( *packet ) );
 
        /* Fail immediately if device has been unplugged */
        if ( port->disconnected )
                return -ENODEV;
 
        /* Reset endpoint if required */
        if ( ( ! list_empty ( &ep->halted ) ) &&
             ( ( rc = usb_endpoint_reset ( ep ) ) != 0 ) )
                return rc;
 
        /* Zero input data buffer (if applicable) */
        if ( request & USB_DIR_IN )
                memset ( iobuf->data, 0, len );
 
        /* Construct setup packet */
        packet = iob_push ( iobuf, sizeof ( *packet ) );
        packet->request = cpu_to_le16 ( request );
        packet->value = cpu_to_le16 ( value );
        packet->index = cpu_to_le16 ( index );
        packet->len = cpu_to_le16 ( len );
 
        /* Enqueue message transfer */
        if ( ( rc = ep->host->message ( ep, iobuf ) ) != 0 ) {
                DBGC ( usb, "USB %s %s could not enqueue message transfer: "
                       "%s\n", usb->name, usb_endpoint_name ( ep ),
                       strerror ( rc ) );
                return rc;
        }
 
        /* Increment fill level */
        ep->fill++;
 
        return 0;
}

References assert, cpu_to_le16, io_buffer::data, DBGC, ENODEV, usb_device::ep, usb_endpoint::fill, usb_endpoint::halted, usb_endpoint::host, index, usb_setup_packet::index, iob_headroom(), iob_len(), iob_push, len, usb_setup_packet::len, list_empty, memset(), usb_endpoint_host_operations::message, usb_device::name, port, usb_device::port, rc, request, usb_setup_packet::request, strerror(), usb_endpoint::usb, usb_port::usb, USB_DIR_IN, usb_endpoint_name(), usb_endpoint_reset(), usb_setup_packet::value, and value.

Referenced by usb_control().

◆ usb_stream()

int usb_stream	(	struct usb_endpoint *	ep,
		struct io_buffer *	iobuf,
		int	terminate )

extern

Enqueue USB stream transfer.

Parameters

ep	USB endpoint
iobuf	I/O buffer
terminate	Terminate using a short packet

Return values

rc	Return status code

Definition at line 545 of file usb.c.

                                 {
        struct usb_device *usb = ep->usb;
        struct usb_port *port = usb->port;
        int zlp;
        int rc;
 
        /* Fail immediately if device has been unplugged */
        if ( port->disconnected )
                return -ENODEV;
 
        /* Reset endpoint if required */
        if ( ( ! list_empty ( &ep->halted ) ) &&
             ( ( rc = usb_endpoint_reset ( ep ) ) != 0 ) )
                return rc;
 
        /* Append a zero-length packet if necessary */
        zlp = terminate;
        if ( iob_len ( iobuf ) & ( ep->mtu - 1 ) )
                zlp = 0;
 
        /* Enqueue stream transfer */
        if ( ( rc = ep->host->stream ( ep, iobuf, zlp ) ) != 0 ) {
                DBGC ( usb, "USB %s %s could not enqueue stream transfer: %s\n",
                       usb->name, usb_endpoint_name ( ep ), strerror ( rc ) );
                return rc;
        }
 
        /* Increment fill level */
        ep->fill++;
 
        return 0;
}

References DBGC, ENODEV, usb_device::ep, usb_endpoint::fill, usb_endpoint::halted, usb_endpoint::host, iob_len(), list_empty, usb_endpoint::mtu, usb_device::name, port, usb_device::port, rc, usb_endpoint_host_operations::stream, strerror(), usb_endpoint::usb, usb_port::usb, usb_endpoint_name(), and usb_endpoint_reset().

Referenced by acm_out_transmit(), axge_out_transmit(), dm96xx_out_transmit(), ecm_out_transmit(), efi_usb_sync_transfer(), imux_tx(), iphone_out_transmit(), ncm_out_transmit(), smsc75xx_out_transmit(), smsc95xx_out_transmit(), usb_refill_limit(), usbblk_out_command(), and usbblk_out_data().

◆ usb_complete_err()

void usb_complete_err	(	struct usb_endpoint *	ep,
		struct io_buffer *	iobuf,
		int	rc )

extern

Complete transfer (possibly with error).

Parameters

ep	USB endpoint
iobuf	I/O buffer
rc	Completion status code

Definition at line 586 of file usb.c.

                                 {
        struct usb_device *usb = ep->usb;
 
        /* Decrement fill level */
        assert ( ep->fill > 0 );
        ep->fill--;
 
        /* Schedule reset, if applicable */
        if ( ( rc != 0 ) && ep->open ) {
                DBGC ( usb, "USB %s %s completion failed: %s\n",
                       usb->name, usb_endpoint_name ( ep ), strerror ( rc ) );
                list_del ( &ep->halted );
                list_add_tail ( &ep->halted, &usb_halted );
        }
 
        /* Report completion */
        ep->driver->complete ( ep, iobuf, rc );
}

References assert, usb_endpoint_driver_operations::complete, DBGC, usb_endpoint::driver, usb_device::ep, usb_endpoint::fill, usb_endpoint::halted, list_add_tail, list_del, usb_device::name, usb_endpoint::open, rc, strerror(), usb_endpoint::usb, usb_endpoint_name(), and usb_halted.

Referenced by ehci_endpoint_close(), ehci_endpoint_poll(), uhci_endpoint_close(), uhci_endpoint_poll(), usb_complete(), usbio_bulk_in_poll(), usbio_bulk_out_poll(), usbio_control_poll(), usbio_endpoint_close(), xhci_endpoint_close(), and xhci_transfer().

◆ usb_refill_init()

void usb_refill_init	(	struct usb_endpoint *	ep,
		size_t	reserve,
		size_t	len,
		unsigned int	max )

inlinestatic

Initialise USB endpoint refill.

Parameters

ep	USB endpoint
reserve	Refill buffer reserved header length
len	Refill buffer payload length (zero for endpoint's MTU)
max	Maximum fill level

Definition at line 627 of file usb.h.

                                     {
 
        INIT_LIST_HEAD ( &ep->recycled );
        ep->reserve = reserve;
        ep->len = len;
        ep->max = max;
}

References INIT_LIST_HEAD, len, usb_endpoint::len, max, usb_endpoint::max, usb_endpoint::recycled, and usb_endpoint::reserve.

Referenced by acm_probe(), axge_probe(), dm96xx_probe(), ecm_probe(), efi_usb_async_start(), hub_probe(), imux_probe(), iphone_probe(), lan78xx_probe(), ncm_in_prefill(), ncm_probe(), smsc75xx_probe(), smsc95xx_probe(), smscusb_init(), usbblk_probe(), and usbkbd_probe().

◆ usb_recycle()

void usb_recycle	(	struct usb_endpoint *	ep,
		struct io_buffer *	iobuf )

inlinestatic

Recycle I/O buffer.

Parameters

ep	USB endpoint
iobuf	I/O buffer

Definition at line 643 of file usb.h.

                                                                 {
 
        list_add_tail ( &iobuf->list, &ep->recycled );
}

References io_buffer::list, list_add_tail, and usb_endpoint::recycled.

Referenced by efi_usb_async_complete(), hub_complete(), ncm_in_complete(), and usbkbd_complete().

◆ usb_prefill()

int usb_prefill ( struct usb_endpoint * ep )

extern

Prefill endpoint recycled buffer list.

Parameters

ep	USB endpoint

Return values

rc	Return status code

Definition at line 619 of file usb.c.

                                            {
        struct io_buffer *iobuf;
        size_t reserve = ep->reserve;
        size_t len = ( ep->len ? ep->len : ep->mtu );
        unsigned int fill;
        int rc;
 
        /* Sanity checks */
        assert ( ep->fill == 0 );
        assert ( ep->max > 0 );
        assert ( list_empty ( &ep->recycled ) );
 
        /* Fill recycled buffer list */
        for ( fill = 0 ; fill < ep->max ; fill++ ) {
 
                /* Allocate I/O buffer */
                iobuf = alloc_iob ( reserve + len );
                if ( ! iobuf ) {
                        rc = -ENOMEM;
                        goto err_alloc;
                }
                iob_reserve ( iobuf, reserve );
 
                /* Add to recycled buffer list */
                list_add_tail ( &iobuf->list, &ep->recycled );
        }
 
        return 0;
 
 err_alloc:
        usb_flush ( ep );
        return rc;
}

References alloc_iob(), assert, ENOMEM, fill, usb_endpoint::fill, iob_reserve, len, usb_endpoint::len, io_buffer::list, list_add_tail, list_empty, usb_endpoint::max, usb_endpoint::mtu, rc, usb_endpoint::recycled, usb_endpoint::reserve, and usb_flush().

Referenced by efi_usb_async_start(), and ncm_in_prefill().

◆ usb_refill_limit()

int usb_refill_limit	(	struct usb_endpoint *	ep,
		unsigned int	max )

extern

Refill endpoint up to specified limit.

Parameters

ep	USB endpoint
max	Fill limit

Return values

rc	Return status code

Definition at line 660 of file usb.c.

                                                                   {
        struct io_buffer *iobuf;
        size_t reserve = ep->reserve;
        size_t len = ( ep->len ? ep->len : ep->mtu );
        int rc;
 
        /* Sanity checks */
        assert ( ep->open );
        assert ( ep->max > 0 );
 
        /* Refill endpoint */
        if ( max > ep->max )
                max = ep->max;
        while ( ep->fill < max ) {
 
                /* Get or allocate buffer */
                if ( list_empty ( &ep->recycled ) ) {
                        /* Recycled buffer list is empty; allocate new buffer */
                        iobuf = alloc_iob ( reserve + len );
                        if ( ! iobuf )
                                return -ENOMEM;
                        iob_reserve ( iobuf, reserve );
                } else {
                        /* Get buffer from recycled buffer list */
                        iobuf = list_first_entry ( &ep->recycled,
                                                   struct io_buffer, list );
                        assert ( iobuf != NULL );
                        list_del ( &iobuf->list );
                }
 
                /* Reset buffer to maximum size */
                assert ( iob_len ( iobuf ) <= len );
                iob_put ( iobuf, ( len - iob_len ( iobuf ) ) );
 
                /* Enqueue buffer */
                if ( ( rc = usb_stream ( ep, iobuf, 0 ) ) != 0 ) {
                        list_add ( &iobuf->list, &ep->recycled );
                        return rc;
                }
        }
 
        return 0;
}

References alloc_iob(), assert, ENOMEM, usb_endpoint::fill, iob_len(), iob_put, iob_reserve, len, usb_endpoint::len, io_buffer::list, list_add, list_del, list_empty, list_first_entry, max, usb_endpoint::max, usb_endpoint::mtu, NULL, usb_endpoint::open, rc, usb_endpoint::recycled, usb_endpoint::reserve, and usb_stream().

Referenced by usb_refill(), and usbblk_in_refill().

◆ usb_refill()

int usb_refill ( struct usb_endpoint * ep )

extern

Refill endpoint.

Parameters

ep	USB endpoint

Return values

rc	Return status code

Definition at line 710 of file usb.c.

                                           {
        return usb_refill_limit ( ep, ep->max );
}

References usb_endpoint::max, and usb_refill_limit().

Referenced by efi_usb_timer(), hub_refill(), usbhid_open(), usbhid_refill(), usbkbd_iskey(), usbnet_open(), and usbnet_refill().

◆ usb_flush()

void usb_flush ( struct usb_endpoint * ep )

extern

Discard endpoint recycled buffer list.

Parameters

ep	USB endpoint

Definition at line 719 of file usb.c.

                                           {
        struct io_buffer *iobuf;
        struct io_buffer *tmp;
 
        /* Sanity checks */
        assert ( ! ep->open );
        assert ( ep->max > 0 );
 
        /* Free all I/O buffers */
        list_for_each_entry_safe ( iobuf, tmp, &ep->recycled, list ) {
                list_del ( &iobuf->list );
                free_iob ( iobuf );
        }
}

References assert, free_iob(), io_buffer::list, list_del, list_for_each_entry_safe, usb_endpoint::max, usb_endpoint::open, usb_endpoint::recycled, and tmp.

Referenced by ncm_open(), usb_endpoint_close(), usb_endpoint_open(), and usb_prefill().

◆ usb_func_set_drvdata()

void usb_func_set_drvdata	(	struct usb_function *	func,
		void *	priv )

inlinestatic

Set USB function driver private data.

Parameters

func	USB function
priv	Driver private data

Definition at line 717 of file usb.h.

                                                               {
        func->priv = priv;
}

References priv, and usb_function::priv.

Referenced by acm_probe(), axge_probe(), dm96xx_probe(), ecm_probe(), efi_usb_probe(), hub_probe(), imux_probe(), iphone_probe(), lan78xx_probe(), ncm_probe(), smsc75xx_probe(), smsc95xx_probe(), usbblk_probe(), and usbkbd_probe().

◆ usb_func_get_drvdata()

void * usb_func_get_drvdata ( struct usb_function * func )

inlinestatic

Get USB function driver private data.

Parameters

function USB function

Return values

priv	Driver private data

Definition at line 728 of file usb.h.

                                                   {
        return func->priv;
}

References usb_function::priv.

Referenced by acm_remove(), axge_remove(), dm96xx_remove(), ecm_remove(), efi_usb_remove(), hub_remove(), imux_remove(), iphone_remove(), lan78xx_remove(), ncm_remove(), smsc75xx_remove(), smsc95xx_remove(), usbblk_remove(), and usbkbd_remove().

◆ usb_set_hostdata()

void usb_set_hostdata	(	struct usb_device *	usb,
		void *	priv )

inlinestatic

Set USB device host controller private data.

Parameters

usb	USB device
priv	Host controller private data

Definition at line 794 of file usb.h.

                                                        {
        usb->priv = priv;
}

References priv, and usb_device::priv.

Referenced by ehci_device_open(), uhci_device_open(), usbio_device_open(), and xhci_device_open().

◆ usb_get_hostdata()

void * usb_get_hostdata ( struct usb_device * usb )

inlinestatic

Get USB device host controller private data.

Parameters

usb	USB device

Return values

priv	Host controller private data

Definition at line 805 of file usb.h.

                                            {
        return usb->priv;
}

References usb_device::priv.

Referenced by ehci_device_address(), ehci_device_close(), ehci_endpoint_open(), uhci_device_address(), uhci_device_close(), uhci_endpoint_open(), xhci_device_address(), xhci_device_close(), xhci_device_open(), xhci_endpoint_open(), and xhci_hub_open().

◆ usb_endpoint()

struct usb_endpoint * usb_endpoint	(	struct usb_device *	usb,
		unsigned int	address )

inlinestatic

Get USB endpoint.

Parameters

usb	USB device
address	Endpoint address

Return values

ep	USB endpoint, or NULL if not opened

Definition at line 816 of file usb.h.

                                                                          {
 
        return usb->ep[ USB_ENDPOINT_IDX ( address ) ];
}

References address, usb_device::ep, usb_endpoint::usb, and USB_ENDPOINT_IDX.

Referenced by ehci_device_address(), and uhci_device_address().

◆ usb_hub_set_drvdata()

void usb_hub_set_drvdata	(	struct usb_hub *	hub,
		void *	priv )

inlinestatic

Set USB hub driver private data.

Parameters

hub	USB hub
priv	Driver private data

Definition at line 947 of file usb.h.

                                                        {
        hub->priv = priv;
}

References priv, and usb_hub::priv.

Referenced by ehci_probe(), hub_probe(), uhci_probe(), usbio_start(), and xhci_register().

◆ usb_hub_get_drvdata()

void * usb_hub_get_drvdata ( struct usb_hub * hub )

inlinestatic

Get USB hub driver private data.

Parameters

hub USB hub

Return values

priv	Driver private data

Definition at line 958 of file usb.h.

                                            {
        return hub->priv;
}

References usb_hub::priv.

Referenced by ehci_root_clear_tt(), ehci_root_close(), ehci_root_disable(), ehci_root_enable(), ehci_root_open(), ehci_root_poll(), ehci_root_speed(), hub_clear_tt(), hub_close(), hub_disable(), hub_enable(), hub_open(), hub_speed(), uhci_root_clear_tt(), uhci_root_disable(), uhci_root_enable(), uhci_root_poll(), uhci_root_speed(), xhci_root_clear_tt(), xhci_root_disable(), xhci_root_enable(), xhci_root_open(), and xhci_root_speed().

◆ usb_port()

struct usb_port * usb_port	(	struct usb_hub *	hub,
		unsigned int	address )

inlinestatic

Get USB port.

Parameters

hub	USB hub
address	Port address

Return values

port USB port

Definition at line 970 of file usb.h.

                                                       {
 
        return &hub->port[ address - 1 ];
}

References address, usb_port::hub, and usb_hub::port.

Referenced by alloc_usb_hub(), ehci_probe(), free_usb_hub(), hub_remove(), register_usb_hub(), uhci_probe(), unregister_usb_hub(), usbio_start(), xhci_port_status(), xhci_register(), and xhci_root_open().

◆ usb_bus_set_hostdata()

void usb_bus_set_hostdata	(	struct usb_bus *	bus,
		void *	priv )

inlinestatic

Set USB bus host controller private data.

Parameters

bus	USB bus
priv	Host controller private data

Definition at line 1061 of file usb.h.

                                                         {
        bus->priv = priv;
}

References bus, and priv.

Referenced by ehci_probe(), uhci_probe(), usbio_start(), and xhci_register().

◆ usb_bus_get_hostdata()

void * usb_bus_get_hostdata ( struct usb_bus * bus )

inlinestatic

Get USB bus host controller private data.

Parameters

bus USB bus

Return values

priv	Host controller private data

Definition at line 1072 of file usb.h.

                                             {
        return bus->priv;
}

References bus.

Referenced by ehci_bus_close(), ehci_bus_open(), ehci_bus_poll(), ehci_device_open(), uhci_bus_close(), uhci_bus_open(), uhci_bus_poll(), uhci_device_open(), usbio_bus_poll(), usbio_device_open(), usbio_endpoint_open(), xhci_bus_close(), xhci_bus_open(), xhci_bus_poll(), and xhci_device_open().

◆ usb_poll()

void usb_poll ( struct usb_bus * bus )

inlinestatic

Poll USB bus.

Parameters

bus USB bus

Definition at line 1082 of file usb.h.

                                 {
        bus->host->poll ( bus );
}

References bus.

Referenced by acm_poll(), axge_poll(), dm96xx_poll(), ecm_poll(), efi_usb_sync_transfer(), efi_usb_timer(), ehci_poll_companions(), imux_step(), iphone_poll(), ncm_poll(), register_usb_hub(), smsc75xx_poll(), smsc95xx_poll(), usb_control(), usb_step(), and usbkbd_iskey().

◆ usb_complete()

void usb_complete	(	struct usb_endpoint *	ep,
		struct io_buffer *	iobuf )

inlinestatic

Complete transfer (without error).

Parameters

ep	USB endpoint
iobuf	I/O buffer

Definition at line 1097 of file usb.h.

                                                                  {
        usb_complete_err ( ep, iobuf, 0 );
}

References usb_complete_err().

Referenced by ehci_endpoint_poll(), uhci_endpoint_poll(), usbio_bulk_in_poll(), usbio_bulk_out_poll(), usbio_control_poll(), usbio_interrupt_poll(), and xhci_transfer().

◆ usb_control()

int usb_control	(	struct usb_device *	usb,
		unsigned int	request,
		unsigned int	value,
		unsigned int	index,
		void *	data,
		size_t	len )

extern

Issue USB control transaction.

Parameters

usb	USB device
request	Request
value	Value parameter
index	Index parameter
data	Data buffer (if any)
len	Length of data

Return values

rc	Return status code

Definition at line 783 of file usb.c.

                               {
        struct usb_bus *bus = usb->port->hub->bus;
        struct usb_endpoint *ep = &usb->control;
        struct io_buffer *iobuf;
        struct io_buffer *cmplt;
        union {
                struct usb_setup_packet setup;
                struct usb_control_pseudo_header pshdr;
        } *headroom;
        struct usb_control_pseudo_header *pshdr;
        unsigned int i;
        int rc;
 
        /* Allocate I/O buffer */
        iobuf = alloc_iob ( sizeof ( *headroom ) + len );
        if ( ! iobuf ) {
                rc = -ENOMEM;
                goto err_alloc;
        }
        iob_reserve ( iobuf, sizeof ( *headroom ) );
        iob_put ( iobuf, len );
        if ( request & USB_DIR_IN ) {
                memset ( data, 0, len );
        } else {
                memcpy ( iobuf->data, data, len );
        }
 
        /* Enqueue message */
        if ( ( rc = usb_message ( ep, request, value, index, iobuf ) ) != 0 )
                goto err_message;
 
        /* Wait for completion */
        for ( i = 0 ; i < USB_CONTROL_MAX_WAIT_MS ; i++ ) {
 
                /* Poll bus */
                usb_poll ( bus );
 
                /* Check for completion */
                while ( ( cmplt = list_first_entry ( &usb->complete,
                                                     struct io_buffer,
                                                     list ) ) ) {
 
                        /* Remove from completion list */
                        list_del ( &cmplt->list );
 
                        /* Extract and strip completion status */
                        pshdr = cmplt->data;
                        iob_pull ( cmplt, sizeof ( *pshdr ) );
                        rc = pshdr->rc;
 
                        /* Discard stale completions */
                        if ( cmplt != iobuf ) {
                                DBGC ( usb, "USB %s stale control completion: "
                                       "%s\n", usb->name, strerror ( rc ) );
                                DBGC_HDA ( usb, 0, cmplt->data,
                                           iob_len ( cmplt ) );
                                free_iob ( cmplt );
                                continue;
                        }
 
                        /* Fail immediately if completion was in error */
                        if ( rc != 0 ) {
                                DBGC ( usb, "USB %s control %04x:%04x:%04x "
                                       "failed: %s\n", usb->name, request,
                                       value, index, strerror ( rc ) );
                                free_iob ( cmplt );
                                usb_endpoint_reset ( ep );
                                return rc;
                        }
 
                        /* Copy completion to data buffer, if applicable */
                        assert ( iob_len ( cmplt ) <= len );
                        if ( request & USB_DIR_IN )
                                memcpy ( data, cmplt->data, iob_len ( cmplt ) );
                        free_iob ( cmplt );
                        return 0;
                }
 
                /* Delay */
                mdelay ( 1 );
        }
 
        DBGC ( usb, "USB %s timed out waiting for control %04x:%04x:%04x\n",
               usb->name, request, value, index );
        return -ETIMEDOUT;
 
 err_message:
        free_iob ( iobuf );
 err_alloc:
        return rc;
}

References alloc_iob(), assert, bus, usb_hub::bus, usb_device::complete, usb_device::control, data, io_buffer::data, DBGC, DBGC_HDA, ENOMEM, ETIMEDOUT, free_iob(), usb_port::hub, index, iob_len(), iob_pull, iob_put, iob_reserve, len, io_buffer::list, list_del, list_first_entry, mdelay(), memcpy(), memset(), usb_device::name, usb_device::port, rc, usb_control_pseudo_header::rc, request, strerror(), usb_endpoint::usb, USB_CONTROL_MAX_WAIT_MS, USB_DIR_IN, usb_endpoint_reset(), usb_message(), usb_poll(), and value.

Referenced by axge_read_register(), axge_write_register(), cdc_get_encapsulated_response(), cdc_send_encapsulated_command(), dm96xx_read_registers(), dm96xx_write_register(), dm96xx_write_registers(), ecm_open(), efi_usb_control_transfer(), iphone_check_link(), iphone_probe(), ncm_open(), ncm_probe(), smscusb_get_statistics(), smscusb_raw_readl(), smscusb_raw_writel(), usb_clear_feature(), usb_get_descriptor(), usb_get_status(), usb_hub_clear_tt_buffer(), usb_hub_set_hub_depth(), usb_set_address(), usb_set_configuration(), usb_set_feature(), usb_set_interface(), usbblk_open(), usbhid_set_idle(), usbhid_set_protocol(), and usbhid_set_report().

◆ usb_get_string_descriptor()

int usb_get_string_descriptor	(	struct usb_device *	usb,
		unsigned int	index,
		unsigned int	language,
		char *	buf,
		size_t	len )

extern

Get USB string descriptor.

Parameters

usb	USB device
index	String index
language	Language ID, or 0 to use default
buf	Data buffer
len	Length of buffer

Return values

len	String length (excluding NUL), or negative error

Definition at line 915 of file usb.c.

                                                                               {
        struct {
                struct usb_descriptor_header header;
                uint16_t character[len];
        } __attribute__ (( packed )) *desc;
        unsigned int actual;
        unsigned int i;
        int rc;
 
        /* Use default language ID, if applicable */
        if ( ( language == 0 ) && ( index != 0 ) ) {
                if ( ! usb->language )
                        usb->language = usb_get_default_language ( usb );
                language = usb->language;
        }
 
        /* Allocate buffer for string */
        desc = malloc ( sizeof ( *desc ) );
        if ( ! desc ) {
                rc = -ENOMEM;
                goto err_alloc;
        }
 
        /* Get descriptor */
        if ( ( rc = usb_get_descriptor ( usb, 0, USB_STRING_DESCRIPTOR, index,
                                         language, &desc->header,
                                         sizeof ( *desc ) ) ) != 0 )
                goto err_get_descriptor;
 
        /* Calculate string length */
        if ( desc->header.len < sizeof ( desc->header ) ) {
                rc = -EINVAL;
                goto err_len;
        }
        actual = ( ( desc->header.len - sizeof ( desc->header ) ) /
                   sizeof ( desc->character[0] ) );
 
        /* Copy to buffer */
        memset ( buf, 0, len );
        for ( i = 0 ; ( ( i < actual ) && ( i < len ) ) ; i++ )
                buf[i] = le16_to_cpu ( desc->character[i] );
 
        /* Free buffer */
        free ( desc );
 
        return actual;
 
 err_len:
 err_get_descriptor:
        free ( desc );
 err_alloc:
        return rc;
}

References __attribute__, desc, EINVAL, ENOMEM, free, header, index, usb_device::language, le16_to_cpu, len, malloc(), memset(), rc, usb_get_default_language(), usb_get_descriptor(), and USB_STRING_DESCRIPTOR.

Referenced by ecm_fetch_mac(), and usb_settings_fetch().

◆ usb_get_status()

int usb_get_status	(	struct usb_device *	usb,
		unsigned int	type,
		unsigned int	index,
		void *	data,
		size_t	len )

inlinestatic

Get status.

Parameters

usb	USB device
type	Request type
index	Target index
data	Status to fill in
len	Length of status descriptor

Return values

rc	Return status code

Definition at line 1120 of file usb.h.

                                          {
 
        return usb_control ( usb, ( USB_GET_STATUS | type ), 0, index,
                             data, len );
}

References data, index, len, type, usb_control(), and USB_GET_STATUS.

Referenced by usb_hub_get_port_status().

◆ usb_clear_feature()

int usb_clear_feature	(	struct usb_device *	usb,
		unsigned int	type,
		unsigned int	feature,
		unsigned int	index )

inlinestatic

Clear feature.

Parameters

usb	USB device
type	Request type
feature	Feature selector
index	Target index

Return values

rc	Return status code

Definition at line 1137 of file usb.h.

                                                               {
 
        return usb_control ( usb, ( USB_CLEAR_FEATURE | type ),
                             feature, index, NULL, 0 );
}

References index, NULL, type, USB_CLEAR_FEATURE, and usb_control().

Referenced by usb_endpoint_clear_halt(), and usb_hub_clear_port_feature().

◆ usb_set_feature()

int usb_set_feature	(	struct usb_device *	usb,
		unsigned int	type,
		unsigned int	feature,
		unsigned int	index )

inlinestatic

Set feature.

Parameters

usb	USB device
type	Request type
feature	Feature selector
index	Target index

Return values

rc	Return status code

Definition at line 1154 of file usb.h.

                                                             {
 
        return usb_control ( usb, ( USB_SET_FEATURE | type ),
                             feature, index, NULL, 0 );
}

References index, NULL, type, usb_control(), and USB_SET_FEATURE.

Referenced by usb_hub_set_port_feature().

◆ usb_set_address()

int usb_set_address	(	struct usb_device *	usb,
		unsigned int	address )

inlinestatic

Set address.

Parameters

usb	USB device
address	Device address

Return values

rc	Return status code

Definition at line 1169 of file usb.h.

                                                                 {
 
        return usb_control ( usb, USB_SET_ADDRESS, address, 0, NULL, 0 );
}

References address, NULL, usb_control(), and USB_SET_ADDRESS.

Referenced by ehci_device_address(), and uhci_device_address().

◆ usb_get_descriptor()

int usb_get_descriptor	(	struct usb_device *	usb,
		unsigned int	type,
		unsigned int	desc,
		unsigned int	index,
		unsigned int	language,
		struct usb_descriptor_header *	data,
		size_t	len )

inlinestatic

Get USB descriptor.

Parameters

usb	USB device
type	Request type
desc	Descriptor type
index	Descriptor index
language	Language ID (for string descriptors)
data	Descriptor to fill in
len	Maximum length of descriptor

Return values

rc	Return status code

Definition at line 1187 of file usb.h.

                                  {
 
        return usb_control ( usb, ( USB_GET_DESCRIPTOR | type ),
                             ( ( desc << 8 ) | index ), language, data, len );
}

References data, desc, index, len, type, usb_control(), and USB_GET_DESCRIPTOR.

Referenced by efi_usb_get_string_descriptor(), efi_usb_probe(), usb_get_config_descriptor(), usb_get_default_language(), usb_get_device_descriptor(), usb_get_mtu(), usb_get_string_descriptor(), and usb_hub_get_descriptor().

◆ usb_get_mtu()

int usb_get_mtu	(	struct usb_device *	usb,
		struct usb_device_descriptor *	data )

inlinestatic

Get first part of USB device descriptor (up to and including MTU).

Parameters

usb	USB device
data	Device descriptor to (partially) fill in

Return values

rc	Return status code

Definition at line 1204 of file usb.h.

                                                                           {
 
        return usb_get_descriptor ( usb, 0, USB_DEVICE_DESCRIPTOR, 0, 0,
                                    &data->header,
                                    ( offsetof ( typeof ( *data ), mtu ) +
                                      sizeof ( data->mtu ) ) );
}

References data, mtu, offsetof, typeof(), USB_DEVICE_DESCRIPTOR, and usb_get_descriptor().

Referenced by register_usb().

◆ usb_get_device_descriptor()

int usb_get_device_descriptor	(	struct usb_device *	usb,
		struct usb_device_descriptor *	data )

inlinestatic

Get USB device descriptor.

Parameters

usb	USB device
data	Device descriptor to fill in

Return values

rc	Return status code

Definition at line 1220 of file usb.h.

                                                                 {
 
        return usb_get_descriptor ( usb, 0, USB_DEVICE_DESCRIPTOR, 0, 0,
                                    &data->header, sizeof ( *data ) );
}

References data, USB_DEVICE_DESCRIPTOR, and usb_get_descriptor().

Referenced by register_usb().

◆ usb_get_config_descriptor()

int usb_get_config_descriptor	(	struct usb_device *	usb,
		unsigned int	index,
		struct usb_configuration_descriptor *	data,
		size_t	len )

inlinestatic

Get USB configuration descriptor.

Parameters

usb	USB device
index	Configuration index
data	Configuration descriptor to fill in

Return values

rc	Return status code

Definition at line 1236 of file usb.h.

                                         {
 
        return usb_get_descriptor ( usb, 0, USB_CONFIGURATION_DESCRIPTOR, index,
                                    0, &data->header, len );
}

References data, index, len, USB_CONFIGURATION_DESCRIPTOR, and usb_get_descriptor().

Referenced by usb_config_descriptor().

◆ usb_set_configuration()

int usb_set_configuration	(	struct usb_device *	usb,
		unsigned int	index )

inlinestatic

Set USB configuration.

Parameters

usb	USB device
index	Configuration index

Return values

rc	Return status code

Definition at line 1252 of file usb.h.

                                                                     {
 
        return usb_control ( usb, USB_SET_CONFIGURATION, index, 0, NULL, 0 );
}

References index, NULL, usb_control(), and USB_SET_CONFIGURATION.

Referenced by axge_open(), usb_autoconfigure(), and usb_deconfigure().

◆ usb_set_interface()

int usb_set_interface	(	struct usb_device *	usb,
		unsigned int	interface,
		unsigned int	alternate )

inlinestatic

Set USB interface alternate setting.

Parameters

usb	USB device
interface	Interface number
alternate	Alternate setting

Return values

rc	Return status code

Definition at line 1266 of file usb.h.

                                             {
 
        return usb_control ( usb, USB_SET_INTERFACE, alternate, interface,
                             NULL, 0 );
}

References alternate, NULL, usb_control(), and USB_SET_INTERFACE.

Referenced by usbnet_close(), and usbnet_open().

◆ usb_depth()

unsigned int usb_depth ( struct usb_device * usb )

inlinestatic

Get USB depth.

Parameters

usb	USB device

Return values

depth Hub depth

Definition at line 1279 of file usb.h.

                                                                {
        struct usb_device *parent;
        unsigned int depth;
 
        /* Navigate up to root hub, constructing depth as we go */
        for ( depth = 0 ; ( parent = usb->port->hub->usb ) ; usb = parent )
                depth++;
 
        return depth;
}

References usb_port::hub, usb_device::port, and usb_hub::usb.

Referenced by efi_usb_path(), and hub_probe().

◆ usb_interface_descriptor()

struct usb_interface_descriptor * usb_interface_descriptor	(	struct usb_configuration_descriptor *	config,
		unsigned int	interface,
		unsigned int	alternate )

extern

Locate USB interface descriptor.

Parameters

config	Configuraton descriptor
interface	Interface number
alternate	Alternate setting

Return values

desc	Interface descriptor, or NULL if not found

Definition at line 143 of file usb.c.

                                                                            {
        struct usb_interface_descriptor *desc;
 
        /* Find a matching interface descriptor */
        for_each_config_descriptor ( desc, config, USB_INTERFACE_DESCRIPTOR ) {
                if ( ( desc->interface == interface ) &&
                     ( desc->alternate == alternate ) )
                        return desc;
        }
        return NULL;
}

References alternate, desc, for_each_config_descriptor, NULL, and USB_INTERFACE_DESCRIPTOR.

Referenced by ecm_probe(), efi_usb_get_interface_descriptor(), ncm_probe(), usbblk_probe(), usbhid_describe(), usbnet_comms_describe(), and usbnet_data_describe().

◆ usb_endpoint_descriptor()

struct usb_endpoint_descriptor * usb_endpoint_descriptor	(	struct usb_configuration_descriptor *	config,
		struct usb_interface_descriptor *	interface,
		unsigned int	type,
		unsigned int	index )

extern

Locate USB endpoint descriptor.

Parameters

config	Configuration descriptor
interface	Interface descriptor
type	Endpoint (internal) type
index	Endpoint index

Return values

desc	Descriptor, or NULL if not found

Definition at line 166 of file usb.c.

                                                                  {
        struct usb_endpoint_descriptor *desc;
        unsigned int attributes = ( type & USB_ENDPOINT_ATTR_TYPE_MASK );
        unsigned int direction = ( type & USB_DIR_IN );
 
        /* Find a matching endpoint descriptor */
        for_each_interface_descriptor ( desc, config, interface,
                                        USB_ENDPOINT_DESCRIPTOR ) {
                if ( ( ( desc->attributes &
                         USB_ENDPOINT_ATTR_TYPE_MASK ) == attributes ) &&
                     ( ( desc->endpoint & USB_DIR_IN ) == direction ) &&
                     ( index-- == 0 ) )
                        return desc;
        }
        return NULL;
}

References usb_endpoint_descriptor::attributes, desc, direction, for_each_interface_descriptor, index, NULL, type, USB_DIR_IN, USB_ENDPOINT_ATTR_TYPE_MASK, and USB_ENDPOINT_DESCRIPTOR.

Referenced by usb_endpoint_described().

◆ usb_endpoint_companion_descriptor()

struct usb_endpoint_companion_descriptor * usb_endpoint_companion_descriptor	(	struct usb_configuration_descriptor *	config,
		struct usb_endpoint_descriptor *	desc )

extern

Locate USB endpoint companion descriptor.

Parameters

config	Configuration descriptor
desc	Endpoint descriptor

Return values

descx Companion descriptor, or NULL if not found

Definition at line 193 of file usb.c.

                                                                           {
        struct usb_endpoint_companion_descriptor *descx;
 
        /* Get companion descriptor, if present */
        descx = container_of ( usb_next_descriptor ( &desc->header ),
                               struct usb_endpoint_companion_descriptor,
                               header );
        return ( ( usb_is_within_config ( config, &descx->header ) &&
                   ( descx->header.len >= sizeof ( *descx ) ) &&
                   ( descx->header.type == USB_ENDPOINT_COMPANION_DESCRIPTOR ) )
                 ? descx : NULL );
}

References container_of, desc, header, usb_endpoint_companion_descriptor::header, usb_descriptor_header::len, NULL, usb_descriptor_header::type, USB_ENDPOINT_COMPANION_DESCRIPTOR, usb_is_within_config(), and usb_next_descriptor().

Referenced by usb_endpoint_described().

◆ find_usb()

struct usb_device * find_usb	(	struct usb_bus *	bus,
		unsigned int	address )

extern

Find USB device by address.

Parameters

bus	USB bus
address	Device address

Return values

usb	USB device, or NULL if not found

Definition at line 1734 of file usb.c.

                                                                           {
        struct usb_device *usb;
 
        /* Search for a matching non-zero address */
        list_for_each_entry ( usb, &bus->devices, list ) {
                if ( address && ( usb->address == address ) )
                        return usb;
        }
 
        return NULL;
}

References address, usb_device::address, bus, usb_device::list, list_for_each_entry, and NULL.

Referenced by usb_find_next(), and usb_settings_fetch().

◆ alloc_usb_hub()

struct usb_hub * alloc_usb_hub	(	struct usb_bus *	bus,
		struct usb_device *	usb,
		unsigned int	ports,
		struct usb_hub_driver_operations *	driver )

extern

Allocate USB hub.

Parameters

bus	USB bus
usb	Underlying USB device, if any
ports	Number of ports
driver	Hub driver operations

Return values

hub	USB hub, or NULL on allocation failure

Definition at line 1936 of file usb.c.

                                                                            {
        struct usb_hub *hub;
        struct usb_port *port;
        unsigned int i;
 
        /* Allocate and initialise structure */
        hub = zalloc ( sizeof ( *hub ) + ( ports * sizeof ( hub->port[0] ) ) );
        if ( ! hub )
                return NULL;
        hub->name = ( usb ? usb->name : bus->name );
        hub->bus = bus;
        hub->usb = usb;
        if ( usb )
                hub->protocol = usb->port->protocol;
        hub->ports = ports;
        hub->driver = driver;
        hub->host = &bus->op->hub;
 
        /* Initialise port list */
        for ( i = 1 ; i <= hub->ports ; i++ ) {
                port = usb_port ( hub, i );
                port->hub = hub;
                port->address = i;
                if ( usb )
                        port->protocol = usb->port->protocol;
                INIT_LIST_HEAD ( &port->changed );
        }
 
        return hub;
}

References bus, usb_hub::bus, usb_hub::driver, usb_hub::host, usb_port::hub, INIT_LIST_HEAD, usb_device::name, usb_hub::name, NULL, port, usb_device::port, usb_hub::port, usb_hub::ports, usb_hub::protocol, usb_port::protocol, usb_hub::usb, usb_port::usb, usb_port(), and zalloc().

Referenced by alloc_usb_bus(), and hub_probe().

◆ register_usb_hub()

int register_usb_hub ( struct usb_hub * hub )

extern

Register USB hub.

Parameters

hub USB hub

Return values

rc	Return status code

Definition at line 1975 of file usb.c.

                                             {
        struct usb_bus *bus = hub->bus;
        struct usb_port *port;
        unsigned int i;
        int rc;
 
        /* Add to hub list */
        list_add_tail ( &hub->list, &bus->hubs );
 
        /* Open hub (host controller) */
        if ( ( rc = hub->host->open ( hub ) ) != 0 ) {
                DBGC ( hub, "USB hub %s could not open: %s\n",
                       hub->name, strerror ( rc ) );
                goto err_host_open;
        }
 
        /* Open hub (driver) */
        if ( ( rc = hub->driver->open ( hub ) ) != 0 ) {
                DBGC ( hub, "USB hub %s could not open: %s\n",
                       hub->name, strerror ( rc ) );
                goto err_driver_open;
        }
 
        /* Delay to allow ports to stabilise */
        mdelay ( USB_PORT_DELAY_MS );
 
        /* Mark all ports as changed */
        for ( i = 1 ; i <= hub->ports ; i++ ) {
                port = usb_port ( hub, i );
                usb_port_changed ( port );
        }
 
        /* Some hubs seem to defer reporting device connections until
         * their interrupt endpoint is polled for the first time.
         * Poll the bus once now in order to pick up any such
         * connections.
         */
        usb_poll ( bus );
 
        return 0;
 
        hub->driver->close ( hub );
 err_driver_open:
        hub->host->close ( hub );
 err_host_open:
        list_del ( &hub->list );
        return rc;
}

References bus, usb_hub::bus, usb_hub_driver_operations::close, usb_hub_host_operations::close, DBGC, usb_hub::driver, usb_hub::host, usb_bus::hub, usb_port::hub, usb_hub::list, list_add_tail, list_del, mdelay(), usb_hub::name, usb_hub_driver_operations::open, usb_hub_host_operations::open, port, usb_hub::ports, rc, strerror(), usb_poll(), usb_port(), usb_port_changed(), and USB_PORT_DELAY_MS.

Referenced by hub_probe(), and register_usb_bus().

◆ unregister_usb_hub()

void unregister_usb_hub ( struct usb_hub * hub )

extern

Unregister USB hub.

Parameters

hub USB hub

Definition at line 2029 of file usb.c.

                                                {
        struct usb_port *port;
        unsigned int i;
 
        /* Detach all devices */
        for ( i = 1 ; i <= hub->ports ; i++ ) {
                port = usb_port ( hub, i );
                if ( port->attached )
                        usb_detached ( port );
        }
 
        /* Close hub (driver) */
        hub->driver->close ( hub );
 
        /* Close hub (host controller) */
        hub->host->close ( hub );
 
        /* Cancel any pending port status changes */
        for ( i = 1 ; i <= hub->ports ; i++ ) {
                port = usb_port ( hub, i );
                list_del ( &port->changed );
                INIT_LIST_HEAD ( &port->changed );
        }
 
        /* Remove from hub list */
        list_del ( &hub->list );
}

References usb_hub_driver_operations::close, usb_hub_host_operations::close, usb_hub::driver, usb_hub::host, usb_port::hub, INIT_LIST_HEAD, usb_hub::list, list_del, port, usb_hub::ports, usb_detached(), and usb_port().

Referenced by hub_probe(), hub_remove(), register_usb_bus(), and unregister_usb_bus().

◆ free_usb_hub()

void free_usb_hub ( struct usb_hub * hub )

extern

Free USB hub.

Parameters

hub USB hub

Definition at line 2062 of file usb.c.

                                          {
        struct usb_port *port;
        unsigned int i;
 
        /* Sanity checks */
        for ( i = 1 ; i <= hub->ports ; i++ ) {
                port = usb_port ( hub, i );
                assert ( ! port->attached );
                assert ( port->usb == NULL );
                assert ( list_empty ( &port->changed ) );
        }
 
        /* Free hub */
        free ( hub );
}

References assert, free, usb_port::hub, list_empty, NULL, port, usb_hub::ports, and usb_port().

Referenced by alloc_usb_bus(), free_usb_bus(), hub_probe(), and hub_remove().

◆ usb_port_changed()

void usb_port_changed ( struct usb_port * port )

extern

Report port status change.

Parameters

port USB port

Definition at line 1857 of file usb.c.

                                                {
 
        /* Record hub port status change */
        list_del ( &port->changed );
        list_add_tail ( &port->changed, &usb_changed );
}

References list_add_tail, list_del, port, and usb_changed.

Referenced by ehci_root_poll(), hub_complete(), register_usb_hub(), uhci_root_poll(), and xhci_port_status().

◆ alloc_usb_bus()

struct usb_bus * alloc_usb_bus	(	struct device *	dev,
		unsigned int	ports,
		size_t	mtu,
		struct usb_host_operations *	op )

extern

Allocate USB bus.

Parameters

dev	Underlying hardware device
ports	Number of root hub ports
mtu	Largest transfer allowed on the bus
op	Host controller operations

Return values

bus	USB bus, or NULL on allocation failure

Definition at line 2094 of file usb.c.

                                                                              {
        struct usb_bus *bus;
 
        /* Allocate and initialise structure */
        bus = zalloc ( sizeof ( *bus ) );
        if ( ! bus )
                goto err_alloc_bus;
        bus->name = dev->name;
        bus->dev = dev;
        bus->mtu = mtu;
        bus->op = op;
        INIT_LIST_HEAD ( &bus->devices );
        INIT_LIST_HEAD ( &bus->hubs );
        bus->host = &bus->op->bus;
 
        /* Allocate root hub */
        bus->hub = alloc_usb_hub ( bus, NULL, ports, &op->root );
        if ( ! bus->hub )
                goto err_alloc_hub;
 
        return bus;
 
        free_usb_hub ( bus->hub );
 err_alloc_hub:
        free ( bus );
 err_alloc_bus:
        return NULL;
}

References alloc_usb_hub(), bus, usb_bus::dev, free, free_usb_hub(), INIT_LIST_HEAD, mtu, device::name, NULL, op, and zalloc().

Referenced by ehci_probe(), uhci_probe(), usbio_start(), and xhci_register().

◆ register_usb_bus()

int register_usb_bus ( struct usb_bus * bus )

extern

Register USB bus.

Parameters

bus USB bus

Return values

rc	Return status code

Definition at line 2130 of file usb.c.

                                             {
        int rc;
 
        /* Sanity checks */
        assert ( bus->hub != NULL );
 
        /* Assign the first available bus address */
        bus->address = 0;
        while ( find_usb_bus ( bus->address ) != NULL )
                bus->address++;
 
        /* Open bus */
        if ( ( rc = bus->host->open ( bus ) ) != 0 )
                goto err_open;
 
        /* Add to list of USB buses */
        list_add_tail ( &bus->list, &usb_buses );
 
        /* Register root hub */
        if ( ( rc = register_usb_hub ( bus->hub ) ) != 0 )
                goto err_register_hub;
 
        /* Attach any devices already present */
        usb_hotplug();
 
        return 0;
 
        unregister_usb_hub ( bus->hub );
 err_register_hub:
        list_del ( &bus->list );
        bus->host->close ( bus );
 err_open:
        return rc;
}

References assert, bus, find_usb_bus(), list_add_tail, list_del, NULL, rc, register_usb_hub(), unregister_usb_hub(), usb_buses, and usb_hotplug().

Referenced by ehci_probe(), REQUIRING_SYMBOL(), uhci_probe(), usbio_start(), and xhci_register().

◆ unregister_usb_bus()

void unregister_usb_bus ( struct usb_bus * bus )

extern

Unregister USB bus.

Parameters

bus USB bus

Definition at line 2170 of file usb.c.

                                                {
 
        /* Sanity checks */
        assert ( bus->hub != NULL );
 
        /* Unregister root hub */
        unregister_usb_hub ( bus->hub );
 
        /* Remove from list of USB buses */
        list_del ( &bus->list );
 
        /* Close bus */
        bus->host->close ( bus );
 
        /* Sanity checks */
        assert ( list_empty ( &bus->devices ) );
        assert ( list_empty ( &bus->hubs ) );
}

References assert, bus, list_del, list_empty, NULL, and unregister_usb_hub().

Referenced by ehci_probe(), ehci_remove(), uhci_probe(), uhci_remove(), usbio_start(), usbio_stop(), xhci_register(), and xhci_unregister().

◆ free_usb_bus()

void free_usb_bus ( struct usb_bus * bus )

extern

Free USB bus.

Parameters

bus USB bus

Definition at line 2194 of file usb.c.

                                          {
        struct usb_endpoint *ep;
        struct usb_port *port;
 
        /* Sanity checks */
        assert ( list_empty ( &bus->devices ) );
        assert ( list_empty ( &bus->hubs ) );
        list_for_each_entry ( ep, &usb_halted, halted )
                assert ( ep->usb->port->hub->bus != bus );
        list_for_each_entry ( port, &usb_changed, changed )
                assert ( port->hub->bus != bus );
 
        /* Free root hub */
        free_usb_hub ( bus->hub );
 
        /* Free bus */
        free ( bus );
}

References assert, bus, usb_hub::bus, usb_port::changed, free, free_usb_hub(), usb_port::hub, list_empty, list_for_each_entry, port, usb_device::port, usb_endpoint::usb, usb_changed, and usb_halted.

Referenced by ehci_probe(), ehci_remove(), uhci_probe(), uhci_remove(), usbio_start(), usbio_stop(), xhci_register(), and xhci_unregister().

◆ find_usb_bus()

struct usb_bus * find_usb_bus ( unsigned int address )

extern

Find USB bus by address.

Parameters

address Bus address

Return values

bus	USB bus, or NULL

Definition at line 2219 of file usb.c.

                                                       {
        struct usb_bus *bus;
 
        for_each_usb_bus ( bus ) {
                if ( bus->address == address )
                        return bus;
        }
 
        return NULL;
}

References address, bus, for_each_usb_bus, and NULL.

Referenced by register_usb_bus(), usb_find_next(), and usb_settings_fetch().

◆ find_usb_bus_by_location()

struct usb_bus * find_usb_bus_by_location	(	unsigned int	bus_type,
		unsigned int	location )

extern

Find USB bus by device location.

Parameters

bus_type	Bus type
location	Bus location

Return values

bus	USB bus, or NULL

Definition at line 2237 of file usb.c.

                                                                    {
        struct usb_bus *bus;
 
        for_each_usb_bus ( bus ) {
                if ( ( bus->dev->desc.bus_type == bus_type ) &&
                     ( bus->dev->desc.location == location ) )
                        return bus;
        }
 
        return NULL;
}

References bus, for_each_usb_bus, and NULL.

Referenced by uhci_root_speed().

◆ usb_alloc_address()

int usb_alloc_address ( struct usb_bus * bus )

extern

Allocate device address.

Parameters

bus USB bus

Return values

address Device address, or negative error

Definition at line 2263 of file usb.c.

                                              {
        unsigned int address;
 
        /* Find first free device address */
        address = ffsll ( ~bus->addresses );
        if ( ! address )
                return -ENOENT;
 
        /* Mark address as used */
        bus->addresses |= ( 1ULL << ( address - 1 ) );
 
        return address;
}

References address, bus, ENOENT, and ffsll.

Referenced by ehci_device_address(), and uhci_device_address().

◆ usb_free_address()

void usb_free_address	(	struct usb_bus *	bus,
		unsigned int	address )

extern

Free device address.

Parameters

bus	USB bus
address	Device address

Definition at line 2283 of file usb.c.

                                                                    {
 
        /* Sanity check */
        assert ( address > 0 );
        assert ( bus->addresses & ( 1ULL << ( address - 1 ) ) );
 
        /* Mark address as free */
        bus->addresses &= ~( 1ULL << ( address - 1 ) );
}

References address, assert, and bus.

Referenced by ehci_device_address(), ehci_device_close(), uhci_device_address(), and uhci_device_close().

◆ usb_find_next()

int usb_find_next	(	struct usb_device **	usb,
		uint16_t *	busdev )

extern

Find next USB device.

Parameters

usb	USB device to fill in
busdev	Starting bus:dev address

Return values

busdev	Bus:dev address of next USB device
rc	Return status code

Definition at line 2301 of file usb.c.

                                                                {
        struct usb_bus *bus;
 
        do {
                /* Find USB bus, if any */
                bus = find_usb_bus ( USB_BUS ( *busdev ) );
                if ( ! bus ) {
                        *busdev |= ( USB_BUS ( 1 ) - 1 );
                        continue;
                }
 
                /* Find USB device, if any */
                *usb = find_usb ( bus, USB_DEV ( *busdev ) );
                if ( *usb )
                        return 0;
 
        } while ( ++(*busdev) );
 
        return -ENODEV;
}

References bus, ENODEV, find_usb(), find_usb_bus(), USB_BUS, and USB_DEV.

Referenced by usbscan_exec().

◆ usb_route_string()

unsigned int usb_route_string ( struct usb_device * usb )

extern

Get USB route string.

Parameters

usb	USB device

Return values

route USB route string

Definition at line 2335 of file usb.c.

                                                         {
        struct usb_device *parent;
        unsigned int route;
 
        /* Navigate up to root hub, constructing route string as we go */
        for ( route = 0 ; ( parent = usb->port->hub->usb ) ; usb = parent ) {
                route <<= 4;
                route |= ( ( usb->port->address > 0xf ) ?
                           0xf : usb->port->address );
        }
 
        return route;
}

References usb_port::address, usb_port::hub, usb_device::port, route(), and usb_hub::usb.

Referenced by xhci_device_address().

◆ usb_root_hub_port()

struct usb_port * usb_root_hub_port ( struct usb_device * usb )

extern

Get USB root hub port.

Parameters

usb	USB device

Return values

port	Root hub port

Definition at line 2355 of file usb.c.

                                                               {
        struct usb_device *parent;
 
        /* Navigate up to root hub */
        while ( ( parent = usb->port->hub->usb ) )
                usb = parent;
 
        return usb->port;
}

References usb_port::hub, usb_device::port, and usb_hub::usb.

Referenced by xhci_device_address(), and xhci_device_open().

◆ usb_transaction_translator()

struct usb_port * usb_transaction_translator ( struct usb_device * usb )

extern

Get USB transaction translator.

Parameters

usb	USB device

Return values

port	Transaction translator port, or NULL

Definition at line 2371 of file usb.c.

                                                                        {
        struct usb_device *parent;
 
        /* Navigate up to root hub.  If we find a low-speed or
         * full-speed device with a higher-speed parent hub, then that
         * device's port is the transaction translator.
         */
        for ( ; ( parent = usb->port->hub->usb ) ; usb = parent ) {
                if ( ( usb->speed <= USB_SPEED_FULL ) &&
                     ( parent->speed > USB_SPEED_FULL ) )
                        return usb->port;
        }
 
        return NULL;
}

References usb_port::hub, NULL, usb_device::port, usb_device::speed, usb_hub::usb, and USB_SPEED_FULL.

Referenced by ehci_endpoint_capabilities(), usb_endpoint_clear_tt(), and xhci_device_open().

◆ usb_find_driver()

struct usb_driver * usb_find_driver	(	struct usb_function_descriptor *	desc,
		struct usb_device_id **	id )

extern

Find USB device driver.

Parameters

desc	Function descriptor

Return values

id	USB device ID, or NULL
driver	USB device driver, or NULL

Definition at line 1166 of file usb.c.

                                                                  {
        struct usb_driver *driver;
        unsigned int i;
 
        /* Look for a matching driver */
        for_each_table_entry ( driver, USB_DRIVERS ) {
                for ( i = 0 ; i < driver->id_count ; i++ ) {
 
                        /* Ignore non-matching driver class */
                        if ( ( driver->class.class.scalar ^ desc->class.scalar )
                             & driver->class.mask.scalar )
                                continue;
 
                        /* Look for a matching ID */
                        *id = &driver->ids[i];
                        if ( ( ( (*id)->vendor == desc->vendor ) ||
                               ( (*id)->vendor == USB_ANY_ID ) ) &&
                             ( ( (*id)->product == desc->product ) ||
                               ( (*id)->product == USB_ANY_ID ) ) )
                                return driver;
                }
        }
 
        /* Not found */
        *id = NULL;
        return NULL;
}

References usb_class_id::class, usb_driver::class, desc, for_each_table_entry, usb_driver::id_count, usb_driver::ids, usb_class_id::mask, NULL, usb_class_descriptor::scalar, USB_ANY_ID, and USB_DRIVERS.

Referenced by usb_probe(), usb_score(), and usbio_supported().

Variable Documentation

◆ usb_buses

struct list_head usb_buses

extern

List of USB buses.

Definition at line 45 of file usb.c.

Referenced by register_usb_bus().

Data Structures

Macros

Enumerations

Functions

Variables

Detailed Description

Macro Definition Documentation

◆ USB_SPEED

◆ USB_SPEED_MANTISSA

◆ USB_SPEED_EXPONENT

◆ USB_BUSDEV

◆ USB_BUS

◆ USB_DEV

◆ USB_DIR_OUT

◆ USB_DIR_IN

◆ USB_TYPE_STANDARD

◆ USB_TYPE_CLASS

◆ USB_TYPE_VENDOR

◆ USB_RECIP_MASK

◆ USB_RECIP_DEVICE

◆ USB_RECIP_INTERFACE

◆ USB_RECIP_ENDPOINT

◆ USB_REQUEST_TYPE

◆ 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_ENDPOINT_HALT

◆ USB_CLASS_HUB

◆ USB_DEVICE_DESCRIPTOR

◆ USB_CONFIGURATION_DESCRIPTOR

◆ USB_STRING_DESCRIPTOR

◆ USB_LANG_ENGLISH

◆ USB_INTERFACE_DESCRIPTOR

◆ USB_ENDPOINT_DESCRIPTOR

◆ USB_ENDPOINT_ATTR_TYPE_MASK

◆ USB_ENDPOINT_ATTR_PERIODIC

◆ USB_ENDPOINT_ATTR_CONTROL

◆ USB_ENDPOINT_ATTR_BULK

◆ USB_ENDPOINT_ATTR_INTERRUPT

◆ USB_BULK_OUT

◆ USB_BULK_IN

◆ USB_INTERRUPT_IN

◆ USB_INTERRUPT_OUT

◆ USB_ENDPOINT_MTU

◆ USB_ENDPOINT_BURST

◆ USB_ENDPOINT_COMPANION_DESCRIPTOR

◆ USB_INTERFACE_ASSOCIATION_DESCRIPTOR

◆ USB_CS_INTERFACE_DESCRIPTOR

◆ USB_CS_ENDPOINT_DESCRIPTOR

◆ for_each_config_descriptor

◆ for_each_interface_descriptor

◆ USB_EP0_ADDRESS

◆ USB_EP0_ATTRIBUTES

◆ USB_EP0_DEFAULT_MTU

◆ USB_EP0_BURST

◆ USB_EP0_INTERVAL

◆ USB_ENDPOINT_MAX

◆ USB_ENDPOINT_IN

◆ USB_ENDPOINT_IDX

◆ for_each_usb_bus

◆ USB_RESET_DELAY_MS

◆ USB_RESET_RECOVER_DELAY_MS

◆ USB_CONTROL_MAX_WAIT_MS

◆ USB_SET_ADDRESS_RECOVER_DELAY_MS

◆ USB_PORT_DELAY_MS

◆ USB_ID

◆ USB_ROM

◆ USB_ANY_ID

◆ USB_CLASS_ID

◆ USB_DRIVERS

◆ __usb_driver

◆ __usb_fallback_driver

Enumeration Type Documentation