iPXE
Data Structures | Functions | Variables
usb.c File Reference

Universal Serial Bus (USB) More...

#include <stdlib.h>
#include <stdio.h>
#include <string.h>
#include <strings.h>
#include <unistd.h>
#include <errno.h>
#include <assert.h>
#include <byteswap.h>
#include <ipxe/usb.h>
#include <ipxe/cdc.h>

Go to the source code of this file.

Data Structures

struct  usb_control_pseudo_header
 USB control transfer pseudo-header. More...
 

Functions

 FILE_LICENCE (GPL2_OR_LATER_OR_UBDL)
 
static const char * usb_speed_name (unsigned int speed)
 Get USB speed name (for debugging) More...
 
static const char * usb_bcd (uint16_t bcd)
 Transcribe USB BCD-coded value (for debugging) More...
 
static struct usb_interface_association_descriptorusb_interface_association_descriptor (struct usb_configuration_descriptor *config, unsigned int first)
 Locate USB interface association descriptor. 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...
 
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...
 
static int usb_endpoint_clear_tt (struct usb_endpoint *ep)
 Clear transaction translator (if applicable) 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...
 
static int usb_endpoint_reset (struct usb_endpoint *ep)
 Reset USB endpoint. More...
 
static int usb_endpoint_mtu (struct usb_endpoint *ep, size_t mtu)
 Update endpoint MTU. 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...
 
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_control_complete (struct usb_endpoint *ep, struct io_buffer *iobuf, int rc)
 Complete USB control transfer. 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...
 
static unsigned int usb_get_default_language (struct usb_device *usb)
 Get default language ID. 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_config_descriptor (struct usb_device *usb, unsigned int index, struct usb_configuration_descriptor **config)
 Get USB configuration descriptor. More...
 
static int usb_describe (struct usb_device *usb, struct usb_configuration_descriptor *config, unsigned int first, uint8_t *interfaces, struct usb_function_descriptor *desc)
 Describe USB function. More...
 
static int usb_used (struct usb_device *usb, unsigned int count, uint8_t *interface, uint8_t *used)
 Update list of used interface. More...
 
struct usb_driverusb_find_driver (struct usb_function_descriptor *desc, struct usb_device_id **id)
 Find USB device driver. More...
 
static int usb_score (struct usb_device *usb, struct usb_configuration_descriptor *config)
 Get USB device configuration score. More...
 
static int usb_probe (struct usb_function *func, struct usb_configuration_descriptor *config)
 Probe USB device driver. More...
 
static void usb_remove (struct usb_function *func)
 Remove USB device driver. More...
 
static void usb_probe_all (struct usb_device *usb, struct usb_configuration_descriptor *config)
 Probe all USB device drivers. More...
 
static void usb_remove_all (struct usb_device *usb)
 Remove all device drivers. More...
 
static void usb_deconfigure (struct usb_device *usb)
 Clear USB device configuration. More...
 
static int usb_autoconfigure (struct usb_device *usb)
 Choose our preferred USB device configuration. More...
 
static struct usb_devicealloc_usb (struct usb_port *port)
 Allocate USB device. More...
 
static int register_usb (struct usb_device *usb)
 Register USB device. More...
 
static void unregister_usb (struct usb_device *usb)
 Unregister USB device. More...
 
static void free_usb (struct usb_device *usb)
 Free USB device. More...
 
static int usb_attached (struct usb_port *port)
 Handle newly attached USB device. More...
 
static void usb_detached (struct usb_port *port)
 Handle newly detached USB device. More...
 
static int usb_hotplugged (struct usb_port *port)
 Handle newly attached or detached USB device. More...
 
void usb_port_changed (struct usb_port *port)
 Report port status change. More...
 
static void usb_hotplug (void)
 Handle newly attached or detached USB device. More...
 
static void usb_step (struct process *process __unused)
 USB process. More...
 
 PERMANENT_PROCESS (usb_process, usb_step)
 USB process. More...
 
struct usb_huballoc_usb_hub (struct usb_bus *bus, struct usb_device *usb, unsigned int ports, struct usb_hub_driver_operations *driver)
 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...
 
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...
 
 REQUIRING_SYMBOL (register_usb_bus)
 
 REQUIRE_OBJECT (config_usb)
 
 REQUIRE_OBJECT (usbhub)
 

Variables

struct list_head usb_buses = LIST_HEAD_INIT ( usb_buses )
 List of USB buses. More...
 
static struct list_head usb_changed = LIST_HEAD_INIT ( usb_changed )
 List of changed ports. More...
 
static struct list_head usb_halted = LIST_HEAD_INIT ( usb_halted )
 List of halted endpoints. More...
 
static struct usb_endpoint_driver_operations usb_control_operations
 USB control endpoint driver operations. More...
 

Detailed Description

Universal Serial Bus (USB)

Definition in file usb.c.

Function Documentation

◆ FILE_LICENCE()

FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL  )

◆ usb_speed_name()

static const char* usb_speed_name ( unsigned int  speed)
inlinestatic

Get USB speed name (for debugging)

Parameters
speedSpeed
Return values
nameSpeed name

Definition at line 65 of file usb.c.

65  {
66  static const char *exponents[4] = { "", "k", "M", "G" };
67  static char buf[ 10 /* "xxxxxXbps" + NUL */ ];
68  unsigned int mantissa;
69  unsigned int exponent;
70 
71  /* Extract mantissa and exponent */
72  mantissa = USB_SPEED_MANTISSA ( speed );
73  exponent = USB_SPEED_EXPONENT ( speed );
74 
75  /* Name speed */
76  switch ( speed ) {
77  case USB_SPEED_NONE: return "DETACHED";
78  case USB_SPEED_LOW: return "low";
79  case USB_SPEED_FULL: return "full";
80  case USB_SPEED_HIGH: return "high";
81  case USB_SPEED_SUPER: return "super";
82  default:
83  snprintf ( buf, sizeof ( buf ), "%d%sbps",
84  mantissa, exponents[exponent] );
85  return buf;
86  }
87 }
#define USB_SPEED_EXPONENT(speed)
Extract USB speed exponent.
Definition: usb.h:41
Low speed (1.5Mbps)
Definition: usb.h:48
#define USB_SPEED_MANTISSA(speed)
Extract USB speed mantissa.
Definition: usb.h:38
Super speed (5Gbps)
Definition: usb.h:54
Not connected.
Definition: usb.h:46
High speed (480Mbps)
Definition: usb.h:52
int snprintf(char *buf, size_t size, const char *fmt,...)
Write a formatted string to a buffer.
Definition: vsprintf.c:382
Full speed (12Mbps)
Definition: usb.h:50

References snprintf(), USB_SPEED_EXPONENT, USB_SPEED_FULL, USB_SPEED_HIGH, USB_SPEED_LOW, USB_SPEED_MANTISSA, USB_SPEED_NONE, and USB_SPEED_SUPER.

Referenced by register_usb().

◆ usb_bcd()

static const char* usb_bcd ( uint16_t  bcd)
inlinestatic

Transcribe USB BCD-coded value (for debugging)

Parameters
bcdBCD-coded value
Return values
stringTranscribed value

Definition at line 95 of file usb.c.

95  {
96  static char buf[ 6 /* "xx.xx" + NUL */ ];
97  uint8_t high = ( bcd >> 8 );
98  uint8_t low = ( bcd >> 0 );
99 
100  snprintf ( buf, sizeof ( buf ), "%x.%02x", high, low );
101  return buf;
102 }
uint32_t low
Low 16 bits of address.
Definition: myson.h:19
uint32_t high
High 32 bits of address.
Definition: myson.h:20
unsigned char uint8_t
Definition: stdint.h:10
int snprintf(char *buf, size_t size, const char *fmt,...)
Write a formatted string to a buffer.
Definition: vsprintf.c:382

References high, low, and snprintf().

Referenced by register_usb().

◆ usb_interface_association_descriptor()

static struct usb_interface_association_descriptor* usb_interface_association_descriptor ( struct usb_configuration_descriptor config,
unsigned int  first 
)
static

Locate USB interface association descriptor.

Parameters
configConfiguraton descriptor
firstFirst interface number
Return values
descInterface association descriptor, or NULL if not found

Definition at line 119 of file usb.c.

