usbh_cdc.h File Reference

This file contains all the prototypes for the usbh_cdc.c. More...

#include "usbh_core.h"

Go to the source code of this file.

Data Structures
union	_CDC_LineCodingStructure
struct	_FunctionalDescriptorHeader
struct	_CallMgmtFunctionalDescriptor
struct	_AbstractCntrlMgmtFunctionalDescriptor
struct	_UnionFunctionalDescriptor
struct	_USBH_CDCInterfaceDesc
struct	CDC_CommItfTypedef
struct	CDC_DataItfTypedef
struct	_CDC_Process

Macros
#define	USB_CDC_CLASS   0x02
#define	COMMUNICATION_INTERFACE_CLASS_CODE   0x02
#define	DATA_INTERFACE_CLASS_CODE   0x0A
#define	RESERVED   0x00
#define	DIRECT_LINE_CONTROL_MODEL   0x01
#define	ABSTRACT_CONTROL_MODEL   0x02
#define	TELEPHONE_CONTROL_MODEL   0x03
#define	MULTICHANNEL_CONTROL_MODEL   0x04
#define	CAPI_CONTROL_MODEL   0x05
#define	ETHERNET_NETWORKING_CONTROL_MODEL   0x06
#define	ATM_NETWORKING_CONTROL_MODEL   0x07
#define	NO_CLASS_SPECIFIC_PROTOCOL_CODE   0x00
#define	COMMON_AT_COMMAND   0x01
#define	VENDOR_SPECIFIC   0xFF
#define	CS_INTERFACE   0x24
#define	CDC_PAGE_SIZE_64   0x40
#define	CDC_SEND_ENCAPSULATED_COMMAND   0x00
#define	CDC_GET_ENCAPSULATED_RESPONSE   0x01
#define	CDC_SET_COMM_FEATURE   0x02
#define	CDC_GET_COMM_FEATURE   0x03
#define	CDC_CLEAR_COMM_FEATURE   0x04
#define	CDC_SET_AUX_LINE_STATE   0x10
#define	CDC_SET_HOOK_STATE   0x11
#define	CDC_PULSE_SETUP   0x12
#define	CDC_SEND_PULSE   0x13
#define	CDC_SET_PULSE_TIME   0x14
#define	CDC_RING_AUX_JACK   0x15
#define	CDC_SET_LINE_CODING   0x20
#define	CDC_GET_LINE_CODING   0x21
#define	CDC_SET_CONTROL_LINE_STATE   0x22
#define	CDC_SEND_BREAK   0x23
#define	CDC_SET_RINGER_PARMS   0x30
#define	CDC_GET_RINGER_PARMS   0x31
#define	CDC_SET_OPERATION_PARMS   0x32
#define	CDC_GET_OPERATION_PARMS   0x33
#define	CDC_SET_LINE_PARMS   0x34
#define	CDC_GET_LINE_PARMS   0x35
#define	CDC_DIAL_DIGITS   0x36
#define	CDC_SET_UNIT_PARAMETER   0x37
#define	CDC_GET_UNIT_PARAMETER   0x38
#define	CDC_CLEAR_UNIT_PARAMETER   0x39
#define	CDC_GET_PROFILE   0x3A
#define	CDC_SET_ETHERNET_MULTICAST_FILTERS   0x40
#define	CDC_SET_ETHERNET_POWER_MANAGEMENT_PATTERN   FILTER 0x41
#define	CDC_GET_ETHERNET_POWER_MANAGEMENT_PATTERN   FILTER 0x42
#define	CDC_SET_ETHERNET_PACKET_FILTER   0x43
#define	CDC_GET_ETHERNET_STATISTIC   0x44
#define	CDC_SET_ATM_DATA_FORMAT   0x50
#define	CDC_GET_ATM_DEVICE_STATISTICS   0x51
#define	CDC_SET_ATM_DEFAULT_VC   0x52
#define	CDC_GET_ATM_VC_STATISTICS   0x53
#define	CDC_ACTIVATE_CARRIER_SIGNAL_RTS   0x0002
#define	CDC_DEACTIVATE_CARRIER_SIGNAL_RTS   0x0000
#define	CDC_ACTIVATE_SIGNAL_DTR   0x0001
#define	CDC_DEACTIVATE_SIGNAL_DTR   0x0000
#define	LINE_CODING_STRUCTURE_SIZE   0x07
#define	USBH_CDC_CLASS   &CDC_Class

