iPXE
Data Structures | Macros | Enumerations | Functions | Variables
usb.h File Reference

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>

Go to the source code of this file.

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

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)
 
static struct usb_descriptor_headerusb_next_descriptor (struct usb_descriptor_header *desc)
 Get next USB descriptor. More...
 
static int usb_is_within_config (struct usb_configuration_descriptor *config, struct usb_descriptor_header *desc)
 Check that descriptor lies within a configuration descriptor. More...
 
static void usb_endpoint_init (struct usb_endpoint *ep, struct usb_device *usb, struct usb_endpoint_driver_operations *driver)
 Initialise USB endpoint. More...
 
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. More...
 
static void usb_endpoint_set_hostdata (struct usb_endpoint *ep, void *priv)
 Set USB endpoint host controller private data. More...
 
static void * usb_endpoint_get_hostdata (struct usb_endpoint *ep)
 Get USB endpoint host controller private data. More...
 
const char * usb_endpoint_name (struct usb_endpoint *ep)
 Get USB endpoint name (for debugging) More...
 
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. More...
 
int usb_endpoint_open (struct usb_endpoint *ep)
 Open USB endpoint. More...
 
int usb_endpoint_clear_halt (struct usb_endpoint *ep)
 Clear endpoint halt (if applicable) More...
 
void usb_endpoint_close (struct usb_endpoint *ep)
 Close USB endpoint. More...
 
int usb_message (struct usb_endpoint *ep, unsigned int request, unsigned int value, unsigned int index, struct io_buffer *iobuf)
 Enqueue USB message transfer. More...
 
int usb_stream (struct usb_endpoint *ep, struct io_buffer *iobuf, int terminate)
 Enqueue USB stream transfer. More...
 
void usb_complete_err (struct usb_endpoint *ep, struct io_buffer *iobuf, int rc)
 Complete transfer (possibly with error) More...
 
static void usb_refill_init (struct usb_endpoint *ep, size_t reserve, size_t len, unsigned int max)
 Initialise USB endpoint refill. More...
 
static void usb_recycle (struct usb_endpoint *ep, struct io_buffer *iobuf)
 Recycle I/O buffer. More...
 
int usb_prefill (struct usb_endpoint *ep)
 Prefill endpoint recycled buffer list. More...
 
int usb_refill_limit (struct usb_endpoint *ep, unsigned int max)
 Refill endpoint up to specified limit. More...
 
int usb_refill (struct usb_endpoint *ep)
 Refill endpoint. More...
 
void usb_flush (struct usb_endpoint *ep)
 Discard endpoint recycled buffer list. More...
 
static void usb_func_set_drvdata (struct usb_function *func, void *priv)
 Set USB function driver private data. More...
 
static void * usb_func_get_drvdata (struct usb_function *func)
 Get USB function driver private data. More...
 
static void usb_set_hostdata (struct usb_device *usb, void *priv)
 Set USB device host controller private data. More...
 
static void * usb_get_hostdata (struct usb_device *usb)
 Get USB device host controller private data. More...
 
static struct usb_endpointusb_endpoint (struct usb_device *usb, unsigned int address)
 Get USB endpoint. More...
 
static void usb_hub_set_drvdata (struct usb_hub *hub, void *priv)
 Set USB hub driver private data. More...
 
static void * usb_hub_get_drvdata (struct usb_hub *hub)
 Get USB hub driver private data. More...
 
static struct usb_portusb_port (struct usb_hub *hub, unsigned int address)
 Get USB port. More...
 
static void usb_bus_set_hostdata (struct usb_bus *bus, void *priv)
 Set USB bus host controller private data. More...
 
static void * usb_bus_get_hostdata (struct usb_bus *bus)
 Get USB bus host controller private data. More...
 
static void usb_poll (struct usb_bus *bus)
 Poll USB bus. More...
 
static void usb_complete (struct usb_endpoint *ep, struct io_buffer *iobuf)
 Complete transfer (without error) More...
 
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. More...
 
int usb_get_string_descriptor (struct usb_device *usb, unsigned int index, unsigned int language, char *buf, size_t len)
 Get USB string descriptor. More...
 
static int usb_get_status (struct usb_device *usb, unsigned int type, unsigned int index, void *data, size_t len)
 Get status. More...
 
static int usb_clear_feature (struct usb_device *usb, unsigned int type, unsigned int feature, unsigned int index)
 Clear feature. More...
 
static int usb_set_feature (struct usb_device *usb, unsigned int type, unsigned int feature, unsigned int index)
 Set feature. More...
 
static int usb_set_address (struct usb_device *usb, unsigned int address)
 Set address. More...
 
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. More...
 
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) More...
 
static int usb_get_device_descriptor (struct usb_device *usb, struct usb_device_descriptor *data)
 Get USB device descriptor. More...
 
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. More...
 
static int usb_set_configuration (struct usb_device *usb, unsigned int index)
 Set USB configuration. More...
 
static int usb_set_interface (struct usb_device *usb, unsigned int interface, unsigned int alternate)
 Set USB interface alternate setting. More...
 
static unsigned int usb_depth (struct usb_device *usb)
 Get USB depth. More...
 
struct usb_interface_descriptorusb_interface_descriptor (struct usb_configuration_descriptor *config, unsigned int interface, unsigned int alternate)
 Locate USB interface descriptor. More...
 
struct usb_endpoint_descriptorusb_endpoint_descriptor (struct usb_configuration_descriptor *config, struct usb_interface_descriptor *interface, unsigned int type, unsigned int index)
 Locate USB endpoint descriptor. More...
 
struct usb_endpoint_companion_descriptorusb_endpoint_companion_descriptor (struct usb_configuration_descriptor *config, struct usb_endpoint_descriptor *desc)
 Locate USB endpoint companion descriptor. More...
 
struct usb_huballoc_usb_hub (struct usb_bus *bus, struct usb_device *usb, unsigned int ports, struct usb_hub_driver_operations *op)
 Allocate USB hub. More...
 
int register_usb_hub (struct usb_hub *hub)
 Register USB hub. More...
 
void unregister_usb_hub (struct usb_hub *hub)
 Unregister USB hub. More...
 
void free_usb_hub (struct usb_hub *hub)
 Free USB hub. More...
 
void usb_port_changed (struct usb_port *port)
 Report port status change. More...
 
struct usb_busalloc_usb_bus (struct device *dev, unsigned int ports, size_t mtu, struct usb_host_operations *op)
 Allocate USB bus. More...
 
int register_usb_bus (struct usb_bus *bus)
 Register USB bus. More...
 
void unregister_usb_bus (struct usb_bus *bus)
 Unregister USB bus. More...
 
void free_usb_bus (struct usb_bus *bus)
 Free USB bus. More...
 
struct usb_busfind_usb_bus_by_location (unsigned int bus_type, unsigned int location)
 Find USB bus by device location. More...
 
int usb_alloc_address (struct usb_bus *bus)
 Allocate device address. More...
 
void usb_free_address (struct usb_bus *bus, unsigned int address)
 Free device address. More...
 
unsigned int usb_route_string (struct usb_device *usb)
 Get USB route string. More...
 
struct usb_portusb_root_hub_port (struct usb_device *usb)
 Get USB root hub port. More...
 
struct usb_portusb_transaction_translator (struct usb_device *usb)
 Get USB transaction translator. More...
 
struct usb_driverusb_find_driver (struct usb_function_descriptor *desc, struct usb_device_id **id)
 Find USB device driver. More...
 

Variables

struct list_head usb_buses
 List of USB buses. More...
 

Detailed Description

Universal Serial Bus (USB)

Definition in file usb.h.

Macro Definition Documentation

◆ USB_SPEED

#define USB_SPEED (   mantissa,
  exponent 
)    ( (exponent << 16) | (mantissa) )

Define a USB speed.

Parameters
mantissaMantissa
exponentExponent (in engineering terms: 1=k, 2=M, 3=G)
Return values
speedUSB speed

Definition at line 35 of file usb.h.

◆ USB_SPEED_MANTISSA

#define USB_SPEED_MANTISSA (   speed)    ( (speed) & 0xffff )

Extract USB speed mantissa.

Definition at line 38 of file usb.h.

◆ USB_SPEED_EXPONENT

#define USB_SPEED_EXPONENT (   speed)    ( ( (speed) >> 16 ) & 0x3 )

Extract USB speed exponent.

Definition at line 41 of file usb.h.

◆ USB_DIR_OUT

#define USB_DIR_OUT   ( 0 << 7 )

Data transfer is from host to device.

Definition at line 80 of file usb.h.

◆ USB_DIR_IN

#define USB_DIR_IN   ( 1 << 7 )

Data transfer is from device to host.

Definition at line 83 of file usb.h.

◆ USB_TYPE_STANDARD

#define USB_TYPE_STANDARD   ( 0 << 5 )

Standard request type.

Definition at line 86 of file usb.h.

◆ USB_TYPE_CLASS

#define USB_TYPE_CLASS   ( 1 << 5 )

Class-specific request type.

Definition at line 89 of file usb.h.

◆ USB_TYPE_VENDOR

#define USB_TYPE_VENDOR   ( 2 << 5 )

Vendor-specific request type.

Definition at line 92 of file usb.h.

◆ USB_RECIP_MASK

#define USB_RECIP_MASK   ( 0x1f << 0 )

Request recipient mask.

Definition at line 95 of file usb.h.

◆ USB_RECIP_DEVICE

#define USB_RECIP_DEVICE   ( 0 << 0 )

Request recipient is the device.

Definition at line 98 of file usb.h.

◆ USB_RECIP_INTERFACE

#define USB_RECIP_INTERFACE   ( 1 << 0 )

Request recipient is an interface.

Definition at line 101 of file usb.h.

◆ USB_RECIP_ENDPOINT

#define USB_RECIP_ENDPOINT   ( 2 << 0 )

Request recipient is an endpoint.

Definition at line 104 of file usb.h.

◆ USB_REQUEST_TYPE

#define USB_REQUEST_TYPE (   type)    ( (type) << 8 )

Construct USB request type.

Definition at line 107 of file usb.h.

◆ USB_GET_STATUS

#define USB_GET_STATUS   ( USB_DIR_IN | USB_REQUEST_TYPE ( 0 ) )

Get status.

Definition at line 110 of file usb.h.

◆ USB_CLEAR_FEATURE

#define USB_CLEAR_FEATURE   ( USB_DIR_OUT | USB_REQUEST_TYPE ( 1 ) )

Clear feature.

Definition at line 113 of file usb.h.

◆ USB_SET_FEATURE

#define USB_SET_FEATURE   ( USB_DIR_OUT | USB_REQUEST_TYPE ( 3 ) )

Set feature.

Definition at line 116 of file usb.h.

◆ USB_SET_ADDRESS

#define USB_SET_ADDRESS   ( USB_DIR_OUT | USB_REQUEST_TYPE ( 5 ) )

Set address.

Definition at line 119 of file usb.h.

◆ USB_GET_DESCRIPTOR

#define USB_GET_DESCRIPTOR   ( USB_DIR_IN | USB_REQUEST_TYPE ( 6 ) )

Get descriptor.

Definition at line 122 of file usb.h.

◆ USB_SET_DESCRIPTOR

#define USB_SET_DESCRIPTOR   ( USB_DIR_OUT | USB_REQUEST_TYPE ( 7 ) )

Set descriptor.

Definition at line 125 of file usb.h.

◆ USB_GET_CONFIGURATION

#define USB_GET_CONFIGURATION   ( USB_DIR_IN | USB_REQUEST_TYPE ( 8 ) )

Get configuration.

Definition at line 128 of file usb.h.

◆ USB_SET_CONFIGURATION

#define USB_SET_CONFIGURATION   ( USB_DIR_OUT | USB_REQUEST_TYPE ( 9 ) )

Set configuration.

Definition at line 131 of file usb.h.

◆ USB_GET_INTERFACE

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

Get interface.

Definition at line 134 of file usb.h.

◆ USB_SET_INTERFACE

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

Set interface.

Definition at line 138 of file usb.h.

◆ USB_ENDPOINT_HALT

#define USB_ENDPOINT_HALT   0

Endpoint halt feature.

Definition at line 142 of file usb.h.

◆ USB_CLASS_HUB

#define USB_CLASS_HUB   9

Class code for USB hubs.

Definition at line 155 of file usb.h.

◆ USB_DEVICE_DESCRIPTOR

#define USB_DEVICE_DESCRIPTOR   1

A USB device descriptor.

Definition at line 192 of file usb.h.

◆ USB_CONFIGURATION_DESCRIPTOR

#define USB_CONFIGURATION_DESCRIPTOR   2

A USB configuration descriptor.

Definition at line 213 of file usb.h.

◆ USB_STRING_DESCRIPTOR

#define USB_STRING_DESCRIPTOR   3

A USB string descriptor.

Definition at line 224 of file usb.h.

◆ USB_LANG_ENGLISH

#define USB_LANG_ENGLISH   0x0409

Language ID for English.

Definition at line 227 of file usb.h.

◆ USB_INTERFACE_DESCRIPTOR

#define USB_INTERFACE_DESCRIPTOR   4

A USB interface descriptor.

Definition at line 246 of file usb.h.

◆ USB_ENDPOINT_DESCRIPTOR

#define USB_ENDPOINT_DESCRIPTOR   5

A USB endpoint descriptor.

Definition at line 263 of file usb.h.

◆ USB_ENDPOINT_ATTR_TYPE_MASK

#define USB_ENDPOINT_ATTR_TYPE_MASK   0x03

Endpoint attribute transfer type mask.

Definition at line 266 of file usb.h.

◆ USB_ENDPOINT_ATTR_PERIODIC

#define USB_ENDPOINT_ATTR_PERIODIC   0x01

Endpoint periodic type.

Definition at line 269 of file usb.h.

◆ USB_ENDPOINT_ATTR_CONTROL

#define USB_ENDPOINT_ATTR_CONTROL   0x00

Control endpoint transfer type.

Definition at line 272 of file usb.h.

◆ USB_ENDPOINT_ATTR_BULK

#define USB_ENDPOINT_ATTR_BULK   0x02

Bulk endpoint transfer type.

Definition at line 275 of file usb.h.

◆ USB_ENDPOINT_ATTR_INTERRUPT

#define USB_ENDPOINT_ATTR_INTERRUPT   0x03

