Minor documentation enhancements.
[pub/USBasp.git] / Projects / MissileLauncher / ConfigDescriptor.h
index 69983fe..5cddada 100644 (file)
                /** Interface Class value for the Human Interface Device class. */
                #define HID_CLASS                 0x03
 
+               /** Pipe number for the HID data IN pipe. */
+               #define HID_DATA_IN_PIPE          1
+               
+               /** Pipe number for the HID data OUT pipe. */
+               #define HID_DATA_OUT_PIPE         2
+
        /* Enums: */
-               /** Enum for the possible return codes of the ProcessConfigurationDescriptor() function. */
+               /** Enum for the possible return codes of the \ref ProcessConfigurationDescriptor() function. */
                enum GenericHIDHost_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 */
-                       NoHIDInterfaceFound             = 4, /**< A compatible HID interface was not found in the device's Configuration Descriptor */
-                       NoEndpointFound                 = 5, /**< A compatible HID IN endpoint was not found in the device's HID interface */
+                       NoCompatibleInterfaceFound      = 4, /**< A compatible interface with the required endpoints was not found */
                };      
 
        /* Function Prototypes: */
                uint8_t ProcessConfigurationDescriptor(void);
 
                uint8_t DComp_NextHIDInterface(void* CurrentDescriptor);
-               uint8_t DComp_NextInterfaceHIDDataEndpoint(void* CurrentDescriptor);
+               uint8_t DComp_NextHIDInterfaceDataEndpoint(void* CurrentDescriptor);
 
 #endif