USB hubs. More...

#include <ipxe/usb.h>
#include <ipxe/list.h>
#include <ipxe/process.h>

Data Structures
struct	usb_hub_descriptor_basic
	A basic USB hub descriptor. More...

struct	usb_hub_descriptor_enhanced
	An enhanced USB hub descriptor. More...

union	usb_hub_descriptor
	A USB hub descriptor. More...

struct	usb_hub_port_status
	Port status. More...

struct	usb_hub_device
	A USB hub device. More...

Macros
#define	USB_HUB_RECIP_PORT ( 3 << 0 )
	Request recipient is a port. More...

#define	USB_HUB_DESCRIPTOR 41
	A basic USB hub descriptor. More...

#define	USB_HUB_DESCRIPTOR_ENHANCED 42
	An enhanced USB hub descriptor. More...

#define	USB_HUB_PORT_CONNECTION 0
	Current connect status feature. More...

#define	USB_HUB_PORT_ENABLE 1
	Port enabled/disabled feature. More...

#define	USB_HUB_PORT_RESET 4
	Port reset feature. More...

#define	USB_HUB_PORT_POWER 8
	Port power feature. More...

#define	USB_HUB_PORT_LOW_SPEED 9
	Low-speed device attached. More...

#define	USB_HUB_PORT_HIGH_SPEED 10
	High-speed device attached. More...

#define	USB_HUB_C_PORT_CONNECTION 16
	Connect status changed. More...

#define	USB_HUB_C_PORT_ENABLE 17
	Port enable/disable changed. More...

#define	USB_HUB_C_PORT_SUSPEND 18
	Suspend changed. More...

#define	USB_HUB_C_PORT_OVER_CURRENT 19
	Over-current indicator changed. More...

#define	USB_HUB_C_PORT_RESET 20
	Reset changed. More...

#define	USB_HUB_C_PORT_LINK_STATE 25
	Link state changed. More...

#define	USB_HUB_C_PORT_CONFIG_ERROR 26
	Configuration error. More...

#define	USB_HUB_C_FEATURE(bit) ( 16 + (bit) )
	Calculate feature from change bit number. More...

#define	USB_HUB_FEATURES
	USB features. More...

#define	USB_HUB_FEATURES_ENHANCED
	USB features for enhanced hubs. More...

#define	USB_HUB_SET_HUB_DEPTH
	Set hub depth. More...

#define	USB_HUB_CLEAR_TT_BUFFER
	Clear transaction translator buffer. More...

#define	USB_HUB_TT_SINGLE 1
	Transaction translator port value for single-TT hubs. More...

#define	USB_HUB_SLOW_START 0x0001
	Hub requires additional settling delay. More...

#define	USB_HUB_SLOW_START_DELAY_MS 500
	Additional setting delay for out-of-spec hubs. More...

#define	USB_HUB_INTR_FILL 4
	Interrupt ring fill level. More...

#define	USB_HUB_ENABLE_MAX_WAIT_MS 100
	Maximum time to wait for port to become enabled. More...

Functions
	FILE_LICENCE (GPL2_OR_LATER_OR_UBDL)

static int	usb_hub_get_descriptor (struct usb_device usb, int enhanced, union usb_hub_descriptor data)
	Get hub descriptor. More...

static int	usb_hub_get_port_status (struct usb_device usb, unsigned int port, struct usb_hub_port_status status)
	Get port status. More...

static int	usb_hub_clear_port_feature (struct usb_device *usb, unsigned int port, unsigned int feature, unsigned int index)
	Clear port feature. More...

static int	usb_hub_set_port_feature (struct usb_device *usb, unsigned int port, unsigned int feature, unsigned int index)
	Set port feature. More...

static int	usb_hub_set_hub_depth (struct usb_device *usb, unsigned int depth)
	Set hub depth. More...

static int	usb_hub_clear_tt_buffer (struct usb_device *usb, unsigned int device, unsigned int endpoint, unsigned int attributes, unsigned int tt_port)
	Clear transaction translator buffer. More...

Detailed Description

USB hubs.

Definition in file usbhub.h.

Macro Definition Documentation

◆ USB_HUB_RECIP_PORT

#define USB_HUB_RECIP_PORT ( 3 << 0 )

Request recipient is a port.

Definition at line 17 of file usbhub.h.

◆ USB_HUB_DESCRIPTOR

#define USB_HUB_DESCRIPTOR 41

A basic USB hub descriptor.

Definition at line 34 of file usbhub.h.

◆ USB_HUB_DESCRIPTOR_ENHANCED