121  {
123 
124  /* Find a matching interface association descriptor */
125  for_each_config_descriptor ( desc, config ) {
126  if ( ( desc->header.type ==
128  ( desc->first == first ) )
129  return desc;
130  }
131  return NULL;
132 }
A USB interface association descriptor.
Definition: usb.h:314
#define for_each_config_descriptor(desc, config)
Iterate over all configuration descriptors.
Definition: usb.h:371
struct usb_descriptor_header header
Descriptor header.
Definition: usb.h:316
uint8_t type
Descriptor type.
Definition: usb.h:162
#define USB_INTERFACE_ASSOCIATION_DESCRIPTOR
A USB interface association descriptor.
Definition: usb.h:328
uint8_t first
First interface number.
Definition: usb.h:318
#define NULL
NULL pointer (VOID *)
Definition: Base.h:362
uint32_t first
Length to skip in first segment.
Definition: pccrc.h:23

References first, usb_interface_association_descriptor::first, for_each_config_descriptor, usb_interface_association_descriptor::header, NULL, usb_descriptor_header::type, and USB_INTERFACE_ASSOCIATION_DESCRIPTOR.

Referenced by usb_describe().

◆ 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
uint8_t type
Type.
Definition: ena.h:16
#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, header, usb_endpoint_descriptor::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().

◆ 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
uint8_t type
Type.
Definition: ena.h:16
#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_tt()

static int usb_endpoint_clear_tt ( struct usb_endpoint ep)
static

Clear transaction translator (if applicable)

Parameters
epUSB endpoint
Return values
rcReturn status code

Definition at line 340 of file usb.c.

340  {
341  struct usb_device *usb = ep->usb;
342  struct usb_port *tt;
343  int rc;
344 
345  /* Do nothing if this is a periodic endpoint */
347  return 0;
348 
349  /* Do nothing if this endpoint is not behind a transaction translator */
351  if ( ! tt )
352  return 0;
353 
354  /* Clear transaction translator buffer */
355  if ( ( rc = tt->hub->driver->clear_tt ( tt->hub, tt, ep ) ) != 0 ) {
356  DBGC ( usb, "USB %s %s could not clear transaction translator: "
357  "%s\n", usb->name, usb_endpoint_name ( ep ),
358  strerror ( rc ) );
359  return rc;
360  }
361 
362  return 0;
363 }
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 USB_ENDPOINT_ATTR_PERIODIC
Endpoint periodic type.
Definition: usb.h:269
int(* clear_tt)(struct usb_hub *hub, struct usb_port *port, struct usb_endpoint *ep)
Clear transaction translator buffer.
Definition: usb.h:911
A USB port.
Definition: usb.h:798
struct usb_hub_driver_operations * driver
Driver operations.
Definition: usb.h:844
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
struct usb_port * usb_transaction_translator(struct usb_device *usb)
Get USB transaction translator.
Definition: usb.c:2302
struct usb_hub * hub
USB hub.
Definition: usb.h:800
struct usb_endpoint * ep[32]
Endpoint list.
Definition: usb.h:730
struct usb_device * usb
USB device.
Definition: usb.h:391
unsigned int attributes
Attributes.
Definition: usb.h:395

References usb_endpoint::attributes, usb_hub_driver_operations::clear_tt, DBGC, usb_hub::driver, usb_device::ep, usb_port::hub, usb_device::name, rc, strerror(), usb_endpoint::usb, usb_port::usb, USB_ENDPOINT_ATTR_PERIODIC, usb_endpoint_name(), and usb_transaction_translator().

Referenced by usb_endpoint_clear_halt(), and usb_endpoint_close().

◆ 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
uint8_t type
Type.
Definition: ena.h:16
#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_endpoint_reset()

static int usb_endpoint_reset ( struct usb_endpoint ep)
static

Reset USB endpoint.

Parameters
epUSB endpoint
Return values
rcReturn status code

Definition at line 429 of file usb.c.

429  {
430  struct usb_device *usb = ep->usb;
431  int rc;
432 
433  /* Sanity check */
434  assert ( ! list_empty ( &ep->halted ) );
435 
436  /* Clear device halt, if applicable */
437  if ( ( rc = usb_endpoint_clear_halt ( ep ) ) != 0 )
438  return rc;
439 
440  /* Reset endpoint */
441  if ( ( rc = ep->host->reset ( ep ) ) != 0 ) {
442  DBGC ( usb, "USB %s %s could not reset: %s\n",
443  usb->name, usb_endpoint_name ( ep ), strerror ( rc ) );
444  return rc;
445  }
446 
447  /* Remove from list of halted endpoints */
448  list_del ( &ep->halted );
449  INIT_LIST_HEAD ( &ep->halted );
450 
451  DBGC ( usb, "USB %s %s reset\n",
452  usb->name, usb_endpoint_name ( ep ) );
453  return 0;
454 }
struct arbelprm_rc_send_wqe rc
Definition: arbel.h:14
#define DBGC(...)
Definition: compiler.h:505
int usb_endpoint_clear_halt(struct usb_endpoint *ep)
Clear endpoint halt (if applicable)
Definition: usb.c:371
int(* reset)(struct usb_endpoint *ep)
Reset endpoint.
Definition: usb.h:447
#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)
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
const char * usb_endpoint_name(struct usb_endpoint *ep)
Get USB endpoint name (for debugging)
Definition: usb.c:220
#define INIT_LIST_HEAD(list)
Initialise a list head.
Definition: list.h:45
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

References assert(), DBGC, usb_device::ep, usb_endpoint::halted, usb_endpoint::host, INIT_LIST_HEAD, list_del, list_empty, usb_device::name, rc, usb_endpoint_host_operations::reset, strerror(), usb_endpoint::usb, usb_endpoint_clear_halt(), and usb_endpoint_name().

Referenced by usb_control(), usb_message(), usb_step(), and usb_stream().

◆ usb_endpoint_mtu()

static int usb_endpoint_mtu ( struct usb_endpoint ep,
size_t  mtu 
)
static

Update endpoint MTU.

Parameters
epUSB endpoint
mtuNew MTU
Return values
rcReturn status code

Definition at line 463 of file usb.c.

463  {
464  struct usb_device *usb = ep->usb;
465  int rc;
466 
467  /* Update MTU */
468  ep->mtu = mtu;
469  if ( ( rc = ep->host->mtu ( ep ) ) != 0 ) {
470  DBGC ( usb, "USB %s %s could not update MTU: %s\n",
471  usb->name, usb_endpoint_name ( ep ), strerror ( rc ) );
472  return rc;
473  }
474 
475  return 0;
476 }
struct arbelprm_rc_send_wqe rc
Definition: arbel.h:14
int(* mtu)(struct usb_endpoint *ep)
Update MTU.
Definition: usb.h:453
#define DBGC(...)
Definition: compiler.h:505
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
size_t mtu
Maximum transfer size.
Definition: usb.h:397
uint32_t mtu
Maximum MTU.
Definition: ena.h:28
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

References DBGC, usb_device::ep, usb_endpoint::host, mtu, usb_endpoint::mtu, usb_endpoint_host_operations::mtu, usb_device::name, rc, strerror(), usb_endpoint::usb, and usb_endpoint_name().

Referenced by register_usb().

◆ 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_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_control_complete()

static void usb_control_complete ( struct usb_endpoint ep,
struct io_buffer iobuf,
int  rc 
)
static

Complete USB control transfer.

Parameters
epUSB endpoint
iobufI/O buffer
rcCompletion status code

Definition at line 754 of file usb.c.

755  {
756  struct usb_device *usb = ep->usb;
757  struct usb_control_pseudo_header *pshdr;
758 
759  /* Record completion status in buffer */
760  pshdr = iob_push ( iobuf, sizeof ( *pshdr ) );
761  pshdr->rc = rc;
762 
763  /* Add to list of completed I/O buffers */
764  list_add_tail ( &iobuf->list, &usb->complete );
765 }
struct arbelprm_rc_send_wqe rc
Definition: arbel.h:14
#define iob_push(iobuf, len)
Definition: iobuf.h:84
int rc
Completion status.
Definition: usb.c:744
#define list_add_tail(new, head)
Add a new entry to the tail of a list.
Definition: list.h:93
A USB device.
Definition: usb.h:708
USB control transfer pseudo-header.
Definition: usb.c:742
struct list_head list
List of which this buffer is a member.
Definition: iobuf.h:40
struct list_head complete
Completed control transfers.
Definition: usb.h:735
struct usb_endpoint * ep[32]
Endpoint list.
Definition: usb.h:730
struct usb_device * usb
USB device.
Definition: usb.h:391

References usb_device::complete, usb_device::ep, iob_push, io_buffer::list, list_add_tail, rc, usb_control_pseudo_header::rc, and usb_endpoint::usb.

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

static unsigned int usb_get_default_language ( struct usb_device usb)
static

Get default language ID.

Parameters
usbUSB device
Return values
languageLanguage ID

Definition at line 883 of file usb.c.

883  {
884  struct {
886  uint16_t language[1];
887  } __attribute__ (( packed )) desc;
888  unsigned int language;
889  int rc;
890 
891  /* Get descriptor */
892  if ( ( rc = usb_get_descriptor ( usb, 0, USB_STRING_DESCRIPTOR, 0, 0,
893  &desc.header, sizeof ( desc ) ) ) !=0){
894  DBGC ( usb, "USB %s has no default language: %s\n",
895  usb->name, strerror ( rc ) );
896  return USB_LANG_ENGLISH;
897  }
898 
899  /* Use first language ID */
900  language = le16_to_cpu ( desc.language[0] );
901  DBGC2 ( usb, "USB %s default language %#04x\n", usb->name, language );
902  return language;
903 }
#define __attribute__(x)
Definition: compiler.h:10
struct arbelprm_rc_send_wqe rc
Definition: arbel.h:14
unsigned short uint16_t
Definition: stdint.h:11
#define USB_STRING_DESCRIPTOR
A USB string descriptor.
Definition: usb.h:224
#define DBGC(...)
Definition: compiler.h:505
char name[32]
Name.
Definition: usb.h:710
char * strerror(int errno)
Retrieve string representation of error number.
Definition: strerror.c:78
#define USB_LANG_ENGLISH
Language ID for English.
Definition: usb.h:227
#define le16_to_cpu(value)
Definition: byteswap.h:112
A USB descriptor header.
Definition: usb.h:158
#define DBGC2(...)
Definition: compiler.h:522
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

References __attribute__, DBGC, DBGC2, header, le16_to_cpu, usb_device::name, rc, strerror(), usb_get_descriptor(), USB_LANG_ENGLISH, and USB_STRING_DESCRIPTOR.

Referenced by usb_get_string_descriptor().

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

static int usb_config_descriptor ( struct usb_device usb,
unsigned int  index,
struct usb_configuration_descriptor **  config 
)
static

Get USB configuration descriptor.

Parameters
usbUSB device
indexConfiguration index
Return values
configConfiguration descriptor
rcReturn status code

The configuration descriptor is dynamically allocated and must eventually be freed by the caller.

Definition at line 991 of file usb.c.

992  {
993  struct usb_configuration_descriptor partial;
994  size_t len;
995  int rc;
996 
997  /* Read first part of configuration descriptor to get size */
998  if ( ( rc = usb_get_config_descriptor ( usb, index, &partial,
999  sizeof ( partial ) ) ) != 0 ) {
1000  DBGC ( usb, "USB %s could not get configuration descriptor %d: "
1001  "%s\n", usb->name, index, strerror ( rc ) );
1002  goto err_get_partial;
1003  }
1004  len = le16_to_cpu ( partial.len );
1005  if ( len < sizeof ( partial ) ) {
1006  DBGC ( usb, "USB %s underlength configuraton descriptor %d\n",
1007  usb->name, index );
1008  rc = -EINVAL;
1009  goto err_partial_len;
1010  }
1011 
1012  /* Allocate buffer for whole configuration descriptor */
1013  *config = malloc ( len );
1014  if ( ! *config ) {
1015  rc = -ENOMEM;
1016  goto err_alloc_config;
1017  }
1018 
1019  /* Read whole configuration descriptor */
1020  if ( ( rc = usb_get_config_descriptor ( usb, index, *config,
1021  len ) ) != 0 ) {
1022  DBGC ( usb, "USB %s could not get configuration descriptor %d: "
1023  "%s\n", usb->name, index, strerror ( rc ) );
1024  goto err_get_config_descriptor;
1025  }
1026  if ( (*config)->len != partial.len ) {
1027  DBGC ( usb, "USB %s bad configuration descriptor %d length\n",
1028  usb->name, index );
1029  rc = -EINVAL;
1030  goto err_config_len;
1031  }
1032 
1033  return 0;
1034 
1035  err_config_len:
1036  err_get_config_descriptor:
1037  free ( *config );
1038  err_alloc_config:
1039  err_partial_len:
1040  err_get_partial:
1041  return rc;
1042 }
#define EINVAL
Invalid argument.
Definition: errno.h:428
struct arbelprm_rc_send_wqe rc
Definition: arbel.h:14
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.
Definition: usb.h:1205
#define DBGC(...)
Definition: compiler.h:505
#define ENOMEM
Not enough space.
Definition: errno.h:534
char name[32]
Name.
Definition: usb.h:710
char * strerror(int errno)
Retrieve string representation of error number.
Definition: strerror.c:78
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 configuration descriptor.
Definition: usb.h:195
uint32_t len
Length.
Definition: ena.h:14
uint8_t config
Configuration value.
Definition: usb.h:203
uint64_t index
Index of the first segment within the content.
Definition: pccrc.h:21

References usb_configuration_descriptor::config, DBGC, EINVAL, ENOMEM, free, index, le16_to_cpu, len, usb_configuration_descriptor::len, malloc(), usb_device::name, rc, strerror(), and usb_get_config_descriptor().

Referenced by usb_autoconfigure().

◆ usb_describe()

static int usb_describe ( struct usb_device usb,
struct usb_configuration_descriptor config,
unsigned int  first,
uint8_t interfaces,
struct usb_function_descriptor desc 
)
static

Describe USB function.

Parameters
usbUSB device
configConfiguration descriptor
firstFirst interface number
interfacesInterface list to fill in
descFunction descriptor to fill in
Return values
rcReturn status code

Definition at line 1054 of file usb.c.

1057  {
1058  struct usb_interface_association_descriptor *association;
1060  struct cdc_union_descriptor *cdc_union;
1061  unsigned int i;
1062 
1063  /* Fill in vendor and product ID */
1064  memset ( desc, 0, sizeof ( *desc ) );
1065  desc->vendor = le16_to_cpu ( usb->device.vendor );
1066  desc->product = le16_to_cpu ( usb->device.product );
1067 
1068  /* First, look for an interface association descriptor */
1069  association = usb_interface_association_descriptor ( config, first );
1070  if ( association ) {
1071 
1072  /* Sanity check */
1073  assert ( association->first == first );
1074  if ( ( first + association->count ) > config->interfaces ) {
1075  DBGC ( usb, "USB %s has invalid association [%d-%d)\n",
1076  usb->name, first, ( first + association->count));
1077  return -ERANGE;
1078  }
1079 
1080  /* Describe function */
1081  memcpy ( &desc->class.class, &association->class,
1082  sizeof ( desc->class.class ) );
1083  desc->count = association->count;
1084  for ( i = 0 ; i < association->count ; i++ )
1085  interfaces[i] = ( first + i );
1086  return 0;
1087  }
1088 
1089  /* Next, look for an interface descriptor */
1090  interface = usb_interface_descriptor ( config, first, 0 );
1091  if ( ! interface ) {
1092  DBGC ( usb, "USB %s has no descriptor for interface %d\n",
1093  usb->name, first );
1094  return -ENOENT;
1095  }
1096 
1097  /* Describe function */
1098  memcpy ( &desc->class.class, &interface->class,
1099  sizeof ( desc->class.class ) );
1100  desc->count = 1;
1101  interfaces[0] = first;
1102 
1103  /* Look for a CDC union descriptor, if applicable */
1104  if ( ( desc->class.class.class == USB_CLASS_CDC ) &&
1105  ( cdc_union = cdc_union_descriptor ( config, interface ) ) ) {
1106 
1107  /* Determine interface count */
1108  desc->count = ( ( cdc_union->header.len -
1109  offsetof ( typeof ( *cdc_union ),
1110  interface[0] ) ) /
1111  sizeof ( cdc_union->interface[0] ) );
1112  if ( desc->count > config->interfaces ) {
1113  DBGC ( usb, "USB %s has invalid union functional "
1114  "descriptor with %d interfaces\n",
1115  usb->name, desc->count );
1116  return -ERANGE;
1117  }
1118 
1119  /* Describe function */
1120  for ( i = 0 ; i < desc->count ; i++ ) {
1121  if ( cdc_union->interface[i] >= config->interfaces ) {
1122  DBGC ( usb, "USB %s has invalid union "
1123  "functional descriptor covering "
1124  "interface %d\n", usb->name,
1125  cdc_union->interface[i] );
1126  return -ERANGE;
1127  }
1128  interfaces[i] = cdc_union->interface[i];
1129  }
1130 
1131  return 0;
1132  }
1133 
1134  return 0;
1135 }
uint8_t class
Class code.
Definition: usb.h:147
uint8_t len
Length of descriptor.
Definition: usb.h:160
unsigned int count
Number of interfaces.
Definition: usb.h:650
uint16_t vendor
Vendor ID.
Definition: usb.h:176
A USB interface association descriptor.
Definition: usb.h:314
#define DBGC(...)
Definition: compiler.h:505
uint16_t vendor
Vendor ID.
Definition: usb.h:644
#define ENOENT
No such file or directory.
Definition: errno.h:514
uint8_t interfaces
Number of interfaces.
Definition: usb.h:201
#define offsetof(type, field)
Get offset of a field within a structure.
Definition: stddef.h:24
union usb_class_descriptor class
Class.
Definition: usb.h:648
uint16_t product
Product ID.
Definition: usb.h:646
uint16_t product
Product ID.
Definition: usb.h:178
void * memcpy(void *dest, const void *src, size_t len) __nonnull
A USB interface descriptor.
Definition: usb.h:230
assert((readw(&hdr->flags) &(GTF_reading|GTF_writing))==0)
An object interface.
Definition: interface.h:124
struct usb_descriptor_header header
Descriptor header.
Definition: cdc.h:30
Union functional descriptor.
Definition: cdc.h:28
char name[32]
Name.
Definition: usb.h:710
#define ERANGE
Result too large.
Definition: errno.h:639
static const char * interfaces[2]
Definition: smc9000.c:52
struct usb_device_descriptor device
Device descriptor.
Definition: usb.h:720
#define le16_to_cpu(value)
Definition: byteswap.h:112
uint8_t count
Interface count.
Definition: usb.h:320
#define USB_CLASS_CDC
Class code for communications devices.
Definition: cdc.h:15
uint8_t first
First interface number.
Definition: usb.h:318
struct usb_class class
Association class.
Definition: usb.h:322
static struct usb_interface_association_descriptor * usb_interface_association_descriptor(struct usb_configuration_descriptor *config, unsigned int first)
Locate USB interface association descriptor.
Definition: usb.c:119
uint8_t interface
Interface number.
Definition: usb.h:234
uint8_t interface[1]
Interfaces (variable-length)
Definition: cdc.h:34
uint32_t first
Length to skip in first segment.
Definition: pccrc.h:23
struct usb_class class
Class.
Definition: usb.h:631
void * memset(void *dest, int character, size_t len) __nonnull

References assert(), usb_class::class, usb_interface_association_descriptor::class, usb_class_descriptor::class, usb_function_descriptor::class, usb_interface_association_descriptor::count, usb_function_descriptor::count, DBGC, usb_device::device, ENOENT, ERANGE, first, usb_interface_association_descriptor::first, cdc_union_descriptor::header, cdc_union_descriptor::interface, usb_interface_descriptor::interface, interfaces, usb_configuration_descriptor::interfaces, le16_to_cpu, usb_descriptor_header::len, memcpy(), memset(), usb_device::name, offsetof, usb_device_descriptor::product, usb_function_descriptor::product, USB_CLASS_CDC, usb_interface_association_descriptor(), usb_device_descriptor::vendor, and usb_function_descriptor::vendor.

Referenced by usb_probe_all(), and usb_score().

◆ usb_used()

static int usb_used ( struct usb_device usb,
unsigned int  count,
uint8_t interface,
uint8_t used 
)
static

Update list of used interface.

Parameters
usbUSB device
countNumber of interfaces
interfaceList of interfaces
usedList of already-used interfaces
Return values
rcReturn status code

Definition at line 1146 of file usb.c.

1147  {
1148  unsigned int i;
1149 
1150  for ( i = 0 ; i < count ; i++ ) {
1151  if ( used[interface[i]] ) {
1152  DBGC ( usb, "USB %s interface %d already in use\n",
1153  usb->name, interface[i] );
1154  return -EINVAL;
1155  }
1156  used[interface[i]] = 1;
1157  }
1158  return 0;
1159 }
#define EINVAL
Invalid argument.
Definition: errno.h:428
#define DBGC(...)
Definition: compiler.h:505
An object interface.
Definition: interface.h:124
char name[32]
Name.
Definition: usb.h:710
uint16_t count
Number of entries.
Definition: ena.h:22

References count, DBGC, EINVAL, and usb_device::name.

Referenced by usb_probe_all(), and usb_score().

◆ 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:358
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().

◆ usb_score()

static int usb_score ( struct usb_device usb,
struct usb_configuration_descriptor config 
)
static

Get USB device configuration score.

Parameters
usbUSB device
configConfiguration descriptor
Return values
scoreDevice configuration score, or negative error

Definition at line 1204 of file usb.c.

1205  {
1206  uint8_t used[config->interfaces];
1207  uint8_t interface[config->interfaces];
1208  struct usb_function_descriptor desc;
1209  struct usb_driver *driver;
1210  struct usb_device_id *id;
1211  unsigned int first;
1212  unsigned int score = 0;
1213  int rc;
1214 
1215  /* Identify each function in turn */
1216  memset ( used, 0, sizeof ( used ) );
1217  for ( first = 0 ; first < config->interfaces ; first++ ) {
1218 
1219  /* Skip interfaces already used */
1220  if ( used[first] )
1221  continue;
1222 
1223  /* Describe function */
1224  if ( ( rc = usb_describe ( usb, config, first, interface,
1225  &desc ) ) != 0 )
1226  return rc;
1227 
1228  /* Update used interfaces */
1229  if ( ( rc = usb_used ( usb, desc.count, interface,
1230  used ) ) != 0 )
1231  return rc;
1232 
1233  /* Look for a driver for this function */
1234  driver = usb_find_driver ( &desc, &id );
1235  if ( driver )
1236  score += driver->score;
1237  }
1238 
1239  return score;
1240 }
A USB driver.
Definition: usb.h:1381
struct arbelprm_rc_send_wqe rc
Definition: arbel.h:14
A USB device ID.
Definition: usb.h:1335
uint8_t interfaces
Number of interfaces.
Definition: usb.h:201
static int usb_used(struct usb_device *usb, unsigned int count, uint8_t *interface, uint8_t *used)
Update list of used interface.
Definition: usb.c:1146
A USB function descriptor.
Definition: usb.h:642
struct usb_driver * usb_find_driver(struct usb_function_descriptor *desc, struct usb_device_id **id)
Find USB device driver.
Definition: usb.c:1168
An object interface.
Definition: interface.h:124
uint8_t id
Request identifier.
Definition: ena.h:12
unsigned int score
Driver score.
Definition: usb.h:1393
unsigned char uint8_t
Definition: stdint.h:10
static int usb_describe(struct usb_device *usb, struct usb_configuration_descriptor *config, unsigned int first, uint8_t *interfaces, struct usb_function_descriptor *desc)
Describe USB function.
Definition: usb.c:1054
uint32_t first
Length to skip in first segment.
Definition: pccrc.h:23
void * memset(void *dest, int character, size_t len) __nonnull

References usb_function_descriptor::count, first, id, usb_configuration_descriptor::interfaces, memset(), rc, usb_driver::score, usb_describe(), usb_find_driver(), and usb_used().

Referenced by usb_autoconfigure().

◆ usb_probe()

static int usb_probe ( struct usb_function func,
struct usb_configuration_descriptor config 
)
static

Probe USB device driver.

Parameters
funcUSB function
configConfiguration descriptor
Return values
rcReturn status code

Definition at line 1249 of file usb.c.

1250  {
1251  struct usb_device *usb = func->usb;
1252  struct usb_driver *driver;
1253  struct usb_device_id *id;
1254  int rc;
1255 
1256  /* Identify driver */
1257  driver = usb_find_driver ( &func->desc, &id );
1258  if ( ! driver ) {
1259  DBGC ( usb, "USB %s %04x:%04x class %d:%d:%d has no driver\n",
1260  func->name, func->desc.vendor, func->desc.product,
1261  func->desc.class.class.class,
1262  func->desc.class.class.subclass,
1263  func->desc.class.class.protocol );
1264  return -ENOENT;
1265  }
1266 
1267  /* Record driver */
1268  func->driver = driver;
1269  func->id = id;
1270  func->dev.driver_name = id->name;
1271 
1272  /* Probe driver */
1273  if ( ( rc = driver->probe ( func, config ) ) != 0 ) {
1274  DBGC ( usb, "USB %s failed to probe driver %s: %s\n",
1275  func->name, id->name, strerror ( rc ) );
1276  return rc;
1277  }
1278 
1279  return 0;
1280 }
A USB driver.
Definition: usb.h:1381
struct arbelprm_rc_send_wqe rc
Definition: arbel.h:14
A USB device ID.
Definition: usb.h:1335
uint8_t class
Class code.
Definition: usb.h:147
const char * name
Name.
Definition: usb.h:661
#define DBGC(...)
Definition: compiler.h:505
uint16_t vendor
Vendor ID.
Definition: usb.h:644
struct usb_driver * driver
Driver.
Definition: usb.h:672
#define ENOENT
No such file or directory.
Definition: errno.h:514
union usb_class_descriptor class
Class.
Definition: usb.h:648
int(* probe)(struct usb_function *func, struct usb_configuration_descriptor *config)
Probe device.
Definition: usb.h:1401
struct usb_device_id * id
Driver device ID.
Definition: usb.h:676
uint16_t product
Product ID.
Definition: usb.h:646
struct usb_driver * usb_find_driver(struct usb_function_descriptor *desc, struct usb_device_id **id)
Find USB device driver.
Definition: usb.c:1168
const char * driver_name
Driver name.
Definition: device.h:77
uint8_t id
Request identifier.
Definition: ena.h:12
A USB device.
Definition: usb.h:708
char * strerror(int errno)
Retrieve string representation of error number.
Definition: strerror.c:78
struct usb_device * usb
USB device.
Definition: usb.h:663
uint8_t protocol
Protocol code.
Definition: usb.h:151
uint8_t subclass
Subclass code.
Definition: usb.h:149
struct usb_function_descriptor desc
Function descriptor.
Definition: usb.h:665
struct device dev
Generic device.
Definition: usb.h:667
struct usb_class class
Class.
Definition: usb.h:631

References usb_class::class, usb_class_descriptor::class, usb_function_descriptor::class, DBGC, usb_function::desc, usb_function::dev, usb_function::driver, device::driver_name, ENOENT, id, usb_function::id, usb_function::name, usb_driver::probe, usb_function_descriptor::product, usb_class::protocol, rc, strerror(), usb_class::subclass, usb_function::usb, usb_find_driver(), and usb_function_descriptor::vendor.

Referenced by usb_probe_all().

◆ usb_remove()

static void usb_remove ( struct usb_function func)
static

Remove USB device driver.

Parameters
funcUSB function

Definition at line 1287 of file usb.c.

1287  {
1288 
1289  /* Remove driver */
1290  func->driver->remove ( func );
1291 }
struct usb_driver * driver
Driver.
Definition: usb.h:672
void(* remove)(struct usb_function *func)
Remove device.
Definition: usb.h:1408

References usb_function::driver, and usb_driver::remove.

Referenced by usb_probe_all(), and usb_remove_all().

◆ usb_probe_all()

static void usb_probe_all ( struct usb_device usb,
struct usb_configuration_descriptor config 
)
static

Probe all USB device drivers.

Parameters
usbUSB device
configConfiguration descriptor

Definition at line 1300 of file usb.c.

1301  {
1302  struct usb_bus *bus = usb->port->hub->bus;
1303  struct usb_function *func;
1304  uint8_t used[config->interfaces];
1305  unsigned int first;
1306  unsigned int i;
1307  int rc;
1308 
1309  /* Identify each function in turn */
1310  memset ( used, 0, sizeof ( used ) );
1311  for ( first = 0 ; first < config->interfaces ; first++ ) {
1312 
1313  /* Skip interfaces already used */
1314  if ( used[first] )
1315  continue;
1316 
1317  /* Allocate and initialise structure */
1318  func = zalloc ( sizeof ( *func ) +
1319  ( config->interfaces *
1320  sizeof ( func->interface[0] ) ) );
1321  if ( ! func )
1322  goto err_alloc;
1323  func->name = func->dev.name;
1324  func->usb = usb;
1325  func->dev.desc.bus_type = BUS_TYPE_USB;
1326  func->dev.desc.location = usb->address;
1327  func->dev.desc.vendor = le16_to_cpu ( usb->device.vendor );
1328  func->dev.desc.device = le16_to_cpu ( usb->device.product );
1329  snprintf ( func->dev.name, sizeof ( func->dev.name ),
1330  "%s-%d.%d", usb->name, config->config, first );
1331  INIT_LIST_HEAD ( &func->dev.children );
1332  func->dev.parent = bus->dev;
1333  list_add_tail ( &func->list, &usb->functions );
1334 
1335  /* Identify function */
1336  if ( ( rc = usb_describe ( usb, config, first, func->interface,
1337  &func->desc ) ) != 0 )
1338  goto err_describe;
1339  assert ( func->desc.count <= config->interfaces );
1340 
1341  /* Mark interfaces as used */
1342  if ( ( rc = usb_used ( usb, func->desc.count, func->interface,
1343  used ) ) != 0 )
1344  goto err_used;
1345 
1346  /* Probe device driver */
1347  if ( ( rc = usb_probe ( func, config ) ) != 0 )
1348  goto err_probe;
1349  DBGC ( usb, "USB %s %04x:%04x class %d:%d:%d interfaces ",
1350  func->name, func->desc.vendor, func->desc.product,
1351  func->desc.class.class.class,
1352  func->desc.class.class.subclass,
1353  func->desc.class.class.protocol );
1354  for ( i = 0 ; i < func->desc.count ; i++ )
1355  DBGC ( usb, "%s%d", ( i ? "," : "" ),
1356  func->interface[i] );
1357  DBGC ( usb, " using driver %s\n", func->dev.driver_name );
1358 
1359  /* Add to device hierarchy */
1360  list_add_tail ( &func->dev.siblings, &bus->dev->children );
1361 
1362  continue;
1363 
1364  list_del ( &func->dev.siblings );
1365  usb_remove ( func );
1366  err_probe:
1367  err_used:
1368  err_describe:
1369  list_del ( &func->list );
1370  free ( func );
1371  err_alloc:
1372  /* Continue registering other functions */
1373  continue;
1374  }
1375 }
struct arbelprm_rc_send_wqe rc
Definition: arbel.h:14
uint8_t class
Class code.
Definition: usb.h:147
uint8_t interface[0]
List of interface numbers.
Definition: usb.h:682
const char * name
Name.
Definition: usb.h:661
unsigned int count
Number of interfaces.
Definition: usb.h:650
uint16_t vendor
Vendor ID.
Definition: usb.h:176
#define DBGC(...)
Definition: compiler.h:505
uint16_t vendor
Vendor ID.
Definition: usb.h:644
char name[40]
Name.
Definition: device.h:75
uint8_t interfaces
Number of interfaces.
Definition: usb.h:201
static int usb_used(struct usb_device *usb, unsigned int count, uint8_t *interface, uint8_t *used)
Update list of used interface.
Definition: usb.c:1146
union usb_class_descriptor class
Class.
Definition: usb.h:648
unsigned int vendor
Vendor ID.
Definition: device.h:31
struct device * parent
Bus device.
Definition: device.h:85
unsigned int address
Device address, if assigned.
Definition: usb.h:718
#define list_del(list)
Delete an entry from a list.
Definition: list.h:119
uint16_t product
Product ID.
Definition: usb.h:646
uint16_t product
Product ID.
Definition: usb.h:178
struct usb_port * port
USB port.
Definition: usb.h:712
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
char name[32]
Name.
Definition: usb.h:710
const char * driver_name
Driver name.
Definition: device.h:77
unsigned int location
Location.
Definition: device.h:29
static void(* free)(struct refcnt *refcnt))
Definition: refcnt.h:54
void * zalloc(size_t size)
Allocate cleared memory.
Definition: malloc.c:624
struct list_head siblings
Devices on the same bus.
Definition: device.h:81
unsigned char uint8_t
Definition: stdint.h:10
static void usb_remove(struct usb_function *func)
Remove USB device driver.
Definition: usb.c:1287
struct usb_device_descriptor device
Device descriptor.
Definition: usb.h:720
struct usb_device * usb
USB device.
Definition: usb.h:663
#define le16_to_cpu(value)
Definition: byteswap.h:112
uint8_t protocol
Protocol code.
Definition: usb.h:151
#define INIT_LIST_HEAD(list)
Initialise a list head.
Definition: list.h:45
uint8_t subclass
Subclass code.
Definition: usb.h:149
unsigned int bus_type
Bus type.
Definition: device.h:24
uint8_t config
Configuration value.
Definition: usb.h:203
unsigned int device
Device ID.
Definition: device.h:33
struct list_head children
Devices attached to this device.
Definition: device.h:83
struct usb_hub * hub
USB hub.
Definition: usb.h:800
struct device_description desc
Device description.
Definition: device.h:79
int snprintf(char *buf, size_t size, const char *fmt,...)
Write a formatted string to a buffer.
Definition: vsprintf.c:382
struct usb_function_descriptor desc
Function descriptor.
Definition: usb.h:665
struct device dev
Generic device.
Definition: usb.h:667
A USB function.
Definition: usb.h:659
#define BUS_TYPE_USB
USB bus type.
Definition: device.h:70
struct usb_bus * bus
USB bus.
Definition: usb.h:830
struct list_head functions
List of functions.
Definition: usb.h:722
struct list_head list
List of functions within this USB device.
Definition: usb.h:669
A USB bus.
Definition: usb.h:951
static int usb_describe(struct usb_device *usb, struct usb_configuration_descriptor *config, unsigned int first, uint8_t *interfaces, struct usb_function_descriptor *desc)
Describe USB function.
Definition: usb.c:1054
uint8_t bus
Bus.
Definition: edd.h:14
uint32_t first
Length to skip in first segment.
Definition: pccrc.h:23
struct usb_class class
Class.
Definition: usb.h:631
static int usb_probe(struct usb_function *func, struct usb_configuration_descriptor *config)
Probe USB device driver.
Definition: usb.c:1249
void * memset(void *dest, int character, size_t len) __nonnull

