Add support for the USB HID SystemControl page

Author: nospam2000

hardware/arduino/avr/cores/arduino/HID.cpp

@@ -44,6 +44,8 @@ Keyboard_ Keyboard;
 #define HID_REPORTID_MOUSE (1)
 #define HID_REPORTID_KEYBOARD (2)
 #define HID_REPORTID_RAWHID (3)
+#define HID_REPORTID_SYSTEMCONTROL (4)
+
 extern const u8 _hidReportDescriptor[] PROGMEM;
 const u8 _hidReportDescriptor[] = {
 
@@ -107,7 +109,37 @@ const u8 _hidReportDescriptor[] = {
     0x81, 0x00,                    //   INPUT (Data,Ary,Abs)
     0xc0,                          // END_COLLECTION
 
-#ifdef RAWHID_ENABLED
+    //  System Control (Power Down, Sleep, Wakeup, ...)
+    0x05, 0x01,                    // USAGE_PAGE (Generic Desktop)
+    0x09, 0x80,                    // USAGE (System Control)
+    0xa1, 0x01,                    // COLLECTION (Application)
+    0x85, HID_REPORTID_SYSTEMCONTROL,// REPORT_ID (4)
+    0x09, 0x81,                    //   USAGE (System Power Down)
+    0x09, 0x82,                    //   USAGE (System Sleep)
+    0x09, 0x83,                    //   USAGE (System Wakeup)
+    0x09, 0x8E,                    //   USAGE (System Cold Restart)
+    0x09, 0x8F,                    //   USAGE (System Warm Restart)
+    0x09, 0xA0,                    //   USAGE (System Dock)
+    0x09, 0xA1,                    //   USAGE (System Undock)
+    0x09, 0xA7,                    //   USAGE (System Speaker Mute)
+    0x09, 0xA8,                    //   USAGE (System Hibernate)
+    // although these display usages are not that important, they don't cost much more than declaring
+    // the otherwise necessary constant fill bits
+    0x09, 0xB0,                    //   USAGE (System Display Invert)
+    0x09, 0xB1,                    //   USAGE (System Display Internal)
+    0x09, 0xB2,                    //   USAGE (System Display External)
+    0x09, 0xB3,                    //   USAGE (System Display Both)
+    0x09, 0xB4,                    //   USAGE (System Display Dual)
+    0x09, 0xB5,                    //   USAGE (System Display Toggle Intern/Extern)
+    0x09, 0xB6,                    //   USAGE (System Display Swap)
+    0x15, 0x00,                    //   LOGICAL_MINIMUM (0)
+    0x25, 0x01,                    //   LOGICAL_MAXIMUM (1)
+    0x75, 0x01,                    //   REPORT_SIZE (1)
+    0x95, 0x10,                    //   REPORT_COUNT (16)
+    0x81, 0x02,                    //   INPUT (Data,Var,Abs)
+    0xc0,                          // END_COLLECTION
+
+#if RAWHID_ENABLED
 	//	RAW HID
 	0x06, LSB(RAWHID_USAGE_PAGE), MSB(RAWHID_USAGE_PAGE),	// 30
 	0x0A, LSB(RAWHID_USAGE), MSB(RAWHID_USAGE),
@@ -463,6 +495,38 @@ size_t Keyboard_::press(uint8_t k)
 	return 1;
 }
 
+// System Control
+//  k is one of the SYSTEM_CONTROL defines which come from the HID usage table "Generic Desktop Page (0x01)"
+// in "HID Usage Tables" (HUT1_12v2.pdf)
+size_t Keyboard_::systemControl(uint8_t k)
+{
+	if(k <= 16)
+	{
+		u16 mask = 0;
+		u8 m[2];
+
+		if(k > 0)
+		{
+			mask = 1 << (k - 1);
+		}
+
+		m[0] = LSB(mask);
+		m[1] = MSB(mask);
+		HID_SendReport(HID_REPORTID_SYSTEMCONTROL,m,sizeof(m));
+
+		// these are all OSCs, so send a clear to make it possible to send it again later
+		m[0] = 0;
+		m[1] = 0;
+		HID_SendReport(HID_REPORTID_SYSTEMCONTROL,m,sizeof(m));
+		return 1;
+	}
+	else
+	{
+		setWriteError();
+		return 0;
+	}
+}
+
 // release() takes the specified key out of the persistent key report and
 // sends the report.  This tells the OS the key is no longer pressed and that
 // it shouldn't be repeated any more.

hardware/arduino/avr/cores/arduino/USBAPI.h

@@ -159,6 +159,30 @@ extern Mouse_ Mouse;
 #define KEY_F11				0xCC
 #define KEY_F12				0xCD
 
+
+// System Control values for Keyboard_::systemControl()
+//  these defines come from the HID usage table "Generic Desktop Page (0x01)"
+//  in the USB standard document "HID Usage Tables" (HUT1_12v2.pdf)
+//  Currently this list contains only OSC (one shot control) values,
+//  the implementation of systemControl will have to be changed when
+//  adding OOC or RTC values.
+#define SYSTEM_CONTROL_POWER_DOWN              1
+#define SYSTEM_CONTROL_SLEEP                   2
+#define SYSTEM_CONTROL_WAKEUP                  3
+#define SYSTEM_CONTROL_COLD_RESTART            4
+#define SYSTEM_CONTROL_WARM_RESTART            5
+#define SYSTEM_CONTROL_DOCK                    6
+#define SYSTEM_CONTROL_UNDOCK                  7
+#define SYSTEM_CONTROL_SPEAKER_MUTE            8
+#define SYSTEM_CONTROL_HIBERNATE               9
+#define SYSTEM_CONTROL_DISPLAY_INVERT         10
+#define SYSTEM_CONTROL_DISPLAY_INTERNAL       11
+#define SYSTEM_CONTROL_DISPLAY_EXTERNAL       12
+#define SYSTEM_CONTROL_DISPLAY_BOTH           13
+#define SYSTEM_CONTROL_DISPLAY_DUAL           14
+#define SYSTEM_CONTROL_DISPLAY_TOGGLE_INT_EXT 15
+#define SYSTEM_CONTROL_DISPLAY_SWAP           16
+
 //	Low level key report: up to 6 keys and shift, ctrl etc at once
 #define KEYREPORT_KEYCOUNT	0x06
 typedef struct
@@ -181,6 +205,7 @@ class Keyboard_ : public Print
 	virtual size_t press(uint8_t k);
 	virtual size_t release(uint8_t k);
 	virtual void releaseAll(void);
+	virtual size_t systemControl(uint8_t k);
 };
 extern Keyboard_ Keyboard;