Microchip® Advanced Software Framework

udi_hid_kbd_doc.h File Reference

USB device driver for Human Interface Device (HID) keyboard interface.

Copyright (c) 2014-2018 Microchip Technology Inc. and its subsidiaries.

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...
 

Macros

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...
 

Functions

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...
 

Variables

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...