From 1df390c34f95fb3c4e07518cf51438986ec7c621 Mon Sep 17 00:00:00 2001 From: Gabriel Kim <68445851+gabrielkim13@users.noreply.github.com> Date: Sun, 9 Jan 2022 14:44:33 -0300 Subject: [PATCH] [Keyboard] Add Meck TKL handwired (#15533) * Add meck_tkl * Fix configuration and pin assignment * Rellocate A10 pin, as it is used by the USB DFU bootloader * Add volume and media keys to the function keys layer * Rellocate source files to the handwired keyboards folder and add documentation * Review changes for PR - Improve LAYOUT macro to match the keyboard layout. - Use "kxy" as pin names on the LAYOUT macro. - Remove unused mcuconf.h and halconf.h. - Fix README. * Improve layout macro naming --- .../meck_tkl/blackpill_f401/chconf.h | 39 +++++++ .../meck_tkl/blackpill_f401/config.h | 14 +++ .../meck_tkl/blackpill_f401/rules.mk | 10 ++ keyboards/handwired/meck_tkl/config.h | 47 ++++++++ keyboards/handwired/meck_tkl/info.json | 103 ++++++++++++++++++ .../meck_tkl/keymaps/default/keymap.c | 29 +++++ .../meck_tkl/keymaps/default/readme.md | 1 + keyboards/handwired/meck_tkl/meck_tkl.c | 4 + keyboards/handwired/meck_tkl/meck_tkl.h | 38 +++++++ keyboards/handwired/meck_tkl/readme.md | 37 +++++++ keyboards/handwired/meck_tkl/rules.mk | 16 +++ 11 files changed, 338 insertions(+) create mode 100644 keyboards/handwired/meck_tkl/blackpill_f401/chconf.h create mode 100644 keyboards/handwired/meck_tkl/blackpill_f401/config.h create mode 100644 keyboards/handwired/meck_tkl/blackpill_f401/rules.mk create mode 100644 keyboards/handwired/meck_tkl/config.h create mode 100644 keyboards/handwired/meck_tkl/info.json create mode 100644 keyboards/handwired/meck_tkl/keymaps/default/keymap.c create mode 100644 keyboards/handwired/meck_tkl/keymaps/default/readme.md create mode 100644 keyboards/handwired/meck_tkl/meck_tkl.c create mode 100644 keyboards/handwired/meck_tkl/meck_tkl.h create mode 100644 keyboards/handwired/meck_tkl/readme.md create mode 100644 keyboards/handwired/meck_tkl/rules.mk diff --git a/keyboards/handwired/meck_tkl/blackpill_f401/chconf.h b/keyboards/handwired/meck_tkl/blackpill_f401/chconf.h new file mode 100644 index 0000000000..ad51f8cbe6 --- /dev/null +++ b/keyboards/handwired/meck_tkl/blackpill_f401/chconf.h @@ -0,0 +1,39 @@ +/* Copyright 2020 QMK + * + * 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 . + */ + +/* + * This file was auto-generated by: + * `qmk chibios-confmigrate -i keyboards/handwired/meck_tkl/chconf.h -r platforms/chibios/common/configs/chconf.h` + */ + +#pragma once + +#define CH_CFG_ST_FREQUENCY 10000 + +#define CH_CFG_FACTORY_OBJECTS_REGISTRY TRUE + +#define CH_CFG_FACTORY_GENERIC_BUFFERS TRUE + +#define CH_CFG_FACTORY_SEMAPHORES TRUE + +#define CH_CFG_FACTORY_MAILBOXES TRUE + +#define CH_CFG_FACTORY_OBJ_FIFOS TRUE + +#define CH_CFG_FACTORY_PIPES TRUE + +#include_next + diff --git a/keyboards/handwired/meck_tkl/blackpill_f401/config.h b/keyboards/handwired/meck_tkl/blackpill_f401/config.h new file mode 100644 index 0000000000..cca2eac3a9 --- /dev/null +++ b/keyboards/handwired/meck_tkl/blackpill_f401/config.h @@ -0,0 +1,14 @@ +// Copyright 2021 Gabriel Kim (@gabrielkim13) +// SPDX-License-Identifier: GPL-2.0-or-later + +#pragma once + +#define MATRIX_ROW_PINS \ + { B15, A8, A9, B14, A15, B3 } +#define MATRIX_COL_PINS \ + { B4, B5, B6, B7, B8, B9, A1, A2, A3, A4, A5, A6, A7, B0, B1, A0, B10 } +#define UNUSED_PINS \ + { A10, A11, A12, B2, B12, C14, C15 } + +#define LED_CAPS_LOCK_PIN C13 +#define LED_PIN_ON_STATE 0 diff --git a/keyboards/handwired/meck_tkl/blackpill_f401/rules.mk b/keyboards/handwired/meck_tkl/blackpill_f401/rules.mk new file mode 100644 index 0000000000..e01b22e8fd --- /dev/null +++ b/keyboards/handwired/meck_tkl/blackpill_f401/rules.mk @@ -0,0 +1,10 @@ +# MCU name +MCU = STM32F401 + +# Bootloader selection +BOOTLOADER = stm32-dfu + +# Build Options +# change yes to no to disable +# +KEYBOARD_SHARED_EP = yes diff --git a/keyboards/handwired/meck_tkl/config.h b/keyboards/handwired/meck_tkl/config.h new file mode 100644 index 0000000000..5c22e781e4 --- /dev/null +++ b/keyboards/handwired/meck_tkl/config.h @@ -0,0 +1,47 @@ +// Copyright 2021 Gabriel Kim (@gabrielkim13) +// SPDX-License-Identifier: GPL-2.0-or-later + +#pragma once + +#include "config_common.h" + +/* USB Device descriptor parameter */ +#define VENDOR_ID 0x474B +#define PRODUCT_ID 0x0001 +#define DEVICE_VER 0x0001 +#define MANUFACTURER gabrielkim13 +#define PRODUCT Meck TKL + +/* key matrix size */ +#define MATRIX_ROWS 6 +#define MATRIX_COLS 17 + +/* + * Keyboard Matrix Assignments + * + * Change this to how you wired your keyboard + * COLS: AVR pins used for columns, left to right + * ROWS: AVR pins used for rows, top to bottom + * DIODE_DIRECTION: COL2ROW = COL = Anode (+), ROW = Cathode (-, marked on diode) + * ROW2COL = ROW = Anode (+), COL = Cathode (-, marked on diode) + * + */ + +/* COL2ROW, ROW2COL */ +#define DIODE_DIRECTION COL2ROW + +/* Debounce reduces chatter (unintended double-presses) - set 0 if debouncing is not needed */ +#define DEBOUNCE 5 + +/* 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 + +/* disable these deprecated features by default */ +#define NO_ACTION_MACRO +#define NO_ACTION_FUNCTION + +/* Bootmagic Lite key configuration */ +//#define BOOTMAGIC_LITE_ROW 0 +//#define BOOTMAGIC_LITE_COLUMN 0 diff --git a/keyboards/handwired/meck_tkl/info.json b/keyboards/handwired/meck_tkl/info.json new file mode 100644 index 0000000000..5976b67584 --- /dev/null +++ b/keyboards/handwired/meck_tkl/info.json @@ -0,0 +1,103 @@ +{ + "keyboard_name": "meck_tkl", + "url": "github.com/gabrielkim13", + "maintainer": "gabrielkim13", + "layouts": { + "LAYOUT_tkl_ansi": { + "layout": [ + { "label": "Esc", "x": 0, "y": 0 }, + { "label": "F1", "x": 2, "y": 0 }, + { "label": "F2", "x": 3, "y": 0 }, + { "label": "F3", "x": 4, "y": 0 }, + { "label": "F4", "x": 5, "y": 0 }, + { "label": "F5", "x": 6.5, "y": 0 }, + { "label": "F6", "x": 7.5, "y": 0 }, + { "label": "F7", "x": 8.5, "y": 0 }, + { "label": "F8", "x": 9.5, "y": 0 }, + { "label": "F9", "x": 11, "y": 0 }, + { "label": "F10", "x": 12, "y": 0 }, + { "label": "F11", "x": 13, "y": 0 }, + { "label": "F12", "x": 14, "y": 0 }, + { "label": "Print Screen", "x": 15.25, "y": 0 }, + { "label": "Scroll Lock", "x": 16.25, "y": 0 }, + { "label": "Pause", "x": 17.25, "y": 0 }, + + { "label": "`", "x": 0, "y": 1.5 }, + { "label": "1", "x": 1, "y": 1.5 }, + { "label": "2", "x": 2, "y": 1.5 }, + { "label": "3", "x": 3, "y": 1.5 }, + { "label": "4", "x": 4, "y": 1.5 }, + { "label": "5", "x": 5, "y": 1.5 }, + { "label": "6", "x": 6, "y": 1.5 }, + { "label": "7", "x": 7, "y": 1.5 }, + { "label": "8", "x": 8, "y": 1.5 }, + { "label": "9", "x": 9, "y": 1.5 }, + { "label": "0", "x": 10, "y": 1.5 }, + { "label": "-", "x": 11, "y": 1.5 }, + { "label": "=", "x": 12, "y": 1.5 }, + { "label": "Back Space", "x": 13, "y": 1.5, "w": 2 }, + { "label": "Insert", "x": 15.25, "y": 1.5 }, + { "label": "Home", "x": 16.25, "y": 1.5 }, + { "label": "Page Up", "x": 17.25, "y": 1.5 }, + + { "label": "Tab", "x": 0, "y": 2.5, "w": 1.5 }, + { "label": "Q", "x": 1.5, "y": 2.5 }, + { "label": "W", "x": 2.5, "y": 2.5 }, + { "label": "E", "x": 3.5, "y": 2.5 }, + { "label": "R", "x": 4.5, "y": 2.5 }, + { "label": "T", "x": 5.5, "y": 2.5 }, + { "label": "Y", "x": 6.5, "y": 2.5 }, + { "label": "U", "x": 7.5, "y": 2.5 }, + { "label": "I", "x": 8.5, "y": 2.5 }, + { "label": "O", "x": 9.5, "y": 2.5 }, + { "label": "P", "x": 10.5, "y": 2.5 }, + { "label": "[", "x": 11.5, "y": 2.5 }, + { "label": "]", "x": 12.5, "y": 2.5 }, + { "label": "\\", "x": 13.5, "y": 2.5, "w": 1.5 }, + { "label": "Delete", "x": 15.25, "y": 2.5 }, + { "label": "End", "x": 16.25, "y": 2.5 }, + { "label": "Page Down", "x": 17.25, "y": 2.5 }, + + { "label": "Caps Lock", "x": 0, "y": 3.5, "w": 1.75 }, + { "label": "A", "x": 1.75, "y": 3.5 }, + { "label": "S", "x": 2.75, "y": 3.5 }, + { "label": "D", "x": 3.75, "y": 3.5 }, + { "label": "F", "x": 4.75, "y": 3.5 }, + { "label": "G", "x": 5.75, "y": 3.5 }, + { "label": "H", "x": 6.75, "y": 3.5 }, + { "label": "J", "x": 7.75, "y": 3.5 }, + { "label": "K", "x": 8.75, "y": 3.5 }, + { "label": "L", "x": 9.75, "y": 3.5 }, + { "label": ";", "x": 10.75, "y": 3.5 }, + { "label": "'", "x": 11.75, "y": 3.5 }, + { "label": "Enter", "x": 12.75, "y": 3.5, "w": 2.25 }, + + { "label": "Left Shift", "x": 0, "y": 4.5, "w": 2.25 }, + { "label": "Z", "x": 2.25, "y": 4.5 }, + { "label": "X", "x": 3.25, "y": 4.5 }, + { "label": "C", "x": 4.25, "y": 4.5 }, + { "label": "V", "x": 5.25, "y": 4.5 }, + { "label": "B", "x": 6.25, "y": 4.5 }, + { "label": "N", "x": 7.25, "y": 4.5 }, + { "label": "M", "x": 8.25, "y": 4.5 }, + { "label": ",", "x": 9.25, "y": 4.5 }, + { "label": ".", "x": 10.25, "y": 4.5 }, + { "label": "/", "x": 11.25, "y": 4.5 }, + { "label": "Right Shift", "x": 12.25, "y": 4.5, "w": 2.75 }, + { "label": "Up", "x": 16.25, "y": 4.5 }, + + { "label": "Left Ctrl", "x": 0, "y": 5.5, "w": 1.25 }, + { "label": "Left OS", "x": 1.25, "y": 5.5, "w": 1.25 }, + { "label": "Left Alt", "x": 2.5, "y": 5.5, "w": 1.25 }, + { "label": "Space", "x": 3.75, "y": 5.5, "w": 6.25 }, + { "label": "Right Alt", "x": 10, "y": 5.5, "w": 1.25 }, + { "label": "Fn", "x": 11.25, "y": 5.5, "w": 1.25 }, + { "label": "Menu", "x": 12.5, "y": 5.5, "w": 1.25 }, + { "label": "Right Ctrl", "x": 13.75, "y": 5.5, "w": 1.25 }, + { "label": "Left", "x": 15.25, "y": 5.5 }, + { "label": "Down", "x": 16.25, "y": 5.5 }, + { "label": "Right", "x": 17.25, "y": 5.5 } + ] + } + } +} diff --git a/keyboards/handwired/meck_tkl/keymaps/default/keymap.c b/keyboards/handwired/meck_tkl/keymaps/default/keymap.c new file mode 100644 index 0000000000..1df1318db5 --- /dev/null +++ b/keyboards/handwired/meck_tkl/keymaps/default/keymap.c @@ -0,0 +1,29 @@ +// Copyright 2021 Gabriel Kim (@gabrielkim13) +// 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_tkl_ansi( + 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_SLCK, 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_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_ENT, + 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_LCTL, KC_LGUI, KC_LALT, KC_SPC, KC_RALT, MO(1), KC_MENU, KC_RCTL, KC_LEFT, KC_DOWN, KC_RGHT + ), + [_FN] = LAYOUT_tkl_ansi( + _______, KC_MUTE, KC_VOLD, KC_VOLU, _______, KC_MPRV, KC_MPLY, KC_MNXT, _______, _______, _______, _______, _______, _______, _______, KC_SLEP, + _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, + _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, + _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, + _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, + _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______ + ) +}; diff --git a/keyboards/handwired/meck_tkl/keymaps/default/readme.md b/keyboards/handwired/meck_tkl/keymaps/default/readme.md new file mode 100644 index 0000000000..9e2994008a --- /dev/null +++ b/keyboards/handwired/meck_tkl/keymaps/default/readme.md @@ -0,0 +1 @@ +# The default keymap for meck_tkl diff --git a/keyboards/handwired/meck_tkl/meck_tkl.c b/keyboards/handwired/meck_tkl/meck_tkl.c new file mode 100644 index 0000000000..2668b440ec --- /dev/null +++ b/keyboards/handwired/meck_tkl/meck_tkl.c @@ -0,0 +1,4 @@ +// Copyright 2021 Gabriel Kim (@gabrielkim13) +// SPDX-License-Identifier: GPL-2.0-or-later + +#include "meck_tkl.h" diff --git a/keyboards/handwired/meck_tkl/meck_tkl.h b/keyboards/handwired/meck_tkl/meck_tkl.h new file mode 100644 index 0000000000..a7417dbafe --- /dev/null +++ b/keyboards/handwired/meck_tkl/meck_tkl.h @@ -0,0 +1,38 @@ +// Copyright 2021 Gabriel Kim (@gabrielkim13) +// SPDX-License-Identifier: GPL-2.0-or-later + +#pragma once + +#include "quantum.h" + +/* This is a shortcut to help you visually see your layout. + * + * The first section contains all of the arguments representing the physical + * layout of the board and position of the keys. + * + * The second converts the arguments into a two-dimensional array which + * represents the switch matrix. + * + * + * | Esc | | F1 | F2 | F3 | F4 | | F5 | F6 | F7 | F8 | | F9 | F10 | F11 | F12 | | SLk | Pau | NLk | + * | ` | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | - | = | Back | | Ins | Hom | PUp | + * | Tab | Q | W | E | R | T | Y | U | I | O | P | [ | ] | \ | | Del | End | PDn | + * | Caps | A | S | D | F | G | H | J | K | L | ; | ' | Enter | + * | Shift | Z | X | C | V | B | N | M | , | . | / | Shift | | ^ | + * | Ctrl | Win | alt | Space | alt | fn | Menu | Ctrl | | < | v | > | + */ +#define LAYOUT_tkl_ansi( \ + k00 , k01 , k02 , k03 , k04 , k05 , k06 , k07 , k08 , k09 , k0A , k0B , k0C , k0D , k0E , k0F , \ + k10 , k11 , k12 , k13 , k14 , k15 , k16 , k17 , k18 , k19 , k1A , k1B , k1C , k1D , k1E , k1F , k1G , \ + k20 , k21 , k22 , k23 , k24 , k25 , k26 , k27 , k28 , k29 , k2A , k2B , k2C , k2D , k2E , k2F , k2G , \ + k30 , k31 , k32 , k33 , k34 , k35 , k36 , k37 , k38 , k39 , k3A , k3B , k3C , \ + k40 , k41 , k42 , k43 , k44 , k45 , k46 , k47 , k48 , k49 , k4A , k4B , k4C , \ + k50 , k51 , k52 , k53 , k54 , k55 , k56 , k57 , k58 , k59 , k5A \ +) { \ + { k00, KC_NO, k01, k02, k03, k04, k05, k06, k07, k08, k09, k0A, k0B, k0C, k0D, k0E, k0F }, \ + { k10, k11, k12, k13, k14, k15, k16, k17, k18, k19, k1A, k1B, k1C, k1D, k1E, k1F, k1G }, \ + { k20, k21, k22, k23, k24, k25, k26, k27, k28, k29, k2A, k2B, k2C, k2D, k2E, k2F, k2G }, \ + { k30, k31, k32, k33, k34, k35, k36, k37, k38, k39, k3A, k3B, KC_NO, k3C, KC_NO, KC_NO, KC_NO }, \ + { k40, KC_NO, k41, k42, k43, k44, k45, k46, k47, k48, k49, k4A, KC_NO, k4B, KC_NO, k4C, KC_NO }, \ + { k50, k51, k52, KC_NO, KC_NO, KC_NO, k53, KC_NO, KC_NO, KC_NO, k54, k55, k56, k57, k58, k59, k5A } \ +} diff --git a/keyboards/handwired/meck_tkl/readme.md b/keyboards/handwired/meck_tkl/readme.md new file mode 100644 index 0000000000..ec09047dde --- /dev/null +++ b/keyboards/handwired/meck_tkl/readme.md @@ -0,0 +1,37 @@ +# meck_tkl + +![meck_tkl](https://i.imgur.com/eIpQTjQ.jpeg) + +A standard tenkeyless keyboard, using STM32 Blackpill. + +* Keyboard Maintainer: [Gabriel Kim](https://github.com/gabrielkim13) +* Hardware Supported: Blackpill F401 +* Hardware Availability: [Thingiverse: Mechanical Keyboard - MECH - TKL](https://www.thingiverse.com/thing:4225961) + +Make example for this keyboard (after setting up your build environment): + + make handwired/meck_tkl:default + +Flashing example for this keyboard: + + make handwired/meck_tkl: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 key at (0,0) in the matrix (usually the top left key or Escape) and plug in the keyboard +* **Physical reset button**: Briefly press the button on the back of the PCB - some may have pads you must short instead +* **Keycode in layout**: Press the key mapped to `RESET` if it is available + +## Wiring instructions + +- On Blackpill boards, **avoid** using the following pins, since they will cause either USB enumeration or the DFU bootloader to not work correctly: + - **USB-related pins:** `PA10`, `PA11`, `PA12` + - **BOOT1 pin:** `PB2` + +Sample wiring: + +![wiring](https://i.imgur.com/jIDmsNy.jpg) diff --git a/keyboards/handwired/meck_tkl/rules.mk b/keyboards/handwired/meck_tkl/rules.mk new file mode 100644 index 0000000000..6213285117 --- /dev/null +++ b/keyboards/handwired/meck_tkl/rules.mk @@ -0,0 +1,16 @@ +# Build Options +# change yes to no to disable +# +BOOTMAGIC_ENABLE = yes # Enable Bootmagic Lite +MOUSEKEY_ENABLE = yes # Mouse keys +EXTRAKEY_ENABLE = yes # Audio control and System control +CONSOLE_ENABLE = yes # Console for debug +COMMAND_ENABLE = no # Commands for debug and configuration +NKRO_ENABLE = yes # Enable N-Key Rollover +BACKLIGHT_ENABLE = no # Enable keyboard backlight functionality +RGBLIGHT_ENABLE = no # Enable keyboard RGB underglow +AUDIO_ENABLE = no # Audio output +AUDIO_SUPPORTED = no +BACKLIGHT_SUPPORTED = no + +DEFAULT_FOLDER = handwired/meck_tkl/blackpill_f401