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 Module Description
  35  *  Host Mode USB Class driver framework interface, for the CDC USB Class driver.
  36  *
  37  *  @{
  38  */
  39
  40 #ifndef __CDC_CLASS_HOST_H__
  41 #define __CDC_CLASS_HOST_H__
  42
  43         /* Includes: */
  44                 #include "../../USB.h"
  45                 #include "../Common/CDC.h"
  46
  47         /* Enable C linkage for C++ Compilers: */
  48                 #if defined(__cplusplus)
  49                         extern "C" {
  50                 #endif
  51
  52         /* Public Interface - May be used in end-application: */
  53                 /* Type Defines: */
  54                         /** Configuration information structure for \ref USB_ClassInfo_CDC_Host_t CDC host interface structures. */
  55                         typedef struct
  56                         {
  57                                 uint8_t  DataINPipeNumber; /**< Pipe number of the CDC interface's IN data pipe */
  58                                 uint8_t  DataOUTPipeNumber; /**< Pipe number of the CDC interface's OUT data pipe */
  59                                 uint8_t  NotificationPipeNumber; /**< Pipe number of the CDC interface's IN notification endpoint, if used */
  60                         } USB_ClassInfo_CDC_Host_Config_t;
  61
  62                         /** Current State information structure for \ref USB_ClassInfo_CDC_Host_t CDC host interface structures. */
  63                         typedef struct
  64                         {
  65                                 uint8_t  ControlInterfaceNumber; /**< Interface number of the CDC control interface within the device */
  66
  67                                 uint16_t DataINPipeSize; /**< Size in bytes of the CDC interface's IN data pipe */
  68                                 uint16_t DataOUTPipeSize;  /**< Size in bytes of the CDC interface's OUT data pipe */
  69                                 uint16_t NotificationPipeSize;  /**< Size in bytes of the CDC interface's IN notification endpoint, if used */
  70
  71                                 struct
  72                                 {
  73                                         uint8_t HostToDevice; /**< Control line states from the host to device, as a set of CDC_CONTROL_LINE_OUT_*
  74                                                                *   masks.
  75                                                                */
  76                                         uint8_t DeviceToHost; /**< Control line states from the device to host, as a set of CDC_CONTROL_LINE_IN_*
  77                                                                *   masks.
  78                                                                */
  79                                 } ControlLineStates;
  80
  81                                 struct
  82                                 {
  83                                         bool Active; /**< Indicates if the interface is currently active, i.e. attached to the connected device */
  84
  85                                         uint32_t BaudRateBPS; /**< Baud rate of the virtual serial port, in bits per second */
  86                                         uint8_t  CharFormat; /**< Character format of the virtual serial port, a value from the
  87                                                                                   *   CDCDevice_CDC_LineCodingFormats_t enum
  88                                                                                   */
  89                                         uint8_t  ParityType; /**< Parity setting of the virtual serial port, a value from the
  90                                                                                   *   CDCDevice_LineCodingParity_t enum
  91                                                                                   */
  92                                         uint8_t  DataBits; /**< Bits of data per character of the virtual serial port */
  93                                 } LineEncoding;
  94                         } USB_ClassInfo_CDC_Host_State_t;
  95
  96                         /** Class state structure. An instance of this structure should be made within the user application,
  97                          *  and passed to each of the CDC class driver functions as the CDCInterfaceInfo parameter. This
  98                          *  stores each CDC interface's configuration and state information.
  99                          */
 100                         typedef struct
 101                         {
 102                                 const USB_ClassInfo_CDC_Host_Config_t Config; /**< Config data for the USB class interface within
 103                                                                                *   the device. All elements in this section
 104                                                                                *   <b>must</b> be set or the interface will fail
 105                                                                                *   to enumerate and operate correctly.
 106                                                                                */
 107
 108                                 USB_ClassInfo_CDC_Host_State_t State; /**< State data for the USB class interface within
 109                                                                        *   the device. All elements in this section
 110                                                                        *   <b>may</b> be set to initial values, but may
 111                                                                        *   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                         typedef enum
 118                         {
 119                                 CDC_ENUMERROR_NoError                    = 0, /**< Configuration Descriptor was processed successfully */
 120                                 CDC_ENUMERROR_ControlError               = 1, /**< A control request to the device failed to complete successfully */
 121                                 CDC_ENUMERROR_DescriptorTooLarge         = 2, /**< The device's Configuration Descriptor is too large to process */
 122                                 CDC_ENUMERROR_InvalidConfigDataReturned  = 3, /**< The device returned an invalid Configuration Descriptor */
 123                                 CDC_ENUMERROR_NoCDCInterfaceFound        = 4, /**< A compatible CDC interface was not found in the device's Configuration Descriptor */
 124                                 CDC_ENUMERROR_NoEndpointFound            = 5, /**< Compatible CDC endpoints were not found in the device's CDC interface */
 125                         } CDCHost_EnumerationFailure_ErrorCodes_t;
 126
 127                 /* Function Prototypes: */
 128                         void CDC_Host_USBTask(USB_ClassInfo_CDC_Host_t* CDCInterfaceInfo);
 129
 130         /* Private Interface - For use in library only: */
 131         #if !defined(__DOXYGEN__)
 132                 /* Macros: */
 133                         #define CDC_CONTROL_CLASS               0x02
 134                         #define CDC_CONTROL_SUBCLASS            0x02
 135                         #define CDC_CONTROL_PROTOCOL            0x01
 136                         #define CDC_DATA_CLASS                  0x0A
 137                         #define CDC_DATA_SUBCLASS               0x00
 138                         #define CDC_DATA_PROTOCOL               0x00
 139
 140                         #define CDC_FOUND_DATAPIPE_IN           (1 << 0)
 141                         #define CDC_FOUND_DATAPIPE_OUT          (1 << 1)
 142                         #define CDC_FOUND_DATAPIPE_NOTIFICATION (1 << 2)
 143
 144                 /* Function Prototypes: */
 145                         #if defined(INCLUDE_FROM_CDC_CLASS_HOST_C)
 146                                 static uint8_t CDC_Host_ProcessConfigDescriptor(USB_ClassInfo_CDC_Host_t* CDCInterfaceInfo);
 147                                 static uint8_t DComp_CDC_Host_NextCDCControlInterface(void* CurrentDescriptor);
 148                                 static uint8_t DComp_CDC_Host_NextCDCDataInterface(void* CurrentDescriptor);
 149                                 static uint8_t DComp_CDC_Host_NextInterfaceCDCDataEndpoint(void* CurrentDescriptor);
 150                         #endif
 151
 152                         void EVENT_CDC_Host_ControLineStateChanged(USB_ClassInfo_CDC_Host_t* CDCInterfaceInfo);
 153
 154                         uint8_t CDC_Host_SetLineEncoding(USB_ClassInfo_CDC_Host_t* CDCInterfaceInfo);
 155                         uint8_t CDC_Host_SendControlLineStateChange(USB_ClassInfo_CDC_Host_t* CDCInterfaceInfo);
 156
 157                         void CDC_Host_SendString(USB_ClassInfo_CDC_Host_t* CDCInterfaceInfo, char* Data, uint16_t Length);
 158                         void CDC_Host_SendByte(USB_ClassInfo_CDC_Host_t* CDCInterfaceInfo, uint8_t Data);
 159                         uint16_t CDC_Host_BytesReceived(USB_ClassInfo_CDC_Host_t* CDCInterfaceInfo);
 160                         uint8_t CDC_Host_ReceiveByte(USB_ClassInfo_CDC_Host_t* CDCInterfaceInfo);
 161
 162         #endif
 163
 164         /* Disable C linkage for C++ Compilers: */
 165                 #if defined(__cplusplus)
 166                         }
 167                 #endif
 168
 169 #endif
 170
 171 /** @} */