usbhub.h File Reference

USB hubs. More...

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

Go to the source code of this file.

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.
#define	USB_HUB_DESCRIPTOR   41
	A basic USB hub descriptor.
#define	USB_HUB_DESCRIPTOR_ENHANCED   42
	An enhanced USB hub descriptor.
#define	USB_HUB_PORT_CONNECTION   0
	Current connect status feature.
#define	USB_HUB_PORT_ENABLE   1
	Port enabled/disabled feature.
#define	USB_HUB_PORT_RESET   4
	Port reset feature.
#define	USB_HUB_PORT_POWER   8
	Port power feature.
#define	USB_HUB_PORT_LOW_SPEED   9
	Low-speed device attached.
#define	USB_HUB_PORT_HIGH_SPEED   10
	High-speed device attached.
#define	USB_HUB_C_PORT_CONNECTION   16
	Connect status changed.
#define	USB_HUB_C_PORT_ENABLE   17
	Port enable/disable changed.
#define	USB_HUB_C_PORT_SUSPEND   18
	Suspend changed.
#define	USB_HUB_C_PORT_OVER_CURRENT   19
	Over-current indicator changed.
#define	USB_HUB_C_PORT_RESET   20
	Reset changed.
#define	USB_HUB_C_PORT_LINK_STATE   25
	Link state changed.
#define	USB_HUB_C_PORT_CONFIG_ERROR   26
	Configuration error.
#define	USB_HUB_C_FEATURE(bit)
	Calculate feature from change bit number.
#define	USB_HUB_FEATURES
	USB features.
#define	USB_HUB_FEATURES_ENHANCED
	USB features for enhanced hubs.
#define	USB_HUB_SET_HUB_DEPTH
	Set hub depth.
#define	USB_HUB_CLEAR_TT_BUFFER
	Clear transaction translator buffer.
#define	USB_HUB_TT_SINGLE   1
	Transaction translator port value for single-TT hubs.
#define	USB_HUB_SLOW_START   0x0001
	Hub requires additional settling delay.
#define	USB_HUB_SLOW_START_DELAY_MS   500
	Additional setting delay for out-of-spec hubs.
#define	USB_HUB_INTR_FILL   4
	Interrupt ring fill level.
#define	USB_HUB_ENABLE_MAX_WAIT_MS   100
	Maximum time to wait for port to become enabled.

Functions
	FILE_LICENCE (GPL2_OR_LATER_OR_UBDL)
	FILE_SECBOOT (PERMITTED)
static int	usb_hub_get_descriptor (struct usb_device *usb, int enhanced, union usb_hub_descriptor *data)
	Get hub descriptor.
static int	usb_hub_get_port_status (struct usb_device *usb, unsigned int port, struct usb_hub_port_status *status)
	Get port status.
static int	usb_hub_clear_port_feature (struct usb_device *usb, unsigned int port, unsigned int feature, unsigned int index)
	Clear port feature.
static int	usb_hub_set_port_feature (struct usb_device *usb, unsigned int port, unsigned int feature, unsigned int index)
	Set port feature.
static int	usb_hub_set_hub_depth (struct usb_device *usb, unsigned int depth)
	Set hub depth.
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.

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 18 of file usbhub.h.

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

USB_HUB_DESCRIPTOR

#define USB_HUB_DESCRIPTOR   41

A basic USB hub descriptor.

Definition at line 35 of file usbhub.h.

Referenced by usb_hub_get_descriptor().

USB_HUB_DESCRIPTOR_ENHANCED

#define USB_HUB_DESCRIPTOR_ENHANCED   42

An enhanced USB hub descriptor.

Definition at line 50 of file usbhub.h.

Referenced by usb_hub_get_descriptor().

USB_HUB_PORT_CONNECTION

#define USB_HUB_PORT_CONNECTION   0

Current connect status feature.

Definition at line 71 of file usbhub.h.

Referenced by hub_speed().

USB_HUB_PORT_ENABLE

#define USB_HUB_PORT_ENABLE   1

Port enabled/disabled feature.

Definition at line 74 of file usbhub.h.

Referenced by hub_disable(), and hub_enable().

USB_HUB_PORT_RESET

