Descriptors.h

   1 /*\r
   2              LUFA Library\r
   3      Copyright (C) Dean Camera, 2011.\r
   4 \r
   5   dean [at] fourwalledcubicle [dot] com\r
   6            www.lufa-lib.org\r
   7 */\r
   8 \r
   9 /*\r
  10   Copyright 2011  Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
  11 \r
  12   Permission to use, copy, modify, distribute, and sell this\r
  13   software and its documentation for any purpose is hereby granted\r
  14   without fee, provided that the above copyright notice appear in\r
  15   all copies and that both that the copyright notice and this\r
  16   permission notice and warranty disclaimer appear in supporting\r
  17   documentation, and that the name of the author not be used in\r
  18   advertising or publicity pertaining to distribution of the\r
  19   software without specific, written prior permission.\r
  20 \r
  21   The author disclaim all warranties with regard to this\r
  22   software, including all implied warranties of merchantability\r
  23   and fitness.  In no event shall the author be liable for any\r
  24   special, indirect or consequential damages or any damages\r
  25   whatsoever resulting from loss of use, data or profits, whether\r
  26   in an action of contract, negligence or other tortious action,\r
  27   arising out of or in connection with the use or performance of\r
  28   this software.\r
  29 */\r
  30 \r
  31 /** \file\r
  32  *\r
  33  *  Header file for Descriptors.c.\r
  34  */\r
  35 \r
  36 #ifndef _DESCRIPTORS_H_\r
  37 #define _DESCRIPTORS_H_\r
  38 \r
  39         /* Includes: */\r
  40                 #include <avr/pgmspace.h>\r
  41 \r
  42                 #include <LUFA/Drivers/USB/USB.h>\r
  43 \r
  44         /* Macros: */\r
  45                 /** Endpoint number of the first CDC interface's device-to-host data IN endpoint. */\r
  46                 #define CDC1_TX_EPNUM                  1\r
  47 \r
  48                 /** Endpoint number of the first CDC interface's host-to-device data OUT endpoint. */\r
  49                 #define CDC1_RX_EPNUM                  2\r
  50 \r
  51                 /** Endpoint number of the first CDC interface's device-to-host notification IN endpoint. */\r
  52                 #define CDC1_NOTIFICATION_EPNUM        3\r
  53 \r
  54                 /** Endpoint number of the second CDC interface's device-to-host data IN endpoint. */\r
  55                 #define CDC2_TX_EPNUM                  4\r
  56 \r
  57                 /** Endpoint number of the second CDC interface's host-to-device data OUT endpoint. */\r
  58                 #define CDC2_RX_EPNUM                  5\r
  59 \r
  60                 /** Endpoint number of the second CDC interface's device-to-host notification IN endpoint. */\r
  61                 #define CDC2_NOTIFICATION_EPNUM        6\r
  62 \r
  63                 /** Size in bytes of the CDC device-to-host notification IN endpoints. */\r
  64                 #define CDC_NOTIFICATION_EPSIZE        8\r
  65 \r
  66                 /** Size in bytes of the CDC data IN and OUT endpoints. */\r
  67                 #define CDC_TXRX_EPSIZE                16\r
  68 \r
  69         /* Type Defines: */\r
  70                 /** Type define for the device configuration descriptor structure. This must be defined in the\r
  71                  *  application code, as the configuration descriptor contains several sub-descriptors which\r
  72                  *  vary between devices, and which describe the device's usage to the host.\r
  73                  */\r
  74                 typedef struct\r
  75                 {\r
  76                         USB_Descriptor_Configuration_Header_t    Config;\r
  77 \r
  78                         // First CDC Control Interface\r
  79                         USB_Descriptor_Interface_Association_t   CDC1_IAD;\r
  80                         USB_Descriptor_Interface_t               CDC1_CCI_Interface;\r
  81                         USB_CDC_Descriptor_FunctionalHeader_t    CDC1_Functional_Header;\r
  82                         USB_CDC_Descriptor_FunctionalACM_t       CDC1_Functional_ACM;\r
  83                         USB_CDC_Descriptor_FunctionalUnion_t     CDC1_Functional_Union;\r
  84                         USB_Descriptor_Endpoint_t                CDC1_ManagementEndpoint;\r
  85 \r
  86                         // First CDC Data Interface\r
  87                         USB_Descriptor_Interface_t               CDC1_DCI_Interface;\r
  88                         USB_Descriptor_Endpoint_t                CDC1_DataOutEndpoint;\r
  89                         USB_Descriptor_Endpoint_t                CDC1_DataInEndpoint;\r
  90 \r
  91                         // Second CDC Control Interface\r
  92                         USB_Descriptor_Interface_Association_t   CDC2_IAD;\r
  93                         USB_Descriptor_Interface_t               CDC2_CCI_Interface;\r
  94                         USB_CDC_Descriptor_FunctionalHeader_t    CDC2_Functional_Header;\r
  95                         USB_CDC_Descriptor_FunctionalACM_t       CDC2_Functional_ACM;\r
  96                         USB_CDC_Descriptor_FunctionalUnion_t     CDC2_Functional_Union;\r
  97                         USB_Descriptor_Endpoint_t                CDC2_ManagementEndpoint;\r
  98 \r
  99                         // Second CDC Data Interface\r
 100                         USB_Descriptor_Interface_t               CDC2_DCI_Interface;\r
 101                         USB_Descriptor_Endpoint_t                CDC2_DataOutEndpoint;\r
 102                         USB_Descriptor_Endpoint_t                CDC2_DataInEndpoint;\r
 103                 } USB_Descriptor_Configuration_t;\r
 104 \r
 105         /* Function Prototypes: */\r
 106                 uint16_t CALLBACK_USB_GetDescriptor(const uint16_t wValue,\r
 107                                                     const uint8_t wIndex,\r
 108                                                     const void** const DescriptorAddress)\r
 109                                                     ATTR_WARN_UNUSED_RESULT ATTR_NON_NULL_PTR_ARG(3);\r
 110 \r
 111 #endif\r