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