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