USB CDC Interface Functions

Functions
uint8_t	sd_cdc_transmit (uint8_t *buf, uint16_t len)
	USB Communications Class Device Transmit Data send over USB IN endpoint are sent over CDC interface through this function. More...
uint8_t	sd_cdc_get_state (void)
static int8_t	sd_cdc_init (void)
	CDC_Init_FS Initializes the CDC media low layer over the FS USB IP. More...
static int8_t	sd_cdc_deinit (void)
	CDC_DeInit_FS DeInitializes the CDC media low layer. More...
static int8_t	sd_cdc_control (uint8_t cmd, uint8_t *pbuf, uint16_t length)
	USB Communications Class Device Control Request Manage the CDC class requests. More...
static int8_t	sd_cdc_receive (uint8_t *buf, uint32_t *len)
	USB Communications Class Device Receive Data received over USB OUT endpoint are sent over CDC interface through this function. More...

Detailed Description

Function Documentation

sd_cdc_control()

static int8_t sd_cdc_control ( uint8_t  cmd, uint8_t *  pbuf, uint16_t  length  )

static

#include <Src/sd_usbd_cdc_if.c>

USB Communications Class Device Control Request 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

USBD_OK

if all operations are successful else USBD_FAIL or USBD_BUSY

{ 
    switch (cmd) {
    case CDC_SEND_ENCAPSULATED_COMMAND:
 
        break;

    case CDC_GET_ENCAPSULATED_RESPONSE:
 
        break;

    case CDC_SET_COMM_FEATURE:
 
        break;

    case CDC_GET_COMM_FEATURE:

        break;

    case CDC_CLEAR_COMM_FEATURE:

        break;

/********************************************************************************/
/* Line Coding Structure                            */
/*------------------------------------------------------------------------------*/
/* Offset | Field       | Size | Value  | Description               */
/* 0      | dwDTERate   |   4  | Number |Data terminal rate, in bits per second */
/* 4      | bCharFormat |   1  | Number | Stop bits             */
/*                  0 - 1 Stop bit              */
/*                  1 - 1.5 Stop bits           */
/*                  2 - 2 Stop bits             */
/* 5      | bParityType |  1   | Number | Parity                */
/*                  0 - None                */
/*                  1 - Odd                 */
/*                  2 - Even                */
/*                  3 - Mark                */
/*                  4 - Space               */
/* 6      | bDataBits  |   1   | Number Data bits (5, 6, 7, 8 or 16).       */
/********************************************************************************/
    case CDC_SET_LINE_CODING:   
    
        break;

    case CDC_GET_LINE_CODING:     

        break;

    case CDC_SET_CONTROL_LINE_STATE:

        break;

    case CDC_SEND_BREAK:
 
        break;    
    
    default:
        break;
    }     

    return (USBD_OK);

sd_cdc_deinit()

static int8_t sd_cdc_deinit ( void  )

static

#include <Src/sd_usbd_cdc_if.c>

CDC_DeInit_FS DeInitializes the CDC media low layer.

Parameters

None

Return values

USBD_OK

if all operations are successful else USBD_FAIL or USBD_BUSY

{
    hUsbDevice_0 = NULL;
    return (USBD_OK);

sd_cdc_init()

static int8_t sd_cdc_init ( void  )

static

#include <Src/sd_usbd_cdc_if.c>

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

Parameters

None

Return values

USBD_OK

if all operations are successful else USBD_FAIL or USBD_BUSY

{
    hUsbDevice_0 = &hUsbDeviceFS;
    
    /* Set Application Buffers */
    USBD_CDC_SetTxBuffer(hUsbDevice_0, UserTxBufferFS, 0);
    USBD_CDC_SetRxBuffer(hUsbDevice_0, UserRxBufferFS);
  
    USBD_CDC_ReceivePacket(hUsbDevice_0);

    return (USBD_OK);

sd_cdc_receive()

static int8_t sd_cdc_receive ( uint8_t *  buf, uint32_t *  len  )

static

#include <Src/sd_usbd_cdc_if.c>

USB Communications Class Device Receive 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 until 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

USBD_OK

if all operations are successful else USBD_FAIL or USBD_BUSY

{
    uint8_t result;

    HAL_UART_Transmit((&uart1_dev)->uart, buf, *len, 1000); /* Bridge to UART */
    result = USBD_CDC_ReceivePacket(hUsbDevice_0);
  
    return result;

sd_cdc_transmit()

uint8_t sd_cdc_transmit	(	uint8_t *	buf,
		uint16_t	len
	)

#include <Src/sd_usbd_cdc_if.c>

USB Communications Class Device Transmit Data send over USB IN endpoint are sent over CDC interface through this function.

Parameters

buf	Buffer of data to be send
len	Number of data to be send (in bytes)

Return values

USBD_OK

if all operations are successful else USBD_FAIL or USBD_BUSY

{
    uint8_t result = USBD_OK;
    
    if (hUsbDevice_0 == NULL) 
        return USBD_FAIL;
  
    USBD_CDC_SetTxBuffer(hUsbDevice_0, buf, len);   
    result = USBD_CDC_TransmitPacket(hUsbDevice_0);
    
    return result;