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  *  \note This file should not be included directly. It is automatically included as needed by the class driver
  35  *        dispatch header located in LUFA/Drivers/USB/Class/CDC.h.
  36  */
  37
  38 /** \ingroup Group_USBClassCDC
  39  *  @defgroup Group_USBClassCDCCommon  Common Class Definitions
  40  *
  41  *  \section Module Description
  42  *  Constants, Types and Enum definitions that are common to both Device and Host modes for the USB
  43  *  CDC Class.
  44  *
  45  *  @{
  46  */
  47
  48 #ifndef _CDC_CLASS_COMMON_H_
  49 #define _CDC_CLASS_COMMON_H_
  50
  51         /* Includes: */
  52                 #include "../../USB.h"
  53
  54                 #include <string.h>
  55
  56         /* Enable C linkage for C++ Compilers: */
  57                 #if defined(__cplusplus)
  58                         extern "C" {
  59                 #endif
  60
  61         /* Preprocessor Checks: */
  62                 #if !defined(__INCLUDE_FROM_CDC_DRIVER)
  63                         #error Do not include this file directly. Include LUFA/Drivers/Class/CDC.h instead.
  64                 #endif
  65
  66         /* Macros: */
  67                 /** CDC Class specific request to get the current virtual serial port configuration settings. */
  68                 #define REQ_GetLineEncoding              0x21
  69
  70                 /** CDC Class specific request to set the current virtual serial port configuration settings. */
  71                 #define REQ_SetLineEncoding              0x20
  72
  73                 /** CDC Class specific request to set the current virtual serial port handshake line states. */
  74                 #define REQ_SetControlLineState          0x22
  75
  76                 /** Notification type constant for a change in the virtual serial port handshake line states, for
  77                  *  use with a USB_Notification_Header_t notification structure when sent to the host via the CDC
  78                  *  notification endpoint.
  79                  */
  80                 #define NOTIF_SerialState                0x20
  81
  82                 /** Mask for the DTR handshake line for use with the REQ_SetControlLineState class specific request
  83                  *  from the host, to indicate that the DTR line state should be high.
  84                  */
  85                 #define CDC_CONTROL_LINE_OUT_DTR         (1 << 0)
  86
  87                 /** Mask for the RTS handshake line for use with the REQ_SetControlLineState class specific request
  88                  *  from the host, to indicate that theRTS line state should be high.
  89                  */
  90                 #define CDC_CONTROL_LINE_OUT_RTS         (1 << 1)
  91
  92                 /** Mask for the DCD handshake line for use with the a NOTIF_SerialState class specific notification
  93                  *  from the device to the host, to indicate that the DCD line state is currently high.
  94                  */
  95                 #define CDC_CONTROL_LINE_IN_DCD          (1 << 0)
  96
  97                 /** Mask for the DSR handshake line for use with the a NOTIF_SerialState class specific notification
  98                  *  from the device to the host, to indicate that the DSR line state is currently high.
  99                  */
 100                 #define CDC_CONTROL_LINE_IN_DSR          (1 << 1)
 101
 102                 /** Mask for the BREAK handshake line for use with the a NOTIF_SerialState class specific notification
 103                  *  from the device to the host, to indicate that the BREAK line state is currently high.
 104                  */
 105                 #define CDC_CONTROL_LINE_IN_BREAK        (1 << 2)
 106
 107                 /** Mask for the RING handshake line for use with the a NOTIF_SerialState class specific notification
 108                  *  from the device to the host, to indicate that the RING line state is currently high.
 109                  */
 110                 #define CDC_CONTROL_LINE_IN_RING         (1 << 3)
 111
 112                 /** Mask for use with the a NOTIF_SerialState class specific notification from the device to the host,
 113                  *  to indicate that a framing error has occurred on the virtual serial port.
 114                  */
 115                 #define CDC_CONTROL_LINE_IN_FRAMEERROR   (1 << 4)
 116
 117                 /** Mask for use with the a NOTIF_SerialState class specific notification from the device to the host,
 118                  *  to indicate that a parity error has occurred on the virtual serial port.
 119                  */
 120                 #define CDC_CONTROL_LINE_IN_PARITYERROR  (1 << 5)
 121
 122                 /** Mask for use with the a NOTIF_SerialState class specific notification from the device to the host,
 123                  *  to indicate that a data overrun error has occurred on the virtual serial port.
 124                  */
 125                 #define CDC_CONTROL_LINE_IN_OVERRUNERROR (1 << 6)
 126
 127                 /** Macro to define a CDC class-specific functional descriptor. CDC functional descriptors have a
 128                  *  uniform structure but variable sized data payloads, thus cannot be represented accurately by
 129                  *  a single typedef struct. A macro is used instead so that functional descriptors can be created
 130                  *  easily by specifying the size of the payload. This allows sizeof() to work correctly.
 131                  *
 132                  *  \param[in] DataSize  Size in bytes of the CDC functional descriptor's data payload
 133                  */
 134                 #define CDC_FUNCTIONAL_DESCRIPTOR(DataSize)        \
 135                      struct                                        \
 136                      {                                             \
 137                           USB_Descriptor_Header_t Header;          \
 138                               uint8_t                 SubType;         \
 139                           uint8_t                 Data[DataSize];  \
 140                      }
 141
 142         /* Enums: */
 143                 /** Enum for the possible line encoding formats of a virtual serial port. */
 144                 enum CDC_LineCodingFormats_t
 145                 {
 146                         CDC_LINEENCODING_OneStopBit          = 0, /**< Each frame contains one stop bit */
 147                         CDC_LINEENCODING_OneAndAHalfStopBits = 1, /**< Each frame contains one and a half stop bits */
 148                         CDC_LINEENCODING_TwoStopBits         = 2, /**< Each frame contains two stop bits */
 149                 };
 150
 151                 /** Enum for the possible line encoding parity settings of a virtual serial port. */
 152                 enum CDC_LineCodingParity_t
 153                 {
 154                         CDC_PARITY_None    = 0, /**< No parity bit mode on each frame */
 155                         CDC_PARITY_Odd     = 1, /**< Odd parity bit mode on each frame */
 156                         CDC_PARITY_Even    = 2, /**< Even parity bit mode on each frame */
 157                         CDC_PARITY_Mark    = 3, /**< Mark parity bit mode on each frame */
 158                         CDC_PARITY_Space   = 4, /**< Space parity bit mode on each frame */
 159                 };
 160
 161         /* Disable C linkage for C++ Compilers: */
 162                 #if defined(__cplusplus)
 163                         }
 164                 #endif
 165
 166 #endif
 167
 168 /** @} */