Interrupt endpoint transfer type.

Definition at line 278 of file usb.h.

◆ USB_BULK_OUT

#define USB_BULK_OUT   ( USB_ENDPOINT_ATTR_BULK | USB_DIR_OUT )

Bulk OUT endpoint (internal) type.

Definition at line 281 of file usb.h.

◆ USB_BULK_IN

#define USB_BULK_IN   ( USB_ENDPOINT_ATTR_BULK | USB_DIR_IN )

Bulk IN endpoint (internal) type.

Definition at line 284 of file usb.h.

◆ USB_INTERRUPT_IN

#define USB_INTERRUPT_IN   ( USB_ENDPOINT_ATTR_INTERRUPT | USB_DIR_IN )

Interrupt IN endpoint (internal) type.

Definition at line 287 of file usb.h.

◆ USB_INTERRUPT_OUT

#define USB_INTERRUPT_OUT   ( USB_ENDPOINT_ATTR_INTERRUPT | USB_DIR_OUT )

Interrupt OUT endpoint (internal) type.

Definition at line 290 of file usb.h.

◆ USB_ENDPOINT_MTU

#define USB_ENDPOINT_MTU (   sizes)    ( ( (sizes) >> 0 ) & 0x07ff )

USB endpoint MTU.

Definition at line 293 of file usb.h.

◆ USB_ENDPOINT_BURST

#define USB_ENDPOINT_BURST (   sizes)    ( ( (sizes) >> 11 ) & 0x0003 )

USB endpoint maximum burst size.

Definition at line 296 of file usb.h.

◆ USB_ENDPOINT_COMPANION_DESCRIPTOR

#define USB_ENDPOINT_COMPANION_DESCRIPTOR   48

A USB endpoint companion descriptor.

Definition at line 311 of file usb.h.

◆ USB_INTERFACE_ASSOCIATION_DESCRIPTOR

#define USB_INTERFACE_ASSOCIATION_DESCRIPTOR   11

A USB interface association descriptor.

Definition at line 328 of file usb.h.

◆ USB_CS_INTERFACE_DESCRIPTOR

#define USB_CS_INTERFACE_DESCRIPTOR   36

A class-specific interface descriptor.

Definition at line 331 of file usb.h.

◆ USB_CS_ENDPOINT_DESCRIPTOR

#define USB_CS_ENDPOINT_DESCRIPTOR   37

A class-specific endpoint descriptor.

Definition at line 334 of file usb.h.

◆ for_each_config_descriptor

#define for_each_config_descriptor (   desc,
  config 
)
Value:
for ( desc = container_of ( &(config)->header, \
typeof ( *desc ), header ) ; \
usb_is_within_config ( (config), &desc->header ) ; \
desc = container_of ( usb_next_descriptor ( &desc->header ), \
typeof ( *desc ), header ) )
static struct usb_descriptor_header * usb_next_descriptor(struct usb_descriptor_header *desc)
Get next USB descriptor.
Definition: usb.h:343
#define container_of(ptr, type, field)
Get containing structure.
Definition: stddef.h:35
struct ena_aq_header header
Header.
Definition: ena.h:12
typeof(acpi_finder=acpi_find)
ACPI table finder.
Definition: acpi.c:45

Iterate over all configuration descriptors.

Definition at line 371 of file usb.h.

◆ for_each_interface_descriptor

#define for_each_interface_descriptor (   desc,
  config,
  interface 
)
Value:
header ), \
typeof ( *desc ), header ) ; \
( usb_is_within_config ( (config), &desc->header ) && \
( desc->header.type != USB_INTERFACE_DESCRIPTOR ) ) ; \
desc = container_of ( usb_next_descriptor ( &desc->header ), \
typeof ( *desc ), header ) )
static struct usb_descriptor_header * usb_next_descriptor(struct usb_descriptor_header *desc)
Get next USB descriptor.
Definition: usb.h:343
#define USB_INTERFACE_DESCRIPTOR
A USB interface descriptor.
Definition: usb.h:246
#define container_of(ptr, type, field)
Get containing structure.
Definition: stddef.h:35
An object interface.
Definition: interface.h:124
struct ena_aq_header header
Header.
Definition: ena.h:12
static int usb_is_within_config(struct usb_configuration_descriptor *config, struct usb_descriptor_header *desc)
Check that descriptor lies within a configuration descriptor.
Definition: usb.h:356
typeof(acpi_finder=acpi_find)
ACPI table finder.
Definition: acpi.c:45

Iterate over all configuration descriptors within an interface descriptor.

Definition at line 379 of file usb.h.

◆ USB_EP0_ADDRESS

#define USB_EP0_ADDRESS   0x00

Control endpoint address.

Definition at line 486 of file usb.h.

◆ USB_EP0_ATTRIBUTES

#define USB_EP0_ATTRIBUTES   0x00

Control endpoint attributes.

Definition at line 489 of file usb.h.

◆ USB_EP0_DEFAULT_MTU

#define USB_EP0_DEFAULT_MTU (   speed)
Value:
( ( (speed) >= USB_SPEED_SUPER ) ? 512 : \
( ( (speed) >= USB_SPEED_FULL ) ? 64 : 8 ) )
Super speed (5Gbps)
Definition: usb.h:54
Full speed (12Mbps)
Definition: usb.h:50

Calculate default MTU based on device speed.

Parameters
speedDevice speed
Return values
mtuDefault MTU

Definition at line 496 of file usb.h.

◆ USB_EP0_BURST

#define USB_EP0_BURST   0

Control endpoint maximum burst size.

Definition at line 501 of file usb.h.

◆ USB_EP0_INTERVAL

#define USB_EP0_INTERVAL   0

Control endpoint interval.

Definition at line 504 of file usb.h.

◆ USB_ENDPOINT_MAX

#define USB_ENDPOINT_MAX   0x0f

Maximum endpoint number.

Definition at line 507 of file usb.h.

◆ USB_ENDPOINT_IN

#define USB_ENDPOINT_IN   0x80

Endpoint direction is in.

Definition at line 510 of file usb.h.

◆ USB_ENDPOINT_IDX

#define USB_ENDPOINT_IDX (   address)
Value:
( ( (address) & USB_ENDPOINT_IN ) >> 3 ) )
uint64_t address
Base address.
Definition: ena.h:24
#define USB_ENDPOINT_MAX
Maximum endpoint number.
Definition: usb.h:507
#define USB_ENDPOINT_IN
Endpoint direction is in.
Definition: usb.h:510

Construct endpoint index from endpoint address.

Definition at line 513 of file usb.h.

◆ for_each_usb_bus

#define for_each_usb_bus (   bus)    list_for_each_entry ( (bus), &usb_buses, list )

Iterate over all USB buses.

Definition at line 1056 of file usb.h.

◆ 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 1302 of file usb.h.

◆ 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 1309 of file usb.h.

◆ 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 1316 of file usb.h.

◆ 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 1323 of file usb.h.

◆ 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 1332 of file usb.h.

◆ USB_ANY_ID

#define USB_ANY_ID   0xffff

Match-anything ID.

Definition at line 1347 of file usb.h.

◆ 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 ), \
}, \
}, \
}
uint16_t base
Base address.
Definition: edd.h:14
#define USB_ANY_ID
Match-anything ID.
Definition: usb.h:1347
uint16_t protocol
Protocol ID.
Definition: stp.h:18

Construct USB class ID.

Parameters
baseBase class code (or USB_ANY_ID)
subclassSubclass code (or USB_ANY_ID)
protocolProtocol code (or USB_ANY_ID)

Definition at line 1363 of file usb.h.

◆ USB_DRIVERS

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

USB driver table.

Definition at line 1412 of file usb.h.

◆ __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 1415 of file usb.h.

◆ __usb_fallback_driver

#define __usb_fallback_driver   __table_entry ( USB_DRIVERS, 02 )

Declare a USB fallback driver.

Definition at line 1418 of file usb.h.

Enumeration Type Documentation

◆ 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 20 of file usb.h.

20  {
21  /** USB 2.0 */
22  USB_PROTO_2_0 = 0x0200,
23  /** USB 3.0 */
24  USB_PROTO_3_0 = 0x0300,
25  /** USB 3.1 */
26  USB_PROTO_3_1 = 0x0301,
27 };
USB 2.0.
Definition: usb.h:22
USB 3.0.
Definition: usb.h:24
USB 3.1.
Definition: usb.h:26

◆ 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 44 of file usb.h.

44  {
45  /** Not connected */
46  USB_SPEED_NONE = 0,
47  /** Low speed (1.5Mbps) */
48  USB_SPEED_LOW = USB_SPEED ( 1500, 1 ),
49  /** Full speed (12Mbps) */
50  USB_SPEED_FULL = USB_SPEED ( 12, 2 ),
51  /** High speed (480Mbps) */
52  USB_SPEED_HIGH = USB_SPEED ( 480, 2 ),
53  /** Super speed (5Gbps) */
54  USB_SPEED_SUPER = USB_SPEED ( 5, 3 ),
55 };
Low speed (1.5Mbps)
Definition: usb.h:48
Super speed (5Gbps)
Definition: usb.h:54
Not connected.
Definition: usb.h:46
#define USB_SPEED(mantissa, exponent)
Define a USB speed.
Definition: usb.h:35
High speed (480Mbps)
Definition: usb.h:52
Full speed (12Mbps)
Definition: usb.h:50

◆ 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 58 of file usb.h.

58  {
59  /** IN PID */
60  USB_PID_IN = 0x69,
61  /** OUT PID */
62  USB_PID_OUT = 0xe1,
63  /** SETUP PID */
64  USB_PID_SETUP = 0x2d,
65 };
OUT PID.
Definition: usb.h:62
SETUP PID.
Definition: usb.h:64
IN PID.
Definition: usb.h:60

◆ 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 1421 of file usb.h.

1421  {
1422  /** Fallback driver (has no effect on overall score) */
1423  USB_SCORE_FALLBACK = 0,
1424  /** Deprecated driver */
1426  /** Normal driver */
1427  USB_SCORE_NORMAL = 2,
1428 };
Deprecated driver.
Definition: usb.h:1425
Normal driver.
Definition: usb.h:1427
Fallback driver (has no effect on overall score)
Definition: usb.h:1423

Function Documentation

◆ FILE_LICENCE()

FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL  )

◆ usb_next_descriptor()

static struct usb_descriptor_header* usb_next_descriptor ( struct usb_descriptor_header desc)
inlinestatic

Get next USB descriptor.

Parameters
descUSB descriptor header
Return values
nextNext USB descriptor header

Definition at line 343 of file usb.h.

343  {
344 
345  return ( ( ( void * ) desc ) + desc->len );
346 }

Referenced by usb_endpoint_companion_descriptor(), and usb_is_within_config().

◆ usb_is_within_config()

static 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
configConfiguration descriptor
descDescriptor header
is_withinDescriptor is within the configuration descriptor

Definition at line 356 of file usb.h.

357  {
358  struct usb_descriptor_header *end =
359  ( ( ( void * ) config ) + le16_to_cpu ( config->len ) );
360 
361  /* Check that descriptor starts within the configuration
362  * descriptor, and that the length does not exceed the
363  * configuration descriptor. This relies on the fact that
364  * usb_next_descriptor() needs to access only the first byte
365  * of the descriptor in order to determine the length.
366  */
367  return ( ( desc < end ) && ( usb_next_descriptor ( desc ) <= end ) );
368 }
static struct usb_descriptor_header * usb_next_descriptor(struct usb_descriptor_header *desc)
Get next USB descriptor.
Definition: usb.h:343
#define le16_to_cpu(value)
Definition: byteswap.h:112
A USB descriptor header.
Definition: usb.h:158
uint32_t end
Ending offset.
Definition: netvsc.h:18
uint16_t len
Total length.
Definition: usb.h:199

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

Referenced by usb_endpoint_companion_descriptor().

◆ usb_endpoint_init()

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

Initialise USB endpoint.

Parameters
epUSB endpoint
usbUSB device
driverDriver operations

Definition at line 525 of file usb.h.

526  {
527 
528  ep->usb = usb;
529  ep->driver = driver;
530 }
struct usb_device * usb
USB device.
Definition: usb.h:391
struct usb_endpoint_driver_operations * driver
Driver operations.
Definition: usb.h:416

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()

static 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
epUSB endpoint
addressEndpoint address
attributesAttributes
mtuMaximum packet size
burstMaximum burst size
intervalInterval (in microframes)

Definition at line 543 of file usb.h.

545  {
546 
547  ep->address = address;
548  ep->attributes = attributes;
549  ep->mtu = mtu;
550  ep->burst = burst;
551  ep->interval = interval;
552 }
uint64_t address
Base address.
Definition: ena.h:24
unsigned int burst
Maximum burst size.
Definition: usb.h:399
size_t mtu
Maximum transfer size.
Definition: usb.h:397
uint32_t mtu
Maximum MTU.
Definition: ena.h:28
unsigned int interval
Interval (in microframes)
Definition: usb.h:401
unsigned int attributes
Attributes.
Definition: usb.h:395
unsigned int address
Endpoint address.
Definition: usb.h:393

References address, usb_endpoint::address, usb_endpoint::attributes, 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()

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

Set USB endpoint host controller private data.

Parameters
epUSB endpoint
privHost controller private data

Definition at line 561 of file usb.h.

561  {
562  ep->priv = priv;
563 }
void * priv
Host controller private data.
Definition: usb.h:414
static struct tlan_private * priv
Definition: tlan.c:224

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()

static void* usb_endpoint_get_hostdata ( struct usb_endpoint ep)
inlinestatic

Get USB endpoint host controller private data.

Parameters
epUSB endpoint
Return values
privHost controller private data

Definition at line 572 of file usb.h.

572  {
573  return ep->priv;
574 }
void * priv
Host controller private data.
Definition: usb.h:414

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)

Get USB endpoint name (for debugging)

Parameters
epUSB endpoint
Return values
nameEndpoint name

Definition at line 220 of file usb.c.