#define USB_HUB_DESCRIPTOR_ENHANCED 42

An enhanced USB hub descriptor.

Definition at line 49 of file usbhub.h.

◆ USB_HUB_PORT_CONNECTION

#define USB_HUB_PORT_CONNECTION 0

Current connect status feature.

Definition at line 70 of file usbhub.h.

◆ USB_HUB_PORT_ENABLE

#define USB_HUB_PORT_ENABLE 1

Port enabled/disabled feature.

Definition at line 73 of file usbhub.h.

◆ USB_HUB_PORT_RESET

#define USB_HUB_PORT_RESET 4

Port reset feature.

Definition at line 76 of file usbhub.h.

◆ USB_HUB_PORT_POWER

#define USB_HUB_PORT_POWER 8

Port power feature.

Definition at line 79 of file usbhub.h.

◆ USB_HUB_PORT_LOW_SPEED

#define USB_HUB_PORT_LOW_SPEED 9

Low-speed device attached.

Definition at line 82 of file usbhub.h.

◆ USB_HUB_PORT_HIGH_SPEED

#define USB_HUB_PORT_HIGH_SPEED 10

High-speed device attached.

Definition at line 85 of file usbhub.h.

◆ USB_HUB_C_PORT_CONNECTION

#define USB_HUB_C_PORT_CONNECTION 16

Connect status changed.

Definition at line 88 of file usbhub.h.

◆ USB_HUB_C_PORT_ENABLE

#define USB_HUB_C_PORT_ENABLE 17

Port enable/disable changed.

Definition at line 91 of file usbhub.h.

◆ USB_HUB_C_PORT_SUSPEND

#define USB_HUB_C_PORT_SUSPEND 18

Suspend changed.

Definition at line 94 of file usbhub.h.

◆ USB_HUB_C_PORT_OVER_CURRENT

#define USB_HUB_C_PORT_OVER_CURRENT 19

Over-current indicator changed.

Definition at line 97 of file usbhub.h.

◆ USB_HUB_C_PORT_RESET

#define USB_HUB_C_PORT_RESET 20

Reset changed.

Definition at line 100 of file usbhub.h.

◆ USB_HUB_C_PORT_LINK_STATE

#define USB_HUB_C_PORT_LINK_STATE 25

Link state changed.

Definition at line 103 of file usbhub.h.

◆ USB_HUB_C_PORT_CONFIG_ERROR

#define USB_HUB_C_PORT_CONFIG_ERROR 26

Configuration error.

Definition at line 106 of file usbhub.h.

◆ USB_HUB_C_FEATURE

#define USB_HUB_C_FEATURE ( bit ) ( 16 + (bit) )

Calculate feature from change bit number.

Definition at line 109 of file usbhub.h.

◆ USB_HUB_FEATURES

#define USB_HUB_FEATURES

Value:

( ( 1 << USB_HUB_C_PORT_CONNECTION ) |                          \
          ( 1 << USB_HUB_C_PORT_ENABLE ) |                              \
          ( 1 << USB_HUB_C_PORT_SUSPEND ) |                             \
          ( 1 << USB_HUB_C_PORT_OVER_CURRENT ) |                        \
          ( 1 << USB_HUB_C_PORT_RESET ) )

USB features.

Definition at line 112 of file usbhub.h.

◆ USB_HUB_FEATURES_ENHANCED

#define USB_HUB_FEATURES_ENHANCED

Value:

( ( 1 << USB_HUB_C_PORT_CONNECTION ) |                          \
          ( 1 << USB_HUB_C_PORT_OVER_CURRENT ) |                        \
          ( 1 << USB_HUB_C_PORT_RESET ) |                               \
          ( 1 << USB_HUB_C_PORT_LINK_STATE ) |                          \
          ( 1 << USB_HUB_C_PORT_CONFIG_ERROR ) )

USB features for enhanced hubs.

Definition at line 120 of file usbhub.h.

◆ USB_HUB_SET_HUB_DEPTH

#define USB_HUB_SET_HUB_DEPTH

Value:

( USB_DIR_OUT | USB_TYPE_CLASS | USB_RECIP_DEVICE | \

USB_REQUEST_TYPE ( 12 ) )

USB_DIR_OUT

#define USB_DIR_OUT

Data transfer is from host to device.

Definition: usb.h:94

USB_TYPE_CLASS

#define USB_TYPE_CLASS

Class-specific request type.

Definition: usb.h:103

USB_RECIP_DEVICE

#define USB_RECIP_DEVICE

Request recipient is the device.

Definition: usb.h:112

