[Keyboard] Add Winry315 keyboard (#15894)

1 files changed, 262 insertions, 0 deletions

diff --git a/keyboards/winry/winry315/winry315.c b/keyboards/winry/winry315/winry315.c
new file mode 100644
index 0000000000..c741ffeb74
--- /dev/null
+++ b/keyboards/winry/winry315/winry315.c
@@ -0,0 +1,262 @@
+// Copyright 2022 Sergey Vlasov (@sigprof)
+// SPDX-License-Identifier: GPL-2.0-or-later
+
+#include "winry315.h"
+
+#include "via.h"
+
+#if !defined(WINRY315_DEFAULT_ORIENTATION)
+#    define WINRY315_DEFAULT_ORIENTATION WINRY315_ORIENTATION_TOP
+#endif
+
+#if !defined(VIA_ENABLE) && defined(ENCODER_ENABLE)
+#    ifndef MEDIA_KEY_DELAY
+#        define MEDIA_KEY_DELAY 10
+#    endif
+bool encoder_update_kb(uint8_t index, bool clockwise) {
+    if (!encoder_update_user(index, clockwise)) {
+        return false;
+    }
+    if (index == 0) {
+        // Left encoder (assuming the default "top" orientation)
+        if (clockwise) {
+            tap_code(KC_PGDN);
+        } else {
+            tap_code(KC_PGUP);
+        }
+    } else if (index == 1) {
+        // Center encoder
+        if (clockwise) {
+            tap_code_delay(KC_VOLU, MEDIA_KEY_DELAY);
+        } else {
+            tap_code_delay(KC_VOLD, MEDIA_KEY_DELAY);
+        }
+    } else if (index == 2) {
+        // Right encoder
+        if (clockwise) {
+            tap_code_delay(KC_MNXT, MEDIA_KEY_DELAY);
+        } else {
+            tap_code_delay(KC_MPRV, MEDIA_KEY_DELAY);
+        }
+    }
+    return true;
+}
+#endif // !defined(VIA_ENABLE) && defined(ENCODER_ENABLE)
+
+#if defined(RGB_MATRIX_ENABLE)
+
+// LED mapping (assuming the default "top" orientation):
+//   0 - right encoder, top right
+//   1 - right encoder, top left
+//   2 - center encoder, top right
+//   3 - center encoder, top left
+//   4 - left encoder, top right
+//   5 - left encoder, top left
+//   6 - row 0, column 0
+//   7 - row 1, column 0
+//   8 - row 2, column 0
+//   9 - row 2, column 1
+//  10 - row 1, column 1
+//  11 - row 0, column 1
+//  12 - row 0, column 2
+//  13 - row 1, column 2
+//  14 - row 2, column 2
+//  15 - row 2, column 3
+//  16 - row 1, column 3
+//  17 - row 0, column 3
+//  18 - row 0, column 4
+//  19 - row 1, column 4
+//  20 - row 2, column 4
+//  21 - underglow, right bottom
+//  22 - underglow, left bottom
+//  23 - underglow, left middle
+//  24 - underglow, left top
+//  25 - underglow, right top
+//  26 - underglow, right middle
+
+#    define X_MM_MIN (-42)
+#    define X_MM_MAX 42
+#    define Y_MM_MIN (-40) // actually -35, but adjusted to get height = width
+#    define Y_MM_MAX 44    // actually 40, but adjusted to get height = width
+#    define WIDTH_MM (X_MM_MAX - X_MM_MIN)
+#    define HEIGHT_MM (Y_MM_MAX - Y_MM_MIN)
+#    define WIDTH_UNITS (35 * 2)  // needs to match RGB_MATRIX_CENTER
+#    define HEIGHT_UNITS (35 * 2) // needs to match RGB_MATRIX_CENTER
+
+// Convert the LED physical coordinates from millimeters with the origin at the
+// PCB center to the form expected by the RGB Matrix code.
+#    define LED(x_mm, y_mm) \
+        { ((x_mm - X_MM_MIN) * WIDTH_UNITS + WIDTH_MM / 2) / WIDTH_MM, ((Y_MM_MAX - y_mm) * HEIGHT_UNITS + HEIGHT_MM / 2) / HEIGHT_MM }
+
+// clang-format off
+static const led_config_t PROGMEM initial_led_config = {
+    {
+        { 6, 11, 12, 17, 18, 7, 10, 13, 16, 19, 8, 9, 14, 15, 20, 2, 0, 4, NO_LED, NO_LED, NO_LED, NO_LED, NO_LED, NO_LED }
+    },
+    {
+        LED( 35,  36),
+        LED( 21,  36),
+        LED( 8,   34),
+        LED(-8,   34),
+        LED(-21,  36),
+        LED(-35,  36),
+        LED(-38,   5),
+        LED(-38, -14),
+        LED(-38, -33),
+        LED(-19, -33),
+        LED(-19, -14),
+        LED(-19,   5),
+        LED(  0,   5),
+        LED(  0, -14),
+        LED(  0, -33),
+        LED( 19, -33),
+        LED( 19, -14),
+        LED( 19,   5),
+        LED( 38,   5),
+        LED( 38, -14),
+        LED( 38, -33),
+        LED( 28, -35),
+        LED(-28, -35),
+        LED(-37,  -9),
+        LED(-42,  40),
+        LED( 42,  40),
+        LED( 37,  -9)
+    },
+    {
+        1, 1, 1, 1, 1, 1,                               // encoders (colored as modifiers)
+        4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4,    // regular keys
+        2, 2, 2, 2, 2, 2                                // underglow
+    }
+};
+// clang-format on
+
+led_config_t g_led_config;
+
+void keyboard_pre_init_kb(void) {
+    // To be safe against any possible changes to rgb_matrix_init(),
+    // g_led_config should be initialized before rgb_matrix_init() is called;
+    // matrix_init_kb() would be too late, so keyboard_pre_init_kb() is used.
+    memcpy_P(&g_led_config, &initial_led_config, sizeof(g_led_config));
+    winry315_set_orientation(WINRY315_DEFAULT_ORIENTATION);
+
+    keyboard_pre_init_user();
+}
+
+// Encoders have two associated LEDs on this board; supporting more than one
+// LED per key requires defining rgb_matrix_map_row_column_to_led_kb() to
+// report any extra LEDs.
+uint8_t rgb_matrix_map_row_column_to_led_kb(uint8_t row, uint8_t column, uint8_t *led_i) {
+    if (row == 0) {
+        switch (column) {
+            case 15: // center encoder
+                led_i[0] = 3;
+                return 1;
+
+            case 16: // right encoder
+                led_i[0] = 1;
+                return 1;
+
+            case 17: // left encoder
+                led_i[0] = 5;
+                return 1;
+        }
+    }
+    return 0;
+}
+
+#    if defined(VIA_ENABLE) && defined(VIA_CUSTOM_LIGHTING_ENABLE)
+
+// VIA supports only 4 discrete values for effect speed; map these to some
+// useful speed values for RGB Matrix.
+enum speed_values {
+    RGBLIGHT_SPEED_0 = UINT8_MAX / 16, // not 0 to avoid really slow effects
+    RGBLIGHT_SPEED_1 = UINT8_MAX / 4,
+    RGBLIGHT_SPEED_2 = UINT8_MAX / 2,     // matches the default value
+    RGBLIGHT_SPEED_3 = UINT8_MAX / 4 * 3, // UINT8_MAX is really fast
+};
+
+static uint8_t speed_from_rgblight(uint8_t rgblight_speed) {
+    switch (rgblight_speed) {
+        case 0:
+            return RGBLIGHT_SPEED_0;
+        case 1:
+            return RGBLIGHT_SPEED_1;
+        case 2:
+        default:
+            return RGBLIGHT_SPEED_2;
+        case 3:
+            return RGBLIGHT_SPEED_3;
+    }
+}
+
+static uint8_t speed_to_rgblight(uint8_t rgb_matrix_speed) {
+    if (rgb_matrix_speed < ((RGBLIGHT_SPEED_0 + RGBLIGHT_SPEED_1) / 2)) {
+        return 0;
+    } else if (rgb_matrix_speed < ((RGBLIGHT_SPEED_1 + RGBLIGHT_SPEED_2) / 2)) {
+        return 1;
+    } else if (rgb_matrix_speed < ((RGBLIGHT_SPEED_2 + RGBLIGHT_SPEED_3) / 2)) {
+        return 2;
+    } else {
+        return 3;
+    }
+}
+
+void raw_hid_receive_kb(uint8_t *data, uint8_t length) {
+    switch (data[0]) {
+        case id_lighting_get_value:
+            if (data[1] == id_qmk_rgblight_effect_speed) {
+                data[2] = speed_to_rgblight(rgb_matrix_get_speed());
+            }
+            break;
+        case id_lighting_set_value:
+            if (data[1] == id_qmk_rgblight_effect_speed) {
+                rgb_matrix_set_speed_noeeprom(speed_from_rgblight(data[2]));
+            }
+            break;
+    }
+}
+
+#    endif // defined(VIA_ENABLE) && defined(VIA_CUSTOM_LIGHTING_ENABLE)
+
+#endif // defined(RGB_MATRIX_ENABLE)
+
+void winry315_set_orientation(uint8_t orientation) {
+    (void)orientation;
+#if defined(RGB_MATRIX_ENABLE)
+    for (uint8_t i = 0; i < DRIVER_LED_TOTAL; ++i) {
+        led_point_t *      dst_point = &g_led_config.point[i];
+        const led_point_t *src_point = &initial_led_config.point[i];
+        uint8_t            x         = pgm_read_byte(&src_point->x);
+        uint8_t            y         = pgm_read_byte(&src_point->y);
+
+        switch (orientation) {
+            case WINRY315_ORIENTATION_TOP:
+            default:
+                dst_point->x = x;
+                dst_point->y = y;
+                break;
+
+            case WINRY315_ORIENTATION_LEFT:
+                dst_point->x = y;
+                dst_point->y = WIDTH_UNITS - x;
+                break;
+
+            case WINRY315_ORIENTATION_RIGHT:
+                dst_point->x = HEIGHT_UNITS - y;
+                dst_point->y = x;
+                break;
+
+            case WINRY315_ORIENTATION_BOTTOM:
+                dst_point->x = WIDTH_UNITS - x;
+                dst_point->y = HEIGHT_UNITS - y;
+                break;
+        }
+    }
+#endif // defined(RGB_MATRIX_ENABLE)
+}
+
+#if defined(VIA_ENABLE)
+void via_set_layout_options_kb(uint32_t value) {
+    winry315_set_orientation(value & 0x03);
+}
+#endif // defined(VIA_ENABLE)