Documentation improvements - put driver example code into its own section, fix incorr...

[pub/USBasp.git] / Demos / Device / Incomplete / Sideshow / Descriptors.h

diff --git a/Demos/Device/Incomplete/Sideshow/Descriptors.h b/Demos/Device/Incomplete/Sideshow/Descriptors.h
index 83c683b..5944d52 100644 (file)
--- a/Demos/Device/Incomplete/Sideshow/Descriptors.h
+++ b/Demos/Device/Incomplete/Sideshow/Descriptors.h
@@ -1,21 +1,21 @@
 /*
              LUFA Library
      Copyright (C) Dean Camera, 2010.
 /*
              LUFA Library
      Copyright (C) Dean Camera, 2010.

-              
+

   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 2010  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.
 
   The author disclaim all warranties with regard to this
   software without specific, written prior permission.
 
   The author disclaim all warranties with regard to this


@@ -35,14 +35,14 @@
                #include <LUFA/Drivers/USB/USB.h>
 
                #include <avr/pgmspace.h>
                #include <LUFA/Drivers/USB/USB.h>
 
                #include <avr/pgmspace.h>

-               
+

                #include "Sideshow.h"
 
        /* Macros: */
                #include "Sideshow.h"
 
        /* Macros: */

-               #define SIDESHOW_IN_EPNUM          3    
-               #define SIDESHOW_OUT_EPNUM         4    
+               #define SIDESHOW_IN_EPNUM          3
+               #define SIDESHOW_OUT_EPNUM         4

                #define SIDESHOW_IO_EPSIZE         64
                #define SIDESHOW_IO_EPSIZE         64

-               
+

        /* Type Defines: */
                typedef struct
                {
        /* Type Defines: */
                typedef struct
                {


@@ -51,45 +51,49 @@
                        USB_Descriptor_Endpoint_t             SSHOW_DataInEndpoint;
                        USB_Descriptor_Endpoint_t             SSHOW_DataOutEndpoint;
                } USB_Descriptor_Configuration_t;
                        USB_Descriptor_Endpoint_t             SSHOW_DataInEndpoint;
                        USB_Descriptor_Endpoint_t             SSHOW_DataOutEndpoint;
                } USB_Descriptor_Configuration_t;

-               
+

                typedef struct
                {
                        USB_Descriptor_Header_t                Header;
                typedef struct
                {
                        USB_Descriptor_Header_t                Header;

-                       
+

                        int                                    Signature[7];
                        uint16_t                               VendorCode;
                } USB_OSDescriptor_t;
                        int                                    Signature[7];
                        uint16_t                               VendorCode;
                } USB_OSDescriptor_t;

-               
+

                typedef struct
                {
                        uint8_t                                FirstInterfaceNumber;
 
                typedef struct
                {
                        uint8_t                                FirstInterfaceNumber;
 

-                       uint8_t                                RESERVED;
-                       
+                       uint8_t                                Reserved;
+

                        uint8_t                                CompatibleID[8];
                        uint8_t                                CompatibleID[8];

-                       uint8_t                                SubCompatibleID[8];                      
+                       uint8_t                                SubCompatibleID[8];

 
 

-                       uint8_t                                RESERVED2[6];
+                       uint8_t                                Reserved2[6];

                } USB_OSCompatibleSection_t;
                } USB_OSCompatibleSection_t;

-               
+

                typedef struct
                {
                        uint32_t                               TotalLength;
                        uint16_t                               Version;
                        uint16_t                               Index;
                        uint8_t                                TotalSections;
                typedef struct
                {
                        uint32_t                               TotalLength;
                        uint16_t                               Version;
                        uint16_t                               Index;
                        uint8_t                                TotalSections;

-                       
-                       uint8_t                                RESERVED[7];
-                       
+
+                       uint8_t                                Reserved[7];
+

                        USB_OSCompatibleSection_t              SideshowCompatID;
                } USB_OSCompatibleIDDescriptor_t;
 
        /* Function Prototypes: */
                        USB_OSCompatibleSection_t              SideshowCompatID;
                } USB_OSCompatibleIDDescriptor_t;
 
        /* Function Prototypes: */

-               uint16_t CALLBACK_USB_GetDescriptor(const uint16_t wValue, const uint8_t wIndex, void** const DescriptorAddress)
-                                                                           ATTR_WARN_UNUSED_RESULT ATTR_WEAK ATTR_NON_NULL_PTR_ARG(3);
+               uint16_t CALLBACK_USB_GetDescriptor(const uint16_t wValue,
+                                                   const uint8_t wIndex,
+                                                   const void** const DescriptorAddress)
+                                                   ATTR_WARN_UNUSED_RESULT ATTR_NON_NULL_PTR_ARG(3);

 
 

-               bool USB_GetOSFeatureDescriptor(const uint16_t wValue, const uint8_t wIndex,
-                                               void** const DescriptorAddress, uint16_t* const DescriptorSize)
-                                               ATTR_WARN_UNUSED_RESULT ATTR_WEAK ATTR_NON_NULL_PTR_ARG(3) ATTR_NON_NULL_PTR_ARG(4);
+               uint16_t USB_GetOSFeatureDescriptor(const uint16_t wValue,
+                                                   const uint8_t wIndex,
+                                                   const void** const DescriptorAddress)
+                                                   ATTR_WARN_UNUSED_RESULT ATTR_NON_NULL_PTR_ARG(3);

 
 #endif
 
 #endif

+