References usb_device::address, assert(), bus, usb_hub::bus, device_description::bus_type, BUS_TYPE_USB, device::children, usb_class::class, usb_class_descriptor::class, usb_function_descriptor::class, usb_configuration_descriptor::config, usb_function_descriptor::count, DBGC, device::desc, usb_function::desc, usb_function::dev, device_description::device, usb_device::device, device::driver_name, first, free, usb_device::functions, usb_port::hub, INIT_LIST_HEAD, usb_function::interface, usb_configuration_descriptor::interfaces, le16_to_cpu, usb_function::list, list_add_tail, list_del, device_description::location, memset(), device::name, usb_function::name, usb_device::name, device::parent, usb_device::port, usb_device_descriptor::product, usb_function_descriptor::product, usb_class::protocol, rc, device::siblings, snprintf(), usb_class::subclass, usb_function::usb, usb_describe(), usb_probe(), usb_remove(), usb_used(), device_description::vendor, usb_device_descriptor::vendor, usb_function_descriptor::vendor, and zalloc().

Referenced by usb_autoconfigure().

◆ usb_remove_all()

static void usb_remove_all ( struct usb_device usb)
static

Remove all device drivers.

Parameters
usbUSB device

Definition at line 1382 of file usb.c.

1382  {
1383  struct usb_function *func;
1384  struct usb_function *tmp;
1385 
1386  /* Remove all functions */
1388 
1389  /* Remove device driver */
1390  usb_remove ( func );
1391 
1392  /* Remove from device hierarchy */
1393  assert ( list_empty ( &func->dev.children ) );
1394  list_del ( &func->dev.siblings );
1395 
1396  /* Remove from list of functions */
1397  list_del ( &func->list );
1398 
1399  /* Free function */
1400  free ( func );
1401  }
1402 }
#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 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
static void(* free)(struct refcnt *refcnt))
Definition: refcnt.h:54
struct list_head siblings
Devices on the same bus.
Definition: device.h:81
uint8_t * tmp
Definition: entropy.h:156
static void usb_remove(struct usb_function *func)
Remove USB device driver.
Definition: usb.c:1287
struct usb_device * usb
USB device.
Definition: usb.h:663
struct list_head children
Devices attached to this device.
Definition: device.h:83
struct device dev
Generic device.
Definition: usb.h:667
A USB function.
Definition: usb.h:659
struct list_head functions
List of functions.
Definition: usb.h:722
struct list_head list
List of functions within this USB device.
Definition: usb.h:669

