Demos/Device/LowLevel/DualVirtualSerial/Descriptors.h

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2010.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6       www.fourwalledcubicle.com
   7 */
   8
   9 /*
  10   Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)
  11
  12   Permission to use, copy, modify, distribute, and sell this
  13   software and its documentation for any purpose is hereby granted
  14   without fee, provided that the above copyright notice appear in
  15   all 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 /** \file
  32  *
  33  *  Header file for Descriptors.c.
  34  */
  35
  36 #ifndef _DESCRIPTORS_H_
  37 #define _DESCRIPTORS_H_
  38
  39         /* Includes: */
  40                 #include <LUFA/Drivers/USB/USB.h>
  41
  42                 #include <avr/pgmspace.h>
  43
  44         /* Macros: */
  45                 /** Macro to define a CDC class-specific functional descriptor. CDC functional descriptors have a
  46                  *  uniform structure but variable sized data payloads, thus cannot be represented accurately by
  47                  *  a single typedef struct. A macro is used instead so that functional descriptors can be created
  48                  *  easily by specifying the size of the payload. This allows sizeof() to work correctly.
  49                  *
  50                  *  \param[in] DataSize  Size in bytes of the CDC functional descriptor's data payload
  51                  */
  52                 #define CDC_FUNCTIONAL_DESCRIPTOR(DataSize)        \
  53                      struct                                        \
  54                      {                                             \
  55                           USB_Descriptor_Header_t Header;          \
  56                               uint8_t                 SubType;         \
  57                           uint8_t                 Data[DataSize];  \
  58                      }
  59
  60                 /** Endpoint number of the first CDC interface's device-to-host notification IN endpoint. */
  61                 #define CDC1_NOTIFICATION_EPNUM        3
  62
  63                 /** Endpoint number of the first CDC interface's device-to-host data IN endpoint. */
  64                 #define CDC1_TX_EPNUM                  1
  65
  66                 /** Endpoint number of the first CDC interface's host-to-device data OUT endpoint. */
  67                 #define CDC1_RX_EPNUM                  2
  68
  69                 /** Endpoint number of the second CDC interface's device-to-host notification IN endpoint. */
  70                 #define CDC2_NOTIFICATION_EPNUM        4
  71
  72                 /** Endpoint number of the second CDC interface's device-to-host data IN endpoint. */
  73                 #define CDC2_TX_EPNUM                  5
  74
  75                 /** Endpoint number of the second CDC interface's host-to-device data OUT endpoint. */
  76                 #define CDC2_RX_EPNUM                  6
  77
  78                 /** Size in bytes of the CDC device-to-host notification IN endpoints. */
  79                 #define CDC_NOTIFICATION_EPSIZE        8
  80
  81                 /** Size in bytes of the CDC data IN and OUT endpoints. */
  82                 #define CDC_TXRX_EPSIZE                16
  83
  84         /* Type Defines: */
  85                 /** Type define for the device configuration descriptor structure. This must be defined in the
  86                  *  application code, as the configuration descriptor contains several sub-descriptors which
  87                  *  vary between devices, and which describe the device's usage to the host.
  88                  */
  89                 typedef struct
  90                 {
  91                         USB_Descriptor_Configuration_Header_t    Config;
  92                         USB_Descriptor_Interface_Association_t   CDC1_IAD;
  93                         USB_Descriptor_Interface_t               CDC1_CCI_Interface;
  94                         CDC_FUNCTIONAL_DESCRIPTOR(2)             CDC1_Functional_IntHeader;
  95                         CDC_FUNCTIONAL_DESCRIPTOR(1)             CDC1_Functional_AbstractControlManagement;
  96                         CDC_FUNCTIONAL_DESCRIPTOR(2)             CDC1_Functional_Union;
  97                         USB_Descriptor_Endpoint_t                CDC1_ManagementEndpoint;
  98                         USB_Descriptor_Interface_t               CDC1_DCI_Interface;
  99                         USB_Descriptor_Endpoint_t                CDC1_DataOutEndpoint;
 100                         USB_Descriptor_Endpoint_t                CDC1_DataInEndpoint;
 101                         USB_Descriptor_Interface_Association_t   CDC2_IAD;
 102                         USB_Descriptor_Interface_t               CDC2_CCI_Interface;
 103                         CDC_FUNCTIONAL_DESCRIPTOR(2)             CDC2_Functional_IntHeader;
 104                         CDC_FUNCTIONAL_DESCRIPTOR(1)             CDC2_Functional_AbstractControlManagement;
 105                         CDC_FUNCTIONAL_DESCRIPTOR(2)             CDC2_Functional_Union;
 106                         USB_Descriptor_Endpoint_t                CDC2_ManagementEndpoint;
 107                         USB_Descriptor_Interface_t               CDC2_DCI_Interface;
 108                         USB_Descriptor_Endpoint_t                CDC2_DataOutEndpoint;
 109                         USB_Descriptor_Endpoint_t                CDC2_DataInEndpoint;
 110                 } USB_Descriptor_Configuration_t;
 111
 112         /* Function Prototypes: */
 113                 uint16_t CALLBACK_USB_GetDescriptor(const uint16_t wValue, const uint8_t wIndex, void** const DescriptorAddress)
 114                                                                                         ATTR_WARN_UNUSED_RESULT ATTR_NON_NULL_PTR_ARG(3);
 115
 116 #endif