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