220  {
221  static char buf[ 9 /* "EPxx OUT" + NUL */ ];
222  unsigned int address = ep->address;
223 
224  snprintf ( buf, sizeof ( buf ), "EP%d%s",
226  ( address ?
227  ( ( address & USB_ENDPOINT_IN ) ? " IN" : " OUT" ) : "" ));
228  return buf;
229 }
uint64_t address
Base address.
Definition: ena.h:24
#define USB_ENDPOINT_MAX
Maximum endpoint number.
Definition: usb.h:507
#define USB_ENDPOINT_IN
Endpoint direction is in.
Definition: usb.h:510
int snprintf(char *buf, size_t size, const char *fmt,...)
Write a formatted string to a buffer.
Definition: vsprintf.c:382
unsigned int address
Endpoint address.
Definition: usb.h:393

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 
)

Describe USB endpoint from device configuration.

Parameters
epUSB endpoint
configConfiguration descriptor
interfaceInterface descriptor
typeEndpoint (internal) type
indexEndpoint index
Return values
rcReturn status code

Definition at line 241 of file usb.c.

244  {
245  struct usb_device *usb = ep->usb;
246  struct usb_endpoint_descriptor *desc;
247  struct usb_endpoint_companion_descriptor *descx;
248  unsigned int sizes;
249  unsigned int burst;
250  unsigned int interval;
251  size_t mtu;
252 
253  /* Locate endpoint descriptor */
254  desc = usb_endpoint_descriptor ( config, interface, type, index );
255  if ( ! desc )
256  return -ENOENT;
257 
258  /* Locate companion descriptor, if any */
259  descx = usb_endpoint_companion_descriptor ( config, desc );
260 
261  /* Calculate MTU and burst size */
262  sizes = le16_to_cpu ( desc->sizes );
263  mtu = USB_ENDPOINT_MTU ( sizes );
264  burst = ( descx ? descx->burst : USB_ENDPOINT_BURST ( sizes ) );
265 
266  /* Calculate interval */
267  if ( ( type & USB_ENDPOINT_ATTR_TYPE_MASK ) ==
269  if ( usb->speed >= USB_SPEED_HIGH ) {
270  /* 2^(desc->interval-1) is a microframe count */
271  interval = ( 1 << ( desc->interval - 1 ) );
272  } else {
273  /* desc->interval is a (whole) frame count */
274  interval = ( desc->interval << 3 );
275  }
276  } else {
277  /* desc->interval is a microframe count */
278  interval = desc->interval;
279  }
280 
281  /* Describe endpoint */
282  usb_endpoint_describe ( ep, desc->endpoint, desc->attributes,
283  mtu, burst, interval );
284  return 0;
285 }
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.
Definition: usb.h:543
uint8_t interval
Polling interval.
Definition: usb.h:259
#define USB_ENDPOINT_ATTR_TYPE_MASK
Endpoint attribute transfer type mask.
Definition: usb.h:266
uint32_t type
Operating system type.
Definition: ena.h:12
#define ENOENT
No such file or directory.
Definition: errno.h:514
uint8_t endpoint
Endpoint address.
Definition: usb.h:253
unsigned int speed
Device speed.
Definition: usb.h:714
An object interface.
Definition: interface.h:124
#define USB_ENDPOINT_BURST(sizes)
USB endpoint maximum burst size.
Definition: usb.h:296
A USB device.
Definition: usb.h:708
#define USB_ENDPOINT_ATTR_INTERRUPT
Interrupt endpoint transfer type.
Definition: usb.h:278
uint8_t attributes
Attributes.
Definition: usb.h:255
#define le16_to_cpu(value)
Definition: byteswap.h:112
struct usb_endpoint_companion_descriptor * usb_endpoint_companion_descriptor(struct usb_configuration_descriptor *config, struct usb_endpoint_descriptor *desc)
Locate USB endpoint companion descriptor.
Definition: usb.c:194
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.
Definition: usb.c:167
A USB endpoint descriptor.
Definition: usb.h:249
uint32_t mtu
Maximum MTU.
Definition: ena.h:28
A USB endpoint companion descriptor.
Definition: usb.h:299
High speed (480Mbps)
Definition: usb.h:52
struct usb_endpoint * ep[32]
Endpoint list.
Definition: usb.h:730
struct usb_device * usb
USB device.
Definition: usb.h:391
#define USB_ENDPOINT_MTU(sizes)
USB endpoint MTU.
Definition: usb.h:293
uint64_t index
Index of the first segment within the content.
Definition: pccrc.h:21
uint16_t sizes
Maximum packet size and burst size.
Definition: usb.h:257
uint8_t burst
Maximum burst size.
Definition: usb.h:303

References usb_endpoint_descriptor::attributes, usb_endpoint_companion_descriptor::burst, usb_endpoint_descriptor::endpoint, ENOENT, usb_device::ep, index, usb_endpoint_descriptor::interval, le16_to_cpu, mtu, usb_endpoint_descriptor::sizes, 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)

Open USB endpoint.

Parameters
epUSB endpoint
Return values
rcReturn status code

Definition at line 293 of file usb.c.

293  {
294  struct usb_device *usb = ep->usb;
295  unsigned int idx = USB_ENDPOINT_IDX ( ep->address );
296  int rc;
297 
298  /* Populate host controller operations */
299  ep->host = &usb->port->hub->bus->op->endpoint;
300 
301  /* Add to endpoint list */
302  if ( usb->ep[idx] != NULL ) {
303  DBGC ( usb, "USB %s %s is already open\n",
304  usb->name, usb_endpoint_name ( ep ) );
305  rc = -EALREADY;
306  goto err_already;
307  }
308  usb->ep[idx] = ep;
309  INIT_LIST_HEAD ( &ep->halted );
310 
311  /* Open endpoint */
312  if ( ( rc = ep->host->open ( ep ) ) != 0 ) {
313  DBGC ( usb, "USB %s %s could not open: %s\n", usb->name,
314  usb_endpoint_name ( ep ), strerror ( rc ) );
315  goto err_open;
316  }
317  ep->open = 1;
318 
319  DBGC2 ( usb, "USB %s %s opened with MTU %zd, burst %d, interval %d\n",
320  usb->name, usb_endpoint_name ( ep ), ep->mtu, ep->burst,
321  ep->interval );
322  return 0;
323 
324  ep->open = 0;
325  ep->host->close ( ep );
326  err_open:
327  usb->ep[idx] = NULL;
328  err_already:
329  if ( ep->max )
330  usb_flush ( ep );
331  return rc;
332 }
struct arbelprm_rc_send_wqe rc
Definition: arbel.h:14
void(* close)(struct usb_endpoint *ep)
Close endpoint.
Definition: usb.h:440
#define DBGC(...)
Definition: compiler.h:505
int open
Endpoint is open.
Definition: usb.h:404
struct usb_port * port
USB port.
Definition: usb.h:712
struct list_head halted
List of halted endpoints.
Definition: usb.h:409
unsigned int burst
Maximum burst size.
Definition: usb.h:399
char name[32]
Name.
Definition: usb.h:710
A USB device.
Definition: usb.h:708
char * strerror(int errno)
Retrieve string representation of error number.
Definition: strerror.c:78
#define USB_ENDPOINT_IDX(address)
Construct endpoint index from endpoint address.
Definition: usb.h:513
#define EALREADY
Connection already in progress.
Definition: errno.h:323
const char * usb_endpoint_name(struct usb_endpoint *ep)
Get USB endpoint name (for debugging)
Definition: usb.c:220
size_t mtu
Maximum transfer size.
Definition: usb.h:397
struct usb_host_operations * op
Host controller operations set.
Definition: usb.h:957
unsigned int max
Maximum fill level.
Definition: usb.h:425
#define INIT_LIST_HEAD(list)
Initialise a list head.
Definition: list.h:45
#define DBGC2(...)
Definition: compiler.h:522
struct usb_hub * hub
USB hub.
Definition: usb.h:800
struct usb_endpoint * ep[32]
Endpoint list.
Definition: usb.h:730
unsigned int interval
Interval (in microframes)
Definition: usb.h:401
struct usb_endpoint_host_operations endpoint
Endpoint operations.
Definition: usb.h:1012
struct usb_device * usb
USB device.
Definition: usb.h:391
int(* open)(struct usb_endpoint *ep)
Open endpoint.
Definition: usb.h:435
void usb_flush(struct usb_endpoint *ep)
Discard endpoint recycled buffer list.
Definition: usb.c:719
struct usb_endpoint_host_operations * host
Host controller operations.
Definition: usb.h:412
struct usb_bus * bus
USB bus.
Definition: usb.h:830
#define NULL
NULL pointer (VOID *)
Definition: Base.h:362
unsigned int address
Endpoint address.
Definition: usb.h:393

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)

Clear endpoint halt (if applicable)

Parameters
epUSB endpoint
Return values
rcReturn status code

Definition at line 371 of file usb.c.

371  {
372  struct usb_device *usb = ep->usb;
373  unsigned int type;
374  int rc;
375 
376  /* Clear transaction translator, if applicable */
377  if ( ( rc = usb_endpoint_clear_tt ( ep ) ) != 0 )
378  return rc;
379 
380  /* Clear endpoint halt (if applicable) */
382  if ( ( type != USB_ENDPOINT_ATTR_CONTROL ) &&
385  ep->address ) ) != 0 ) ) {
386  DBGC ( usb, "USB %s %s could not clear endpoint halt: %s\n",
387  usb->name, usb_endpoint_name ( ep ), strerror ( rc ) );
388  return rc;
389  }
390 
391  return 0;
392 }
struct arbelprm_rc_send_wqe rc
Definition: arbel.h:14
#define USB_ENDPOINT_ATTR_TYPE_MASK
Endpoint attribute transfer type mask.
Definition: usb.h:266
uint32_t type
Operating system type.
Definition: ena.h:12
#define DBGC(...)
Definition: compiler.h:505
#define USB_RECIP_ENDPOINT
Request recipient is an endpoint.
Definition: usb.h:104
static int usb_clear_feature(struct usb_device *usb, unsigned int type, unsigned int feature, unsigned int index)
Clear feature.
Definition: usb.h:1106
char name[32]
Name.
Definition: usb.h:710
A USB device.
Definition: usb.h:708
char * strerror(int errno)
Retrieve string representation of error number.
Definition: strerror.c:78
const char * usb_endpoint_name(struct usb_endpoint *ep)
Get USB endpoint name (for debugging)
Definition: usb.c:220
static int usb_endpoint_clear_tt(struct usb_endpoint *ep)
Clear transaction translator (if applicable)
Definition: usb.c:340
struct usb_endpoint * ep[32]
Endpoint list.
Definition: usb.h:730
#define USB_ENDPOINT_ATTR_CONTROL
Control endpoint transfer type.
Definition: usb.h:272
struct usb_device * usb
USB device.
Definition: usb.h:391
#define USB_ENDPOINT_HALT
Endpoint halt feature.
Definition: usb.h:142
unsigned int attributes
Attributes.
Definition: usb.h:395
unsigned int address
Endpoint address.
Definition: usb.h:393

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)

Close USB endpoint.

Parameters
epUSB endpoint

Definition at line 399 of file usb.c.

399  {
400  struct usb_device *usb = ep->usb;
401  unsigned int idx = USB_ENDPOINT_IDX ( ep->address );
402 
403  /* Sanity checks */
404  assert ( usb->ep[idx] == ep );
405 
406  /* Close endpoint */
407  ep->open = 0;
408  ep->host->close ( ep );
409  assert ( ep->fill == 0 );
410 
411  /* Remove from endpoint list */
412  usb->ep[idx] = NULL;
413  list_del ( &ep->halted );
414 
415  /* Discard any recycled buffers, if applicable */
416  if ( ep->max )
417  usb_flush ( ep );
418 
419  /* Clear transaction translator, if applicable */
421 }
void(* close)(struct usb_endpoint *ep)
Close endpoint.
Definition: usb.h:440
int open
Endpoint is open.
Definition: usb.h:404
#define list_del(list)
Delete an entry from a list.
Definition: list.h:119
assert((readw(&hdr->flags) &(GTF_reading|GTF_writing))==0)
struct list_head halted
List of halted endpoints.
Definition: usb.h:409
A USB device.
Definition: usb.h:708
unsigned int fill
Buffer fill level.
Definition: usb.h:406
#define USB_ENDPOINT_IDX(address)
Construct endpoint index from endpoint address.
Definition: usb.h:513
static int usb_endpoint_clear_tt(struct usb_endpoint *ep)
Clear transaction translator (if applicable)
Definition: usb.c:340
unsigned int max
Maximum fill level.
Definition: usb.h:425
struct usb_endpoint * ep[32]
Endpoint list.
Definition: usb.h:730
struct usb_device * usb
USB device.
Definition: usb.h:391
void usb_flush(struct usb_endpoint *ep)
Discard endpoint recycled buffer list.
Definition: usb.c:719
struct usb_endpoint_host_operations * host
Host controller operations.
Definition: usb.h:412
#define NULL
NULL pointer (VOID *)
Definition: Base.h:362
unsigned int address
Endpoint address.
Definition: usb.h:393

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 
)

Enqueue USB message transfer.

Parameters
epUSB endpoint
requestRequest
valueValue parameter
indexIndex parameter
iobufI/O buffer
Return values
rcReturn status code

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

Definition at line 491 of file usb.c.

