Merge upstream

.github/workflows/auto-build.yml

@@ -24,8 +24,21 @@ jobs:
       run: pip3 install -r requirements.txt
     - name: Build keyboards
       run: python3 bin/build_all.py
+    - name: Declare some variables
+      id: vars
+      shell: bash
+      run: |
+          echo "##[set-output name=branch;]$(echo ${GITHUB_REF_NAME//\//-})"
+          echo "::set-output name=sha_short::$(git rev-parse --short HEAD)"
 
     - uses: actions/upload-artifact@v2
+      if: ${{ always() }}
+      with:
+        name: Pre-Compiled Firmware (${{ steps.vars.outputs.branch }}-${{ steps.vars.outputs.sha_short }})
+        path: '*.bin'
+
+    - uses: actions/upload-artifact@v2
+      if: ${{ always() }}
       with:
         name: Pre-Compiled Firmware
         path: '*.bin'

bin/build_all.py

@@ -1,7 +1,72 @@
 import subprocess
 import os
+import sys
 
-BOARDS = ['redragon/k552/rev1', 'redragon/k552/rev2', 'redragon/k556', 'keychron/k4', 'keychron/k6', 'ajazz/ak33/rev1', 'ajazz/ak33/rev2']
+BOARDS = [
+    'redragon/k552/rev1',
+    'redragon/k552/rev2',
+    'redragon/k530',
+    'redragon/k556',
+    'redragon/k580',
+    'redragon/k630',
+    'keychron/c1/plain',
+    'keychron/c1/rgb',
+    'keychron/c1/white',
+    'keychron/c2/white',
+    'keychron/k2/rgb',
+    'keychron/k2/rgb/via',
+    'keychron/k2/rgb/optical',
+    'keychron/k2/rgb/optical_via',
+    'keychron/k3/rgb',
+    'keychron/k3/rgb/via',
+    'keychron/k3/rgb/optical',
+    'keychron/k3/rgb/optical_via',
+    'keychron/k4/rgb/v1',
+    'keychron/k4/rgb/v1/via',
+    'keychron/k4/rgb/v1/optical',
+    'keychron/k4/rgb/v1/optical_via',
+    'keychron/k4/rgb/v2',
+    'keychron/k4/rgb/v2/via',
+    'keychron/k4/rgb/v2/optical',
+    'keychron/k4/rgb/v2/optical_via',
+    'keychron/k6/rgb',
+    'keychron/k6/rgb/via',
+    'keychron/k6/rgb/optical',
+    'keychron/k6/rgb/optical_via',
+    'keychron/k6/white',
+    'keychron/k7/rgb',
+    'keychron/k7/rgb/via',
+    'keychron/k7/rgb/optical',
+    'keychron/k7/rgb/optical_via',
+    'keychron/k8/rgb',
+    'keychron/k8/rgb/via',
+    'keychron/k8/rgb/optical',
+    'keychron/k8/rgb/optical_via',
+    'keychron/k14/rgb',
+    'keychron/k14/rgb/via',
+    'keychron/k14/rgb/optical',
+    'keychron/k14/rgb/optical_via',
+    'ajazz/ak33/rev1',
+    'ajazz/ak33/rev2',
+    'smartduck/xs61',
+    'spcgear/gk530',
+    'spcgear/gk540',
+    'sharkoon/sgk3',
+    'womier/k87',
+    'flashquark/horizon_z',
+    'ffc/ffc61',
+    'gmmk/full/rev2',
+    'gmmk/full/rev3',
+    'gmmk/tkl/rev2',
+    'gmmk/tkl/rev3',
+    'gmmk/compact/rev2',
+    'gmmk/compact/rev3',    
+    'marvo/kg938',
+    'akko/3061_rgb']
 
+error = False
 for kb in BOARDS:
-    subprocess.run(f"bin/qmk compile -kb {kb} -km all -j{os.cpu_count()}", shell=True)
+    if subprocess.run(f"qmk compile -kb {kb} -km all -j{os.cpu_count()}", shell=True).returncode != 0:
+        error = True
+if error:
+    sys.exit(1)

common_features.mk

@@ -135,11 +135,14 @@ else
         SRC += $(PLATFORM_COMMON_DIR)/flash_stm32.c
         OPT_DEFS += -DEEPROM_EMU_STM32F072xB
         OPT_DEFS += -DSTM32_EEPROM_ENABLE
