Common User Interface for USB host composite application.

#include "uhc.h"

Functions
void	ui_init (void)
	Initializes the user interface. More...

void	ui_test_finish (bool b_success)
	Displays the result of the test. More...

void	ui_test_flag_reset (void)
	Resets the status flag of the test. More...

void	ui_uhi_hid_mouse_change (uhc_device_t *dev, bool b_plug)
	Notify that a USB device HID has been connected or disconnected. More...

void	ui_uhi_msc_change (uhc_device_t *dev, bool b_plug)
	Notify that a USB device MSC has been connected or disconnected. More...

void	ui_usb_connection_event (uhc_device_t *dev, bool b_present)
	Notify that a USB device has been connected or disconnected. More...

void	ui_usb_enum_event (uhc_device_t *dev, uhc_enum_status_t status)
	Notify the end of a USB device enumeration. 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...

void	ui_usb_sof_event (void)
	Notify that a SOF has been sent (each 1 ms) More...

void	ui_usb_vbus_change (bool b_vbus_present)
	Notify that a Vbus are changed Available only in USB hardware with Vbus monitoring. More...

void	ui_usb_vbus_error (void)
	Notify that a Vbus error has occurred Available only in USB hardware with Vbus monitoring. More...

void	ui_usb_wakeup_event (void)
	Notify that a USB device or the host has wake up the USB line. More...

Callback to manage the HID mouse events
void	ui_uhi_hid_mouse_btn_left (bool b_state)

void	ui_uhi_hid_mouse_btn_right (bool b_state)

void	ui_uhi_hid_mouse_btn_middle (bool b_state)

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

Callback to show the MSC read and write access
void	ui_start_read (void)

void	ui_stop_read (void)

void	ui_start_write (void)

void	ui_stop_write (void)

void ui_init ( void )

Initializes the user interface.

References LED0, LED1, LED2, LED3, and LED_Off().

Referenced by main(), and ui_usb_mode_change().

void ui_start_read ( void )

void ui_start_write ( void )

void ui_stop_read ( void )

void ui_stop_write ( void )

void ui_test_finish ( bool b_success )

Displays the result of the test.

Parameters

b_success true, if the test is successful

References LED3, LED_On(), ui_test_done, and ui_test_result.

Referenced by main().

void ui_test_flag_reset ( void )

Resets the status flag of the test.

References ui_test_done.

Referenced by main().

void ui_uhi_hid_mouse_btn_left ( bool b_state )

References ui_uhi_hid_mouse_btn().

void ui_uhi_hid_mouse_btn_middle ( bool b_state )

References ui_uhi_hid_mouse_btn().

void ui_uhi_hid_mouse_btn_right ( bool b_state )

References ui_uhi_hid_mouse_btn().

void ui_uhi_hid_mouse_change	(	uhc_device_t *	dev,
		bool	b_plug
	)

Notify that a USB device HID has been connected or disconnected.

Parameters

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

References ui_hid_mouse_plug.

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

void ui_uhi_msc_change	(	uhc_device_t *	dev,
		bool	b_plug
	)

Notify that a USB device MSC has been connected or disconnected.

Parameters

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

References ui_msc_plug.

void ui_usb_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 LED0, LED1, LED2, LED3, LED_Off(), LED_On(), and ui_enum_status.

Referenced by main_usb_connection_event().

void ui_usb_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 UHD_SPEED_FULL, UHD_SPEED_HIGH, UHD_SPEED_LOW, ui_device_speed_blink, ui_enum_status, and ui_test_done.

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 ui_init().

void ui_usb_sof_event ( void )

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

References is_joystick_pressed(), LED0, LED1, LED2, LED3, LED_Off(), LED_Toggle(), uhc_suspend(), ui_device_speed_blink, ui_enable_asynchronous_interrupt(), ui_enum_status, ui_hid_mouse_plug, ui_msc_plug, ui_test_done, and ui_test_result.

Referenced by main_usb_sof_event().

void ui_usb_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_usb_vbus_error ( void )

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

void ui_usb_wakeup_event ( void )

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

References ui_disable_asynchronous_interrupt().

Microchip® Advanced Software Framework

Functions