#include "HIDReport.h"
/* Macros: */
- /** Interface Class value for the Human Interface Device class */
+ /** Interface Class value for the Human Interface Device class. */
#define KEYBOARD_CLASS 0x03
- /** Interface Protocol value for a Boot Protocol Keyboard compliant device */
+ /** Interface Protocol value for a Boot Protocol Keyboard compliant device. */
#define KEYBOARD_PROTOCOL 0x01
- /** Descriptor header type constant for a HID descriptor */
+ /** Descriptor header type constant for a HID descriptor. */
#define DTYPE_HID 0x21
- /** Descriptor header type constant for a HID report descriptor */
+ /** Descriptor header type constant for a HID report descriptor. */
#define DTYPE_Report 0x22
+ /** Pipe number for the keyboard report data pipe. */
+ #define KEYBOARD_DATA_IN_PIPE 1
+
/* Enums: */
- /** Enum for the possible return codes of the ProcessConfigurationDescriptor() function. */
+ /** Enum for the possible return codes of the \ref ProcessConfigurationDescriptor() function. */
enum KeyboardHostWithParser_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 */
- NoHIDDescriptorFound = 5, /**< A compatible HID descriptor was not found in the device's HID interface */
- 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: */