Microchip® Advanced Software Framework

hid/device/kbd/unit_tests/unit_tests.h File Reference

Declaration of main function used by HID keyboard unit test.

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

Functions

void main_keyboard_disable (void)
 Called by HID interface Callback running when USB Host disable keyboard interface. More...
 
bool main_keyboard_enable (void)
 Called by HID interface Callback running when USB Host enable keyboard interface. More...
 
void main_keyboard_led (uint8_t value)
 Called by HID interface Callback running when USB Host change keyboard leds. More...
 
void main_remotewakeup_disable (void)
 Called by UDC when USB Host request to disable remote wakeup. More...
 
void main_remotewakeup_enable (void)
 Called by UDC when USB Host request to enable remote wakeup. More...
 
void main_resume_action (void)
 Called by UDD when the USB line exit of suspend state. More...
 
void main_sof_action (void)
 Called when a start of frame is received on USB line. More...
 
void main_suspend_action (void)
 Enters the application in low power mode Callback called when USB host sets USB line in suspend state. More...
 
void main_vbus_action (bool b_high)
 Called when Vbus line state change. More...
 

void main_keyboard_disable ( void  )

Called by HID interface Callback running when USB Host disable keyboard interface.

References main_b_keyboard_enable.

bool main_keyboard_enable ( void  )

Called by HID interface Callback running when USB Host enable keyboard interface.

Return values
trueif keyboard startup is ok

References main_b_keyboard_enable, and main_b_keyboard_enumerated.

void main_keyboard_led ( uint8_t  value)

Called by HID interface Callback running when USB Host change keyboard leds.

References main_b_keyboard_led, and UNUSED.

void main_remotewakeup_disable ( void  )

Called by UDC when USB Host request to disable remote wakeup.

Called by UDC when USB Host request to disable remote wakeup.

This is called by the USB stack when the host requests remote wake-up to be disabled, and will request the user interface to disable wake-up.

References ui_wakeup_disable().

void main_remotewakeup_enable ( void  )

Called by UDC when USB Host request to enable remote wakeup.

Called by UDC when USB Host request to enable remote wakeup.

This is called by the USB stack when the host requests remote wake-up to be enabled, and will request the user interface to enable wake-up.

References ui_wakeup_enable().

void main_resume_action ( void  )

Called by UDD when the USB line exit of suspend state.

Turn on a led to notify active mode Called when the USB line is resumed from the suspend state.

Turn on a led to notify active mode Called when the USB line is resumed from the suspend state.

Called by UDD when the USB line exit of suspend state.

Called by USB stack when the bus resumes from suspend.

References main_b_suspend_event, and ui_wakeup().

void main_sof_action ( void  )

Called when a start of frame is received on USB line.

Manages the leds behaviors Called when a start of frame is received on USB line each 1ms.

Manages the leds behaviors Called when a start of frame is received on USB line each 1ms.

Called when a start of frame is received on USB line.

Called by USB stack when a start of frame is received, i.e., every millisecond during normal operation. This function triggers processing of the user interface if the HID interface has been enabled.

References main_b_cdc_enable, main_b_generic_enable, main_b_kbd_enable, main_b_keyboard_enable, main_b_mouse_enable, main_b_msc_enable, main_b_mtouch_enable, main_b_phdc_enable, main_b_sof_event, main_b_vendor_enable, udd_get_frame_number(), and ui_process().

void main_suspend_action ( void  )

Enters the application in low power mode Callback called when USB host sets USB line in suspend state.

Called by UDD when a suspend is received Callback running when USB Host set USB line in suspend state.

Turn off all leds Callback running when USB Host set USB line in suspend state.

Called by UDD when a suspend is received Callback running when USB Host set USB line in suspend state.

Turn off all leds Callback running when USB Host set USB line in suspend state.

Enters the application in low power mode Callback called when USB host sets USB line in suspend state.

Called by USB stack when host suspends the bus.

References main_b_resume_event, and ui_powerdown().

void main_vbus_action ( bool  b_high)

Called when Vbus line state change.

References main_b_vbus_event.

Referenced by main(), run_usb_cdc_test(), run_usb_keyboard_test(), run_usb_mouse_test(), and run_usb_msc_test().