Demos/Device/ClassDriver/RNDISEthernet/Descriptors.h

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