SAMV71 Xplained Ultra Software Package 1.3

HID Protocol Types
[Usb_hid]

Collaboration diagram for HID Protocol Types:

Defines

#define HIDProtocol_BOOT   0
#define HIDProtocol_REPORT   1
#define HIDIdleRequest_INFINITE   0

Functions

uint8_t HIDReportRequest_GetReportType (const USBGenericRequest *request)
uint8_t HIDReportRequest_GetReportId (const USBGenericRequest *request)
uint8_t HIDIdleRequest_GetReportId (const USBGenericRequest *request)
uint8_t HIDIdleRequest_GetIdleRate (const USBGenericRequest *request)

Define Documentation

#define HIDIdleRequest_INFINITE   0

Infinite idle rate.

Definition at line 113 of file HIDRequests.h.

#define HIDProtocol_BOOT   0

Boot Protocol

Definition at line 108 of file HIDRequests.h.

#define HIDProtocol_REPORT   1

Report Protocol

Definition at line 110 of file HIDRequests.h.


Function Documentation

uint8_t HIDIdleRequest_GetIdleRate ( const USBGenericRequest request  ) 

Retrieves the Idle rate (in milliseconds) indicated by a SET_IDLE request.

Parameters:
request Pointer to a USBGenericRequest instance.
Returns:
New idle rate for the report.

Definition at line 68 of file HIDIdleRequest.c.

Here is the call graph for this function:

uint8_t HIDIdleRequest_GetReportId ( const USBGenericRequest request  ) 

Indicates the ID of the report targeted by a SET_IDLE or GET_IDLE request. This value should be 0 if report IDs are not used.

Parameters:
request Pointer to a USBGenericRequest instance.
Returns:
Requested report ID.

Definition at line 57 of file HIDIdleRequest.c.

Here is the call graph for this function:

uint8_t HIDReportRequest_GetReportId ( const USBGenericRequest request  ) 

Indicates the ID of the report targeted by a SET_REPORT or GET_REPORT request. This value should be 0 if report IDs are not used.

Parameters:
request Pointer to a USBGenericRequest instance.
Returns:
Requested report ID.

Definition at line 68 of file HIDReportRequest.c.

Here is the call graph for this function:

uint8_t HIDReportRequest_GetReportType ( const USBGenericRequest request  ) 

Indicates the type of report targeted by a SET_REPORT or GET_REPORT request.

Parameters:
request Pointer to a USBGenericRequest instance.
Returns:
Requested report type (see "HID Report Types").

Definition at line 57 of file HIDReportRequest.c.

Here is the call graph for this function:

 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Defines