493  {
494  struct usb_device *usb = ep->usb;
495  struct usb_port *port = usb->port;
496  struct usb_setup_packet *packet;
497  size_t len = iob_len ( iobuf );
498  int rc;
499 
500  /* Sanity check */
501  assert ( iob_headroom ( iobuf ) >= sizeof ( *packet ) );
502 
503  /* Fail immediately if device has been unplugged */
504  if ( port->disconnected )
505  return -ENODEV;
506 
507  /* Reset endpoint if required */
508  if ( ( ! list_empty ( &ep->halted ) ) &&
509  ( ( rc = usb_endpoint_reset ( ep ) ) != 0 ) )
510  return rc;
511 
512  /* Zero input data buffer (if applicable) */
513  if ( request & USB_DIR_IN )
514  memset ( iobuf->data, 0, len );
515 
516  /* Construct setup packet */
517  packet = iob_push ( iobuf, sizeof ( *packet ) );
518  packet->request = cpu_to_le16 ( request );
519  packet->value = cpu_to_le16 ( value );
520  packet->index = cpu_to_le16 ( index );
521  packet->len = cpu_to_le16 ( len );
522 
523  /* Enqueue message transfer */
524  if ( ( rc = ep->host->message ( ep, iobuf ) ) != 0 ) {
525  DBGC ( usb, "USB %s %s could not enqueue message transfer: "
526  "%s\n", usb->name, usb_endpoint_name ( ep ),
527  strerror ( rc ) );
528  return rc;
529  }
530 
531  /* Increment fill level */
532  ep->fill++;
533 
534  return 0;
535 }
struct arbelprm_rc_send_wqe rc
Definition: arbel.h:14
#define iob_push(iobuf, len)
Definition: iobuf.h:84
#define DBGC(...)
Definition: compiler.h:505
struct usb_device * usb
Currently attached device (if in use)
Definition: usb.h:820
#define list_empty(list)
Test whether a list is empty.
Definition: list.h:136
A USB port.
Definition: usb.h:798
u8 port
Port number.
Definition: CIB_PRM.h:31
struct usb_port * port
USB port.
Definition: usb.h:712
assert((readw(&hdr->flags) &(GTF_reading|GTF_writing))==0)
uint16_t index
Index parameter.
Definition: usb.h:74
struct list_head halted
List of halted endpoints.
Definition: usb.h:409
#define USB_DIR_IN
Data transfer is from device to host.
Definition: usb.h:83
char name[32]
Name.
Definition: usb.h:710
A USB device.
Definition: usb.h:708
pseudo_bit_t value[0x00020]
Definition: arbel.h:13
char * strerror(int errno)
Retrieve string representation of error number.
Definition: strerror.c:78
static size_t iob_len(struct io_buffer *iobuf)
Calculate length of data in an I/O buffer.
Definition: iobuf.h:155
#define ENODEV
No such device.
Definition: errno.h:509
static int usb_endpoint_reset(struct usb_endpoint *ep)
Reset USB endpoint.
Definition: usb.c:429
unsigned int fill
Buffer fill level.
Definition: usb.h:406
A USB setup data packet.
Definition: usb.h:68
const char * usb_endpoint_name(struct usb_endpoint *ep)
Get USB endpoint name (for debugging)
Definition: usb.c:220
uint16_t request
Request.
Definition: usb.h:70
static size_t iob_headroom(struct io_buffer *iobuf)
Calculate available space at start of an I/O buffer.
Definition: iobuf.h:165
uint32_t len
Length.
Definition: ena.h:14
void * data
Start of data.
Definition: iobuf.h:48
struct usb_endpoint * ep[32]
Endpoint list.
Definition: usb.h:730
u8 request[0]
List of IEs requested.
Definition: ieee80211.h:16
#define cpu_to_le16(value)
Definition: byteswap.h:106
uint16_t len
Length of data stage.
Definition: usb.h:76
struct usb_device * usb
USB device.
Definition: usb.h:391
int(* message)(struct usb_endpoint *ep, struct io_buffer *iobuf)
Enqueue message transfer.
Definition: usb.h:460
struct usb_endpoint_host_operations * host
Host controller operations.
Definition: usb.h:412
uint64_t index
Index of the first segment within the content.
Definition: pccrc.h:21
uint16_t value
Value parameter.
Definition: usb.h:72
void * memset(void *dest, int character, size_t len) __nonnull

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(), value, and usb_setup_packet::value.

Referenced by usb_control().

◆ usb_stream()

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

Enqueue USB stream transfer.

Parameters
epUSB endpoint
iobufI/O buffer
terminateTerminate using a short packet
Return values
rcReturn status code

Definition at line 545 of file usb.c.

546  {
547  struct usb_device *usb = ep->usb;
548  struct usb_port *port = usb->port;
549  int zlp;
550  int rc;
551 
552  /* Fail immediately if device has been unplugged */
553  if ( port->disconnected )
554  return -ENODEV;
555 
556  /* Reset endpoint if required */
557  if ( ( ! list_empty ( &ep->halted ) ) &&
558  ( ( rc = usb_endpoint_reset ( ep ) ) != 0 ) )
559  return rc;
560 
561  /* Append a zero-length packet if necessary */
562  zlp = terminate;
563  if ( iob_len ( iobuf ) & ( ep->mtu - 1 ) )
564  zlp = 0;
565 
566  /* Enqueue stream transfer */
567  if ( ( rc = ep->host->stream ( ep, iobuf, zlp ) ) != 0 ) {
568  DBGC ( usb, "USB %s %s could not enqueue stream transfer: %s\n",
569  usb->name, usb_endpoint_name ( ep ), strerror ( rc ) );
570  return rc;
571  }
572 
573  /* Increment fill level */
574  ep->fill++;
575 
576  return 0;
577 }
struct arbelprm_rc_send_wqe rc
Definition: arbel.h:14
#define DBGC(...)
Definition: compiler.h:505
struct usb_device * usb
Currently attached device (if in use)
Definition: usb.h:820
#define list_empty(list)
Test whether a list is empty.
Definition: list.h:136
A USB port.
Definition: usb.h:798
u8 port
Port number.
Definition: CIB_PRM.h:31
struct usb_port * port
USB port.
Definition: usb.h:712
struct list_head halted
List of halted endpoints.
Definition: usb.h:409
char name[32]
Name.
Definition: usb.h:710
A USB device.
Definition: usb.h:708
char * strerror(int errno)
Retrieve string representation of error number.
Definition: strerror.c:78
static size_t iob_len(struct io_buffer *iobuf)
Calculate length of data in an I/O buffer.
Definition: iobuf.h:155
#define ENODEV
No such device.
Definition: errno.h:509
static int usb_endpoint_reset(struct usb_endpoint *ep)
Reset USB endpoint.
Definition: usb.c:429
unsigned int fill
Buffer fill level.
Definition: usb.h:406
const char * usb_endpoint_name(struct usb_endpoint *ep)
Get USB endpoint name (for debugging)
Definition: usb.c:220
size_t mtu
Maximum transfer size.
Definition: usb.h:397
struct usb_endpoint * ep[32]
Endpoint list.
Definition: usb.h:730
struct usb_device * usb
USB device.
Definition: usb.h:391
struct usb_endpoint_host_operations * host
Host controller operations.
Definition: usb.h:412
int(* stream)(struct usb_endpoint *ep, struct io_buffer *iobuf, int zlp)
Enqueue stream transfer.
Definition: usb.h:469

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 
)

Complete transfer (possibly with error)

Parameters
epUSB endpoint
iobufI/O buffer
rcCompletion status code

Definition at line 586 of file usb.c.

587  {
588  struct usb_device *usb = ep->usb;
589 
590  /* Decrement fill level */
591  assert ( ep->fill > 0 );
592  ep->fill--;
593 
594  /* Schedule reset, if applicable */
595  if ( ( rc != 0 ) && ep->open ) {
596  DBGC ( usb, "USB %s %s completion failed: %s\n",
597  usb->name, usb_endpoint_name ( ep ), strerror ( rc ) );
598  list_del ( &ep->halted );
600  }
601 
602  /* Report completion */
603  ep->driver->complete ( ep, iobuf, rc );
604 }
struct arbelprm_rc_send_wqe rc
Definition: arbel.h:14
void(* complete)(struct usb_endpoint *ep, struct io_buffer *iobuf, int rc)
Complete transfer.
Definition: usb.h:481
#define DBGC(...)
Definition: compiler.h:505
int open
Endpoint is open.
Definition: usb.h:404
#define list_del(list)
Delete an entry from a list.
Definition: list.h:119
assert((readw(&hdr->flags) &(GTF_reading|GTF_writing))==0)
#define list_add_tail(new, head)
Add a new entry to the tail of a list.
Definition: list.h:93
struct list_head halted
List of halted endpoints.
Definition: usb.h:409
char name[32]
Name.
Definition: usb.h:710
A USB device.
Definition: usb.h:708
char * strerror(int errno)
Retrieve string representation of error number.
Definition: strerror.c:78
unsigned int fill
Buffer fill level.
Definition: usb.h:406
const char * usb_endpoint_name(struct usb_endpoint *ep)
Get USB endpoint name (for debugging)
Definition: usb.c:220
static struct list_head usb_halted
List of halted endpoints.
Definition: usb.c:50
struct usb_endpoint * ep[32]
Endpoint list.
Definition: usb.h:730
struct usb_device * usb
USB device.
Definition: usb.h:391
struct usb_endpoint_driver_operations * driver
Driver operations.
Definition: usb.h:416

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()

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

Initialise USB endpoint refill.

Parameters
epUSB endpoint
reserveRefill buffer reserved header length
lenRefill buffer payload length (zero for endpoint's MTU)
maxMaximum fill level

Definition at line 602 of file usb.h.

603  {
604 
605  INIT_LIST_HEAD ( &ep->recycled );
606  ep->reserve = reserve;
607  ep->len = len;
608  ep->max = max;
609 }
#define max(x, y)
Definition: ath.h:39
struct list_head recycled
Recycled I/O buffer list.
Definition: usb.h:419
size_t len
Refill buffer payload length.
Definition: usb.h:423
size_t reserve
Refill buffer reserved header length.
Definition: usb.h:421
unsigned int max
Maximum fill level.
Definition: usb.h:425
#define INIT_LIST_HEAD(list)
Initialise a list head.
Definition: list.h:45
uint32_t len
Length.
Definition: ena.h:14
struct usb_endpoint * ep[32]
Endpoint list.
Definition: usb.h:730

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(), usbblk_probe(), and usbkbd_probe().

◆ usb_recycle()

static void usb_recycle ( struct usb_endpoint ep,
struct io_buffer iobuf 
)
inlinestatic

Recycle I/O buffer.

Parameters
epUSB endpoint
iobufI/O buffer

Definition at line 618 of file usb.h.

618  {
619 
620  list_add_tail ( &iobuf->list, &ep->recycled );
621 }
struct list_head recycled
Recycled I/O buffer list.
Definition: usb.h:419
#define list_add_tail(new, head)
Add a new entry to the tail of a list.
Definition: list.h:93
struct list_head list
List of which this buffer is a member.
Definition: iobuf.h:40
struct usb_endpoint * ep[32]
Endpoint list.
Definition: usb.h:730

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)

Prefill endpoint recycled buffer list.

Parameters
epUSB endpoint
Return values
rcReturn status code

Definition at line 619 of file usb.c.

619  {
620  struct io_buffer *iobuf;
621  size_t reserve = ep->reserve;
622  size_t len = ( ep->len ? ep->len : ep->mtu );
623  unsigned int fill;
624  int rc;
625 
626  /* Sanity checks */
627  assert ( ep->fill == 0 );
628  assert ( ep->max > 0 );
629  assert ( list_empty ( &ep->recycled ) );
630 
631  /* Fill recycled buffer list */
632  for ( fill = 0 ; fill < ep->max ; fill++ ) {
633 
634  /* Allocate I/O buffer */
635  iobuf = alloc_iob ( reserve + len );
636  if ( ! iobuf ) {
637  rc = -ENOMEM;
638  goto err_alloc;
639  }
640  iob_reserve ( iobuf, reserve );
641 
642  /* Add to recycled buffer list */
643  list_add_tail ( &iobuf->list, &ep->recycled );
644  }
645 
646  return 0;
647 
648  err_alloc:
649  usb_flush ( ep );
650  return rc;
651 }
struct arbelprm_rc_send_wqe rc
Definition: arbel.h:14
struct list_head recycled
Recycled I/O buffer list.
Definition: usb.h:419
size_t len
Refill buffer payload length.
Definition: usb.h:423
struct io_buffer * alloc_iob(size_t len)
Allocate I/O buffer.
Definition: iobuf.c:129
#define list_empty(list)
Test whether a list is empty.
Definition: list.h:136
#define ENOMEM
Not enough space.
Definition: errno.h:534
assert((readw(&hdr->flags) &(GTF_reading|GTF_writing))==0)
#define list_add_tail(new, head)
Add a new entry to the tail of a list.
Definition: list.h:93
size_t reserve
Refill buffer reserved header length.
Definition: usb.h:421
unsigned int fill
Buffer fill level.
Definition: usb.h:406
size_t mtu
Maximum transfer size.
Definition: usb.h:397
#define iob_reserve(iobuf, len)
Definition: iobuf.h:67
unsigned int max
Maximum fill level.
Definition: usb.h:425
struct list_head list
List of which this buffer is a member.
Definition: iobuf.h:40
uint32_t len
Length.
Definition: ena.h:14
uint8_t fill
Length pair.
Definition: deflate.h:12
void usb_flush(struct usb_endpoint *ep)
Discard endpoint recycled buffer list.
Definition: usb.c:719
A persistent I/O buffer.
Definition: iobuf.h:33

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 
)

Refill endpoint up to specified limit.

Parameters
epUSB endpoint
maxFill limit
Return values
rcReturn status code

Definition at line 660 of file usb.c.

660  {
661  struct io_buffer *iobuf;
662  size_t reserve = ep->reserve;
663  size_t len = ( ep->len ? ep->len : ep->mtu );
664  int rc;
665 
666  /* Sanity checks */
667  assert ( ep->open );
668  assert ( ep->max > 0 );
669 
670  /* Refill endpoint */
671  if ( max > ep->max )
672  max = ep->max;
673  while ( ep->fill < max ) {
674 
675  /* Get or allocate buffer */
676  if ( list_empty ( &ep->recycled ) ) {
677  /* Recycled buffer list is empty; allocate new buffer */
678  iobuf = alloc_iob ( reserve + len );
679  if ( ! iobuf )
680  return -ENOMEM;
681  iob_reserve ( iobuf, reserve );
682  } else {
683  /* Get buffer from recycled buffer list */
684  iobuf = list_first_entry ( &ep->recycled,
685  struct io_buffer, list );
686  assert ( iobuf != NULL );
687  list_del ( &iobuf->list );
688  }
689 
690  /* Reset buffer to maximum size */
691  assert ( iob_len ( iobuf ) <= len );
692  iob_put ( iobuf, ( len - iob_len ( iobuf ) ) );
693 
694  /* Enqueue buffer */
695  if ( ( rc = usb_stream ( ep, iobuf, 0 ) ) != 0 ) {
696  list_add ( &iobuf->list, &ep->recycled );
697  return rc;
698  }
699  }
700 
701  return 0;
702 }
struct arbelprm_rc_send_wqe rc
Definition: arbel.h:14
#define iob_put(iobuf, len)
Definition: iobuf.h:120
#define max(x, y)
Definition: ath.h:39
#define list_add(new, head)
Add a new entry to the head of a list.
Definition: list.h:69
struct list_head recycled
Recycled I/O buffer list.
Definition: usb.h:419
size_t len
Refill buffer payload length.
Definition: usb.h:423
int usb_stream(struct usb_endpoint *ep, struct io_buffer *iobuf, int terminate)
Enqueue USB stream transfer.
Definition: usb.c:545
int open
Endpoint is open.
Definition: usb.h:404
struct io_buffer * alloc_iob(size_t len)
Allocate I/O buffer.
Definition: iobuf.c:129
#define list_empty(list)
Test whether a list is empty.
Definition: list.h:136
#define list_first_entry(list, type, member)
Get the container of the first entry in a list.
Definition: list.h:333
#define list_del(list)
Delete an entry from a list.
Definition: list.h:119
#define ENOMEM
Not enough space.
Definition: errno.h:534
assert((readw(&hdr->flags) &(GTF_reading|GTF_writing))==0)
size_t reserve
Refill buffer reserved header length.
Definition: usb.h:421
static size_t iob_len(struct io_buffer *iobuf)
Calculate length of data in an I/O buffer.
Definition: iobuf.h:155
unsigned int fill
Buffer fill level.
Definition: usb.h:406
size_t mtu
Maximum transfer size.
Definition: usb.h:397
#define iob_reserve(iobuf, len)
Definition: iobuf.h:67
unsigned int max
Maximum fill level.
Definition: usb.h:425
struct list_head list
List of which this buffer is a member.
Definition: iobuf.h:40
uint32_t len
Length.
Definition: ena.h:14
#define NULL
NULL pointer (VOID *)
Definition: Base.h:362
A persistent I/O buffer.
Definition: iobuf.h:33

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)

