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

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2009.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6       www.fourwalledcubicle.com
   7 */
   8
   9 /*
  10   Copyright 2009  Dean Camera (dean [at] fourwalledcubicle [dot] com)
  11
  12   Permission to use, copy, modify, and distribute this software
  13   and its documentation for any purpose and without fee is hereby
  14   granted, provided that the above copyright notice appear in all
  15   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         /* Enable C linkage for C++ Compilers: */
  52                 #if defined(__cplusplus)
  53                         extern "C" {
  54                 #endif
  55
  56         /* Public Interface - May be used in end-application: */
  57                 /* Type Defines: */
  58                         /** Class state structure. An instance of this structure should be made within the user application,
  59                          *  and passed to each of the CDC class driver functions as the CDCInterfaceInfo parameter. This
  60                          *  stores each CDC interface's configuration and state information.
  61                          */
  62                         typedef struct
  63                         {
  64                                 const struct
  65                                 {
  66                                         uint8_t  DataINPipeNumber; /**< Pipe number of the CDC interface's IN data pipe */
  67                                         bool     DataINPipeDoubleBank; /** Indicates if the CDC interface's IN data pipe should use double banking */
  68
  69                                         uint8_t  DataOUTPipeNumber; /**< Pipe number of the CDC interface's OUT data pipe */
  70                                         bool     DataOUTPipeDoubleBank; /** Indicates if the CDC interface's OUT data pipe should use double banking */
  71
  72                                         uint8_t  NotificationPipeNumber; /**< Pipe number of the CDC interface's IN notification endpoint, if used */
  73                                         bool     NotificationPipeDoubleBank; /** Indicates if the CDC interface's notification pipe should use double banking */
  74                                 } Config; /**< Config data for the USB class interface within the device. All elements in this section
  75                                            *   <b>must</b> be set or the interface will fail to enumerate and operate correctly.
  76                                            */
  77                                 struct
  78                                 {
  79                                         bool IsActive; /**< Indicates if the current interface instance is connected to an attached device, valid
  80                                                         *   after \ref CDC_Host_ConfigurePipes() is called and the Host state machine is in the
  81                                                         *   Configured state
  82                                                         */
  83                                         uint8_t ControlInterfaceNumber; /**< Interface index of the CDC-ACM control interface within the attached device */
  84
  85                                         uint16_t DataINPipeSize; /**< Size in bytes of the CDC interface's IN data pipe */
  86                                         uint16_t DataOUTPipeSize;  /**< Size in bytes of the CDC interface's OUT data pipe */
  87                                         uint16_t NotificationPipeSize;  /**< Size in bytes of the CDC interface's IN notification pipe, if used */
  88
  89                                         struct
  90                                         {
  91                                                 uint8_t HostToDevice; /**< Control line states from the host to device, as a set of CDC_CONTROL_LINE_OUT_*
  92                                                                                            *   masks.
  93                                                                                            */
  94                                                 uint8_t DeviceToHost; /**< Control line states from the device to host, as a set of CDC_CONTROL_LINE_IN_*
  95                                                                                            *   masks.
  96                                                                                            */
  97                                         } ControlLineStates;
  98
  99                                         struct
 100                                         {
 101                                                 uint32_t BaudRateBPS; /**< Baud rate of the virtual serial port, in bits per second */
 102                                                 uint8_t  CharFormat; /**< Character format of the virtual serial port, a value from the
 103                                                                                           *   CDCDevice_CDC_LineCodingFormats_t enum
 104                                                                                           */
 105                                                 uint8_t  ParityType; /**< Parity setting of the virtual serial port, a value from the
 106                                                                                           *   CDCDevice_LineCodingParity_t enum
 107                                                                                           */
 108                                                 uint8_t  DataBits; /**< Bits of data per character of the virtual serial port */
 109                                         } LineEncoding;
 110                                 } State; /**< State data for the USB class interface within the device. All elements in this section
 111                                                   *   <b>may</b> be set to initial values, but may also be ignored to default to sane values when
 112                                                   *   the interface is enumerated.
 113                                                   */
 114                         } USB_ClassInfo_CDC_Host_t;
 115
 116                 /* Enums: */
 117                         /** Enum for the possible error codes returned by the \ref CDC_Host_ConfigurePipes() function. */
 118                         enum CDCHost_EnumerationFailure_ErrorCodes_t
 119                         {
 120                                 CDC_ENUMERROR_NoError                    = 0, /**< Configuration Descriptor was processed successfully */
 121                                 CDC_ENUMERROR_InvalidConfigDescriptor    = 1, /**< The device returned an invalid Configuration Descriptor */
 122                                 CDC_ENUMERROR_NoCDCInterfaceFound        = 2, /**< A compatible CDC interface was not found in the device's Configuration Descriptor */
 123                                 CDC_ENUMERROR_EndpointsNotFound          = 3, /**< Compatible CDC endpoints were not found in the device's CDC interface */
 124                         };
 125
 126                 /* Function Prototypes: */
 127                         /** General management task for a given CDC host class interface, required for the correct operation of the interface. This should
 128                          *  be called frequently in the main program loop, before the master USB management task \ref USB_USBTask().
 129                          *
 130                          *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing an CDC Class host configuration and state
 131                          */
 132                         void CDC_Host_USBTask(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 133
 134                         /** Host interface configuration routine, to configure a given CDC host interface instance using the Configuration
 135                          *  Descriptor read from an attached USB device. This function automatically updates the given CDC Host instance's
 136                          *  state values and configures the pipes required to communicate with the interface if it is found within the device.
 137                          *  This should be called once after the stack has enumerated the attached device, while the host state machine is in
 138                          *  the Addressed state.
 139                          *
 140                          *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing an CDC Class host configuration and state
 141                          *  \param[in] ConfigDescriptorSize  Length of the attached device's Configuration Descriptor
 142                          *  \param[in] DeviceConfigDescriptor  Pointer to a buffer containing the attached device's Configuration Descriptor
 143                          *
 144                          *  \return A value from the \ref CDCHost_EnumerationFailure_ErrorCodes_t enum
 145                          */
 146                         uint8_t CDC_Host_ConfigurePipes(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo, uint16_t ConfigDescriptorSize,
 147                                                         void* DeviceConfigDescriptor) ATTR_NON_NULL_PTR_ARG(1, 3);
 148
 149                         /** Sets the line encoding for the attached device's virtual serial port. This should be called when the LineEncoding
 150                          *  values of the interface have been changed to push the new settings to the USB device.
 151                          *
 152                          *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class host configuration and state
 153                          *
 154                          *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum
 155                          */
 156                         uint8_t CDC_Host_SetLineEncoding(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 157
 158                         /** Sends a Serial Control Line State Change notification to the device. This should be called when the virtual serial
 159                          *  control lines (DTR, RTS, etc.) have changed states. Line states persist until they are cleared via a second
 160                          *  notification. This should be called each time the CDC class driver's ControlLineStates.HostToDevice value is updated
 161                          *  to push the new states to the USB device.
 162                          *
 163                          *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class host configuration and state
 164                          *
 165                          *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum
 166                          */
 167                         uint8_t CDC_Host_SendControlLineStateChange(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 168
 169                         /** Sends a given string to the attached USB device, if connected. If a device is not connected when the function is called, the
 170                          *  string is discarded.
 171                          *
 172                          *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class host configuration and state
 173                          *  \param[in] Data  Pointer to the string to send to the device
 174                          *  \param[in] Length  Size in bytes of the string to send to the device
 175                          *
 176                          *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum
 177                          */
 178                         uint8_t CDC_Host_SendString(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo, char* Data, const uint16_t Length) ATTR_NON_NULL_PTR_ARG(1, 2);
 179
 180                         /** Sends a given byte to the attached USB device, if connected. If a host is not connected when the function is called, the
 181                          *  byte is discarded.
 182                          *
 183                          *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class host configuration and state
 184                          *  \param[in] Data  Byte of data to send to the device
 185                          *
 186                          *  \return A value from the \ref Pipe_WaitUntilReady_ErrorCodes_t enum
 187                          */
 188                         uint8_t CDC_Host_SendByte(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo, const uint8_t Data) ATTR_NON_NULL_PTR_ARG(1);
 189
 190                         /** Determines the number of bytes received by the CDC interface from the device, waiting to be read.
 191                          *
 192                          *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class host configuration and state
 193                          *
 194                          *  \return Total number of buffered bytes received from the device
 195                          */
 196                         uint16_t CDC_Host_BytesReceived(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 197
 198                         /** 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
 199                          *  returns 0. The \ref CDC_Host_BytesReceived() function should be queried before data is received to ensure that no data
 200                          *  underflow occurs.
 201                          *
 202                          *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class host configuration and state
 203                          *
 204                          *  \return Next received byte from the device, or 0 if no data received
 205                          */
 206                         uint8_t CDC_Host_ReceiveByte(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 207
 208                         /** CDC class driver event for a control line state change on a CDC host interface. This event fires each time the device notifies
 209                          *  the host of a control line state change (containing the virtual serial control line states, such as DCD) and may be hooked in the
 210                          *  user program by declaring a handler function with the same name and parameters listed here. The new control line states
 211                          *  are available in the ControlLineStates.DeviceToHost value inside the CDC host interface structure passed as a parameter, set as
 212                          *  a mask of CDC_CONTROL_LINE_IN_* masks.
 213                          *
 214                          *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class host configuration and state
 215                          */
 216                         void EVENT_CDC_Host_ControLineStateChanged(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 217
 218         /* Private Interface - For use in library only: */
 219         #if !defined(__DOXYGEN__)
 220                 /* Macros: */
 221                         #define CDC_CONTROL_CLASS               0x02
 222                         #define CDC_CONTROL_SUBCLASS            0x02
 223                         #define CDC_CONTROL_PROTOCOL            0x01
 224                         #define CDC_DATA_CLASS                  0x0A
 225                         #define CDC_DATA_SUBCLASS               0x00
 226                         #define CDC_DATA_PROTOCOL               0x00
 227
 228                         #define CDC_FOUND_DATAPIPE_IN           (1 << 0)
 229                         #define CDC_FOUND_DATAPIPE_OUT          (1 << 1)
 230                         #define CDC_FOUND_NOTIFICATION_IN       (1 << 2)
 231
 232                 /* Function Prototypes: */
 233                         #if defined(INCLUDE_FROM_CDC_CLASS_HOST_C)
 234                                 void CDC_Host_Event_Stub(void);
 235                                 void EVENT_CDC_Host_ControLineStateChanged(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo)
 236                                                                            ATTR_WEAK ATTR_NON_NULL_PTR_ARG(1) ATTR_ALIAS(CDC_Host_Event_Stub);
 237                                 static uint8_t DComp_CDC_Host_NextCDCControlInterface(void* const CurrentDescriptor) ATTR_NON_NULL_PTR_ARG(1);
 238                                 static uint8_t DComp_CDC_Host_NextCDCDataInterface(void* const CurrentDescriptor) ATTR_NON_NULL_PTR_ARG(1);
 239                                 static uint8_t DComp_CDC_Host_NextCDCInterfaceEndpoint(void* const CurrentDescriptor);
 240                         #endif
 241         #endif
 242
 243         /* Disable C linkage for C++ Compilers: */
 244                 #if defined(__cplusplus)
 245                         }
 246                 #endif
 247
 248 #endif
 249
 250 /** @} */