HIDGetIdle

Syntax

#include <cafe/hid.h>
    
HID_ERROR_CODE  HIDGetIdle(
                                    u32         handle,
                                    u8          interface_index,
                                    u8          report_id,
                                    u8          *p_idle,
                                    HIDCallback async_callback,
                                    void        *p_user
                                    );

Parameters

handle Handle associated with the HID device.
interface_index Interface index of HID interface associated with HIDDevice.
report_id Report ID as defined by the HID specification.
p_idle Pointer to buffer to receive duration. This buffer must be aligned and padded to L2_CACHE_LINE_SIZE.
async_callback Pointer to HIDCallback for asynchronous completion notification.
p_user User-specified pointer passed to HIDCallback.

Return Values

HIDGetIdle returns HID_ERROR_CODE. For blocking calls, a return value of ≥ 0 specifies the number of bytes transferred for the request. For asynchronous calls, a return value of HID_ERROR_OK specifies that the call was initiated successfully and the result of the transaction will be specified in the HIDCallback parameters upon completion.

Description

HIDGetIdle performs an HID get idle transaction to an HID interface associated with an HIDDevice.handle. HIDGetIdle executes in a blocking manner when no HIDCallback is specified.

Do Not Call From

Background Do not call this function from the background.

See Also

HID_ERROR_CODE
HIDCallback
HIDSetIdle

Revision History

2013/05/08 Automated cleanup pass.
2011/09/29 Initial version.


CONFIDENTIAL