ui.h File Reference

Common User Interface for USB application.

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

Functions
void	ui_com_close (uint8_t port)
	Called when communication port is closed. More...
void	ui_com_error (void)
	Called when a communication error occur. More...
void	ui_com_open (uint8_t port)
	Called when communication port is opened. More...
void	ui_com_overflow (void)
	Called when a overflow occur. More...
void	ui_com_rx_start (void)
	Called when a data is received on CDC. More...
void	ui_com_rx_stop (void)
	Called when all data pending are sent on port com. More...
void	ui_com_tx_start (void)
	Called when a data is received on port com. More...
void	ui_com_tx_stop (void)
	Called when all data pending are sent on CDC. More...
void	ui_init (void)
	Initializes the user interface. More...
void	ui_kbd_led (uint8_t value)
	Turn on or off the keyboard LEDs. More...
void	ui_powerdown (void)
	Enters the user interface in power down mode. More...
void	ui_process (uint16_t framenumber)
	This process is called each 1ms It is called only if the USB interface is enabled. More...
void	ui_wakeup (void)
	Exits the user interface of power down mode. More...
void	ui_wakeup_disable (void)
	Disables the asynchronous interrupts of the user interface. More...
void	ui_wakeup_enable (void)
	Enables the asynchronous interrupts of the user interface. More...
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_com_close

(

uint8_t

port

)

Called when communication port is closed.

References UNUSED.

Referenced by main_cdc_set_dtr().

void ui_com_error

(

void

)

Called when a communication error occur.

Referenced by ISR().

void ui_com_open

(

uint8_t

port

)

Called when communication port is opened.

References UNUSED.

Referenced by main_cdc_set_dtr().

void ui_com_overflow

(

void

)

Called when a overflow occur.

Referenced by ISR().

void ui_com_rx_start

(

void

)

Called when a data is received on CDC.

Referenced by ISR().

void ui_com_rx_stop

(

void

)

Called when all data pending are sent on port com.

Referenced by ISR().

void ui_com_tx_start

(

void

)

Called when a data is received on port com.

Referenced by ISR().

void ui_com_tx_stop

(

void

)

Called when all data pending are sent on CDC.

Referenced by ISR().

void ui_init

(

void

)

Initializes the user interface.

References LED_Off, pio_handler_set(), ui_wakeup_handler(), WAKEUP_PIO, WAKEUP_PIO_ATTR, WAKEUP_PIO_ID, and WAKEUP_PIO_MASK.

Referenced by main().

void ui_kbd_led

(

uint8_t

value

)

Turn on or off the keyboard LEDs.

References UNUSED.

void ui_powerdown

(

void

)

Enters the user interface in power down mode.

References LED_Off.

Referenced by main(), and main_suspend_action().

void ui_process

(

uint16_t

framenumber

)

This process is called each 1ms It is called only if the USB interface is enabled.

Parameters

framenumber

Current frame number

References b_down, b_modifier, GPIO_PUSH_BUTTON_1, ioport_get_pin_level(), LED_Off, LED_On, MOUSE_MOVE_RANGE, SEQUENCE_PERIOD, u8_value, udi_hid_kbd_down(), udi_hid_kbd_modifier_down(), udi_hid_kbd_modifier_up(), udi_hid_kbd_up(), udi_hid_mouse_moveY(), and ui_sequence.

Referenced by main_sof_action().

void ui_start_read

(

void

)

void ui_start_write

(

void

)

void ui_stop_read

(

void

)

void ui_stop_write

(

void

)

void ui_wakeup

(

void

)

Exits the user interface of power down mode.

Referenced by main_resume_action().

void ui_wakeup_disable

(

void

)

Disables the asynchronous interrupts of the user interface.

References pio_disable_pin_interrupt(), pmc_clr_fast_startup_input(), WAKEUP_PIN, and WAKEUP_PMC_FSTT.

Referenced by main_remotewakeup_disable().

void ui_wakeup_enable

(

void

)

Enables the asynchronous interrupts of the user interface.

References pio_configure_pin(), pio_enable_pin_interrupt(), pmc_set_fast_startup_input(), WAKEUP_PIN, WAKEUP_PIO_ATTR, and WAKEUP_PMC_FSTT.

Referenced by main_remotewakeup_enable().