Damian Gabino / picoGW_mcu
Embed: (wiki syntax)

« Back to documentation index

USBD_CDC

usbd core module More...

Modules

 USBD_CDC_Private_TypesDefinitions
 USBD_CDC_Private_Defines
 USBD_CDC_Private_Macros
 USBD_CDC_Private_FunctionPrototypes
 USBD_CDC_Private_Variables
 USBD_CDC_Private_Functions
 USBD_CDC_IF_Exported_Variables

Functions

uint8_t CDC_Transmit_FS (uint8_t *Buf, uint16_t Len)
 CDC_Transmit_FS Data send over USB IN endpoint are sent over CDC interface through this function.
static int8_t CDC_Init_FS (void)
 CDC_Init_FS Initializes the CDC media low layer over the FS USB IP.
static int8_t CDC_DeInit_FS (void)
 CDC_DeInit_FS DeInitializes the CDC media low layer.
static int8_t CDC_Control_FS (uint8_t cmd, uint8_t *pbuf, uint16_t length)
 CDC_Control_FS Manage the CDC class requests.
static int8_t CDC_Receive_FS (uint8_t *Buf, uint32_t *Len)
 CDC_Receive_FS Data received over USB OUT endpoint are sent over CDC interface through this function.

Detailed Description

usbd core module


Function Documentation

static int8_t CDC_Control_FS ( uint8_t  cmd,
uint8_t *  pbuf,
uint16_t  length 
) [static]

CDC_Control_FS Manage the CDC class requests.

Parameters:
cmd,:Command code
pbuf,:Buffer containing command data (request parameters)
length,:Number of data to be sent (in bytes)
Return values:
Resultof the operation: USBD_OK if all operations are OK else USBD_FAIL

Definition at line 169 of file usbd_cdc_if.cpp.

static int8_t CDC_DeInit_FS ( void   ) [static]

CDC_DeInit_FS DeInitializes the CDC media low layer.

Parameters:
None
Return values:
Resultof the operation: USBD_OK if all operations are OK else USBD_FAIL

Definition at line 154 of file usbd_cdc_if.cpp.

static int8_t CDC_Init_FS ( void   ) [static]

CDC_Init_FS Initializes the CDC media low layer over the FS USB IP.

Parameters:
None
Return values:
Resultof the operation: USBD_OK if all operations are OK else USBD_FAIL

Definition at line 138 of file usbd_cdc_if.cpp.

static int8_t CDC_Receive_FS ( uint8_t *  Buf,
uint32_t *  Len 
) [static]

CDC_Receive_FS Data received over USB OUT endpoint are sent over CDC interface through this function.

Note:
This function will block any OUT packet reception on USB endpoint untill exiting this function. If you exit this function before transfer is complete on CDC interface (ie. using DMA controller) it will result in receiving more data while previous ones are still not sent.
Parameters:
Buf,:Buffer of data to be received
Len,:Number of data received (in bytes)
Return values:
Resultof the operation: USBD_OK if all operations are OK else USBD_FAIL

Definition at line 250 of file usbd_cdc_if.cpp.

uint8_t CDC_Transmit_FS ( uint8_t *  Buf,
uint16_t  Len 
)

CDC_Transmit_FS Data send over USB IN endpoint are sent over CDC interface through this function.

Note:
Parameters:
Buf,:Buffer of data to be send
Len,:Number of data to be send (in bytes)
Return values:
Resultof the operation: USBD_OK if all operations are OK else USBD_FAIL or USBD_BUSY

Definition at line 270 of file usbd_cdc_if.cpp.