UfxDeviceNotifySuspend function (ufxclient.h)

Notifies UFX about a USB bus suspend event.

Syntax

void UfxDeviceNotifySuspend(
  [in] UFXDEVICE UfxDevice
);

Parameters

[in] UfxDevice

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

Return value

None

Remarks

The client driver calls UfxDeviceNotifySuspend when it receives a bus suspend event. The default endpoint should be reset on a bus suspend. The device should move to a low power mode.

The client driver typically calls UfxDeviceNotifySuspend from its EvtInterruptDpc callback function. The following example shows how to handle a suspend event.

    case DeviceEventSuspend:
        if (!ControllerContext->Suspended) {
            ControllerContext->Suspended = TRUE;
            UfxDeviceNotifySuspend(ControllerContext->UfxDevice);
        }
        break;

Requirements