Typedefs
typedef union _CDC_LineCodingStructure	CDC_LineCodingTypeDef
typedef struct _FunctionalDescriptorHeader	CDC_HeaderFuncDesc_TypeDef
typedef struct _CallMgmtFunctionalDescriptor	CDC_CallMgmtFuncDesc_TypeDef
typedef struct _AbstractCntrlMgmtFunctionalDescriptor	CDC_AbstCntrlMgmtFuncDesc_TypeDef
typedef struct _UnionFunctionalDescriptor	CDC_UnionFuncDesc_TypeDef
typedef struct _USBH_CDCInterfaceDesc	CDC_InterfaceDesc_Typedef
typedef struct _CDC_Process	CDC_HandleTypeDef

Enumerations
enum	CDC_DataStateTypeDef {   CDC_IDLE = 0, CDC_SEND_DATA, CDC_SEND_DATA_WAIT, CDC_RECEIVE_DATA,   CDC_RECEIVE_DATA_WAIT }
enum	CDC_StateTypeDef {   CDC_IDLE_STATE = 0, CDC_SET_LINE_CODING_STATE, CDC_GET_LAST_LINE_CODING_STATE, CDC_TRANSFER_DATA,   CDC_ERROR_STATE }

Functions
USBH_StatusTypeDef	USBH_CDC_SetLineCoding (USBH_HandleTypeDef *phost, CDC_LineCodingTypeDef *linecoding)
	This function prepares the state before issuing the class specific commands. More...
USBH_StatusTypeDef	USBH_CDC_GetLineCoding (USBH_HandleTypeDef *phost, CDC_LineCodingTypeDef *linecoding)
	This function prepares the state before issuing the class specific commands. More...
USBH_StatusTypeDef	USBH_CDC_Transmit (USBH_HandleTypeDef *phost, uint8_t *pbuff, uint32_t length)
	This function prepares the state before issuing the class specific commands. More...
USBH_StatusTypeDef	USBH_CDC_Receive (USBH_HandleTypeDef *phost, uint8_t *pbuff, uint32_t length)
	This function prepares the state before issuing the class specific commands. More...
uint16_t	USBH_CDC_GetLastReceivedDataSize (USBH_HandleTypeDef *phost)
	This function return last received data size. More...
USBH_StatusTypeDef	USBH_CDC_Stop (USBH_HandleTypeDef *phost)
	USBH_CDC_Stop Stop current CDC Transmission. More...
void	USBH_CDC_LineCodingChanged (USBH_HandleTypeDef *phost)
	The function informs user that Settings have been changed. More...
void	USBH_CDC_TransmitCallback (USBH_HandleTypeDef *phost)
	The function informs user that data have been received. More...
void	USBH_CDC_ReceiveCallback (USBH_HandleTypeDef *phost)
	The function informs user that data have been sent. More...

Variables
USBH_ClassTypeDef	CDC_Class

Detailed Description

This file contains all the prototypes for the usbh_cdc.c.

Author

MCD Application Team

Version

V3.2.2

Date

07-July-2015

Attention

© COPYRIGHT 2015 STMicroelectronics

Licensed under MCD-ST Liberty SW License Agreement V2, (the "License"); You may not use this file except in compliance with the License. You may obtain a copy of the License at:

   http://www.st.com/software_license_agreement_liberty_v2

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Definition in file usbh_cdc.h.