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