Demos/Device/LowLevel/USBtoSerial/USBtoSerial.h

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2009.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6       www.fourwalledcubicle.com
   7 */
   8
   9 /*
  10   Copyright 2009  Dean Camera (dean [at] fourwalledcubicle [dot] com)
  11
  12   Permission to use, copy, modify, and distribute this software
  13   and its documentation for any purpose and without fee is hereby
  14   granted, provided that the above copyright notice appear in all
  15   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 USBtoSerial.c.
  34  */
  35
  36 #ifndef _USB_SERIAL_H_
  37 #define _USB_SERIAL_H_
  38
  39         /* Includes: */
  40                 #include <avr/io.h>
  41                 #include <avr/wdt.h>
  42                 #include <avr/interrupt.h>
  43                 #include <avr/power.h>
  44
  45                 #include "Descriptors.h"
  46
  47                 #include "Lib/RingBuff.h"
  48
  49                 #include <LUFA/Version.h>                         // Library Version Information
  50                 #include <LUFA/Drivers/USB/USB.h>                 // USB Functionality
  51                 #include <LUFA/Drivers/Peripheral/Serial.h>       // USART driver
  52                 #include <LUFA/Drivers/Board/LEDs.h>              // LEDs driver
  53                 #include <LUFA/Scheduler/Scheduler.h>             // Simple scheduler for task management
  54
  55         /* Macros: */
  56                 /** CDC Class specific request to get the current virtual serial port configuration settings. */
  57                 #define REQ_GetLineEncoding          0x21
  58
  59                 /** CDC Class specific request to set the current virtual serial port configuration settings. */
  60                 #define REQ_SetLineEncoding          0x20
  61
  62                 /** CDC Class specific request to set the current virtual serial port handshake line states. */
  63                 #define REQ_SetControlLineState      0x22
  64
  65                 /** Notification type constant for a change in the virtual serial port handshake line states, for
  66                  *  use with a USB_Notification_Header_t notification structure when sent to the host via the CDC
  67                  *  notification endpoint.
  68                  */
  69                 #define NOTIF_SerialState            0x20
  70
  71                 /** Mask for the DTR handshake line for use with the REQ_SetControlLineState class specific request
  72                  *  from the host, to indicate that the DTR line state should be high.
  73                  */
  74                 #define CONTROL_LINE_OUT_DTR         (1 << 0)
  75
  76                 /** Mask for the RTS handshake line for use with the REQ_SetControlLineState class specific request
  77                  *  from the host, to indicate that theRTS line state should be high.
  78                  */
  79                 #define CONTROL_LINE_OUT_RTS         (1 << 1)
  80
  81                 /** Mask for the DCD handshake line for use with the a NOTIF_SerialState class specific notification
  82                  *  from the device to the host, to indicate that the DCD line state is currently high.
  83                  */
  84                 #define CONTROL_LINE_IN_DCD          (1 << 0)
  85
  86                 /** Mask for the DSR handshake line for use with the a NOTIF_SerialState class specific notification
  87                  *  from the device to the host, to indicate that the DSR line state is currently high.
  88                  */
  89                 #define CONTROL_LINE_IN_DSR          (1 << 1)
  90
  91                 /** Mask for the BREAK handshake line for use with the a NOTIF_SerialState class specific notification
  92                  *  from the device to the host, to indicate that the BREAK line state is currently high.
  93                  */
  94                 #define CONTROL_LINE_IN_BREAK        (1 << 2)
  95
  96                 /** Mask for the RING handshake line for use with the a NOTIF_SerialState class specific notification
  97                  *  from the device to the host, to indicate that the RING line state is currently high.
  98                  */
  99                 #define CONTROL_LINE_IN_RING         (1 << 3)
 100
 101                 /** Mask for use with the a NOTIF_SerialState class specific notification from the device to the host,
 102                  *  to indicate that a framing error has occurred on the virtual serial port.
 103                  */
 104                 #define CONTROL_LINE_IN_FRAMEERROR   (1 << 4)
 105
 106                 /** Mask for use with the a NOTIF_SerialState class specific notification from the device to the host,
 107                  *  to indicate that a parity error has occurred on the virtual serial port.
 108                  */
 109                 #define CONTROL_LINE_IN_PARITYERROR  (1 << 5)
 110
 111                 /** Mask for use with the a NOTIF_SerialState class specific notification from the device to the host,
 112                  *  to indicate that a data overrun error has occurred on the virtual serial port.
 113                  */
 114                 #define CONTROL_LINE_IN_OVERRUNERROR (1 << 6)
 115
 116         /* Type Defines: */
 117                 /** Type define for the virtual serial port line encoding settings, for storing the current USART configuration
 118                  *  as set by the host via a class specific request.
 119                  */
 120                 typedef struct
 121                 {
 122                         uint32_t BaudRateBPS; /**< Baud rate of the virtual serial port, in bits per second */
 123                         uint8_t  CharFormat; /**< Character format of the virtual serial port, a value from the
 124                                               *   CDCDevice_CDC_LineCodingFormats_t enum
 125                                               */
 126                         uint8_t  ParityType; /**< Parity setting of the virtual serial port, a value from the
 127                                               *   CDCDevice_LineCodingParity_t enum
 128                                               */
 129                         uint8_t  DataBits; /**< Bits of data per character of the virtual serial port */
 130                 } CDC_Line_Coding_t;
 131
 132                 /** Type define for a CDC notification, sent to the host via the CDC notification endpoint to indicate a
 133                  *  change in the device state asynchronously.
 134                  */
 135                 typedef struct
 136                 {
 137                         uint8_t  NotificationType; /**< Notification type, a mask of REQDIR_*, REQTYPE_* and REQREC_* constants
 138                                                     *   from the library StdRequestType.h header
 139                                                     */
 140                         uint8_t  Notification; /**< Notification value, a NOTIF_* constant */
 141                         uint16_t wValue; /**< Notification wValue, notification-specific */
 142                         uint16_t wIndex; /**< Notification wIndex, notification-specific */
 143                         uint16_t wLength; /**< Notification wLength, notification-specific */
 144                 } USB_Notification_Header_t;
 145
 146         /* Enums: */
 147                 /** Enum for the possible line encoding formats of a virtual serial port. */
 148                 enum CDCDevice_CDC_LineCodingFormats_t
 149                 {
 150                         OneStopBit          = 0, /**< Each frame contains one stop bit */
 151                         OneAndAHalfStopBits = 1, /**< Each frame contains one and a half stop bits */
 152                         TwoStopBits         = 2, /**< Each frame contains two stop bits */
 153                 };
 154
 155                 /** Enum for the possible line encoding parity settings of a virtual serial port. */
 156                 enum CDCDevice_LineCodingParity_t
 157                 {
 158                         Parity_None         = 0, /**< No parity bit mode on each frame */
 159                         Parity_Odd          = 1, /**< Odd parity bit mode on each frame */
 160                         Parity_Even         = 2, /**< Even parity bit mode on each frame */
 161                         Parity_Mark         = 3, /**< Mark parity bit mode on each frame */
 162                         Parity_Space        = 4, /**< Space parity bit mode on each frame */
 163                 };
 164
 165                 /** Enum for the possible status codes for passing to the UpdateStatus() function. */
 166                 enum USBtoSerial_StatusCodes_t
 167                 {
 168                         Status_USBNotReady    = 0, /**< USB is not ready (disconnected from a USB host) */
 169                         Status_USBEnumerating = 1, /**< USB interface is enumerating */
 170                         Status_USBReady       = 2, /**< USB interface is connected and ready */
 171                 };
 172
 173         /* Tasks: */
 174                 TASK(CDC_Task);
 175
 176         /* Function Prototypes: */
 177                 void EVENT_USB_Connect(void);
 178                 void EVENT_USB_Disconnect(void);
 179                 void EVENT_USB_ConfigurationChanged(void);
 180                 void EVENT_USB_UnhandledControlPacket(void);
 181
 182                 void ReconfigureUSART(void);
 183                 void UpdateStatus(uint8_t CurrentStatus);
 184
 185 #endif