UfxDevicePortDetectComplete function (ufxclient.h)

Article
10/21/2021

Notifies UFX about the port type that was detected.

Syntax

void UfxDevicePortDetectComplete(
  [in] UFXDEVICE       UfxDevice,
  [in] USBFN_PORT_TYPE PortType
);

Parameters

[in] UfxDevice

A handle to a UFX device object that the driver created by calling UfxDeviceCreate.

[in] PortType

Contains an enumeration value of type USBFN_PORT_TYPE.

Return value

None

Remarks

The client driver calls UfxDevicePortDetectComplete when port detection is complete. On some platforms, UFX may use the reported port type to notify the battery manager of the maximum current it can draw from the USB port.

The client driver typically calls UfxDevicePortDetectComplete from its EVT_UFX_DEVICE_PORT_DETECT callback function, as shown in this example.

    // In this example we will return an unknown port type.  This will allow UFX to connect to a host if
    // one is present.  UFX will timeout after 5 seconds if no host is present and transition to
    // an invalid charger type, which will allow the controller to exit D0.
    //
    UfxDevicePortDetectComplete(ControllerContext->UfxDevice, UsbfnUnknownPort);

Requirements

Requirement	Value
Minimum supported client	Windows 10
Target Platform	Windows
Header	ufxclient.h
Library	ufxstub.lib
IRQL	DISPATCH_LEVEL

Share via