References assert(), device::children, usb_function::dev, free, usb_device::functions, usb_function::list, list_del, list_empty, list_for_each_entry_safe, device::siblings, tmp, usb_function::usb, and usb_remove().

Referenced by usb_autoconfigure(), and usb_deconfigure().

◆ usb_deconfigure()

static void usb_deconfigure ( struct usb_device usb)
static

Clear USB device configuration.

Parameters
usbUSB device

Definition at line 1409 of file usb.c.

1409  {
1410  unsigned int i;
1411 
1412  /* Remove device drivers */
1413  usb_remove_all ( usb );
1414 
1415  /* Sanity checks */
1416  for ( i = 0 ; i < ( sizeof ( usb->ep ) / sizeof ( usb->ep[0] ) ) ; i++){
1417  if ( i != USB_ENDPOINT_IDX ( USB_EP0_ADDRESS ) )
1418  assert ( usb->ep[i] == NULL );
1419  }
1420 
1421  /* Clear device configuration */
1422  usb_set_configuration ( usb, 0 );
1423 }
static int usb_set_configuration(struct usb_device *usb, unsigned int index)
Set USB configuration.
Definition: usb.h:1221
assert((readw(&hdr->flags) &(GTF_reading|GTF_writing))==0)
struct usb_device * usb
USB device.
Definition: usb.h:663
#define USB_ENDPOINT_IDX(address)
Construct endpoint index from endpoint address.
Definition: usb.h:513
static void usb_remove_all(struct usb_device *usb)
Remove all device drivers.
Definition: usb.c:1382
struct usb_endpoint * ep[32]
Endpoint list.
Definition: usb.h:730
#define USB_EP0_ADDRESS
Control endpoint address.
Definition: usb.h:486
#define NULL
NULL pointer (VOID *)
Definition: Base.h:362

