CDCDescriptors.h

Go to the documentation of this file.

/* ---------------------------------------------------------------------------- */
/*                  Atmel Microcontroller Software Support                      */
/*                       SAM Software Package License                           */
/* ---------------------------------------------------------------------------- */
/* Copyright (c) 2015, Atmel Corporation                                        */
/*                                                                              */
/* All rights reserved.                                                         */
/*                                                                              */
/* Redistribution and use in source and binary forms, with or without           */
/* modification, are permitted provided that the following condition is met:    */
/*                                                                              */
/* - Redistributions of source code must retain the above copyright notice,     */
/* this list of conditions and the disclaimer below.                            */
/*                                                                              */
/* Atmel's name may not be used to endorse or promote products derived from     */
/* this software without specific prior written permission.                     */
/*                                                                              */
/* DISCLAIMER:  THIS SOFTWARE IS PROVIDED BY ATMEL "AS IS" AND ANY EXPRESS OR   */
/* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF */
/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT ARE   */
/* DISCLAIMED. IN NO EVENT SHALL ATMEL 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.                           */
/* ---------------------------------------------------------------------------- */

#ifndef _CDCDESCRIPTORS_H_
#define _CDCDESCRIPTORS_H_

/*----------------------------------------------------------------------------
 *         Includes
 *----------------------------------------------------------------------------*/

#include <stdint.h>

/*----------------------------------------------------------------------------
 *         Definitions
 *----------------------------------------------------------------------------*/

#define CDCGenericDescriptor_CDC1_10                            0x0110

#define CDCGenericDescriptor_INTERFACE                          0x24

#define CDCGenericDescriptor_ENDPOINT                           0x25

#define CDCGenericDescriptor_HEADER                             0x00

#define CDCGenericDescriptor_CALLMANAGEMENT                     0x01

#define CDCGenericDescriptor_ABSTRACTCONTROLMANAGEMENT          0x02

#define CDCGenericDescriptor_UNION                              0x06

#define CDCDeviceDescriptor_CLASS               0x02

#define CDCDeviceDescriptor_SUBCLASS            0x00

#define CDCDeviceDescriptor_PROTOCOL            0x00

#define CDCCommunicationInterfaceDescriptor_CLASS                   0x02

#define CDCCommunicationInterfaceDescriptor_ABSTRACTCONTROLMODEL    0x02

#define CDCCommunicationInterfaceDescriptor_ETHERNETEMULATIONMODEL  0x0C

#define CDCCommunicationInterfaceDescriptor_NOPROTOCOL              0x00

#define CDCCommunicationInterfaceDescriptor_EEMPROTOCOL             0x07

#define CDCDataInterfaceDescriptor_CLASS        0x0A

#define CDCDataInterfaceDescriptor_SUBCLASS     0x00

#define CDCDataInterfaceDescriptor_NOPROTOCOL   0x00

#define CDCCallManagementDescriptor_SELFCALLMANAGEMENT      (1 << 0)

#define CDCCallManagementDescriptor_DATACALLMANAGEMENT      (1 << 1)

#define CDCAbstractControlManagementDescriptor_COMMFEATURE          (1 << 0)

#define CDCAbstractControlManagementDescriptor_LINE                 (1 << 1)

#define CDCAbstractControlManagementDescriptor_SENDBREAK            (1 << 2)

#define CDCAbstractControlManagementDescriptor_NETWORKCONNECTION    (1 << 3)


#define  CDC_SUBCLASS_DLCM    0x01      
#define  CDC_SUBCLASS_ACM     0x02      
#define  CDC_SUBCLASS_TCM     0x03      
#define  CDC_SUBCLASS_MCCM    0x04      
#define  CDC_SUBCLASS_CCM     0x05      
#define  CDC_SUBCLASS_ETH     0x06      
#define  CDC_SUBCLASS_ATM     0x07      



#define  CDC_PROTOCOL_V25TER  0x01      



#define  CDC_PROTOCOL_I430    0x30      
#define  CDC_PROTOCOL_HDLC    0x31      
#define  CDC_PROTOCOL_TRANS   0x32      
#define  CDC_PROTOCOL_Q921M   0x50      
#define  CDC_PROTOCOL_Q921    0x51      
#define  CDC_PROTOCOL_Q921TM  0x52      
#define  CDC_PROTOCOL_V42BIS  0x90      
#define  CDC_PROTOCOL_Q931    0x91      
#define  CDC_PROTOCOL_V120    0x92      
#define  CDC_PROTOCOL_CAPI20  0x93      
#define  CDC_PROTOCOL_HOST    0xFD      

#define  CDC_PROTOCOL_PUFD    0xFE

/*----------------------------------------------------------------------------
 *         Types
 *----------------------------------------------------------------------------*/
#pragma pack(1)
#if defined   ( __CC_ARM   ) /* Keil ¦ÌVision 4 */
#elif defined ( __ICCARM__ ) /* IAR Ewarm */
#define __attribute__(...)
#define __packed__  packed
#elif defined (  __GNUC__  ) /* GCC CS3 */
#define __packed__  aligned(1)
#endif

typedef struct _CDCHeaderDescriptor {

    uint8_t bFunctionLength;
    uint8_t bDescriptorType;
    uint8_t bDescriptorSubtype;
    uint16_t bcdCDC;

} __attribute__ ((__packed__)) CDCHeaderDescriptor; /* GCC */

typedef struct _CDCUnionDescriptor {

    uint8_t bFunctionLength;
    uint8_t bDescriptorType;
    uint8_t bDescriptorSubtype;
    uint8_t bMasterInterface;
    uint8_t bSlaveInterface0;

} __attribute__ ((__packed__)) CDCUnionDescriptor; /* GCC */

typedef struct _CDCCallManagementDescriptor {

    uint8_t bFunctionLength;
    uint8_t bDescriptorType;
    uint8_t bDescriptorSubtype;
    uint8_t bmCapabilities;
    uint8_t bDataInterface;

} __attribute__ ((__packed__)) CDCCallManagementDescriptor; /* GCC */

typedef struct _CDCAbstractControlManagementDescriptor {

    uint8_t bFunctionLength;
    uint8_t bDescriptorType;
    uint8_t bDescriptorSubtype;
    uint8_t bmCapabilities;

} __attribute__ ((__packed__)) CDCAbstractControlManagementDescriptor; /* GCC */

#pragma pack()

/*----------------------------------------------------------------------------
 *         Functions
 *----------------------------------------------------------------------------*/


#endif /* #ifndef _CDCDESCRIPTORS_H_ */