Mini M keyboard support with the MiniRazz controller

keyboards/unicomp/mini_m/justify_mike_smith/config.h

@@ -0,0 +1,18 @@
+/* SPDX-License-Identifier: GPL-2.0-or-later */
+
+#pragma once
+
+#define DEF_SERIAL_NUMBER "purdea.ro:justify_mike_smith"
+
+#ifndef SERIAL_NUMBER
+#define SERIAL_NUMBER DEF_SERIAL_NUMBER
+#endif
+
+#define MATRIX_ROWS 12
+#define MATRIX_COLS 16
+
+#define WEAR_LEVELING_LOGICAL_SIZE 16384
+#define WEAR_LEVELING_BACKING_SIZE (WEAR_LEVELING_LOGICAL_SIZE * 2)
+
+// with eager debouncing the default is not good enough:
+#define DEBOUNCE 10

keyboards/unicomp/mini_m/justify_mike_smith/info.json

@@ -0,0 +1,29 @@
+{
+    "manufacturer": "Unicomp",
+    "maintainer": "purdeaandrei",
+    "url": "https://github.com/purdeaandrei/MiniRazz",
+    "usb": {
+        "device_version": "0.0.1",
+        "pid": "0x27DB",
+        "vid": "0x16C0"
+    },
+    "keyboard_name": "Mini M (Justify Mike Smith)",
+    "processor": "RP2040",
+    "bootloader": "rp2040",
+    "board": "GENERIC_RP_RP2040",
+    "matrix_pins": {
+        "ghost": true,
+        "io_delay": 4,
+        "cols": [null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null],
+        "rows": [null, null, null, null, null, null, null, null, null, null, null, null]
+    },
+    "indicators": {
+        "on_state": 0,
+        "num_lock": "GP6",
+        "caps_lock": "GP7",
+        "scroll_lock": "GP8"
+    },
+    "bootmagic": {
+        "matrix": [0, 1]
+    }
+}

keyboards/unicomp/mini_m/justify_mike_smith/justify_mike_smith.c

@@ -0,0 +1,23 @@
+/* Copyright 2023 Purdea Andrei
+ *
+ * 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 <hardware/structs/pads_qspi.h>
+void board_init(void) {
+    /* The following sets the QSPI drive strengths to 2mA with a slow slew rate. */
+    for (int gpio=0;gpio<NUM_QSPI_GPIOS;gpio++) {
+        pads_qspi_hw->io[gpio] &= ~(PADS_QSPI_GPIO_QSPI_SCLK_DRIVE_BITS | PADS_QSPI_GPIO_QSPI_SCLK_SLEWFAST_BITS);
+    }
+}

keyboards/unicomp/mini_m/justify_mike_smith/matrix.c

