Atmel Software Framework

hid/dual/mouse/example/ui.h File Reference

Common User Interface for application.

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

#include "uhc.h"

Functions

Main user interface functions
void ui_init (void)
 Initializes the user interface. More...
 
void ui_usb_mode_change (bool b_host_mode)
 Notify that the USB mode are switched automatically. This is possible only when ID pin is available. More...
 
Host mode user interface functions
void ui_host_vbus_change (bool b_vbus_present)
 Notify that a Vbus are changed Available only in USB hardware with Vbus monitoring. More...
 
void ui_host_vbus_error (void)
 Notify that a Vbus error has occurred Available only in USB hardware with Vbus monitoring. More...
 
void ui_host_connection_event (uhc_device_t *dev, bool b_present)
 Notify that a USB device has been connected or disconnected. More...
 
void ui_host_wakeup_event (void)
 Notify that a USB device or the host has wake up the USB line. More...
 
void ui_host_sof_event (void)
 Notify that a SOF has been sent (each 1 ms) More...
 
void ui_host_enum_event (uhc_device_t *dev, uhc_enum_status_t status)
 Notify the end of a USB device enumeration. More...
 
Callback to mange the HID mouse events
void ui_host_hid_mouse_btn_left (bool b_state)
 
void ui_host_hid_mouse_btn_right (bool b_state)
 
void ui_host_hid_mouse_btn_middle (bool b_state)
 
void ui_host_hid_mouse_move (int8_t x, int8_t y, int8_t scroll)
 
Device mode user interface functions
void ui_device_suspend_action (void)
 Enters the user interface in low power mode Callback called when USB host sets USB line in suspend state. More...
 
void ui_device_resume_action (void)
 Exits the user interface if the low power mode Callback called when USB host sets USB line in IDLE state. More...
 
void ui_device_remotewakeup_enable (void)
 Enables the remotewakeup feature. More...
 
void ui_device_remotewakeup_disable (void)
 Disables the remotewakeup feature. More...
 
bool ui_device_mouse_enable (void)
 Enables the device mouse interface. More...
 
void ui_device_mouse_disable (void)
 Disables the device mouse interface. More...
 
void ui_device_sof_action (void)
 Scans the device mouse controls and shows the device status each USB SOF. More...
 

void ui_device_mouse_disable ( void  )

Disables the device mouse interface.

bool ui_device_mouse_enable ( void  )

Enables the device mouse interface.

void ui_device_remotewakeup_disable ( void  )

Disables the remotewakeup feature.

void ui_device_remotewakeup_enable ( void  )

Enables the remotewakeup feature.

void ui_device_resume_action ( void  )

Exits the user interface if the low power mode Callback called when USB host sets USB line in IDLE state.

void ui_device_sof_action ( void  )

Scans the device mouse controls and shows the device status each USB SOF.

void ui_device_suspend_action ( void  )

Enters the user interface in low power mode Callback called when USB host sets USB line in suspend state.

void ui_host_connection_event ( uhc_device_t dev,
bool  b_present 
)

Notify that a USB device has been connected or disconnected.

Parameters
devPointer on USB device information
b_presenttrue, if the device has been connected
void ui_host_enum_event ( uhc_device_t dev,
uhc_enum_status_t  status 
)

Notify the end of a USB device enumeration.

Parameters
devPointer on USB device information
statusStatus of the USB enumeration
void ui_host_hid_mouse_btn_left ( bool  b_state)
void ui_host_hid_mouse_btn_middle ( bool  b_state)
void ui_host_hid_mouse_btn_right ( bool  b_state)
void ui_host_hid_mouse_move ( int8_t  x,
int8_t  y,
int8_t  scroll 
)
void ui_host_sof_event ( void  )

Notify that a SOF has been sent (each 1 ms)

void ui_host_vbus_change ( bool  b_vbus_present)

Notify that a Vbus are changed Available only in USB hardware with Vbus monitoring.

Parameters
b_vbus_presenttrue, if Vbus is high.
void ui_host_vbus_error ( void  )

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

void ui_host_wakeup_event ( void  )

Notify that a USB device or the host has wake up the USB line.

void ui_init ( void  )

Initializes the user interface.

void ui_usb_mode_change ( bool  b_host_mode)

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

Parameters
b_host_modetrue, if the host mode has been selected