ui.c File Reference

User Interface.

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

#include <asf.h>

Macros
#define	RESUME_PIN   (GPIO_PUSH_BUTTON_2)
#define	RESUME_PIO   (PIN_PUSHBUTTON_2_PIO)
#define	RESUME_PIO_ATTR   (PIN_PUSHBUTTON_2_ATTR)
#define	RESUME_PIO_ID   (PIN_PUSHBUTTON_2_ID)
#define	RESUME_PIO_MASK   (PIN_PUSHBUTTON_2_MASK)
#define	RESUME_PMC_FSTT   (PMC_FSMR_FSTT14)

Functions
Internal routines to manage asynchronous interrupt pin change
This interrupt is connected to a switch and allows to wakeup CPU in low sleep mode. This wakeup the USB devices connected via a downstream resume.
static void	ui_enable_asynchronous_interrupt (void)
	Initializes and enables interrupt pin change. More...
static void	ui_disable_asynchronous_interrupt (void)
	Disables interrupt pin change. More...
static void	ui_wakeup_handler (uint32_t id, uint32_t mask)
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...
Callback to mange 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)

Host mode user interface functions
static uhc_enum_status_t	ui_enum_status = UHC_ENUM_DISCONNECT
static uint16_t	ui_device_speed_blink
static bool	ui_hid_mouse_plug = false
static bool	ui_msc_plug = false
static bool	ui_test_done
static bool	ui_test_result
static int8_t	ui_x
static int8_t	ui_y
static int8_t	ui_scroll
static uint8_t	ui_nb_down = 0
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_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_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_wakeup_event (void)
	Notify that a USB device or the host has wake up the USB line. More...
void	ui_usb_sof_event (void)
	Notify that a SOF has been sent (each 1 ms) More...
static void	ui_uhi_hid_mouse_btn (bool b_state)
void	ui_test_flag_reset (void)
	Resets the status flag of the test. More...
void	ui_test_finish (bool b_success)
	Displays the result of the test. More...

#define RESUME_PIN   (GPIO_PUSH_BUTTON_2)

Referenced by ui_init().

#define RESUME_PIO   (PIN_PUSHBUTTON_2_PIO)

Referenced by ui_init().

#define RESUME_PIO_ATTR   (PIN_PUSHBUTTON_2_ATTR)

Referenced by ui_init().

#define RESUME_PIO_ID   (PIN_PUSHBUTTON_2_ID)

Referenced by ui_init(), and ui_wakeup_handler().

#define RESUME_PIO_MASK   (PIN_PUSHBUTTON_2_MASK)

Referenced by ui_init(), and ui_wakeup_handler().

#define RESUME_PMC_FSTT   (PMC_FSMR_FSTT14)

Referenced by ui_init().

static void ui_disable_asynchronous_interrupt ( void  )

static

Disables interrupt pin change.

References GPIO_PUSH_BUTTON_2, pio_disable_pin_interrupt(), pio_get_interrupt_status(), and pmc_clr_fast_startup_input().

Referenced by ui_usb_wakeup_event(), and ui_wakeup_handler().

static void ui_enable_asynchronous_interrupt ( void  )

static

Initializes and enables interrupt pin change.

References GPIO_PUSH_BUTTON_2, pio_enable_pin_interrupt(), pio_get_interrupt_status(), and pmc_set_fast_startup_input().

Referenced by ui_usb_sof_event().

void ui_init

(

void

)

Initializes the user interface.

References LED0_GPIO, LED1_GPIO, LED2_GPIO, LED3_GPIO, LED_Off(), pio_configure_pin(), pio_enable_pin_interrupt(), pio_get_interrupt_status(), pio_handler_set(), pmc_enable_periph_clk(), pmc_set_fast_startup_input(), RESUME_PIN, RESUME_PIO, RESUME_PIO_ATTR, RESUME_PIO_ID, RESUME_PIO_MASK, RESUME_PMC_FSTT, and ui_wakeup_handler().

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 LED2_GPIO, 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().

static void ui_uhi_hid_mouse_btn ( bool  b_state )

static

References ui_nb_down.

Referenced by ui_uhi_hid_mouse_btn_left(), ui_uhi_hid_mouse_btn_middle(), and ui_uhi_hid_mouse_btn_right().

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, and UNUSED.

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

References ui_scroll, ui_x, and ui_y.

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, and UNUSED.

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_GPIO, LED1_GPIO, LED2_GPIO, LED3_GPIO, LED_Off(), LED_On(), UHC_ENUM_DISCONNECT, ui_enum_status, and UNUSED.

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 uhc_device_t::speed, UHC_ENUM_SUCCESS, UHD_SPEED_FULL, UHD_SPEED_HIGH, UHD_SPEED_LOW, ui_device_speed_blink, ui_enum_status, ui_test_done, and UNUSED.

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(), and UNUSED.

void ui_usb_sof_event

(

void

)

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

References gpio_pin_is_high, GPIO_PUSH_BUTTON_1, LED0_GPIO, LED1_GPIO, LED2_GPIO, LED3_GPIO, LED_Off(), LED_On(), LED_Toggle, UHC_ENUM_SUCCESS, uhc_suspend(), ui_device_speed_blink, ui_enable_asynchronous_interrupt(), ui_enum_status, ui_hid_mouse_plug, ui_msc_plug, ui_nb_down, ui_scroll, ui_test_done, ui_test_result, ui_x, and ui_y.

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

static void ui_wakeup_handler ( uint32_t  id, uint32_t  mask  )

static

References RESUME_PIO_ID, RESUME_PIO_MASK, uhc_is_suspend(), uhc_resume(), and ui_disable_asynchronous_interrupt().

Referenced by ui_init().

uint16_t ui_device_speed_blink

static

Blink frequency depending on device speed

Referenced by ui_usb_enum_event(), and ui_usb_sof_event().

uhc_enum_status_t ui_enum_status = UHC_ENUM_DISCONNECT

static

Status of device enumeration

Referenced by ui_usb_connection_event(), ui_usb_enum_event(), and ui_usb_sof_event().

bool ui_hid_mouse_plug = false

static

Notify the presence of a USB device mouse

Referenced by ui_uhi_hid_mouse_change(), and ui_usb_sof_event().

bool ui_msc_plug = false

static

Notify the presence of a USB device MSC

Referenced by ui_uhi_msc_change(), and ui_usb_sof_event().

uint8_t ui_nb_down = 0

static

Manages device mouse button down

Referenced by ui_uhi_hid_mouse_btn(), and ui_usb_sof_event().

int8_t ui_scroll

static

Referenced by ui_uhi_hid_mouse_move(), and ui_usb_sof_event().

bool ui_test_done

static

Status of the MSC test

Referenced by ui_test_finish(), ui_test_flag_reset(), ui_usb_enum_event(), and ui_usb_sof_event().

bool ui_test_result

static

Result of the MSC test

Referenced by ui_test_finish(), and ui_usb_sof_event().

int8_t ui_x

static

Manages device mouse moving

Referenced by ui_uhi_hid_mouse_move(), and ui_usb_sof_event().

int8_t ui_y

static

Referenced by ui_uhi_hid_mouse_move(), and ui_usb_sof_event().