From 32cb168ce6c64e3bdce2d855589583b5de132fe0 Mon Sep 17 00:00:00 2001
From: Danny Robson <danny@nerdcruft.net>
Date: Sat, 9 Mar 2019 11:11:23 +1100
Subject: [PATCH] setup: add some sectioning comments to keyboard descriptor
 bytes

---
 quimby-setup | 11 +++++++++++
 1 file changed, 11 insertions(+)

diff --git a/quimby-setup b/quimby-setup
index 2b128f8..6912b62 100755
--- a/quimby-setup
+++ b/quimby-setup
@@ -12,6 +12,8 @@ keyboard = {
         0x05, 0x01, # Usage Page (Generic Desktop Ctrls)
         0x09, 0x06, # Usage (Keyboard)
         0xA1, 0x01, # Collection (Application)
+
+        # Control key bitmask
         0x05, 0x07, #   Usage Page (Kbrd/Keypad)
         0x19, 0xE0, #   Usage Minimum (0xE0)
         0x29, 0xE7, #   Usage Maximum (0xE7)
@@ -20,18 +22,26 @@ keyboard = {
         0x75, 0x01, #   Report Size (1)
         0x95, 0x08, #   Report Count (8)
         0x81, 0x02, #   Input (Data,Var,Abs,No Wrap,Linear,Preferred State,No Null Position)
+
+        # Reserved byte
         0x95, 0x01, #   Report Count (1)
         0x75, 0x08, #   Report Size (8)
         0x81, 0x03, #   Input (Const,Var,Abs,No Wrap,Linear,Preferred State,No Null Position)
+
+        # LED status
         0x95, 0x05, #   Report Count (5)
         0x75, 0x01, #   Report Size (1)
         0x05, 0x08, #   Usage Page (LEDs)
         0x19, 0x01, #   Usage Minimum (Num Lock)
         0x29, 0x05, #   Usage Maximum (Kana)
         0x91, 0x02, #   Output (Data,Var,Abs,No Wrap,Linear,Preferred State,No Null Position,Non-volatile)
+
+        # Padding
         0x95, 0x01, #   Report Count (1)
         0x75, 0x03, #   Report Size (3)
         0x91, 0x03, #   Output (Const,Var,Abs,No Wrap,Linear,Preferred State,No Null Position,Non-volatile)
+
+        # 6 general buttons
         0x95, 0x06, #   Report Count (6)
         0x75, 0x08, #   Report Size (8)
         0x15, 0x00, #   Logical Minimum (0)
@@ -40,6 +50,7 @@ keyboard = {
         0x19, 0x00, #   Usage Minimum (0x00)
         0x29, 0x65, #   Usage Maximum (0x65)
         0x81, 0x00, #   Input (Data,Array,Abs,No Wrap,Linear,Preferred State,No Null Position)
+
         0xC0,       # End Collection
     ]),
 }