-#      else ifeq ($(MCU_SERIES)_$(MCU_LDSCRIPT), SN32F240_SN32F240B)
-#        SRC += $(PLATFORM_COMMON_DIR)/eeprom_sn32.c
-#        SRC += $(PLATFORM_COMMON_DIR)/flash_sn32.c
-#        OPT_DEFS += -DEEPROM_EMU_SN32F240B
-#        OPT_DEFS += -DSN32_EEPROM_ENABLE
+      else ifeq ($(MCU_SERIES)_$(MCU_LDSCRIPT), SN32F240B_SN32F240B)
+        SRC += $(PLATFORM_COMMON_DIR)/eeprom_sn32.c
+        OPT_DEFS += -DEEPROM_EMU_SN32F240B
+        OPT_DEFS += -DSN32_EEPROM_ENABLE
+      else ifeq ($(MCU_SERIES)_$(MCU_LDSCRIPT), SN32F260_SN32F260)
+        SRC += $(PLATFORM_COMMON_DIR)/eeprom_sn32.c
+        OPT_DEFS += -DEEPROM_EMU_SN32F260
+        OPT_DEFS += -DSN32_EEPROM_ENABLE        
       else ifeq ($(MCU_SERIES)_$(MCU_LDSCRIPT), STM32F0xx_STM32F042x6)
 
         # Stack sizes: Since this chip has limited RAM capacity, the stack area needs to be reduced.
@@ -205,7 +208,7 @@ ifeq ($(strip $(LED_MATRIX_ENABLE)), yes)
 endif
 
 RGB_MATRIX_ENABLE ?= no
-VALID_RGB_MATRIX_TYPES := IS31FL3731 IS31FL3733 IS31FL3737 IS31FL3741 WS2812 custom
+VALID_RGB_MATRIX_TYPES := IS31FL3731 IS31FL3733 IS31FL3737 IS31FL3741 WS2812 SN32F248B SN32F26x custom
 
 ifeq ($(strip $(RGB_MATRIX_ENABLE)), yes)
     ifeq ($(filter $(RGB_MATRIX_DRIVER),$(VALID_RGB_MATRIX_TYPES)),)
@@ -218,7 +221,9 @@ ifneq (,$(filter $(MCU), atmega16u2 atmega32u2))
 endif
     SRC += $(QUANTUM_DIR)/color.c
     SRC += $(QUANTUM_DIR)/rgb_matrix.c
-    SRC += $(QUANTUM_DIR)/rgb_matrix_drivers.c
+    ifneq ($(strip $(RGB_MATRIX_DRIVER)), SN32F248B)
+        SRC += $(QUANTUM_DIR)/rgb_matrix_drivers.c
+    endif
     CIE1931_CURVE := yes
     RGB_KEYCODES_ENABLE := yes
 
@@ -255,6 +260,16 @@ endif
         WS2812_DRIVER_REQUIRED := yes
     endif
 
+    ifeq ($(strip $(RGB_MATRIX_DRIVER)), SN32F248B)
+        COMMON_VPATH += $(DRIVER_PATH)/sn32
+        SRC += rgb_matrix_sn32f248b.c
+    endif    
+
+    ifeq ($(strip $(RGB_MATRIX_DRIVER)), SN32F26x)
+        COMMON_VPATH += $(DRIVER_PATH)/sn32
+        SRC += matrix_sn32f26x.c
+    endif
+
     ifeq ($(strip $(RGB_MATRIX_CUSTOM_KB)), yes)
         OPT_DEFS += -DRGB_MATRIX_CUSTOM_KB
     endif

drivers/sn32/matrix_sn32f24xx.c

