CDCRequests.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 _CDCREQUESTS_H_
#define _CDCREQUESTS_H_

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

#include <stdint.h>
#include <USBRequests.h>

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

#define CDCGenericRequest_SETLINECODING             0x20

#define CDCGenericRequest_GETLINECODING             0x21

#define CDCGenericRequest_SETCONTROLLINESTATE       0x22

#define CDCControlLineState_DTE_PRESENT                     (1 << 0)

#define CDCControlLineState_DTR                             (1 << 0)

#define CDCControlLineState_CARRIER_ON                      (1 << 1)

#define CDCControlLineState_RTS                             (1 << 1)

#define CDCLineCoding_ONESTOPBIT            0

#define CDCLineCoding_ONE5STOPBIT           1

#define CDCLineCoding_TWOSTOPBITS           2

#define CDCLineCoding_NOPARITY              0

#define CDCLineCoding_ODDPARITY             1

#define CDCLineCoding_EVENPARITY            2

#define CDCLineCoding_MARKPARITY            3

#define CDCLineCoding_SPACEPARITY           4

/*----------------------------------------------------------------------------
 *         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 _CDCLineCoding {

    uint32_t dwDTERate;
    uint8_t bCharFormat;
    uint8_t bParityType;
    uint8_t bDataBits;

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

#pragma pack()

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

extern uint8_t CDCSetControlLineStateRequest_IsDtePresent(
    const USBGenericRequest *request);

extern uint8_t CDCSetControlLineStateRequest_ActivateCarrier(
    const USBGenericRequest *request);

extern void CDCLineCoding_Initialize(CDCLineCoding *lineCoding,
                                     uint32_t bitrate,
                                     uint8_t stopbits,
                                     uint8_t parity,
                                     uint8_t databits);


#endif /* #define _CDCREQUESTS_H_ */