References assert(), usb_device::ep, NULL, usb_function::usb, USB_ENDPOINT_IDX, USB_EP0_ADDRESS, usb_remove_all(), and usb_set_configuration().

Referenced by register_usb(), and unregister_usb().

◆ usb_autoconfigure()

static int usb_autoconfigure ( struct usb_device usb)
static

Choose our preferred USB device configuration.

Parameters
usbUSB device
Return values
rcReturn status code

Definition at line 1431 of file usb.c.

1431  {
1433  unsigned int preferred = 0;
1434  unsigned int index;
1435  int score;
1436  int best = 0;
1437  int rc;
1438 
1439  /* Calculate driver score for each configuration index */
1440  for ( index = 0 ; index < usb->device.configurations ; index++ ) {
1441 
1442  /* Read configuration descriptor */
1443  if ( ( rc = usb_config_descriptor ( usb, index,
1444  &config ) ) != 0 )
1445  goto err_config;
1446 
1447  /* Get score for this configuration */
1448  score = usb_score ( usb, config );
1449  if ( score < 0 ) {
1450  rc = score;
1451  goto err_score;
1452  }
1453  DBGC2 ( usb, "USB %s configuration %d score %d\n",
1454  usb->name, config->config, score );
1455 
1456  /* Record as preferred configuration, if applicable */
1457  if ( score > best ) {
1458  best = score;
1459  preferred = index;
1460  }
1461 
1462  /* Free configuration descriptor */
1463  free ( config );
1464  config = NULL;
1465  }
1466 
1467  /* Read preferred configuration descriptor */
1468  if ( ( rc = usb_config_descriptor ( usb, preferred, &config ) ) != 0 )
1469  goto err_preferred;
1470 
1471  /* Set configuration */
1472  if ( ( rc = usb_set_configuration ( usb, config->config ) ) != 0){
1473  DBGC ( usb, "USB %s could not set configuration %d: %s\n",
1474  usb->name, config->config, strerror ( rc ) );
1475  goto err_set_configuration;
1476  }
1477 
1478  /* Probe USB device drivers */
1479  usb_probe_all ( usb, config );
1480 
1481  /* Free configuration descriptor */
1482  free ( config );
1483 
1484  return 0;
1485 
1486  usb_remove_all ( usb );
1487  usb_set_configuration ( usb, 0 );
1488  err_set_configuration:
1489  free ( config );
1490  err_preferred:
1491  return rc;
1492 
1493  err_score:
1494  free ( config );
1495  err_config:
1496  return rc;
1497 }
struct arbelprm_rc_send_wqe rc
Definition: arbel.h:14
static int usb_set_configuration(struct usb_device *usb, unsigned int index)
Set USB configuration.
Definition: usb.h:1221
#define DBGC(...)
Definition: compiler.h:505
static void usb_probe_all(struct usb_device *usb, struct usb_configuration_descriptor *config)
Probe all USB device drivers.
Definition: usb.c:1300
uint8_t configurations
Number of possible configurations.
Definition: usb.h:188
char name[32]
Name.
Definition: usb.h:710
char * strerror(int errno)
Retrieve string representation of error number.
Definition: strerror.c:78
static void(* free)(struct refcnt *refcnt))
Definition: refcnt.h:54
static int usb_score(struct usb_device *usb, struct usb_configuration_descriptor *config)
Get USB device configuration score.
Definition: usb.c:1204
struct usb_device_descriptor device
Device descriptor.
Definition: usb.h:720
static void usb_remove_all(struct usb_device *usb)
Remove all device drivers.
Definition: usb.c:1382
A USB configuration descriptor.
Definition: usb.h:195
static int usb_config_descriptor(struct usb_device *usb, unsigned int index, struct usb_configuration_descriptor **config)
Get USB configuration descriptor.
Definition: usb.c:991
uint8_t config
Configuration value.
Definition: usb.h:203
#define DBGC2(...)
Definition: compiler.h:522
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_configuration_descriptor::config, usb_device_descriptor::configurations, DBGC, DBGC2, usb_device::device, free, index, usb_device::name, NULL, rc, strerror(), usb_config_descriptor(), usb_probe_all(), usb_remove_all(), usb_score(), and usb_set_configuration().

