usbd_cdc_interface.c File Reference

Source file for USBD CDC interface. More...

#include "usbd_cdc_interface.h" #include "main.h"

Go to the source code of this file.

Macros
#define	APP_RX_DATA_SIZE   2048
#define	APP_TX_DATA_SIZE   2048

Functions
static int8_t	CDC_Itf_Init (void)
	CDC_Itf_Init Initializes the CDC media low layer. More...
static int8_t	CDC_Itf_DeInit (void)
	CDC_Itf_DeInit DeInitializes the CDC media low layer. More...
static int8_t	CDC_Itf_Control (uint8_t cmd, uint8_t *pbuf, uint16_t length)
	CDC_Itf_Control Manage the CDC class requests. More...
static int8_t	CDC_Itf_Receive (uint8_t *Buf, uint32_t *Len)
	CDC_Itf_DataRx Data received over USB OUT endpoint are sent over CDC interface through this function. More...
static void	Error_Handler (void)
	This function is executed in case of error occurrence. More...
static void	TIM_Config (void)
	TIM_Config: Configure TIMx timer. More...
uint8_t	CDC_Fill_Buffer (uint8_t *Buf, uint32_t TotalLen)
	Fill the usb tx buffer. More...
void	HAL_TIM_PeriodElapsedCallback (TIM_HandleTypeDef *htim)
	TIM period elapsed callback. More...

Variables
USBD_CDC_LineCodingTypeDef	LineCoding
uint8_t	UserRxBuffer [APP_RX_DATA_SIZE]
uint8_t	UserTxBuffer [APP_TX_DATA_SIZE]
uint32_t	BuffLength
uint32_t	UserTxBufPtrIn = 0
uint32_t	UserTxBufPtrOut = 0
volatile uint8_t	USB_RxBuffer [USB_RxBufferDim]
volatile uint16_t	USB_RxBufferStart_idx = 0
TIM_HandleTypeDef	TimHandle
USBD_HandleTypeDef	USBD_Device
USBD_CDC_ItfTypeDef	USBD_CDC_fops

Detailed Description

Source file for USBD CDC interface.

Author

MCD Application Team

Version

V1.3.0

Date

29-January-2016

Attention

© Copyright (c) 2016 STMicroelectronics International N.V. All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted, provided that the following conditions are met:

1. Redistribution of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
3. Neither the name of STMicroelectronics nor the names of other contributors to this software may be used to endorse or promote products derived from this software without specific written permission.
4. This software, including modifications and/or derivative works of this software, must execute solely and exclusively on microcontroller or microprocessor devices manufactured by or for STMicroelectronics.
5. Redistribution and use of this software other than as permitted under this license is void and will automatically terminate your rights under this license.

THIS SOFTWARE IS PROVIDED BY STMICROELECTRONICS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS, IMPLIED OR STATUTORY WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT OF THIRD PARTY INTELLECTUAL PROPERTY RIGHTS ARE DISCLAIMED TO THE FULLEST EXTENT PERMITTED BY LAW. IN NO EVENT SHALL STMICROELECTRONICS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Definition in file usbd_cdc_interface.c.

Function Documentation

CDC_Fill_Buffer()

uint8_t CDC_Fill_Buffer	(	uint8_t *	Buf,
		uint32_t	TotalLen
	)

Fill the usb tx buffer.

Parameters

Buf	pointer to the tx buffer
TotalLen	number of bytes to be sent

Return values

Result

of the operation: USBD_OK if all operations are OK

Definition at line 224 of file usbd_cdc_interface.c.

CDC_Itf_Control()

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

static

CDC_Itf_Control Manage the CDC class requests.

Parameters

Cmd	Command code
Buf	Buffer containing command data (request parameters)
Len	Number of data to be sent (in bytes)

Return values

Result

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

Definition at line 158 of file usbd_cdc_interface.c.

CDC_Itf_DeInit()

static int8_t CDC_Itf_DeInit ( void  )

static

CDC_Itf_DeInit DeInitializes the CDC media low layer.

Parameters

None

Return values

Result

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

Definition at line 144 of file usbd_cdc_interface.c.

CDC_Itf_Init()

static int8_t CDC_Itf_Init ( void  )

static

CDC_Itf_Init Initializes the CDC media low layer.

Parameters

None

Return values

Result

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

Definition at line 108 of file usbd_cdc_interface.c.

CDC_Itf_Receive()

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

static

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

Parameters

Buf	Buffer of data to be transmitted
Len	Number of data received (in bytes)

Return values

Result

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

Definition at line 281 of file usbd_cdc_interface.c.

Error_Handler()

static void Error_Handler ( void  )

static

This function is executed in case of error occurrence.

Parameters

None

Return values

None

Definition at line 343 of file usbd_cdc_interface.c.

HAL_TIM_PeriodElapsedCallback()

void HAL_TIM_PeriodElapsedCallback

(

TIM_HandleTypeDef *

htim

)

TIM period elapsed callback.

Parameters

htim	TIM handle

Return values

None

Definition at line 241 of file usbd_cdc_interface.c.

TIM_Config()

static void TIM_Config ( void  )

static

TIM_Config: Configure TIMx timer.

Parameters

None.

Return values

None.

Definition at line 315 of file usbd_cdc_interface.c.

Variable Documentation

LineCoding

USBD_CDC_LineCodingTypeDef LineCoding

Initial value:

=
  {
    115200, 
    0x00,   
    0x00,   
    0x08    
  }

Definition at line 59 of file usbd_cdc_interface.c.

USBD_CDC_fops

USBD_CDC_ItfTypeDef USBD_CDC_fops

Initial value:

= 
{
 CDC_Itf_Init,
 CDC_Itf_DeInit,
 CDC_Itf_Control,
 CDC_Itf_Receive
}

Definition at line 92 of file usbd_cdc_interface.c.