LUFA/Drivers/USB/Class/Device/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 /** \ingroup Group_USBClassCDC
  32  *  @defgroup Group_USBClassCDCDevice CDC Class Device Mode Driver
  33  *
  34  *  \section Module Description
  35  *  Device Mode USB Class driver framework interface, for the CDC USB Class driver.
  36  *
  37  *  @{
  38  */
  39
  40 #ifndef _CDC_CLASS_DEVICE_H_
  41 #define _CDC_CLASS_DEVICE_H_
  42
  43         /* Includes: */
  44                 #include "../../USB.h"
  45                 #include "../Common/CDC.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         /* Public Interface - May be used in end-application: */
  55                 /* Type Defines: */
  56                         /** Configuration information structure for \ref USB_ClassInfo_CDC_Device_t CDC device interface structures. */
  57                         typedef struct
  58                         {
  59                                 uint8_t  ControlInterfaceNumber; /**< Interface number of the CDC control interface within the device */
  60
  61                                 uint8_t  DataINEndpointNumber; /**< Endpoint number of the CDC interface's IN data endpoint */
  62                                 uint16_t DataINEndpointSize; /**< Size in bytes of the CDC interface's IN data endpoint */
  63
  64                                 uint8_t  DataOUTEndpointNumber; /**< Endpoint number of the CDC interface's OUT data endpoint */
  65                                 uint16_t DataOUTEndpointSize;  /**< Size in bytes of the CDC interface's OUT data endpoint */
  66
  67                                 uint8_t  NotificationEndpointNumber; /**< Endpoint number of the CDC interface's IN notification endpoint, if used */
  68                                 uint16_t NotificationEndpointSize;  /**< Size in bytes of the CDC interface's IN notification endpoint, if used */
  69                         } USB_ClassInfo_CDC_Device_Config_t;
  70
  71                         /** Current State information structure for \ref USB_ClassInfo_CDC_Device_t CDC device interface structures. */
  72                         typedef struct
  73                         {
  74                                 uint8_t  ControlLineState; /**< Current control line states, as set by the host */
  75
  76                                 struct
  77                                 {
  78                                         uint32_t BaudRateBPS; /**< Baud rate of the virtual serial port, in bits per second */
  79                                         uint8_t  CharFormat; /**< Character format of the virtual serial port, a value from the
  80                                                                                   *   CDCDevice_CDC_LineCodingFormats_t enum
  81                                                                                   */
  82                                         uint8_t  ParityType; /**< Parity setting of the virtual serial port, a value from the
  83                                                                                   *   CDCDevice_LineCodingParity_t enum
  84                                                                                   */
  85                                         uint8_t  DataBits; /**< Bits of data per character of the virtual serial port */
  86                                 } LineEncoding;
  87                         } USB_ClassInfo_CDC_Device_State_t;
  88
  89                         /** Class state structure. An instance of this structure should be made for each CDC interface
  90                          *  within the user application, and passed to each of the CDC class driver functions as the
  91                          *  CDCInterfaceInfo parameter. This stores each CDC interface's configuration and state information.
  92                          */
  93                         typedef struct
  94                         {
  95                                 const USB_ClassInfo_CDC_Device_Config_t Config; /**< Config data for the USB class interface within
  96                                                                                  *   the device. All elements in this section
  97                                                                                  *   <b>must</b> be set or the interface will fail
  98                                                                                  *   to enumerate and operate correctly.
  99                                                                                  */
 100
 101                                 USB_ClassInfo_CDC_Device_State_t State; /**< State data for the USB class interface within
 102                                                                          *   the device. All elements in this section
 103                                                                          *   <b>may</b> be set to initial values, but may
 104                                                                          *   also be ignored to default to sane values when
 105                                                                          *   the interface is enumerated.
 106                                                                          */
 107                         } USB_ClassInfo_CDC_Device_t;
 108
 109                 /* Function Prototypes: */
 110                         /** Configures the endpoints of a given CDC interface, ready for use. This should be linked to the library
 111                          *  \ref EVENT_USB_ConfigurationChanged() event so that the endpoints are configured when the configuration containing the
 112                          *  given CDC interface is selected.
 113                          *
 114                          *  \param CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state.
 115                          *
 116                          *  \return Boolean true if the endpoints were sucessfully configured, false otherwise
 117                          */
 118                         bool CDC_Device_ConfigureEndpoints(USB_ClassInfo_CDC_Device_t* CDCInterfaceInfo);
 119
 120                         /** Processes incomming control requests from the host, that are directed to the given CDC class interface. This should be
 121                          *  linked to the library \ref EVENT_USB_UnhandledControlPacket() event.
 122                          *
 123                          *  \param CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state.
 124                          */
 125                         void CDC_Device_ProcessControlPacket(USB_ClassInfo_CDC_Device_t* CDCInterfaceInfo);
 126
 127                         /** General management task for a given CDC class interface, required for the correct operation of the interface. This should
 128                          *  be called frequently in the main program loop, before the master USB management task \ref USB_USBTask().
 129                          *
 130                          *  \param CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state.
 131                          */
 132                         void CDC_Device_USBTask(USB_ClassInfo_CDC_Device_t* CDCInterfaceInfo);
 133
 134                         /** CDC class driver event for a line encoding change on a CDC interface. This event fires each time the host requests a
 135                          *  line encoding change (containing the serial parity, baud and other configuration information) and may be hooked in the
 136                          *  user program by declaring a handler function with the same name and parameters listed here. The new line encoding
 137                          *  settings are available in the LineEncoding structure inside the CDC interface structure passed as a parameter.
 138                          *
 139                          *  \param CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state.
 140                          */
 141                         void EVENT_CDC_Device_LineEncodingChanged(USB_ClassInfo_CDC_Device_t* CDCInterfaceInfo);
 142
 143                         /** CDC class driver event for a control line state change on a CDC interface. This event fires each time the host requests a
 144                          *  control line state change (containing the virtual serial control line states, such as DTR) and may be hooked in the
 145                          *  user program by declaring a handler function with the same name and parameters listed here. The new control line states
 146                          *  are available in the ControlLineState value inside the CDC interface structure passed as a parameter, set as a mask of
 147                          *  CDC_CONTROL_LINE_OUT_* masks.
 148                          *
 149                          *  \param CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state.
 150                          */
 151                         void EVENT_CDC_Device_ControLineStateChanged(USB_ClassInfo_CDC_Device_t* CDCInterfaceInfo);
 152
 153                         /** Sends a given string to the attached USB host, if connected. If a host is not connected when the function is called, the
 154                          *  string is discarded.
 155                          *
 156                          *  \param CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state.
 157                          *  \param Data  Pointer to the string to send to the host
 158                          *  \param Length  Size in bytes of the string to send to the host
 159                          */
 160                         void CDC_Device_SendString(USB_ClassInfo_CDC_Device_t* CDCInterfaceInfo, char* Data, uint16_t Length);
 161
 162                         /** Sends a given byte to the attached USB host, if connected. If a host is not connected when the function is called, the
 163                          *  byte is discarded.
 164                          *
 165                          *  \param CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state.
 166                          *  \param Data  Byte of data to send to the host
 167                          */
 168                         void CDC_Device_SendByte(USB_ClassInfo_CDC_Device_t* CDCInterfaceInfo, uint8_t Data);
 169
 170                         /** Determines the number of bytes received by the CDC interface from the host, waiting to be read.
 171                          *
 172                          *  \param CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state.
 173                          *
 174                          *  \return Total number of buffered bytes received from the host
 175                          */
 176                         uint16_t CDC_Device_BytesReceived(USB_ClassInfo_CDC_Device_t* CDCInterfaceInfo);
 177
 178                         /** Reads a byte of data from the host. If no data is waiting to be read of if a USB host is not connected, the function
 179                          *  returns 0. The USB_CDC_BytesReceived() function should be queried before data is recieved to ensure that no data
 180                          *  underflow occurs.
 181                          *
 182                          *  \param CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state.
 183                          *
 184                          *  \return Next received byte from the host, or 0 if no data received
 185                          */
 186                         uint8_t CDC_Device_ReceiveByte(USB_ClassInfo_CDC_Device_t* CDCInterfaceInfo);
 187
 188                         /** Sends a Serial Control Line State Change notification to the host. This should be called when the virtual serial control
 189                          *  lines (DCD, DSR, etc.) have changed states, or to give BREAK notfications to the host. Line states persist until they are
 190                          *  cleared via a second notification.
 191                          *
 192                          *  \param CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state.
 193                          *  \param LineStateMask  Mask of CDC_CONTROL_LINE_IN_* masks giving the current control line states
 194                          */
 195                         void CDC_Device_SendControlLineStateChange(USB_ClassInfo_CDC_Device_t* CDCInterfaceInfo, uint16_t LineStateMask);
 196
 197         /* Private Interface - For use in library only: */
 198         #if !defined(__DOXYGEN__)
 199                 /* Function Prototypes: */
 200                         #if defined(INCLUDE_FROM_CDC_CLASS_DEVICE_C)
 201                                 void CDC_Device_Event_Stub(void);
 202                                 void EVENT_CDC_Device_LineEncodingChanged(USB_ClassInfo_CDC_Device_t* CDCInterfaceInfo)
 203                                                                                                                   ATTR_WEAK ATTR_ALIAS(CDC_Device_Event_Stub);
 204                                 void EVENT_CDC_Device_ControLineStateChanged(USB_ClassInfo_CDC_Device_t* CDCInterfaceInfo)
 205                                                                                                                          ATTR_WEAK ATTR_ALIAS(CDC_Device_Event_Stub);
 206                         #endif
 207
 208         #endif
 209
 210         /* Disable C linkage for C++ Compilers: */
 211                 #if defined(__cplusplus)
 212                         }
 213                 #endif
 214
 215 #endif
 216
 217 /** @} */