#define USB_HUB_PORT_RESET   4

Port reset feature.

Definition at line 77 of file usbhub.h.

Referenced by hub_enable().

USB_HUB_PORT_POWER

#define USB_HUB_PORT_POWER   8

Port power feature.

Definition at line 80 of file usbhub.h.

Referenced by hub_open().

USB_HUB_PORT_LOW_SPEED

#define USB_HUB_PORT_LOW_SPEED   9

Low-speed device attached.

Definition at line 83 of file usbhub.h.

Referenced by hub_speed().

USB_HUB_PORT_HIGH_SPEED

#define USB_HUB_PORT_HIGH_SPEED   10

High-speed device attached.

Definition at line 86 of file usbhub.h.

Referenced by hub_speed().

USB_HUB_C_PORT_CONNECTION

#define USB_HUB_C_PORT_CONNECTION   16

Connect status changed.

Definition at line 89 of file usbhub.h.

USB_HUB_C_PORT_ENABLE

#define USB_HUB_C_PORT_ENABLE   17

Port enable/disable changed.

Definition at line 92 of file usbhub.h.

USB_HUB_C_PORT_SUSPEND

#define USB_HUB_C_PORT_SUSPEND   18

Suspend changed.

Definition at line 95 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 98 of file usbhub.h.

USB_HUB_C_PORT_RESET

#define USB_HUB_C_PORT_RESET   20

Reset changed.

Definition at line 101 of file usbhub.h.

USB_HUB_C_PORT_LINK_STATE

#define USB_HUB_C_PORT_LINK_STATE   25

Link state changed.

Definition at line 104 of file usbhub.h.

USB_HUB_C_PORT_CONFIG_ERROR

#define USB_HUB_C_PORT_CONFIG_ERROR   26

Configuration error.

Definition at line 107 of file usbhub.h.

USB_HUB_C_FEATURE

#define USB_HUB_C_FEATURE

(

bit

)

Value:

( 16 + (bit) )

Calculate feature from change bit number.

Definition at line 110 of file usbhub.h.

Referenced by hub_clear_changes().

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 113 of file usbhub.h.

#define USB_HUB_FEATURES                                                \
        ( ( 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 ) )

Referenced by hub_probe().

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 121 of file usbhub.h.

#define USB_HUB_FEATURES_ENHANCED                                       \
        ( ( 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 ) )

Referenced by hub_probe().

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

Set hub depth.

Definition at line 129 of file usbhub.h.

#define USB_HUB_SET_HUB_DEPTH                                           \
        ( USB_DIR_OUT | USB_TYPE_CLASS | USB_RECIP_DEVICE |             \
          USB_REQUEST_TYPE ( 12 ) )

Referenced by usb_hub_set_hub_depth().

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

Clear transaction translator buffer.

Definition at line 134 of file usbhub.h.

#define USB_HUB_CLEAR_TT_BUFFER                                         \
        ( USB_DIR_OUT | USB_TYPE_CLASS | USB_HUB_RECIP_PORT |           \
          USB_REQUEST_TYPE ( 8 ) )

Referenced by usb_hub_clear_tt_buffer().

USB_HUB_TT_SINGLE

#define USB_HUB_TT_SINGLE   1

Transaction translator port value for single-TT hubs.

Definition at line 249 of file usbhub.h.

Referenced by hub_clear_tt().

USB_HUB_SLOW_START

#define USB_HUB_SLOW_START   0x0001

Hub requires additional settling delay.

Definition at line 271 of file usbhub.h.

Referenced by hub_open().

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 274 of file usbhub.h.

Referenced by hub_open().

USB_HUB_INTR_FILL

#define USB_HUB_INTR_FILL   4

Interrupt ring fill level.

This is a policy decision.

Definition at line 280 of file usbhub.h.

Referenced by hub_probe().

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 286 of file usbhub.h.

Referenced by hub_enable().

Function Documentation

FILE_LICENCE()

FILE_LICENCE

(

GPL2_OR_LATER_OR_UBDL

)

FILE_SECBOOT()

FILE_SECBOOT

(

PERMITTED

)

usb_hub_get_descriptor()

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

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

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

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

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

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