[Keyboard] Model H controller for IBM Model M (#20625)

Co-authored-by: Drashna Jaelre <drashna@live.com>
Co-authored-by: Ryan <fauxpark@gmail.com>
Co-authored-by: hcbille <32437363+hcbille@users.noreply.github.com>

6 files changed, 398 insertions, 0 deletions

diff --git a/keyboards/modelh/config.h b/keyboards/modelh/config.h
new file mode 100644
index 0000000000..ac95ccfe66
--- /dev/null
+++ b/keyboards/modelh/config.h
@@ -0,0 +1,45 @@
+/*
+Copyright 2020 John Hawthorn
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 2 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.
+*/
+
+#pragma once
+
+
+/* Model H customizations */
+
+#define MODELH_STATUS_LED C13
+
+/* Mechanical locking support. Use KC_LCAP, KC_LNUM or KC_LSCR instead in keymap */
+#define LOCKING_SUPPORT_ENABLE
+/* Locking resynchronize hack */
+#define LOCKING_RESYNC_ENABLE
+
+
+/*
+ * Feature disable options
+ *  These options are also useful to firmware size reduction.
+ */
+
+/* disable debug print */
+//#define NO_DEBUG
+
+/* disable print */
+//#define NO_PRINT
+
+/* disable action features */
+//#define NO_ACTION_LAYER
+//#define NO_ACTION_TAPPING
+//#define NO_ACTION_ONESHOT
diff --git a/keyboards/modelh/info.json b/keyboards/modelh/info.json
new file mode 100644
index 0000000000..6d55d5c6bd
--- /dev/null
+++ b/keyboards/modelh/info.json
@@ -0,0 +1,282 @@
+{
+    "manufacturer": "IBM",
+    "keyboard_name": "Model M",
+    "maintainer": "jhawthorn",
+    "bootloader": "stm32duino",
+    "diode_direction": "COL2ROW",
+    "features": {
+        "bootmagic": false,
+        "command": false,
+        "console": false,
+        "extrakey": true,
+        "mousekey": false,
+        "nkro": false
+    },
+    "indicators": {
+        "caps_lock": "B8",
+        "num_lock": "B7",
+        "scroll_lock": "B9",
+        "on_state": 0
+    },
+    "matrix_pins": {
+        "cols": ["A10", "A9", "A8", "B15", "B14", "B13", "B12", "B11", "B10", "B1", "B0", "A7", "A6", "A5", "A4", "A3"],
+        "rows": ["B6", "B5", "B4", "A15", "B3", "A0", "A2", "A1"]
+    },
+    "processor": "STM32F103",
+    "url": "modelh.club",
+    "usb": {
+        "device_version": "1.0.0",
+        "max_power": 100,
+        "pid": "0xB155",
+        "vid": "0xFEED"
+    },
+    "layouts": {
+        "LAYOUT_fullsize_ansi_wkl": {
+            "layout": [
+                {"matrix": [0, 2], "x": 0, "y": 0},
+
+                {"matrix": [2, 3], "x": 2, "y": 0},
+                {"matrix": [2, 4], "x": 3, "y": 0},
+                {"matrix": [1, 4], "x": 4, "y": 0},
+                {"matrix": [0, 4], "x": 5, "y": 0},
+
+                {"matrix": [0, 6], "x": 6.5, "y": 0},
+                {"matrix": [0, 8], "x": 7.5, "y": 0},
+                {"matrix": [1, 9], "x": 8.5, "y": 0},
+                {"matrix": [2, 9], "x": 9.5, "y": 0},
+
+                {"matrix": [2, 6], "x": 11, "y": 0},
+                {"matrix": [3, 6], "x": 12, "y": 0},
+                {"matrix": [3, 11], "x": 13, "y": 0},
+                {"matrix": [3, 12], "x": 14, "y": 0},
+
+                {"matrix": [3, 15], "x": 15.25, "y": 0},
+                {"matrix": [4, 15], "x": 16.25, "y": 0},
+                {"matrix": [6, 14], "x": 17.25, "y": 0},
+
+                {"matrix": [2, 2], "x": 0, "y": 1.5},
+                {"matrix": [3, 2], "x": 1, "y": 1.5},
+                {"matrix": [3, 3], "x": 2, "y": 1.5},
+                {"matrix": [3, 4], "x": 3, "y": 1.5},
+                {"matrix": [3, 5], "x": 4, "y": 1.5},
+                {"matrix": [2, 5], "x": 5, "y": 1.5},
+                {"matrix": [2, 7], "x": 6, "y": 1.5},
+                {"matrix": [3, 7], "x": 7, "y": 1.5},
+                {"matrix": [3, 8], "x": 8, "y": 1.5},
+                {"matrix": [3, 9], "x": 9, "y": 1.5},
+                {"matrix": [3, 10], "x": 10, "y": 1.5},
+                {"matrix": [2, 10], "x": 11, "y": 1.5},
+                {"matrix": [2, 8], "x": 12, "y": 1.5},
+                {"matrix": [1, 6], "x": 13, "y": 1.5, "w": 2},
+
+                {"matrix": [2, 12], "x": 15.25, "y": 1.5},
+                {"matrix": [2, 14], "x": 16.25, "y": 1.5},
+                {"matrix": [2, 13], "x": 17.25, "y": 1.5},
+
+                {"matrix": [6, 11], "x": 18.5, "y": 1.5},
+                {"matrix": [6, 12], "x": 19.5, "y": 1.5},
+                {"matrix": [6, 13], "x": 20.5, "y": 1.5},
+                {"matrix": [7, 13], "x": 21.5, "y": 1.5},
+
+                {"matrix": [1, 2], "x": 0, "y": 2.5, "w": 1.5},
+                {"matrix": [4, 2], "x": 1.5, "y": 2.5},
+                {"matrix": [4, 3], "x": 2.5, "y": 2.5},
+                {"matrix": [4, 4], "x": 3.5, "y": 2.5},
+                {"matrix": [4, 5], "x": 4.5, "y": 2.5},
+                {"matrix": [1, 5], "x": 5.5, "y": 2.5},
+                {"matrix": [1, 7], "x": 6.5, "y": 2.5},
+                {"matrix": [4, 7], "x": 7.5, "y": 2.5},
+                {"matrix": [4, 8], "x": 8.5, "y": 2.5},
+                {"matrix": [4, 9], "x": 9.5, "y": 2.5},
+                {"matrix": [4, 10], "x": 10.5, "y": 2.5},
+                {"matrix": [1, 10], "x": 11.5, "y": 2.5},
+                {"matrix": [1, 8], "x": 12.5, "y": 2.5},
+                {"matrix": [5, 6], "x": 13.5, "y": 2.5, "w": 1.5},
+
+                {"matrix": [2, 11], "x": 15.25, "y": 2.5},
+                {"matrix": [3, 14], "x": 16.25, "y": 2.5},
+                {"matrix": [3, 13], "x": 17.25, "y": 2.5},
+
+                {"matrix": [4, 11], "x": 18.5, "y": 2.5},
+                {"matrix": [4, 12], "x": 19.5, "y": 2.5},
+                {"matrix": [4, 13], "x": 20.5, "y": 2.5},
+                {"matrix": [4, 14], "x": 21.5, "y": 2.5, "h": 2},
+
+                {"matrix": [1, 3], "x": 0, "y": 3.5, "w": 1.5},
+                {"matrix": [5, 2], "x": 1.75, "y": 3.5},
+                {"matrix": [5, 3], "x": 2.75, "y": 3.5},
+                {"matrix": [5, 4], "x": 3.75, "y": 3.5},
+                {"matrix": [5, 5], "x": 4.75, "y": 3.5},
+                {"matrix": [0, 5], "x": 5.75, "y": 3.5},
+                {"matrix": [0, 7], "x": 6.75, "y": 3.5},
+                {"matrix": [5, 7], "x": 7.75, "y": 3.5},
+                {"matrix": [5, 8], "x": 8.75, "y": 3.5},
+                {"matrix": [5, 9], "x": 9.75, "y": 3.5},
+                {"matrix": [5, 10], "x": 10.75, "y": 3.5},
+                {"matrix": [0, 10], "x": 11.75, "y": 3.5},
+                {"matrix": [6, 6], "x": 12.75, "y": 3.5, "w": 2.25},
+
+                {"matrix": [1, 11], "x": 18.5, "y": 3.5},
+                {"matrix": [1, 12], "x": 19.5, "y": 3.5},
+                {"matrix": [1, 13], "x": 20.5, "y": 3.5},
+
+                {"matrix": [1, 1], "x": 0, "y": 4.5, "w": 2.25},
+                {"matrix": [6, 2], "x": 2.25, "y": 4.5},
+                {"matrix": [6, 3], "x": 3.25, "y": 4.5},
+                {"matrix": [6, 4], "x": 4.25, "y": 4.5},
+                {"matrix": [6, 5], "x": 5.25, "y": 4.5},
+                {"matrix": [7, 5], "x": 6.25, "y": 4.5},
+                {"matrix": [7, 7], "x": 7.25, "y": 4.5},
+                {"matrix": [6, 7], "x": 8.25, "y": 4.5},
+                {"matrix": [6, 8], "x": 9.25, "y": 4.5},
+                {"matrix": [6, 9], "x": 10.25, "y": 4.5},
+                {"matrix": [7, 10], "x": 11.25, "y": 4.5},
+                {"matrix": [6, 1], "x": 12.25, "y": 4.5, "w": 2.75},
+
+                {"matrix": [0, 14], "x": 16.25, "y": 4.5},
+
+                {"matrix": [5, 11], "x": 18.5, "y": 4.5},
+                {"matrix": [5, 12], "x": 19.5, "y": 4.5},
+                {"matrix": [5, 13], "x": 20.5, "y": 4.5},
+                {"matrix": [5, 14], "x": 21.5, "y": 4.5, "h": 2},
+
+                {"matrix": [2, 0], "x": 0, "y": 5.5, "w": 1.5},
+                {"matrix": [0, 15], "x": 2.5, "y": 5.5, "w": 1.5},
+                {"matrix": [7, 6], "x": 4, "y": 5.5, "w": 7},
+                {"matrix": [7, 15], "x": 11, "y": 5.5, "w": 1.5},
+                {"matrix": [6, 0], "x": 13.5, "y": 5.5, "w": 1.5},
+
+                {"matrix": [7, 14], "x": 15.25, "y": 5.5},
+                {"matrix": [7, 11], "x": 16.25, "y": 5.5},
+                {"matrix": [7, 12], "x": 17.25, "y": 5.5},
+
+                {"matrix": [0, 12], "x": 18.5, "y": 5.5, "w": 2},
+                {"matrix": [0, 13], "x": 20.5, "y": 5.5}
+            ]
+        },
+        "LAYOUT_fullsize_iso_wkl": {
+            "layout": [
+                {"matrix": [0, 2], "x": 0, "y": 0},
+
+                {"matrix": [2, 3], "x": 2, "y": 0},
+                {"matrix": [2, 4], "x": 3, "y": 0},
+                {"matrix": [1, 4], "x": 4, "y": 0},
+                {"matrix": [0, 4], "x": 5, "y": 0},
+
+                {"matrix": [0, 6], "x": 6.5, "y": 0},
+                {"matrix": [0, 8], "x": 7.5, "y": 0},
+                {"matrix": [1, 9], "x": 8.5, "y": 0},
+                {"matrix": [2, 9], "x": 9.5, "y": 0},
+
+                {"matrix": [2, 6], "x": 11, "y": 0},
+                {"matrix": [3, 6], "x": 12, "y": 0},
+                {"matrix": [3, 11], "x": 13, "y": 0},
+                {"matrix": [3, 12], "x": 14, "y": 0},
+
+                {"matrix": [3, 15], "x": 15.25, "y": 0},
+                {"matrix": [4, 15], "x": 16.25, "y": 0},
+                {"matrix": [6, 14], "x": 17.25, "y": 0},
+
+                {"matrix": [2, 2], "x": 0, "y": 1.5},
+                {"matrix": [3, 2], "x": 1, "y": 1.5},
+                {"matrix": [3, 3], "x": 2, "y": 1.5},
+                {"matrix": [3, 4], "x": 3, "y": 1.5},
+                {"matrix": [3, 5], "x": 4, "y": 1.5},
+                {"matrix": [2, 5], "x": 5, "y": 1.5},
+                {"matrix": [2, 7], "x": 6, "y": 1.5},
+                {"matrix": [3, 7], "x": 7, "y": 1.5},
+                {"matrix": [3, 8], "x": 8, "y": 1.5},
+                {"matrix": [3, 9], "x": 9, "y": 1.5},
+                {"matrix": [3, 10], "x": 10, "y": 1.5},
+                {"matrix": [2, 10], "x": 11, "y": 1.5},
+                {"matrix": [2, 8], "x": 12, "y": 1.5},
+                {"matrix": [1, 6], "x": 13, "y": 1.5, "w": 2},
+
+                {"matrix": [2, 12], "x": 15.25, "y": 1.5},
+                {"matrix": [2, 14], "x": 16.25, "y": 1.5},
+                {"matrix": [2, 13], "x": 17.25, "y": 1.5},
+
+                {"matrix": [6, 11], "x": 18.5, "y": 1.5},
+                {"matrix": [6, 12], "x": 19.5, "y": 1.5},
+                {"matrix": [6, 13], "x": 20.5, "y": 1.5},
+                {"matrix": [7, 13], "x": 21.5, "y": 1.5},
+
+                {"matrix": [1, 2], "x": 0, "y": 2.5, "w": 1.5},
+                {"matrix": [4, 2], "x": 1.5, "y": 2.5},
+                {"matrix": [4, 3], "x": 2.5, "y": 2.5},
+                {"matrix": [4, 4], "x": 3.5, "y": 2.5},
+                {"matrix": [4, 5], "x": 4.5, "y": 2.5},
+                {"matrix": [1, 5], "x": 5.5, "y": 2.5},
+                {"matrix": [1, 7], "x": 6.5, "y": 2.5},
+                {"matrix": [4, 7], "x": 7.5, "y": 2.5},
+                {"matrix": [4, 8], "x": 8.5, "y": 2.5},
+                {"matrix": [4, 9], "x": 9.5, "y": 2.5},
+                {"matrix": [4, 10], "x": 10.5, "y": 2.5},
+                {"matrix": [1, 10], "x": 11.5, "y": 2.5},
+                {"matrix": [1, 8], "x": 12.5, "y": 2.5},
+
+                {"matrix": [2, 11], "x": 15.25, "y": 2.5},
+                {"matrix": [3, 14], "x": 16.25, "y": 2.5},
+                {"matrix": [3, 13], "x": 17.25, "y": 2.5},
+
+                {"matrix": [4, 11], "x": 18.5, "y": 2.5},
+                {"matrix": [4, 12], "x": 19.5, "y": 2.5},
+                {"matrix": [4, 13], "x": 20.5, "y": 2.5},
+                {"matrix": [4, 14], "x": 21.5, "y": 2.5, "h": 2},
+
+                {"matrix": [1, 3], "x": 0, "y": 3.5, "w": 1.5},
+                {"matrix": [5, 2], "x": 1.75, "y": 3.5},
+                {"matrix": [5, 3], "x": 2.75, "y": 3.5},
+                {"matrix": [5, 4], "x": 3.75, "y": 3.5},
+                {"matrix": [5, 5], "x": 4.75, "y": 3.5},
+                {"matrix": [0, 5], "x": 5.75, "y": 3.5},
+                {"matrix": [0, 7], "x": 6.75, "y": 3.5},
+                {"matrix": [5, 7], "x": 7.75, "y": 3.5},
+                {"matrix": [5, 8], "x": 8.75, "y": 3.5},
+                {"matrix": [5, 9], "x": 9.75, "y": 3.5},
+                {"matrix": [5, 10], "x": 10.75, "y": 3.5},
+                {"matrix": [0, 10], "x": 11.75, "y": 3.5},
+                {"matrix": [6, 10], "x": 12.75, "y": 3.5},
+                {"matrix": [6, 6], "x": 13.75, "y": 2.5, "w": 1.25, "h": 2},
+
+                {"matrix": [1, 11], "x": 18.5, "y": 3.5},
+                {"matrix": [1, 12], "x": 19.5, "y": 3.5},
+                {"matrix": [1, 13], "x": 20.5, "y": 3.5},
+
+                {"matrix": [1, 1], "x": 0, "y": 4.5, "w": 1.25},
+                {"matrix": [0, 3], "x": 1.25, "y": 4.5},
+                {"matrix": [6, 2], "x": 2.25, "y": 4.5},
+                {"matrix": [6, 3], "x": 3.25, "y": 4.5},
+                {"matrix": [6, 4], "x": 4.25, "y": 4.5},
+                {"matrix": [6, 5], "x": 5.25, "y": 4.5},
+                {"matrix": [7, 5], "x": 6.25, "y": 4.5},
+                {"matrix": [7, 7], "x": 7.25, "y": 4.5},
+                {"matrix": [6, 7], "x": 8.25, "y": 4.5},
+                {"matrix": [6, 8], "x": 9.25, "y": 4.5},
+                {"matrix": [6, 9], "x": 10.25, "y": 4.5},
+                {"matrix": [7, 10], "x": 11.25, "y": 4.5},
+                {"matrix": [6, 1], "x": 12.25, "y": 4.5, "w": 2.75},
+
+                {"matrix": [0, 14], "x": 16.25, "y": 4.5},
+
+                {"matrix": [5, 11], "x": 18.5, "y": 4.5},
+                {"matrix": [5, 12], "x": 19.5, "y": 4.5},
+                {"matrix": [5, 13], "x": 20.5, "y": 4.5},
+                {"matrix": [5, 14], "x": 21.5, "y": 4.5, "h": 2},
+
+                {"matrix": [2, 0], "x": 0, "y": 5.5, "w": 1.5},
+                {"matrix": [0, 15], "x": 2.5, "y": 5.5, "w": 1.5},
+                {"matrix": [7, 6], "x": 4, "y": 5.5, "w": 7},
+                {"matrix": [7, 15], "x": 11, "y": 5.5, "w": 1.5},
+                {"matrix": [6, 0], "x": 13.5, "y": 5.5, "w": 1.5},
+
+                {"matrix": [7, 14], "x": 15.25, "y": 5.5},
+                {"matrix": [7, 11], "x": 16.25, "y": 5.5},
+                {"matrix": [7, 12], "x": 17.25, "y": 5.5},
+
+                {"matrix": [0, 12], "x": 18.5, "y": 5.5, "w": 2},
+                {"matrix": [0, 13], "x": 20.5, "y": 5.5}
+            ]
+        }
+    }
+}
diff --git a/keyboards/modelh/keymaps/default/keymap.c b/keyboards/modelh/keymaps/default/keymap.c
new file mode 100644
index 0000000000..9098b869b3
--- /dev/null
+++ b/keyboards/modelh/keymaps/default/keymap.c
@@ -0,0 +1,27 @@
+/* Copyright 2020 John Hawthorn
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+#include QMK_KEYBOARD_H
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+  [0] = LAYOUT_fullsize_ansi_wkl( /* Base layer */
+    KC_ESC,           KC_F1,  KC_F2,   KC_F3,   KC_F4,   KC_F5,   KC_F6,   KC_F7,   KC_F8,   KC_F9,   KC_F10,  KC_F11,  KC_F12,    KC_PSCR, KC_SCRL, KC_PAUS,
+    KC_GRV,  KC_1,    KC_2,   KC_3,    KC_4,    KC_5,    KC_6,    KC_7,    KC_8,    KC_9,    KC_0,    KC_MINS, KC_EQL,  KC_BSPC,   KC_INS,  KC_HOME, KC_PGUP,   KC_NUM,  KC_PSLS, KC_PAST, KC_PMNS,
+    KC_TAB,  KC_Q,    KC_W,   KC_E,    KC_R,    KC_T,    KC_Y,    KC_U,    KC_I,    KC_O,    KC_P,    KC_LBRC, KC_RBRC, KC_BSLS,   KC_DEL,  KC_END,  KC_PGDN,   KC_P7,   KC_P8,   KC_P9,   KC_PPLS,
+    KC_CAPS, KC_A,    KC_S,   KC_D,    KC_F,    KC_G,    KC_H,    KC_J,    KC_K,    KC_L,    KC_SCLN, KC_QUOT,          KC_ENT,                                 KC_P4,   KC_P5,   KC_P6,
+    KC_LSFT,          KC_Z,   KC_X,    KC_C,    KC_V,    KC_B,    KC_N,    KC_M,    KC_COMM, KC_DOT,  KC_SLSH,          KC_RSFT,            KC_UP,              KC_P1,   KC_P2,   KC_P3,   KC_PENT,
+    KC_LCTL,          KC_LALT,                           KC_SPC,                                      KC_RALT,          KC_RCTL,   KC_LEFT, KC_DOWN, KC_RGHT,   KC_P0,            KC_PDOT
+  ),
+};
diff --git a/keyboards/modelh/modelh.c b/keyboards/modelh/modelh.c
new file mode 100644
index 0000000000..5384b37338
--- /dev/null
+++ b/keyboards/modelh/modelh.c
@@ -0,0 +1,25 @@
+/* Copyright 2020 John Hawthorn
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#include "quantum.h"
+
+
+void keyboard_pre_init_kb(void) {
+    setPinOutput(MODELH_STATUS_LED);
+    writePin(MODELH_STATUS_LED, 0);
+
+    keyboard_pre_init_user();
+}
diff --git a/keyboards/modelh/readme.md b/keyboards/modelh/readme.md
new file mode 100644
index 0000000000..8cd68c111a
--- /dev/null
+++ b/keyboards/modelh/readme.md
@@ -0,0 +1,19 @@
+# Model H - A USB capable PCB for the IBM Model M keyboard
+
+![modelh](https://i.imgur.com/4ymGdkM.jpg)
+
+This conversion kit allows you to replace your IBM Model M's original internal controller board with a modern USB board. This aims to match the footprint of the original controller and plugs into the original keyboard matrix, but exposes a USB port through the original SDL connector.
+
+* Keyboard Maintainer: [John Hawthorn](https://github.com/jhawthorn)
+* Hardware Supported: IBM Model M
+* Hardware Availability: [www.modelh.club](www.modelh.club)
+
+Make example for this keyboard (after setting up your build environment):
+
+    make modelh:default
+
+Flashing example for this keyboard:
+
+    make modelh:default:flash
+
+See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs).
diff --git a/keyboards/modelh/rules.mk b/keyboards/modelh/rules.mk
new file mode 100644
index 0000000000..e69de29bb2
--- /dev/null
+++ b/keyboards/modelh/rules.mk