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