ucxcontroller.h header

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

Functions

Title Description
UCX_CONTROLLER_CONFIG_SET_ACPI_INFO Initializes a UCX_CONTROLLER_CONFIG structure with the specified values for the controller with ACPI as the parent.
UCX_CONTROLLER_CONFIG_SET_PCI_INFO Initializes a UCX_CONTROLLER_CONFIG structure with the specified values for the controller with PCI as the parent bus type.
UcxControllerCreate Creates a host controller object.
UcxControllerNeedsReset Initiates a non-Plug and Play (PnP) controller reset operation by queuing an event into the controller reset state machine.
UcxControllerNotifyTransportCharacteristicsChange Notifies UCX about a new port change event from host controller.
UcxControllerResetComplete Informs USB Host Controller Extension (UCX) that the reset operation has competed.
UcxControllerSetFailed Informs USB Host Controller Extension (UCX) that the controller has encountered a critical failure.
UcxControllerSetIdStrings Updates the identifier strings of a controller after the controller has been initialized.
UcxIoDeviceControl Allows USB host controller extension (UCX) to handle an I/O control code (IOCTL) request from user mode.

Callback functions

Title Description
EVT_UCX_CONTROLLER_GET_CURRENT_FRAMENUMBER The client driver's implementation that UCX calls to retrieve the current 32-bit frame number.
EVT_UCX_CONTROLLER_GET_FRAME_NUMBER_AND_QPC_FOR_TIME_SYNC UCX invokes this callback to retrieves the system query performance counter (QPC) value synchronized with the frame and microframe.
EVT_UCX_CONTROLLER_GET_TRANSPORT_CHARACTERISTICS UCX invokes this callback to retrieve the host controller characteristics.
EVT_UCX_CONTROLLER_QUERY_USB_CAPABILITY The client driver's implementation to determine if the controller supports a specific capability.
EVT_UCX_CONTROLLER_RESET The client driver's implementation that UCX calls to reset the controller.
EVT_UCX_CONTROLLER_SET_TRANSPORT_CHARACTERISTICS_CHANGE_NOTIFICATION UCX invokes this callback function to specify its preference in transport characteristics for which the client driver must send notifications when changes occur.
EVT_UCX_CONTROLLER_START_TRACKING_FOR_TIME_SYNC UCX invokes this callback function to the start time tracking functionality in the controller.
EVT_UCX_CONTROLLER_STOP_TRACKING_FOR_TIME_SYNC UCX invokes this callback function to the stop time tracking functionality in the controller.
EVT_UCX_CONTROLLER_USBDEVICE_ADD The client driver's implementation that UCX calls when a new USB device is detected.

Structures

Title Description
UCX_CONTROLLER_ACPI_INFORMATION This structure provides information about an advanced Configuration and power interface (ACPI) USB controller.
UCX_CONTROLLER_CONFIG This structure configuration data for a USB controller.
UCX_CONTROLLER_PCI_INFORMATION This structure provides information about a PCI USB controller.
UCX_CONTROLLER_RESET_COMPLETE_INFO Contains information about the operation to reset the controller. This is used by the client driver in its EVT_UCX_CONTROLLER_RESET callback function.
UCX_CONTROLLER_TRANSPORT_CHARACTERISTICS Stores the transport characteristics at relevant points in time. This structure is used in the EVT_UCX_CONTROLLER_GET_TRANSPORT_CHARACTERISTICS callback function.
UCX_CONTROLLER_TRANSPORT_CHARACTERISTICS_CHANGE_FLAGS Defines flags for the transport characteristics changes. This structure is used in the EVT_UCX_CONTROLLER_SET_TRANSPORT_CHARACTERISTICS_CHANGE_NOTIFICATION callback function.

Enumerations

Title Description
UCX_CONTROLLER_PARENT_BUS_TYPE The UCX_CONTROLLER_PARENT_BUS_TYPE enumeration defines the parent bus type.
UCX_CONTROLLER_STATE This enumeration provides values to specify the UCX controller state after a reset.