Quick start guide for USB host mouse module (UHI mouse)

This is the quick start guide for the USB host mouse module (UHI mouse) 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.

Basic use case

In this basic use case, the "USB Host HID Mouse (Single Class support)" module is used. The "USB Host HID Mouse (Multiple Classes support)" module usage is described in Advanced use cases.

Setup steps

Prerequisites

This module is based on USB host stack full interrupt driven and supporting Sleep manager sleepmgr. For AVR and SAM3/4 devices the Clock Management clock services is supported. For SAMD21 devices the asfdoc_sam0_system_clock_group clock driver is supported.

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

• Specify the clock configuration:
  • 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.
  • SAMD21 devices without USB high speed support need 48MHz clock input.
    You must use a DFLL and an external OSC.
• 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 SAMD21 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_host.h:

#define USB_HOST_POWER_MAX  500

Add to application C-file:

void usb_init(void)
{
uhc_start();
}

Workflow

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

// Maximum current allowed on Vbus (mA) which depends of 5V generator
#define USB_HOST_POWER_MAX  500 // (500mA) 

1. Call the USB host stack start function to enable USB Host stack:

   • uhc_start(); 

Usage steps

Example code

Content of conf_usb_host.h:

#define USB_HOST_UHI        UHI_HID_MOUSE
#define UHI_HID_MOUSE_CHANGE(dev, b_plug) my_callback_mouse_change(dev, b_plug)
extern bool my_callback_mouse_change(uhc_device_t* dev, bool b_plug);
#define UHI_HID_MOUSE_EVENT_BTN_LEFT(b_state) my_callback_event_btn_left(b_state)
extern void my_callback_event_btn_left(bool b_state);
#define UHI_HID_MOUSE_EVENT_BTN_RIGHT(b_state) my_callback_event_btn_right(b_state)
extern void my_callback_event_btn_right(bool b_state);
#define UHI_HID_MOUSE_EVENT_BTN_MIDDLE(b_state) my_callback_event_btn_middle(b_state)
extern void my_callback_event_btn_middle(bool b_state);
#define UHI_HID_MOUSE_EVENT_MOUVE(x, y, scroll) my_callback_event_mouse(x, y, scroll)
extern void my_callback_event_mouse(int8_t x, int8_t y, int8_t scroll);
#include "uhi_hid_mouse.h" // At the end of conf_usb_host.h file

Add to application C-file:

bool my_callback_mouse_change(uhc_device_t* dev, bool b_plug)
{
   if (b_plug) {
      my_display_on_mouse_icon();
   } else {
      my_display_off_mouse_icon();
   }
}

void my_callback_event_btn_left(bool b_state)
{
   if (b_state) {
      // Here mouse button left pressed
   } else {
      // Here mouse button left released
   }
}

void my_callback_event_mouse(int8_t x, int8_t y, int8_t scroll)
{
   if (!x) {
      // Here mouse are moved on axe X
      cursor_x += x;
   }
   if (!y) {
      // Here mouse are moved on axe Y
      cursor_y += y;
   }
   if (!scroll) {
      // Here mouse are moved the wheel
      wheel += scroll;
   }
}

Workflow

1. Ensure that conf_usb_host.h is available and contains the following configuration which is the USB host mouse configuration:

   • #define USB_HOST_UHI   UHI_HID_MOUSE 

     Note

     It defines the list of UHI supported by USB host.

   • #define UHI_HID_MOUSE_CHANGE(dev, b_plug) my_callback_mouse_change(dev, b_plug)
         extern bool my_callback_mouse_change(uhc_device_t* dev, bool b_plug); 

     Note

     This callback is called when a USB device mouse is plugged or unplugged.

   • #define UHI_HID_MOUSE_EVENT_BTN_LEFT(b_state) my_callback_event_btn_left(b_state)
        extern void my_callback_event_btn_left(bool b_state);
        #define UHI_HID_MOUSE_EVENT_BTN_RIGHT(b_state) my_callback_event_btn_right(b_state)
        extern void my_callback_event_btn_right(bool b_state);
        #define UHI_HID_MOUSE_EVENT_BTN_MIDDLE(b_state) my_callback_event_btn_middle(b_state)
        extern void my_callback_event_btn_middle(bool b_state);
        #define UHI_HID_MOUSE_EVENT_MOUVE(x, y, scroll) my_callback_event_mouse(x, y, scroll)
        extern void my_callback_event_mouse(int8_t x, int8_t y, int8_t scroll) 

     Note

     These callbacks are called when a USB device mouse event is received.

Advanced use cases

For more advanced use of the UHI HID mouse module, see the following use cases:

• Enable USB high speed support
• Multiple classes support
• Dual roles support