Upgrade doxygen configuration files to the latest version.

[pub/lufa.git] / Demos / Host / LowLevel / RNDISEthernetHost / ConfigDescriptor.h

diff --git a/Demos/Host/LowLevel/RNDISEthernetHost/ConfigDescriptor.h b/Demos/Host/LowLevel/RNDISEthernetHost/ConfigDescriptor.h
index 149d81b..d4447cf 100644 (file)
--- a/Demos/Host/LowLevel/RNDISEthernetHost/ConfigDescriptor.h
+++ b/Demos/Host/LowLevel/RNDISEthernetHost/ConfigDescriptor.h
@@ -1,24 +1,24 @@
 /*
              LUFA Library
 /*
              LUFA Library

-     Copyright (C) Dean Camera, 2010.
-              
+     Copyright (C) Dean Camera, 2021.
+

   dean [at] fourwalledcubicle [dot] com
   dean [at] fourwalledcubicle [dot] com

-      www.fourwalledcubicle.com
+           www.lufa-lib.org

 */
 
 /*
 */
 
 /*

-  Copyright 2010  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 
+  Permission to use, copy, modify, distribute, and sell this

   software and its documentation for any purpose is hereby granted
   software and its documentation for any purpose is hereby granted

-  without fee, provided that the above copyright notice appear in 
+  without fee, provided that the above copyright notice appear in

   all copies and that both that the copyright notice and this
   all copies and that both that the copyright notice and this

-  permission notice and warranty disclaimer appear in supporting 
-  documentation, and that the name of the author not be used in 
-  advertising or publicity pertaining to distribution of the 
+  permission notice and warranty disclaimer appear in supporting
+  documentation, and that the name of the author not be used in
+  advertising or publicity pertaining to distribution of the

   software without specific, written prior permission.
 
   software without specific, written prior permission.
 

-  The author disclaim all warranties with regard to this
+  The author disclaims all warranties with regard to this

   software, including all implied warranties of merchantability
   and fitness.  In no event shall the author be liable for any
   special, indirect or consequential damages or any damages
   software, including all implied warranties of merchantability
   and fitness.  In no event shall the author be liable for any
   special, indirect or consequential damages or any damages


@@ -38,45 +38,36 @@
 
        /* Includes: */
                #include <LUFA/Drivers/USB/USB.h>
 
        /* Includes: */
                #include <LUFA/Drivers/USB/USB.h>

-               
+

                #include "RNDISEthernetHost.h"
                #include "RNDISEthernetHost.h"

-               
-       /* Macros: */
-               /** Interface Class value for the CDC class. */
-               #define CDC_CONTROL_CLASS              0x02

 
 

-               /** Interface Class value for the CDC Communication Interface subclass. */
-               #define CDC_CONTROL_SUBCLASS           0x02
+       /* Macros: */
+               /** Pipe address for the RNDIS data IN pipe. */
+               #define RNDIS_DATA_IN_PIPE             (PIPE_DIR_IN  | 1)

 
 

-               /** Interface Class value for the CDC RNDIS vendor specific protocol. */
-               #define CDC_CONTROL_PROTOCOL           0xFF
-               
-               /** Interface Class value for the CDC data class. */
-               #define CDC_DATA_CLASS                 0x0A
+               /** Pipe address for the RNDIS data OUT pipe. */
+               #define RNDIS_DATA_OUT_PIPE            (PIPE_DIR_OUT | 2)

 
 

-               /** Interface Class value for the CDC data subclass. */
-               #define CDC_DATA_SUBCLASS              0x00
+               /** Pipe address for the RNDIS notification IN pipe. */
+               #define RNDIS_NOTIFICATION_PIPE        (PIPE_DIR_IN  | 3)

 
 

-               /** Interface Class value for the CDC data protocol. */
-               #define CDC_DATA_PROTOCOL              0x00
-       

        /* Enums: */
        /* Enums: */

-               /** Enum for the possible return codes of the ProcessConfigurationDescriptor() function. */
+               /** Enum for the possible return codes of the \ref ProcessConfigurationDescriptor() function. */

                enum RNDISHost_GetConfigDescriptorDataCodes_t
                {
                        SuccessfulConfigRead            = 0, /**< Configuration Descriptor was processed successfully */
                        ControlError                    = 1, /**< A control request to the device failed to complete successfully */
                        DescriptorTooLarge              = 2, /**< The device's Configuration Descriptor is too large to process */
                        InvalidConfigDataReturned       = 3, /**< The device returned an invalid Configuration Descriptor */
                enum RNDISHost_GetConfigDescriptorDataCodes_t
                {
                        SuccessfulConfigRead            = 0, /**< Configuration Descriptor was processed successfully */
                        ControlError                    = 1, /**< A control request to the device failed to complete successfully */
                        DescriptorTooLarge              = 2, /**< The device's Configuration Descriptor is too large to process */
                        InvalidConfigDataReturned       = 3, /**< The device returned an invalid Configuration Descriptor */

-                       NoRNDISInterfaceFound           = 4, /**< A compatible RNDIS interface was not found in the device's Configuration Descriptor */
-                       NoEndpointFound                 = 5, /**< Compatible RNDIS endpoints were not found in the device's RNDIS interface */
+                       NoCompatibleInterfaceFound      = 4, /**< A compatible interface with the required endpoints was not found */

                };
 
        /* Function Prototypes: */
                };
 
        /* Function Prototypes: */

-               uint8_t ProcessConfigurationDescriptor(void);   
-               
+               uint8_t ProcessConfigurationDescriptor(void);
+

                uint8_t DComp_NextCDCControlInterface(void* CurrentDescriptor);
                uint8_t DComp_NextCDCDataInterface(void* CurrentDescriptor);
                uint8_t DComp_NextCDCDataInterfaceEndpoint(void* CurrentDescriptor);
                uint8_t DComp_NextCDCControlInterface(void* CurrentDescriptor);
                uint8_t DComp_NextCDCDataInterface(void* CurrentDescriptor);
                uint8_t DComp_NextCDCDataInterfaceEndpoint(void* CurrentDescriptor);

-               
+

 #endif
 #endif

+