Referenced by register_usb().

◆ alloc_usb()

static struct usb_device* alloc_usb ( struct usb_port port)
static

Allocate USB device.

Parameters
portUSB port
Return values
usbUSB device, or NULL on allocation failure

Definition at line 1512 of file usb.c.

1512  {
1513  struct usb_hub *hub = port->hub;
1514  struct usb_bus *bus = hub->bus;
1515  struct usb_device *usb;
1516 
1517  /* Allocate and initialise structure */
1518  usb = zalloc ( sizeof ( *usb ) );
1519  if ( ! usb )
1520  return NULL;
1521  snprintf ( usb->name, sizeof ( usb->name ), "%s%c%d", hub->name,
1522  ( hub->usb ? '.' : '-' ), port->address );
1523  usb->port = port;
1524  INIT_LIST_HEAD ( &usb->functions );
1525  usb->host = &bus->op->device;
1527  INIT_LIST_HEAD ( &usb->complete );
1528 
1529  return usb;
1530 }
A USB hub.
Definition: usb.h:826
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
static struct usb_endpoint_driver_operations usb_control_operations
USB control endpoint driver operations.
Definition: usb.c:768
char name[32]
Name.
Definition: usb.h:710
const char * name
Name.
Definition: usb.h:828
A USB device.
Definition: usb.h:708
struct usb_endpoint control
Control endpoint.
Definition: usb.h:733
void * zalloc(size_t size)
Allocate cleared memory.
Definition: malloc.c:624
static void usb_endpoint_init(struct usb_endpoint *ep, struct usb_device *usb, struct usb_endpoint_driver_operations *driver)
Initialise USB endpoint.
Definition: usb.h:525
#define INIT_LIST_HEAD(list)
Initialise a list head.
Definition: list.h:45
struct list_head complete
Completed control transfers.
Definition: usb.h:735
struct usb_hub * hub
Root hub.
Definition: usb.h:974
int snprintf(char *buf, size_t size, const char *fmt,...)
Write a formatted string to a buffer.
Definition: vsprintf.c:382
struct usb_device_host_operations * host
Host controller operations.
Definition: usb.h:725
struct usb_bus * bus
USB bus.
Definition: usb.h:830
struct list_head functions
List of functions.
Definition: usb.h:722
#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, usb_hub::bus, usb_device::complete, usb_device::control, usb_device::functions, usb_device::host, usb_bus::hub, INIT_LIST_HEAD, usb_device::name, usb_hub::name, NULL, port, usb_device::port, snprintf(), usb_hub::usb, usb_control_operations, usb_endpoint_init(), and zalloc().

Referenced by usb_attached().

◆ register_usb()

static int register_usb ( struct usb_device usb)
static

Register USB device.

Parameters
usbUSB device
Return values
rcReturn status code

Definition at line 1538 of file usb.c.

1538  {
1539  struct usb_port *port = usb->port;
1540  struct usb_hub *hub = port->hub;
1541  struct usb_bus *bus = hub->bus;
1542  unsigned int protocol;
1543  size_t mtu;
1544  int rc;
1545 
1546  /* Add to port */
1547  if ( port->usb != NULL ) {
1548  DBGC ( hub, "USB hub %s port %d is already registered to %s\n",
1549  hub->name, port->address, port->usb->name );
1550  rc = -EALREADY;
1551  goto err_already;
1552  }
1553  port->usb = usb;
1554 
1555  /* Add to bus device list */
1556  list_add_tail ( &usb->list, &bus->devices );
1557 
1558  /* Enable device */
1559  if ( ( rc = hub->driver->enable ( hub, port ) ) != 0 ) {
1560  DBGC ( hub, "USB hub %s port %d could not enable: %s\n",
1561  hub->name, port->address, strerror ( rc ) );
1562  goto err_enable;
1563  }
1564 
1565  /* Allow recovery interval since port may have been reset */
1567 
1568  /* Get device speed */
1569  if ( ( rc = hub->driver->speed ( hub, port ) ) != 0 ) {
1570  DBGC ( hub, "USB hub %s port %d could not get speed: %s\n",
1571  hub->name, port->address, strerror ( rc ) );
1572  goto err_speed;
1573  }
1574  usb->speed = port->speed;
1575  DBGC2 ( usb, "USB %s attached as %s-speed device\n",
1576  usb->name, usb_speed_name ( usb->speed ) );
1577 
1578  /* Open device */
1579  if ( ( rc = usb->host->open ( usb ) ) != 0 ) {
1580  DBGC ( usb, "USB %s could not open: %s\n",
1581  usb->name, strerror ( rc ) );
1582  goto err_open;
1583  }
1584 
1585  /* Describe control endpoint */
1586  mtu = USB_EP0_DEFAULT_MTU ( usb->speed );
1589  USB_EP0_INTERVAL );
1590 
1591  /* Open control endpoint */
1592  if ( ( rc = usb_endpoint_open ( &usb->control ) ) != 0 )
1593  goto err_open_control;
1594  assert ( usb_endpoint ( usb, USB_EP0_ADDRESS ) == &usb->control );
1595 
1596  /* Assign device address */
1597  if ( ( rc = usb->host->address ( usb ) ) != 0 ) {
1598  DBGC ( usb, "USB %s could not set address: %s\n",
1599  usb->name, strerror ( rc ) );
1600  goto err_address;
1601  }
1602  DBGC2 ( usb, "USB %s assigned address %d\n", usb->name, usb->address );
1603 
1604  /* Allow recovery interval after Set Address command */
1606 
1607  /* Read first part of device descriptor to get EP0 MTU */
1608  if ( ( rc = usb_get_mtu ( usb, &usb->device ) ) != 0 ) {
1609  DBGC ( usb, "USB %s could not get MTU: %s\n",
1610  usb->name, strerror ( rc ) );
1611  goto err_get_mtu;
1612  }
1613 
1614  /* Calculate EP0 MTU */
1615  protocol = le16_to_cpu ( usb->device.protocol );
1616  mtu = ( ( protocol < USB_PROTO_3_0 ) ?
1617  usb->device.mtu : ( 1 << usb->device.mtu ) );
1618  DBGC2 ( usb, "USB %s has control MTU %zd (guessed %zd)\n",
1619  usb->name, mtu, usb->control.mtu );
1620 
1621  /* Update MTU */
1622  if ( ( rc = usb_endpoint_mtu ( &usb->control, mtu ) ) != 0 )
1623  goto err_mtu;
1624 
1625  /* Read whole device descriptor */
1626  if ( ( rc = usb_get_device_descriptor ( usb, &usb->device ) ) != 0 ) {
1627  DBGC ( usb, "USB %s could not get device descriptor: %s\n",
1628  usb->name, strerror ( rc ) );
1629  goto err_get_device_descriptor;
1630  }
1631  DBGC ( usb, "USB %s addr %d %04x:%04x class %d:%d:%d (v%s, %s-speed, "
1632  "MTU %zd)\n", usb->name, usb->address,
1633  le16_to_cpu ( usb->device.vendor ),
1634  le16_to_cpu ( usb->device.product ), usb->device.class.class,
1636  usb_bcd ( le16_to_cpu ( usb->device.protocol ) ),
1637  usb_speed_name ( usb->speed ), usb->control.mtu );
1638 
1639  /* Configure device */
1640  if ( ( rc = usb_autoconfigure ( usb ) ) != 0 )
1641  goto err_autoconfigure;
1642 
1643  return 0;
1644 
1645  usb_deconfigure ( usb );
1646  err_autoconfigure:
1647  err_get_device_descriptor:
1648  err_mtu:
1649  err_get_mtu:
1650  err_address:
1651  usb_endpoint_close ( &usb->control );
1652  err_open_control:
1653  usb->host->close ( usb );
1654  err_open:
1655  err_speed:
1656  /* Leave port enabled on failure, to avoid an endless loop of
1657  * failed device registrations.
1658  */
1659  err_enable:
1660  list_del ( &usb->list );
1661  port->usb = NULL;
1662  err_already:
1663  return rc;
1664 }
struct arbelprm_rc_send_wqe rc
Definition: arbel.h:14
uint8_t class
Class code.
Definition: usb.h:147
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
A USB hub.
Definition: usb.h:826
uint16_t vendor
Vendor ID.
Definition: usb.h:176
#define USB_EP0_DEFAULT_MTU(speed)
Calculate default MTU based on device speed.
Definition: usb.h:496
#define USB_RESET_RECOVER_DELAY_MS
Reset recovery time.
Definition: usb.h:1309
static const char * usb_bcd(uint16_t bcd)
Transcribe USB BCD-coded value (for debugging)
Definition: usb.c:95
#define DBGC(...)
Definition: compiler.h:505
struct usb_device * usb
Currently attached device (if in use)
Definition: usb.h:820
int usb_endpoint_open(struct usb_endpoint *ep)
Open USB endpoint.
Definition: usb.c:293
static int usb_endpoint_mtu(struct usb_endpoint *ep, size_t mtu)
Update endpoint MTU.
Definition: usb.c:463
void usb_endpoint_close(struct usb_endpoint *ep)
Close USB endpoint.
Definition: usb.c:399
unsigned int address
Device address, if assigned.
Definition: usb.h:718
static int usb_autoconfigure(struct usb_device *usb)
Choose our preferred USB device configuration.
Definition: usb.c:1431
unsigned int speed
Device speed.
Definition: usb.h:714
#define USB_EP0_ATTRIBUTES
Control endpoint attributes.
Definition: usb.h:489
#define list_del(list)
Delete an entry from a list.
Definition: list.h:119
A USB port.
Definition: usb.h:798
uint16_t product
Product ID.
Definition: usb.h:178
A USB endpoint.
Definition: usb.h:389
#define USB_EP0_BURST
Control endpoint maximum burst size.
Definition: usb.h:501
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)
struct usb_hub_driver_operations * driver
Driver operations.
Definition: usb.h:844
USB 3.0.
Definition: usb.h:24
static const char * usb_speed_name(unsigned int speed)
Get USB speed name (for debugging)
Definition: usb.c:65
#define list_add_tail(new, head)
Add a new entry to the tail of a list.
Definition: list.h:93
struct usb_class class
Device class.
Definition: usb.h:172
int(* enable)(struct usb_hub *hub, struct usb_port *port)
Enable port.
Definition: usb.h:889
char name[32]
Name.
Definition: usb.h:710
const char * name
Name.
Definition: usb.h:828
void(* close)(struct usb_device *usb)
Close device.
Definition: usb.h:753
struct usb_endpoint control
Control endpoint.
Definition: usb.h:733
char * strerror(int errno)
Retrieve string representation of error number.
Definition: strerror.c:78
struct list_head list
List of devices on this bus.
Definition: usb.h:716
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)
Definition: usb.h:1173
struct usb_device_descriptor device
Device descriptor.
Definition: usb.h:720
#define le16_to_cpu(value)
Definition: byteswap.h:112
#define EALREADY
Connection already in progress.
Definition: errno.h:323
uint8_t protocol
Protocol code.
Definition: usb.h:151
#define USB_EP0_INTERVAL
Control endpoint interval.
Definition: usb.h:504
size_t mtu
Maximum transfer size.
Definition: usb.h:397
void mdelay(unsigned long msecs)
Delay for a fixed number of milliseconds.
Definition: timer.c:78
static int usb_get_device_descriptor(struct usb_device *usb, struct usb_device_descriptor *data)
Get USB device descriptor.
Definition: usb.h:1189
static void usb_deconfigure(struct usb_device *usb)
Clear USB device configuration.
Definition: usb.c:1409
uint8_t subclass
Subclass code.
Definition: usb.h:149
#define DBGC2(...)
Definition: compiler.h:522
uint16_t protocol
USB specification release number in BCD.
Definition: usb.h:170
uint8_t mtu
Maximum packet size for endpoint zero.
Definition: usb.h:174
uint32_t mtu
Maximum MTU.
Definition: ena.h:28
#define USB_SET_ADDRESS_RECOVER_DELAY_MS
Set address recovery time.
Definition: usb.h:1323
int(* address)(struct usb_device *usb)
Assign device address.
Definition: usb.h:759
struct usb_hub * hub
Root hub.
Definition: usb.h:974
uint16_t protocol
Protocol ID.
Definition: stp.h:18
struct usb_device_host_operations * host
Host controller operations.
Definition: usb.h:725
struct usb_bus * bus
USB bus.
Definition: usb.h:830
#define USB_EP0_ADDRESS
Control endpoint address.
Definition: usb.h:486
int(* speed)(struct usb_hub *hub, struct usb_port *port)
Update port speed.
Definition: usb.h:903
#define NULL
NULL pointer (VOID *)
Definition: Base.h:362
A USB bus.
Definition: usb.h:951
uint8_t bus
Bus.
Definition: edd.h:14
int(* open)(struct usb_device *usb)
Open device.
Definition: usb.h:748

