Microchip® Advanced Software Framework

common/services/usb/class/composite/device/example4/main.h File Reference

Declaration of main function used by Composite example 4.

Copyright (c) 2011-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)
 Opens the communication port This is called by CDC interface when USB Host enable it. 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_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_resume_action (void)
 Turn on a led to notify active mode Called when the USB line is resumed from the suspend state. More...
 
void main_sof_action (void)
 Manages the leds behaviors Called when a start of frame is received on USB line each 1ms. 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)

Opens the communication port This is called by CDC interface when USB Host enable it.

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, header, 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_MSC_STRING_ID, USB_DT_STRING, usb_setup_req_t::wLength, and usb_setup_req_t::wValue.

void main_msc_disable ( void  )

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

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.

void main_sof_action ( void  )

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.

void main_suspend_action ( void  )

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

void memories_initialization ( void  )

Initialize the memories used by examples.