Refill endpoint.

Parameters
epUSB endpoint
Return values
rcReturn status code

Definition at line 710 of file usb.c.

710  {
711  return usb_refill_limit ( ep, ep->max );
712 }
int usb_refill_limit(struct usb_endpoint *ep, unsigned int max)
Refill endpoint up to specified limit.
Definition: usb.c:660
unsigned int max
Maximum fill level.
Definition: usb.h:425

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)

Discard endpoint recycled buffer list.

Parameters
epUSB endpoint

Definition at line 719 of file usb.c.

719  {
720  struct io_buffer *iobuf;
721  struct io_buffer *tmp;
722 
723  /* Sanity checks */
724  assert ( ! ep->open );
725  assert ( ep->max > 0 );
726 
727  /* Free all I/O buffers */
728  list_for_each_entry_safe ( iobuf, tmp, &ep->recycled, list ) {
729  list_del ( &iobuf->list );
730  free_iob ( iobuf );
731  }
732 }
struct list_head recycled
Recycled I/O buffer list.
Definition: usb.h:419
void free_iob(struct io_buffer *iobuf)
Free I/O buffer.
Definition: iobuf.c:146
int open
Endpoint is open.
Definition: usb.h:404
#define list_del(list)
Delete an entry from a list.
Definition: list.h:119
assert((readw(&hdr->flags) &(GTF_reading|GTF_writing))==0)
#define list_for_each_entry_safe(pos, tmp, head, member)
Iterate over entries in a list, safe against deletion of the current entry.
Definition: list.h:447
uint8_t * tmp
Definition: entropy.h:156
unsigned int max
Maximum fill level.
Definition: usb.h:425
struct list_head list
List of which this buffer is a member.
Definition: iobuf.h:40
A persistent I/O buffer.
Definition: iobuf.h:33

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()

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

Set USB function driver private data.

Parameters
funcUSB function
privDriver private data

Definition at line 692 of file usb.h.

692  {
693  func->priv = priv;
694 }
void * priv
Driver private data.
Definition: usb.h:674
static struct tlan_private * priv
Definition: tlan.c:224

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()

static void* usb_func_get_drvdata ( struct usb_function func)
inlinestatic

Get USB function driver private data.

Parameters
functionUSB function
Return values
privDriver private data

Definition at line 703 of file usb.h.

703  {
704  return func->priv;
705 }
void * priv
Driver private data.
Definition: usb.h:674

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()

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

Set USB device host controller private data.

Parameters
usbUSB device
privHost controller private data

Definition at line 769 of file usb.h.

769  {
770  usb->priv = priv;
771 }
void * priv
Host controller private data.
Definition: usb.h:727
static struct tlan_private * priv
Definition: tlan.c:224

References priv, and usb_device::priv.

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

◆ usb_get_hostdata()

static void* usb_get_hostdata ( struct usb_device usb)
inlinestatic

Get USB device host controller private data.

Parameters
usbUSB device
Return values
privHost controller private data

Definition at line 780 of file usb.h.

780  {
781  return usb->priv;
782 }
void * priv
Host controller private data.
Definition: usb.h:727

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()

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

Get USB endpoint.

Parameters
usbUSB device
addressEndpoint address
Return values
epUSB endpoint, or NULL if not opened

Definition at line 791 of file usb.h.

792  {
793 
794  return usb->ep[ USB_ENDPOINT_IDX ( address ) ];
795 }
uint64_t address
Base address.
Definition: ena.h:24
#define USB_ENDPOINT_IDX(address)
Construct endpoint index from endpoint address.
Definition: usb.h:513
struct usb_endpoint * ep[32]
Endpoint list.
Definition: usb.h:730

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()

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

Set USB hub driver private data.

Parameters
hubUSB hub
privDriver private data

Definition at line 922 of file usb.h.

922  {
923  hub->priv = priv;
924 }
void * priv
Driver private data.
Definition: usb.h:846
static struct tlan_private * priv
Definition: tlan.c:224

References priv, and usb_hub::priv.

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

◆ usb_hub_get_drvdata()

static void* usb_hub_get_drvdata ( struct usb_hub hub)
inlinestatic

◆ usb_port()

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

Get USB port.

Parameters
hubUSB hub
addressPort address
Return values
portUSB port

Definition at line 945 of file usb.h.

945  {
946 
947  return &hub->port[ address - 1 ];
948 }
uint64_t address
Base address.
Definition: ena.h:24
struct usb_port port[0]
Port list.
Definition: usb.h:852

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_probe(), and xhci_root_open().

◆ usb_bus_set_hostdata()

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

Set USB bus host controller private data.

Parameters
busUSB bus
privHost controller private data

Definition at line 1030 of file usb.h.

1030  {
1031  bus->priv = priv;
1032 }
static struct tlan_private * priv
Definition: tlan.c:224
uint8_t bus
Bus.
Definition: edd.h:14

References bus, and priv.

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

◆ usb_bus_get_hostdata()

static void* usb_bus_get_hostdata ( struct usb_bus bus)
inlinestatic

Get USB bus host controller private data.

Parameters
busUSB bus
Return values
privHost controller private data

Definition at line 1041 of file usb.h.

1041  {
1042  return bus->priv;
1043 }
uint8_t bus
Bus.
Definition: edd.h:14

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()

static void usb_poll ( struct usb_bus bus)
inlinestatic

Poll USB bus.

Parameters
busUSB bus

Definition at line 1051 of file usb.h.

1051  {
1052  bus->host->poll ( bus );
1053 }
uint8_t bus
Bus.
Definition: edd.h:14

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()

static void usb_complete ( struct usb_endpoint ep,
struct io_buffer iobuf 
)
inlinestatic

Complete transfer (without error)

Parameters
epUSB endpoint
iobufI/O buffer

Definition at line 1066 of file usb.h.

1066  {
1067  usb_complete_err ( ep, iobuf, 0 );
1068 }
void usb_complete_err(struct usb_endpoint *ep, struct io_buffer *iobuf, int rc)
Complete transfer (possibly with error)
Definition: usb.c:586

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 
)

Issue USB control transaction.

Parameters
usbUSB device
requestRequest
valueValue parameter
indexIndex parameter
dataData buffer (if any)
lenLength of data
Return values
rcReturn status code

Definition at line 783 of file usb.c.

785  {
786  struct usb_bus *bus = usb->port->hub->bus;
787  struct usb_endpoint *ep = &usb->control;
788  struct io_buffer *iobuf;
789  struct io_buffer *cmplt;
790  union {
791  struct usb_setup_packet setup;
792  struct usb_control_pseudo_header pshdr;
793  } *headroom;
794  struct usb_control_pseudo_header *pshdr;
795  unsigned int i;
796  int rc;
797 
798  /* Allocate I/O buffer */
799  iobuf = alloc_iob ( sizeof ( *headroom ) + len );
800  if ( ! iobuf ) {
801  rc = -ENOMEM;
802  goto err_alloc;
803  }
804  iob_reserve ( iobuf, sizeof ( *headroom ) );
805  iob_put ( iobuf, len );
806  if ( request & USB_DIR_IN ) {
807  memset ( data, 0, len );
808  } else {
809  memcpy ( iobuf->data, data, len );
810  }
811 
812  /* Enqueue message */
813  if ( ( rc = usb_message ( ep, request, value, index, iobuf ) ) != 0 )
814  goto err_message;
815 
816  /* Wait for completion */
817  for ( i = 0 ; i < USB_CONTROL_MAX_WAIT_MS ; i++ ) {
818 
819  /* Poll bus */
820  usb_poll ( bus );
821 
822  /* Check for completion */
823  while ( ( cmplt = list_first_entry ( &usb->complete,
824  struct io_buffer,
825  list ) ) ) {
826 
827  /* Remove from completion list */
828  list_del ( &cmplt->list );
829 
830  /* Extract and strip completion status */
831  pshdr = cmplt->data;
832  iob_pull ( cmplt, sizeof ( *pshdr ) );
833  rc = pshdr->rc;
834 
835  /* Discard stale completions */
836  if ( cmplt != iobuf ) {
837  DBGC ( usb, "USB %s stale control completion: "
838  "%s\n", usb->name, strerror ( rc ) );
839  DBGC_HDA ( usb, 0, cmplt->data,
840  iob_len ( cmplt ) );
841  free_iob ( cmplt );
842  continue;
843  }
844 
845  /* Fail immediately if completion was in error */
846  if ( rc != 0 ) {
847  DBGC ( usb, "USB %s control %04x:%04x:%04x "
848  "failed: %s\n", usb->name, request,
849  value, index, strerror ( rc ) );
850  free_iob ( cmplt );
851  usb_endpoint_reset ( ep );
852  return rc;
853  }
854 
855  /* Copy completion to data buffer, if applicable */
856  assert ( iob_len ( cmplt ) <= len );
857  if ( request & USB_DIR_IN )
858  memcpy ( data, cmplt->data, iob_len ( cmplt ) );
859  free_iob ( cmplt );
860  return 0;
861  }
862 
863  /* Delay */
864  mdelay ( 1 );
865  }
866 
867  DBGC ( usb, "USB %s timed out waiting for control %04x:%04x:%04x\n",
868  usb->name, request, value, index );
869  return -ETIMEDOUT;
870 
871  err_message:
872  free_iob ( iobuf );
873  err_alloc:
874  return rc;
875 }
#define iob_pull(iobuf, len)
Definition: iobuf.h:102
struct arbelprm_rc_send_wqe rc
Definition: arbel.h:14
#define iob_put(iobuf, len)
Definition: iobuf.h:120
void free_iob(struct io_buffer *iobuf)
Free I/O buffer.
Definition: iobuf.c:146
#define DBGC(...)
Definition: compiler.h:505
int rc
Completion status.
Definition: usb.c:744
struct io_buffer * alloc_iob(size_t len)
Allocate I/O buffer.
Definition: iobuf.c:129
#define list_first_entry(list, type, member)
Get the container of the first entry in a list.
Definition: list.h:333
#define list_del(list)
Delete an entry from a list.
Definition: list.h:119
#define ENOMEM
Not enough space.
Definition: errno.h:534
A USB endpoint.
Definition: usb.h:389
void * memcpy(void *dest, const void *src, size_t len) __nonnull
int usb_message(struct usb_endpoint *ep, unsigned int request, unsigned int value, unsigned int index, struct io_buffer *iobuf)
Enqueue USB message transfer.
Definition: usb.c:491
struct usb_port * port
USB port.
Definition: usb.h:712
assert((readw(&hdr->flags) &(GTF_reading|GTF_writing))==0)
#define DBGC_HDA(...)
Definition: compiler.h:506
#define USB_CONTROL_MAX_WAIT_MS
Maximum time to wait for a control transaction to complete.
Definition: usb.h:1316
#define USB_DIR_IN
Data transfer is from device to host.
Definition: usb.h:83
char name[32]
Name.
Definition: usb.h:710
pseudo_bit_t value[0x00020]
Definition: arbel.h:13
struct usb_endpoint control
Control endpoint.
Definition: usb.h:733
static void usb_poll(struct usb_bus *bus)
Poll USB bus.
Definition: usb.h:1051
char * strerror(int errno)
Retrieve string representation of error number.
Definition: strerror.c:78
static size_t iob_len(struct io_buffer *iobuf)
Calculate length of data in an I/O buffer.
Definition: iobuf.h:155
static int usb_endpoint_reset(struct usb_endpoint *ep)
Reset USB endpoint.
Definition: usb.c:429
USB control transfer pseudo-header.
Definition: usb.c:742
A USB setup data packet.
Definition: usb.h:68
void mdelay(unsigned long msecs)
Delay for a fixed number of milliseconds.
Definition: timer.c:78
#define iob_reserve(iobuf, len)
Definition: iobuf.h:67
struct list_head list
List of which this buffer is a member.
Definition: iobuf.h:40
uint32_t len
Length.
Definition: ena.h:14
struct list_head complete
Completed control transfers.
Definition: usb.h:735
void * data
Start of data.
Definition: iobuf.h:48
struct usb_hub * hub
USB hub.
Definition: usb.h:800
u8 request[0]
List of IEs requested.
Definition: ieee80211.h:16
struct usb_device * usb
USB device.
Definition: usb.h:391
struct arbelprm_port_state_change_st data
Message.
Definition: arbel.h:12
uint64_t index
Index of the first segment within the content.
Definition: pccrc.h:21
struct usb_bus * bus
USB bus.
Definition: usb.h:830
#define ETIMEDOUT
Connection timed out.
Definition: errno.h:669
A USB bus.
Definition: usb.h:951
uint8_t bus
Bus.
Definition: edd.h:14
void * memset(void *dest, int character, size_t len) __nonnull
A persistent I/O buffer.
Definition: iobuf.h:33

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_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 
)

Get USB string descriptor.

