Documentation: Update copyrights to 2019.
[pub/lufa.git] / Demos / Host / LowLevel / StillImageHost / ConfigDescriptor.h
index 66f9bfe..62f16ff 100644 (file)
@@ -1,24 +1,24 @@
 /*
              LUFA Library
-     Copyright (C) Dean Camera, 2010.
-              
+     Copyright (C) Dean Camera, 2019.
+
   dean [at] fourwalledcubicle [dot] com
-      www.fourwalledcubicle.com
+           www.lufa-lib.org
 */
 
 /*
-  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)
+  Copyright 2019  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
-  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
-  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
+  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
 
        /* Includes: */
                #include <LUFA/Drivers/USB/USB.h>
-               
+
                #include "StillImageHost.h"
-               
+
        /* Macros: */
-               /** Interface Class value for the Still Image Device class. */
-               #define SIMAGE_CLASS                   0x06
+               /** Pipe address of the Still Image data IN pipe. */
+               #define SIMAGE_DATA_IN_PIPE            (PIPE_DIR_IN  | 1)
 
-               /** Interface Class value for the Still Image Device subclass. */
-               #define SIMAGE_SUBCLASS                0x01
+               /** Pipe address of the Still Image data OUT pipe. */
+               #define SIMAGE_DATA_OUT_PIPE           (PIPE_DIR_OUT | 2)
+
+               /** Pipe address of the Still Image events IN pipe. */
+               #define SIMAGE_EVENTS_PIPE             (PIPE_DIR_IN  | 3)
 
-               /** Interface Class value for the Still Image Device protocol. */
-               #define SIMAGE_PROTOCOL                0x01
-       
        /* Enums: */
-               /** Enum for the possible return codes of the ProcessConfigurationDescriptor() function. */
+               /** Enum for the possible return codes of the \ref ProcessConfigurationDescriptor() function. */
                enum StillImageHost_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 */
-                       NoInterfaceFound                = 4, /**< A compatible SI interface was not found in the device's Configuration Descriptor */
-                       NoEndpointFound                 = 5, /**< The correct SI endpoint descriptors were not found in the device's SI interface */
+                       NoCompatibleInterfaceFound      = 4, /**< A compatible interface with the required endpoints was not found */
                };
-       
+
        /* Function Prototypes: */
                uint8_t ProcessConfigurationDescriptor(void);
 
@@ -70,3 +69,4 @@
                uint8_t DComp_NextStillImageInterfaceDataEndpoint(void* CurrentDescriptor);
 
 #endif
+