Quick start guide for USB device keyboard module (UDI keyboard)

This is the quick start guide for the USB device keyboard module (UDI keyboard) with step-by-step instructions on how to configure and use the modules in a selection of use cases.

The use cases contain several code fragments. The code fragments in the steps for setup can be copied into a custom initialization function, while the steps for usage can be copied into, e.g., the main application function.

Also, you can refer to application note AVR4904: ASF - USB Device HID Keyboard Application.

Basic use case

In this basic use case, the "USB HID Keyboard (Single Interface Device)" module is used. The "USB HID Keyboard (Composite Device)" module usage is described in Advanced use cases.

Setup steps

Prerequisites

This module is based on USB device stack full interrupt driven, and supporting Sleep manager sleepmgr. For AVR and SAM3/4 devices the clk_group clock services is supported. For SAMD devices the SAM System Clock Management (SYSTEM CLOCK) Driver clock driver is supported.

The following procedure must be executed to setup the project correctly:

• Specify the clock configuration:
  • XMEGA USB devices need 48MHz clock input.
    XMEGA USB devices need CPU frequency higher than 12MHz.
    You can use either an internal RC48MHz auto calibrated by Start of Frames or an external OSC.
  • UC3 and SAM3/4 devices without USB high speed support need 48MHz clock input.
    You must use a PLL and an external OSC.
  • UC3 and SAM3/4 devices with USB high speed support need 12MHz clock input.
    You must use an external OSC.
  • UC3 devices with USBC hardware need CPU frequency higher than 25MHz.
  • SAMD devices without USB high speed support need 48MHz clock input.
    You should use DFLL with USBCRM.
• In conf_board.h, the define CONF_BOARD_USB_PORT must be added to enable USB lines. (Not mandatory for all boards)
• Enable interrupts
• Initialize the clock service

The usage of Sleep manager sleepmgr service is optional, but recommended to reduce power consumption:

• Initialize the sleep manager service
• Activate sleep mode when the application is in IDLE state

conf_clock.h examples with USB support.

for AVR and SAM3/4 devices, add to the initialization code:

sysclk_init();
irq_initialize_vectors();
cpu_irq_enable();
board_init();
sleepmgr_init(); // Optional

For SAMD devices, add to the initialization code:

system_init();
irq_initialize_vectors();
cpu_irq_enable();
sleepmgr_init(); // Optional

Add to the main IDLE loop:

sleepmgr_enter_sleep(); // Optional

Example code

Content of conf_usb.h:

#define USB_DEVICE_VENDOR_ID 0x03EB
#define USB_DEVICE_PRODUCT_ID 0xXXXX
#define USB_DEVICE_MAJOR_VERSION 1
#define USB_DEVICE_MINOR_VERSION 0
#define USB_DEVICE_POWER 100
#define USB_DEVICE_ATTR USB_CONFIG_ATTR_BUS_POWERED

Add to application C-file:

void usb_init(void)
{
  udc_start();
}

Workflow

1. Ensure that conf_usb.h is available and contains the following configuration which is the main USB device configuration:

// Vendor ID provided by USB org (ATMEL 0x03EB)
#define USB_DEVICE_VENDOR_ID 0x03EB // Type Word
// Product ID (Atmel PID referenced in usb_atmel.h)
#define USB_DEVICE_PRODUCT_ID 0xXXXX // Type Word
// Major version of the device
#define USB_DEVICE_MAJOR_VERSION 1 // Type Byte
// Minor version of the device
#define USB_DEVICE_MINOR_VERSION 0 // Type Byte
// Maximum device power (mA)
#define USB_DEVICE_POWER 100 // Type 9-bits
// USB attributes to enable features
#define USB_DEVICE_ATTR USB_CONFIG_ATTR_BUS_POWERED // Flags 

1. Call the USB device stack start function to enable stack and start USB:

   • udc_start(); 

     Note

     In case of USB dual roles (Device and Host) managed through USB OTG connector (USB ID pin), the call of udc_start() must be removed and replaced by uhc_start(). SeRefer to "AVR4950 section 6.1 Dual roles" for further information about dual roles.

Usage steps

Example code

Content of conf_usb.h:

#define UDI_HID_KBD_ENABLE_EXT() my_callback_keyboard_enable()
extern bool my_callback_keyboard_enable(void);
#define UDI_HID_KBD_DISABLE_EXT() my_callback_keyboard_disable()
extern void my_callback_keyboard_disable(void);
#include "udi_hid_keyboard_conf.h" // At the end of conf_usb.h file

Add to application C-file:

static bool my_flag_autorize_keyboard_events = false;
bool my_callback_keyboard_enable(void)
{
   my_flag_autorize_keyboard_events = true;
   return true;
}
void my_callback_keyboard_disable(void)
{
   my_flag_autorize_keyboard_events = false;
}

void my_key_A_press_event(void)
{
   if (!my_flag_autorize_keyboard_events) {
      return;
   }
   udi_hid_kbd_up(HID_A);
}

Workflow

1. Ensure that conf_usb.h is available and contains the following configuration which is the USB device keyboard configuration:

   • #define UDI_HID_KBD_ENABLE_EXT() my_callback_keyboard_enable()
         extern bool my_callback_keyboard_enable(void); 

     Note

     After the device enumeration (detecting and identifying USB devices), the USB host starts the device configuration. When the USB keyboard interface from the device is accepted by the host, the USB host enables this interface and the UDI_HID_KBD_ENABLE_EXT() callback function is called and return true. Thus, it is recommended to enable sensors used by the keyboard in this function.

   • #define UDI_HID_KBD_DISABLE_EXT() my_callback_keyboard_disable()
         extern void my_callback_keyboard_disable(void); 

     Note

     When the USB device is unplugged or is reset by the USB host, the USB interface is disabled and the UDI_HID_KBD_DISABLE_EXT() callback function is called. Thus, it is recommended to disable sensors used by the keyboard in this function.

2. send keyboard events:

   • // Send events key modifier released
        udi_hid_kbd_modifier_up(uint8_t modifier_id);
        // Send events key modifier pressed
        udi_hid_kbd_modifier_down(uint8_t modifier_id);
        // Send events key released
        udi_hid_kbd_up(uint8_t key_id);
        // Send events key pressed
        udi_hid_kbd_down(uint8_t key_id); 

Advanced use cases

For more advanced use of the UDI HID keyboard module, see the following use cases:

• HID keyboard in a composite device
• Change USB speed
• Use USB strings
• Use USB remote wakeup feature
• Bus power application recommendations
• USB dynamic serial number