Parameters
usbUSB device
indexString index
languageLanguage ID, or 0 to use default
bufData buffer
lenLength of buffer
Return values
lenString length (excluding NUL), or negative error

Definition at line 915 of file usb.c.

916  {
917  size_t max = ( len ? ( len - 1 /* NUL */ ) : 0 );
918  struct {
920  uint16_t character[max];
921  } __attribute__ (( packed )) *desc;
922  unsigned int actual;
923  unsigned int i;
924  int rc;
925 
926  /* Use default language ID, if applicable */
927  if ( ( language == 0 ) && ( index != 0 ) ) {
928  if ( ! usb->language )
929  usb->language = usb_get_default_language ( usb );
930  language = usb->language;
931  }
932 
933  /* Allocate buffer for string */
934  desc = malloc ( sizeof ( *desc ) );
935  if ( ! desc ) {
936  rc = -ENOMEM;
937  goto err_alloc;
938  }
939 
940  /* Get descriptor */
941  if ( ( rc = usb_get_descriptor ( usb, 0, USB_STRING_DESCRIPTOR, index,
942  language, &desc->header,
943  sizeof ( *desc ) ) ) != 0 )
944  goto err_get_descriptor;
945 
946  /* Calculate string length */
947  if ( desc->header.len < sizeof ( desc->header ) ) {
948  rc = -EINVAL;
949  goto err_len;
950  }
951  actual = ( ( desc->header.len - sizeof ( desc->header ) ) /
952  sizeof ( desc->character[0] ) );
953 
954  /* Copy to buffer */
955  for ( i = 0 ; ( ( i < actual ) && ( i < max ) ) ; i++ )
956  buf[i] = le16_to_cpu ( desc->character[i] );
957  if ( len )
958  buf[i] = '\0';
959 
960  /* Free buffer */
961  free ( desc );
962 
963  return actual;
964 
965  err_len:
966  err_get_descriptor:
967  free ( desc );
968  err_alloc:
969  return rc;
970 }
#define __attribute__(x)
Definition: compiler.h:10
#define EINVAL
Invalid argument.
Definition: errno.h:428
struct arbelprm_rc_send_wqe rc
Definition: arbel.h:14
unsigned short uint16_t
Definition: stdint.h:11
static unsigned int usb_get_default_language(struct usb_device *usb)
Get default language ID.
Definition: usb.c:883
#define max(x, y)
Definition: ath.h:39
#define USB_STRING_DESCRIPTOR
A USB string descriptor.
Definition: usb.h:224
#define ENOMEM
Not enough space.
Definition: errno.h:534
static void(* free)(struct refcnt *refcnt))
Definition: refcnt.h:54
#define le16_to_cpu(value)
Definition: byteswap.h:112
void * malloc(size_t size)
Allocate memory.
Definition: malloc.c:583
A USB descriptor header.
Definition: usb.h:158
unsigned int language
Default language ID (if known)
Definition: usb.h:738
uint32_t len
Length.
Definition: ena.h:14
struct ena_aq_header header
Header.
Definition: ena.h:12
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.
Definition: usb.h:1156
uint64_t index
Index of the first segment within the content.
Definition: pccrc.h:21

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

Referenced by ecm_fetch_mac().

◆ usb_get_status()

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

Get status.

Parameters
usbUSB device
typeRequest type
indexTarget index
dataStatus to fill in
lenLength of status descriptor
Return values
rcReturn status code

Definition at line 1089 of file usb.h.

1090  {
1091 
1092  return usb_control ( usb, ( USB_GET_STATUS | type ), 0, index,
1093  data, len );
1094 }
uint32_t type
Operating system type.
Definition: ena.h:12
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.
Definition: usb.c:783
#define USB_GET_STATUS
Get status.
Definition: usb.h:110
uint32_t len
Length.
Definition: ena.h:14
struct arbelprm_port_state_change_st data
Message.
Definition: arbel.h:12
uint64_t index
Index of the first segment within the content.
Definition: pccrc.h:21

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

Referenced by usb_hub_get_port_status().

◆ usb_clear_feature()

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

Clear feature.

Parameters
usbUSB device
typeRequest type
featureFeature selector
indexTarget index
Return values
rcReturn status code

Definition at line 1106 of file usb.h.

1107  {
1108 
1109  return usb_control ( usb, ( USB_CLEAR_FEATURE | type ),
1110  feature, index, NULL, 0 );
1111 }
uint32_t type
Operating system type.
Definition: ena.h:12
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.
Definition: usb.c:783
#define USB_CLEAR_FEATURE
Clear feature.
Definition: usb.h:113
A named feature.
Definition: features.h:78
uint64_t index
Index of the first segment within the content.
Definition: pccrc.h:21
#define NULL
NULL pointer (VOID *)
Definition: Base.h:362

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()

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

Set feature.

Parameters
usbUSB device
typeRequest type
featureFeature selector
indexTarget index
Return values
rcReturn status code

Definition at line 1123 of file usb.h.

1124  {
1125 
1126  return usb_control ( usb, ( USB_SET_FEATURE | type ),
1127  feature, index, NULL, 0 );
1128 }
uint32_t type
Operating system type.
Definition: ena.h:12
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.
Definition: usb.c:783
A named feature.
Definition: features.h:78
uint64_t index
Index of the first segment within the content.
Definition: pccrc.h:21
#define USB_SET_FEATURE
Set feature.
Definition: usb.h:116
#define NULL
NULL pointer (VOID *)
Definition: Base.h:362

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

Referenced by usb_hub_set_port_feature().

◆ usb_set_address()

static int usb_set_address ( struct usb_device usb,
unsigned int  address 
)
inlinestatic

Set address.

Parameters
usbUSB device
addressDevice address
Return values
rcReturn status code

Definition at line 1138 of file usb.h.

1138  {
1139 
1140  return usb_control ( usb, USB_SET_ADDRESS, address, 0, NULL, 0 );
1141 }
uint64_t address
Base address.
Definition: ena.h:24
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.
Definition: usb.c:783
#define USB_SET_ADDRESS
Set address.
Definition: usb.h:119
#define NULL
NULL pointer (VOID *)
Definition: Base.h:362

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

Referenced by ehci_device_address(), and uhci_device_address().

◆ usb_get_descriptor()

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 
)
inlinestatic

Get USB descriptor.

Parameters
usbUSB device
typeRequest type
descDescriptor type
indexDescriptor index
languageLanguage ID (for string descriptors)
dataDescriptor to fill in
lenMaximum length of descriptor
Return values
rcReturn status code

Definition at line 1156 of file usb.h.

1159  {
1160 
1161  return usb_control ( usb, ( USB_GET_DESCRIPTOR | type ),
1162  ( ( desc << 8 ) | index ), language, data, len );
1163 }
#define USB_GET_DESCRIPTOR
Get descriptor.
Definition: usb.h:122
uint32_t type
Operating system type.
Definition: ena.h:12
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.
Definition: usb.c:783
uint32_t len
Length.
Definition: ena.h:14
struct arbelprm_port_state_change_st data
Message.
Definition: arbel.h:12
uint64_t index
Index of the first segment within the content.
Definition: pccrc.h:21

References data, 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()

static 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
usbUSB device
dataDevice descriptor to (partially) fill in
Return values
rcReturn status code

Definition at line 1173 of file usb.h.

1173  {
1174 
1175  return usb_get_descriptor ( usb, 0, USB_DEVICE_DESCRIPTOR, 0, 0,
1176  &data->header,
1177  ( offsetof ( typeof ( *data ), mtu ) +
1178  sizeof ( data->mtu ) ) );
1179 }
#define offsetof(type, field)
Get offset of a field within a structure.
Definition: stddef.h:24
uint32_t mtu
Maximum MTU.
Definition: ena.h:28
typeof(acpi_finder=acpi_find)
ACPI table finder.
Definition: acpi.c:45
struct arbelprm_port_state_change_st data
Message.
Definition: arbel.h:12
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.
Definition: usb.h:1156
Standard Device Descriptor USB 2.0 spec, Section 9.6.1.
Definition: Usb.h:111

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

Referenced by register_usb().

◆ usb_get_device_descriptor()

static int usb_get_device_descriptor ( struct usb_device usb,
struct usb_device_descriptor data 
)
inlinestatic

Get USB device descriptor.

Parameters
usbUSB device
dataDevice descriptor to fill in
Return values
rcReturn status code

Definition at line 1189 of file usb.h.

1190  {
1191 
1192  return usb_get_descriptor ( usb, 0, USB_DEVICE_DESCRIPTOR, 0, 0,
1193  &data->header, sizeof ( *data ) );
1194 }
struct arbelprm_port_state_change_st data
Message.
Definition: arbel.h:12
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.
Definition: usb.h:1156
Standard Device Descriptor USB 2.0 spec, Section 9.6.1.
Definition: Usb.h:111

References data, and usb_get_descriptor().

Referenced by register_usb().

◆ usb_get_config_descriptor()

static 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
usbUSB device
indexConfiguration index
dataConfiguration descriptor to fill in
Return values
rcReturn status code

Definition at line 1205 of file usb.h.

1207  {
1208 
1210  0, &data->header, len );
1211 }
#define USB_CONFIGURATION_DESCRIPTOR
A USB configuration descriptor.
Definition: usb.h:213
uint32_t len
Length.
Definition: ena.h:14
struct arbelprm_port_state_change_st data
Message.
Definition: arbel.h:12
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.
Definition: usb.h:1156
uint64_t index
Index of the first segment within the content.
Definition: pccrc.h:21

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

Referenced by usb_config_descriptor().

◆ usb_set_configuration()

static int usb_set_configuration ( struct usb_device usb,
unsigned int  index 
)
inlinestatic

Set USB configuration.

Parameters
usbUSB device
indexConfiguration index
Return values
rcReturn status code

Definition at line 1221 of file usb.h.

1221  {
1222 
1223  return usb_control ( usb, USB_SET_CONFIGURATION, index, 0, NULL, 0 );
1224 }
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.
Definition: usb.c:783
uint64_t index
Index of the first segment within the content.
Definition: pccrc.h:21
#define USB_SET_CONFIGURATION
Set configuration.
Definition: usb.h:131
#define NULL
NULL pointer (VOID *)
Definition: Base.h:362

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

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

◆ usb_set_interface()

static int usb_set_interface ( struct usb_device usb,
unsigned int  interface,
unsigned int  alternate 
)
inlinestatic

Set USB interface alternate setting.

Parameters
usbUSB device
interfaceInterface number
alternateAlternate setting
Return values
rcReturn status code

Definition at line 1235 of file usb.h.

1236  {
1237 
1239  NULL, 0 );
1240 }
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.
Definition: usb.c:783
An object interface.
Definition: interface.h:124
struct ib_cm_path alternate
Alternate path.
Definition: ib_mad.h:42
#define USB_SET_INTERFACE
Set interface.
Definition: usb.h:138
#define NULL
NULL pointer (VOID *)
Definition: Base.h:362

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

Referenced by usbnet_close(), and usbnet_open().

◆ usb_depth()

static unsigned int usb_depth ( struct usb_device usb)
inlinestatic

Get USB depth.

Parameters
usbUSB device
Return values
depthHub depth

Definition at line 1248 of file usb.h.

1248  {
1249  struct usb_device *parent;
1250  unsigned int depth;
1251 
1252  /* Navigate up to root hub, constructing depth as we go */
1253  for ( depth = 0 ; ( parent = usb->port->hub->usb ) ; usb = parent )
1254  depth++;
1255 
1256  return depth;
1257 }
struct usb_device * usb
Underlying USB device, if any.
Definition: usb.h:832
struct usb_port * port
USB port.
Definition: usb.h:712
A USB device.
Definition: usb.h:708
struct usb_hub * hub
USB hub.
Definition: usb.h:800

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 
)

Locate USB interface descriptor.

Parameters
configConfiguraton descriptor
interfaceInterface number
alternateAlternate setting
Return values
descInterface descriptor, or NULL if not found

Definition at line 143 of file usb.c.

144  {
145  struct usb_interface_descriptor *desc;
146 
147  /* Find a matching interface descriptor */
148  for_each_config_descriptor ( desc, config ) {
149  if ( ( desc->header.type == USB_INTERFACE_DESCRIPTOR ) &&
150  ( desc->interface == interface ) &&
151  ( desc->alternate == alternate ) )
152  return desc;
153  }
154  return NULL;
155 }
struct usb_descriptor_header header
Descriptor header.
Definition: usb.h:232
Standard Interface Descriptor USB 2.0 spec, Section 9.6.5.
Definition: Usb.h:147
#define for_each_config_descriptor(desc, config)
Iterate over all configuration descriptors.
Definition: usb.h:371
A USB interface descriptor.
Definition: usb.h:230
An object interface.
Definition: interface.h:124
struct ib_cm_path alternate
Alternate path.
Definition: ib_mad.h:42
uint8_t type
Descriptor type.
Definition: usb.h:162
uint8_t alternate
Alternate setting.
Definition: usb.h:236
#define NULL
NULL pointer (VOID *)
Definition: Base.h:362
uint8_t interface
Interface number.
Definition: usb.h:234

References alternate, usb_interface_descriptor::alternate, for_each_config_descriptor, usb_interface_descriptor::header, usb_interface_descriptor::interface, NULL, and usb_descriptor_header::type.

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 
)

Locate USB endpoint descriptor.

Parameters
configConfiguration descriptor
interfaceInterface descriptor
typeEndpoint (internal) type
indexEndpoint index
Return values
descDescriptor, or NULL if not found

Definition at line 167 of file usb.c.

