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                         typedef struct
  55                         {
  56                                 uint8_t  ControlInterfaceNumber; /**< Interface number of the CDC control interface within the device */
  57
  58                                 uint8_t  DataINPipeNumber; /**< Pipe number of the CDC interface's IN data pipe */
  59                                 uint16_t DataINPipeSize; /**< Size in bytes of the CDC interface's IN data pipe */
  60
  61                                 uint8_t  DataOUTPipeNumber; /**< Pipe number of the CDC interface's OUT data pipe */
  62                                 uint16_t DataOUTPipeSize;  /**< Size in bytes of the CDC interface's OUT data pipe */
  63
  64                                 uint8_t  NotificationPipeNumber; /**< Pipe number of the CDC interface's IN notification endpoint, if used */
  65                                 uint16_t NotificationPipeSize;  /**< Size in bytes of the CDC interface's IN notification endpoint, if used */
  66
  67                                 uint8_t  ControlLineState; /**< Current control line states */
  68
  69                                 struct
  70                                 {
  71                                         uint32_t BaudRateBPS; /**< Baud rate of the virtual serial port, in bits per second */
  72                                         uint8_t  CharFormat; /**< Character format of the virtual serial port, a value from the
  73                                                                                   *   CDCDevice_CDC_LineCodingFormats_t enum
  74                                                                                   */
  75                                         uint8_t  ParityType; /**< Parity setting of the virtual serial port, a value from the
  76                                                                                   *   CDCDevice_LineCodingParity_t enum
  77                                                                                   */
  78                                         uint8_t  DataBits; /**< Bits of data per character of the virtual serial port */
  79                                 } LineEncoding;
  80                         } USB_ClassInfo_CDC_Host_t;
  81
  82                 /* Enums: */
  83                         typedef enum
  84                         {
  85                                 CDC_ENUMERROR_NoError                    = 0, /**< Configuration Descriptor was processed successfully */
  86                                 CDC_ENUMERROR_ControlError               = 1, /**< A control request to the device failed to complete successfully */
  87                                 CDC_ENUMERROR_DescriptorTooLarge         = 2, /**< The device's Configuration Descriptor is too large to process */
  88                                 CDC_ENUMERROR_InvalidConfigDataReturned  = 3, /**< The device returned an invalid Configuration Descriptor */
  89                                 CDC_ENUMERROR_NoCDCInterfaceFound        = 4, /**< A compatible CDC interface was not found in the device's Configuration Descriptor */
  90                                 CDC_ENUMERROR_NoEndpointFound            = 5, /**< Compatible CDC endpoints were not found in the device's CDC interface */
  91                         } CDCHost_EnumerationFailure_ErrorCodes_t;
  92
  93                 /* Function Prototypes: */
  94                         void CDC_Host_USBTask(USB_ClassInfo_CDC_Host_t* CDCInterfaceInfo);
  95
  96         /* Private Interface - For use in library only: */
  97         #if !defined(__DOXYGEN__)
  98                 /* Macros: */
  99                         #define CDC_CONTROL_CLASS              0x02
 100                         #define CDC_CONTROL_SUBCLASS           0x02
 101                         #define CDC_CONTROL_PROTOCOL           0x01
 102                         #define CDC_DATA_CLASS                 0x0A
 103                         #define CDC_DATA_SUBCLASS              0x00
 104                         #define CDC_DATA_PROTOCOL              0x00
 105
 106                 /* Function Prototypes: */
 107                         #if defined(INCLUDE_FROM_CDC_CLASS_HOST_C)
 108                                 static uint8_t CDC_Host_ProcessConfigDescriptor(void);
 109                                 static uint8_t DComp_CDC_Host_NextCDCControlInterface(void* CurrentDescriptor);
 110                                 static uint8_t DComp_CDC_Host_NextCDCDataInterface(void* CurrentDescriptor);
 111                                 static uint8_t DComp_CDC_Host_NextInterfaceCDCDataEndpoint(void* CurrentDescriptor);
 112                         #endif
 113
 114         #endif
 115
 116         /* Disable C linkage for C++ Compilers: */
 117                 #if defined(__cplusplus)
 118                         }
 119                 #endif
 120
 121 #endif
 122
 123 /** @} */