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_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_cdc_disable

(

uint8_t

port

)

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

References main_b_cdc_enable, and uart_close().

bool main_cdc_enable

(

uint8_t

port

)

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

Return values

true	if cdc startup is successfully done

References main_b_cdc_enable, and uart_open().

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.

References ui_com_close(), and ui_com_open().

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.

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

)

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.

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.

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.