LUFA/Drivers/USB/Class/Host/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 Host mode driver for the library USB CDC Class driver.
  33  *
  34  *  Host 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_USBClassCDCHost CDC Class Host 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/Host/CDC.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i>
  46  *
  47  *  \section Sec_ModDescription Module Description
  48  *  Host Mode USB Class driver framework interface, for the CDC USB Class driver.
  49  *
  50  *  @{
  51  */
  52
  53 #ifndef __CDC_CLASS_HOST_H__
  54 #define __CDC_CLASS_HOST_H__
  55
  56         /* Includes: */
  57                 #include "../../USB.h"
  58                 #include "../Common/CDC.h"
  59
  60                 #include <stdio.h>
  61
  62         /* Enable C linkage for C++ Compilers: */
  63                 #if defined(__cplusplus)
  64                         extern "C" {
  65                 #endif
  66
  67         /* Preprocessor Checks: */
  68                 #if !defined(__INCLUDE_FROM_CDC_DRIVER)
  69                         #error Do not include this file directly. Include LUFA/Drivers/USB.h instead.
  70                 #endif
  71
  72         /* Public Interface - May be used in end-application: */
  73                 /* Type Defines: */
  74                         /** \brief CDC Class Host Mode Configuration and State Structure.
  75                          *
  76                          *  Class state structure. An instance of this structure should be made within the user application,
  77                          *  and passed to each of the CDC class driver functions as the \c CDCInterfaceInfo parameter. This
  78                          *  stores each CDC interface's configuration and state information.
  79                          */
  80                         typedef struct
  81                         {
  82                                 const struct
  83                                 {
  84                                         uint8_t  DataINPipeNumber; /**< Pipe number of the CDC interface's IN data pipe. */
  85                                         bool     DataINPipeDoubleBank; /**< Indicates if the CDC interface's IN data pipe should use double banking. */
  86
  87                                         uint8_t  DataOUTPipeNumber; /**< Pipe number of the CDC interface's OUT data pipe. */
  88                                         bool     DataOUTPipeDoubleBank; /**< Indicates if the CDC interface's OUT data pipe should use double banking. */
  89
  90                                         uint8_t  NotificationPipeNumber; /**< Pipe number of the CDC interface's IN notification endpoint, if used. */
  91                                         bool     NotificationPipeDoubleBank; /**< Indicates if the CDC interface's notification pipe should use double banking. */
  92                                 } Config; /**< Config data for the USB class interface within the device. All elements in this section
  93                                            *   <b>must</b> be set or the interface will fail to enumerate and operate correctly.
  94                                            */
  95                                 struct
  96                                 {
  97                                         bool IsActive; /**< Indicates if the current interface instance is connected to an attached device, valid
  98                                                         *   after \ref CDC_Host_ConfigurePipes() is called and the Host state machine is in the
  99                                                         *   Configured state.
 100                                                         */
 101                                         uint8_t  ControlInterfaceNumber; /**< Interface index of the CDC-ACM control interface within the attached device. */
 102
 103                                         uint16_t DataINPipeSize; /**< Size in bytes of the CDC interface's IN data pipe. */
 104                                         uint16_t DataOUTPipeSize;  /**< Size in bytes of the CDC interface's OUT data pipe. */
 105                                         uint16_t NotificationPipeSize;  /**< Size in bytes of the CDC interface's IN notification pipe, if used. */
 106
 107                                         struct
 108                                         {
 109                                                 uint8_t HostToDevice; /**< Control line states from the host to device, as a set of \c CDC_CONTROL_LINE_OUT_*
 110                                                                                            *   masks - to notify the device of changes to these values, call the
 111                                                                                            *   \ref CDC_Host_SendControlLineStateChange() function.
 112                                                                                            */
 113                                                 uint8_t DeviceToHost; /**< Control line states from the device to host, as a set of \c CDC_CONTROL_LINE_IN_*
 114                                                                                            *   masks. This value is updated each time \ref CDC_Host_USBTask() is called.
 115                                                                                            */
 116                                         } ControlLineStates; /**< Current states of the virtual serial port's control lines between the device and host. */
 117
 118                                         CDC_LineEncoding_t LineEncoding; /**< Line encoding used in the virtual serial port, for the device's information.
 119                                                                           *   This is generally only used if the virtual serial port data is to be
 120                                                                           *   reconstructed on a physical UART. When set by the host application, the
 121                                                                           *   \ref CDC_Host_SetLineEncoding() function must be called to push the changes
 122                                                                           *   to the device.
 123                                                                           */
 124                                 } State; /**< State data for the USB class interface within the device. All elements in this section
 125                                                   *   <b>may</b> be set to initial values, but may also be ignored to default to sane values when
 126                                                   *   the interface is enumerated.
 127                                                   */
 128                         } USB_ClassInfo_CDC_Host_t;
 129
 130                 /* Enums: */
 131                         /** Enum for the possible error codes returned by the \ref CDC_Host_ConfigurePipes() function. */
 132                         enum CDC_Host_EnumerationFailure_ErrorCodes_t
 133                         {
 134                                 CDC_ENUMERROR_NoError                    = 0, /**< Configuration Descriptor was processed successfully. */
 135                                 CDC_ENUMERROR_InvalidConfigDescriptor    = 1, /**< The device returned an invalid Configuration Descriptor. */
 136                                 CDC_ENUMERROR_NoCompatibleInterfaceFound = 2, /**< A compatible CDC interface was not found in the device's Configuration Descriptor. */
 137                                 CDC_ENUMERROR_PipeConfigurationFailed    = 3, /**< One or more pipes for the specified interface could not be configured correctly. */
 138                         };
 139
 140                 /* Function Prototypes: */
 141                         /** General management task for a given CDC host class interface, required for the correct operation of the interface. This should
 142                          *  be called frequently in the main program loop, before the master USB management task \ref USB_USBTask().
 143                          *
 144                          *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing an CDC Class host configuration and state.
 145                          */
 146                         void CDC_Host_USBTask(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 147
 148                         /** Host interface configuration routine, to configure a given CDC host interface instance using the Configuration
 149                          *  Descriptor read from an attached USB device. This function automatically updates the given CDC Host instance's
 150                          *  state values and configures the pipes required to communicate with the interface if it is found within the device.
 151                          *  This should be called once after the stack has enumerated the attached device, while the host state machine is in
 152                          *  the Addressed state.
 153                          *
 154                          *  \note The pipe index numbers as given in the interface's configuration structure must not overlap with any other
 155                          *        interface, or pipe bank corruption will occur. Gaps in the allocated pipe numbers or non-sequential indexes
 156                          *        within a single interface is allowed, but no two interfaces of any type have have interleaved pipe indexes.
 157                          *
 158                          *  \param[in,out] CDCInterfaceInfo        Pointer to a structure containing an CDC Class host configuration and state.
 159                          *  \param[in]     ConfigDescriptorSize    Length of the attached device's Configuration Descriptor.
 160                          *  \param[in]     DeviceConfigDescriptor  Pointer to a buffer containing the attached device's Configuration Descriptor.
 161                          *
 162                          *  \return A value from the \ref CDC_Host_EnumerationFailure_ErrorCodes_t enum.
 163                          */
 164                         uint8_t CDC_Host_ConfigurePipes(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo,
 165                                                         uint16_t ConfigDescriptorSize,
 166                                                         void* DeviceConfigDescriptor) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(3);
 167
 168                         /** Sets the line encoding for the attached device's virtual serial port. This should be called when the \c LineEncoding
 169                          *  values of the interface have been changed to push the new settings to the USB device.
 170                          *
 171                          *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class host configuration and state.
 172                          *
 173                          *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum.
 174                          */
 175                         uint8_t CDC_Host_SetLineEncoding(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 176
 177                         /** Sends a Serial Control Line State Change notification to the device. This should be called when the virtual serial
 178                          *  control lines (DTR, RTS, etc.) have changed states. Line states persist until they are cleared via a second
 179                          *  notification. This should be called each time the CDC class driver's \c ControlLineStates.HostToDevice value is updated
 180                          *  to push the new states to the USB device.
 181                          *
 182                          *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class host configuration and state.
 183                          *
 184                          *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum.
 185                          */
 186                         uint8_t CDC_Host_SendControlLineStateChange(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 187
 188                         /** Sends a Send Break request to the device. This is generally used to separate data data or to indicate a special condition
 189                          *  to the receiving device.
 190                          *
 191                          *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class host configuration and state.
 192                          *  \param[in]     Duration          Duration of the break, in milliseconds.
 193                          *
 194                          *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum.
 195                          */
 196                         uint8_t CDC_Host_SendBreak(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo,
 197                                                    const uint8_t Duration) ATTR_NON_NULL_PTR_ARG(1);
 198
 199                         /** Sends a given data buffer to the attached USB device, if connected. If a device is not connected when the function is
 200                          *  called, the data will be discarded. Bytes will be queued for transmission to the device until either the pipe bank
 201                          *  becomes full, or the \ref CDC_Host_Flush() function is called to flush the pending data to the device. This allows for
 202                          *  multiple bytes to be packed into a single pipe packet, increasing data throughput.
 203                          *
 204                          *  \pre This function must only be called when the Host state machine is in the \ref HOST_STATE_Configured state or the
 205                          *       call will fail.
 206                          *
 207                          *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class host configuration and state.
 208                          *  \param[in]     Buffer            Pointer to a buffer containing the data to send to the device.
 209                          *  \param[in]     Length            Length of the data to send to the device.
 210                          *
 211                          *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.
 212                          */
 213                         uint8_t CDC_Host_SendData(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo,
 214                                                   const uint8_t* const Buffer,
 215                                                   const uint16_t Length);
 216
 217                         /** Sends a given null-terminated string to the attached USB device, if connected. If a device is not connected when the
 218                          *  function is called, the string is discarded. Bytes will be queued for transmission to the device until either the pipe
 219                          *  bank becomes full, or the \ref CDC_Host_Flush() function is called to flush the pending data to the device. This allows
 220                          *  for multiple bytes to be packed into a single pipe packet, increasing data throughput.
 221                          *
 222                          *  \pre This function must only be called when the Host state machine is in the \ref HOST_STATE_Configured state or the
 223                          *       call will fail.
 224                          *
 225                          *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class host configuration and state.
 226                          *  \param[in]     String            Pointer to the null terminated string to send to the device.
 227                          *
 228                          *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.
 229                          */
 230                         uint8_t CDC_Host_SendString(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo,
 231                                                     const char* const String) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);
 232
 233                         /** Sends a given byte to the attached USB device, if connected. If a device is not connected when the function is called, the
 234                          *  byte is discarded. Bytes will be queued for transmission to the device until either the pipe bank becomes full, or the
 235                          *  \ref CDC_Host_Flush() function is called to flush the pending data to the host. This allows for multiple bytes to be
 236                          *  packed into a single pipe packet, increasing data throughput.
 237                          *
 238                          *  \pre This function must only be called when the Host state machine is in the \ref HOST_STATE_Configured state or the
 239                          *       call will fail.
 240                          *
 241                          *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class host configuration and state.
 242                          *  \param[in]     Data              Byte of data to send to the device.
 243                          *
 244                          *  \return A value from the \ref Pipe_WaitUntilReady_ErrorCodes_t enum.
 245                          */
 246                         uint8_t CDC_Host_SendByte(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo,
 247                                                   const uint8_t Data) ATTR_NON_NULL_PTR_ARG(1);
 248
 249                         /** Determines the number of bytes received by the CDC interface from the device, waiting to be read. This indicates the number
 250                          *  of bytes in the IN pipe bank only, and thus the number of calls to \ref CDC_Host_ReceiveByte() which are guaranteed to succeed
 251                          *  immediately. If multiple bytes are to be received, they should be buffered by the user application, as the pipe bank will not be
 252                          *  released back to the USB controller until all bytes are read.
 253                          *
 254                          *  \pre This function must only be called when the Host state machine is in the \ref HOST_STATE_Configured state or the
 255                          *       call will fail.
 256                          *
 257                          *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class host configuration and state.
 258                          *
 259                          *  \return Total number of buffered bytes received from the device.
 260                          */
 261                         uint16_t CDC_Host_BytesReceived(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 262
 263                         /** Reads a byte of data from the device. If no data is waiting to be read of if a USB device is not connected, the function
 264                          *  returns a negative value. The \ref CDC_Host_BytesReceived() function may be queried in advance to determine how many bytes
 265                          *  are currently buffered in the CDC interface's data receive pipe.
 266                          *
 267                          *  \pre This function must only be called when the Host state machine is in the \ref HOST_STATE_Configured state or the
 268                          *       call will fail.
 269                          *
 270                          *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class host configuration and state.
 271                          *
 272                          *  \return Next received byte from the device, or a negative value if no data received.
 273                          */
 274                         int16_t CDC_Host_ReceiveByte(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 275
 276                         /** Flushes any data waiting to be sent, ensuring that the send buffer is cleared.
 277                          *
 278                          *  \pre This function must only be called when the Host state machine is in the \ref HOST_STATE_Configured state or the
 279                          *       call will fail.
 280                          *
 281                          *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class host configuration and state.
 282                          *
 283                          *  \return A value from the \ref Pipe_WaitUntilReady_ErrorCodes_t enum.
 284                          */
 285                         uint8_t CDC_Host_Flush(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 286
 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 \c <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 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_Host_CreateStream(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo,
 306                                                    FILE* const Stream);
 307
 308                         /** Identical to \ref CDC_Host_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_Host_CreateBlockingStream(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo,
 317                                                            FILE* const Stream);
 318
 319                         /** CDC class driver event for a control line state change on a CDC host interface. This event fires each time the device notifies
 320                          *  the host of a control line state change (containing the virtual serial control line states, such as DCD) and may be hooked in the
 321                          *  user program by declaring a handler function with the same name and parameters listed here. The new control line states
 322                          *  are available in the ControlLineStates.DeviceToHost value inside the CDC host interface structure passed as a parameter, set as
 323                          *  a mask of \c CDC_CONTROL_LINE_IN_* masks.
 324                          *
 325                          *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class host configuration and state.
 326                          */
 327                         void EVENT_CDC_Host_ControLineStateChanged(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 328
 329         /* Private Interface - For use in library only: */
 330         #if !defined(__DOXYGEN__)
 331                 /* Function Prototypes: */
 332                         #if defined(__INCLUDE_FROM_CDC_HOST_C)
 333                                 #if defined(FDEV_SETUP_STREAM)
 334                                 static int CDC_Host_putchar(char c,
 335                                                             FILE* Stream) ATTR_NON_NULL_PTR_ARG(2);
 336                                 static int CDC_Host_getchar(FILE* Stream) ATTR_NON_NULL_PTR_ARG(1);
 337                                 static int CDC_Host_getchar_Blocking(FILE* Stream) ATTR_NON_NULL_PTR_ARG(1);
 338                                 #endif
 339
 340                                 void CDC_Host_Event_Stub(void) ATTR_CONST;
 341                                 void EVENT_CDC_Host_ControLineStateChanged(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo)
 342                                                                            ATTR_WEAK ATTR_NON_NULL_PTR_ARG(1) ATTR_ALIAS(CDC_Host_Event_Stub);
 343
 344                                 static uint8_t DCOMP_CDC_Host_NextCDCControlInterface(void* const CurrentDescriptor) ATTR_NON_NULL_PTR_ARG(1);
 345                                 static uint8_t DCOMP_CDC_Host_NextCDCDataInterface(void* const CurrentDescriptor) ATTR_NON_NULL_PTR_ARG(1);
 346                                 static uint8_t DCOMP_CDC_Host_NextCDCInterfaceEndpoint(void* const CurrentDescriptor) ATTR_NON_NULL_PTR_ARG(1);
 347                         #endif
 348         #endif
 349
 350         /* Disable C linkage for C++ Compilers: */
 351                 #if defined(__cplusplus)
 352                         }
 353                 #endif
 354
 355 #endif
 356
 357 /** @} */
 358