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                                         uint8_t  DataOUTPipeNumber; /**< Pipe number of the CDC interface's OUT data pipe */
  68                                         uint8_t  NotificationPipeNumber; /**< Pipe number of the CDC interface's IN notification endpoint, if used */
  69                                 } Config; /**< Config data for the USB class interface within the device. All elements in this section
  70                                            *   <b>must</b> be set or the interface will fail to enumerate and operate correctly.
  71                                            */
  72                                 struct
  73                                 {
  74                                         bool Active; /**< Indicates if the current interface instance is connected to an attached device */
  75
  76                                         uint8_t ControlInterfaceNumber; /**< Interface index of the CDC-ACM control interface within the attached device */
  77
  78                                         uint16_t DataINPipeSize; /**< Size in bytes of the CDC interface's IN data pipe */
  79                                         uint16_t DataOUTPipeSize;  /**< Size in bytes of the CDC interface's OUT data pipe */
  80                                         uint16_t NotificationPipeSize;  /**< Size in bytes of the CDC interface's IN notification endpoint, if used */
  81
  82                                         struct
  83                                         {
  84                                                 uint8_t HostToDevice; /**< Control line states from the host to device, as a set of CDC_CONTROL_LINE_OUT_*
  85                                                                                            *   masks.
  86                                                                                            */
  87                                                 uint8_t DeviceToHost; /**< Control line states from the device to host, as a set of CDC_CONTROL_LINE_IN_*
  88                                                                                            *   masks.
  89                                                                                            */
  90                                         } ControlLineStates;
  91
  92                                         struct
  93                                         {
  94                                                 bool Active; /**< Indicates if the interface is currently active, i.e. attached to the connected device */
  95
  96                                                 uint32_t BaudRateBPS; /**< Baud rate of the virtual serial port, in bits per second */
  97                                                 uint8_t  CharFormat; /**< Character format of the virtual serial port, a value from the
  98                                                                                           *   CDCDevice_CDC_LineCodingFormats_t enum
  99                                                                                           */
 100                                                 uint8_t  ParityType; /**< Parity setting of the virtual serial port, a value from the
 101                                                                                           *   CDCDevice_LineCodingParity_t enum
 102                                                                                           */
 103                                                 uint8_t  DataBits; /**< Bits of data per character of the virtual serial port */
 104                                         } LineEncoding;
 105                                 } State; /**< State data for the USB class interface within the device. All elements in this section
 106                                                   *   <b>may</b> be set to initial values, but may also be ignored to default to sane values when
 107                                                   *   the interface is enumerated.
 108                                                   */
 109                         } USB_ClassInfo_CDC_Host_t;
 110
 111                 /* Enums: */
 112                         enum
 113                         {
 114                                 CDC_ENUMERROR_NoError                    = 0, /**< Configuration Descriptor was processed successfully */
 115                                 CDC_ENUMERROR_InvalidConfigDescriptor    = 1, /**< The device returned an invalid Configuration Descriptor */
 116                                 CDC_ENUMERROR_NoCDCInterfaceFound        = 2, /**< A compatible CDC interface was not found in the device's Configuration Descriptor */
 117                                 CDC_ENUMERROR_EndpointsNotFound          = 3, /**< Compatible CDC endpoints were not found in the device's CDC interface */
 118                         } CDCHost_EnumerationFailure_ErrorCodes_t;
 119
 120                 /* Function Prototypes: */
 121                         void CDC_Host_USBTask(USB_ClassInfo_CDC_Host_t* CDCInterfaceInfo);
 122                         uint8_t CDC_Host_ConfigurePipes(USB_ClassInfo_CDC_Host_t* CDCInterfaceInfo, uint16_t ConfigDescriptorLength,
 123                                                         uint8_t* DeviceConfigDescriptor);
 124
 125                         uint8_t CDC_Host_SetLineEncoding(USB_ClassInfo_CDC_Host_t* CDCInterfaceInfo);
 126                         uint8_t CDC_Host_SendControlLineStateChange(USB_ClassInfo_CDC_Host_t* CDCInterfaceInfo);
 127
 128                         void CDC_Host_SendString(USB_ClassInfo_CDC_Host_t* CDCInterfaceInfo, char* Data, uint16_t Length);
 129                         void CDC_Host_SendByte(USB_ClassInfo_CDC_Host_t* CDCInterfaceInfo, uint8_t Data);
 130                         uint16_t CDC_Host_BytesReceived(USB_ClassInfo_CDC_Host_t* CDCInterfaceInfo);
 131                         uint8_t CDC_Host_ReceiveByte(USB_ClassInfo_CDC_Host_t* CDCInterfaceInfo);
 132
 133         /* Private Interface - For use in library only: */
 134         #if !defined(__DOXYGEN__)
 135                 /* Macros: */
 136                         #define CDC_CONTROL_CLASS               0x02
 137                         #define CDC_CONTROL_SUBCLASS            0x02
 138                         #define CDC_CONTROL_PROTOCOL            0x01
 139                         #define CDC_DATA_CLASS                  0x0A
 140                         #define CDC_DATA_SUBCLASS               0x00
 141                         #define CDC_DATA_PROTOCOL               0x00
 142
 143                         #define CDC_FOUND_DATAPIPE_IN           (1 << 0)
 144                         #define CDC_FOUND_DATAPIPE_OUT          (1 << 1)
 145                         #define CDC_FOUND_DATAPIPE_NOTIFICATION (1 << 2)
 146
 147                 /* Function Prototypes: */
 148                         #if defined(INCLUDE_FROM_CDC_CLASS_HOST_C)
 149                                 void CDC_Host_Event_Stub(void);
 150                                 void EVENT_CDC_Host_ControLineStateChanged(USB_ClassInfo_CDC_Host_t* CDCInterfaceInfo)
 151                                                                            ATTR_WEAK ATTR_ALIAS(CDC_Host_Event_Stub);
 152                                 static uint8_t DComp_CDC_Host_NextCDCControlInterface(void* CurrentDescriptor);
 153                                 static uint8_t DComp_CDC_Host_NextCDCDataInterface(void* CurrentDescriptor);
 154                                 static uint8_t DComp_CDC_Host_NextInterfaceCDCDataEndpoint(void* CurrentDescriptor);
 155                         #endif
 156         #endif
 157
 158         /* Disable C linkage for C++ Compilers: */
 159                 #if defined(__cplusplus)
 160                         }
 161                 #endif
 162
 163 #endif
 164
 165 /** @} */