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