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                                         uint32_t BaudRateBPS; /**< Baud rate of the virtual serial port, in bits per second */
  84                                         uint8_t  CharFormat; /**< Character format of the virtual serial port, a value from the
  85                                                                                   *   CDCDevice_CDC_LineCodingFormats_t enum
  86                                                                                   */
  87                                         uint8_t  ParityType; /**< Parity setting of the virtual serial port, a value from the
  88                                                                                   *   CDCDevice_LineCodingParity_t enum
  89                                                                                   */
  90                                         uint8_t  DataBits; /**< Bits of data per character of the virtual serial port */
  91                                 } LineEncoding;
  92                         } USB_ClassInfo_CDC_Host_State_t;
  93
  94                         /** Class state structure. An instance of this structure should be made within the user application,
  95                          *  and passed to each of the CDC class driver functions as the CDCInterfaceInfo parameter. This
  96                          *  stores each CDC interface's configuration and state information.
  97                          */
  98                         typedef struct
  99                         {
 100                                 const USB_ClassInfo_CDC_Host_Config_t Config; /**< Config data for the USB class interface within
 101                                                                                *   the device. All elements in this section
 102                                                                                *   <b>must</b> be set or the interface will fail
 103                                                                                *   to enumerate and operate correctly.
 104                                                                                */
 105
 106                                 USB_ClassInfo_CDC_Host_State_t State; /**< State data for the USB class interface within
 107                                                                        *   the device. All elements in this section
 108                                                                        *   <b>may</b> be set to initial values, but may
 109                                                                        *   also be ignored to default to sane values when
 110                                                                        *   the interface is enumerated.
 111                                                                        */
 112                         } USB_ClassInfo_CDC_Host_t;
 113
 114                 /* Enums: */
 115                         typedef enum
 116                         {
 117                                 CDC_ENUMERROR_NoError                    = 0, /**< Configuration Descriptor was processed successfully */
 118                                 CDC_ENUMERROR_ControlError               = 1, /**< A control request to the device failed to complete successfully */
 119                                 CDC_ENUMERROR_DescriptorTooLarge         = 2, /**< The device's Configuration Descriptor is too large to process */
 120                                 CDC_ENUMERROR_InvalidConfigDataReturned  = 3, /**< The device returned an invalid Configuration Descriptor */
 121                                 CDC_ENUMERROR_NoCDCInterfaceFound        = 4, /**< A compatible CDC interface was not found in the device's Configuration Descriptor */
 122                                 CDC_ENUMERROR_NoEndpointFound            = 5, /**< Compatible CDC endpoints were not found in the device's CDC interface */
 123                         } CDCHost_EnumerationFailure_ErrorCodes_t;
 124
 125                 /* Function Prototypes: */
 126                         void CDC_Host_USBTask(USB_ClassInfo_CDC_Host_t* CDCInterfaceInfo);
 127
 128         /* Private Interface - For use in library only: */
 129         #if !defined(__DOXYGEN__)
 130                 /* Macros: */
 131                         #define CDC_CONTROL_CLASS               0x02
 132                         #define CDC_CONTROL_SUBCLASS            0x02
 133                         #define CDC_CONTROL_PROTOCOL            0x01
 134                         #define CDC_DATA_CLASS                  0x0A
 135                         #define CDC_DATA_SUBCLASS               0x00
 136                         #define CDC_DATA_PROTOCOL               0x00
 137
 138                         #define CDC_FOUND_DATAPIPE_IN           (1 << 0)
 139                         #define CDC_FOUND_DATAPIPE_OUT          (1 << 1)
 140                         #define CDC_FOUND_DATAPIPE_NOTIFICATION (1 << 2)
 141
 142                 /* Function Prototypes: */
 143                         #if defined(INCLUDE_FROM_CDC_CLASS_HOST_C)
 144                                 static uint8_t CDC_Host_ProcessConfigDescriptor(USB_ClassInfo_CDC_Host_t* CDCInterfaceInfo);
 145                                 static uint8_t DComp_CDC_Host_NextCDCControlInterface(void* CurrentDescriptor);
 146                                 static uint8_t DComp_CDC_Host_NextCDCDataInterface(void* CurrentDescriptor);
 147                                 static uint8_t DComp_CDC_Host_NextInterfaceCDCDataEndpoint(void* CurrentDescriptor);
 148                         #endif
 149
 150                         void EVENT_CDC_Host_ControLineStateChanged(USB_ClassInfo_CDC_Host_t* CDCInterfaceInfo);
 151
 152                         uint8_t CDC_Host_SetLineEncoding(USB_ClassInfo_CDC_Host_t* CDCInterfaceInfo);
 153                         uint8_t CDC_Host_SendControlLineStateChange(USB_ClassInfo_CDC_Host_t* CDCInterfaceInfo);
 154
 155                         void CDC_Host_SendString(USB_ClassInfo_CDC_Host_t* CDCInterfaceInfo, char* Data, uint16_t Length);
 156                         void CDC_Host_SendByte(USB_ClassInfo_CDC_Host_t* CDCInterfaceInfo, uint8_t Data);
 157                         uint16_t CDC_Host_BytesReceived(USB_ClassInfo_CDC_Host_t* CDCInterfaceInfo);
 158                         uint8_t CDC_Host_ReceiveByte(USB_ClassInfo_CDC_Host_t* CDCInterfaceInfo);
 159
 160         #endif
 161
 162         /* Disable C linkage for C++ Compilers: */
 163                 #if defined(__cplusplus)
 164                         }
 165                 #endif
 166
 167 #endif
 168
 169 /** @} */