Set hub depth.

Definition at line 128 of file usbhub.h.

◆ USB_HUB_CLEAR_TT_BUFFER

#define USB_HUB_CLEAR_TT_BUFFER

Value:

( USB_DIR_OUT | USB_TYPE_CLASS | USB_HUB_RECIP_PORT | \

USB_REQUEST_TYPE ( 8 ) )

USB_DIR_OUT

#define USB_DIR_OUT

Data transfer is from host to device.

Definition: usb.h:94

USB_HUB_RECIP_PORT

#define USB_HUB_RECIP_PORT

Request recipient is a port.

Definition: usbhub.h:17

USB_TYPE_CLASS

#define USB_TYPE_CLASS

Class-specific request type.

Definition: usb.h:103

Clear transaction translator buffer.

Definition at line 133 of file usbhub.h.

◆ USB_HUB_TT_SINGLE

#define USB_HUB_TT_SINGLE 1

Transaction translator port value for single-TT hubs.

Definition at line 248 of file usbhub.h.

◆ USB_HUB_SLOW_START

#define USB_HUB_SLOW_START 0x0001

Hub requires additional settling delay.

Definition at line 270 of file usbhub.h.

◆ USB_HUB_SLOW_START_DELAY_MS

#define USB_HUB_SLOW_START_DELAY_MS 500

Additional setting delay for out-of-spec hubs.

Definition at line 273 of file usbhub.h.

◆ USB_HUB_INTR_FILL

#define USB_HUB_INTR_FILL 4

Interrupt ring fill level.

This is a policy decision.

Definition at line 279 of file usbhub.h.

◆ USB_HUB_ENABLE_MAX_WAIT_MS

#define USB_HUB_ENABLE_MAX_WAIT_MS 100

Maximum time to wait for port to become enabled.

This is a policy decision.

Definition at line 285 of file usbhub.h.

Function Documentation

◆ FILE_LICENCE()

FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL )

◆ usb_hub_get_descriptor()

static int usb_hub_get_descriptor	(	struct usb_device *	usb,
		int	enhanced,
		union usb_hub_descriptor *	data
	)

inlinestatic

Get hub descriptor.

Parameters

usb	USB device
enhanced	Hub is an enhanced hub
data	Hub descriptor to fill in

Return values

rc	Return status code

Definition at line 146 of file usbhub.h.

                                                           {
         unsigned int desc;
         size_t len;
 
         /* Determine descriptor type and length */
         desc = ( enhanced ? USB_HUB_DESCRIPTOR_ENHANCED : USB_HUB_DESCRIPTOR );
         len = ( enhanced ? sizeof ( data->enhanced ) : sizeof ( data->basic ) );
 
         return usb_get_descriptor ( usb, USB_TYPE_CLASS, desc, 0, 0,
                                     &data->header, len );
 }

References data, desc, len, usb_get_descriptor(), USB_HUB_DESCRIPTOR, USB_HUB_DESCRIPTOR_ENHANCED, and USB_TYPE_CLASS.

Referenced by hub_probe().

◆ usb_hub_get_port_status()

static int usb_hub_get_port_status	(	struct usb_device *	usb,
		unsigned int	port,
		struct usb_hub_port_status *	status
	)

inlinestatic

Get port status.

Parameters

usb	USB device
port	Port address
status	Port status descriptor to fill in

Return values

rc	Return status code

Definition at line 168 of file usbhub.h.

                                                                {
 
         return usb_get_status ( usb, ( USB_TYPE_CLASS | USB_HUB_RECIP_PORT ),
                                 port, status, sizeof ( *status ) );
 }

References port, status, usb_get_status(), USB_HUB_RECIP_PORT, and USB_TYPE_CLASS.

Referenced by hub_enable(), and hub_speed().

◆ usb_hub_clear_port_feature()

static int usb_hub_clear_port_feature	(	struct usb_device *	usb,
		unsigned int	port,
		unsigned int	feature,
		unsigned int	index
	)

inlinestatic

Clear port feature.

Parameters

usb	USB device
port	Port address
feature	Feature to clear
index	Index (when clearing a port indicator)

Return values

rc	Return status code

Definition at line 185 of file usbhub.h.

                                                                         {
 
         return usb_clear_feature ( usb, ( USB_TYPE_CLASS | USB_HUB_RECIP_PORT ),
                                    feature, ( ( index << 8 ) | port ) );
 }

References index, port, usb_clear_feature(), USB_HUB_RECIP_PORT, and USB_TYPE_CLASS.

Referenced by hub_clear_changes(), and hub_disable().

