Upgrade doxygen configuration files to the latest version.

[pub/lufa.git] / Demos / Device / ClassDriver / RNDISEthernet / Descriptors.h

diff --git a/Demos/Device/ClassDriver/RNDISEthernet/Descriptors.h b/Demos/Device/ClassDriver/RNDISEthernet/Descriptors.h
index 7ae8c22..10d815b 100644 (file)
--- a/Demos/Device/ClassDriver/RNDISEthernet/Descriptors.h
+++ b/Demos/Device/ClassDriver/RNDISEthernet/Descriptors.h
@@ -1,13 +1,13 @@
 /*
              LUFA Library
-     Copyright (C) Dean Camera, 2013.
+     Copyright (C) Dean Camera, 2021.
 
   dean [at] fourwalledcubicle [dot] com
            www.lufa-lib.org
 */
 
 /*
-  Copyright 2013  Dean Camera (dean [at] fourwalledcubicle [dot] com)
+  Copyright 2021  Dean Camera (dean [at] fourwalledcubicle [dot] com)
 
   Permission to use, copy, modify, distribute, and sell this
   software and its documentation for any purpose is hereby granted
@@ -42,7 +42,7 @@
                #include <avr/pgmspace.h>
 
                #include "Config/AppConfig.h"
-               
+
        /* Macros: */
                /** Endpoint address of the CDC device-to-host notification IN endpoint. */
                #define CDC_NOTIFICATION_EPADDR        (ENDPOINT_DIR_IN  | 3)
@@ -59,6 +59,10 @@
                /** Size in bytes of the CDC data IN and OUT endpoints. */
                #define CDC_TXRX_EPSIZE                64
 
+               /** Vendor request (0-255) the host should issue to retrieve the
+                *  Microsoft OS Compatibility Descriptors. */
+               #define VENDOR_REQUEST_ID_MS_COMPAT    0x01
+
        /* Type Defines: */
                /** Type define for the device configuration descriptor structure. This must be defined in the
                 *  application code, as the configuration descriptor contains several sub-descriptors which
@@ -81,11 +85,50 @@
                        USB_Descriptor_Endpoint_t             RNDIS_DataInEndpoint;
                } USB_Descriptor_Configuration_t;
 
+               /** Type define for a Microsoft OS Compatibility 1.0 descriptor. */
+               typedef struct
+               {
+                       uint32_t dwLength;
+                       uint16_t bcdVersion;
+                       uint16_t wIndex;
+                       uint8_t  bCount;
+                       uint8_t  bReserved[7];
+                       uint8_t  bFirstInterfaceNumber;
+                       uint8_t  bReserved2;
+                       char     compatibleID[8];
+                       char     subCompatibleID[8];
+                       uint8_t  bReserved3[6];
+               } USB_Descriptor_MSCompatibility_t;
+
+               /** Enum for the device interface descriptor IDs within the device. Each interface descriptor
+                *  should have a unique ID index associated with it, which can be used to refer to the
+                *  interface from other descriptors.
+                */
+               enum InterfaceDescriptors_t
+               {
+                       INTERFACE_ID_CDC_CCI = 0, /**< CDC CCI interface descriptor ID */
+                       INTERFACE_ID_CDC_DCI = 1, /**< CDC DCI interface descriptor ID */
+               };
+
+               /** Enum for the device string descriptor IDs within the device. Each string descriptor should
+                *  have a unique ID index associated with it, which can be used to refer to the string from
+                *  other descriptors.
+                */
+               enum StringDescriptors_t
+               {
+                       STRING_ID_Language     = 0, /**< Supported Languages string descriptor ID (must be zero) */
+                       STRING_ID_Manufacturer = 1, /**< Manufacturer string ID */
+                       STRING_ID_Product      = 2, /**< Product string ID */
+                       STRING_ID_MS_Compat    = 0xEE, /**< MS OS Compatibility string descriptor ID (magic value set by Microsoft) */
+               };
+
        /* Function Prototypes: */
                uint16_t CALLBACK_USB_GetDescriptor(const uint16_t wValue,
-                                                   const uint8_t wIndex,
+                                                   const uint16_t wIndex,
                                                    const void** const DescriptorAddress)
                                                    ATTR_WARN_UNUSED_RESULT ATTR_NON_NULL_PTR_ARG(3);
 
+               void     CheckIfMSCompatibilityDescriptorRequest(void);
+
 #endif