Microchip® Advanced Software Framework

conf_usb_host.h File Reference

USB host configuration file.

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

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

Macros

#define USB_HOST_UHI   UHI_MSC, UHI_HID_MOUSE
 USB Host Configuration. More...
 
#define USB_HOST_POWER_MAX   500
 Maximum current allowed on Vbus (mA) More...
 
#define USB_HOST_HS_SUPPORT
 Authorize the USB HUB support. More...
 
#define UHC_MODE_CHANGE(b_host_mode)   ui_usb_mode_change(b_host_mode)
 USB Host callbacks. 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)   main_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()   main_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)   ui_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 UHI_MSC_CHANGE(dev, b_plug)   ui_uhi_msc_change(dev,b_plug)
 Configuration of MSC interface. More...
 

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

To notify that a device has been connected or disconnected.

Referenced by uhc_connection_tree().

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

Referenced by uhc_enumeration_error(), uhc_enumeration_step13(), uhc_enumeration_step14(), uhc_enumeration_step15(), uhc_enumeration_step17_lpm(), and uhc_enumeration_step18_lpm().

#define UHC_MODE_CHANGE (   b_host_mode)    ui_usb_mode_change(b_host_mode)

USB Host callbacks.

To notify that the USB mode are switched automatically. This is possible only when ID pin is available.

Referenced by usb_dual_enable().

#define UHC_SOF_EVENT ( )    main_usb_sof_event()

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

Referenced by _uhd_sof_interrupt().

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

Referenced by uhc_notify_resume(), and uhc_notify_resume_lpm().

#define UHI_HID_MOUSE_CHANGE (   dev,
  b_plug 
)    ui_uhi_hid_mouse_change(dev,b_plug)

USB Interface Configuration.

Configuration of HID Mouse interface

Referenced by uhi_hid_mouse_enable(), and uhi_hid_mouse_uninstall().

#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 UHI_MSC_CHANGE (   dev,
  b_plug 
)    ui_uhi_msc_change(dev,b_plug)

Configuration of MSC interface.

Referenced by uhi_msc_enable_step3(), and uhi_msc_uninstall().

#define USB_HOST_HS_SUPPORT

Authorize the USB HUB support.

Authorize the USB host to run in High Speed

#define USB_HOST_POWER_MAX   500

Maximum current allowed on Vbus (mA)

Referenced by uhc_enumeration_step13().

#define USB_HOST_UHI   UHI_MSC, UHI_HID_MOUSE

USB Host Configuration.

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