Microchip® Advanced Software Framework

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

Main functions.

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)
 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...
 
void main_remotewakeup_lpm_disable (void)
 Called by UDC when USB Host request to disable LPM remote wakeup. More...
 
void main_remotewakeup_lpm_enable (void)
 Called by UDC when USB Host request to enable LPM remote wakeup. 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 main_suspend_lpm_action (void)
 Enters the application in low power mode Callback called when USB host sets LPM suspend state. 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.

void main_remotewakeup_lpm_disable ( void  )

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

void main_remotewakeup_lpm_enable ( void  )

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

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

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