USBD_CDC_IF_Private_FunctionPrototypes

Private functions declaration. More...

Collaboration diagram for USBD_CDC_IF_Private_FunctionPrototypes:

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

Detailed Description

Private functions declaration.

Function Documentation

CDC_Init_FS()

static int8_t CDC_Init_FS ( void  )

static

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

Return values

USBD_OK

if all operations are OK else USBD_FAIL

                                {
    /* USER CODE BEGIN 3 */
    /* Set Application Buffers */
    USBD_CDC_SetTxBuffer(&hUsbDeviceFS, UserTxBufferFS, 0);
    USBD_CDC_SetRxBuffer(&hUsbDeviceFS, UserRxBufferFS);
    usbd_cdc_initialized = 1;
    return (USBD_OK);
    /* USER CODE END 3 */
}

Here is the call graph for this function:

CDC_DeInit_FS()

static int8_t CDC_DeInit_FS ( void  )

static

DeInitializes the CDC media low layer.

Return values

USBD_OK

if all operations are OK else USBD_FAIL

                                  {
    /* USER CODE BEGIN 4 */
    usbd_cdc_initialized = 0;
    return (USBD_OK);
    /* USER CODE END 4 */
}

CDC_Control_FS()

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

static

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

Result

of the operation: USBD_OK if all operations are OK else USBD_FAIL

                                                                          {
    /* USER CODE BEGIN 5 */
    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:
        pbuf[0] = 0x20; // bits/second 115200
        pbuf[1] = 0xc2;
        pbuf[2] = 0x01;
        pbuf[3] = 0x00;
        pbuf[4] = 0x00; // 1 stop bit
        pbuf[5] = 0x00; // parity none
        pbuf[6] = 0x08; // 8 data bits
        break;
 
    case CDC_SET_CONTROL_LINE_STATE:
        usbd_cdc_initialized = 1; //hack, we need enable usbd_cdc on reconnect
        break;
 
    case CDC_SEND_BREAK:
        break;
 
    default:
        break;
    }
 
    return (USBD_OK);
    /* USER CODE END 5 */
}

CDC_Receive_FS()

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

static

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

Result

of the operation: USBD_OK if all operations are OK else USBD_FAIL

                                                          {
    /* USER CODE BEGIN 6 */
    app_cdc_rx(Buf, *Len);
    USBD_CDC_SetRxBuffer(&hUsbDeviceFS, &Buf[0]);
    USBD_CDC_ReceivePacket(&hUsbDeviceFS);
    return (USBD_OK);
    /* USER CODE END 6 */
}

Here is the call graph for this function: