2.2.4.13 USB_DEVICE_RemoteWakeupStartTimed Function

C

void USB_DEVICE_RemoteWakeupStartTimed(
    USB_DEVICE_HANDLE usbDeviceHandle
);

Summary

This function will start a self timed Remote Wake-up sequence. The function will cause the device to generate resume signaling for 10 milliseconds. The resume signaling will stop after 10 milliseconds. The application can use this function instead of the USB_DEVICE_RemoteWakeupStart and USB_DEVICE_RemoteWakeupStop functions, which require the application to manually start, maintain duration and then stop the resume signaling.

Precondition

Client handle should be valid. The host should have enabled the Remote Wake-up feature for this device.

Parameters

Returns

None.

Example

// This code example shows how the device can use the
// USB_DEVICE_RemoteWakeupStartTimed function to drive resume signaling
// on the bus for 10 milliseconds.

USB_DEVICE_HANDLE usbDeviceHandle;

// Check if host has enabled remote wake-up for the device.
if(USB_DEVICE_REMOTE_WAKEUP_ENABLED == USB_DEVICE_RemoteWakeupStatusGet(usbDeviceHandle))
{
    // Remote wake-up is enabled

    USB_DEVICE_RemoteWakeupStartTimed(usbDeviceHandle);
}

Remarks

None.