Microchip® Advanced Software Framework

services/usb/class/composite/device/example2/main.h File Reference

Declaration of main function used by Composite example 2.

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

#include "usb_protocol_cdc.h"

Functions

void main_cdc_disable (uint8_t port)
 Closes the communication port This is called by CDC interface when USB Host disable it. More...
 
bool main_cdc_enable (uint8_t port)
 Called by CDC interface Callback running when USB Host enable CDC interface. More...
 
void main_cdc_set_dtr (uint8_t port, bool b_enable)
 Save new DTR state to change led behavior. The DTR notify that the terminal have open or close the communication port. More...
 
bool main_extra_string (void)
 Called by UDC when USB Host request a extra string different of this specified in USB device descriptor. More...
 
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_mouse_disable (void)
 Called by HID interface Callback running when USB Host disable mouse interface. More...
 
bool main_mouse_enable (void)
 Called by HID interface Callback running when USB Host enable mouse interface. More...
 
void main_msc_disable (void)
 Called by MSC interface Callback running when USB Host disable MSC interface. More...
 
bool main_msc_enable (void)
 Called by MSC interface Callback running when USB Host enable MSC interface. 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 memories_initialization (void)
 Initialize the memories used by examples. More...
 

void main_cdc_disable ( uint8_t  port)

Closes the communication port This is called by CDC interface when USB Host disable it.

bool main_cdc_enable ( uint8_t  port)

Called by CDC interface Callback running when USB Host enable CDC interface.

Return values
trueif cdc startup is successfully done

Called by CDC interface Callback running when USB Host enable CDC interface.

Return values
trueif cdc startup is successfully done
void main_cdc_set_dtr ( uint8_t  port,
bool  b_enable 
)

Save new DTR state to change led behavior. The DTR notify that the terminal have open or close the communication port.

bool main_extra_string ( void  )

Called by UDC when USB Host request a extra string different of this specified in USB device descriptor.

Called by UDC when USB Host request a extra string different of this specified in USB device descriptor.

return true, if the string ID requested is know and managed by this functions

References cpu_to_le16, Max, udd_ctrl_request_t::payload, udd_ctrl_request_t::payload_size, udd_ctrl_request_t::req, UDC_DESC_STORAGE, udd_g_ctrlreq, UDI_CDC_IAD_STRING_ID, UDI_HID_KBD_STRING_ID, UDI_HID_MOUSE_STRING_ID, UDI_MSC_STRING_ID, USB_DT_STRING, usb_setup_req_t::wLength, and usb_setup_req_t::wValue.

void main_keyboard_disable ( void  )

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

bool main_keyboard_enable ( void  )

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

Return values
trueif keyboard startup is ok
void main_mouse_disable ( void  )

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

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

Called by the USB stack when the host disables the mouse interface.

bool main_mouse_enable ( void  )

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

Return values
trueif mouse startup is ok

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

Called by the USB stack when the host enables the mouse interface.

Return values
trueSignal that mouse started up OK
void main_msc_disable ( void  )

Called by MSC interface Callback running when USB Host disable MSC interface.

Called by MSC interface Callback running when USB Host disable MSC interface.

bool main_msc_enable ( void  )

Called by MSC interface Callback running when USB Host enable MSC interface.

Return values
trueif MSC startup is ok

Called by MSC interface Callback running when USB Host enable MSC interface.

Return values
trueif MSC startup is ok

Called by MSC interface Callback running when USB Host enable MSC interface.

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.

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.

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.

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.

void main_suspend_action ( void  )

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

Turn off all leds 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.

void memories_initialization ( void  )

Initialize the memories used by examples.