206 lines
6.7 KiB
C
206 lines
6.7 KiB
C
/**
|
|
******************************************************************************
|
|
* @file usbd_cdc.h
|
|
* @author MCD Application Team
|
|
* @brief header file for the usbd_cdc.c file.
|
|
******************************************************************************
|
|
* @attention
|
|
*
|
|
* <h2><center>© Copyright (c) 2017 STMicroelectronics International N.V.
|
|
* All rights reserved.</center></h2>
|
|
*
|
|
* 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.
|
|
*
|
|
******************************************************************************
|
|
*/
|
|
|
|
/* Define to prevent recursive inclusion -------------------------------------*/
|
|
#ifndef __USB_CDC_H
|
|
#define __USB_CDC_H
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/* Includes ------------------------------------------------------------------*/
|
|
#include "usbd_ioreq.h"
|
|
|
|
/** @addtogroup STM32_USB_DEVICE_LIBRARY
|
|
* @{
|
|
*/
|
|
|
|
/** @defgroup usbd_cdc
|
|
* @brief This file is the Header file for usbd_cdc.c
|
|
* @{
|
|
*/
|
|
|
|
|
|
/** @defgroup usbd_cdc_Exported_Defines
|
|
* @{
|
|
*/
|
|
#define CDC_IN_EP 0x82U /* EP1 for data IN */
|
|
#define CDC_OUT_EP 0x02U /* EP1 for data OUT */
|
|
#define CDC_CMD_EP 0x83U /* EP2 for CDC commands */
|
|
|
|
#ifndef CDC_HS_BINTERVAL
|
|
#define CDC_HS_BINTERVAL 0x10U
|
|
#endif /* CDC_HS_BINTERVAL */
|
|
|
|
#ifndef CDC_FS_BINTERVAL
|
|
#define CDC_FS_BINTERVAL 0x10U
|
|
#endif /* CDC_FS_BINTERVAL */
|
|
|
|
/* CDC Endpoints parameters: you can fine tune these values depending on the needed baudrates and performance. */
|
|
#define CDC_DATA_HS_MAX_PACKET_SIZE 64U /* Endpoint IN & OUT Packet size */
|
|
#define CDC_DATA_FS_MAX_PACKET_SIZE 64U /* Endpoint IN & OUT Packet size */
|
|
#define CDC_CMD_PACKET_SIZE 8U /* Control Endpoint Packet size */
|
|
|
|
#define USB_CDC_CONFIG_DESC_SIZ 67U
|
|
#define CDC_DATA_HS_IN_PACKET_SIZE CDC_DATA_HS_MAX_PACKET_SIZE
|
|
#define CDC_DATA_HS_OUT_PACKET_SIZE CDC_DATA_HS_MAX_PACKET_SIZE
|
|
|
|
#define CDC_DATA_FS_IN_PACKET_SIZE CDC_DATA_FS_MAX_PACKET_SIZE
|
|
#define CDC_DATA_FS_OUT_PACKET_SIZE CDC_DATA_FS_MAX_PACKET_SIZE
|
|
|
|
/*---------------------------------------------------------------------*/
|
|
/* CDC definitions */
|
|
/*---------------------------------------------------------------------*/
|
|
#define CDC_SEND_ENCAPSULATED_COMMAND 0x00U
|
|
#define CDC_GET_ENCAPSULATED_RESPONSE 0x01U
|
|
#define CDC_SET_COMM_FEATURE 0x02U
|
|
#define CDC_GET_COMM_FEATURE 0x03U
|
|
#define CDC_CLEAR_COMM_FEATURE 0x04U
|
|
#define CDC_SET_LINE_CODING 0x20U
|
|
#define CDC_GET_LINE_CODING 0x21U
|
|
#define CDC_SET_CONTROL_LINE_STATE 0x22U
|
|
#define CDC_SEND_BREAK 0x23U
|
|
|
|
/**
|
|
* @}
|
|
*/
|
|
|
|
|
|
/** @defgroup USBD_CORE_Exported_TypesDefinitions
|
|
* @{
|
|
*/
|
|
|
|
/**
|
|
* @}
|
|
*/
|
|
typedef struct
|
|
{
|
|
uint32_t bitrate;
|
|
uint8_t format;
|
|
uint8_t paritytype;
|
|
uint8_t datatype;
|
|
}USBD_CDC_LineCodingTypeDef;
|
|
|
|
typedef struct _USBD_CDC_Itf
|
|
{
|
|
int8_t (* Init) (void);
|
|
int8_t (* DeInit) (void);
|
|
int8_t (* Control) (uint8_t cmd, uint8_t* pbuf, uint16_t length);
|
|
int8_t (* Receive) (uint8_t* Buf, uint32_t *Len);
|
|
|
|
}USBD_CDC_ItfTypeDef;
|
|
|
|
|
|
typedef struct
|
|
{
|
|
uint32_t data[CDC_DATA_HS_MAX_PACKET_SIZE / 4U]; /* Force 32bits alignment */
|
|
uint8_t CmdOpCode;
|
|
uint8_t CmdLength;
|
|
uint8_t *RxBuffer;
|
|
uint8_t *TxBuffer;
|
|
uint32_t RxLength;
|
|
uint32_t TxLength;
|
|
|
|
__IO uint32_t TxState;
|
|
__IO uint32_t RxState;
|
|
}
|
|
USBD_CDC_HandleTypeDef;
|
|
|
|
|
|
|
|
/** @defgroup USBD_CORE_Exported_Macros
|
|
* @{
|
|
*/
|
|
|
|
/**
|
|
* @}
|
|
*/
|
|
|
|
/** @defgroup USBD_CORE_Exported_Variables
|
|
* @{
|
|
*/
|
|
|
|
extern USBD_ClassTypeDef USBD_CDC;
|
|
#define USBD_CDC_CLASS &USBD_CDC
|
|
/**
|
|
* @}
|
|
*/
|
|
|
|
/** @defgroup USB_CORE_Exported_Functions
|
|
* @{
|
|
*/
|
|
uint8_t USBD_CDC_RegisterInterface (USBD_HandleTypeDef *pdev,
|
|
USBD_CDC_ItfTypeDef *fops);
|
|
|
|
uint8_t USBD_CDC_SetTxBuffer (USBD_HandleTypeDef *pdev,
|
|
uint8_t *pbuff,
|
|
uint16_t length);
|
|
|
|
uint8_t USBD_CDC_SetRxBuffer (USBD_HandleTypeDef *pdev,
|
|
uint8_t *pbuff);
|
|
|
|
uint8_t USBD_CDC_ReceivePacket (USBD_HandleTypeDef *pdev);
|
|
|
|
uint8_t USBD_CDC_TransmitPacket (USBD_HandleTypeDef *pdev);
|
|
/**
|
|
* @}
|
|
*/
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* __USB_CDC_H */
|
|
/**
|
|
* @}
|
|
*/
|
|
|
|
/**
|
|
* @}
|
|
*/
|
|
|
|
/************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/
|