USB Device Interface (UDI) for Human Interface Device Generic (HID Generic)

USB Device Interface (UDI) for Human Interface Device generic (HID generic) provides an interface for the configuration and management of USB HID generic device.

The outline of this documentation is as follows:

• API Overview
• Quick Start Guide for USB Device Generic Module (UDI Generic)
• Configuration File Examples

For more details for Atmel® Software Framework (ASF) USB Device Stack and USB Device HID generic, refer to following application notes:

• AVR4900: ASF - USB Device Stack
• AVR4905: ASF - USB Device HID Generic Application
• AVR4920: ASF - USB Device Stack - Compliance and Performance Figures
• AVR4921: ASF - USB Device Stack Differences between ASF V1 and V2

API Overview

Data Structures
struct	udi_hid_generic_desc_t
	Interface descriptor structure for HID generic. More...
struct	udi_hid_generic_report_desc_t
	Report descriptor for HID generic. More...

Interface with USB Device Core (UDC)
Structure required by UDC.
UDC_DESC_STORAGE udi_api_t	udi_api_hid_generic
	Global structure which contains standard UDI API for UDC. More...

USB Interface Descriptors
The following structures provide predefined USB interface descriptors. It must be used to define the final USB descriptors.
#define	UDI_HID_GENERIC_STRING_ID   0
	By default no string associated to this interface. More...
#define	UDI_HID_GENERIC_DESC
	Content of HID generic interface descriptor for all speed. More...

USB Device Interface (UDI) for Human Interface Device (HID) Generic Class
Common APIs used by high level application to use this USB class.
bool	udi_hid_generic_send_report_in (uint8_t *data)
	Routine used to send a report to USB Host. More...

#define UDI_HID_GENERIC_DESC

Value:

{\
   .iface.bLength             = sizeof(usb_iface_desc_t),\
   .iface.bDescriptorType     = USB_DT_INTERFACE,\
   .iface.bInterfaceNumber    = UDI_HID_GENERIC_IFACE_NUMBER,\
   .iface.bAlternateSetting   = 0,\
   .iface.bNumEndpoints       = 2,\
   .iface.bInterfaceClass     = HID_CLASS,\
   .iface.bInterfaceSubClass  = HID_SUB_CLASS_NOBOOT,\
   .iface.bInterfaceProtocol  = HID_PROTOCOL_GENERIC,\
   .iface.iInterface          = UDI_HID_GENERIC_STRING_ID,\
   .hid.bLength               = sizeof(usb_hid_descriptor_t),\
   .hid.bDescriptorType       = USB_DT_HID,\
   .hid.bcdHID                = LE16(USB_HID_BDC_V1_11),\
   .hid.bCountryCode          = USB_HID_NO_COUNTRY_CODE,\
   .hid.bNumDescriptors       = USB_HID_NUM_DESC,\
   .hid.bRDescriptorType      = USB_DT_HID_REPORT,\
   .hid.wDescriptorLength     = LE16(sizeof(udi_hid_generic_report_desc_t)),\
   .ep_in.bLength             = sizeof(usb_ep_desc_t),\
   .ep_in.bDescriptorType     = USB_DT_ENDPOINT,\
   .ep_in.bEndpointAddress    = UDI_HID_GENERIC_EP_IN,\
   .ep_in.bmAttributes        = USB_EP_TYPE_INTERRUPT,\
   .ep_in.wMaxPacketSize      = LE16(UDI_HID_GENERIC_EP_SIZE),\
   .ep_in.bInterval           = 4,\
   .ep_out.bLength            = sizeof(usb_ep_desc_t),\
   .ep_out.bDescriptorType    = USB_DT_ENDPOINT,\
   .ep_out.bEndpointAddress   = UDI_HID_GENERIC_EP_OUT,\
   .ep_out.bmAttributes       = USB_EP_TYPE_INTERRUPT,\
   .ep_out.wMaxPacketSize     = LE16(UDI_HID_GENERIC_EP_SIZE),\
   .ep_out.bInterval          = 4,\
   }

Content of HID generic interface descriptor for all speed.

#define UDI_HID_GENERIC_STRING_ID   0

By default no string associated to this interface.

bool udi_hid_generic_send_report_in

(

uint8_t *

data

)

Routine used to send a report to USB Host.

Parameters

[in]

data

Pointer on the report to send (size = UDI_HID_REPORT_IN_SIZE)

Returns

1 if function was successfully done, otherwise 0.

UDC_DESC_STORAGE udi_api_t udi_api_hid_generic

Global structure which contains standard UDI API for UDC.