Add UTD80 PCB (#11799)

* Create readme.md

* Add files via upload

* Create readme.md

* Add files via upload

* Update utd80.h

* Update utd80.c

* Update keymap.c

Change 6 length underscore to 7.

* Update keyboards/utd80/readme.md

Co-Authored-By: Drashna Jaelre <drashna@live.com>

* Update keyboards/utd80/readme.md

Co-Authored-By: Drashna Jaelre <drashna@live.com>

* Update keyboards/utd80/readme.md

Co-Authored-By: Drashna Jaelre <drashna@live.com>

* Update keyboards/utd80/readme.md

Co-Authored-By: fauxpark <fauxpark@gmail.com>

* Update keyboards/utd80/readme.md

Co-Authored-By: fauxpark <fauxpark@gmail.com>

* Update utd80.c

* Update utd80.c

* Update keymap.c

* Apply #7701 PR review suggestions

* Add GPL license headers

* Replace led implementation with definition

* Add VIA keymap for UTD80

* Update attributions

Co-authored-by: UTDKeyboard <59077857+utdkeyboard@users.noreply.github.com>
Co-authored-by: Drashna Jaelre <drashna@live.com>
Co-authored-by: fauxpark <fauxpark@gmail.com>

10 files changed, 274 insertions, 0 deletions

diff --git a/keyboards/utd80/config.h b/keyboards/utd80/config.h
new file mode 100644
index 0000000000..c5a9697f54
--- /dev/null
+++ b/keyboards/utd80/config.h
@@ -0,0 +1,68 @@
+/* Copyright 2021 UTDKeyboard & Dominic Gan
+ * 
+ * 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
+
+#include "config_common.h"
+
+/* USB Device descriptor parameter */
+#define VENDOR_ID       0xFEED
+#define PRODUCT_ID      0x001C
+#define DEVICE_VER      0x0001
+#define MANUFACTURER    UTD
+#define PRODUCT         UTD80
+
+/* key matrix size */
+#define MATRIX_ROWS 6
+#define MATRIX_COLS 16
+
+// ROWS: Top to bottom, COLS: Left to right
+
+#define MATRIX_ROW_PINS { B4, D5, D0, B2, B3, B0 }
+#define MATRIX_COL_PINS { B1, F0, F1, F4, F5, F6, F7, C7, C6, D3, E6, D7, D6, D4, D2, D1 }
+#define UNUSED_PINS
+
+#define BACKLIGHT_PIN B7
+#define BACKLIGHT_BREATHING
+#ifdef BACKLIGHT_PIN
+#define BACKLIGHT_LEVELS 3
+#endif
+
+/* COL2ROW or ROW2COL */
+#define DIODE_DIRECTION COL2ROW
+
+#define LED_CAPS_LOCK_PIN B6
+#define LED_SCROLL_LOCK_PIN B5
+
+/* define if matrix has ghost */
+//#define MATRIX_HAS_GHOST
+
+/* Set 0 if debouncing isn't 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
+
+#define RGB_DI_PIN E2
+#ifdef RGB_DI_PIN
+#define RGBLIGHT_ANIMATIONS
+#define RGBLED_NUM 4
+#define RGBLIGHT_HUE_STEP 8
+#define RGBLIGHT_SAT_STEP 8
+#define RGBLIGHT_VAL_STEP 8
+#endif
diff --git a/keyboards/utd80/info.json b/keyboards/utd80/info.json
new file mode 100644
index 0000000000..701bf1fcf7
--- /dev/null
+++ b/keyboards/utd80/info.json
@@ -0,0 +1,15 @@
+{
+    "keyboard_name": "UTD80",
+    "url": "",
+    "maintainer": "qmk",
+    "width": 18.25,
+    "height": 6.5,
+    "layouts": {
+      "LAYOUT_tkl_ansi_wkl": {
+        "layout": [{"x":0, "y":0}, {"x":2, "y":0}, {"x":3, "y":0}, {"x":4, "y":0}, {"x":5, "y":0}, {"x":6.5, "y":0}, {"x":7.5, "y":0}, {"x":8.5, "y":0}, {"x":9.5, "y":0}, {"x":11, "y":0}, {"x":12, "y":0}, {"x":13, "y":0}, {"x":14, "y":0}, {"x":15.25, "y":0}, {"x":16.25, "y":0}, {"x":17.25, "y":0}, {"x":0, "y":1.5}, {"x":1, "y":1.5}, {"x":2, "y":1.5}, {"x":3, "y":1.5}, {"x":4, "y":1.5}, {"x":5, "y":1.5}, {"x":6, "y":1.5}, {"x":7, "y":1.5}, {"x":8, "y":1.5}, {"x":9, "y":1.5}, {"x":10, "y":1.5}, {"x":11, "y":1.5}, {"x":12, "y":1.5}, {"x":13, "y":1.5, "w":2}, {"x":15.25, "y":1.5}, {"x":16.25, "y":1.5}, {"x":17.25, "y":1.5}, {"x":0, "y":2.5, "w":1.5}, {"x":1.5, "y":2.5}, {"x":2.5, "y":2.5}, {"x":3.5, "y":2.5}, {"x":4.5, "y":2.5}, {"x":5.5, "y":2.5}, {"x":6.5, "y":2.5}, {"x":7.5, "y":2.5}, {"x":8.5, "y":2.5}, {"x":9.5, "y":2.5}, {"x":10.5, "y":2.5}, {"x":11.5, "y":2.5}, {"x":12.5, "y":2.5}, {"x":13.5, "y":2.5, "w":1.5}, {"x":15.25, "y":2.5}, {"x":16.25, "y":2.5}, {"x":17.25, "y":2.5}, {"x":0, "y":3.5, "w":1.75}, {"x":1.75, "y":3.5}, {"x":2.75, "y":3.5}, {"x":3.75, "y":3.5}, {"x":4.75, "y":3.5}, {"x":5.75, "y":3.5}, {"x":6.75, "y":3.5}, {"x":7.75, "y":3.5}, {"x":8.75, "y":3.5}, {"x":9.75, "y":3.5}, {"x":10.75, "y":3.5}, {"x":11.75, "y":3.5}, {"x":12.75, "y":3.5, "w":2.25}, {"x":0, "y":4.5, "w":2.25}, {"x":2.25, "y":4.5}, {"x":3.25, "y":4.5}, {"x":4.25, "y":4.5}, {"x":5.25, "y":4.5}, {"x":6.25, "y":4.5}, {"x":7.25, "y":4.5}, {"x":8.25, "y":4.5}, {"x":9.25, "y":4.5}, {"x":10.25, "y":4.5}, {"x":11.25, "y":4.5}, {"x":12.25, "y":4.5, "w":2.75}, {"x":16.25, "y":4.5}, {"x":0, "y":5.5, "w":1.5}, {"x":2.5, "y":5.5, "w":1.5}, {"x":4, "y":5.5, "w":7}, {"x":11, "y":5.5, "w":1.5}, {"x":13.5, "y":5.5, "w":1.5}, {"x":15.25, "y":5.5}, {"x":16.25, "y":5.5}, {"x":17.25, "y":5.5}]
+      }
+    }
+}
+
+
+
diff --git a/keyboards/utd80/keymaps/default/keymap.c b/keyboards/utd80/keymaps/default/keymap.c
new file mode 100644
index 0000000000..8d8bfc6159
--- /dev/null
+++ b/keyboards/utd80/keymaps/default/keymap.c
@@ -0,0 +1,44 @@
+/* Copyright 2021 UTDKeyboard & Dominic Gan
+ * 
+ * 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_tkl_ansi_wkl(
+        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_LALT,                             KC_SPC,                                       MO(2),          KC_RCTL,       KC_LEFT, KC_DOWN, KC_RGHT 
+    ),
+    [1] = LAYOUT_tkl_ansi_wkl(
+        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_LALT,                             KC_SPC,                                     KC_RALT,          KC_RCTL,       KC_LEFT, KC_DOWN, KC_RGHT
+    ),
+    [2] = LAYOUT_tkl_ansi_wkl(
+        _______,            BL_ON, BL_STEP, BL_BRTG,  BL_OFF, _______, _______, _______, _______, _______, _______, _______, _______,       _______, _______, _______,
+        _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,       _______, _______, _______,
+        _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,       _______, _______, _______,
+        _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,          _______,
+        _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,                   _______,                _______,
+        _______,          _______,                            _______,                                     _______,          _______,       _______, _______, _______
+    )
+};
diff --git a/keyboards/utd80/keymaps/default/readme.md b/keyboards/utd80/keymaps/default/readme.md
new file mode 100644
index 0000000000..59c01c6195
--- /dev/null
+++ b/keyboards/utd80/keymaps/default/readme.md
@@ -0,0 +1 @@
+# The default keymap for UTD80
diff --git a/keyboards/utd80/keymaps/via/keymap.c b/keyboards/utd80/keymaps/via/keymap.c
new file mode 100644
index 0000000000..0f5d573844
--- /dev/null
+++ b/keyboards/utd80/keymaps/via/keymap.c
@@ -0,0 +1,52 @@
+/* Copyright 2021 UTDKeyboard & Dominic Gan
+ * 
+ * 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_tkl_ansi_wkl(
+        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_LALT,                             KC_SPC,                                       MO(1),          KC_RCTL,       KC_LEFT, KC_DOWN, KC_RGHT 
+    ),
+    [1] = LAYOUT_tkl_ansi_wkl(
+        _______,            BL_ON, BL_STEP, BL_BRTG,  BL_OFF, _______, _______, _______, _______, _______, _______, _______, _______,       _______, _______, _______,
+        _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,       _______, _______, _______,
+        _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,       _______, _______, _______,
+        _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,          _______,
+        _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,                   _______,                _______,
+        _______,          _______,                            _______,                                     _______,          _______,       _______, _______, _______
+    ),
+    [2] = LAYOUT_tkl_ansi_wkl(
+        _______,          _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,       _______, _______, _______,
+        _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,       _______, _______, _______,
+        _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,       _______, _______, _______,
+        _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,          _______,
+        _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,                   _______,                _______,
+        _______,          _______,                            _______,                                     _______,          _______,       _______, _______, _______
+    ),
+    [3] = LAYOUT_tkl_ansi_wkl(
+        _______,          _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,       _______, _______, _______,
+        _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,       _______, _______, _______,
+        _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,       _______, _______, _______,
+        _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,          _______,
+        _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,                   _______,                _______,
+        _______,          _______,                            _______,                                     _______,          _______,       _______, _______, _______
+    )
+};
diff --git a/keyboards/utd80/keymaps/via/rules.mk b/keyboards/utd80/keymaps/via/rules.mk
new file mode 100644
index 0000000000..ad7a6e4056
--- /dev/null
+++ b/keyboards/utd80/keymaps/via/rules.mk
@@ -0,0 +1,3 @@
+VIA_ENABLE = yes
+
+LTO_ENABLE = yes
diff --git a/keyboards/utd80/readme.md b/keyboards/utd80/readme.md
new file mode 100644
index 0000000000..c2c11b7af4
--- /dev/null
+++ b/keyboards/utd80/readme.md
@@ -0,0 +1,16 @@
+# UTD80
+
+A 80% replacement PCB for OTD keyboards.
+
+![UTD80 PCB](https://i.imgur.com/U0X8XmAl.jpg)
+
+
+* Keyboard Maintainer: [UTDKeyboard](https://github.com/utdkeyboard)
+* Hardware Supported: OTD TKL keyboard
+* Hardware Availability: TaoBao
+
+Make example for this keyboard (after setting up your build environment):
+
+    make utd80:default
+
+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/utd80/rules.mk b/keyboards/utd80/rules.mk
new file mode 100644
index 0000000000..f77a4ad180
--- /dev/null
+++ b/keyboards/utd80/rules.mk
@@ -0,0 +1,22 @@
+# MCU name
+MCU = atmega32u4
+
+# Bootloader selection
+BOOTLOADER = atmel-dfu
+
+# Build Options
+#   change yes to no to disable
+#
+BOOTMAGIC_ENABLE = full       # Virtual DIP switch configuration
+MOUSEKEY_ENABLE = no       # Mouse keys
+EXTRAKEY_ENABLE = yes       # Audio control and System control
+CONSOLE_ENABLE = no        # Console for debug
+COMMAND_ENABLE = no        # Commands for debug and configuration
+# Do not enable SLEEP_LED_ENABLE. it uses the same timer as BACKLIGHT_ENABLE
+SLEEP_LED_ENABLE = no       # Breathing sleep LED during USB suspend
+# if this doesn't work, see here: https://github.com/tmk/tmk_keyboard/wiki/FAQ#nkro-doesnt-work
+NKRO_ENABLE = yes            # USB Nkey Rollover
+BACKLIGHT_ENABLE = yes       # Enable keyboard backlight functionality
+RGBLIGHT_ENABLE = yes        # Enable keyboard RGB underglow
+BLUETOOTH_ENABLE = no       # Enable Bluetooth
+AUDIO_ENABLE = no           # Audio output
diff --git a/keyboards/utd80/utd80.c b/keyboards/utd80/utd80.c
new file mode 100644
index 0000000000..7b1a269d7b
--- /dev/null
+++ b/keyboards/utd80/utd80.c
@@ -0,0 +1,16 @@
+/* Copyright 2021 UTDKeyboard & Dominic Gan
+ * 
+ * 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 "utd80.h"
diff --git a/keyboards/utd80/utd80.h b/keyboards/utd80/utd80.h
new file mode 100644
index 0000000000..43d69ef845
--- /dev/null
+++ b/keyboards/utd80/utd80.h
@@ -0,0 +1,37 @@
+/* Copyright 2021 UTDKeyboard & Dominic Gan
+ * 
+ * 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
+
+#include "quantum.h"
+
+#define XXX KC_NO
+
+#define LAYOUT_tkl_ansi_wkl( \
+    K00,      K02, K03, K04, K05,   K06, K07, K08, K09,   K0A, K0B, K0C, K0D,   K01,K0F,K5F, \
+    K10, K11, K12, K13, K14, K15, K16, K17, K18, K19, K1A, K1B, K1C,   K1D,     K1E,K1F,K3F, \
+     K20, K21, K22, K23, K24, K25, K26, K27, K28, K29, K2A, K2B, K2C,   K2D,    K2E,K2F,K4F, \
+    K30,   K31, K32, K33, K34, K35, K36, K37, K38, K39, K3A, K3B,    K3D,                    \
+      K40,  K41, K42, K43, K44, K45, K46, K47, K48, K49, K4A,      K4D,             K4E,     \
+     K50,          K51,               K56,               K5A,          K5D,     K5E,K3E,K0E  \
+) { \
+    { 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}, \
+    { K20, K21, K22, K23, K24, K25, K26, K27, K28, K29, K2A, K2B, K2C, K2D, K2E, K2F}, \
+    { K30, K31, K32, K33, K34, K35, K36, K37, K38, K39, K3A, K3B, XXX, K3D, K3E, K3F}, \
+    { K40, K41, K42, K43, K44, K45, K46, K47, K48, K49, K4A, XXX, XXX, K4D, K4E, K4F}, \
+    { K50, K51, XXX, XXX, XXX, XXX, K56, XXX, XXX, XXX, K5A, XXX, XXX, K5D, K5E, K5F}  \
+}
+