@@ -0,0 +1,196 @@
+/*
+Copyright 2021 Dimitris Mantzouranis <[email protected]>
+Copyright 2021 Adam Honse <[email protected]>
+Copyright 2011 Jun Wako <[email protected]>
+
+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/>.
+
+Ported to QMK by Stephen Peery <https://github.com/smp4488/>
+*/
+
+#include <stdint.h>
+#include <stdbool.h>
+#include "ch.h"
+#include "hal.h"
+
+#include "wait.h"
+#include "util.h"
+#include "matrix.h"
+#include "debounce.h"
+#include "quantum.h"
+#include "rgb_matrix_sn32f24xx.h"
+
+#if defined(OPTICAL_MATRIX)
+#ifndef PRESSED_KEY_PIN_STATE
+#    define PRESSED_KEY_PIN_STATE 1
+#endif
+#ifndef MATRIX_KEY_SAMPLE_DELAY
+#    define MATRIX_KEY_SAMPLE_DELAY 2000
+#endif
+#endif
+
+#ifndef PRESSED_KEY_PIN_STATE
+#    define PRESSED_KEY_PIN_STATE 0
+#endif
+
+#ifndef MATRIX_KEY_SAMPLE_DELAY
+#    define MATRIX_KEY_SAMPLE_DELAY 100
+#endif
+
+#if defined(MATRIX_KEY_SAMPLE_DELAY)
+void sample_delay(void){
+    //should give 2000/48000000Mhz = 42us delay
+    //we want 42 micro thus to get value
+    for (int i = 0; i < MATRIX_KEY_SAMPLE_DELAY; ++i) {
+        __asm__ volatile("" ::: "memory");
+    }
+    //wait_us(73); //does not work
+}
+#endif
+
+static const pin_t row_pins[MATRIX_ROWS] = MATRIX_ROW_PINS;
+static const pin_t col_pins[MATRIX_COLS] = MATRIX_COL_PINS;
+matrix_row_t raw_matrix[MATRIX_ROWS]; //raw values
+matrix_row_t last_matrix[MATRIX_ROWS] = {0};  // raw values
+matrix_row_t matrix[MATRIX_ROWS]; //debounced values
+
+static bool matrix_changed = false;
+
+__attribute__((weak)) void matrix_init_kb(void) { matrix_init_user(); }
+
+__attribute__((weak)) void matrix_scan_kb(void) { matrix_scan_user(); }
+
+__attribute__((weak)) void matrix_init_user(void) {}
+
+__attribute__((weak)) void matrix_scan_user(void) {}
+
+inline matrix_row_t matrix_get_row(uint8_t row) { return matrix[row]; }
+
+void matrix_print(void) {}
+
+static void init_pins(void) {
+#if(DIODE_DIRECTION == ROW2COL)
+    //  Unselect ROWs
+    for (uint8_t x = 0; x < MATRIX_ROWS; x++) {
+        setPinInputHigh(row_pins[x]);
+    }
+#elif(DIODE_DIRECTION == COL2ROW)
+    // Unselect COLs
+    for (uint8_t x = 0; x < MATRIX_COLS; x++) {
+        setPinInputHigh(col_pins[x]);
+    }
+#else
+#error DIODE_DIRECTION must be one of COL2ROW or ROW2COL!
+#endif
+}
+
+void matrix_scan_select(uint8_t current){ 
+#if(DIODE_DIRECTION == ROW2COL)
+    // Select COL
+    setPinOutput(col_pins[current]);
+    writePinLow(col_pins[current]);
+#elif(DIODE_DIRECTION == COL2ROW)
+    // Select ROW
+    setPinOutput(row_pins[current]);
+    writePinLow(row_pins[current]);
+#endif
+}
+
+void matrix_scan_unselect(uint8_t current) {
+#if(DIODE_DIRECTION == ROW2COL)
+    // Select COL
+    setPinInputHigh(col_pins[current]);
+#elif(DIODE_DIRECTION == COL2ROW)
+    // Select ROW
+    setPinInputHigh(row_pins[current]);
+#endif
+}
+
+void matrix_init(void) {
+    // initialize key pins
+    init_pins();
+
+    // initialize matrix state: all keys off
+    for (uint8_t i = 0; i < MATRIX_ROWS; i++) {
+        raw_matrix[i] = 0;
+        matrix[i]     = 0;
+    }
+
+    debounce_init(MATRIX_ROWS);
+
+    matrix_init_quantum();
+}
+
+uint8_t matrix_scan(void) {
+    matrix_changed = false;
+    for (uint8_t current_col = 0; current_col < MATRIX_COLS; current_col++) {
+        for (uint8_t row_index = 0; row_index < MATRIX_ROWS; row_index++) {
+            // Determine if the matrix changed state
+            if ((last_matrix[row_index] != raw_matrix[row_index])) {
+                matrix_changed         = true;
+                last_matrix[row_index] = raw_matrix[row_index];
+            }
+        }
+    }
+
+    debounce(raw_matrix, matrix, MATRIX_ROWS, matrix_changed);
+
+    matrix_scan_quantum();
+
+    return matrix_changed;
+}
+
+void matrix_scan_keys(matrix_row_t raw_matrix[], uint8_t current){
+        #if(DIODE_DIRECTION == ROW2COL)
+            // Read the key matrix rows on col
+            uint8_t col_index = current;
+            // Enable the column
+            matrix_scan_select(col_index);
+            sample_delay();
+            for (uint8_t row_index = 0; row_index < MATRIX_ROWS; row_index++) {
+                // Check row pin state
+                if (readPin(row_pins[row_index]) == PRESSED_KEY_PIN_STATE) {
+                    // Pin LO, set col bit
+                    raw_matrix[row_index] |= (MATRIX_ROW_SHIFTER << col_index);
+                } else {
+                    // Pin HI, clear col bit
+                    raw_matrix[row_index] &= ~(MATRIX_ROW_SHIFTER << col_index);
+                }
+            }
+            // Disable the column
+            matrix_scan_unselect(col_index);
+            //see https://github.com/SonixQMK/qmk_firmware/issues/157
+            sample_delay();
+        #elif(DIODE_DIRECTION == COL2ROW)
+            // Read the key matrix cols on row
+            uint8_t row_index = current;
+            // Enable the row
+            matrix_scan_select(row_index);
+            sample_delay();
+            for (uint8_t col_index = 0; col_index < MATRIX_COLS; col_index++) {
+                // Check row pin state
+                if (readPin(col_pins[col_index]) == PRESSED_KEY_PIN_STATE) {
+                    // Pin LO, set col bit
+                    raw_matrix[row_index] |= (MATRIX_ROW_SHIFTER << col_index);
+                } else {
+                    // Pin HI, clear col bit
+                    raw_matrix[row_index] &= ~(MATRIX_ROW_SHIFTER << col_index);
+                }
+            }
+            // Disable the row
+            matrix_scan_unselect(row_index);
+            //see https://github.com/SonixQMK/qmk_firmware/issues/157
+            sample_delay();
+        #endif
+}