Add M4m5 support (#25499)

keyboards/sneakbox/m4m5/keyboard.json

@@ -0,0 +1,203 @@
+{
+    "manufacturer": "Sneakbox",
+    "keyboard_name": "M4 & M5",
+    "maintainer": "mujimanic",
+    "bootloader": "atmel-dfu",
+    "bootmagic": {
+        "matrix": [2, 0]
+    },
+    "build": {
+        "lto": true
+    },
+    "diode_direction": "COL2ROW",
+    "encoder": {
+        "rotary": [
+            {"pin_a": "D3", "pin_b": "D2"}
+        ]
+    },
+    "features": {
+        "bootmagic": true,
+        "encoder": true,
+        "extrakey": true,
+        "mousekey": true,
+        "nkro": true,
+        "rgblight": true
+    },
+    "indicators": {
+        "caps_lock": "D6",
+        "num_lock": "D4",
+        "scroll_lock": "D7"
+    },
+    "matrix_pins": {
+        "cols": ["F0", "D0", "C7", "C6", "B6", "B5", "B4", "D1"],
+        "rows": ["F1", "E6", "F4", "B1", "F5", "B2", "F6", "B3", "F7", "B7"]
+    },
+    "processor": "atmega32u4",
+    "rgblight": {
+        "animations": {
+            "alternating": true,
+            "breathing": true,
+            "christmas": true,
+            "knight": true,
+            "rainbow_mood": true,
+            "rainbow_swirl": true,
+            "rgb_test": true,
+            "snake": true,
+            "static_gradient": true,
+            "twinkle": true
+        },
+        "led_count": 16
+    },
+    "url": "https://sneakbox.design",
+    "usb": {
+        "device_version": "0.0.1",
+        "pid": "0x0005",
+        "vid": "0x5342"
+    },
+    "ws2812": {
+        "pin": "D5"
+    },
+    "layouts": {
+        "LAYOUT_alice": {
+            "layout": [
+                {"matrix": [2, 0], "x": 0, "y": 0},
+                {"matrix": [0, 0], "x": 1.25, "y": 0},
+                {"matrix": [0, 1], "x": 2.25, "y": 0},
+                {"matrix": [0, 2], "x": 3.25, "y": 0},
+                {"matrix": [0, 3], "x": 4.25, "y": 0},
+                {"matrix": [0, 4], "x": 5.25, "y": 0},
+                {"matrix": [0, 5], "x": 6.25, "y": 0},
+                {"matrix": [0, 6], "x": 7.25, "y": 0},
+                {"matrix": [1, 0], "x": 10.25, "y": 0},
+                {"matrix": [1, 1], "x": 11.25, "y": 0},
+                {"matrix": [1, 2], "x": 12.25, "y": 0},
+                {"matrix": [1, 3], "x": 13.25, "y": 0},
+                {"matrix": [1, 4], "x": 14.25, "y": 0},
+                {"matrix": [1, 5], "x": 15.25, "y": 0},
+                {"matrix": [1, 6], "x": 16.25, "y": 0, "w": 2},
+                {"matrix": [4, 0], "x": 0, "y": 1},
+                {"matrix": [2, 1], "x": 1.25, "y": 1, "w": 1.5},
+                {"matrix": [2, 2], "x": 2.75, "y": 1},
+                {"matrix": [2, 3], "x": 3.75, "y": 1},
+                {"matrix": [2, 4], "x": 4.75, "y": 1},
+                {"matrix": [2, 5], "x": 5.75, "y": 1},
+                {"matrix": [2, 6], "x": 6.75, "y": 1},
+                {"matrix": [3, 0], "x": 9.75, "y": 1},
+                {"matrix": [3, 1], "x": 10.75, "y": 1},
+                {"matrix": [3, 2], "x": 11.75, "y": 1},
+                {"matrix": [3, 3], "x": 12.75, "y": 1},
+                {"matrix": [3, 4], "x": 13.75, "y": 1},
+                {"matrix": [3, 5], "x": 14.75, "y": 1},
+                {"matrix": [3, 6], "x": 15.75, "y": 1},
+                {"matrix": [3, 7], "x": 16.75, "y": 1, "w": 1.5},
+                {"matrix": [6, 0], "x": 0, "y": 2},
+                {"matrix": [4, 1], "x": 1.25, "y": 2, "w": 1.75},
+                {"matrix": [4, 2], "x": 3, "y": 2},
+                {"matrix": [4, 3], "x": 4, "y": 2},
+                {"matrix": [4, 4], "x": 5, "y": 2},
+                {"matrix": [4, 5], "x": 6, "y": 2},
+                {"matrix": [4, 6], "x": 7, "y": 2},
+                {"matrix": [5, 0], "x": 10, "y": 2},
+                {"matrix": [5, 1], "x": 11, "y": 2},
+                {"matrix": [5, 2], "x": 12, "y": 2},
+                {"matrix": [5, 3], "x": 13, "y": 2},
+                {"matrix": [5, 4], "x": 14, "y": 2},
+                {"matrix": [5, 5], "x": 15, "y": 2},
+                {"matrix": [5, 6], "x": 16, "y": 2, "w": 2.25},
+                {"matrix": [6, 1], "x": 1.25, "y": 3, "w": 2.25},
+                {"matrix": [6, 2], "x": 3.5, "y": 3},
+                {"matrix": [6, 3], "x": 4.5, "y": 3},
+                {"matrix": [6, 4], "x": 5.5, "y": 3},
+                {"matrix": [6, 5], "x": 6.5, "y": 3},
+                {"matrix": [6, 6], "x": 7.5, "y": 3},
+                {"matrix": [7, 0], "x": 9.5, "y": 3},
+                {"matrix": [7, 1], "x": 10.5, "y": 3},
+                {"matrix": [7, 2], "x": 11.5, "y": 3},
+                {"matrix": [7, 3], "x": 12.5, "y": 3},
+                {"matrix": [7, 4], "x": 13.5, "y": 3},
+                {"matrix": [7, 5], "x": 14.5, "y": 3},
+                {"matrix": [7, 6], "x": 15.5, "y": 3, "w": 1.75},
+                {"matrix": [7, 7], "x": 17.25, "y": 3},
+                {"matrix": [8, 1], "x": 1.25, "y": 4, "w": 1.5},
+                {"matrix": [8, 3], "x": 4, "y": 4, "w": 1.5},
+                {"matrix": [8, 5], "x": 5.5, "y": 4, "w": 2.25},
+                {"matrix": [8, 6], "x": 7.75, "y": 4},
+                {"matrix": [9, 1], "x": 9.75, "y": 4, "w": 1.25},
+                {"matrix": [9, 2], "x": 11, "y": 4, "w": 1.5},
+                {"matrix": [9, 3], "x": 12.5, "y": 4, "w": 1.5},
+                {"matrix": [9, 7], "x": 16.75, "y": 4, "w": 1.5}
+            ]
+        },
+        "LAYOUT_alice_split_bs": {
+            "layout": [
+                {"matrix": [2, 0], "x": 0, "y": 0},
+                {"matrix": [0, 0], "x": 1.25, "y": 0},
+                {"matrix": [0, 1], "x": 2.25, "y": 0},
+                {"matrix": [0, 2], "x": 3.25, "y": 0},
+                {"matrix": [0, 3], "x": 4.25, "y": 0},
+                {"matrix": [0, 4], "x": 5.25, "y": 0},
+                {"matrix": [0, 5], "x": 6.25, "y": 0},
+                {"matrix": [0, 6], "x": 7.25, "y": 0},
+                {"matrix": [1, 0], "x": 10.25, "y": 0},
+                {"matrix": [1, 1], "x": 11.25, "y": 0},
+                {"matrix": [1, 2], "x": 12.25, "y": 0},
+                {"matrix": [1, 3], "x": 13.25, "y": 0},
+                {"matrix": [1, 4], "x": 14.25, "y": 0},
+                {"matrix": [1, 5], "x": 15.25, "y": 0},
+                {"matrix": [1, 6], "x": 16.25, "y": 0},
+                {"matrix": [1, 7], "x": 17.25, "y": 0},
+                {"matrix": [4, 0], "x": 0, "y": 1},
+                {"matrix": [2, 1], "x": 1.25, "y": 1, "w": 1.5},
+                {"matrix": [2, 2], "x": 2.75, "y": 1},
+                {"matrix": [2, 3], "x": 3.75, "y": 1},
+                {"matrix": [2, 4], "x": 4.75, "y": 1},
+                {"matrix": [2, 5], "x": 5.75, "y": 1},
+                {"matrix": [2, 6], "x": 6.75, "y": 1},
+                {"matrix": [3, 0], "x": 9.75, "y": 1},
+                {"matrix": [3, 1], "x": 10.75, "y": 1},
+                {"matrix": [3, 2], "x": 11.75, "y": 1},
+                {"matrix": [3, 3], "x": 12.75, "y": 1},
+                {"matrix": [3, 4], "x": 13.75, "y": 1},
+                {"matrix": [3, 5], "x": 14.75, "y": 1},
+                {"matrix": [3, 6], "x": 15.75, "y": 1},
+                {"matrix": [3, 7], "x": 16.75, "y": 1, "w": 1.5},
+                {"matrix": [6, 0], "x": 0, "y": 2},
+                {"matrix": [4, 1], "x": 1.25, "y": 2, "w": 1.75},
+                {"matrix": [4, 2], "x": 3, "y": 2},
+                {"matrix": [4, 3], "x": 4, "y": 2},
+                {"matrix": [4, 4], "x": 5, "y": 2},
+                {"matrix": [4, 5], "x": 6, "y": 2},
+                {"matrix": [4, 6], "x": 7, "y": 2},
+                {"matrix": [5, 0], "x": 10, "y": 2},
+                {"matrix": [5, 1], "x": 11, "y": 2},
+                {"matrix": [5, 2], "x": 12, "y": 2},
+                {"matrix": [5, 3], "x": 13, "y": 2},
+                {"matrix": [5, 4], "x": 14, "y": 2},
+                {"matrix": [5, 5], "x": 15, "y": 2},
+                {"matrix": [5, 6], "x": 16, "y": 2, "w": 2.25},
+                {"matrix": [6, 1], "x": 1.25, "y": 3, "w": 2.25},
+                {"matrix": [6, 2], "x": 3.5, "y": 3},
+                {"matrix": [6, 3], "x": 4.5, "y": 3},
+                {"matrix": [6, 4], "x": 5.5, "y": 3},
+                {"matrix": [6, 5], "x": 6.5, "y": 3},
+                {"matrix": [6, 6], "x": 7.5, "y": 3},
+                {"matrix": [7, 0], "x": 9.5, "y": 3},
+                {"matrix": [7, 1], "x": 10.5, "y": 3},
+                {"matrix": [7, 2], "x": 11.5, "y": 3},
+                {"matrix": [7, 3], "x": 12.5, "y": 3},
+                {"matrix": [7, 4], "x": 13.5, "y": 3},
+                {"matrix": [7, 5], "x": 14.5, "y": 3},
+                {"matrix": [7, 6], "x": 15.5, "y": 3, "w": 1.75},
+                {"matrix": [7, 7], "x": 17.25, "y": 3},
+                {"matrix": [8, 1], "x": 1.25, "y": 4, "w": 1.5},
+                {"matrix": [8, 3], "x": 4, "y": 4, "w": 1.5},
+                {"matrix": [8, 5], "x": 5.5, "y": 4, "w": 2.25},
+                {"matrix": [8, 6], "x": 7.75, "y": 4},
+                {"matrix": [9, 1], "x": 9.75, "y": 4, "w": 1.25},
+                {"matrix": [9, 2], "x": 11, "y": 4, "w": 1.5},
+                {"matrix": [9, 3], "x": 12.5, "y": 4, "w": 1.5},
+                {"matrix": [9, 7], "x": 16.75, "y": 4, "w": 1.5}
+            ]
+        }
+    }
+}

keyboards/sneakbox/m4m5/keymaps/alice/keymap.c

@@ -0,0 +1,32 @@
+// Copyright 2023 Bryan Ong
+// SPDX-License-Identifier: GPL-2.0-or-later
+
+#include QMK_KEYBOARD_H
+
+// Defines names for use in layer keycodes and the keymap
+enum layer_names {
+    _BASE,
+    _FN
+};
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+    [_BASE] = LAYOUT_alice(
+        KC_ESC,    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_PGUP,   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_PGDN,   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_LSFT,   KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,                          KC_B,    KC_N,    KC_M,    KC_COMM,    KC_DOT,    KC_SLSH,    KC_RSFT,    KC_LGUI,
+                   KC_LCTL,                     KC_LALT, KC_SPC, LT(_FN, KC_SPC),                KC_SPC,  KC_SPC,  KC_RALT,                                    KC_RCTL),
+    [_FN] = LAYOUT_alice(
+        KC_TRNS,   KC_TRNS,   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_TRNS,    
+        KC_TRNS,   KC_TRNS,   KC_TRNS, KC_UP,   KC_TRNS, KC_TRNS, KC_TRNS,                       KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,    KC_TRNS,   UG_PREV,   UG_NEXT,    UG_TOGG,
+        QK_BOOT,   KC_TRNS,   KC_LEFT, KC_DOWN, KC_RGHT, KC_TRNS, KC_TRNS,                       KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,    UG_VALD,   UG_VALU,    KC_TRNS,
+                   KC_TRNS,   KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,                       KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,    UG_SATD,   UG_SATU,    KC_TRNS,    UG_HUEU,
+                   KC_TRNS,                     KC_TRNS, KC_TRNS, KC_TRNS,                       KC_TRNS, KC_TRNS, KC_TRNS,                                    KC_TRNS),
+};
+
+#if defined(ENCODER_MAP_ENABLE)
+const uint16_t PROGMEM encoder_map[][NUM_ENCODERS][NUM_DIRECTIONS] = {
+    [_BASE] = { ENCODER_CCW_CW(KC_VOLD, KC_VOLU)},
+    [_FN]   = { ENCODER_CCW_CW(_______, _______)}
+};
+#endif