References usb_device::address, usb_device_host_operations::address, assert(), bus, usb_hub::bus, usb_class::class, usb_device_descriptor::class, usb_device_host_operations::close, usb_device::control, DBGC, DBGC2, usb_device::device, usb_hub::driver, EALREADY, usb_hub_driver_operations::enable, usb_device::host, usb_bus::hub, le16_to_cpu, usb_device::list, list_add_tail, list_del, mdelay(), mtu, usb_device_descriptor::mtu, usb_endpoint::mtu, usb_device::name, usb_hub::name, NULL, usb_device_host_operations::open, port, usb_device::port, usb_device_descriptor::product, protocol, usb_class::protocol, usb_device_descriptor::protocol, rc, usb_device::speed, usb_hub_driver_operations::speed, strerror(), usb_class::subclass, usb_port::usb, usb_autoconfigure(), usb_bcd(), usb_deconfigure(), usb_endpoint_close(), usb_endpoint_describe(), usb_endpoint_mtu(), usb_endpoint_open(), USB_EP0_ADDRESS, USB_EP0_ATTRIBUTES, USB_EP0_BURST, USB_EP0_DEFAULT_MTU, USB_EP0_INTERVAL, usb_get_device_descriptor(), usb_get_mtu(), USB_PROTO_3_0, USB_RESET_RECOVER_DELAY_MS, USB_SET_ADDRESS_RECOVER_DELAY_MS, usb_speed_name(), and usb_device_descriptor::vendor.

Referenced by usb_attached().

◆ unregister_usb()

static void unregister_usb ( struct usb_device usb)
static

Unregister USB device.

Parameters
usbUSB device

Definition at line 1671 of file usb.c.

1671  {
1672  struct usb_port *port = usb->port;
1673  struct usb_hub *hub = port->hub;
1674  struct io_buffer *iobuf;
1675  struct io_buffer *tmp;
1676 
1677  DBGC ( usb, "USB %s addr %d %04x:%04x class %d:%d:%d removed\n",
1678  usb->name, usb->address, le16_to_cpu ( usb->device.vendor ),
1679  le16_to_cpu ( usb->device.product ), usb->device.class.class,
1680  usb->device.class.subclass, usb->device.class.protocol );
1681 
1682  /* Sanity checks */
1683  assert ( port->usb == usb );
1684 
1685  /* Clear device configuration */
1686  usb_deconfigure ( usb );
1687 
1688  /* Close control endpoint */
1689  usb_endpoint_close ( &usb->control );
1690 
1691  /* Discard any stale control completions */
1692  list_for_each_entry_safe ( iobuf, tmp, &usb->complete, list ) {
1693  list_del ( &iobuf->list );
1694  free_iob ( iobuf );
1695  }
1696 
1697  /* Close device */
1698  usb->host->close ( usb );
1699 
1700  /* Disable port */
1701  hub->driver->disable ( hub, port );
1702 
1703  /* Remove from bus device list */
1704  list_del ( &usb->list );
1705 
1706  /* Remove from port */
1707  port->usb = NULL;
1708 }
uint8_t class
Class code.
Definition: usb.h:147
A USB hub.
Definition: usb.h:826
uint16_t vendor
Vendor ID.
Definition: usb.h:176
void free_iob(struct io_buffer *iobuf)
Free I/O buffer.
Definition: iobuf.c:146
#define DBGC(...)
Definition: compiler.h:505
struct usb_device * usb
Currently attached device (if in use)
Definition: usb.h:820
void usb_endpoint_close(struct usb_endpoint *ep)
Close USB endpoint.
Definition: usb.c:399
unsigned int address
Device address, if assigned.
Definition: usb.h:718
#define list_del(list)
Delete an entry from a list.
Definition: list.h:119
A USB port.
Definition: usb.h:798
uint16_t product
Product ID.
Definition: usb.h:178
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
assert((readw(&hdr->flags) &(GTF_reading|GTF_writing))==0)
struct usb_class class
Device class.
Definition: usb.h:172
char name[32]
Name.
Definition: usb.h:710
void(* close)(struct usb_device *usb)
Close device.
Definition: usb.h:753
#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
struct usb_endpoint control
Control endpoint.
Definition: usb.h:733
struct list_head list
List of devices on this bus.
Definition: usb.h:716
uint8_t * tmp
Definition: entropy.h:156
struct usb_device_descriptor device
Device descriptor.
Definition: usb.h:720
#define le16_to_cpu(value)
Definition: byteswap.h:112
uint8_t protocol
Protocol code.
Definition: usb.h:151
int(* disable)(struct usb_hub *hub, struct usb_port *port)
Disable port.
Definition: usb.h:896
static void usb_deconfigure(struct usb_device *usb)
Clear USB device configuration.
Definition: usb.c:1409
uint8_t subclass
Subclass code.
Definition: usb.h:149
struct list_head list
List of which this buffer is a member.
Definition: iobuf.h:40
struct list_head complete
Completed control transfers.
Definition: usb.h:735
struct usb_device_host_operations * host
Host controller operations.
Definition: usb.h:725
#define NULL
NULL pointer (VOID *)
Definition: Base.h:362
A persistent I/O buffer.
Definition: iobuf.h:33

References usb_device::address, assert(), usb_class::class, usb_device_descriptor::class, usb_device_host_operations::close, usb_device::complete, usb_device::control, DBGC, usb_device::device, usb_hub_driver_operations::disable, usb_hub::driver, free_iob(), usb_device::host, le16_to_cpu, io_buffer::list, usb_device::list, list_del, list_for_each_entry_safe, usb_device::name, NULL, port, usb_device::port, usb_device_descriptor::product, usb_class::protocol, usb_class::subclass, tmp, usb_port::usb, usb_deconfigure(), usb_endpoint_close(), and usb_device_descriptor::vendor.

Referenced by usb_attached(), and usb_detached().

◆ free_usb()

static void free_usb ( struct usb_device usb)
static

Free USB device.

Parameters
usbUSB device

Definition at line 1715 of file usb.c.

1715  {
1716  unsigned int i;
1717 
1718  /* Sanity checks */
1719  for ( i = 0 ; i < ( sizeof ( usb->ep ) / sizeof ( usb->ep[0] ) ) ; i++ )
1720  assert ( usb->ep[i] == NULL );
1721  assert ( list_empty ( &usb->functions ) );
1722  assert ( list_empty ( &usb->complete ) );
1723 
1724  /* Free device */
1725  free ( usb );
1726 }
#define list_empty(list)
Test whether a list is empty.
Definition: list.h:136
assert((readw(&hdr->flags) &(GTF_reading|GTF_writing))==0)
static void(* free)(struct refcnt *refcnt))
Definition: refcnt.h:54
struct list_head complete
Completed control transfers.
Definition: usb.h:735
struct usb_endpoint * ep[32]
Endpoint list.
Definition: usb.h:730
struct list_head functions
List of functions.
Definition: usb.h:722
#define NULL
NULL pointer (VOID *)
Definition: Base.h:362

