Demos/Device/LowLevel/VirtualSerial/VirtualSerial.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  *
  33  *  Header file for VirtualSerial.c.
  34  */
  35
  36 #ifndef _VIRTUALSERIAL_H_
  37 #define _VIRTUALSERIAL_H_
  38
  39         /* Includes: */
  40                 #include <avr/io.h>
  41                 #include <avr/wdt.h>
  42                 #include <avr/power.h>
  43                 #include <string.h>
  44
  45                 #include "Descriptors.h"
  46
  47                 #include <LUFA/Version.h>
  48                 #include <LUFA/Drivers/USB/USB.h>
  49                 #include <LUFA/Drivers/Board/Joystick.h>
  50                 #include <LUFA/Drivers/Board/LEDs.h>
  51
  52         /* Macros: */
  53                 /** CDC Class specific request to get the current virtual serial port configuration settings. */
  54                 #define REQ_GetLineEncoding          0x21
  55
  56                 /** CDC Class specific request to set the current virtual serial port configuration settings. */
  57                 #define REQ_SetLineEncoding          0x20
  58
  59                 /** CDC Class specific request to set the current virtual serial port handshake line states. */
  60                 #define REQ_SetControlLineState      0x22
  61
  62                 /** Notification type constant for a change in the virtual serial port handshake line states, for
  63                  *  use with a USB_Notification_Header_t notification structure when sent to the host via the CDC
  64                  *  notification endpoint.
  65                  */
  66                 #define NOTIF_SerialState            0x20
  67
  68                 /** Mask for the DTR handshake line for use with the REQ_SetControlLineState class specific request
  69                  *  from the host, to indicate that the DTR line state should be high.
  70                  */
  71                 #define CONTROL_LINE_OUT_DTR         (1 << 0)
  72
  73                 /** Mask for the RTS handshake line for use with the REQ_SetControlLineState class specific request
  74                  *  from the host, to indicate that theRTS line state should be high.
  75                  */
  76                 #define CONTROL_LINE_OUT_RTS         (1 << 1)
  77
  78                 /** Mask for the DCD handshake line for use with the a NOTIF_SerialState class specific notification
  79                  *  from the device to the host, to indicate that the DCD line state is currently high.
  80                  */
  81                 #define CONTROL_LINE_IN_DCD          (1 << 0)
  82
  83                 /** Mask for the DSR handshake line for use with the a NOTIF_SerialState class specific notification
  84                  *  from the device to the host, to indicate that the DSR line state is currently high.
  85                  */
  86                 #define CONTROL_LINE_IN_DSR          (1 << 1)
  87
  88                 /** Mask for the BREAK handshake line for use with the a NOTIF_SerialState class specific notification
  89                  *  from the device to the host, to indicate that the BREAK line state is currently high.
  90                  */
  91                 #define CONTROL_LINE_IN_BREAK        (1 << 2)
  92
  93                 /** Mask for the RING handshake line for use with the a NOTIF_SerialState class specific notification
  94                  *  from the device to the host, to indicate that the RING line state is currently high.
  95                  */
  96                 #define CONTROL_LINE_IN_RING         (1 << 3)
  97
  98                 /** Mask for use with the a NOTIF_SerialState class specific notification from the device to the host,
  99                  *  to indicate that a framing error has occurred on the virtual serial port.
 100                  */
 101                 #define CONTROL_LINE_IN_FRAMEERROR   (1 << 4)
 102
 103                 /** Mask for use with the a NOTIF_SerialState class specific notification from the device to the host,
 104                  *  to indicate that a parity error has occurred on the virtual serial port.
 105                  */
 106                 #define CONTROL_LINE_IN_PARITYERROR  (1 << 5)
 107
 108                 /** Mask for use with the a NOTIF_SerialState class specific notification from the device to the host,
 109                  *  to indicate that a data overrun error has occurred on the virtual serial port.
 110                  */
 111                 #define CONTROL_LINE_IN_OVERRUNERROR (1 << 6)
 112
 113                 /** LED mask for the library LED driver, to indicate that the USB interface is not ready. */
 114                 #define LEDMASK_USB_NOTREADY         LEDS_LED1
 115
 116                 /** LED mask for the library LED driver, to indicate that the USB interface is enumerating. */
 117                 #define LEDMASK_USB_ENUMERATING     (LEDS_LED2 | LEDS_LED3)
 118
 119                 /** LED mask for the library LED driver, to indicate that the USB interface is ready. */
 120                 #define LEDMASK_USB_READY           (LEDS_LED2 | LEDS_LED4)
 121
 122                 /** LED mask for the library LED driver, to indicate that an error has occurred in the USB interface. */
 123                 #define LEDMASK_USB_ERROR           (LEDS_LED1 | LEDS_LED3)
 124
 125         /* Type Defines: */
 126                 /** Type define for the virtual serial port line encoding settings, for storing the current USART configuration
 127                  *  as set by the host via a class specific request.
 128                  */
 129                 typedef struct
 130                 {
 131                         uint32_t BaudRateBPS; /**< Baud rate of the virtual serial port, in bits per second */
 132                         uint8_t  CharFormat; /**< Character format of the virtual serial port, a value from the
 133                                               *   CDCDevice_CDC_LineCodingFormats_t enum
 134                                               */
 135                         uint8_t  ParityType; /**< Parity setting of the virtual serial port, a value from the
 136                                               *   CDCDevice_LineCodingParity_t enum
 137                                               */
 138                         uint8_t  DataBits; /**< Bits of data per character of the virtual serial port */
 139                 } CDC_Line_Coding_t;
 140
 141                 /** Type define for a CDC notification, sent to the host via the CDC notification endpoint to indicate a
 142                  *  change in the device state asynchronously.
 143                  */
 144                 typedef struct
 145                 {
 146                         uint8_t  NotificationType; /**< Notification type, a mask of REQDIR_*, REQTYPE_* and REQREC_* constants
 147                                                     *   from the library StdRequestType.h header
 148                                                     */
 149                         uint8_t  Notification; /**< Notification value, a NOTIF_* constant */
 150                         uint16_t wValue; /**< Notification wValue, notification-specific */
 151                         uint16_t wIndex; /**< Notification wIndex, notification-specific */
 152                         uint16_t wLength; /**< Notification wLength, notification-specific */
 153                 } USB_Notification_Header_t;
 154
 155         /* Enums: */
 156                 /** Enum for the possible line encoding formats of a virtual serial port. */
 157                 enum CDCDevice_CDC_LineCodingFormats_t
 158                 {
 159                         OneStopBit          = 0, /**< Each frame contains one stop bit */
 160                         OneAndAHalfStopBits = 1, /**< Each frame contains one and a half stop bits */
 161                         TwoStopBits         = 2, /**< Each frame contains two stop bits */
 162                 };
 163
 164                 /** Enum for the possible line encoding parity settings of a virtual serial port. */
 165                 enum CDCDevice_LineCodingParity_t
 166                 {
 167                         Parity_None         = 0, /**< No parity bit mode on each frame */
 168                         Parity_Odd          = 1, /**< Odd parity bit mode on each frame */
 169                         Parity_Even         = 2, /**< Even parity bit mode on each frame */
 170                         Parity_Mark         = 3, /**< Mark parity bit mode on each frame */
 171                         Parity_Space        = 4, /**< Space parity bit mode on each frame */
 172                 };
 173
 174         /* Function Prototypes: */
 175                 void SetupHardware(void);
 176                 void CDC_Task(void);
 177
 178                 void EVENT_USB_Device_Connect(void);
 179                 void EVENT_USB_Device_Disconnect(void);
 180                 void EVENT_USB_Device_ConfigurationChanged(void);
 181                 void EVENT_USB_Device_UnhandledControlRequest(void);
 182
 183 #endif