Don't run the AVRISP-MKII Windows Driver through Doxygen.

[pub/USBasp.git] / Demos / Device / LowLevel / RNDISEthernet / Descriptors.h

diff --git a/Demos/Device/LowLevel/RNDISEthernet/Descriptors.h b/Demos/Device/LowLevel/RNDISEthernet/Descriptors.h
index 34d64e0..5b14f44 100644 (file)
--- a/Demos/Device/LowLevel/RNDISEthernet/Descriptors.h
+++ b/Demos/Device/LowLevel/RNDISEthernet/Descriptors.h
@@ -1,13 +1,13 @@
 /*
              LUFA Library
 /*
              LUFA Library

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

 
   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 2016  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
 
   Permission to use, copy, modify, distribute, and sell this
   software and its documentation for any purpose is hereby granted


@@ -18,7 +18,7 @@
   advertising or publicity pertaining to distribution of the
   software without specific, written prior permission.
 
   advertising or publicity pertaining to distribution of the
   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


@@ -41,15 +41,17 @@
 
                #include <avr/pgmspace.h>
 
 
                #include <avr/pgmspace.h>
 

+               #include "Config/AppConfig.h"
+

        /* Macros: */
        /* Macros: */

-               /** Endpoint number of the CDC device-to-host data IN endpoint. */
-               #define CDC_TX_EPNUM                   1
+               /** Endpoint address of the CDC device-to-host data IN endpoint. */
+               #define CDC_TX_EPADDR                  (ENDPOINT_DIR_IN  | 1)

 
 

-               /** Endpoint number of the CDC host-to-device data OUT endpoint. */
-               #define CDC_RX_EPNUM                   2
+               /** Endpoint address of the CDC host-to-device data OUT endpoint. */
+               #define CDC_RX_EPADDR                  (ENDPOINT_DIR_OUT | 2)

 
 

-               /** Endpoint number of the CDC device-to-host notification IN endpoint. */
-               #define CDC_NOTIFICATION_EPNUM         3
+               /** Endpoint address of the CDC device-to-host notification IN endpoint. */
+               #define CDC_NOTIFICATION_EPADDR        (ENDPOINT_DIR_IN  | 3)

 
                /** Size in bytes of the CDC data IN and OUT endpoints. */
                #define CDC_TXRX_EPSIZE                64
 
                /** Size in bytes of the CDC data IN and OUT endpoints. */
                #define CDC_TXRX_EPSIZE                64


@@ -58,60 +60,51 @@
                #define CDC_NOTIFICATION_EPSIZE        8
 
        /* Type Defines: */
                #define CDC_NOTIFICATION_EPSIZE        8
 
        /* Type Defines: */

-               /** Type define for a CDC class-specific functional header descriptor. This indicates to the host that the device
-                *  contains one or more CDC functional data descriptors, which give the CDC interface's capabilities and configuration.
-                *  See the CDC class specification for more details.
-                */
-               typedef struct
-               {
-                       USB_Descriptor_Header_t Header; /**< Regular descriptor header containing the descriptor's type and length. */
-                       uint8_t                 Subtype; /**< Sub type value used to distinguish between CDC class-specific descriptors. */
-                       uint16_t                CDCSpecification; /**< Version number of the CDC specification implemented by the device,
-                                                                  *   encoded in BCD format.
-                                                                  */
-               } USB_Descriptor_CDC_FunctionalHeader_t;
-
-               /** Type define for a CDC class-specific functional ACM descriptor. This indicates to the host that the CDC interface
-                *  supports the CDC ACM subclass of the CDC specification. See the CDC class specification for more details.
+               /** 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
+                *  vary between devices, and which describe the device's usage to the host.

                 */
                typedef struct
                {
                 */
                typedef struct
                {

-                       USB_Descriptor_Header_t Header; /**< Regular descriptor header containing the descriptor's type and length. */
-                       uint8_t                 Subtype; /**< Sub type value used to distinguish between CDC class-specific descriptors. */
-                       uint8_t                 Capabilities; /**< Capabilities of the ACM interface, given as a bit mask. */
-               } USB_Descriptor_CDC_FunctionalACM_t;
+                       USB_Descriptor_Configuration_Header_t Config;
+
+                       // RNDIS CDC Control Interface
+                       USB_Descriptor_Interface_t            CDC_CCI_Interface;
+                       USB_CDC_Descriptor_FunctionalHeader_t CDC_Functional_Header;
+                       USB_CDC_Descriptor_FunctionalACM_t    CDC_Functional_ACM;
+                       USB_CDC_Descriptor_FunctionalUnion_t  CDC_Functional_Union;
+                       USB_Descriptor_Endpoint_t             CDC_NotificationEndpoint;
+
+                       // RNDIS CDC Data Interface
+                       USB_Descriptor_Interface_t            CDC_DCI_Interface;
+                       USB_Descriptor_Endpoint_t             RNDIS_DataOutEndpoint;
+                       USB_Descriptor_Endpoint_t             RNDIS_DataInEndpoint;
+               } USB_Descriptor_Configuration_t;

 
 

-               /** Type define for a CDC class-specific functional Union descriptor. This indicates to the host that specific
-                *  CDC control and data interfaces are related. See the CDC class specification for more details.
+               /** 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.

                 */
                 */

-               typedef struct
+               enum InterfaceDescriptors_t

                {
                {

-                       USB_Descriptor_Header_t Header; /**< Regular descriptor header containing the descriptor's type and length. */
-                       uint8_t                 Subtype; /**< Sub type value used to distinguish between CDC class-specific descriptors. */
-                       uint8_t                 MasterInterfaceNumber; /**< Interface number of the CDC Control interface. */
-                       uint8_t                 SlaveInterfaceNumber; /**< Interface number of the CDC Data interface. */
-               } USB_Descriptor_CDC_FunctionalUnion_t;
+                       INTERFACE_ID_CDC_CCI = 0, /**< CDC CCI interface descriptor ID */
+                       INTERFACE_ID_CDC_DCI = 1, /**< CDC DCI interface descriptor ID */
+               };

 
 

-               /** 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
-                *  vary between devices, and which describe the device's usage to the host.
+               /** 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.

                 */
                 */

-               typedef struct
+               enum StringDescriptors_t

                {
                {

-                       USB_Descriptor_Configuration_Header_t    Config;
-                       USB_Descriptor_Interface_t               CDC_CCI_Interface;
-                       USB_Descriptor_CDC_FunctionalHeader_t    CDC_Functional_Header;
-                       USB_Descriptor_CDC_FunctionalACM_t       CDC_Functional_ACM;
-                       USB_Descriptor_CDC_FunctionalUnion_t     CDC_Functional_Union;
-                       USB_Descriptor_Endpoint_t                CDC_NotificationEndpoint;
-                       USB_Descriptor_Interface_t               CDC_DCI_Interface;
-                       USB_Descriptor_Endpoint_t                RNDIS_DataOutEndpoint;
-                       USB_Descriptor_Endpoint_t                RNDIS_DataInEndpoint;
-               } USB_Descriptor_Configuration_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 */
+               };

 
        /* Function Prototypes: */
                uint16_t CALLBACK_USB_GetDescriptor(const uint16_t wValue,
 
        /* 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);
 
                                                    const void** const DescriptorAddress)
                                                    ATTR_WARN_UNUSED_RESULT ATTR_NON_NULL_PTR_ARG(3);