keyboards/sneakbox/m4m5/keymaps/default/keymap.c

@@ -0,0 +1,32 @@
+// Copyright 2023 Bryan Ong
+// SPDX-License-Identifier: GPL-2.0-or-later
+
+#include QMK_KEYBOARD_H
+
+// Defines names for use in layer keycodes and the keymap
+enum layer_names {
+    _BASE,
+    _FN
+};
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+    [_BASE] = LAYOUT_alice_split_bs(
+        KC_ESC,    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_BSPC,
+        KC_PGUP,   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_PGDN,   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_LSFT,   KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,                          KC_B,    KC_N,    KC_M,    KC_COMM,    KC_DOT,    KC_SLSH,    KC_RSFT,    KC_LGUI,
+                   KC_LCTL,                     KC_LALT, KC_SPC, LT(_FN, KC_SPC),                KC_SPC,  KC_SPC,  KC_RALT,                                    KC_RCTL),
+    [_FN] = LAYOUT_alice_split_bs(
+        KC_TRNS,   KC_TRNS,   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_TRNS,    KC_TRNS,
+        KC_TRNS,   KC_TRNS,   KC_TRNS, KC_UP,   KC_TRNS, KC_TRNS, KC_TRNS,                       KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,    KC_TRNS,   UG_PREV,    UG_NEXT,    UG_TOGG,
+        QK_BOOT,   KC_TRNS,   KC_LEFT, KC_DOWN, KC_RGHT, KC_TRNS, KC_TRNS,                       KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,    UG_VALD,   UG_VALU,    KC_TRNS,
+                   KC_TRNS,   KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,                       KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,    UG_SATD,   UG_SATU,    KC_TRNS,    UG_HUEU,
+                   KC_TRNS,                     KC_TRNS, KC_TRNS, KC_TRNS,                       KC_TRNS, KC_TRNS, KC_TRNS,                                    KC_TRNS),
+};
+
+#if defined(ENCODER_MAP_ENABLE)
+const uint16_t PROGMEM encoder_map[][NUM_ENCODERS][NUM_DIRECTIONS] = {
+    [_BASE] = { ENCODER_CCW_CW(KC_VOLD, KC_VOLU)},
+    [_FN]   = { ENCODER_CCW_CW(_______, _______)}
+};
+#endif

