LUFA/Drivers/USB/Class/Device/CDC.h

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2011.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2011  Dean Camera (dean [at] fourwalledcubicle [dot] com)
  11
  12   Permission to use, copy, modify, distribute, and sell this
  13   software and its documentation for any purpose is hereby granted
  14   without fee, provided that the above copyright notice appear in
  15   all 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  *  \brief Device mode driver for the library USB CDC Class driver.
  33  *
  34  *  Device mode driver for the library USB CDC Class driver.
  35  *
  36  *  \note This file should not be included directly. It is automatically included as needed by the USB module driver
  37  *        dispatch header located in LUFA/Drivers/USB.h.
  38  */
  39
  40 /** \ingroup Group_USBClassCDC
  41  *  \defgroup Group_USBClassCDCDevice CDC Class Device Mode Driver
  42  *
  43  *  \section Sec_Dependencies Module Source Dependencies
  44  *  The following files must be built with any user project that uses this module:
  45  *    - LUFA/Drivers/USB/Class/Device/CDC.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i>
  46  *
  47  *  \section Sec_ModDescription Module Description
  48  *  Device Mode USB Class driver framework interface, for the CDC USB Class driver.
  49  *
  50  *  \note There are several major drawbacks to the CDC-ACM standard USB class, however
  51  *        it is very standardized and thus usually available as a built-in driver on
  52  *        most platforms, and so is a better choice than a proprietary serial class.
  53  *
  54  *        One major issue with CDC-ACM is that it requires two Interface descriptors,
  55  *        which will upset most hosts when part of a multi-function "Composite" USB
  56  *        device, as each interface will be loaded into a separate driver instance. To
  57  *        combat this, you should use the "Interface Association Descriptor" addendum to
  58  *        the USB standard which is available on most OSes when creating Composite devices.
  59  *
  60  *        Another major oversight is that there is no mechanism for the host to notify the
  61  *        device that there is a data sink on the host side ready to accept data. This
  62  *        means that the device may try to send data while the host isn't listening, causing
  63  *        lengthy blocking timeouts in the transmission routines. To combat this, it is
  64  *        recommended that the virtual serial line DTR (Data Terminal Ready) be used where
  65  *        possible to determine if a host application is ready for data.
  66  *
  67  *  @{
  68  */
  69
  70 #ifndef _CDC_CLASS_DEVICE_H_
  71 #define _CDC_CLASS_DEVICE_H_
  72
  73         /* Includes: */
  74                 #include "../../USB.h"
  75                 #include "../Common/CDC.h"
  76
  77                 #include <stdio.h>
  78
  79         /* Enable C linkage for C++ Compilers: */
  80                 #if defined(__cplusplus)
  81                         extern "C" {
  82                 #endif
  83
  84         /* Preprocessor Checks: */
  85                 #if !defined(__INCLUDE_FROM_CDC_DRIVER)
  86                         #error Do not include this file directly. Include LUFA/Drivers/USB.h instead.
  87                 #endif
  88
  89         /* Public Interface - May be used in end-application: */
  90                 /* Type Defines: */
  91                         /** \brief CDC Class Device Mode Configuration and State Structure.
  92                          *
  93                          *  Class state structure. An instance of this structure should be made for each CDC interface
  94                          *  within the user application, and passed to each of the CDC class driver functions as the
  95                          *  CDCInterfaceInfo parameter. This stores each CDC interface's configuration and state information.
  96                          */
  97                         typedef struct
  98                         {
  99                                 const struct
 100                                 {
 101                                         uint8_t  ControlInterfaceNumber; /**< Interface number of the CDC control interface within the device. */
 102
 103                                         uint8_t  DataINEndpointNumber; /**< Endpoint number of the CDC interface's IN data endpoint. */
 104                                         uint16_t DataINEndpointSize; /**< Size in bytes of the CDC interface's IN data endpoint. */
 105                                         bool     DataINEndpointDoubleBank; /**< Indicates if the CDC interface's IN data endpoint should use double banking. */
 106
 107                                         uint8_t  DataOUTEndpointNumber; /**< Endpoint number of the CDC interface's OUT data endpoint. */
 108                                         uint16_t DataOUTEndpointSize;  /**< Size in bytes of the CDC interface's OUT data endpoint. */
 109                                         bool     DataOUTEndpointDoubleBank; /**< Indicates if the CDC interface's OUT data endpoint should use double banking. */
 110
 111                                         uint8_t  NotificationEndpointNumber; /**< Endpoint number of the CDC interface's IN notification endpoint, if used. */
 112                                         uint16_t NotificationEndpointSize;  /**< Size in bytes of the CDC interface's IN notification endpoint, if used. */
 113                                         bool     NotificationEndpointDoubleBank; /**< Indicates if the CDC interface's notification endpoint should use double banking. */
 114                                 } Config; /**< Config data for the USB class interface within the device. All elements in this section
 115                                            *   <b>must</b> be set or the interface will fail to enumerate and operate correctly.
 116                                            */
 117                                 struct
 118                                 {
 119                                         struct
 120                                         {
 121                                                 uint16_t HostToDevice; /**< Control line states from the host to device, as a set of \c CDC_CONTROL_LINE_OUT_*
 122                                                                                             *   masks. This value is updated each time \ref CDC_Device_USBTask() is called.
 123                                                                                             */
 124                                                 uint16_t DeviceToHost; /**< Control line states from the device to host, as a set of \c CDC_CONTROL_LINE_IN_*
 125                                                                                             *   masks - to notify the host of changes to these values, call the
 126                                                                                             *   \ref CDC_Device_SendControlLineStateChange() function.
 127                                                                                             */
 128                                         } ControlLineStates; /**< Current states of the virtual serial port's control lines between the device and host. */
 129
 130                                         CDC_LineEncoding_t LineEncoding; /** Line encoding used in the virtual serial port, for the device's information.
 131                                                                           *  This is generally only used if the virtual serial port data is to be
 132                                                                           *  reconstructed on a physical UART.
 133                                                                           */
 134                                 } State; /**< State data for the USB class interface within the device. All elements in this section
 135                                           *   are reset to their defaults when the interface is enumerated.
 136                                           */
 137                         } USB_ClassInfo_CDC_Device_t;
 138
 139                 /* Function Prototypes: */
 140                         /** Configures the endpoints of a given CDC interface, ready for use. This should be linked to the library
 141                          *  \ref EVENT_USB_Device_ConfigurationChanged() event so that the endpoints are configured when the configuration containing
 142                          *  the given CDC interface is selected.
 143                          *
 144                          *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state.
 145                          *
 146                          *  \return Boolean \c true if the endpoints were successfully configured, \c false otherwise.
 147                          */
 148                         bool CDC_Device_ConfigureEndpoints(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 149
 150                         /** Processes incoming control requests from the host, that are directed to the given CDC class interface. This should be
 151                          *  linked to the library \ref EVENT_USB_Device_ControlRequest() event.
 152                          *
 153                          *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state.
 154                          */
 155                         void CDC_Device_ProcessControlRequest(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 156
 157                         /** General management task for a given CDC class interface, required for the correct operation of the interface. This should
 158                          *  be called frequently in the main program loop, before the master USB management task \ref USB_USBTask().
 159                          *
 160                          *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state.
 161                          */
 162                         void CDC_Device_USBTask(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 163
 164                         /** CDC class driver event for a line encoding change on a CDC interface. This event fires each time the host requests a
 165                          *  line encoding change (containing the serial parity, baud and other configuration information) and may be hooked in the
 166                          *  user program by declaring a handler function with the same name and parameters listed here. The new line encoding
 167                          *  settings are available in the LineEncoding structure inside the CDC interface structure passed as a parameter.
 168                          *
 169                          *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state.
 170                          */
 171                         void EVENT_CDC_Device_LineEncodingChanged(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 172
 173                         /** CDC class driver event for a control line state change on a CDC interface. This event fires each time the host requests a
 174                          *  control line state change (containing the virtual serial control line states, such as DTR) and may be hooked in the
 175                          *  user program by declaring a handler function with the same name and parameters listed here. The new control line states
 176                          *  are available in the State.ControlLineStates.HostToDevice value inside the CDC interface structure passed as a parameter, set as
 177                          *  a mask of CDC_CONTROL_LINE_OUT_* masks.
 178                          *
 179                          *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state.
 180                          */
 181                         void EVENT_CDC_Device_ControLineStateChanged(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 182
 183                         /** CDC class driver event for a send break request sent to the device from the host. This is generally used to separate
 184                          *  data or to indicate a special condition to the receiving device.
 185                          *
 186                          *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state.
 187                          *  \param[in]     Duration          Duration of the break that has been sent by the host, in milliseconds.
 188                          */
 189                         void EVENT_CDC_Device_BreakSent(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo,
 190                                                         const uint8_t Duration) ATTR_NON_NULL_PTR_ARG(1);
 191
 192                         /** Sends a given data buffer to the attached USB host, if connected. If a host is not connected when the function is
 193                          *  called, the string is discarded. Bytes will be queued for transmission to the host until either the endpoint bank
 194                          *  becomes full, or the \ref CDC_Device_Flush() function is called to flush the pending data to the host. This allows
 195                          *  for multiple bytes to be packed into a single endpoint packet, increasing data throughput.
 196                          *
 197                          *  \pre This function must only be called when the Device state machine is in the \ref DEVICE_STATE_Configured state or
 198                          *       the call will fail.
 199                          *
 200                          *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state.
 201                          *  \param[in]     Buffer            Pointer to a buffer containing the data to send to the device.
 202                          *  \param[in]     Length            Length of the data to send to the host.
 203                          *
 204                          *  \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum.
 205                          */
 206                         uint8_t CDC_Device_SendData(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo,
 207                                                     const char* const Buffer,
 208                                                     const uint16_t Length) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);
 209
 210                         /** Sends a given null terminated string to the attached USB host, if connected. If a host is not connected when
 211                          *  the function is called, the string is discarded. Bytes will be queued for transmission to the host until either
 212                          *  the endpoint bank becomes full, or the \ref CDC_Device_Flush() function is called to flush the pending data to
 213                          *  the host. This allows for multiple bytes to be packed into a single endpoint packet, increasing data throughput.
 214                          *
 215                          *  \pre This function must only be called when the Device state machine is in the \ref DEVICE_STATE_Configured state or
 216                          *       the call will fail.
 217                          *
 218                          *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state.
 219                          *  \param[in]     String            Pointer to the null terminated string to send to the host.
 220                          *
 221                          *  \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum.
 222                          */
 223                         uint8_t CDC_Device_SendString(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo,
 224                                                       const char* const String) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);
 225
 226                         /** Sends a given byte to the attached USB host, if connected. If a host is not connected when the function is called, the
 227                          *  byte is discarded. Bytes will be queued for transmission to the host until either the endpoint bank becomes full, or the
 228                          *  \ref CDC_Device_Flush() function is called to flush the pending data to the host. This allows for multiple bytes to be
 229                          *  packed into a single endpoint packet, increasing data throughput.
 230                          *
 231                          *  \pre This function must only be called when the Device state machine is in the \ref DEVICE_STATE_Configured state or
 232                          *       the call will fail.
 233                          *
 234                          *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state.
 235                          *  \param[in]     Data              Byte of data to send to the host.
 236                          *
 237                          *  \return A value from the \ref Endpoint_WaitUntilReady_ErrorCodes_t enum.
 238                          */
 239                         uint8_t CDC_Device_SendByte(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo,
 240                                                     const uint8_t Data) ATTR_NON_NULL_PTR_ARG(1);
 241
 242                         /** Determines the number of bytes received by the CDC interface from the host, waiting to be read. This indicates the number
 243                          *  of bytes in the OUT endpoint bank only, and thus the number of calls to \ref CDC_Device_ReceiveByte() which are guaranteed to
 244                          *  succeed immediately. If multiple bytes are to be received, they should be buffered by the user application, as the endpoint
 245                          *  bank will not be released back to the USB controller until all bytes are read.
 246                          *
 247                          *  \pre This function must only be called when the Device state machine is in the \ref DEVICE_STATE_Configured state or
 248                          *       the call will fail.
 249                          *
 250                          *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state.
 251                          *
 252                          *  \return Total number of buffered bytes received from the host.
 253                          */
 254                         uint16_t CDC_Device_BytesReceived(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 255
 256                         /** 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
 257                          *  returns a negative value. The \ref CDC_Device_BytesReceived() function may be queried in advance to determine how many
 258                          *  bytes are currently buffered in the CDC interface's data receive endpoint bank, and thus how many repeated calls to this
 259                          *  function which are guaranteed to succeed.
 260                          *
 261                          *  \pre This function must only be called when the Device state machine is in the \ref DEVICE_STATE_Configured state or
 262                          *       the call will fail.
 263                          *
 264                          *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state.
 265                          *
 266                          *  \return Next received byte from the host, or a negative value if no data received.
 267                          */
 268                         int16_t CDC_Device_ReceiveByte(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 269
 270                         /** Flushes any data waiting to be sent, ensuring that the send buffer is cleared.
 271                          *
 272                          *  \pre This function must only be called when the Device state machine is in the \ref DEVICE_STATE_Configured state or
 273                          *       the call will fail.
 274                          *
 275                          *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state.
 276                          *
 277                          *  \return A value from the \ref Endpoint_WaitUntilReady_ErrorCodes_t enum.
 278                          */
 279                         uint8_t CDC_Device_Flush(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 280
 281                         /** Sends a Serial Control Line State Change notification to the host. This should be called when the virtual serial
 282                          *  control lines (DCD, DSR, etc.) have changed states, or to give BREAK notifications to the host. Line states persist
 283                          *  until they are cleared via a second notification. This should be called each time the CDC class driver's
 284                          *  ControlLineStates.DeviceToHost value is updated to push the new states to the USB host.
 285                          *
 286                          *  \pre This function must only be called when the Device state machine is in the \ref DEVICE_STATE_Configured state or
 287                          *       the call will fail.
 288                          *
 289                          *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state.
 290                          */
 291                         void CDC_Device_SendControlLineStateChange(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 292
 293                         /** Creates a standard character stream for the given CDC Device instance so that it can be used with all the regular
 294                          *  functions in the standard <stdio.h> library that accept a \c FILE stream as a destination (e.g. \c fprintf). The created
 295                          *  stream is bidirectional and can be used for both input and output functions.
 296                          *
 297                          *  Reading data from this stream is non-blocking, i.e. in most instances, complete strings cannot be read in by a single
 298                          *  fetch, as the endpoint will not be ready at some point in the transmission, aborting the transfer. However, this may
 299                          *  be used when the read data is processed byte-per-bye (via \c getc()) or when the user application will implement its own
 300                          *  line buffering.
 301                          *
 302                          *  \note The created stream can be given as stdout if desired to direct the standard output from all <stdio.h> functions
 303                          *        to the given CDC interface.
 304                          *        \n\n
 305                          *
 306                          *  \note This function is not available on all microcontroller architectures.
 307                          *
 308                          *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state.
 309                          *  \param[in,out] Stream            Pointer to a FILE structure where the created stream should be placed.
 310                          */
 311                         void CDC_Device_CreateStream(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo,
 312                                                      FILE* const Stream) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);
 313
 314                         /** Identical to \ref CDC_Device_CreateStream(), except that reads are blocking until the calling stream function terminates
 315                          *  the transfer. While blocking, the USB and CDC service tasks are called repeatedly to maintain USB communications.
 316                          *
 317                          *  \note This function is not available on all microcontroller architectures.
 318                          *
 319                          *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state.
 320                          *  \param[in,out] Stream            Pointer to a FILE structure where the created stream should be placed.
 321                          */
 322                         void CDC_Device_CreateBlockingStream(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo,
 323                                                              FILE* const Stream) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);
 324
 325         /* Private Interface - For use in library only: */
 326         #if !defined(__DOXYGEN__)
 327                 /* Function Prototypes: */
 328                         #if defined(__INCLUDE_FROM_CDC_DEVICE_C)
 329                                 #if defined(FDEV_SETUP_STREAM)
 330                                 static int CDC_Device_putchar(char c,
 331                                                               FILE* Stream) ATTR_NON_NULL_PTR_ARG(2);
 332                                 static int CDC_Device_getchar(FILE* Stream) ATTR_NON_NULL_PTR_ARG(1);
 333                                 static int CDC_Device_getchar_Blocking(FILE* Stream) ATTR_NON_NULL_PTR_ARG(1);
 334                                 #endif
 335
 336                                 void CDC_Device_Event_Stub(void) ATTR_CONST;
 337
 338                                 void EVENT_CDC_Device_LineEncodingChanged(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo)
 339                                                                           ATTR_WEAK ATTR_NON_NULL_PTR_ARG(1) ATTR_ALIAS(CDC_Device_Event_Stub);
 340                                 void EVENT_CDC_Device_ControLineStateChanged(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo)
 341                                                                              ATTR_WEAK ATTR_NON_NULL_PTR_ARG(1) ATTR_ALIAS(CDC_Device_Event_Stub);
 342                                 void EVENT_CDC_Device_BreakSent(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo,
 343                                                                 const uint8_t Duration) ATTR_WEAK ATTR_NON_NULL_PTR_ARG(1)
 344                                                                 ATTR_ALIAS(CDC_Device_Event_Stub);
 345                         #endif
 346
 347         #endif
 348
 349         /* Disable C linkage for C++ Compilers: */
 350                 #if defined(__cplusplus)
 351                         }
 352                 #endif
 353
 354 #endif
 355
 356 /** @} */
 357