◆ usb_hub_set_port_feature()

static int usb_hub_set_port_feature	(	struct usb_device *	usb,
		unsigned int	port,
		unsigned int	feature,
		unsigned int	index
	)

inlinestatic

Set port feature.

Parameters

usb	USB device
port	Port address
feature	Feature to clear
index	Index (when clearing a port indicator)

Return values

rc	Return status code

Definition at line 202 of file usbhub.h.

                                                                       {
 
         return usb_set_feature ( usb, ( USB_TYPE_CLASS | USB_HUB_RECIP_PORT ),
                                  feature, ( ( index << 8 ) | port ) );
 }

References index, port, USB_HUB_RECIP_PORT, usb_set_feature(), and USB_TYPE_CLASS.

Referenced by hub_enable(), and hub_open().

◆ usb_hub_set_hub_depth()

static int usb_hub_set_hub_depth	(	struct usb_device *	usb,
		unsigned int	depth
	)

inlinestatic

Set hub depth.

Parameters

usb	USB device
depth	Hub depth

Return values

rc	Return status code

Definition at line 217 of file usbhub.h.

                                                                      {
 
         return usb_control ( usb, USB_HUB_SET_HUB_DEPTH, depth, 0, NULL, 0 );
 }

References NULL, usb_control(), and USB_HUB_SET_HUB_DEPTH.

Referenced by hub_probe().

◆ usb_hub_clear_tt_buffer()

static int usb_hub_clear_tt_buffer	(	struct usb_device *	usb,
		unsigned int	device,
		unsigned int	endpoint,
		unsigned int	attributes,
		unsigned int	tt_port
	)

inlinestatic

Clear transaction translator buffer.

Parameters

usb	USB device
device	Device address
endpoint	Endpoint address
attributes	Endpoint attributes
tt_port	Transaction translator port (or 1 for single-TT hubs)

Return values

rc	Return status code

Definition at line 233 of file usbhub.h.

                                                  {
         unsigned int value;
 
         /* Calculate value */
         value = ( ( ( endpoint & USB_ENDPOINT_MAX ) << 0 ) | ( device << 4 ) |
                   ( ( attributes & USB_ENDPOINT_ATTR_TYPE_MASK ) << 11 ) |
                   ( ( endpoint & USB_ENDPOINT_IN ) << 8 ) );
 
         return usb_control ( usb, USB_HUB_CLEAR_TT_BUFFER, value,
                              tt_port, NULL, 0 );
 }

References NULL, usb_control(), USB_ENDPOINT_ATTR_TYPE_MASK, USB_ENDPOINT_IN, USB_ENDPOINT_MAX, USB_HUB_CLEAR_TT_BUFFER, and value.

Referenced by hub_clear_tt().

Data Structures

Macros

Functions

Detailed Description

Macro Definition Documentation

◆ USB_HUB_RECIP_PORT

◆ USB_HUB_DESCRIPTOR

◆ USB_HUB_DESCRIPTOR_ENHANCED

◆ USB_HUB_PORT_CONNECTION

◆ USB_HUB_PORT_ENABLE

◆ USB_HUB_PORT_RESET

◆ USB_HUB_PORT_POWER

◆ USB_HUB_PORT_LOW_SPEED

◆ USB_HUB_PORT_HIGH_SPEED

◆ USB_HUB_C_PORT_CONNECTION

◆ USB_HUB_C_PORT_ENABLE

◆ USB_HUB_C_PORT_SUSPEND

◆ USB_HUB_C_PORT_OVER_CURRENT

◆ USB_HUB_C_PORT_RESET

◆ USB_HUB_C_PORT_LINK_STATE

◆ USB_HUB_C_PORT_CONFIG_ERROR

◆ USB_HUB_C_FEATURE

◆ USB_HUB_FEATURES

◆ USB_HUB_FEATURES_ENHANCED

◆ USB_HUB_SET_HUB_DEPTH

◆ USB_HUB_CLEAR_TT_BUFFER

◆ USB_HUB_TT_SINGLE

◆ USB_HUB_SLOW_START

◆ USB_HUB_SLOW_START_DELAY_MS

◆ USB_HUB_INTR_FILL

◆ USB_HUB_ENABLE_MAX_WAIT_MS

Function Documentation

◆ FILE_LICENCE()

◆ usb_hub_get_descriptor()

◆ usb_hub_get_port_status()

◆ usb_hub_clear_port_feature()

◆ usb_hub_set_port_feature()

◆ usb_hub_set_hub_depth()

◆ usb_hub_clear_tt_buffer()