EC 23U PCB (#20049)

* Add EC 23U PCB firmware

* Moved from data driven row/col def to config def

* Implemented proper LAYOUT_ changes

* Removed unnecessary `.h` includes

* Updated default thresholds

* Added `DISCHARGE_TIME`

Addition of a `DISCHARGE_TIME` time. This is to ensure that the ghost capacitor  that is the row strobed for the ADC read, is fully drained and doesn't carry charges that deviates the readings.

Tested on multiple hardware and confirmed working and improving the readings, both in terms of stability and consistency for baseline noise.

* Update readme.md

Added missing `cipulot/` in example commands.

* Removal of `info.json` lines as suggested

* Update to comply with `_kb` and `_user` separation

* Update rules.mk

keyboards/cipulot/ec_23u/config.h

@@ -0,0 +1,47 @@
+/* Copyright 2023 Cipulot
+ *
+ * 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
+
+#define MATRIX_ROWS 4
+#define MATRIX_COLS 6
+
+/* Custom matrix pins and port select array */
+#define MATRIX_ROW_PINS \
+    { B13, B12, A7, B0 }
+#define MATRIX_COL_CHANNELS \
+    { 4, 6, 3, 2, 0, 1 }
+#define MUX_SEL_PINS \
+    { C14, C13, B6 }
+
+/* Hardware peripherals pins */
+#define APLEX_EN_PIN C15
+#define DISCHARGE_PIN A3
+#define ANALOG_PORT A2
+
+/* Debounce reduces chatter (unintended double-presses) - set 0 if debouncing is not 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
+
+#define DEFAULT_ACTUATION_LEVEL 550
+#define DEFAULT_RELEASE_LEVEL 500
+
+#define DISCHARGE_TIME 10

keyboards/cipulot/ec_23u/ec_switch_matrix.c

@@ -0,0 +1,165 @@
+/* Copyright 2023 Cipulot
+ *
+ * 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 "ec_switch_matrix.h"
+#include "analog.h"
+#include "atomic_util.h"
+#include "print.h"
+#include "wait.h"
+
+/* Pin and port array */
+const uint32_t row_pins[]     = MATRIX_ROW_PINS;
+const uint8_t  col_channels[] = MATRIX_COL_CHANNELS;
+const uint32_t mux_sel_pins[] = MUX_SEL_PINS;
+
+static ecsm_config_t config;
+static uint16_t      ecsm_sw_value[MATRIX_ROWS][MATRIX_COLS];
+
+static adc_mux adcMux;
+
+static inline void discharge_capacitor(void) {
+    writePinLow(DISCHARGE_PIN);
+}
+static inline void charge_capacitor(uint8_t row) {
+    writePinHigh(DISCHARGE_PIN);
+    writePinHigh(row_pins[row]);
+}
+
+static inline void init_mux_sel(void) {
+    for (int idx = 0; idx < 3; idx++) {
+        setPinOutput(mux_sel_pins[idx]);
+    }
+}
+
+static inline void select_mux(uint8_t col) {
+    uint8_t ch = col_channels[col];
+    writePin(mux_sel_pins[0], ch & 1);
+    writePin(mux_sel_pins[1], ch & 2);
+    writePin(mux_sel_pins[2], ch & 4);
+}
+
+static inline void init_row(void) {
+    for (int idx = 0; idx < MATRIX_ROWS; idx++) {
+        setPinOutput(row_pins[idx]);
+        writePinLow(row_pins[idx]);
+    }
+}
+
+/* Initialize the peripherals pins */
+int ecsm_init(ecsm_config_t const* const ecsm_config) {
+    // Initialize config
+    config = *ecsm_config;
+
+    palSetLineMode(ANALOG_PORT, PAL_MODE_INPUT_ANALOG);
+    adcMux = pinToMux(ANALOG_PORT);
+
+    //Dummy call to make sure that adcStart() has been called in the appropriate state
+    adc_read(adcMux);
+
+    // Initialize discharge pin as discharge mode
+    writePinLow(DISCHARGE_PIN);
+    setPinOutputOpenDrain(DISCHARGE_PIN);
+
+    // Initialize drive lines
+    init_row();
+
+    // Initialize multiplexer select pin
+    init_mux_sel();
+
+    // Enable AMUX
+    setPinOutput(APLEX_EN_PIN);
+    writePinLow(APLEX_EN_PIN);
+
+    return 0;
+}
+
+int ecsm_update(ecsm_config_t const* const ecsm_config) {
+    // Save config
+    config = *ecsm_config;
+    return 0;
+}
+
+// Read the capacitive sensor value
+uint16_t ecsm_readkey_raw(uint8_t channel, uint8_t row, uint8_t col) {
+    uint16_t sw_value = 0;
+
+    // Select the multiplexer
+    writePinHigh(APLEX_EN_PIN);
+    select_mux(col);
+    writePinLow(APLEX_EN_PIN);
+
+    // Set strobe pins to low state
+    writePinLow(row_pins[row]);
+    ATOMIC_BLOCK_FORCEON {
+        // Set the row pin to high state and have capacitor charge
+        charge_capacitor(row);
+        // Read the ADC value
+        sw_value = adc_read(adcMux);
+    }
+    // Discharge peak hold capacitor
+    discharge_capacitor();
+    // Waiting for the ghost capacitor to discharge fully
+    wait_us(DISCHARGE_TIME);
+
+    return sw_value;
+}
+
+// Update press/release state of key
+bool ecsm_update_key(matrix_row_t* current_row, uint8_t row, uint8_t col, uint16_t sw_value) {
+    bool current_state = (*current_row >> col) & 1;
+
+    // Press to release
+    if (current_state && sw_value < config.ecsm_actuation_threshold) {
+        *current_row &= ~(1 << col);
+        return true;
+    }
+
+    // Release to press
+    if ((!current_state) && sw_value > config.ecsm_release_threshold) {
+        *current_row |= (1 << col);
+        return true;
+    }
+
+    return false;
+}
+
+// Scan key values and update matrix state
+bool ecsm_matrix_scan(matrix_row_t current_matrix[]) {
+    bool updated = false;
+
+    for (int col = 0; col < sizeof(col_channels); col++) {
+        for (int row = 0; row < MATRIX_ROWS; row++) {
+            ecsm_sw_value[row][col] = ecsm_readkey_raw(0, row, col);
+            updated |= ecsm_update_key(&current_matrix[row], row, col, ecsm_sw_value[row][col]);
+        }
+    }
+
+    return updated;
+}
+
+// Debug print key values
+void ecsm_print_matrix(void) {
+    for (int row = 0; row < MATRIX_ROWS; row++) {
+        for (int col = 0; col < MATRIX_COLS; col++) {
+            uprintf("%4d", ecsm_sw_value[row][col]);
+            if (col < (MATRIX_COLS - 1)) {
+                print(",");
+            }
+        }
+        print("\n");
+    }
+    print("\n");
+}

keyboards/cipulot/ec_23u/ec_switch_matrix.h

@@ -0,0 +1,36 @@
+/* Copyright 2023 Cipulot
+ *
+ * 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 <stdint.h>
+#include <stdbool.h>
+
+#include "matrix.h"
+
+typedef struct {
+    uint16_t ecsm_actuation_threshold; // threshold for key release
+    uint16_t ecsm_release_threshold;   // threshold for key press
+} ecsm_config_t;
+
+ecsm_config_t ecsm_config;
+
+int      ecsm_init(ecsm_config_t const* const ecsm_config);
+int      ecsm_update(ecsm_config_t const* const ecsm_config);
+bool     ecsm_matrix_scan(matrix_row_t current_matrix[]);
+uint16_t ecsm_readkey_raw(uint8_t channel, uint8_t row, uint8_t col);
+bool     ecsm_update_key(matrix_row_t* current_row, uint8_t row, uint8_t col, uint16_t sw_value);
+void     ecsm_print_matrix(void);

keyboards/cipulot/ec_23u/halconf.h

@@ -0,0 +1,21 @@
+/* Copyright 2023 Cipulot
+ *
+ * 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
+
+#define HAL_USE_ADC TRUE
+
+#include_next <halconf.h>

keyboards/cipulot/ec_23u/info.json

@@ -0,0 +1,108 @@
+{
+    "manufacturer": "Cipulot",
+    "keyboard_name": "EC 23U",
+    "maintainer": "Cipulot",
+    "bootloader": "stm32-dfu",
+    "build": {
+        "lto": true
+    },
+    "diode_direction": "COL2ROW",
+    "features": {
+        "audio": false,
+        "backlight": false,
+        "bootmagic": true,
+        "command": false,
+        "console": true,
+        "extrakey": true,
+        "mousekey": true,
+        "nkro": true,
+        "rgblight": true
+    },
+    "mouse_key": {
+        "enabled": true
+    },
+    "indicators": {
+        "num_lock": "B14"
+    },
+    "processor": "STM32F401",
+    "rgblight": {
+        "led_count": 21,
+        "pin": "B5",
+        "animations": {
+            "alternating": true,
+            "breathing": true,
+            "christmas": true,
+            "knight": true,
+            "rainbow_mood": true,
+            "rainbow_swirl": true,
+            "rgb_test": true,
+            "snake": true,
+            "static_gradient": true,
+            "twinkle": true
+        }
+    },
+    "url": "https://www.github.com/Cipulot/EC23U",
+    "usb": {
+        "device_version": "0.0.1",
+        "pid": "0x6B95",
+        "shared_endpoint": {
+            "keyboard": true
+        },
+        "vid": "0x6369"
+    },
+    "layouts": {
+        "LAYOUT_all": {
+            "layout": [
+                { "label": "0,0", "matrix": [0, 0], "x": 0.0, "y": 0.0 },
+                { "label": "0,1", "matrix": [0, 1], "x": 1.0, "y": 0.0 },
+                { "label": "0,2", "matrix": [0, 2], "x": 2.0, "y": 0.0 },
+                { "label": "0,3", "matrix": [0, 3], "x": 3.0, "y": 0.0 },
+                { "label": "1,0", "matrix": [1, 0], "x": 0.0, "y": 1.5 },
+                { "label": "1,1", "matrix": [1, 1], "x": 1.0, "y": 1.5 },
+                { "label": "1,2", "matrix": [1, 2], "x": 2.0, "y": 1.5 },
+                { "label": "1,3", "matrix": [1, 3], "x": 3.0, "y": 1.5 },
+                { "label": "2,0", "matrix": [2, 0], "x": 0.0, "y": 2.5 },
+                { "label": "2,1", "matrix": [2, 1], "x": 1.0, "y": 2.5 },
+                { "label": "2,2", "matrix": [2, 2], "x": 2.0, "y": 2.5 },
+                { "label": "2,3", "matrix": [2, 3], "x": 3.0, "y": 2.5 },
+                { "label": "3,0", "matrix": [3, 0], "x": 0.0, "y": 3.5 },
+                { "label": "3,1", "matrix": [3, 1], "x": 1.0, "y": 3.5 },
+                { "label": "3,2", "matrix": [3, 2], "x": 2.0, "y": 3.5 },
+                { "label": "3,3", "matrix": [3, 3], "x": 3.0, "y": 3.5 },
+                { "label": "2,4", "matrix": [2, 4], "x": 0.0, "y": 4.5 },
+                { "label": "0,4", "matrix": [0, 4], "x": 1.0, "y": 4.5 },
+                { "label": "1,4", "matrix": [1, 4], "x": 2.0, "y": 4.5 },
+                { "label": "3,4", "matrix": [3, 4], "x": 3.0, "y": 4.5 },
+                { "label": "2,5", "matrix": [2, 5], "x": 0.0, "y": 5.5 },
+                { "label": "0,5", "matrix": [0, 5], "x": 1.0, "y": 5.5 },
+                { "label": "1,5", "matrix": [1, 5], "x": 2.0, "y": 5.5 },
+                { "label": "3,5", "matrix": [3, 5], "x": 3.0, "y": 5.5 }
+            ]
+        },
+        "LAYOUT_numpad_6x4": {
+            "layout": [
+                { "label": "0,0", "matrix": [0, 0], "x": 0.0, "y": 0.0 },
+                { "label": "0,1", "matrix": [0, 1], "x": 1.0, "y": 0.0 },
+                { "label": "0,2", "matrix": [0, 2], "x": 2.0, "y": 0.0 },
+                { "label": "0,3", "matrix": [0, 3], "x": 3.0, "y": 0.0 },
+                { "label": "1,0", "matrix": [1, 0], "x": 0.0, "y": 1.5 },
+                { "label": "1,1", "matrix": [1, 1], "x": 1.0, "y": 1.5 },
+                { "label": "1,2", "matrix": [1, 2], "x": 2.0, "y": 1.5 },
+                { "label": "1,3", "matrix": [1, 3], "x": 3.0, "y": 1.5 },
+                { "label": "2,0", "matrix": [2, 0], "x": 0.0, "y": 2.5 },
+                { "label": "2,1", "matrix": [2, 1], "x": 1.0, "y": 2.5 },
+                { "label": "2,2", "matrix": [2, 2], "x": 2.0, "y": 2.5 },
+                { "h": 2, "label": "3,3", "matrix": [3, 3], "x": 3.0, "y": 2.5 },
+                { "label": "3,0", "matrix": [3, 0], "x": 0.0, "y": 3.5 },
+                { "label": "3,1", "matrix": [3, 1], "x": 1.0, "y": 3.5 },
+                { "label": "3,2", "matrix": [3, 2], "x": 2.0, "y": 3.5 },
+                { "label": "2,4", "matrix": [2, 4], "x": 0.0, "y": 4.5 },
+                { "label": "0,4", "matrix": [0, 4], "x": 1.0, "y": 4.5 },
+                { "label": "1,4", "matrix": [1, 4], "x": 2.0, "y": 4.5 },
+                { "h": 2, "label": "3,4", "matrix": [3, 4], "x": 3.0, "y": 4.5 },
+                { "label": "2,5", "matrix": [2, 5], "w": 2, "x": 0.0, "y": 5.5 },
+                { "label": "1,5", "matrix": [1, 5], "x": 2.0, "y": 5.5 }
+            ]
+        }
+    }
+}