Microchip® Advanced Software Framework

vendor/device/example/ui.h File Reference

Common User Interface for USB vendor class application.

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

Functions

void ui_init (void)
 Initializes the user interface. More...
 
void ui_loop_back_state (bool b_started)
 Notify the state of loopback It is called when a the loopback is started and stopped. 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_init ( void  )

Initializes the user interface.

Referenced by main().

void ui_loop_back_state ( bool  b_started)

Notify the state of loopback It is called when a the loopback is started and stopped.

Parameters
b_startedloopback started if true, else stopped

Referenced by main_setup_in_received(), main_setup_out_received(), main_vendor_bulk_in_received(), main_vendor_bulk_out_received(), main_vendor_int_in_received(), main_vendor_int_out_received(), main_vendor_iso_in_received(), and main_vendor_iso_out_received().

void ui_powerdown ( void  )

Enters the user interface in power down mode.

Referenced by main(), main_hid_set_feature(), 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
framenumberCurrent frame number

Referenced by main(), and main_sof_action().

void ui_wakeup ( void  )

Exits the user interface of power down mode.

Referenced by main_resume_action().