[Keyboard] Jian keyboard (#8914)

Co-authored-by: Joel Challis <git@zvecr.com>
Co-authored-by: Drashna Jaelre <drashna@live.com>
Co-authored-by: Ryan <fauxpark@gmail.com>
Co-authored-by: Nick Brassel <nick@tzarc.org>

4 files changed, 288 insertions, 0 deletions

diff --git a/keyboards/jian/rev1/config.h b/keyboards/jian/rev1/config.h
new file mode 100644
index 0000000000..799a71fc07
--- /dev/null
+++ b/keyboards/jian/rev1/config.h
@@ -0,0 +1,138 @@
+/*
+Copyright 2012 Jun Wako <wakojun@gmail.com>
+Copyright 2015 Jack Humbert
+
+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       0xC0DE
+#define PRODUCT_ID      0x1337
+#define DEVICE_VER      0x0100
+#define MANUFACTURER    KgOfHedgehogs
+#define PRODUCT         Jian
+#define DESCRIPTION     An ergo split keyboard
+
+/* key matrix size */
+// Rows are doubled-up
+#define MATRIX_ROWS 8
+#define MATRIX_COLS 7
+#define DIODE_DIRECTION COL2ROW
+
+// wiring of each half
+#define MATRIX_ROW_PINS { D3, D2, E6, B4 }
+#define MATRIX_COL_PINS { F4, F5, F6, F7, B1, B3, B2 }
+
+/* Use I2C or Serial, not both */
+// #define USE_SERIAL
+#define USE_I2C
+
+/* Select hand configuration */
+// #define MASTER_LEFT
+// #define MASTER_RIGHT
+#define EE_HANDS
+
+// different Jian configs
+#define DIPS_ENABLE
+#define PHYSICAL_LEDS_ENABLE
+#define NUM_LOCK_LED_PIN C6
+#define CAPS_LOCK_LED_PIN D7
+#define SCROLL_LOCK_LED_PIN B5
+
+// #define NUM_NMOSFET  //uncomment this if you using n-mosfet
+// #define CAPS_NMOSFET  //uncomment this if you using n-mosfet
+// #define SCROLL_NMOSFET  //uncomment this if you using n-mosfet
+
+// #define NUM_INVERT // uncomment this if you want to reverse logic of numlock
+// This will make it light up only when lock is off
+// (Doesn't work on mac. There is no num lock, so it will be always off and lit)
+
+#ifdef NUM_NMOSFET
+#define RESET_NUM_LOCK_LED() writePinLow(NUM_LOCK_LED_PIN)
+#ifdef NUM_INVERT
+#define UPDATE_NUM_LOCK_LED() writePin(NUM_LOCK_LED_PIN, !led_state.num_lock)
+#else
+#define UPDATE_NUM_LOCK_LED() writePin(NUM_LOCK_LED_PIN, led_state.num_lock)
+#endif // NUM_INVERT
+#else
+#define RESET_NUM_LOCK_LED() writePinHigh(NUM_LOCK_LED_PIN)
+#ifdef NUM_INVERT
+#define UPDATE_NUM_LOCK_LED() writePin(NUM_LOCK_LED_PIN, led_state.num_lock)
+#else
+#define UPDATE_NUM_LOCK_LED() writePin(NUM_LOCK_LED_PIN, !led_state.num_lock)
+#endif // NUM_INVERT
+#endif // NUM_NMOSFET
+
+#ifdef CAPS_NMOSFET
+#define RESET_CAPS_LOCK_LED() writePinLow(CAPS_LOCK_LED_PIN)
+#define UPDATE_CAPS_LOCK_LED() writePin(CAPS_LOCK_LED_PIN, led_state.caps_lock)
+#else
+#define RESET_CAPS_LOCK_LED() writePinHigh(CAPS_LOCK_LED_PIN)
+#define UPDATE_CAPS_LOCK_LED() writePin(CAPS_LOCK_LED_PIN, !led_state.caps_lock)
+#endif // CAPS_NMOSFET
+
+#ifdef SCROLL_NMOSFET
+#define RESET_SCROLL_LOCK_LED() writePinLow(SCROLL_LOCK_LED_PIN)
+#define UPDATE_SCROLL_LOCK_LED() writePin(SCROLL_LOCK_LED_PIN, led_state.scroll_lock)
+#else
+#define RESET_SCROLL_LOCK_LED() writePinHigh(SCROLL_LOCK_LED_PIN)
+#define UPDATE_SCROLL_LOCK_LED() writePin(SCROLL_LOCK_LED_PIN, !led_state.scroll_lock)
+#endif // SCROLL_NMOSFET
+
+/* Set 0 if debouncing isn't needed */
+#define DEBOUNCE 5
+
+#ifdef BACKLIGHT_ENABLE
+#define BACKLIGHT_PIN B6
+#define BACKLIGHT_LEVELS 5
+//#define BACKLIGHT_BREATHING //not working with splits right now
+#define BREATHING_PERIOD 6
+#endif
+
+/* ws2812 RGB LED */
+#define RGB_DI_PIN D4
+#define RGBLIGHT_TIMER
+#define RGBLED_NUM 7    // Number of LEDs
+#define RGBLIGHT_ANIMATIONS //not working with splits right now
+
+#define RGBLIGHT_SLEEP
+#define RGBLIGHT_SPLIT
+
+#ifndef IOS_DEVICE_ENABLE
+#if RGBLED_NUM <= 6
+#define RGBLIGHT_LIMIT_VAL 255
+#else
+#define RGBLIGHT_LIMIT_VAL 130
+#endif
+#define RGBLIGHT_VAL_STEP 8
+#else
+#if RGBLED_NUM <= 6
+#define RGBLIGHT_LIMIT_VAL 90
+#else
+#define RGBLIGHT_LIMIT_VAL 45
+#endif
+#define RGBLIGHT_VAL_STEP 4
+#endif
+#define RGBLIGHT_HUE_STEP 10
+#define RGBLIGHT_SAT_STEP 17
+
+#if defined(RGBLIGHT_ENABLE) && !defined(IOS_DEVICE_ENABLE)
+#define USB_MAX_POWER_CONSUMPTION 400
+#else
+// iOS device need lessthan 100
+#define USB_MAX_POWER_CONSUMPTION 100
+#endif
diff --git a/keyboards/jian/rev1/rev1.c b/keyboards/jian/rev1/rev1.c
new file mode 100644
index 0000000000..f1cfe99180
--- /dev/null
+++ b/keyboards/jian/rev1/rev1.c
@@ -0,0 +1,74 @@
+#include "rev1.h"
+
+#ifdef SWAP_HANDS_ENABLE
+__attribute__ ((weak))
+const keypos_t hand_swap_config[MATRIX_ROWS][MATRIX_COLS] = {
+  {{0, 4}, {1, 4}, {2, 4}, {3, 4}, {4, 4}, {5, 4}, {6, 4}},
+  {{0, 5}, {1, 5}, {2, 5}, {3, 5}, {4, 5}, {5, 5}, {6, 5}},
+  {{0, 6}, {1, 6}, {2, 6}, {3, 6}, {4, 6}, {5, 6}, {6, 6}},
+  {{0, 7}, {1, 7}, {2, 7}, {3, 7}, {4, 7}, {5, 7}, {6, 7}},
+  {{0, 0}, {1, 0}, {2, 0}, {3, 0}, {4, 0}, {5, 0}, {6, 0}},
+  {{0, 1}, {1, 1}, {2, 1}, {3, 1}, {4, 1}, {5, 1}, {6, 1}},
+  {{0, 2}, {1, 2}, {2, 2}, {3, 2}, {4, 2}, {5, 2}, {6, 2}},
+  {{0, 3}, {1, 3}, {2, 3}, {3, 3}, {4, 3}, {5, 3}, {6, 3}},
+};
+#endif
+
+static bool backlight_was_toggled = false;
+
+void suspend_power_down_kb(void) {
+    if (is_backlight_enabled()) {
+        backlight_disable();
+        backlight_was_toggled = true;
+    }
+}
+
+void suspend_wakeup_init_kb(void) {
+    if (backlight_was_toggled) {
+        backlight_enable();
+        backlight_was_toggled = false;
+    }
+}
+
+#ifdef PHYSICAL_LEDS_ENABLE
+void led_init_kb(void)
+{
+#ifdef NUM_LOCK_LED_PIN
+    setPinOutput(NUM_LOCK_LED_PIN);
+    RESET_NUM_LOCK_LED();
+#endif // NUM_LOCK_LED_PIN
+#ifdef CAPS_LOCK_LED_PIN
+    setPinOutput(CAPS_LOCK_LED_PIN);
+    RESET_CAPS_LOCK_LED();
+#endif // CAPS_LOCK_LED_PIN
+#ifdef SCROLL_LOCK_LED_PIN
+    setPinOutput(SCROLL_LOCK_LED_PIN);
+    RESET_SCROLL_LOCK_LED();
+#endif // SCROLL_LOCK_LED_PIN
+}
+#endif // PHYSICAL_LEDS_ENABLE
+
+void matrix_init_kb(void) {
+#ifdef PHYSICAL_LEDS_ENABLE
+  led_init_kb();
+#endif // PHYSICAL_LEDS_ENABLE
+  matrix_init_user();
+};
+
+#ifdef PHYSICAL_LEDS_ENABLE
+bool led_update_kb(led_t led_state) {
+    bool res = led_update_user(led_state);
+    if(res) {
+#ifdef NUM_LOCK_LED_PIN
+        UPDATE_NUM_LOCK_LED();
+#endif // NUM_LOCK_LED_PIN
+#ifdef CAPS_LOCK_LED_PIN
+        UPDATE_CAPS_LOCK_LED();
+#endif // CAPS_LOCK_LED_PIN
+#ifdef SCROLL_LOCK_LED_PIN
+        UPDATE_SCROLL_LOCK_LED();
+#endif // SCROLL_LOCK_LED_PIN
+    }
+    return res;
+}
+#endif // PHYSICAL_LEDS_ENABLE
diff --git a/keyboards/jian/rev1/rev1.h b/keyboards/jian/rev1/rev1.h
new file mode 100644
index 0000000000..ee55de6287
--- /dev/null
+++ b/keyboards/jian/rev1/rev1.h
@@ -0,0 +1,56 @@
+#pragma once
+
+#include "jian.h"
+
+#define XXX KC_NO
+
+#define LAYOUT( \
+  L00, L01, L02, L03, L04, L05, L06,    R06, R05, R04, R03, R02, R01, R00, \
+       L11, L12, L13, L14, L15, L16,    R16, R15, R14, R13, R12, R11, \
+       L21, L22, L23, L24, L25, L26,    R26, R25, R24, R23, R22, R21, \
+                      L34, L35, L36,    R36, R35, R34 \
+) \
+{ \
+  {L00, L01, L02, L03, L04, L05, L06}, \
+  {XXX, L11, L12, L13, L14, L15, L16}, \
+  {XXX, L21, L22, L23, L24, L25, L26}, \
+  {XXX, XXX, XXX, XXX, L34, L35, L36}, \
+  {R00, R01, R02, R03, R04, R05, R06}, \
+  {XXX, R11, R12, R13, R14, R15, R16}, \
+  {XXX, R21, R22, R23, R24, R25, R26}, \
+  {XXX, XXX, XXX, XXX, R34, R35, R36} \
+}
+
+#define LAYOUT_symmetric( \
+  K00, K01, K02, K03, K04, K05, K06, \
+       K11, K12, K13, K14, K15, K16, \
+       K21, K22, K23, K24, K25, K26, \
+                      K34, K35, K36 \
+) \
+{ \
+  {K00, K01, K02, K03, K04, K05, K06}, \
+  {XXX, K11, K12, K13, K14, K15, K16}, \
+  {XXX, K21, K22, K23, K24, K25, K26}, \
+  {XXX, XXX, XXX, XXX, K34, K35, K36}, \
+  {K00, K01, K02, K03, K04, K05, K06}, \
+  {XXX, K11, K12, K13, K14, K15, K16}, \
+  {XXX, K21, K22, K23, K24, K25, K26}, \
+  {XXX, XXX, XXX, XXX, K34, K35, K36} \
+}
+
+#ifdef DIPS_ENABLE
+#define LAYOUT_dips( \
+  DL0, DL1, DL2, DL3, DL4, DL5, \
+  DR5, DR4, DR3, DR2, DR1, DR0  \
+) \
+{ \
+  {XXX, XXX, XXX, XXX, XXX, XXX, XXX}, \
+  {DL0, XXX, XXX, XXX, XXX, XXX, XXX}, \
+  {DL1, XXX, XXX, XXX, XXX, XXX, XXX}, \
+  {DL2, DL3, DL4, DL5, XXX, XXX, XXX}, \
+  {XXX, XXX, XXX, XXX, XXX, XXX, XXX}, \
+  {DR0, XXX, XXX, XXX, XXX, XXX, XXX}, \
+  {DR1, XXX, XXX, XXX, XXX, XXX, XXX}, \
+  {DR2, DR3, DR4, DR5, XXX, XXX, XXX}, \
+}
+#endif // DIPS_ENABLE
diff --git a/keyboards/jian/rev1/rules.mk b/keyboards/jian/rev1/rules.mk
new file mode 100644
index 0000000000..915b647548
--- /dev/null
+++ b/keyboards/jian/rev1/rules.mk
@@ -0,0 +1,20 @@
+# MCU name
+MCU = atmega32u4
+
+# Bootloader selection
+#   Teensy       halfkay
+#   Pro Micro    caterina
+#   Atmel DFU    atmel-dfu
+#   LUFA DFU     lufa-dfu
+#   QMK DFU      qmk-dfu
+#   ATmega32A    bootloadHID
+#   ATmega328P   USBasp
+BOOTLOADER = caterina
+
+# Build Options
+#   change yes to no to disable
+#
+CONSOLE_ENABLE = no
+SPLIT_KEYBOARD = yes
+BACKLIGHT_ENABLE = yes
+RGBLIGHT_ENABLE = yes