ufxclient.h header

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

• Universal Serial Bus (USB)

ufxclient.h contains the following programming interfaces:

Functions

UFX_DEVICE_CALLBACKS_INIT The UFX_DEVICE_CALLBACKS_INIT macro initializes the UFX_DEVICE_CALLBACKS structure.
UFX_DEVICE_CAPABILITIES_INIT The UFX_DEVICE_CAPABILITIES_INIT macro the initializes the UFX_DEVICE_CAPABILITIES structure.
UFX_ENDPOINT_CALLBACKS_INIT The UFX_ENDPOINT_CALLBACKS_INIT macro initializes the UFX_ENDPOINT_CALLBACKS structure.
UfxDeviceCreate Creates a UFX device object, registers event callback routines, and specifies capabilities specific to the controller.
UfxDeviceEventComplete Informs UFX that the client driver has completed processing a UFX callback function.
UfxDeviceIoControl Passes non-internal IOCTLs from user-mode to UFX.
UfxDeviceIoInternalControl Passes kernel mode IOCTLs to UFX.
UfxDeviceNotifyAttach Notifies UFX that the device's USB cable has been attached.
UfxDeviceNotifyDetach Notifies UFX that the device's USB cable has been detached.
UfxDeviceNotifyFinalExit Notifies UFX that the device is detached.
UfxDeviceNotifyHardwareFailure Notifies UFX about a non-recoverable hardware failure in the controller.
UfxDeviceNotifyHardwareReady Notifies UFX that the hardware is ready.
UfxDeviceNotifyReset Notifies UFX about a USB bus reset event.
UfxDeviceNotifyResume Notifies UFX about a USB bus resume event.
UfxDeviceNotifySuspend Notifies UFX about a USB bus suspend event.
UfxDevicePortDetectComplete Notifies UFX about the port type that was detected.
UfxDevicePortDetectCompleteEx Notifies UFX about the port type that was detected, and optionally requests an action.
UfxDeviceProprietaryChargerDetectComplete Notifies UFX about a detected proprietary port/charger type.
UfxEndpointCreate Creates an endpoint object.
UfxEndpointGetCommandQueue Returns the command queue previously created by UfxEndpointCreate.
UfxEndpointGetTransferQueue Returns the transfer queue previously created by UfxEndpointCreate.
UfxEndpointInitSetEventCallbacks Initialize a UFXENDPOINT_INIT structure.
UfxEndpointNotifySetup Notifies UFX when the client driver receives a setup packet from the host.
UfxFdoInit Initializes the WDFDEVICE_INIT structure that the client driver subsequently provides when it calls WdfDeviceCreate.

Callback functions

EVT_UFX_DEVICE_ADDRESSED The client driver's implementation to assign an address on the function controller.
EVT_UFX_DEVICE_CONTROLLER_RESET The client driver's implementation to reset the function controller to its initial state.
EVT_UFX_DEVICE_DEFAULT_ENDPOINT_ADD The client driver's implementation to create a default control endpoint.
EVT_UFX_DEVICE_ENDPOINT_ADD The client driver's implementation to create a default endpoint object.
EVT_UFX_DEVICE_HOST_CONNECT The client driver's implementation to initiate connection with the host.
EVT_UFX_DEVICE_HOST_DISCONNECT The client driver's implementation to disable the function controller's communication with the host.
EVT_UFX_DEVICE_PORT_CHANGE The client driver's implementation to update the type of the new port to which the USB device is connected.
EVT_UFX_DEVICE_PORT_DETECT The client driver's implementation to initiate port detection.
EVT_UFX_DEVICE_PROPRIETARY_CHARGER_DETECT The client driver's implementation to initiate proprietary charger detection.
EVT_UFX_DEVICE_PROPRIETARY_CHARGER_RESET The client driver's implementation to resets proprietary charger.
EVT_UFX_DEVICE_PROPRIETARY_CHARGER_SET_PROPERTY The client driver's implementation to set charger information that it uses to enable charging over USB.
EVT_UFX_DEVICE_REMOTE_WAKEUP_SIGNAL The client driver's implementation to initiate remote wake-up on the function controller.
EVT_UFX_DEVICE_SUPER_SPEED_POWER_FEATURE The client driver's implementation to set or clear the specified power feature on the function controller.
EVT_UFX_DEVICE_TEST_MODE_SET The client driver's implementation to set the test mode of the function controller.
EVT_UFX_DEVICE_TESTHOOK This IOCTL code is not supported.
EVT_UFX_DEVICE_USB_STATE_CHANGE The client driver's implementation to update the state of the USB device.

Structures

UFX_DEVICE_CALLBACKS The UFX_DEVICE_CALLBACKS structure is used to define then event callback functions supported by the client driver.
UFX_ENDPOINT_CALLBACKS The UFX_ENDPOINT_CALLBACKS structure is used to define then event callback functions supported by the client driver.