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

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

The outline of this documentation is as follows:

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

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

• AVR4900: ASF - USB Device Stack
• AVR4904: ASF - USB Device HID Keyboard 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_kbd_desc_t
	Interface descriptor structure for HID keyboard. More...
struct	udi_hid_kbd_report_desc_t
	Report descriptor for HID keyboard. More...

Interface with USB Device Core (UDC)
Variable required by UDC.
UDC_DESC_STORAGE udi_api_t	udi_api_hid_kbd
	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_KBD_STRING_ID   0
	By default no string associated to this interface. More...
#define	UDI_HID_KBD_EP_SIZE   8
	HID keyboard endpoints size. More...
#define	UDI_HID_KBD_DESC
	Content of HID keyboard interface descriptor for all speed. More...

USB Device Interface (UDI) for Human Interface Device (HID) Keyboard Class
Common APIs used by high level application to use this USB class.
bool	udi_hid_kbd_modifier_up (uint8_t modifier_id)
	Send events key modifier released. More...
bool	udi_hid_kbd_modifier_down (uint8_t modifier_id)
	Send events key modifier pressed. More...
bool	udi_hid_kbd_up (uint8_t key_id)
	Send events key released. More...
bool	udi_hid_kbd_down (uint8_t key_id)
	Send events key pressed. More...

#define UDI_HID_KBD_DESC

Value:

{\
    .iface.bLength             = sizeof(usb_iface_desc_t),\
    .iface.bDescriptorType     = USB_DT_INTERFACE,\
    .iface.bInterfaceNumber    = UDI_HID_KBD_IFACE_NUMBER,\
    .iface.bAlternateSetting   = 0,\
    .iface.bNumEndpoints       = 1,\
    .iface.bInterfaceClass     = HID_CLASS,\
    .iface.bInterfaceSubClass  = HID_SUB_CLASS_NOBOOT,\
    .iface.bInterfaceProtocol  = HID_PROTOCOL_KEYBOARD,\
    .iface.iInterface          = UDI_HID_KBD_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_kbd_report_desc_t)),\
    .ep.bLength                = sizeof(usb_ep_desc_t),\
    .ep.bDescriptorType        = USB_DT_ENDPOINT,\
    .ep.bEndpointAddress       = UDI_HID_KBD_EP_IN,\
    .ep.bmAttributes           = USB_EP_TYPE_INTERRUPT,\
    .ep.wMaxPacketSize         = LE16(UDI_HID_KBD_EP_SIZE),\
    .ep.bInterval              = 2,\
    }

Content of HID keyboard interface descriptor for all speed.

#define UDI_HID_KBD_EP_SIZE   8

HID keyboard endpoints size.

#define UDI_HID_KBD_STRING_ID   0

By default no string associated to this interface.

bool udi_hid_kbd_down

(

uint8_t

key_id

)

Send events key pressed.

Parameters

[in]

key_id

ID of key

Returns

1 if function was successfully done, otherwise 0.

Parameters

key_id

ID of key

References cpu_irq_restore(), cpu_irq_save(), i, udi_hid_kbd_b_report_valid, udi_hid_kbd_report, UDI_HID_KBD_REPORT_SIZE, and udi_hid_kbd_send_report().

bool udi_hid_kbd_modifier_down

(

uint8_t

modifier_id

)

Send events key modifier pressed.

Parameters

[in]

modifier_id

ID of key modifier

Returns

1 if function was successfully done, otherwise 0.

Parameters

modifier_id

ID of key modifier

Returns

1 if function was successfully done, otherwise 0.

References cpu_irq_restore(), cpu_irq_save(), udi_hid_kbd_b_report_valid, udi_hid_kbd_report, and udi_hid_kbd_send_report().

bool udi_hid_kbd_modifier_up

(

uint8_t

modifier_id

)

Send events key modifier released.

Parameters

[in]

modifier_id

ID of key modifier

Returns

1 if function was successfully done, otherwise 0.

Parameters

modifier_id

ID of key modifier

Returns

1 if function was successfully done, otherwise 0.

References cpu_irq_restore(), cpu_irq_save(), udi_hid_kbd_b_report_valid, udi_hid_kbd_report, and udi_hid_kbd_send_report().

bool udi_hid_kbd_up

(

uint8_t

key_id

)

Send events key released.

Parameters

[in]

key_id

ID of key

Returns

1 if function was successfully done, otherwise 0.

Parameters

key_id

ID of key

Returns

1 if function was successfully done, otherwise 0.

References cpu_irq_restore(), cpu_irq_save(), i, udi_hid_kbd_b_report_valid, udi_hid_kbd_report, UDI_HID_KBD_REPORT_SIZE, and udi_hid_kbd_send_report().

UDC_DESC_STORAGE udi_api_t udi_api_hid_kbd

Global structure which contains standard UDI API for UDC.

Global structure which contains standard UDI API for UDC.