X-Git-Url: http://git.linex4red.de/pub/USBasp.git/blobdiff_plain/196724c62d8c09b30dabb9a8ff3246033d95315f..797130bddc25d519cd765ca8d82d1e729e3d8ae0:/LUFA/Drivers/USB/Class/Common/HID.h?ds=inline

diff --git a/LUFA/Drivers/USB/Class/Common/HID.h b/LUFA/Drivers/USB/Class/Common/HID.h
index 6f2d7c222..0c908c5b5 100644
--- a/LUFA/Drivers/USB/Class/Common/HID.h
+++ b/LUFA/Drivers/USB/Class/Common/HID.h
@@ -28,6 +28,15 @@
   this software.
 */
 
+/** \file
+ *  \brief Common definitions and declarations for the library USB HID Class driver.
+ *
+ *  Common definitions and declarations for the library USB HID Class driver.
+ *
+ *  \note This file should not be included directly. It is automatically included as needed by the class driver
+ *        dispatch header located in LUFA/Drivers/USB/Class/HID.h.
+ */
+
 /** \ingroup Group_USBClassHID
  *  @defgroup Group_USBClassHIDCommon  Common Class Definitions
  *
@@ -46,6 +55,11 @@
 
 		#include <string.h>
 
+	/* Preprocessor Checks: */
+		#if !defined(__INCLUDE_FROM_HID_DRIVER)
+			#error Do not include this file directly. Include LUFA/Drivers/Class/HID.h instead.
+		#endif
+		
 	/* Macros: */
 		/** HID Class Specific Request to get the current HID report from the device. */
 		#define REQ_GetReport                   0x01
@@ -109,6 +123,18 @@
 
 		/** Constant for a keyboard report modifier byte, indicating that the keyboard's right GUI key is currently pressed. */
 		#define HID_KEYBOARD_MODIFER_RIGHTGUI   (1 << 7)
+		
+		/** Constant for a keyboard output report LED byte, indicating that the host's NUM LOCK mode is currently set. */
+		#define HID_KEYBOARD_LED_NUMLOCK        (1 << 0)
+		
+		/** Constant for a keyboard output report LED byte, indicating that the host's CAPS LOCK mode is currently set. */
+		#define HID_KEYBOARD_LED_CAPSLOCK       (1 << 1)
+
+		/** Constant for a keyboard output report LED byte, indicating that the host's SCROLL LOCK mode is currently set. */
+		#define HID_KEYBOARD_LED_SCROLLLOCK     (1 << 2)
+
+		/** Constant for a keyboard output report LED byte, indicating that the host's KATANA mode is currently set. */
+		#define HID_KEYBOARD_LED_KATANA         (1 << 3)
 
 	/* Type Defines: */
 		/** Enum for the different types of HID reports. */
@@ -119,7 +145,9 @@
 			REPORT_ITEM_TYPE_Feature              = 2, /**< Indicates that the item is a FEATURE report type. */
 		};
 
-		/** Type define for the HID class specific HID descriptor, to describe the HID device's specifications. Refer to the HID
+		/** \brief HID Class Specific HID Descriptor.
+		 *
+		 *  Type define for the HID class specific HID descriptor, to describe the HID device's specifications. Refer to the HID
 		 *  specification for details on the structure elements.
 		 */
 		typedef struct
@@ -135,7 +163,10 @@
 			uint16_t                 HIDReportLength;
 		} USB_HID_Descriptor_t;
 
-		/** Type define for a standard Boot Protocol Mouse report */
+		/** \brief Standard HID Boot Protocol Mouse Report.
+		 *
+		 *  Type define for a standard Boot Protocol Mouse report
+		 */
 		typedef struct
 		{
 			uint8_t Button; /**< Button mask for currently pressed buttons in the mouse */
@@ -143,7 +174,10 @@
 			int8_t  Y; /**< Current delta Y movement on the mouse */
 		} USB_MouseReport_Data_t;
 		
-		/** Type define for a standard Boot Protocol Keyboard report */
+		/** \brief Standard HID Boot Protocol Keyboard Report.
+		 *
+		 *  Type define for a standard Boot Protocol Keyboard report
+		 */
 		typedef struct
 		{
 			uint8_t Modifier; /**< Keyboard modifier byte, indicating pressed modifier keys (a combination of