169  {
170  struct usb_endpoint_descriptor *desc;
171  unsigned int attributes = ( type & USB_ENDPOINT_ATTR_TYPE_MASK );
172  unsigned int direction = ( type & USB_DIR_IN );
173 
174  /* Find a matching endpoint descriptor */
175  for_each_interface_descriptor ( desc, config, interface ) {
176  if ( ( desc->header.type == USB_ENDPOINT_DESCRIPTOR ) &&
177  ( ( desc->attributes &
179  ( ( desc->endpoint & USB_DIR_IN ) == direction ) &&
180  ( index-- == 0 ) )
181  return desc;
182  }
183  return NULL;
184 }
#define USB_ENDPOINT_ATTR_TYPE_MASK
Endpoint attribute transfer type mask.
Definition: usb.h:266
uint32_t type
Operating system type.
Definition: ena.h:12
#define for_each_interface_descriptor(desc, config, interface)
Iterate over all configuration descriptors within an interface descriptor.
Definition: usb.h:379
uint8_t direction
Direction.
Definition: ena.h:14
uint8_t endpoint
Endpoint address.
Definition: usb.h:253
An object interface.
Definition: interface.h:124
#define USB_DIR_IN
Data transfer is from device to host.
Definition: usb.h:83
uint8_t type
Descriptor type.
Definition: usb.h:162
uint8_t attributes
Attributes.
Definition: usb.h:255
Standard Endpoint Descriptor USB 2.0 spec, Section 9.6.6.
Definition: Usb.h:163
A USB endpoint descriptor.
Definition: usb.h:249
struct usb_descriptor_header header
Descriptor header.
Definition: usb.h:251
uint64_t index
Index of the first segment within the content.
Definition: pccrc.h:21
#define NULL
NULL pointer (VOID *)
Definition: Base.h:362

References usb_endpoint_descriptor::attributes, direction, usb_endpoint_descriptor::endpoint, for_each_interface_descriptor, usb_endpoint_descriptor::header, index, NULL, type, usb_descriptor_header::type, USB_DIR_IN, and USB_ENDPOINT_ATTR_TYPE_MASK.

Referenced by usb_endpoint_described().

◆ usb_endpoint_companion_descriptor()

Locate USB endpoint companion descriptor.

Parameters
configConfiguration descriptor
descEndpoint descriptor
Return values
descxCompanion descriptor, or NULL if not found

Definition at line 194 of file usb.c.

195  {
196  struct usb_endpoint_companion_descriptor *descx;
197 
198  /* Get companion descriptor, if present */
199  descx = container_of ( usb_next_descriptor ( &desc->header ),
201  header );
202  return ( ( usb_is_within_config ( config, &descx->header ) &&
204  ? descx : NULL );
205 }
struct usb_descriptor_header header
Descriptor header.
Definition: usb.h:301
static struct usb_descriptor_header * usb_next_descriptor(struct usb_descriptor_header *desc)
Get next USB descriptor.
Definition: usb.h:343
#define USB_ENDPOINT_COMPANION_DESCRIPTOR
A USB endpoint companion descriptor.
Definition: usb.h:311
#define container_of(ptr, type, field)
Get containing structure.
Definition: stddef.h:35
uint8_t type
Descriptor type.
Definition: usb.h:162
A USB endpoint companion descriptor.
Definition: usb.h:299
struct ena_aq_header header
Header.
Definition: ena.h:12
struct usb_descriptor_header header
Descriptor header.
Definition: usb.h:251
static int usb_is_within_config(struct usb_configuration_descriptor *config, struct usb_descriptor_header *desc)
Check that descriptor lies within a configuration descriptor.
Definition: usb.h:356
#define NULL
NULL pointer (VOID *)
Definition: Base.h:362

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

Referenced by usb_endpoint_described().

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

Allocate USB hub.

Parameters
busUSB bus
usbUnderlying USB device, if any
portsNumber of ports
driverHub driver operations
Return values
hubUSB hub, or NULL on allocation failure

Definition at line 1918 of file usb.c.

1920  {
1921  struct usb_hub *hub;
1922  struct usb_port *port;
1923  unsigned int i;
1924 
1925  /* Allocate and initialise structure */
1926  hub = zalloc ( sizeof ( *hub ) + ( ports * sizeof ( hub->port[0] ) ) );
1927  if ( ! hub )
1928  return NULL;
1929  hub->name = ( usb ? usb->name : bus->name );
1930  hub->bus = bus;
1931  hub->usb = usb;
1932  if ( usb )
1933  hub->protocol = usb->port->protocol;
1934  hub->ports = ports;
1935  hub->driver = driver;
1936  hub->host = &bus->op->hub;
1937 
1938  /* Initialise port list */
1939  for ( i = 1 ; i <= hub->ports ; i++ ) {
1940  port = usb_port ( hub, i );
1941  port->hub = hub;
1942  port->address = i;
1943  if ( usb )
1944  port->protocol = usb->port->protocol;
1945  INIT_LIST_HEAD ( &port->changed );
1946  }
1947 
1948  return hub;
1949 }
A USB hub.
Definition: usb.h:826
struct usb_hub_host_operations * host
Host controller operations.
Definition: usb.h:842
struct usb_device * usb
Currently attached device (if in use)
Definition: usb.h:820
unsigned int protocol
Port protocol.
Definition: usb.h:804
A USB port.
Definition: usb.h:798
struct usb_device * usb
Underlying USB device, if any.
Definition: usb.h:832
u8 port
Port number.
Definition: CIB_PRM.h:31
struct usb_port * port
USB port.
Definition: usb.h:712
struct usb_hub_driver_operations * driver
Driver operations.
Definition: usb.h:844
char name[32]
Name.
Definition: usb.h:710
unsigned int ports
Number of ports.
Definition: usb.h:836
const char * name
Name.
Definition: usb.h:828
void * zalloc(size_t size)
Allocate cleared memory.
Definition: malloc.c:624
#define INIT_LIST_HEAD(list)
Initialise a list head.
Definition: list.h:45
struct usb_hub * hub
USB hub.
Definition: usb.h:800
static struct usb_port * usb_port(struct usb_hub *hub, unsigned int address)
Get USB port.
Definition: usb.h:945
unsigned int protocol
Hub protocol.
Definition: usb.h:834
struct usb_bus * bus
USB bus.
Definition: usb.h:830
#define NULL
NULL pointer (VOID *)
Definition: Base.h:362
uint8_t bus
Bus.
Definition: edd.h:14
struct usb_port port[0]
Port list.
Definition: usb.h:852

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_port::protocol, usb_hub::protocol, usb_port::usb, usb_hub::usb, usb_port(), and zalloc().

Referenced by alloc_usb_bus(), and hub_probe().

◆ register_usb_hub()

int register_usb_hub ( struct usb_hub hub)

Register USB hub.

Parameters
hubUSB hub
Return values
rcReturn status code

Definition at line 1957 of file usb.c.

1957  {
1958  struct usb_bus *bus = hub->bus;
1959  struct usb_port *port;
1960  unsigned int i;
1961  int rc;
1962 
1963  /* Add to hub list */
1964  list_add_tail ( &hub->list, &bus->hubs );
1965 
1966  /* Open hub (host controller) */
1967  if ( ( rc = hub->host->open ( hub ) ) != 0 ) {
1968  DBGC ( hub, "USB hub %s could not open: %s\n",
1969  hub->name, strerror ( rc ) );
1970  goto err_host_open;
1971  }
1972 
1973  /* Open hub (driver) */
1974  if ( ( rc = hub->driver->open ( hub ) ) != 0 ) {
1975  DBGC ( hub, "USB hub %s could not open: %s\n",
1976  hub->name, strerror ( rc ) );
1977  goto err_driver_open;
1978  }
1979 
1980  /* Delay to allow ports to stabilise */
1982 
1983  /* Mark all ports as changed */
1984  for ( i = 1 ; i <= hub->ports ; i++ ) {
1985  port = usb_port ( hub, i );
1986  usb_port_changed ( port );
1987  }
1988 
1989  /* Some hubs seem to defer reporting device connections until
1990  * their interrupt endpoint is polled for the first time.
1991  * Poll the bus once now in order to pick up any such
1992  * connections.
1993  */
1994  usb_poll ( bus );
1995 
1996  return 0;
1997 
1998  hub->driver->close ( hub );
1999  err_driver_open:
2000  hub->host->close ( hub );
2001  err_host_open:
2002  list_del ( &hub->list );
2003  return rc;
2004 }
struct arbelprm_rc_send_wqe rc
Definition: arbel.h:14
struct usb_hub_host_operations * host
Host controller operations.
Definition: usb.h:842
#define DBGC(...)
Definition: compiler.h:505
void usb_port_changed(struct usb_port *port)
Report port status change.
Definition: usb.c:1839
int(* open)(struct usb_hub *hub)
Open hub.
Definition: usb.h:862
#define list_del(list)
Delete an entry from a list.
Definition: list.h:119
A USB port.
Definition: usb.h:798
u8 port
Port number.
Definition: CIB_PRM.h:31
struct usb_hub_driver_operations * driver
Driver operations.
Definition: usb.h:844
void(* close)(struct usb_hub *hub)
Close hub.
Definition: usb.h:867
#define list_add_tail(new, head)
Add a new entry to the tail of a list.
Definition: list.h:93
unsigned int ports
Number of ports.
Definition: usb.h:836
const char * name
Name.
Definition: usb.h:828
static void usb_poll(struct usb_bus *bus)
Poll USB bus.
Definition: usb.h:1051
char * strerror(int errno)
Retrieve string representation of error number.
Definition: strerror.c:78
void(* close)(struct usb_hub *hub)
Close hub.
Definition: usb.h:882
void mdelay(unsigned long msecs)
Delay for a fixed number of milliseconds.
Definition: timer.c:78
struct list_head list
List of hubs.
Definition: usb.h:839
struct usb_hub * hub
USB hub.
Definition: usb.h:800
#define USB_PORT_DELAY_MS
Time to wait for ports to stabilise.
Definition: usb.h:1332
struct usb_hub * hub
Root hub.
Definition: usb.h:974
static struct usb_port * usb_port(struct usb_hub *hub, unsigned int address)
Get USB port.
Definition: usb.h:945
struct usb_bus * bus
USB bus.
Definition: usb.h:830
A USB bus.
Definition: usb.h:951
uint8_t bus
Bus.
Definition: edd.h:14
int(* open)(struct usb_hub *hub)
Open hub.
Definition: usb.h:877

References bus, usb_hub::bus, usb_hub_host_operations::close, usb_hub_driver_operations::close, DBGC, usb_hub::driver, usb_hub::host, usb_port::hub, usb_bus::hub, usb_hub::list, list_add_tail, list_del, mdelay(), usb_hub::name, usb_hub_host_operations::open, usb_hub_driver_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)

Unregister USB hub.

Parameters
hubUSB hub

Definition at line 2011 of file usb.c.

2011  {
2012  struct usb_port *port;
2013  unsigned int i;
2014 
2015  /* Detach all devices */
2016  for ( i = 1 ; i <= hub->ports ; i++ ) {
2017  port = usb_port ( hub, i );
2018  if ( port->attached )
2019  usb_detached ( port );
2020  }
2021 
2022  /* Close hub (driver) */
2023  hub->driver->close ( hub );
2024 
2025  /* Close hub (host controller) */
2026  hub->host->close ( hub );
2027 
2028  /* Cancel any pending port status changes */
2029  for ( i = 1 ; i <= hub->ports ; i++ ) {
2030  port = usb_port ( hub, i );
2031  list_del ( &port->changed );
2032  INIT_LIST_HEAD ( &port->changed );
2033  }
2034 
2035  /* Remove from hub list */
2036  list_del ( &hub->list );
2037 }
static void usb_detached(struct usb_port *port)
Handle newly detached USB device.
Definition: usb.c:1776
struct usb_hub_host_operations * host
Host controller operations.
Definition: usb.h:842
#define list_del(list)
Delete an entry from a list.
Definition: list.h:119
A USB port.
Definition: usb.h:798
u8 port
Port number.
Definition: CIB_PRM.h:31
struct usb_hub_driver_operations * driver
Driver operations.
Definition: usb.h:844
void(* close)(struct usb_hub *hub)
Close hub.
Definition: usb.h:867
unsigned int ports
Number of ports.
Definition: usb.h:836
void(* close)(struct usb_hub *hub)
Close hub.
Definition: usb.h:882
#define INIT_LIST_HEAD(list)
Initialise a list head.
Definition: list.h:45
struct list_head list
List of hubs.
Definition: usb.h:839
struct usb_hub * hub
USB hub.
Definition: usb.h:800
static struct usb_port * usb_port(struct usb_hub *hub, unsigned int address)
Get USB port.
Definition: usb.h:945

References usb_hub_host_operations::close, usb_hub_driver_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)

Free USB hub.

Parameters
hubUSB hub

Definition at line 2044 of file usb.c.

2044  {
2045  struct usb_port *port;
2046  unsigned int i;
2047 
2048  /* Sanity checks */
2049  for ( i = 1 ; i <= hub->ports ; i++ ) {
2050  port = usb_port ( hub, i );
2051  assert ( ! port->attached );
2052  assert ( port->usb == NULL );
2053  assert ( list_empty ( &port->changed ) );
2054  }
2055 
2056  /* Free hub */
2057  free ( hub );
2058 }
#define list_empty(list)
Test whether a list is empty.
Definition: list.h:136
A USB port.
Definition: usb.h:798
u8 port
Port number.
Definition: CIB_PRM.h:31
assert((readw(&hdr->flags) &(GTF_reading|GTF_writing))==0)
unsigned int ports
Number of ports.
Definition: usb.h:836
static void(* free)(struct refcnt *refcnt))
Definition: refcnt.h:54
struct usb_hub * hub
USB hub.
Definition: usb.h:800
static struct usb_port * usb_port(struct usb_hub *hub, unsigned int address)
Get USB port.
Definition: usb.h:945
#define NULL
NULL pointer (VOID *)
Definition: Base.h:362

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)

Report port status change.

Parameters
portUSB port

Definition at line 1839 of file usb.c.

1839  {
1840 
1841  /* Record hub port status change */
1842  list_del ( &port->changed );
1843  list_add_tail ( &port->changed, &usb_changed );
1844 }
#define list_del(list)
Delete an entry from a list.
Definition: list.h:119
u8 port
Port number.
Definition: CIB_PRM.h:31
#define list_add_tail(new, head)
Add a new entry to the tail of a list.
Definition: list.h:93
static struct list_head usb_changed
List of changed ports.
Definition: usb.c:47

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 
)

Allocate USB bus.

Parameters
devUnderlying hardware device
portsNumber of root hub ports
mtuLargest transfer allowed on the bus
opHost controller operations
Return values
busUSB bus, or NULL on allocation failure

Definition at line 2076 of file usb.c.

