USB Host Interface (UHI) for Human Interface Device Mouse (HID Mouse)

USB Host Interface (UHI) for Human Interface Device Mouse (HID Mouse) provides an interface for the configuration and management of USB HID mouse host.

The outline of this documentation is as follows:

• API Overview
• Quick Start Guide for USB Host Mouse Module (UHI Mouse)
• Configuration File Examples

For more details for Atmel® Software Framework (ASF) USB Host Stack, refer to following application note:

• AVR4950: ASF - USB Host Stack

API Overview

Interface with USB Host Core (UHC)
Define and functions required by UHC.
#define	UHI_HID_MOUSE
	Global define which contains standard UHI API for UHC. More...

Functions Required by UHC
uhc_enum_status_t	uhi_hid_mouse_install (uhc_device_t *dev)
	Install interface Allocate interface endpoints if supported. More...
void	uhi_hid_mouse_enable (uhc_device_t *dev)
	Enable the interface. More...
void	uhi_hid_mouse_uninstall (uhc_device_t *dev)
	Uninstall the interface (if installed). More...

UHI for Human Interface Device Mouse Class
Common APIs used by high level application to use this USB host class. These APIs require only callback definitions in conf_usb_host.h file through following defines:
#define	UHI_HID_MOUSE_CHANGE(dev, b_plug)
#define	UHI_HID_MOUSE_EVENT_BTN_LEFT(b_state)
#define	UHI_HID_MOUSE_EVENT_BTN_RIGHT(b_state)
#define	UHI_HID_MOUSE_EVENT_BTN_MIDDLE(b_state)
#define	UHI_HID_MOUSE_EVENT_MOUVE(x, y, scroll)

#define UHI_HID_MOUSE

Value:

{ \
    .install = uhi_hid_mouse_install, \
    .enable = uhi_hid_mouse_enable, \
    .uninstall = uhi_hid_mouse_uninstall, \
    .sof_notify = NULL, \
}

Global define which contains standard UHI API for UHC.

It must be added in USB_HOST_UHI define from conf_usb_host.h file.

#define UHI_HID_MOUSE_CHANGE	(		dev,
			b_plug
	)

#define UHI_HID_MOUSE_EVENT_BTN_LEFT

(

b_state

)

#define UHI_HID_MOUSE_EVENT_BTN_MIDDLE

(

b_state

)

#define UHI_HID_MOUSE_EVENT_BTN_RIGHT

(

b_state

)

#define UHI_HID_MOUSE_EVENT_MOUVE	(		x,
			y,
			scroll
	)

void uhi_hid_mouse_enable

(

uhc_device_t *

dev

)

Enable the interface.

Enable a USB interface corresponding to UHI.

Parameters

[in]

uhc_device_t

Device to request

References uhc_device_t::address, uhi_hid_mouse_dev_t::dev, uhi_hid_mouse_dev_t::report_btn_prev, UHI_HID_MOUSE_CHANGE, and uhi_hid_mouse_start_trans_report().

uhc_enum_status_t uhi_hid_mouse_install

(

uhc_device_t *

dev

)

Install interface Allocate interface endpoints if supported.

Parameters

[in]

uhc_device_t

Device to request

Returns

Status of the install.

References uhc_device_t::address, Assert, usb_iface_desc_t::bDescriptorType, usb_iface_desc_t::bInterfaceClass, usb_iface_desc_t::bInterfaceProtocol, usb_iface_desc_t::bLength, uhc_device_t::conf_desc, uhi_hid_mouse_dev_t::dev, dev, uhi_hid_mouse_dev_t::ep_in, HID_CLASS, HID_PROTOCOL_MOUSE, le16_to_cpu, NULL, uhi_hid_mouse_dev_t::report, uhi_hid_mouse_dev_t::report_size, uhc_device_t::speed, UHC_ENUM_HARDWARE_LIMIT, UHC_ENUM_MEMORY_LIMIT, UHC_ENUM_SOFTWARE_LIMIT, UHC_ENUM_SUCCESS, UHC_ENUM_UNSUPPORTED, uhd_ep_alloc(), USB_DT_ENDPOINT, USB_DT_INTERFACE, USB_EP_DIR_IN, and usb_conf_desc_t::wTotalLength.

void uhi_hid_mouse_uninstall

(

uhc_device_t *

dev

)

Uninstall the interface (if installed).

Parameters

[in]

uhc_device_t

Device to request

References Assert, uhi_hid_mouse_dev_t::dev, NULL, uhi_hid_mouse_dev_t::report, and UHI_HID_MOUSE_CHANGE.