Projects/Webserver/Descriptors.h

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2020.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2020  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                 #include "Config/AppConfig.h"
  45
  46         /* Macros: */
  47                 /** Endpoint address of the Mass Storage device-to-host data IN endpoint. */
  48                 #define MASS_STORAGE_IN_EPADDR         (ENDPOINT_DIR_IN  | 3)
  49
  50                 /** Endpoint address of the Mass Storage host-to-device data OUT endpoint. */
  51                 #define MASS_STORAGE_OUT_EPADDR        (ENDPOINT_DIR_OUT | 4)
  52
  53                 /** Size in bytes of the Mass Storage data endpoints. */
  54                 #define MASS_STORAGE_IO_EPSIZE         64
  55
  56                 /** Endpoint address of the CDC device-to-host notification IN endpoint. */
  57                 #define CDC_NOTIFICATION_EPADDR        (ENDPOINT_DIR_IN  | 5)
  58
  59                 /** Endpoint address of the CDC device-to-host data IN endpoint. */
  60                 #define CDC_TX_EPADDR                  (ENDPOINT_DIR_IN  | 1)
  61
  62                 /** Endpoint address of the CDC host-to-device data OUT endpoint. */
  63                 #define CDC_RX_EPADDR                  (ENDPOINT_DIR_OUT | 2)
  64
  65                 /** Size in bytes of the CDC device-to-host notification IN endpoint. */
  66                 #define CDC_NOTIFICATION_EPSIZE        8
  67
  68                 /** Size in bytes of the CDC data IN and OUT endpoints. */
  69                 #define CDC_TXRX_EPSIZE                64
  70
  71                 /** Vendor request (0-255) the host should issue to retrieve the
  72                  *  Microsoft OS Compatibility Descriptors. */
  73                 #define VENDOR_REQUEST_ID_MS_COMPAT    0x01
  74
  75         /* Type Defines: */
  76                 /** Type define for the device configuration descriptor structure. This must be defined in the
  77                  *  application code, as the configuration descriptor contains several sub-descriptors which
  78                  *  vary between devices, and which describe the device's usage to the host.
  79                  */
  80                 typedef struct
  81                 {
  82                         USB_Descriptor_Configuration_Header_t  Config;
  83
  84                         // RNDIS CDC Command Interface
  85                         USB_Descriptor_Interface_Association_t CDC_IAD;
  86                         USB_Descriptor_Interface_t             CDC_CCI_Interface;
  87                         USB_CDC_Descriptor_FunctionalHeader_t  CDC_Functional_Header;
  88                         USB_CDC_Descriptor_FunctionalACM_t     CDC_Functional_ACM;
  89                         USB_CDC_Descriptor_FunctionalUnion_t   CDC_Functional_Union;
  90                         USB_Descriptor_Endpoint_t              CDC_NotificationEndpoint;
  91
  92                         // RNDIS CDC Data Interface
  93                         USB_Descriptor_Interface_t             CDC_DCI_Interface;
  94                         USB_Descriptor_Endpoint_t              RNDIS_DataOutEndpoint;
  95                         USB_Descriptor_Endpoint_t              RNDIS_DataInEndpoint;
  96
  97                         // Mass Storage Interface
  98                         USB_Descriptor_Interface_t             MS_Interface;
  99                         USB_Descriptor_Endpoint_t              MS_DataInEndpoint;
 100                         USB_Descriptor_Endpoint_t              MS_DataOutEndpoint;
 101                 } USB_Descriptor_Configuration_t;
 102
 103                 /** Type define for a Microsoft OS Compatibility 1.0 descriptor. */
 104                 typedef struct
 105                 {
 106                         uint32_t dwLength;
 107                         uint16_t bcdVersion;
 108                         uint16_t wIndex;
 109                         uint8_t  bCount;
 110                         uint8_t  bReserved[7];
 111                         uint8_t  bFirstInterfaceNumber;
 112                         uint8_t  bReserved2;
 113                         char     compatibleID[8];
 114                         char     subCompatibleID[8];
 115                         uint8_t  bReserved3[6];
 116                 } USB_Descriptor_MSCompatibility_t;
 117
 118                 /** Enum for the device interface descriptor IDs within the device. Each interface descriptor
 119                  *  should have a unique ID index associated with it, which can be used to refer to the
 120                  *  interface from other descriptors.
 121                  */
 122                 enum InterfaceDescriptors_t
 123                 {
 124                         INTERFACE_ID_CDC_CCI     = 0, /**< CDC CCI interface descriptor ID */
 125                         INTERFACE_ID_CDC_DCI     = 1, /**< CDC DCI interface descriptor ID */
 126                         INTERFACE_ID_MassStorage = 2, /**< Mass storage interface descriptor ID */
 127                 };
 128
 129                 /** Enum for the device string descriptor IDs within the device. Each string descriptor should
 130                  *  have a unique ID index associated with it, which can be used to refer to the string from
 131                  *  other descriptors.
 132                  */
 133                 enum StringDescriptors_t
 134                 {
 135                         STRING_ID_Language     = 0, /**< Supported Languages string descriptor ID (must be zero) */
 136                         STRING_ID_Manufacturer = 1, /**< Manufacturer string ID */
 137                         STRING_ID_Product      = 2, /**< Product string ID */
 138                         STRING_ID_MS_Compat    = 0xEE, /**< MS OS Compatibility string descriptor ID (magic value set by Microsoft) */
 139                 };
 140
 141         /* Function Prototypes: */
 142                 uint16_t CALLBACK_USB_GetDescriptor(const uint16_t wValue,
 143                                                     const uint16_t wIndex,
 144                                                     const void** const DescriptorAddress)
 145                                                     ATTR_WARN_UNUSED_RESULT ATTR_NON_NULL_PTR_ARG(3);
 146
 147                 void     CheckIfMSCompatibilityDescriptorRequest(void);
 148
 149 #endif
 150