ucxroothub.h header

This header is used by usbref. For more information, see:

ucxroothub.h contains the following programming interfaces:

Functions

 
UcxRootHubPortChanged

Notifies UCX about a new port change event on the host controller.

Callback functions

 
EVT_UCX_ROOTHUB_CONTROL_URB

The client driver uses this callback type to implement handlers that UCX calls when it receives feature control requests on the USB hub.
EVT_UCX_ROOTHUB_GET_20PORT_INFO

The client driver's implementation that UCX calls when it receives a request for information about USB 2.0 ports on the root hub.
EVT_UCX_ROOTHUB_GET_30PORT_INFO

The client driver's implementation that UCX calls when it receives a request for information about USB 3.0 ports on the root hub.
EVT_UCX_ROOTHUB_GET_INFO

The client driver's implementation that UCX calls when it receives a request for information about the root hub.
EVT_UCX_ROOTHUB_INTERRUPT_TX

The client driver's implementation that UCX calls when it receives a request for information about changed ports.

Structures

 
CONTROLLER_USB_20_HARDWARE_LPM_FLAGS

Describes supported protocol capabilities for Link Power Management (LPM) in as defined the USB 2.0 specification.
HUB_INFO_FROM_PARENT

Describes information about a hub from its parent device.
PARENT_HUB_FLAGS

This structure is used by the HUB_INFO_FROM_PARENT structure to get hub information from the parent.
ROOTHUB_20PORT_INFO

Provides information about a USB 2.0 root hub port. This structure is passed by UCX in the EVT_UCX_ROOTHUB_GET_20PORT_INFO callback function.
ROOTHUB_20PORTS_INFO

This structure that has an array of 2.0 ports supported by the root hub. This structure is provided by UCX in a framework request in the EVT_UCX_ROOTHUB_GET_20PORT_INFO callback function.
ROOTHUB_30PORT_INFO

Provides information about a USB 3.0 root hub port. This structure is passed by UCX in the EVT_UCX_ROOTHUB_GET_30PORT_INFO callback function.
ROOTHUB_30PORT_INFO_EX

Provides extended USB 3.0 port information about speed.
ROOTHUB_30PORTS_INFO

Provides information about USB 3.0 root hub ports. This structure is passed by UCX in the EVT_UCX_ROOTHUB_GET_30PORT_INFO callback function.
ROOTHUB_INFO

Provides information about a USB root hub. This structure is passed by UCX in the EVT_UCX_ROOTHUB_GET_INFO callback function.
UCX_ROOTHUB_CONFIG

Contains pointers to event callback functions for creating the root hub by calling UcxRootHubCreate. Initialize this structure by calling UCX_ROOTHUB_CONFIG_INIT initialization function (see Ucxclass.h).

Enumerations

 
CONTROLLER_TYPE

This enumeration specifies if the USB host controller is an eXtensible Host Controller Interface (xHCI) controller.
TRISTATE

The TRISTATE enumeration indicates generic state values for true or false.