@@ -0,0 +1,90 @@
+/* Copyright 2023 Purdea Andrei
+ *
+ * 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"
+#include <hardware/structs/pads_qspi.h>
+
+#define LEDS_COMMON_ANODE GP5
+#define DEC_A0 GP0
+#define DEC_A1 GP1
+#define DEC_A2 GP2
+#define DEC_EN_U1 GP3
+#define DEC_EN_U2 GP4
+#define ROW_MIN_GPIO GP11
+
+matrix_row_t previous_matrix[MATRIX_ROWS];
+
+static inline void setPinOutput_writeLow(pin_t pin) {
+    setPinOutput(pin);
+    writePinLow(pin);
+}
+
+void matrix_init_custom(void) {
+    setPinOutput(LEDS_COMMON_ANODE);
+    writePinHigh(LEDS_COMMON_ANODE);
+    setPinOutput(DEC_EN_U1);
+    writePinHigh(DEC_EN_U1);
+    setPinOutput(DEC_EN_U2);
+    writePinHigh(DEC_EN_U2);
+    setPinOutput(DEC_A0);
+    setPinOutput(DEC_A1);
+    setPinOutput(DEC_A2);
+
+    for (int i=0; i<=11; i++)
+    {
+        setPinInputHigh(ROW_MIN_GPIO + i);
+    }
+}
+
+bool matrix_has_it_changed(const matrix_row_t current_matrix[]) {
+    bool changed = false;
+    for (uint8_t row=0; row<MATRIX_ROWS; row++)
+    {
+        if (previous_matrix[row] != current_matrix[row]) changed = true;
+        previous_matrix[row] = current_matrix[row];
+    }
+    return changed;
+}
+
+bool matrix_scan_custom(matrix_row_t current_matrix[]) {
+    for (int col=0; col<16; col++) {
+        uint32_t bit = 1 << col;
+        writePin(DEC_A0, col & 1);
+        writePin(DEC_A1, (col >> 1) & 1);
+        writePin(DEC_A2, (col >> 2) & 1);
+        if (col & 0b1000) {
+            writePinLow(DEC_EN_U2);
+        } else {
+            writePinLow(DEC_EN_U1);
+        }
+        matrix_output_select_delay();
+        uint32_t keys_pressed = (~palReadPort(PAL_PORT(GP0)) >> (ROW_MIN_GPIO - GP0)) & 0xfff;
+        if (col & 0b1000) {
+            writePinHigh(DEC_EN_U2);
+        } else {
+            writePinHigh(DEC_EN_U1);
+        }
+        matrix_output_unselect_delay(col, !!keys_pressed);
+        for (int row = 0; row < 12; row++) {
+            if (keys_pressed & (1 << row)) {
+                current_matrix[row] |= bit;
+            } else {
+                current_matrix[row] &= ~bit;
+            }
+        }
+    }
+    return matrix_has_it_changed(current_matrix);
+}

keyboards/unicomp/mini_m/justify_mike_smith/readme.md

@@ -0,0 +1,31 @@
+# unicomp/mini_m/justify_mike_smith
+
+![unicomp/mini_m/justify_mike_smith](https://i.imgur.com/JFXIz4Oh.jpeg)
+
+Supports the Unicomp Mini M keyboard, with the "Justify with Mike Smith" OEM controller.
+
+* Keyboard Maintainer: [Purdea Andrei](https://github.com/purdeaandrei)
+* Hardware Supported: Unicomp Mini M Keyboard + OEM Justify with Mike Smith controller
+* Hardware Availability:
+  * [keyboard](https://www.pckeyboard.com/)
+
+To place the keyboard into bootloader mode in order to flash it, hold the ESC key while plugging the board in.
+It's possible to make this feature not work, by flashing the wrong firmware onto the keyboard.
+If that happens, open up the keyboard, and hold the pushbutton on the controller while plugging in the keyboard.
+
+A couple features of this keyboard implementation:
+* The QK_USER_0 keycode is defined as Scroll Lock, when pressed without modifiers, and Num Lock when pressed with shift.
+  * You can disable this with `#define DISABLE_CUSTOM_NUMSLCK_KEYCODE` in your keymap's config.h
+* Layer 1 is a special layer that is activated when the NumLock locklight is on. This is in order to support the embedded numpad.
+  * You can disable this with `#define DISABLE_NUMPAD_LAYER` in your keymap's config.h
+  * You can change the number of the activated layer by `#define NUMPAD_LAYER <number>` in your keymap's config.h
+
+Make example for this keyboard (after setting up your build environment):
+
+    make unicomp/mini_m/justify_mike_smith:default
+
+Flashing example for this keyboard:
+
+    make unicomp/mini_m/justify_mike_smith: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).

keyboards/unicomp/mini_m/justify_mike_smith/rules.mk

@@ -0,0 +1,13 @@
+# Build Options
+#   change yes to no to disable
+#
+BOOTMAGIC_ENABLE = yes
+MOUSEKEY_ENABLE = yes       # Mouse keys
+EXTRAKEY_ENABLE = yes       # Audio control and System control
+CONSOLE_ENABLE = no        # Console for debug
+COMMAND_ENABLE = no        # Commands for debug and configuration
+NKRO_ENABLE = yes           # USB Nkey Rollover
+
+SRC += matrix.c
+CUSTOM_MATRIX = lite
+DEBOUNCE_TYPE = sym_eager_pk

keyboards/unicomp/mini_m/keymaps/default/keymap.c

@@ -0,0 +1,41 @@
+/* Copyright 2021 stevendlander
+ *
+ * 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
+
+// Layer shortcuts
+enum custom_layers {
+    _QWERTY,
+    _NUMPAD,
+};
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+  [_QWERTY] = LAYOUT_all(
+    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, QK_USER_0, 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_BSPC,   KC_INS,  KC_HOME,   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_DEL,  KC_END,    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_NUHS, KC_ENT,
+    KC_LSFT, KC_NUBS, KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,    KC_N,    KC_M,    KC_COMM, KC_DOT,  KC_SLSH, KC_RSFT, KC_RSFT,                     KC_UP,
+    KC_LCTL, KC_LGUI, KC_LALT,                            KC_SPC,                             KC_RALT, KC_RGUI, KC_APP,  KC_RCTL,            KC_LEFT, KC_DOWN,   KC_RGHT
+  ),
+  [_NUMPAD] = LAYOUT_all(
+    KC_TRNS,          KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,            KC_TRNS, KC_TRNS,   KC_TRNS,
+    KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_P7,   KC_P8,   KC_P9,   KC_TRNS, KC_PMNS, KC_PPLS, KC_TRNS, KC_TRNS,   KC_TRNS, KC_TRNS,   KC_TRNS,
+    KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_P4,   KC_P5,   KC_P6,   KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,            KC_TRNS, KC_TRNS,   KC_TRNS,
+    KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_P1,   KC_P2,   KC_P3,   KC_PAST, KC_TRNS, KC_TRNS, KC_PENT,
+    KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_P0,   KC_TRNS, KC_PDOT, KC_PSLS, KC_TRNS, KC_TRNS,                     KC_TRNS,
+    KC_TRNS, KC_TRNS, KC_TRNS,                            KC_TRNS,                            KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,            KC_TRNS, KC_TRNS,   KC_TRNS
+  ),
+};

keyboards/unicomp/mini_m/mini_m.c

@@ -0,0 +1,73 @@
+/* Copyright 2021 stevendlander
+ *
+ * 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
+
+#ifndef NUMPAD_LAYER
+#define NUMPAD_LAYER 1
+#endif
+
+#ifndef DISABLE_CUSTOM_NUMSLCK_KEYCODE
+
+enum custom_keycodes {
+    NUMSLCK = QK_USER_0, // Num Lock on shift, Scroll Lock regularly
+};
+
+// Mod key detection
+#define MODS_SHIFT_MASK (MOD_BIT(KC_LSFT)|MOD_BIT(KC_RSFT))
+#define MODS_ALT_MASK (MOD_BIT(KC_LALT)|MOD_BIT(KC_RALT))
+
+bool process_record_kb(uint16_t keycode, keyrecord_t *record) {
+    switch (keycode) {
+        case NUMSLCK: {
+            if (record->event.pressed) {
+                if (keyboard_report->mods & MODS_SHIFT_MASK) {
+                    tap_code(KC_NUM);
+                } else {
+                    register_code(KC_SCRL);
+                }
+            } else {
+                unregister_code(KC_SCRL);
+            }
+            break;
+        }
+    }
+
+    return process_record_user(keycode, record);
+}
+
+#endif
+
+#ifndef DISABLE_NUMPAD_LAYER
+
+bool led_update_kb(led_t led_state) {
+    bool res = led_update_user(led_state);
+    if (res) {
+        static bool num_state = false;
+        if (num_state != led_state.num_lock) {
+            if (led_state.num_lock) {
+                layer_on(NUMPAD_LAYER);
+            } else { 
+                layer_off(NUMPAD_LAYER);
+            }
+            num_state = led_state.num_lock;
+        }
+
+        led_update_ports(led_state);
+    }
+    return res;
+}
+
+#endif

keyboards/unicomp/mini_m/minirazz/config.h

@@ -0,0 +1,25 @@
+/* SPDX-License-Identifier: GPL-2.0-or-later */
+
+#pragma once
+
+#define DEF_SERIAL_NUMBER "purdea.ro:minirazz"
+
+#ifndef SERIAL_NUMBER
+#define SERIAL_NUMBER DEF_SERIAL_NUMBER
+#endif
+
+#define MATRIX_ROWS 12
+#define MATRIX_COLS 16
+
+#define SOLENOID_PIN GP25
+#define HAPTIC_ENABLE_PIN GP23
+#define SOLENOID_DEFAULT_DWELL 20
+#define SOLENOID_MIN_DWELL 4
+#define HAPTIC_OFF_IN_LOW_POWER 1
+#define NO_HAPTIC_MOD
+
+#define WEAR_LEVELING_LOGICAL_SIZE 16384
+#define WEAR_LEVELING_BACKING_SIZE (WEAR_LEVELING_LOGICAL_SIZE * 2)
+
+// with eager debouncing the default is not good enough:
+#define DEBOUNCE 10

keyboards/unicomp/mini_m/minirazz/info.json

@@ -0,0 +1,29 @@
+{
+    "manufacturer": "Unicomp",
+    "maintainer": "purdeaandrei",
+    "url": "https://github.com/purdeaandrei/MiniRazz",
+    "usb": {
+        "device_version": "0.0.1",
+        "pid": "0x27DB",
+        "vid": "0x16C0"
+    },
+    "keyboard_name": "Mini M (MiniRazz)",
+    "processor": "RP2040",
+    "bootloader": "rp2040",
+    "board": "GENERIC_RP_RP2040",
+    "matrix_pins": {
+        "ghost": true,
+        "io_delay": 4,
+        "cols": [null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null],
+        "rows": [null, null, null, null, null, null, null, null, null, null, null, null]
+    },
+    "indicators": {
+        "on_state": 0,
+        "num_lock": "GP22",
+        "caps_lock": "GP21",
+        "scroll_lock": "GP20"
+    },
+    "bootmagic": {
+        "matrix": [0, 1]
+    }
+}