Microchip® Advanced Software Framework

composite/device/example4/ui.h File Reference

Common User Interface for USB application.

Copyright (c) 2011-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_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...
 
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.

Referenced by main_cdc_set_dtr().

void ui_com_error ( void  )

Called when a communication error occur.

void ui_com_open ( uint8_t  port)

Called when communication port is opened.

Referenced by main_cdc_set_dtr().

void ui_com_overflow ( void  )

Called when a overflow occur.

Referenced by usart_rx_callback().

void ui_com_rx_start ( void  )

Called when a data is received on CDC.

Referenced by uart_rx_notify(), and usart_tx_callback().

void ui_com_rx_stop ( void  )

Called when all data pending are sent on port com.

Referenced by usart_tx_callback().

void ui_com_tx_start ( void  )

Called when a data is received on port com.

Referenced by usart_rx_callback().

void ui_com_tx_stop ( void  )

Called when all data pending are sent on CDC.

Referenced by usart_rx_callback().

void ui_init ( void  )

Initializes the user interface.

void ui_powerdown ( void  )

Enters the user interface in power down mode.

Referenced by main(), main_hid_set_feature(), main_suspend_action(), and main_suspend_lpm_action().

void ui_process ( uint16_t  framenumber)

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

Parameters
framenumberCurrent frame number

Referenced by main(), and 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().