Common User Interface for application.

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

References ui_device_b_mouse_enable.

bool ui_device_mouse_enable ( void )

Enables the device mouse interface.

References ui_device_b_mouse_enable.

void ui_device_remotewakeup_disable ( void )

Disables the remotewakeup feature.

References ui_disable_asynchronous_interrupt().

void ui_device_remotewakeup_enable ( void )

Enables the remotewakeup feature.

References ui_enable_asynchronous_interrupt().

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.

References GPIO_PUSH_BUTTON_0, ioport_get_pin_level(), LED0, LED_Off, LED_On, MOUSE_MOVE_COUNT, MOUSE_MOVE_RANGE, MOVE_DOWN, MOVE_LEFT, MOVE_RIGHT, MOVE_UP, udd_get_frame_number(), udi_hid_mouse_moveX(), udi_hid_mouse_moveY(), and ui_device_b_mouse_enable.

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.

References ui_init().

void ui_host_connection_event	(	uhc_device_t *	dev,
		bool	b_present
	)

Notify that a USB device has been connected or disconnected.

Parameters

dev	Pointer on USB device information
b_present	true, if the device has been connected

References bm_mouse_pointer_ctrl(), LED0, LED_On, ui_enum_status, and UNUSED.

void ui_host_enum_event	(	uhc_device_t *	dev,
		uhc_enum_status_t	status
	)

Notify the end of a USB device enumeration.

Parameters

dev	Pointer on USB device information
status	Status of the USB enumeration

References bm_mouse_pointer_ctrl(), bm_x, bm_y, UHD_SPEED_FULL, UHD_SPEED_HIGH, UHD_SPEED_LOW, ui_device_speed_blink, and ui_enum_status.

void ui_host_hid_mouse_btn_left ( bool b_state )

References ui_host_hid_mouse_btn().

void ui_host_hid_mouse_btn_middle ( bool b_state )

References ui_host_hid_mouse_btn().

void ui_host_hid_mouse_btn_right ( bool b_state )

References ui_host_hid_mouse_btn().

void ui_host_hid_mouse_move	(	int8_t	x,
		int8_t	y,
		int8_t	scroll
	)

References bm_x, bm_y, Max, Min, and UNUSED.

void ui_host_sof_event ( void )

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

References bm_mouse_pointer_move(), bm_x, bm_y, GPIO_PUSH_BUTTON_0, ioport_get_pin_level(), LED0, LED_Off, LED_On, LED_Toggle, uhc_suspend(), ui_device_speed_blink, ui_enable_asynchronous_interrupt(), ui_enum_status, and ui_nb_down.

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_present true, if Vbus is high.

References UNUSED.

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.

References ui_disable_asynchronous_interrupt().

void ui_init ( void )

Initializes the user interface.

References bm_init(), bm_mouse_pointer_ctrl(), LED0, and LED_Off.

Referenced by main(), and ui_device_suspend_action().

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_mode true, if the host mode has been selected

References LED0, LED_Off, LED_On, and ui_b_host_mode.

Microchip® Advanced Software Framework

Functions