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 /** \ingroup Group_USBClassCDC
  32  *  @defgroup Group_USBClassCDCHost CDC Class Host Mode Driver
  33  *
  34  *  \section Sec_Dependencies Module Source Dependencies
  35  *  The following files must be built with any user project that uses this module:
  36  *    - LUFA/Drivers/USB/Class/Host/CDC.c
  37  *
  38  *  \section Module Description
  39  *  Host Mode USB Class driver framework interface, for the CDC USB Class driver.
  40  *
  41  *  @{
  42  */
  43
  44 #ifndef __CDC_CLASS_HOST_H__
  45 #define __CDC_CLASS_HOST_H__
  46
  47         /* Includes: */
  48                 #include "../../USB.h"
  49                 #include "../Common/CDC.h"
  50
  51                 #include <stdio.h>
  52                 #include <string.h>
  53
  54         /* Enable C linkage for C++ Compilers: */
  55                 #if defined(__cplusplus)
  56                         extern "C" {
  57                 #endif
  58
  59         /* Public Interface - May be used in end-application: */
  60                 /* Type Defines: */
  61                         /** Class state structure. An instance of this structure should be made within the user application,
  62                          *  and passed to each of the CDC class driver functions as the CDCInterfaceInfo parameter. This
  63                          *  stores each CDC interface's configuration and state information.
  64                          */
  65                         typedef struct
  66                         {
  67                                 const struct
  68                                 {
  69                                         uint8_t  DataINPipeNumber; /**< Pipe number of the CDC interface's IN data pipe */
  70                                         bool     DataINPipeDoubleBank; /** Indicates if the CDC interface's IN data pipe should use double banking */
  71
  72                                         uint8_t  DataOUTPipeNumber; /**< Pipe number of the CDC interface's OUT data pipe */
  73                                         bool     DataOUTPipeDoubleBank; /** Indicates if the CDC interface's OUT data pipe should use double banking */
  74
  75                                         uint8_t  NotificationPipeNumber; /**< Pipe number of the CDC interface's IN notification endpoint, if used */
  76                                         bool     NotificationPipeDoubleBank; /** Indicates if the CDC interface's notification pipe should use double banking */
  77                                 } Config; /**< Config data for the USB class interface within the device. All elements in this section
  78                                            *   <b>must</b> be set or the interface will fail to enumerate and operate correctly.
  79                                            */
  80                                 struct
  81                                 {
  82                                         bool IsActive; /**< Indicates if the current interface instance is connected to an attached device, valid
  83                                                         *   after \ref CDC_Host_ConfigurePipes() is called and the Host state machine is in the
  84                                                         *   Configured state
  85                                                         */
  86                                         uint8_t ControlInterfaceNumber; /**< Interface index of the CDC-ACM control interface within the attached device */
  87
  88                                         uint16_t DataINPipeSize; /**< Size in bytes of the CDC interface's IN data pipe */
  89                                         uint16_t DataOUTPipeSize;  /**< Size in bytes of the CDC interface's OUT data pipe */
  90                                         uint16_t NotificationPipeSize;  /**< Size in bytes of the CDC interface's IN notification pipe, if used */
  91
  92                                         struct
  93                                         {
  94                                                 uint8_t HostToDevice; /**< Control line states from the host to device, as a set of CDC_CONTROL_LINE_OUT_*
  95                                                                                            *   masks.
  96                                                                                            */
  97                                                 uint8_t DeviceToHost; /**< Control line states from the device to host, as a set of CDC_CONTROL_LINE_IN_*
  98                                                                                            *   masks.
  99                                                                                            */
 100                                         } ControlLineStates;
 101
 102                                         struct
 103                                         {
 104                                                 uint32_t BaudRateBPS; /**< Baud rate of the virtual serial port, in bits per second */
 105                                                 uint8_t  CharFormat; /**< Character format of the virtual serial port, a value from the
 106                                                                                           *   CDCDevice_CDC_LineCodingFormats_t enum
 107                                                                                           */
 108                                                 uint8_t  ParityType; /**< Parity setting of the virtual serial port, a value from the
 109                                                                                           *   CDCDevice_LineCodingParity_t enum
 110                                                                                           */
 111                                                 uint8_t  DataBits; /**< Bits of data per character of the virtual serial port */
 112                                         } LineEncoding;
 113                                 } State; /**< State data for the USB class interface within the device. All elements in this section
 114                                                   *   <b>may</b> be set to initial values, but may also be ignored to default to sane values when
 115                                                   *   the interface is enumerated.
 116                                                   */
 117                         } USB_ClassInfo_CDC_Host_t;
 118
 119                 /* Enums: */
 120                         /** Enum for the possible error codes returned by the \ref CDC_Host_ConfigurePipes() function. */
 121                         enum CDCHost_EnumerationFailure_ErrorCodes_t
 122                         {
 123                                 CDC_ENUMERROR_NoError                    = 0, /**< Configuration Descriptor was processed successfully */
 124                                 CDC_ENUMERROR_InvalidConfigDescriptor    = 1, /**< The device returned an invalid Configuration Descriptor */
 125                                 CDC_ENUMERROR_NoCDCInterfaceFound        = 2, /**< A compatible CDC interface was not found in the device's Configuration Descriptor */
 126                                 CDC_ENUMERROR_EndpointsNotFound          = 3, /**< Compatible CDC endpoints were not found in the device's CDC interface */
 127                         };
 128
 129                 /* Function Prototypes: */
 130                         /** General management task for a given CDC host class interface, required for the correct operation of the interface. This should
 131                          *  be called frequently in the main program loop, before the master USB management task \ref USB_USBTask().
 132                          *
 133                          *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing an CDC Class host configuration and state
 134                          */
 135                         void CDC_Host_USBTask(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 136
 137                         /** Host interface configuration routine, to configure a given CDC host interface instance using the Configuration
 138                          *  Descriptor read from an attached USB device. This function automatically updates the given CDC Host instance's
 139                          *  state values and configures the pipes required to communicate with the interface if it is found within the device.
 140                          *  This should be called once after the stack has enumerated the attached device, while the host state machine is in
 141                          *  the Addressed state.
 142                          *
 143                          *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing an CDC Class host configuration and state
 144                          *  \param[in] ConfigDescriptorSize  Length of the attached device's Configuration Descriptor
 145                          *  \param[in] DeviceConfigDescriptor  Pointer to a buffer containing the attached device's Configuration Descriptor
 146                          *
 147                          *  \return A value from the \ref CDCHost_EnumerationFailure_ErrorCodes_t enum
 148                          */
 149                         uint8_t CDC_Host_ConfigurePipes(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo, uint16_t ConfigDescriptorSize,
 150                                                         void* DeviceConfigDescriptor) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(3);
 151
 152                         /** Sets the line encoding for the attached device's virtual serial port. This should be called when the LineEncoding
 153                          *  values of the interface have been changed to push the new settings to the USB device.
 154                          *
 155                          *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class host configuration and state
 156                          *
 157                          *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum
 158                          */
 159                         uint8_t CDC_Host_SetLineEncoding(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 160
 161                         /** Sends a Serial Control Line State Change notification to the device. This should be called when the virtual serial
 162                          *  control lines (DTR, RTS, etc.) have changed states. Line states persist until they are cleared via a second
 163                          *  notification. This should be called each time the CDC class driver's ControlLineStates.HostToDevice value is updated
 164                          *  to push the new states to the USB device.
 165                          *
 166                          *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class host configuration and state
 167                          *
 168                          *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum
 169                          */
 170                         uint8_t CDC_Host_SendControlLineStateChange(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 171
 172                         /** Sends a given string to the attached USB device, if connected. If a device is not connected when the function is called, the
 173                          *  string is discarded. Bytes will be queued for transmission to the device until either the pipe bank becomes full, or the
 174                          *  \ref CDC_Host_Flush() function is called to flush the pending data to the host. This allows for multiple bytes to be
 175                          *  packed into a single pipe packet, increasing data throughput.
 176                          *
 177                          *  \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the
 178                          *        call will fail.
 179                          *
 180                          *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class host configuration and state
 181                          *  \param[in] Data  Pointer to the string to send to the device
 182                          *  \param[in] Length  Size in bytes of the string to send to the device
 183                          *
 184                          *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum
 185                          */
 186                         uint8_t CDC_Host_SendString(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo, char* Data, const uint16_t Length)
 187                                                     ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);
 188
 189                         /** Sends a given byte to the attached USB device, if connected. If a device is not connected when the function is called, the
 190                          *  byte is discarded. Bytes will be queued for transmission to the device until either the pipe bank becomes full, or the
 191                          *  \ref CDC_Host_Flush() function is called to flush the pending data to the host. This allows for multiple bytes to be
 192                          *  packed into a single pipe packet, increasing data throughput.
 193                          *
 194                          *  \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the
 195                          *        call will fail.
 196                          *
 197                          *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class host configuration and state
 198                          *  \param[in] Data  Byte of data to send to the device
 199                          *
 200                          *  \return A value from the \ref Pipe_WaitUntilReady_ErrorCodes_t enum
 201                          */
 202                         uint8_t CDC_Host_SendByte(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo, const uint8_t Data) ATTR_NON_NULL_PTR_ARG(1);
 203
 204                         /** Determines the number of bytes received by the CDC interface from the device, waiting to be read.
 205                          *
 206                          *  \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the
 207                          *        call will fail.
 208                          *
 209                          *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class host configuration and state
 210                          *
 211                          *  \return Total number of buffered bytes received from the device
 212                          */
 213                         uint16_t CDC_Host_BytesReceived(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 214
 215                         /** 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
 216                          *  returns 0. The \ref CDC_Host_BytesReceived() function should be queried before data is received to ensure that no data
 217                          *  underflow occurs.
 218                          *
 219                          *  \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the
 220                          *        call will fail.
 221                          *
 222                          *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class host configuration and state
 223                          *
 224                          *  \return Next received byte from the device, or 0 if no data received
 225                          */
 226                         uint8_t CDC_Host_ReceiveByte(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 227
 228                         /** Flushes any data waiting to be sent, ensuring that the send buffer is cleared.
 229                          *
 230                          *  \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the
 231                          *        call will fail.
 232                          *
 233                          *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class host configuration and state
 234                          *
 235                          *  \return A value from the \ref Pipe_WaitUntilReady_ErrorCodes_t enum
 236                          */
 237                         uint8_t CDC_Host_Flush(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 238
 239                         /** Creates a standard characer stream for the given CDC Device instance so that it can be used with all the regular
 240                          *  functions in the avr-libc <stdio.h> library that accept a FILE stream as a destination (e.g. fprintf). The created
 241                          *  stream is bidirectional and can be used for both input and output functions.
 242                          *
 243                          *  \note The created stream can be given as stdout if desired to direct the standard output from all <stdio.h> functions
 244                          *        to the given CDC interface.
 245                          *
 246                          *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state
 247                          *  \param[in,out] Stream  Pointer to a FILE structure where the created stream should be placed
 248                          */
 249                         void CDC_Host_CreateStream(USB_ClassInfo_CDC_Host_t* CDCInterfaceInfo, FILE* Stream);
 250
 251                         /** Identical to CDC_Host_CreateStream(), except that reads are blocking until the calling stream function terminates
 252                          *  the transfer. While blocking, the USB and CDC service tasks are called repeatedly to maintain USB communications.
 253                          *
 254                          *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state
 255                          *  \param[in,out] Stream  Pointer to a FILE structure where the created stream should be placed
 256                          */
 257                         void CDC_Host_CreateBlockingStream(USB_ClassInfo_CDC_Host_t* CDCInterfaceInfo, FILE* Stream);
 258
 259                         /** CDC class driver event for a control line state change on a CDC host interface. This event fires each time the device notifies
 260                          *  the host of a control line state change (containing the virtual serial control line states, such as DCD) and may be hooked in the
 261                          *  user program by declaring a handler function with the same name and parameters listed here. The new control line states
 262                          *  are available in the ControlLineStates.DeviceToHost value inside the CDC host interface structure passed as a parameter, set as
 263                          *  a mask of CDC_CONTROL_LINE_IN_* masks.
 264                          *
 265                          *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class host configuration and state
 266                          */
 267                         void EVENT_CDC_Host_ControLineStateChanged(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 268
 269         /* Private Interface - For use in library only: */
 270         #if !defined(__DOXYGEN__)
 271                 /* Macros: */
 272                         #define CDC_CONTROL_CLASS               0x02
 273                         #define CDC_CONTROL_SUBCLASS            0x02
 274                         #define CDC_CONTROL_PROTOCOL            0x01
 275                         #define CDC_DATA_CLASS                  0x0A
 276                         #define CDC_DATA_SUBCLASS               0x00
 277                         #define CDC_DATA_PROTOCOL               0x00
 278
 279                         #define CDC_FOUND_DATAPIPE_IN           (1 << 0)
 280                         #define CDC_FOUND_DATAPIPE_OUT          (1 << 1)
 281                         #define CDC_FOUND_NOTIFICATION_IN       (1 << 2)
 282
 283                 /* Function Prototypes: */
 284                         #if defined(INCLUDE_FROM_CDC_CLASS_HOST_C)
 285                                 static int CDC_Host_putchar(char c, FILE* Stream);
 286                                 static int CDC_Host_getchar(FILE* Stream);
 287                                 static int CDC_Host_getchar_Blocking(FILE* Stream);
 288
 289                                 void CDC_Host_Event_Stub(void);
 290                                 void EVENT_CDC_Host_ControLineStateChanged(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo)
 291                                                                            ATTR_WEAK ATTR_NON_NULL_PTR_ARG(1) ATTR_ALIAS(CDC_Host_Event_Stub);
 292                                 static uint8_t DComp_CDC_Host_NextCDCControlInterface(void* const CurrentDescriptor) ATTR_NON_NULL_PTR_ARG(1);
 293                                 static uint8_t DComp_CDC_Host_NextCDCDataInterface(void* const CurrentDescriptor) ATTR_NON_NULL_PTR_ARG(1);
 294                                 static uint8_t DComp_CDC_Host_NextCDCInterfaceEndpoint(void* const CurrentDescriptor);
 295                         #endif
 296         #endif
 297
 298         /* Disable C linkage for C++ Compilers: */
 299                 #if defined(__cplusplus)
 300                         }
 301                 #endif
 302
 303 #endif
 304
 305 /** @} */