Atmel Software Framework

class/hid/host/mouse/example/conf_usb_host.h File Reference

USB host configuration file.

Copyright (C) 2011-2012 Atmel Corporation. All rights reserved.

#include "compiler.h"
#include "uhi_hid_mouse.h"
#include "ui.h"

Macros

#define USB_HOST_UHI   UHI_HID_MOUSE
 USB Host Configuration. More...
 
#define USB_HOST_POWER_MAX   500
 Maximum current allowed on Vbus (mA) More...
 
#define UHC_MODE_CHANGE(b_host_mode)   ui_usb_mode_change(b_host_mode)
 Authorize the USB HUB support. More...
 
#define UHC_VBUS_CHANGE(b_present)   ui_usb_vbus_change(b_present)
 To notify that the Vbus level has changed Available only in USB hardware with Vbus monitoring. More...
 
#define UHC_VBUS_ERROR()   ui_usb_vbus_error()
 To notify that a Vbus error has occurred Available only in USB hardware with Vbus monitoring. More...
 
#define UHC_CONNECTION_EVENT(dev, b_present)   ui_usb_connection_event(dev,b_present)
 To notify that a device has been connected or disconnected. More...
 
#define UHC_WAKEUP_EVENT()   ui_usb_wakeup_event()
 Called when a USB device or the host have wake up the USB line. More...
 
#define UHC_SOF_EVENT()   ui_usb_sof_event()
 Called for each received SOF each 1 ms Note: Available in High and Full speed mode. More...
 
#define UHC_ENUM_EVENT(dev, b_status)   ui_usb_enum_event(dev,b_status)
 Called when a USB device configuration must be chosen. More...
 
#define UHI_HID_MOUSE_CHANGE(dev, b_plug)
 USB Interface Configuration. More...
 
#define UHI_HID_MOUSE_EVENT_BTN_LEFT(b_state)   ui_uhi_hid_mouse_btn_left(b_state)
 
#define UHI_HID_MOUSE_EVENT_BTN_RIGHT(b_state)   ui_uhi_hid_mouse_btn_right(b_state)
 
#define UHI_HID_MOUSE_EVENT_BTN_MIDDLE(b_state)   ui_uhi_hid_mouse_btn_middle(b_state)
 
#define UHI_HID_MOUSE_EVENT_MOUVE(x, y, scroll)   ui_uhi_hid_mouse_move(x,y,scroll)
 

#define UHC_CONNECTION_EVENT (   dev,
  b_present 
)    ui_usb_connection_event(dev,b_present)

To notify that a device has been connected or disconnected.

#define UHC_ENUM_EVENT (   dev,
  b_status 
)    ui_usb_enum_event(dev,b_status)

Called when a USB device configuration must be chosen.

Thus, the application can choose either a configuration number for this device or a configuration number 0 to reject it. If callback not defined the configuration 1 is chosen. Called when a USB device enumeration is completed.

#define UHC_MODE_CHANGE (   b_host_mode)    ui_usb_mode_change(b_host_mode)

Authorize the USB HUB support.

Authorize the USB host to run in High Speed USB Host callbacksTo notify that the USB mode are switched automatically. This is possible only when ID pin is available.

#define UHC_SOF_EVENT ( )    ui_usb_sof_event()

Called for each received SOF each 1 ms Note: Available in High and Full speed mode.

#define UHC_VBUS_CHANGE (   b_present)    ui_usb_vbus_change(b_present)

To notify that the Vbus level has changed Available only in USB hardware with Vbus monitoring.

#define UHC_VBUS_ERROR ( )    ui_usb_vbus_error()

To notify that a Vbus error has occurred Available only in USB hardware with Vbus monitoring.

#define UHC_WAKEUP_EVENT ( )    ui_usb_wakeup_event()

Called when a USB device or the host have wake up the USB line.

#define UHI_HID_MOUSE_CHANGE (   dev,
  b_plug 
)

USB Interface Configuration.

Configuration of HID Mouse interface

#define UHI_HID_MOUSE_EVENT_BTN_LEFT (   b_state)    ui_uhi_hid_mouse_btn_left(b_state)
#define UHI_HID_MOUSE_EVENT_BTN_MIDDLE (   b_state)    ui_uhi_hid_mouse_btn_middle(b_state)
#define UHI_HID_MOUSE_EVENT_BTN_RIGHT (   b_state)    ui_uhi_hid_mouse_btn_right(b_state)
#define UHI_HID_MOUSE_EVENT_MOUVE (   x,
  y,
  scroll 
)    ui_uhi_hid_mouse_move(x,y,scroll)
#define USB_HOST_POWER_MAX   500

Maximum current allowed on Vbus (mA)

#define USB_HOST_UHI   UHI_HID_MOUSE

USB Host Configuration.

Array of UHI APIs Define the list of UHI supported by USB host.