2077  {
2078  struct usb_bus *bus;
2079 
2080  /* Allocate and initialise structure */
2081  bus = zalloc ( sizeof ( *bus ) );
2082  if ( ! bus )
2083  goto err_alloc_bus;
2084  bus->name = dev->name;
2085  bus->dev = dev;
2086  bus->mtu = mtu;
2087  bus->op = op;
2088  INIT_LIST_HEAD ( &bus->devices );
2089  INIT_LIST_HEAD ( &bus->hubs );
2090  bus->host = &bus->op->bus;
2091 
2092  /* Allocate root hub */
2093  bus->hub = alloc_usb_hub ( bus, NULL, ports, &op->root );
2094  if ( ! bus->hub )
2095  goto err_alloc_hub;
2096 
2097  return bus;
2098 
2099  free_usb_hub ( bus->hub );
2100  err_alloc_hub:
2101  free ( bus );
2102  err_alloc_bus:
2103  return NULL;
2104 }
char name[40]
Name.
Definition: device.h:75
struct device * dev
Underlying hardware device.
Definition: usb.h:955
static void(* free)(struct refcnt *refcnt))
Definition: refcnt.h:54
void * zalloc(size_t size)
Allocate cleared memory.
Definition: malloc.c:624
void free_usb_hub(struct usb_hub *hub)
Free USB hub.
Definition: usb.c:2044
static uint16_t struct vmbus_xfer_pages_operations * op
Definition: netvsc.h:327
#define INIT_LIST_HEAD(list)
Initialise a list head.
Definition: list.h:45
uint32_t mtu
Maximum MTU.
Definition: ena.h:28
#define NULL
NULL pointer (VOID *)
Definition: Base.h:362
A USB bus.
Definition: usb.h:951
uint8_t bus
Bus.
Definition: edd.h:14
struct usb_hub * alloc_usb_hub(struct usb_bus *bus, struct usb_device *usb, unsigned int ports, struct usb_hub_driver_operations *driver)
Allocate USB hub.
Definition: usb.c:1918

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_probe().

◆ register_usb_bus()

int register_usb_bus ( struct usb_bus bus)

Register USB bus.

Parameters
busUSB bus
Return values
rcReturn status code

Definition at line 2112 of file usb.c.

2112  {
2113  int rc;
2114 
2115  /* Sanity checks */
2116  assert ( bus->hub != NULL );
2117 
2118  /* Open bus */
2119  if ( ( rc = bus->host->open ( bus ) ) != 0 )
2120  goto err_open;
2121 
2122  /* Add to list of USB buses */
2123  list_add_tail ( &bus->list, &usb_buses );
2124 
2125  /* Register root hub */
2126  if ( ( rc = register_usb_hub ( bus->hub ) ) != 0 )
2127  goto err_register_hub;
2128 
2129  /* Attach any devices already present */
2130  usb_hotplug();
2131 
2132  return 0;
2133 
2134  unregister_usb_hub ( bus->hub );
2135  err_register_hub:
2136  list_del ( &bus->list );
2137  bus->host->close ( bus );
2138  err_open:
2139  return rc;
2140 }
struct arbelprm_rc_send_wqe rc
Definition: arbel.h:14
static void usb_hotplug(void)
Handle newly attached or detached USB device.
Definition: usb.c:1850
void unregister_usb_hub(struct usb_hub *hub)
Unregister USB hub.
Definition: usb.c:2011
#define list_del(list)
Delete an entry from a list.
Definition: list.h:119
assert((readw(&hdr->flags) &(GTF_reading|GTF_writing))==0)
#define list_add_tail(new, head)
Add a new entry to the tail of a list.
Definition: list.h:93
struct list_head usb_buses
List of USB buses.
Definition: usb.c:44
int register_usb_hub(struct usb_hub *hub)
Register USB hub.
Definition: usb.c:1957
#define NULL
NULL pointer (VOID *)
Definition: Base.h:362
uint8_t bus
Bus.
Definition: edd.h:14

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

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

◆ unregister_usb_bus()

void unregister_usb_bus ( struct usb_bus bus)

Unregister USB bus.

Parameters
busUSB bus

Definition at line 2147 of file usb.c.

2147  {
2148 
2149  /* Sanity checks */
2150  assert ( bus->hub != NULL );
2151 
2152  /* Unregister root hub */
2153  unregister_usb_hub ( bus->hub );
2154 
2155  /* Remove from list of USB buses */
2156  list_del ( &bus->list );
2157 
2158  /* Close bus */
2159  bus->host->close ( bus );
2160 
2161  /* Sanity checks */
2162  assert ( list_empty ( &bus->devices ) );
2163  assert ( list_empty ( &bus->hubs ) );
2164 }
void unregister_usb_hub(struct usb_hub *hub)
Unregister USB hub.
Definition: usb.c:2011
#define list_empty(list)
Test whether a list is empty.
Definition: list.h:136
#define list_del(list)
Delete an entry from a list.
Definition: list.h:119
assert((readw(&hdr->flags) &(GTF_reading|GTF_writing))==0)
#define NULL
NULL pointer (VOID *)
Definition: Base.h:362
uint8_t bus
Bus.
Definition: edd.h:14

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_probe(), and xhci_remove().

◆ free_usb_bus()

void free_usb_bus ( struct usb_bus bus)

Free USB bus.

Parameters
busUSB bus

Definition at line 2171 of file usb.c.

2171  {
2172  struct usb_endpoint *ep;
2173  struct usb_port *port;
2174 
2175  /* Sanity checks */
2176  assert ( list_empty ( &bus->devices ) );
2177  assert ( list_empty ( &bus->hubs ) );
2178  list_for_each_entry ( ep, &usb_halted, halted )
2179  assert ( ep->usb->port->hub->bus != bus );
2181  assert ( port->hub->bus != bus );
2182 
2183  /* Free root hub */
2184  free_usb_hub ( bus->hub );
2185 
2186  /* Free bus */
2187  free ( bus );
2188 }
struct list_head changed
List of changed ports.
Definition: usb.h:822
#define list_empty(list)
Test whether a list is empty.
Definition: list.h:136
A USB port.
Definition: usb.h:798
A USB endpoint.
Definition: usb.h:389
u8 port
Port number.
Definition: CIB_PRM.h:31
struct usb_port * port
USB port.
Definition: usb.h:712
assert((readw(&hdr->flags) &(GTF_reading|GTF_writing))==0)
#define list_for_each_entry(pos, head, member)
Iterate over entries in a list.
Definition: list.h:420
static void(* free)(struct refcnt *refcnt))
Definition: refcnt.h:54
void free_usb_hub(struct usb_hub *hub)
Free USB hub.
Definition: usb.c:2044
static struct list_head usb_halted
List of halted endpoints.
Definition: usb.c:50
struct usb_hub * hub
USB hub.
Definition: usb.h:800
struct usb_device * usb
USB device.
Definition: usb.h:391
static struct list_head usb_changed
List of changed ports.
Definition: usb.c:47
struct usb_bus * bus
USB bus.
Definition: usb.h:830
uint8_t bus
Bus.
Definition: edd.h:14

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_probe(), and xhci_remove().

◆ find_usb_bus_by_location()

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

Find USB bus by device location.

Parameters
bus_typeBus type
locationBus location
Return values
busUSB bus, or NULL

Definition at line 2197 of file usb.c.

2198  {
2199  struct usb_bus *bus;
2200 
2201  for_each_usb_bus ( bus ) {
2202  if ( ( bus->dev->desc.bus_type == bus_type ) &&
2203  ( bus->dev->desc.location == location ) )
2204  return bus;
2205  }
2206 
2207  return NULL;
2208 }
#define for_each_usb_bus(bus)
Iterate over all USB buses.
Definition: usb.h:1056
#define NULL
NULL pointer (VOID *)
Definition: Base.h:362
A USB bus.
Definition: usb.h:951
uint8_t bus
Bus.
Definition: edd.h:14

References bus, for_each_usb_bus, and NULL.

Referenced by uhci_root_speed().

◆ usb_alloc_address()

int usb_alloc_address ( struct usb_bus bus)

Allocate device address.

Parameters
busUSB bus
Return values
addressDevice address, or negative error

Definition at line 2223 of file usb.c.

2223  {
2224  unsigned int address;
2225 
2226  /* Find first free device address */
2227  address = ffsll ( ~bus->addresses );
2228  if ( ! address )
2229  return -ENOENT;
2230 
2231  /* Mark address as used */
2232  bus->addresses |= ( 1ULL << ( address - 1 ) );
2233 
2234  return address;
2235 }
uint64_t address
Base address.
Definition: ena.h:24
#define ENOENT
No such file or directory.
Definition: errno.h:514
#define ffsll(x)
Find first (i.e.
Definition: strings.h:122
uint8_t bus
Bus.
Definition: edd.h:14

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 
)

Free device address.

Parameters
busUSB bus
addressDevice address

Definition at line 2243 of file usb.c.

2243  {
2244 
2245  /* Sanity check */
2246  assert ( address > 0 );
2247  assert ( bus->addresses & ( 1ULL << ( address - 1 ) ) );
2248 
2249  /* Mark address as free */
2250  bus->addresses &= ~( 1ULL << ( address - 1 ) );
2251 }
uint64_t address
Base address.
Definition: ena.h:24
assert((readw(&hdr->flags) &(GTF_reading|GTF_writing))==0)
uint8_t bus
Bus.
Definition: edd.h:14

References address, assert(), and bus.

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

◆ usb_route_string()

unsigned int usb_route_string ( struct usb_device usb)

Get USB route string.

Parameters
usbUSB device
Return values
routeUSB route string

Definition at line 2266 of file usb.c.

2266  {
2267  struct usb_device *parent;
2268  unsigned int route;
2269 
2270  /* Navigate up to root hub, constructing route string as we go */
2271  for ( route = 0 ; ( parent = usb->port->hub->usb ) ; usb = parent ) {
2272  route <<= 4;
2273  route |= ( ( usb->port->address > 0xf ) ?
2274  0xf : usb->port->address );
2275  }
2276 
2277  return route;
2278 }
struct usb_device * usb
Underlying USB device, if any.
Definition: usb.h:832
struct usb_port * port
USB port.
Definition: usb.h:712
void route(void)
Print routing table.
Definition: route.c:39
A USB device.
Definition: usb.h:708
unsigned int address
Port address.
Definition: usb.h:802
struct usb_hub * hub
USB hub.
Definition: usb.h:800

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)

Get USB root hub port.

Parameters
usbUSB device
Return values
portRoot hub port

Definition at line 2286 of file usb.c.

2286  {
2287  struct usb_device *parent;
2288 
2289  /* Navigate up to root hub */
2290  while ( ( parent = usb->port->hub->usb ) )
2291  usb = parent;
2292 
2293  return usb->port;
2294 }
struct usb_device * usb
Underlying USB device, if any.
Definition: usb.h:832
struct usb_port * port
USB port.
Definition: usb.h:712
A USB device.
Definition: usb.h:708
struct usb_hub * hub
USB hub.
Definition: usb.h:800

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

Referenced by xhci_device_address().

◆ usb_transaction_translator()

struct usb_port* usb_transaction_translator ( struct usb_device usb)

Get USB transaction translator.

Parameters
usbUSB device
Return values
portTransaction translator port, or NULL

Definition at line 2302 of file usb.c.

2302  {
2303  struct usb_device *parent;
2304 
2305  /* Navigate up to root hub. If we find a low-speed or
2306  * full-speed device with a higher-speed parent hub, then that
2307  * device's port is the transaction translator.
2308  */
2309  for ( ; ( parent = usb->port->hub->usb ) ; usb = parent ) {
2310  if ( ( usb->speed <= USB_SPEED_FULL ) &&
2311  ( parent->speed > USB_SPEED_FULL ) )
2312  return usb->port;
2313  }
2314 
2315  return NULL;
2316 }
unsigned int speed
Device speed.
Definition: usb.h:714
struct usb_device * usb
Underlying USB device, if any.
Definition: usb.h:832
struct usb_port * port
USB port.
Definition: usb.h:712
A USB device.
Definition: usb.h:708
struct usb_hub * hub
USB hub.
Definition: usb.h:800
#define NULL
NULL pointer (VOID *)
Definition: Base.h:362
Full speed (12Mbps)
Definition: usb.h:50

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 
)

Find USB device driver.

Parameters
descFunction descriptor
Return values
idUSB device ID, or NULL
driverUSB device driver, or NULL

Definition at line 1168 of file usb.c.

1169  {
1170  struct usb_driver *driver;
1171  unsigned int i;
1172 
1173  /* Look for a matching driver */
1174  for_each_table_entry ( driver, USB_DRIVERS ) {
1175  for ( i = 0 ; i < driver->id_count ; i++ ) {
1176 
1177  /* Ignore non-matching driver class */
1178  if ( ( driver->class.class.scalar ^ desc->class.scalar )
1179  & driver->class.mask.scalar )
1180  continue;
1181 
1182  /* Look for a matching ID */
1183  *id = &driver->ids[i];
1184  if ( ( ( (*id)->vendor == desc->vendor ) ||
1185  ( (*id)->vendor == USB_ANY_ID ) ) &&
1186  ( ( (*id)->product == desc->product ) ||
1187  ( (*id)->product == USB_ANY_ID ) ) )
1188  return driver;
1189  }
1190  }
1191 
1192  /* Not found */
1193  *id = NULL;
1194  return NULL;
1195 }
A USB driver.
Definition: usb.h:1381
union usb_class_descriptor mask
Class mask.
Definition: usb.h:1354
uint16_t vendor
Vendor ID.
Definition: usb.h:644
union usb_class_descriptor class
Class.
Definition: usb.h:648
union usb_class_descriptor class
Class.
Definition: usb.h:1352
uint16_t product
Product ID.
Definition: usb.h:646
struct usb_class_id class
Class ID.
Definition: usb.h:1387
#define for_each_table_entry(pointer, table)
Iterate through all entries within a linker table.
Definition: tables.h:385
uint32_t scalar
Scalar value.
Definition: usb.h:633
#define USB_ANY_ID
Match-anything ID.
Definition: usb.h:1347
unsigned int id_count
Number of entries in ID table.
Definition: usb.h:1385
#define USB_DRIVERS
USB driver table.
Definition: usb.h:1412
#define NULL
NULL pointer (VOID *)
Definition: Base.h:362
struct usb_device_id * ids
USB ID table.
Definition: usb.h:1383

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

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

Variable Documentation

◆ usb_buses

struct list_head usb_buses

List of USB buses.

Definition at line 44 of file usb.c.

Referenced by register_usb_bus().