ui.c File Reference

User Interface.

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

#include <asf.h>
#include "conf_board.h"
#include "conf_usb_host.h"
#include "conf_usb.h"

Macros
#define	RESUME_PIN   (GPIO_PUSH_BUTTON_1)
#define	RESUME_PIO   (PIN_PUSHBUTTON_1_PIO)
#define	RESUME_PIO_ATTR   (PIN_PUSHBUTTON_1_ATTR)
#define	RESUME_PIO_ID   (PIN_PUSHBUTTON_1_ID)
#define	RESUME_PIO_MASK   (PIN_PUSHBUTTON_1_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. In USB device mode, this wakeup the USB host via a upstream resume. In USB host 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...

Variables
static bool	ui_b_host_mode = false

Host mode user interface functions
static uhc_enum_status_t	ui_host_enum_status = UHC_ENUM_DISCONNECT
static int8_t	ui_host_x
static int8_t	ui_host_y
static int8_t	ui_host_scroll
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_enum_event (uhc_device_t *dev, uhc_enum_status_t status)
	Notify the end of a USB device enumeration. 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...
static void	ui_host_hid_mouse_btn (bool b_state)
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
#define	MOUSE_MOVE_RANGE   3
static bool	ui_device_b_mouse_enable = false
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...

#define MOUSE_MOVE_RANGE   3

Referenced by ui_device_sof_action().

#define RESUME_PIN   (GPIO_PUSH_BUTTON_1)

Referenced by ui_disable_asynchronous_interrupt(), ui_enable_asynchronous_interrupt(), and ui_init().

#define RESUME_PIO   (PIN_PUSHBUTTON_1_PIO)

Referenced by ui_disable_asynchronous_interrupt(), ui_enable_asynchronous_interrupt(), and ui_init().

#define RESUME_PIO_ATTR   (PIN_PUSHBUTTON_1_ATTR)

Referenced by ui_init().

#define RESUME_PIO_ID   (PIN_PUSHBUTTON_1_ID)

Referenced by ui_init(), and ui_wakeup_handler().

#define RESUME_PIO_MASK   (PIN_PUSHBUTTON_1_MASK)

Referenced by ui_init(), and ui_wakeup_handler().

#define RESUME_PMC_FSTT   (PMC_FSMR_FSTT14)

Referenced by ui_disable_asynchronous_interrupt(), and ui_enable_asynchronous_interrupt().

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.

References LED_On.

void ui_device_sof_action

(

void

)

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

References gpio_pin_is_high, GPIO_PUSH_BUTTON_1, LED_Off, LED_On, MOUSE_MOVE_RANGE, udd_get_frame_number(), udi_hid_mouse_moveX(), 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().

static void ui_disable_asynchronous_interrupt ( void  )

static

Disables interrupt pin change.

References pio_disable_pin_interrupt(), pio_get_interrupt_status(), pmc_clr_fast_startup_input(), RESUME_PIN, RESUME_PIO, and RESUME_PMC_FSTT.

Referenced by ui_device_remotewakeup_disable(), ui_host_wakeup_event(), and ui_wakeup_handler().

static void ui_enable_asynchronous_interrupt ( void  )

static

Initializes and enables interrupt pin change.

References pio_enable_pin_interrupt(), pio_get_interrupt_status(), pmc_set_fast_startup_input(), RESUME_PIN, RESUME_PIO, and RESUME_PMC_FSTT.

Referenced by ui_device_remotewakeup_enable(), and ui_host_sof_event().

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 LED_Off, LED_On, UHC_ENUM_DISCONNECT, and ui_host_enum_status.

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 UHC_ENUM_SUCCESS, ui_host_enum_status, ui_host_scroll, ui_host_x, and ui_host_y.

static void ui_host_hid_mouse_btn ( bool  b_state )

static

References LED_Off, and LED_On.

Referenced by ui_host_hid_mouse_btn_left(), ui_host_hid_mouse_btn_middle(), and ui_host_hid_mouse_btn_right().

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 ui_host_scroll, ui_host_x, and ui_host_y.

void ui_host_sof_event

(

void

)

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

References gpio_pin_is_high, GPIO_PUSH_BUTTON_1, LED_Off, LED_On, LED_Toggle, UHC_ENUM_SUCCESS, uhc_suspend(), ui_enable_asynchronous_interrupt(), ui_host_enum_status, ui_host_scroll, ui_host_x, and ui_host_y.

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 LED_Off, pio_configure_pin(), pio_handler_set(), pmc_enable_periph_clk(), RESUME_PIN, RESUME_PIO, RESUME_PIO_ATTR, RESUME_PIO_ID, RESUME_PIO_MASK, and ui_wakeup_handler().

Referenced by main(), ui_device_suspend_action(), and ui_usb_mode_change().

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 LED_Off, LED_On, ui_b_host_mode, and ui_init().

static void ui_wakeup_handler ( uint32_t  id, uint32_t  mask  )

static

References pmc_wait_wakeup_clocks_restore(), RESUME_PIO_ID, RESUME_PIO_MASK, udc_remotewakeup(), uhc_is_suspend(), uhc_resume(), ui_b_host_mode, and ui_disable_asynchronous_interrupt().

Referenced by ui_init().

bool ui_b_host_mode = false

static

Current USB mode

Referenced by ui_usb_mode_change(), and ui_wakeup_handler().

bool ui_device_b_mouse_enable = false

static

Referenced by ui_device_mouse_disable(), ui_device_mouse_enable(), and ui_device_sof_action().

uhc_enum_status_t ui_host_enum_status = UHC_ENUM_DISCONNECT

static

Status of device enumeration

Referenced by ui_host_connection_event(), ui_host_enum_event(), and ui_host_sof_event().

int8_t ui_host_scroll

static

Referenced by ui_host_enum_event(), ui_host_hid_mouse_move(), and ui_host_sof_event().

int8_t ui_host_x

static

Manages device mouse moving

Referenced by ui_host_enum_event(), ui_host_hid_mouse_move(), and ui_host_sof_event().

int8_t ui_host_y

static

Referenced by ui_host_enum_event(), ui_host_hid_mouse_move(), and ui_host_sof_event().