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