Microchip® Advanced Software Framework

common/services/usb/class/cdc/device/example/ui.h File Reference

Common User Interface for CDC 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_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...
 

void ui_com_close ( uint8_t  port)

Called when communication port is closed.

void ui_com_error ( void  )

Called when a communication error occur.

void ui_com_open ( uint8_t  port)

Called when communication port is opened.

void ui_com_overflow ( void  )

Called when a overflow occur.

void ui_com_rx_start ( void  )

Called when a data is received on CDC.

void ui_com_rx_stop ( void  )

Called when all data pending are sent on port com.

void ui_com_tx_start ( void  )

Called when a data is received on port com.

void ui_com_tx_stop ( void  )

Called when all data pending are sent on CDC.

void ui_init ( void  )

Initializes the user interface.

void ui_powerdown ( void  )

Enters the user interface in power down mode.

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
void ui_wakeup ( void  )

Exits the user interface of power down mode.

void ui_wakeup_disable ( void  )

Disables the asynchronous interrupts of the user interface.

void ui_wakeup_enable ( void  )

Enables the asynchronous interrupts of the user interface.