[Keyboard] add support for ModelM USB board (#9846)

* add support for ModelM USB board

* EMI improvement: remove unnecessary toggling of MOSI pin

* address review comments

* Update keyboards/mschwingen/modelm/rules.mk

Co-authored-by: James Young <18669334+noroadsleft@users.noreply.github.com>

* Update keyboards/mschwingen/modelm/rules.mk

Co-authored-by: James Young <18669334+noroadsleft@users.noreply.github.com>

* Update keyboards/mschwingen/modelm/config.h

Co-authored-by: James Young <18669334+noroadsleft@users.noreply.github.com>

* Update keyboards/mschwingen/modelm/config.h

Co-authored-by: James Young <18669334+noroadsleft@users.noreply.github.com>

* Update keyboards/mschwingen/modelm/rules.mk

Co-authored-by: Drashna Jaelre <drashna@live.com>

* Update keyboards/mschwingen/modelm/keymaps/default/keymap.c

Co-authored-by: Drashna Jaelre <drashna@live.com>

* update printf usage

* add comment

* EMI improvement: remove unnecessary toggling of MOSI signal

* remove trailing space

* use shorter macros as suggested in review by noroadsleft, re-format table to line up columns

* Update keyboards/mschwingen/modelm/config.h

Co-authored-by: Ryan <fauxpark@gmail.com>

* Update keyboards/mschwingen/modelm/rules.mk

Co-authored-by: Ryan <fauxpark@gmail.com>

* Update keyboards/mschwingen/modelm/rules.mk

Co-authored-by: Ryan <fauxpark@gmail.com>

* Update keyboards/mschwingen/modelm/rules.mk

Co-authored-by: Ryan <fauxpark@gmail.com>

* Update keyboards/mschwingen/modelm/README.md

Co-authored-by: Ryan <fauxpark@gmail.com>

* Update keyboards/mschwingen/modelm/README.md

Co-authored-by: Ryan <fauxpark@gmail.com>

* Apply suggestions from code review

use spi_read from core insteads of our own copy

Co-authored-by: Ryan <fauxpark@gmail.com>

* include spi_master.c to use spi_read()

* Update keyboards/mschwingen/modelm/README.md

Co-authored-by: James Young <18669334+noroadsleft@users.noreply.github.com>

* Apply suggestions from code review: correct indenting in keymap

Co-authored-by: James Young <18669334+noroadsleft@users.noreply.github.com>

* Apply suggestions from code review

use automatic variant defines from makefile instead of defining our own

Co-authored-by: Drashna Jaelre <drashna@live.com>

* Update keyboards/mschwingen/modelm/rules.mk: use QUANTUM_LIB_SRC for uart.c

Co-authored-by: Drashna Jaelre <drashna@live.com>

Co-authored-by: Michael Schwingen <michael@schwingen.org>
Co-authored-by: James Young <18669334+noroadsleft@users.noreply.github.com>
Co-authored-by: Drashna Jaelre <drashna@live.com>
Co-authored-by: Ryan <fauxpark@gmail.com>

1 files changed, 214 insertions, 0 deletions

diff --git a/keyboards/mschwingen/modelm/modelm.c b/keyboards/mschwingen/modelm/modelm.c
new file mode 100644
index 0000000000..5756a95170
--- /dev/null
+++ b/keyboards/mschwingen/modelm/modelm.c
@@ -0,0 +1,214 @@
+/*
+ * Copyright 2020 Michael Schwingen
+
+ * 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 <util/delay.h>
+#include "modelm.h"
+#include "uart.h"
+#include "print.h"
+#include "sendchar.h"
+#include "ws2812.h"
+#include "modelm.h"
+#include "sleep_led.h"
+
+#ifdef UART_DEBUG
+#    undef sendchar
+static int8_t capture_sendchar(uint8_t c) {
+    //  sendchar(c);
+    uart_putchar(c);
+    return 0;
+}
+#endif
+
+static uint16_t blink_cycle_timer;
+static bool     blink_state = false;
+static uint8_t  isRecording = 0;
+
+#ifdef KEYBOARD_mschwingen_modelm_led_ws2812
+#    if RGBLED_NUM < 3
+#        error we need at least 3 RGB LEDs!
+#    endif
+static cRGB led[RGBLED_NUM] = {{255, 255, 255}, {255, 255, 255}, {255, 255, 255}};
+
+#    define BRIGHT 32
+#    define DIM 6
+
+static const cRGB black = {.r = 0, .g = 0, .b = 0};
+
+static const cRGB green  = {.r = 0, .g = BRIGHT, .b = 0};
+static const cRGB lgreen = {.r = 0, .g = DIM, .b = 0};
+
+static const cRGB red  = {.r = BRIGHT, .g = 0, .b = 0};
+static const cRGB lred = {.r = DIM, .g = 0, .b = 0};
+
+static const cRGB blue  = {.r = 0, .g = 0, .b = BRIGHT};
+static const cRGB lblue = {.r = 0, .g = 0, .b = DIM};
+
+static const cRGB turq  = {.r = 0, .g = BRIGHT, .b = BRIGHT};
+static const cRGB lturq = {.r = 0, .g = DIM, .b = DIM};
+
+static const cRGB white = {.r = BRIGHT, .g = BRIGHT, .b = BRIGHT};
+
+static led_t   led_state;
+static uint8_t layer;
+static uint8_t default_layer;
+#endif
+
+// we need our own sleep_led_* implementation to get callbacks on USB
+// suspend/resume in order to completely turn off WS2812 LEDs
+static bool suspend_active = false;
+void sleep_led_init(void) {}
+
+void sleep_led_toggle(void) {}
+
+void sleep_led_disable(void) {
+    suspend_active = false;
+    writePinHigh(QMK_LED);
+}
+
+void sleep_led_enable(void) {
+    suspend_active = true;
+    writePinLow(QMK_LED);
+#ifdef KEYBOARD_mschwingen_modelm_led_ws2812
+    led[0] = black;
+    led[1] = black;
+    led[2] = black;
+    ws2812_setleds(led, RGBLED_NUM);
+#endif
+}
+
+void keyboard_pre_init_kb(void) {
+#ifdef KEYBOARD_mschwingen_modelm_led_ws2812
+    ws2812_setleds(led, RGBLED_NUM);
+#else
+    /* Set status LEDs pins to output and Low (on) */
+    setPinOutput(MODELM_LED_CAPSLOCK);
+    setPinOutput(MODELM_LED_SCROLLOCK);
+    setPinOutput(MODELM_LED_NUMLOCK);
+    writePinLow(MODELM_LED_CAPSLOCK);
+    writePinLow(MODELM_LED_SCROLLOCK);
+    writePinLow(MODELM_LED_NUMLOCK);
+#endif
+    setPinOutput(QMK_LED);
+    writePinHigh(QMK_LED);
+    _delay_ms(50);
+#ifdef UART_DEBUG
+    uart_init(115200);
+    print_set_sendchar(capture_sendchar);
+    uprintf("\r\nHello world!\r\n");
+#endif
+
+    setPinOutput(SR_LOAD_PIN);
+    setPinOutput(SR_CLK_PIN);
+    setPinOutput(SR_DOUT_PIN);  // MOSI - unused
+    writePinLow(SR_CLK_PIN);
+}
+
+#ifdef KEYBOARD_mschwingen_modelm_led_ws2812
+static void led_update_rgb(void) {
+    if (isRecording && blink_state) {
+        led[0] = white;
+    } else {
+        switch (default_layer) {
+            case 0:
+                led[0] = led_state.num_lock ? blue : lblue;
+                break;
+            case 1:
+                led[0] = led_state.num_lock ? green : black;
+                break;
+        }
+    }
+
+    led[1] = led_state.caps_lock ? green : black;
+
+    switch (layer) {
+        case 0:
+        case 1:
+        default:
+            led[2] = led_state.scroll_lock ? green : black;
+            break;
+        case 2:
+            led[2] = led_state.scroll_lock ? red : lred;
+            break;
+        case 3:
+            led[2] = led_state.scroll_lock ? turq : lturq;
+            break;
+    }
+    if (!suspend_active) {
+	ws2812_setleds(led, RGBLED_NUM);
+    }
+}
+
+bool led_update_kb(led_t state) {
+    dprintf("LED Update: %d %d %d", led_state.num_lock, led_state.caps_lock, led_state.scroll_lock);
+    led_state = state;
+    led_update_rgb();
+
+    return true;
+}
+
+void update_layer_leds(void) {
+    static uint8_t old_layer         = 255;
+    static uint8_t old_default_layer = 255;
+
+    layer         = biton32(layer_state);
+    default_layer = biton32(default_layer_state);
+
+    if (isRecording && timer_elapsed(blink_cycle_timer) > 150) {
+        blink_state       = !blink_state;
+        blink_cycle_timer = timer_read();
+        old_layer         = 255;  // fallthrough next check
+    }
+
+    if (layer == old_layer && default_layer == old_default_layer) {
+	return;
+    }
+    old_layer         = layer;
+    old_default_layer = default_layer;
+    dprintf("Layer change: %d %d", default_layer, layer);
+    led_update_rgb();
+}
+
+/*****************************************************************************/
+#else  // classic LEDs on GPIO
+bool led_update_kb(led_t led_state) {
+    dprintf("LED Update: %d %d %d", led_state.num_lock, led_state.caps_lock, led_state.scroll_lock);
+
+    if (led_update_user(led_state)) {
+        if (!isRecording) writePin(MODELM_LED_NUMLOCK, !led_state.num_lock);
+        writePin(MODELM_LED_CAPSLOCK, !led_state.caps_lock);
+        writePin(MODELM_LED_SCROLLOCK, !led_state.scroll_lock);
+    }
+    return true;
+}
+
+void update_layer_leds(void) {
+    if (isRecording && timer_elapsed(blink_cycle_timer) > 150) {
+        blink_state = !blink_state;
+        blink_cycle_timer = timer_read();
+        writePin(MODELM_LED_NUMLOCK, blink_state);
+    }
+}
+
+#endif
+
+void dynamic_macro_record_start_user(void) {
+    isRecording++;
+    blink_cycle_timer = timer_read();
+}
+
+void dynamic_macro_record_end_user(int8_t direction) {
+    if (isRecording) isRecording--;
+}