References assert(), usb_device::complete, usb_device::ep, free, usb_device::functions, list_empty, and NULL.

Referenced by usb_attached(), and usb_detached().

◆ usb_attached()

static int usb_attached ( struct usb_port port)
static

Handle newly attached USB device.

Parameters
portUSB port
Return values
rcReturn status code

Definition at line 1741 of file usb.c.

1741  {
1742  struct usb_device *usb;
1743  int rc;
1744 
1745  /* Mark port as attached */
1746  port->attached = 1;
1747 
1748  /* Sanity checks */
1749  assert ( port->usb == NULL );
1750 
1751  /* Allocate USB device */
1752  usb = alloc_usb ( port );
1753  if ( ! usb ) {
1754  rc = -ENOMEM;
1755  goto err_alloc;
1756  }
1757 
1758  /* Register USB device */
1759  if ( ( rc = register_usb ( usb ) ) != 0 )
1760  goto err_register;
1761 
1762  return 0;
1763 
1764  unregister_usb ( usb );
1765  err_register:
1766  free_usb ( usb );
1767  err_alloc:
1768  return rc;
1769 }
struct arbelprm_rc_send_wqe rc
Definition: arbel.h:14
static void unregister_usb(struct usb_device *usb)
Unregister USB device.
Definition: usb.c:1671
#define ENOMEM
Not enough space.
Definition: errno.h:534
u8 port
Port number.
Definition: CIB_PRM.h:31
assert((readw(&hdr->flags) &(GTF_reading|GTF_writing))==0)
A USB device.
Definition: usb.h:708
static void free_usb(struct usb_device *usb)
Free USB device.
Definition: usb.c:1715
static int register_usb(struct usb_device *usb)
Register USB device.
Definition: usb.c:1538
static struct usb_device * alloc_usb(struct usb_port *port)
Allocate USB device.
Definition: usb.c:1512
#define NULL
NULL pointer (VOID *)
Definition: Base.h:362

References alloc_usb(), assert(), ENOMEM, free_usb(), NULL, port, rc, register_usb(), and unregister_usb().

Referenced by usb_hotplugged().

◆ usb_detached()

static void usb_detached ( struct usb_port port)
static

Handle newly detached USB device.

Parameters
portUSB port

Definition at line 1776 of file usb.c.

1776  {
1777  struct usb_device *usb = port->usb;
1778 
1779  /* Mark port as detached */
1780  port->attached = 0;
1781 
1782  /* Do nothing if we have no USB device */
1783  if ( ! usb )
1784  return;
1785 
1786  /* Unregister USB device */
1787  unregister_usb ( usb );
1788 
1789  /* Free USB device */
1790  free_usb ( usb );
1791 }
static void unregister_usb(struct usb_device *usb)
Unregister USB device.
Definition: usb.c:1671
u8 port
Port number.
Definition: CIB_PRM.h:31
A USB device.
Definition: usb.h:708
static void free_usb(struct usb_device *usb)
Free USB device.
Definition: usb.c:1715

References free_usb(), port, and unregister_usb().

Referenced by unregister_usb_hub(), and usb_hotplugged().

◆ usb_hotplugged()

static int usb_hotplugged ( struct usb_port port)
static

Handle newly attached or detached USB device.

Parameters
portUSB port
Return values
rcReturn status code

Definition at line 1799 of file usb.c.

1799  {
1800  struct usb_hub *hub = port->hub;
1801  int rc;
1802 
1803  /* Get current port speed */
1804  if ( ( rc = hub->driver->speed ( hub, port ) ) != 0 ) {
1805  DBGC ( hub, "USB hub %s port %d could not get speed: %s\n",
1806  hub->name, port->address, strerror ( rc ) );
1807  /* Treat as a disconnection */
1808  port->disconnected = 1;
1809  port->speed = USB_SPEED_NONE;
1810  }
1811 
1812  /* Detach device, if applicable */
1813  if ( port->attached && ( port->disconnected || ! port->speed ) )
1814  usb_detached ( port );
1815 
1816  /* Clear any recorded disconnections */
1817  port->disconnected = 0;
1818 
1819  /* Attach device, if applicable */
1820  if ( port->speed && ( ! port->attached ) &&
1821  ( ( rc = usb_attached ( port ) ) != 0 ) )
1822  return rc;
1823 
1824  return 0;
1825 }
struct arbelprm_rc_send_wqe rc
Definition: arbel.h:14
static void usb_detached(struct usb_port *port)
Handle newly detached USB device.
Definition: usb.c:1776
A USB hub.
Definition: usb.h:826
static int usb_attached(struct usb_port *port)
Handle newly attached USB device.
Definition: usb.c:1741
#define DBGC(...)
Definition: compiler.h:505
u8 port
Port number.
Definition: CIB_PRM.h:31
struct usb_hub_driver_operations * driver
Driver operations.
Definition: usb.h:844
Not connected.
Definition: usb.h:46
const char * name
Name.
Definition: usb.h:828
char * strerror(int errno)
Retrieve string representation of error number.
Definition: strerror.c:78
int(* speed)(struct usb_hub *hub, struct usb_port *port)
Update port speed.
Definition: usb.h:903

References DBGC, usb_hub::driver, usb_hub::name, port, rc, usb_hub_driver_operations::speed, strerror(), usb_attached(), usb_detached(), and USB_SPEED_NONE.

Referenced by usb_hotplug().

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

◆ usb_hotplug()

static void usb_hotplug ( void  )
static

Handle newly attached or detached USB device.

Definition at line 1850 of file usb.c.

1850  {
1851  struct usb_port *port;
1852 
1853  /* Handle any changed ports, allowing for the fact that the
1854  * port list may change as we perform hotplug actions.
1855  */
1856  while ( ! list_empty ( &usb_changed ) ) {
1857 
1858  /* Get first changed port */
1860  changed );
1861  assert ( port != NULL );
1862 
1863  /* Remove from list of changed ports */
1864  list_del ( &port->changed );
1865  INIT_LIST_HEAD ( &port->changed );
1866 
1867  /* Perform appropriate hotplug action */
1868  usb_hotplugged ( port );
1869  }
1870 }
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
#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
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)
static int usb_hotplugged(struct usb_port *port)
Handle newly attached or detached USB device.
Definition: usb.c:1799
#define INIT_LIST_HEAD(list)
Initialise a list head.
Definition: list.h:45
static struct list_head usb_changed
List of changed ports.
Definition: usb.c:47
#define NULL
NULL pointer (VOID *)
Definition: Base.h:362

References assert(), usb_port::changed, INIT_LIST_HEAD, list_del, list_empty, list_first_entry, NULL, port, usb_changed, and usb_hotplugged().

Referenced by register_usb_bus(), and usb_step().

◆ usb_step()

static void usb_step ( struct process *process  __unused)
static

USB process.

Parameters
processUSB process

Definition at line 1877 of file usb.c.

1877  {
1878  struct usb_bus *bus;
1879  struct usb_endpoint *ep;
1880 
1881  /* Poll all buses */
1882  for_each_usb_bus ( bus )
1883  usb_poll ( bus );
1884 
1885  /* Attempt to reset first halted endpoint in list, if any. We
1886  * do not attempt to process the complete list, since this
1887  * would require extra code to allow for the facts that the
1888  * halted endpoint list may change as we do so, and that
1889  * resetting an endpoint may fail.
1890  */
1891  if ( ( ep = list_first_entry ( &usb_halted, struct usb_endpoint,
1892  halted ) ) != NULL )
1893  usb_endpoint_reset ( ep );
1894 
1895  /* Handle any changed ports */
1896  usb_hotplug();
1897 }
static void usb_hotplug(void)
Handle newly attached or detached USB device.
Definition: usb.c:1850
#define list_first_entry(list, type, member)
Get the container of the first entry in a list.
Definition: list.h:333
#define for_each_usb_bus(bus)
Iterate over all USB buses.
Definition: usb.h:1056
A USB endpoint.
Definition: usb.h:389
struct list_head halted
List of halted endpoints.
Definition: usb.h:409
static void usb_poll(struct usb_bus *bus)
Poll USB bus.
Definition: usb.h:1051
static int usb_endpoint_reset(struct usb_endpoint *ep)
Reset USB endpoint.
Definition: usb.c:429
static struct list_head usb_halted
List of halted endpoints.
Definition: usb.c:50
#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, usb_endpoint::halted, list_first_entry, NULL, usb_endpoint_reset(), usb_halted, usb_hotplug(), and usb_poll().

◆ PERMANENT_PROCESS()

PERMANENT_PROCESS ( usb_process  ,
usb_step   
)

USB process.

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

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

◆ REQUIRING_SYMBOL()

REQUIRING_SYMBOL ( register_usb_bus  )

◆ REQUIRE_OBJECT() [1/2]

REQUIRE_OBJECT ( config_usb  )

◆ REQUIRE_OBJECT() [2/2]

REQUIRE_OBJECT ( usbhub  )

Variable Documentation

◆ usb_buses

struct list_head usb_buses = LIST_HEAD_INIT ( usb_buses )

List of USB buses.

Definition at line 44 of file usb.c.

Referenced by register_usb_bus().

◆ usb_changed

struct list_head usb_changed = LIST_HEAD_INIT ( usb_changed )
static

List of changed ports.

Definition at line 47 of file usb.c.

Referenced by free_usb_bus(), usb_hotplug(), and usb_port_changed().

◆ usb_halted

struct list_head usb_halted = LIST_HEAD_INIT ( usb_halted )
static

List of halted endpoints.

Definition at line 50 of file usb.c.

Referenced by free_usb_bus(), usb_complete_err(), and usb_step().

◆ usb_control_operations

struct usb_endpoint_driver_operations usb_control_operations
static
Initial value:
= {
.complete = usb_control_complete,
}
static void usb_control_complete(struct usb_endpoint *ep, struct io_buffer *iobuf, int rc)
Complete USB control transfer.
Definition: usb.c:754

USB control endpoint driver operations.

Definition at line 768 of file usb.c.

Referenced by alloc_usb().