Contents

setIdlePolicy

Sets the amount of idle time that must pass before suspending the device.

Declaration

virtual kern_return_t setIdlePolicy(USBIdlePolicyType type, uint16_t idleTimeMs);

Parameters

  • type:

    The target of the idle policy. For a list of possible values, see Usbidlepolicytype.

  • idleTimeMs:

    The idle time in milliseconds.

Return Value

kIOReturnSuccess on success, or another value if an error occurs. See Error Codes.

Discussion

Once the interface or pipe is idle, it defers electrical suspension of the device for the specified duration.

See Also

Configuring the Device