protocol/lufa/LUFA-git/Demos/Device/ClassDriver/DualVirtualSerial/Descriptors.h

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2014.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2014  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 disclaims 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 <avr/pgmspace.h>
  41
  42                 #include <LUFA/Drivers/USB/USB.h>
  43
  44         /* Macros: */
  45                 /** Endpoint address of the first CDC interface's device-to-host data IN endpoint. */
  46                 #define CDC1_TX_EPADDR                 (ENDPOINT_DIR_IN  | 1)
  47
  48                 /** Endpoint address of the first CDC interface's host-to-device data OUT endpoint. */
  49                 #define CDC1_RX_EPADDR                 (ENDPOINT_DIR_OUT | 2)
  50
  51                 /** Endpoint address of the first CDC interface's device-to-host notification IN endpoint. */
  52                 #define CDC1_NOTIFICATION_EPADDR       (ENDPOINT_DIR_IN  | 3)
  53
  54                 /** Endpoint address of the second CDC interface's device-to-host data IN endpoint. */
  55                 #define CDC2_TX_EPADDR                 (ENDPOINT_DIR_IN  | 4)
  56
  57                 /** Endpoint address of the second CDC interface's host-to-device data OUT endpoint. */
  58                 #define CDC2_RX_EPADDR                 (ENDPOINT_DIR_OUT | 5)
  59
  60                 /** Endpoint address of the second CDC interface's device-to-host notification IN endpoint. */
  61                 #define CDC2_NOTIFICATION_EPADDR       (ENDPOINT_DIR_IN  | 6)
  62
  63                 /** Size in bytes of the CDC device-to-host notification IN endpoints. */
  64                 #define CDC_NOTIFICATION_EPSIZE        8
  65
  66                 /** Size in bytes of the CDC data IN and OUT endpoints. */
  67                 #define CDC_TXRX_EPSIZE                16
  68
  69         /* Type Defines: */
  70                 /** Type define for the device configuration descriptor structure. This must be defined in the
  71                  *  application code, as the configuration descriptor contains several sub-descriptors which
  72                  *  vary between devices, and which describe the device's usage to the host.
  73                  */
  74                 typedef struct
  75                 {
  76                         USB_Descriptor_Configuration_Header_t    Config;
  77
  78                         // First CDC Control Interface
  79                         USB_Descriptor_Interface_Association_t   CDC1_IAD;
  80                         USB_Descriptor_Interface_t               CDC1_CCI_Interface;
  81                         USB_CDC_Descriptor_FunctionalHeader_t    CDC1_Functional_Header;
  82                         USB_CDC_Descriptor_FunctionalACM_t       CDC1_Functional_ACM;
  83                         USB_CDC_Descriptor_FunctionalUnion_t     CDC1_Functional_Union;
  84                         USB_Descriptor_Endpoint_t                CDC1_ManagementEndpoint;
  85
  86                         // First CDC Data Interface
  87                         USB_Descriptor_Interface_t               CDC1_DCI_Interface;
  88                         USB_Descriptor_Endpoint_t                CDC1_DataOutEndpoint;
  89                         USB_Descriptor_Endpoint_t                CDC1_DataInEndpoint;
  90
  91                         // Second CDC Control Interface
  92                         USB_Descriptor_Interface_Association_t   CDC2_IAD;
  93                         USB_Descriptor_Interface_t               CDC2_CCI_Interface;
  94                         USB_CDC_Descriptor_FunctionalHeader_t    CDC2_Functional_Header;
  95                         USB_CDC_Descriptor_FunctionalACM_t       CDC2_Functional_ACM;
  96                         USB_CDC_Descriptor_FunctionalUnion_t     CDC2_Functional_Union;
  97                         USB_Descriptor_Endpoint_t                CDC2_ManagementEndpoint;
  98
  99                         // Second CDC Data Interface
 100                         USB_Descriptor_Interface_t               CDC2_DCI_Interface;
 101                         USB_Descriptor_Endpoint_t                CDC2_DataOutEndpoint;
 102                         USB_Descriptor_Endpoint_t                CDC2_DataInEndpoint;
 103                 } USB_Descriptor_Configuration_t;
 104
 105                 /** Enum for the device interface descriptor IDs within the device. Each interface descriptor
 106                  *  should have a unique ID index associated with it, which can be used to refer to the
 107                  *  interface from other descriptors.
 108                  */
 109                 enum InterfaceDescriptors_t
 110                 {
 111                         INTERFACE_ID_CDC1_CCI = 0, /**< CDC1 CCI interface descriptor ID */
 112                         INTERFACE_ID_CDC1_DCI = 1, /**< CDC1 DCI interface descriptor ID */
 113                         INTERFACE_ID_CDC2_CCI = 2, /**< CDC2 CCI interface descriptor ID */
 114                         INTERFACE_ID_CDC2_DCI = 3, /**< CDC2 DCI interface descriptor ID */
 115                 };
 116
 117                 /** Enum for the device string descriptor IDs within the device. Each string descriptor should
 118                  *  have a unique ID index associated with it, which can be used to refer to the string from
 119                  *  other descriptors.
 120                  */
 121                 enum StringDescriptors_t
 122                 {
 123                         STRING_ID_Language     = 0, /**< Supported Languages string descriptor ID (must be zero) */
 124                         STRING_ID_Manufacturer = 1, /**< Manufacturer string ID */
 125                         STRING_ID_Product      = 2, /**< Product string ID */
 126                 };
 127
 128         /* Function Prototypes: */
 129                 uint16_t CALLBACK_USB_GetDescriptor(const uint16_t wValue,
 130                                                     const uint8_t wIndex,
 131                                                     const void** const DescriptorAddress)
 132                                                     ATTR_WARN_UNUSED_RESULT ATTR_NON_NULL_PTR_ARG(3);
 133
 134 #endif
 135