tmk_core/protocol/lufa/LUFA-git/LUFA/Drivers/USB/Class/Device/CDCClassDevice.h

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