From a0f532072d9f057f57c073521c2f587339ff8c20 Mon Sep 17 00:00:00 2001
From: Xelus22 <17491233+Xelus22@users.noreply.github.com>
Date: Sun, 28 Feb 2021 06:04:46 +0000
Subject: [PATCH] [Keyboard] Dawn60 Rev1 RGB matrix port (#11970)
* refactor
* layout update
* fix mods config
* lto enable
* add eeprom
* refactor
* final refactor
---
keyboards/xelus/dawn60/dawn60.h | 2 +
keyboards/xelus/dawn60/rev1_qmk/config.h | 73 +++++++
keyboards/xelus/dawn60/rev1_qmk/readme.md | 3 +
keyboards/xelus/dawn60/rev1_qmk/rev1_qmk.c | 216 +++++++++++++++++++++
keyboards/xelus/dawn60/rev1_qmk/rev1_qmk.h | 34 ++++
keyboards/xelus/dawn60/rev1_qmk/rules.mk | 50 +++++
6 files changed, 378 insertions(+)
create mode 100644 keyboards/xelus/dawn60/rev1_qmk/config.h
create mode 100644 keyboards/xelus/dawn60/rev1_qmk/readme.md
create mode 100644 keyboards/xelus/dawn60/rev1_qmk/rev1_qmk.c
create mode 100644 keyboards/xelus/dawn60/rev1_qmk/rev1_qmk.h
create mode 100644 keyboards/xelus/dawn60/rev1_qmk/rules.mk
diff --git a/keyboards/xelus/dawn60/dawn60.h b/keyboards/xelus/dawn60/dawn60.h
index e663e3bbe..feec9b5e1 100644
--- a/keyboards/xelus/dawn60/dawn60.h
+++ b/keyboards/xelus/dawn60/dawn60.h
@@ -19,4 +19,6 @@
#if defined(KEYBOARD_xelus_dawn60_rev1)
#include "rev1.h"
+#elif defined(KEYBOARD_xelus_dawn60_rev1_qmk)
+ #include "rev1_qmk.h"
#endif
diff --git a/keyboards/xelus/dawn60/rev1_qmk/config.h b/keyboards/xelus/dawn60/rev1_qmk/config.h
new file mode 100644
index 000000000..07de129c0
--- /dev/null
+++ b/keyboards/xelus/dawn60/rev1_qmk/config.h
@@ -0,0 +1,73 @@
+/* Copyright 2017 Jason Williams (Wilba)
+ *
+ * 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 .
+ */
+#pragma once
+
+#include "config_common.h"
+
+// USB Device descriptor parameter
+#define VENDOR_ID 0x5845 // XE
+#define PRODUCT_ID 0x0060 // Dawn60
+#define DEVICE_VER 0x0001
+#define MANUFACTURER Xelus
+#define PRODUCT Dawn60
+
+// key matrix size
+#define MATRIX_ROWS 5
+#define MATRIX_COLS 14
+
+//underglow
+#define MATRIX_ROW_PINS { B1, B3, F1, F6, F7 }
+#define MATRIX_COL_PINS { B0, D5, B2, F5, D3, D2, C7, C6, B6, B5, B4, D7, D6, D4 }
+#define UNUSED_PINS
+
+// COL2ROW or ROW2COL
+#define DIODE_DIRECTION COL2ROW
+
+// 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
+
+//RGB Underglow defines
+#define RGB_DI_PIN F0
+#define WS2812_LED_TOTAL 20
+
+//RGB Matrix defines
+#define DRIVER_ADDR_1 0x74
+#define DRIVER_ADDR_2 0x76
+
+#define DRIVER_COUNT 2
+#define DRIVER_1_LED_TOTAL 32
+#define DRIVER_2_LED_TOTAL 32
+#define ISSI_DRIVER_TOTAL (DRIVER_1_LED_TOTAL + DRIVER_2_LED_TOTAL)
+#define DRIVER_LED_TOTAL (DRIVER_1_LED_TOTAL + DRIVER_2_LED_TOTAL + WS2812_LED_TOTAL)
+
+#define RGB_MATRIX_STARTUP_VAL 80
+#define RGB_MATRIX_KEYPRESSES
+
+// enable/disable LEDs based on layout
+// switch between split backspace (1) or normal backspace(0)
+#define RGB_BACKLIGHT_USE_SPLIT_BACKSPACE 1
+// switch between Tsangan (1) or Arrows Bottom Row (0)
+#define RGB_BACKLIGHT_USE_7U_SPACEBAR 0
+// switch between standard split rshift (0) or arrows r shift (1)
+// .------------------. .-------------------.
+// | ? | Shift | Fn | vs | Shift | Up | Fn |
+// `------------------' `-------------------'
+#define RGB_BACKLIGHT_USE_SPLIT_RIGHT_SHIFT 1
diff --git a/keyboards/xelus/dawn60/rev1_qmk/readme.md b/keyboards/xelus/dawn60/rev1_qmk/readme.md
new file mode 100644
index 000000000..b105dd6c7
--- /dev/null
+++ b/keyboards/xelus/dawn60/rev1_qmk/readme.md
@@ -0,0 +1,3 @@
+# Dawn60
+
+The QMK RGB Matrix Version
\ No newline at end of file
diff --git a/keyboards/xelus/dawn60/rev1_qmk/rev1_qmk.c b/keyboards/xelus/dawn60/rev1_qmk/rev1_qmk.c
new file mode 100644
index 000000000..901f7a18c
--- /dev/null
+++ b/keyboards/xelus/dawn60/rev1_qmk/rev1_qmk.c
@@ -0,0 +1,216 @@
+/* Copyright 2017 Jason Williams (Wilba)
+ *
+ * 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 .
+ */
+
+#include
+#include
+#include
+#include
+#include "drivers/issi/is31fl3731.h"
+#include "ws2812.h"
+#include "rev1_qmk.h"
+
+#ifdef RGB_MATRIX_ENABLE
+LED_TYPE rgb_matrix_ws2812_array[WS2812_LED_TOTAL];
+
+const is31_led g_is31_leds[DRIVER_LED_TOTAL] = {
+/* Refer to IS31 manual for these locations
+ * driver
+ * | R location
+ * | | G location
+ * | | | B location
+ * | | | | */
+ {0, C1_1, C3_2, C4_2}, //A1
+ {0, C1_2, C2_2, C4_3}, //A2
+ {0, C1_3, C2_3, C3_3}, //A3
+ {0, C1_4, C2_4, C3_4}, //A4
+ {0, C1_5, C2_5, C3_5}, //A5
+ {0, C1_6, C2_6, C3_6}, //A6
+ {0, C1_7, C2_7, C3_7}, //A7
+ {0, C1_8, C2_8, C3_8}, //A8
+ {0, C9_1, C8_1, C7_1}, //A9
+ {0, C9_2, C8_2, C7_2}, //A10
+ {0, C9_3, C8_3, C7_3}, //A11
+ {0, C9_4, C8_4, C7_4}, //A12
+ {0, C9_5, C8_5, C7_5}, //A13
+ {0, C9_6, C8_6, C7_6}, //A14
+ {0, C9_7, C8_7, C6_6}, //A15
+ {0, C9_8, C7_7, C6_7}, //A16
+
+ {0, C1_9, C3_10, C4_10}, //B1
+ {0, C1_10, C2_10, C4_11}, //B2
+ {0, C1_11, C2_11, C3_11}, //B3
+ {0, C1_12, C2_12, C3_12}, //B4
+ {0, C1_13, C2_13, C3_13}, //B5
+ {0, C1_14, C2_14, C3_14}, //B6
+ {0, C1_15, C2_15, C3_15}, //B7
+ {0, C1_16, C2_16, C3_16}, //B8
+ {0, C9_9, C8_9, C7_9}, //B9
+ {0, C9_10, C8_10, C7_10}, //B10
+ {0, C9_11, C8_11, C7_11}, //B11
+ {0, C9_12, C8_12, C7_12}, //B12
+ {0, C9_13, C8_13, C7_13}, //B13
+ {0, C9_14, C8_14, C7_14}, //B14
+ {0, C9_15, C8_15, C6_14}, //B15
+ {0, C9_16, C7_15, C6_15}, //B16
+
+ {1, C1_1, C3_2, C4_2}, //C1
+ {1, C1_2, C2_2, C4_3}, //C2
+ {1, C1_3, C2_3, C3_3}, //C3
+ {1, C1_4, C2_4, C3_4}, //C4
+ {1, C1_5, C2_5, C3_5}, //C5
+ {1, C1_6, C2_6, C3_6}, //C6
+ {1, C1_7, C2_7, C3_7}, //C7
+ {1, C1_8, C2_8, C3_8}, //C8
+ {1, C9_1, C8_1, C7_1}, //C9
+ {1, C9_2, C8_2, C7_2}, //C10
+ {1, C9_3, C8_3, C7_3}, //C11
+ {1, C9_4, C8_4, C7_4}, //C12
+ {1, C9_5, C8_5, C7_5}, //C13
+ {1, C9_6, C8_6, C7_6}, //C14
+ {1, C9_7, C8_7, C6_6}, //C15
+ {1, C9_8, C7_7, C6_7}, //C16
+
+ {1, C1_9, C3_10, C4_10}, //D1
+ {1, C1_10, C2_10, C4_11}, //D2
+ {1, C1_11, C2_11, C3_11}, //D3
+ {1, C1_12, C2_12, C3_12}, //D4
+ {1, C1_13, C2_13, C3_13}, //D5
+ {1, C1_14, C2_14, C3_14}, //D6
+ {1, C1_15, C2_15, C3_15}, //D7
+ {1, C1_16, C2_16, C3_16}, //D8
+ {1, C9_9, C8_9, C7_9}, //D9
+ {1, C9_10, C8_10, C7_10}, //D10
+ {1, C9_11, C8_11, C7_11}, //D11
+ {1, C9_12, C8_12, C7_12}, //D12
+ {1, C9_13, C8_13, C7_13}, //D13
+ {1, C9_14, C8_14, C7_14}, //D14
+ {1, C9_15, C8_15, C6_14}, //D15
+ {1, C9_16, C7_15, C6_15}, //D16
+
+ //fake underglows 1- 20
+ {2, 0, 0, 0},
+ {2, 0, 0, 0},
+ {2, 0, 0, 0},
+ {2, 0, 0, 0},
+ {2, 0, 0, 0},
+ {2, 0, 0, 0},
+ {2, 0, 0, 0},
+ {2, 0, 0, 0},
+ {2, 0, 0, 0},
+ {2, 0, 0, 0},
+ {2, 0, 0, 0},
+ {2, 0, 0, 0},
+ {2, 0, 0, 0},
+ {2, 0, 0, 0},
+ {2, 0, 0, 0},
+ {2, 0, 0, 0},
+ {2, 0, 0, 0},
+ {2, 0, 0, 0},
+ {2, 0, 0, 0},
+ {2, 0, 0, 0}
+};
+
+__attribute__ ((weak))
+led_config_t g_led_config = { {
+ { -1+16, -1+15, -1+14, -1+13, -1+12, -1+11, -1+10, -1+9 , 15+1 , 15+2 , 15+3 , 15+4 , 15+5 , 15+6 },
+ { -1+7 , -1+6 , -1+5 , -1+4 , -1+3 , -1+2 , -1 +1, 15+9 , 15+10, 15+11, 15+12, 15+13, 15+14, 15+15},
+ { -1+8 , 31+14, 31+13, 31+12, 31+11, 31+10, 31+9 , 47+1 , 47+2 , 47+3 , 47+4 , 47+5 , 15+8 , 15+7 },
+ { 31+15, 31+5 , 31+4 , 31+3 , 31+2 , 31+1 , 47+9 , 47+10, 47+11, 47+12, NO_LED ,47+6 , 47+7 , 15+16},
+ { 31+16, 31+8 , 31+7 , NO_LED, NO_LED , 31+6 , NO_LED , NO_LED , NO_LED , 47+13, 47+14, 47+15, 47+16, 47+8 }
+}, {
+ // LA1..LA16
+ {104, 16}, {88 , 16}, {72 , 16}, {56 , 16}, {40 , 16}, {24 , 16}, {4 , 16}, {6 , 32},
+ {112, 0}, {96 , 0}, {80 , 0}, {64 , 0}, {48 , 0}, {32 , 0}, {16 , 0}, {0 , 0},
+
+ // LB1..LB16
+ {128, 0}, {144, 0}, {160, 0}, {176, 0}, {192, 0}, {208, 0}, {224, 0}, {214, 32},
+ {120, 16}, {136, 16}, {152, 16}, {168, 16}, {184, 16}, {200, 16}, {220, 16}, {224, 48},
+
+ // LC1..LC16
+ {100, 48}, {84 , 48}, {68 , 48}, {52 , 48}, {36 , 48}, {102, 64}, {42 , 64}, {22 , 64},
+ {108, 32}, {92 , 32}, {76 , 32}, {60 , 32}, {44 , 32}, {28 , 32}, {10 , 48}, {2 , 64},
+
+ // LD1..LD16
+ {124, 32}, {140, 32}, {156, 32}, {172, 32}, {188, 32}, {180, 48}, {202, 48}, {224, 64},
+ {116, 48}, {132, 48}, {148, 48}, {164, 48}, {160, 64}, {176, 64}, {192, 64}, {208, 64},
+
+ //RGB UNDERGLOW
+ {27 , 3}, {64 , 3}, {100, 3}, {137, 3}, {173, 3}, {209, 3}, {242, 4}, {255, 8}, {255,32}, {255,64},
+ {241,64}, {212,64}, {173,64}, {137,64}, {100,64}, {63 ,64}, {28 ,64}, {0 ,64}, {0 ,32}, {0 , 8} //20
+}, {
+ 4, 4, 4, 4, 4, 4, 1, 1,
+ 4, 4, 4, 4, 4, 4, 4, 1,
+ 4, 4, 4, 4, 4, 4, 1, 1,
+ 4, 4, 4, 4, 4, 4, 1, 1,
+ 4, 4, 4, 4, 4, 4, 1, 1,
+ 4, 4, 4, 4, 4, 4, 1, 1,
+ 4, 4, 4, 4, 4, 1, 1, 1,
+ 4, 4, 4, 4, 1, 1, 1, 4,
+
+ 3, 3, 3, 3, 3, 3, 3, 3, 3, 3,
+ 3, 3, 3, 3, 3, 3, 3, 3, 3, 3
+} };
+
+//Custom Driver
+static void init(void) {
+ i2c_init();
+ IS31FL3731_init(DRIVER_ADDR_1);
+ IS31FL3731_init(DRIVER_ADDR_2);
+ for (int index = 0; index < ISSI_DRIVER_TOTAL; index++) {
+ bool enabled = true;
+ IS31FL3731_set_led_control_register(index, enabled, enabled, enabled);
+ }
+ IS31FL3731_update_led_control_registers(DRIVER_ADDR_1, 0);
+ IS31FL3731_update_led_control_registers(DRIVER_ADDR_2, 1);
+
+ //RGB Underglow ws2812
+
+}
+
+static void flush(void) {
+ IS31FL3731_update_pwm_buffers(DRIVER_ADDR_1, 0);
+ IS31FL3731_update_pwm_buffers(DRIVER_ADDR_2, 1);
+ ws2812_setleds(rgb_matrix_ws2812_array, WS2812_LED_TOTAL);
+}
+
+static void set_color(int index, uint8_t red, uint8_t green, uint8_t blue) {
+ if (index < ISSI_DRIVER_TOTAL) {
+ IS31FL3731_set_color(index, red, green, blue);
+ } else {
+ rgb_matrix_ws2812_array[index - ISSI_DRIVER_TOTAL].r = red;
+ rgb_matrix_ws2812_array[index - ISSI_DRIVER_TOTAL].g = green;
+ rgb_matrix_ws2812_array[index - ISSI_DRIVER_TOTAL].b = blue;
+ }
+}
+
+static void set_color_all(uint8_t red, uint8_t green, uint8_t blue) {
+ IS31FL3731_set_color_all( red, green, blue );
+ for (uint8_t i = 0; i < WS2812_LED_TOTAL; i++) {
+ rgb_matrix_ws2812_array[i].r = red;
+ rgb_matrix_ws2812_array[i].g = green;
+ rgb_matrix_ws2812_array[i].b = blue;
+ }
+}
+
+
+const rgb_matrix_driver_t rgb_matrix_driver = {
+ .init = init,
+ .flush = flush,
+ .set_color = set_color,
+ .set_color_all = set_color_all
+};
+
+#endif
diff --git a/keyboards/xelus/dawn60/rev1_qmk/rev1_qmk.h b/keyboards/xelus/dawn60/rev1_qmk/rev1_qmk.h
new file mode 100644
index 000000000..3625ab1f1
--- /dev/null
+++ b/keyboards/xelus/dawn60/rev1_qmk/rev1_qmk.h
@@ -0,0 +1,34 @@
+/* Copyright 2020 Harrison Chan (Xelus)
+ *
+ * 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 .
+ */
+#pragma once
+
+#include "quantum.h"
+
+#define XXX KC_NO
+
+#define LAYOUT_60_all( \
+ K00, K01, K02, K03, K04, K05, K06, K07, K08, K09, K0A, K0B, K0C, K0D, K2D, \
+ K10, K11, K12, K13, K14, K15, K16, K17, K18, K19, K1A, K1B, K1C, K1D, \
+ K20, K21, K22, K23, K24, K25, K26, K27, K28, K29, K2A, K2B, K2C, \
+ K30, K31, K32, K33, K34, K35, K36, K37, K38, K39, K3B, K3C, K3D, \
+ K40, K41, K42, K45, K49, K4A, K4B, K4C, K4D \
+) { \
+ { K00, K01, K02, K03, K04, K05, K06, K07, K08, K09, K0A, K0B, K0C, K0D }, \
+ { K10, K11, K12, K13, K14, K15, K16, K17, K18, K19, K1A, K1B, K1C, K1D }, \
+ { K20, K21, K22, K23, K24, K25, K26, K27, K28, K29, K2A, K2B, K2C, K2D }, \
+ { K30, K31, K32, K33, K34, K35, K36, K37, K38, K39, XXX, K3B, K3C, K3D }, \
+ { K40, K41, K42, XXX, XXX, K45, XXX, XXX, XXX, K49, K4A, K4B, K4C, K4D } \
+}
diff --git a/keyboards/xelus/dawn60/rev1_qmk/rules.mk b/keyboards/xelus/dawn60/rev1_qmk/rules.mk
new file mode 100644
index 000000000..edfba2730
--- /dev/null
+++ b/keyboards/xelus/dawn60/rev1_qmk/rules.mk
@@ -0,0 +1,50 @@
+# 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 = atmel-dfu
+
+# Do not put the microcontroller into power saving mode
+# when we get USB suspend event. We want it to keep updating
+# backlight effects.
+OPT_DEFS += -DNO_SUSPEND_POWER_DOWN
+
+# Build Options
+# change yes to no to disable
+#
+BOOTMAGIC_ENABLE = lite # Virtual DIP switch configuration
+MOUSEKEY_ENABLE = no # Mouse keys
+EXTRAKEY_ENABLE = yes # Audio control and System control
+CONSOLE_ENABLE = yes # 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 = no # Enable keyboard backlight functionality on B7 by default
+MIDI_ENABLE = no # MIDI support
+UNICODE_ENABLE = no # Unicode
+BLUETOOTH_ENABLE = no # Enable Bluetooth with the Adafruit EZ-Key HID
+AUDIO_ENABLE = no # Audio output on port C6
+FAUXCLICKY_ENABLE = no # Use buzzer to emulate clicky switches
+RGBLIGHT_ENABLE = no # Enable WS2812 RGB underlight. - We have custom RGB underglow
+
+RGB_MATRIX_ENABLE = yes # Enable RGB matrix effects.
+RGB_MATRIX_DRIVER = custom # Enable RGB matrix effects.
+
+COMMON_VPATH += $(DRIVER_PATH)/issi
+
+# project specific files
+SRC += drivers/issi/is31fl3731.c \
+ ws2812.c
+
+QUANTUM_LIB_SRC += i2c_master.c
+
+LTO_ENABLE = yes