LUFA/Drivers/USB/Class/Common/CDC.h

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2010.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6       www.fourwalledcubicle.com
   7 */
   8
   9 /*
  10   Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)
  11
  12   Permission to use, copy, modify, distribute, and sell this
  13   software and its documentation for any purpose is hereby granted
  14   without fee, provided that the above copyright notice appear in
  15   all copies and that both that the copyright notice and this
  16   permission notice and warranty disclaimer appear in supporting
  17   documentation, and that the name of the author not be used in
  18   advertising or publicity pertaining to distribution of the
  19   software without specific, written prior permission.
  20
  21   The author disclaim all warranties with regard to this
  22   software, including all implied warranties of merchantability
  23   and fitness.  In no event shall the author be liable for any
  24   special, indirect or consequential damages or any damages
  25   whatsoever resulting from loss of use, data or profits, whether
  26   in an action of contract, negligence or other tortious action,
  27   arising out of or in connection with the use or performance of
  28   this software.
  29 */
  30
  31 /** \file
  32  *  \brief Common definitions and declarations for the library USB CDC Class driver.
  33  *
  34  *  Common definitions and declarations for the library USB CDC Class driver.
  35  *
  36  *  \note This file should not be included directly. It is automatically included as needed by the class driver
  37  *        dispatch header located in LUFA/Drivers/USB/Class/CDC.h.
  38  */
  39
  40 /** \ingroup Group_USBClassCDC
  41  *  @defgroup Group_USBClassCDCCommon  Common Class Definitions
  42  *
  43  *  \section Module Description
  44  *  Constants, Types and Enum definitions that are common to both Device and Host modes for the USB
  45  *  CDC Class.
  46  *
  47  *  @{
  48  */
  49
  50 #ifndef _CDC_CLASS_COMMON_H_
  51 #define _CDC_CLASS_COMMON_H_
  52
  53         /* Includes: */
  54                 #include "../../USB.h"
  55
  56                 #include <string.h>
  57
  58         /* Enable C linkage for C++ Compilers: */
  59                 #if defined(__cplusplus)
  60                         extern "C" {
  61                 #endif
  62
  63         /* Preprocessor Checks: */
  64                 #if !defined(__INCLUDE_FROM_CDC_DRIVER)
  65                         #error Do not include this file directly. Include LUFA/Drivers/Class/CDC.h instead.
  66                 #endif
  67
  68         /* Macros: */
  69                 /** CDC class-specific request to get the current virtual serial port configuration settings. */
  70                 #define REQ_GetLineEncoding              0x21
  71
  72                 /** CDC class-specific request to set the current virtual serial port configuration settings. */
  73                 #define REQ_SetLineEncoding              0x20
  74
  75                 /** CDC class-specific request to set the current virtual serial port handshake line states. */
  76                 #define REQ_SetControlLineState          0x22
  77
  78                 /** CDC class-specific request to send a break to the receiver via the carrier channel. */
  79                 #define REQ_SendBreak                    0x23
  80
  81                 /** CDC class-specific request to send an encapsulated command to the device. */
  82                 #define REQ_SendEncapsulatedCommand      0x00
  83
  84                 /** CDC class-specific request to retrieve an encapsulated command response from the device. */
  85                 #define REQ_GetEncapsulatedResponse      0x01
  86
  87                 /** Notification type constant for a change in the virtual serial port handshake line states, for
  88                  *  use with a USB_Notification_Header_t notification structure when sent to the host via the CDC
  89                  *  notification endpoint.
  90                  */
  91                 #define NOTIF_SerialState                0x20
  92
  93                 /** Mask for the DTR handshake line for use with the REQ_SetControlLineState class-specific request
  94                  *  from the host, to indicate that the DTR line state should be high.
  95                  */
  96                 #define CDC_CONTROL_LINE_OUT_DTR         (1 << 0)
  97
  98                 /** Mask for the RTS handshake line for use with the REQ_SetControlLineState class-specific request
  99                  *  from the host, to indicate that theRTS line state should be high.
 100                  */
 101                 #define CDC_CONTROL_LINE_OUT_RTS         (1 << 1)
 102
 103                 /** Mask for the DCD handshake line for use with the a NOTIF_SerialState class-specific notification
 104                  *  from the device to the host, to indicate that the DCD line state is currently high.
 105                  */
 106                 #define CDC_CONTROL_LINE_IN_DCD          (1 << 0)
 107
 108                 /** Mask for the DSR handshake line for use with the a NOTIF_SerialState class-specific notification
 109                  *  from the device to the host, to indicate that the DSR line state is currently high.
 110                  */
 111                 #define CDC_CONTROL_LINE_IN_DSR          (1 << 1)
 112
 113                 /** Mask for the BREAK handshake line for use with the a NOTIF_SerialState class-specific notification
 114                  *  from the device to the host, to indicate that the BREAK line state is currently high.
 115                  */
 116                 #define CDC_CONTROL_LINE_IN_BREAK        (1 << 2)
 117
 118                 /** Mask for the RING handshake line for use with the a NOTIF_SerialState class-specific notification
 119                  *  from the device to the host, to indicate that the RING line state is currently high.
 120                  */
 121                 #define CDC_CONTROL_LINE_IN_RING         (1 << 3)
 122
 123                 /** Mask for use with the a NOTIF_SerialState class-specific notification from the device to the host,
 124                  *  to indicate that a framing error has occurred on the virtual serial port.
 125                  */
 126                 #define CDC_CONTROL_LINE_IN_FRAMEERROR   (1 << 4)
 127
 128                 /** Mask for use with the a NOTIF_SerialState class-specific notification from the device to the host,
 129                  *  to indicate that a parity error has occurred on the virtual serial port.
 130                  */
 131                 #define CDC_CONTROL_LINE_IN_PARITYERROR  (1 << 5)
 132
 133                 /** Mask for use with the a NOTIF_SerialState class-specific notification from the device to the host,
 134                  *  to indicate that a data overrun error has occurred on the virtual serial port.
 135                  */
 136                 #define CDC_CONTROL_LINE_IN_OVERRUNERROR (1 << 6)
 137
 138                 /** Macro to define a CDC class-specific functional descriptor. CDC functional descriptors have a
 139                  *  uniform structure but variable sized data payloads, thus cannot be represented accurately by
 140                  *  a single typedef struct. A macro is used instead so that functional descriptors can be created
 141                  *  easily by specifying the size of the payload. This allows sizeof() to work correctly.
 142                  *
 143                  *  \param[in] DataSize  Size in bytes of the CDC functional descriptor's data payload.
 144                  */
 145                 #define CDC_FUNCTIONAL_DESCRIPTOR(DataSize)        \
 146                      struct                                        \
 147                      {                                             \
 148                           USB_Descriptor_Header_t Header;          \
 149                               uint8_t                 SubType;         \
 150                           uint8_t                 Data[DataSize];  \
 151                      }
 152
 153         /* Enums: */
 154                 /** Enum for the possible line encoding formats of a virtual serial port. */
 155                 enum CDC_LineEncodingFormats_t
 156                 {
 157                         CDC_LINEENCODING_OneStopBit          = 0, /**< Each frame contains one stop bit. */
 158                         CDC_LINEENCODING_OneAndAHalfStopBits = 1, /**< Each frame contains one and a half stop bits. */
 159                         CDC_LINEENCODING_TwoStopBits         = 2, /**< Each frame contains two stop bits. */
 160                 };
 161
 162                 /** Enum for the possible line encoding parity settings of a virtual serial port. */
 163                 enum CDC_LineEncodingParity_t
 164                 {
 165                         CDC_PARITY_None    = 0, /**< No parity bit mode on each frame. */
 166                         CDC_PARITY_Odd     = 1, /**< Odd parity bit mode on each frame. */
 167                         CDC_PARITY_Even    = 2, /**< Even parity bit mode on each frame. */
 168                         CDC_PARITY_Mark    = 3, /**< Mark parity bit mode on each frame. */
 169                         CDC_PARITY_Space   = 4, /**< Space parity bit mode on each frame. */
 170                 };
 171
 172         /* Disable C linkage for C++ Compilers: */
 173                 #if defined(__cplusplus)
 174                         }
 175                 #endif
 176
 177 #endif
 178
 179 /** @} */