keyboards/sneakbox/m4m5/readme.md

@@ -0,0 +1,27 @@
+# Sneakbox M4 & M5 PCB
+
+![Sneakbox M4 & M5 PCB](https://i.imgur.com/hVLal1m.jpeg)
+
+An Alice-compatible PCB with hotswap with pushbutton rotary encoder socket placed at the top left key position. This PCB is the successor to the AliceCloneRGB PCB and features RGB underglow lighting along with revised hardware components such as an additional spacebar key in the right spacebar cluster. M4M5 firmware covers two physical PCBs for the MGA project (M4 PCB and M5 PCB) namely for the MGA V3 keyboard (which uses either PCB).
+
+* Keyboard Maintainer: [mujimanic](https://github.com/mujimanic)
+* Hardware Supported: Any Alice-layout case.
+* Hardware Availability: [sneakbox.design](https://sneakbox.com/products/m4-alice-pcbs-for-mga-cases)
+
+Make example for this keyboard (after setting up your build environment):
+
+    make sneakbox/m4m5:default
+
+Flashing example for this keyboard:
+
+    make sneakbox/m4m5: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).
+
+## Bootloader
+
+Enter the bootloader in 3 ways:
+
+* **Bootmagic reset**: Hold down the top left key in the nevigation cluster (Escape key) and plug in the keyboard
+* **Physical reset button**: Briefly press the small metal button on the back of the PCB
+* **Keycode in layout**: Press and hold the key next to the right split spacebar (to the right of the spacebar) and then press the End key (located on the bottom of the three-key navigation cluster)