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

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2010.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6       www.fourwalledcubicle.com
   7 */
   8
   9 /*
  10   Copyright 2010  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 class driver
  37  *        dispatch header located in LUFA/Drivers/USB/Class/CDC.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 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                 #include <string.h>
  62
  63         /* Enable C linkage for C++ Compilers: */
  64                 #if defined(__cplusplus)
  65                         extern "C" {
  66                 #endif
  67
  68         /* Preprocessor Checks: */
  69                 #if !defined(__INCLUDE_FROM_CDC_DRIVER)
  70                         #error Do not include this file directly. Include LUFA/Drivers/Class/CDC.h instead.
  71                 #endif
  72
  73         /* Public Interface - May be used in end-application: */
  74                 /* Type Defines: */
  75                         /** \brief CDC Class Host Mode Configuration and State Structure.
  76                          *
  77                          *  Class state structure. An instance of this structure should be made within the user application,
  78                          *  and passed to each of the CDC class driver functions as the CDCInterfaceInfo parameter. This
  79                          *  stores each CDC interface's configuration and state information.
  80                          */
  81                         typedef struct
  82                         {
  83                                 const struct
  84                                 {
  85                                         uint8_t  DataINPipeNumber; /**< Pipe number of the CDC interface's IN data pipe. */
  86                                         bool     DataINPipeDoubleBank; /**< Indicates if the CDC interface's IN data pipe should use double banking. */
  87
  88                                         uint8_t  DataOUTPipeNumber; /**< Pipe number of the CDC interface's OUT data pipe. */
  89                                         bool     DataOUTPipeDoubleBank; /**< Indicates if the CDC interface's OUT data pipe should use double banking. */
  90
  91                                         uint8_t  NotificationPipeNumber; /**< Pipe number of the CDC interface's IN notification endpoint, if used. */
  92                                         bool     NotificationPipeDoubleBank; /**< Indicates if the CDC interface's notification pipe should use double banking. */
  93                                 } Config; /**< Config data for the USB class interface within the device. All elements in this section
  94                                            *   <b>must</b> be set or the interface will fail to enumerate and operate correctly.
  95                                            */
  96                                 struct
  97                                 {
  98                                         bool IsActive; /**< Indicates if the current interface instance is connected to an attached device, valid
  99                                                         *   after \ref CDC_Host_ConfigurePipes() is called and the Host state machine is in the
 100                                                         *   Configured state.
 101                                                         */
 102                                         uint8_t  ControlInterfaceNumber; /**< Interface index of the CDC-ACM control interface within the attached device. */
 103
 104                                         uint16_t DataINPipeSize; /**< Size in bytes of the CDC interface's IN data pipe. */
 105                                         uint16_t DataOUTPipeSize;  /**< Size in bytes of the CDC interface's OUT data pipe. */
 106                                         uint16_t NotificationPipeSize;  /**< Size in bytes of the CDC interface's IN notification pipe, if used. */
 107
 108                                         struct
 109                                         {
 110                                                 uint8_t HostToDevice; /**< Control line states from the host to device, as a set of CDC_CONTROL_LINE_OUT_*
 111                                                                                            *   masks - to notify the device of changes to these values, call the
 112                                                                                            *   \ref CDC_Host_SendControlLineStateChange() function.
 113                                                                                            */
 114                                                 uint8_t DeviceToHost; /**< Control line states from the device to host, as a set of CDC_CONTROL_LINE_IN_*
 115                                                                                            *   masks. This value is updated each time \ref CDC_Host_USBTask() is called.
 116                                                                                            */
 117                                         } ControlLineStates; /**< Current states of the virtual serial port's control lines between the device and host. */
 118
 119                                         struct
 120                                         {
 121                                                 uint32_t BaudRateBPS; /**< Baud rate of the virtual serial port, in bits per second. */
 122                                                 uint8_t  CharFormat; /**< Character format of the virtual serial port, a value from the
 123                                                                                           *   \ref CDC_LineEncodingFormats_t enum.
 124                                                                                           */
 125                                                 uint8_t  ParityType; /**< Parity setting of the virtual serial port, a value from the
 126                                                                                           *   \ref CDC_LineEncodingParity_t enum.
 127                                                                                           */
 128                                                 uint8_t  DataBits; /**< Bits of data per character of the virtual serial port. */
 129                                         } LineEncoding; /**< Line encoding used in the virtual serial port, for the device's information. This is generally
 130                                                          *   only used if the virtual serial port data is to be reconstructed on a physical UART. When set
 131                                                          *   by the host application, the \ref CDC_Host_SetLineEncoding() function must be called to push
 132                                                          *   the changes to the device.
 133                                                          */
 134                                 } State; /**< State data for the USB class interface within the device. All elements in this section
 135                                                   *   <b>may</b> be set to initial values, but may also be ignored to default to sane values when
 136                                                   *   the interface is enumerated.
 137                                                   */
 138                         } USB_ClassInfo_CDC_Host_t;
 139
 140                 /* Enums: */
 141                         /** Enum for the possible error codes returned by the \ref CDC_Host_ConfigurePipes() function. */
 142                         enum CDCHost_EnumerationFailure_ErrorCodes_t
 143                         {
 144                                 CDC_ENUMERROR_NoError                    = 0, /**< Configuration Descriptor was processed successfully. */
 145                                 CDC_ENUMERROR_InvalidConfigDescriptor    = 1, /**< The device returned an invalid Configuration Descriptor. */
 146                                 CDC_ENUMERROR_NoCDCInterfaceFound        = 2, /**< A compatible CDC interface was not found in the device's Configuration Descriptor. */
 147                                 CDC_ENUMERROR_EndpointsNotFound          = 3, /**< Compatible CDC endpoints were not found in the device's CDC interface. */
 148                         };
 149
 150                 /* Function Prototypes: */
 151                         /** General management task for a given CDC host class interface, required for the correct operation of the interface. This should
 152                          *  be called frequently in the main program loop, before the master USB management task \ref USB_USBTask().
 153                          *
 154                          *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing an CDC Class host configuration and state.
 155                          */
 156                         void CDC_Host_USBTask(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 157
 158                         /** Host interface configuration routine, to configure a given CDC host interface instance using the Configuration
 159                          *  Descriptor read from an attached USB device. This function automatically updates the given CDC Host instance's
 160                          *  state values and configures the pipes required to communicate with the interface if it is found within the device.
 161                          *  This should be called once after the stack has enumerated the attached device, while the host state machine is in
 162                          *  the Addressed state.
 163                          *
 164                          *  \param[in,out] CDCInterfaceInfo        Pointer to a structure containing an CDC Class host configuration and state.
 165                          *  \param[in]     ConfigDescriptorSize    Length of the attached device's Configuration Descriptor.
 166                          *  \param[in]     DeviceConfigDescriptor  Pointer to a buffer containing the attached device's Configuration Descriptor.
 167                          *
 168                          *  \return A value from the \ref CDCHost_EnumerationFailure_ErrorCodes_t enum.
 169                          */
 170                         uint8_t CDC_Host_ConfigurePipes(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo,
 171                                                         uint16_t ConfigDescriptorSize,
 172                                                         void* DeviceConfigDescriptor) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(3);
 173
 174                         /** Sets the line encoding for the attached device's virtual serial port. This should be called when the LineEncoding
 175                          *  values of the interface have been changed to push the new settings to the USB device.
 176                          *
 177                          *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class host configuration and state.
 178                          *
 179                          *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum.
 180                          */
 181                         uint8_t CDC_Host_SetLineEncoding(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 182
 183                         /** Sends a Serial Control Line State Change notification to the device. This should be called when the virtual serial
 184                          *  control lines (DTR, RTS, etc.) have changed states. Line states persist until they are cleared via a second
 185                          *  notification. This should be called each time the CDC class driver's ControlLineStates.HostToDevice value is updated
 186                          *  to push the new states to the USB device.
 187                          *
 188                          *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class host configuration and state.
 189                          *
 190                          *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum.
 191                          */
 192                         uint8_t CDC_Host_SendControlLineStateChange(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 193
 194                         /** Sends a Send Break request to the device. This is generally used to separate data data or to indicate a special condition
 195                          *  to the receiving device.
 196                          *
 197                          *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class host configuration and state.
 198                          *  \param[in]     Duration          Duration of the break, in milliseconds.
 199                          *
 200                          *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum.
 201                          */
 202                         uint8_t CDC_Host_SendBreak(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo,
 203                                                    const uint8_t Duration) ATTR_NON_NULL_PTR_ARG(1);
 204
 205                         /** Sends a given string to the attached USB device, if connected. If a device is not connected when the function is called, the
 206                          *  string is discarded. Bytes will be queued for transmission to the device until either the pipe bank becomes full, or the
 207                          *  \ref CDC_Host_Flush() function is called to flush the pending data to the host. This allows for multiple bytes to be
 208                          *  packed into a single pipe packet, increasing data throughput.
 209                          *
 210                          *  \pre This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the
 211                          *       call will fail.
 212                          *
 213                          *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class host configuration and state.
 214                          *  \param[in]     Data              Pointer to the string to send to the device.
 215                          *  \param[in]     Length            Size in bytes of the string to send to the device.
 216                          *
 217                          *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.
 218                          */
 219                         uint8_t CDC_Host_SendString(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo,
 220                                                     const char* const Data,
 221                                                     const uint16_t Length) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);
 222
 223                         /** Sends a given byte to the attached USB device, if connected. If a device is not connected when the function is called, the
 224                          *  byte is discarded. Bytes will be queued for transmission to the device until either the pipe bank becomes full, or the
 225                          *  \ref CDC_Host_Flush() function is called to flush the pending data to the host. This allows for multiple bytes to be
 226                          *  packed into a single pipe packet, increasing data throughput.
 227                          *
 228                          *  \pre This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the
 229                          *       call will fail.
 230                          *
 231                          *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class host configuration and state.
 232                          *  \param[in]     Data              Byte of data to send to the device.
 233                          *
 234                          *  \return A value from the \ref Pipe_WaitUntilReady_ErrorCodes_t enum.
 235                          */
 236                         uint8_t CDC_Host_SendByte(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo,
 237                                                   const uint8_t Data) ATTR_NON_NULL_PTR_ARG(1);
 238
 239                         /** Determines the number of bytes received by the CDC interface from the device, waiting to be read. This indicates the number
 240                          *  of bytes in the IN pipe bank only, and thus the number of calls to \ref CDC_Host_ReceiveByte() which are guaranteed to succeed
 241                          *  immediately. If multiple bytes are to be received, they should be buffered by the user application, as the pipe bank will not be
 242                          *  released back to the USB controller until all bytes are read.
 243                          *
 244                          *  \pre This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the
 245                          *       call will fail.
 246                          *
 247                          *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class host configuration and state.
 248                          *
 249                          *  \return Total number of buffered bytes received from the device.
 250                          */
 251                         uint16_t CDC_Host_BytesReceived(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 252
 253                         /** 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
 254                          *  returns a negative value. The \ref CDC_Host_BytesReceived() function may be queried in advance to determine how many bytes
 255                          *  are currently buffered in the CDC interface's data receive pipe.
 256                          *
 257                          *  \pre This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the
 258                          *       call will fail.
 259                          *
 260                          *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class host configuration and state.
 261                          *
 262                          *  \return Next received byte from the device, or a negative value if no data received.
 263                          */
 264                         int16_t CDC_Host_ReceiveByte(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 265
 266                         /** Flushes any data waiting to be sent, ensuring that the send buffer is cleared.
 267                          *
 268                          *  \pre This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the
 269                          *       call will fail.
 270                          *
 271                          *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class host configuration and state.
 272                          *
 273                          *  \return A value from the \ref Pipe_WaitUntilReady_ErrorCodes_t enum.
 274                          */
 275                         uint8_t CDC_Host_Flush(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 276
 277                         /** Creates a standard character stream for the given CDC Device instance so that it can be used with all the regular
 278                          *  functions in the avr-libc <stdio.h> library that accept a FILE stream as a destination (e.g. fprintf). The created
 279                          *  stream is bidirectional and can be used for both input and output functions.
 280                          *
 281                          *  \note The created stream can be given as stdout if desired to direct the standard output from all <stdio.h> functions
 282                          *        to the given CDC interface.
 283                          *
 284                          *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state.
 285                          *  \param[in,out] Stream            Pointer to a FILE structure where the created stream should be placed.
 286                          */
 287                         void CDC_Host_CreateStream(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo,
 288                                                    FILE* const Stream);
 289
 290                         /** Identical to CDC_Host_CreateStream(), except that reads are blocking until the calling stream function terminates
 291                          *  the transfer. While blocking, the USB and CDC service tasks are called repeatedly to maintain USB communications.
 292                          *
 293                          *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state.
 294                          *  \param[in,out] Stream            Pointer to a FILE structure where the created stream should be placed.
 295                          */
 296                         void CDC_Host_CreateBlockingStream(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo,
 297                                                            FILE* const Stream);
 298
 299                         /** CDC class driver event for a control line state change on a CDC host interface. This event fires each time the device notifies
 300                          *  the host of a control line state change (containing the virtual serial control line states, such as DCD) and may be hooked in the
 301                          *  user program by declaring a handler function with the same name and parameters listed here. The new control line states
 302                          *  are available in the ControlLineStates.DeviceToHost value inside the CDC host interface structure passed as a parameter, set as
 303                          *  a mask of CDC_CONTROL_LINE_IN_* masks.
 304                          *
 305                          *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class host configuration and state.
 306                          */
 307                         void EVENT_CDC_Host_ControLineStateChanged(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 308
 309         /* Private Interface - For use in library only: */
 310         #if !defined(__DOXYGEN__)
 311                 /* Macros: */
 312                         #define CDC_CONTROL_CLASS               0x02
 313                         #define CDC_CONTROL_SUBCLASS            0x02
 314                         #define CDC_CONTROL_PROTOCOL            0x01
 315                         #define CDC_DATA_CLASS                  0x0A
 316                         #define CDC_DATA_SUBCLASS               0x00
 317                         #define CDC_DATA_PROTOCOL               0x00
 318
 319                         #define CDC_FOUND_DATAPIPE_IN           (1 << 0)
 320                         #define CDC_FOUND_DATAPIPE_OUT          (1 << 1)
 321                         #define CDC_FOUND_NOTIFICATION_IN       (1 << 2)
 322
 323                 /* Function Prototypes: */
 324                         #if defined(__INCLUDE_FROM_CDC_CLASS_HOST_C)
 325                                 static int CDC_Host_putchar(char c,
 326                                                             FILE* Stream) ATTR_NON_NULL_PTR_ARG(2);
 327                                 static int CDC_Host_getchar(FILE* Stream) ATTR_NON_NULL_PTR_ARG(1);
 328                                 static int CDC_Host_getchar_Blocking(FILE* Stream) ATTR_NON_NULL_PTR_ARG(1);
 329
 330                                 void CDC_Host_Event_Stub(void);
 331                                 void EVENT_CDC_Host_ControLineStateChanged(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo)
 332                                                                            ATTR_WEAK ATTR_NON_NULL_PTR_ARG(1) ATTR_ALIAS(CDC_Host_Event_Stub);
 333
 334                                 static uint8_t DCOMP_CDC_Host_NextCDCControlInterface(void* const CurrentDescriptor) ATTR_NON_NULL_PTR_ARG(1);
 335                                 static uint8_t DCOMP_CDC_Host_NextCDCDataInterface(void* const CurrentDescriptor) ATTR_NON_NULL_PTR_ARG(1);
 336                                 static uint8_t DCOMP_CDC_Host_NextCDCInterfaceEndpoint(void* const CurrentDescriptor) ATTR_NON_NULL_PTR_ARG(1);
 337                         #endif
 338         #endif
 339
 340         /* Disable C linkage for C++ Compilers: */
 341                 #if defined(__cplusplus)
 342                         }
 343                 #endif
 344
 345 #endif
 346
 347 /** @} */