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

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