SAMV71 Xplained Ultra Software Package 1.4

Usb_hid

Collaboration diagram for Usb_hid:

Data Structures

struct  _HIDDescriptor
struct  _HIDDescriptor1
struct  _HIDPhysicalDescriptor0
union  HIDPhysicalInfo
struct  _HIDPhysicalDescriptor

Modules

 HID Device Descriptor Codes
 HID Interface Descriptor Codes
 HID Release Numbers
 HID Descriptors Types
 USB HID Report
 HID Request Codes
 HID Report Types
 HID Protocol Types
 HID Usage Pages' IDs
 HID GenericDesktop Page ID
 HID GenericDesktop Usages
 HID Keypad Page ID
 HID Alphabetic Keys
 HID Numeric Keys
 HID Special Keys
 HID Modified Keys
 HID Error Codes
 HID LEDs Page ID
 HID LEDs Usages
 HID BUTTONs Page ID

Functions

uint8_t HIDIdleRequest_GetReportId (const USBGenericRequest *request)
uint8_t HIDIdleRequest_GetIdleRate (const USBGenericRequest *request)
uint8_t HIDKeypad_IsModifierKey (uint8_t key)
uint8_t HIDReportRequest_GetReportType (const USBGenericRequest *request)
uint8_t HIDReportRequest_GetReportId (const USBGenericRequest *request)
struct _HIDDescriptor __attribute__ ((__packed__)) HIDDescriptor

Function Documentation

struct _HIDDescriptor __attribute__ ( (__packed__)   ) 

HID Physical Descriptor set 0: specifies the number of additional descriptor sets.

HID Physical Descriptor

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 HIDKeypad_IsModifierKey ( uint8_t  key  ) 

Indicates if the given key code is associated with a modified key.

Parameters:
key Key code.
Returns:
1 if the key code represents a modifier key; otherwise 0.
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