Co-authored-by: Drashna Jaelre <drashna@live.com> Co-authored-by: Joel Challis <git@zvecr.com>pull/23155/head
@ -0,0 +1,64 @@ | |||
/* 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 3 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 "quantum.h" | |||
void eeconfig_init_kb(void) { | |||
// Default values | |||
eeprom_ec_config.actuation_mode = DEFAULT_ACTUATION_MODE; | |||
eeprom_ec_config.mode_0_actuation_threshold = DEFAULT_MODE_0_ACTUATION_LEVEL; | |||
eeprom_ec_config.mode_0_release_threshold = DEFAULT_MODE_0_RELEASE_LEVEL; | |||
eeprom_ec_config.mode_1_initial_deadzone_offset = DEFAULT_MODE_1_INITIAL_DEADZONE_OFFSET; | |||
eeprom_ec_config.mode_1_actuation_offset = DEFAULT_MODE_1_ACTUATION_OFFSET; | |||
eeprom_ec_config.mode_1_release_offset = DEFAULT_MODE_1_RELEASE_OFFSET; | |||
for (uint8_t row = 0; row < MATRIX_ROWS; row++) { | |||
for (uint8_t col = 0; col < MATRIX_COLS; col++) { | |||
eeprom_ec_config.bottoming_reading[row][col] = DEFAULT_BOTTOMING_READING; | |||
} | |||
} | |||
// Write default value to EEPROM now | |||
eeconfig_update_kb_datablock(&eeprom_ec_config); | |||
eeconfig_init_user(); | |||
} | |||
// On Keyboard startup | |||
void keyboard_post_init_kb(void) { | |||
// Read custom menu variables from memory | |||
eeconfig_read_kb_datablock(&eeprom_ec_config); | |||
// Set runtime values to EEPROM values | |||
ec_config.actuation_mode = eeprom_ec_config.actuation_mode; | |||
ec_config.mode_0_actuation_threshold = eeprom_ec_config.mode_0_actuation_threshold; | |||
ec_config.mode_0_release_threshold = eeprom_ec_config.mode_0_release_threshold; | |||
ec_config.mode_1_initial_deadzone_offset = eeprom_ec_config.mode_1_initial_deadzone_offset; | |||
ec_config.mode_1_actuation_offset = eeprom_ec_config.mode_1_actuation_offset; | |||
ec_config.mode_1_release_offset = eeprom_ec_config.mode_1_release_offset; | |||
ec_config.bottoming_calibration = false; | |||
for (uint8_t row = 0; row < MATRIX_ROWS; row++) { | |||
for (uint8_t col = 0; col < MATRIX_COLS; col++) { | |||
ec_config.bottoming_calibration_starter[row][col] = true; | |||
ec_config.bottoming_reading[row][col] = eeprom_ec_config.bottoming_reading[row][col]; | |||
ec_config.rescaled_mode_0_actuation_threshold[row][col] = rescale(ec_config.mode_0_actuation_threshold, 0, 1023, ec_config.noise_floor[row][col], eeprom_ec_config.bottoming_reading[row][col]); | |||
ec_config.rescaled_mode_0_release_threshold[row][col] = rescale(ec_config.mode_0_release_threshold, 0, 1023, ec_config.noise_floor[row][col], eeprom_ec_config.bottoming_reading[row][col]); | |||
ec_config.rescaled_mode_1_initial_deadzone_offset[row][col] = rescale(ec_config.mode_1_initial_deadzone_offset, 0, 1023, ec_config.noise_floor[row][col], eeprom_ec_config.bottoming_reading[row][col]); | |||
} | |||
} | |||
keyboard_post_init_user(); | |||
} |
@ -0,0 +1,312 @@ | |||
/* 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 3 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 "math.h" | |||
#include "print.h" | |||
#include "wait.h" | |||
#if defined(__AVR__) | |||
# error "AVR platforms not supported due to a variety of reasons. Among them there are limited memory, limited number of pins and ADC not being able to give satisfactory results." | |||
#endif | |||
#define OPEN_DRAIN_SUPPORT defined(PAL_MODE_OUTPUT_OPENDRAIN) | |||
eeprom_ec_config_t eeprom_ec_config; | |||
ec_config_t ec_config; | |||
// Pin and port array | |||
const pin_t row_pins[] = MATRIX_ROW_PINS; | |||
const pin_t amux_sel_pins[] = AMUX_SEL_PINS; | |||
const pin_t amux_en_pins[] = AMUX_EN_PINS; | |||
const pin_t amux_n_col_sizes[] = AMUX_COL_CHANNELS_SIZES; | |||
const pin_t amux_n_col_channels[][AMUX_MAX_COLS_COUNT] = {AMUX_COL_CHANNELS}; | |||
#define AMUX_SEL_PINS_COUNT ARRAY_SIZE(amux_sel_pins) | |||
#define EXPECTED_AMUX_SEL_PINS_COUNT ceil(log2(AMUX_MAX_COLS_COUNT) | |||
// Checks for the correctness of the configuration | |||
_Static_assert(ARRAY_SIZE(amux_en_pins) == AMUX_COUNT, "AMUX_EN_PINS doesn't have the minimum number of bits required to enable all the multiplexers available"); | |||
// Check that number of select pins is enough to select all the channels | |||
_Static_assert(AMUX_SEL_PINS_COUNT == EXPECTED_AMUX_SEL_PINS_COUNT), "AMUX_SEL_PINS doesn't have the minimum number of bits required address all the channels"); | |||
// Check that number of elements in AMUX_COL_CHANNELS_SIZES is enough to specify the number of channels for all the multiplexers available | |||
_Static_assert(ARRAY_SIZE(amux_n_col_sizes) == AMUX_COUNT, "AMUX_COL_CHANNELS_SIZES doesn't have the minimum number of elements required to specify the number of channels for all the multiplexers available"); | |||
static uint16_t sw_value[MATRIX_ROWS][MATRIX_COLS]; | |||
static adc_mux adcMux; | |||
// Initialize the row pins | |||
void init_row(void) { | |||
// Set all row pins as output and low | |||
for (uint8_t idx = 0; idx < MATRIX_ROWS; idx++) { | |||
setPinOutput(row_pins[idx]); | |||
writePinLow(row_pins[idx]); | |||
} | |||
} | |||
// Initialize the multiplexers | |||
void init_amux(void) { | |||
for (uint8_t idx = 0; idx < AMUX_COUNT; idx++) { | |||
setPinOutput(amux_en_pins[idx]); | |||
writePinLow(amux_en_pins[idx]); | |||
} | |||
for (uint8_t idx = 0; idx < AMUX_SEL_PINS_COUNT; idx++) { | |||
setPinOutput(amux_sel_pins[idx]); | |||
} | |||
} | |||
// Select the multiplexer channel of the specified multiplexer | |||
void select_amux_channel(uint8_t channel, uint8_t col) { | |||
// Get the channel for the specified multiplexer | |||
uint8_t ch = amux_n_col_channels[channel][col]; | |||
// momentarily disable specified multiplexer | |||
writePinHigh(amux_en_pins[channel]); | |||
// Select the multiplexer channel | |||
for (uint8_t i = 0; i < AMUX_SEL_PINS_COUNT; i++) { | |||
writePin(amux_sel_pins[i], ch & (1 << i)); | |||
} | |||
// re enable specified multiplexer | |||
writePinLow(amux_en_pins[channel]); | |||
} | |||
// Disable all the unused multiplexers | |||
void disable_unused_amux(uint8_t channel) { | |||
// disable all the other multiplexers apart from the current selected one | |||
for (uint8_t idx = 0; idx < AMUX_COUNT; idx++) { | |||
if (idx != channel) { | |||
writePinHigh(amux_en_pins[idx]); | |||
} | |||
} | |||
} | |||
// Discharge the peak hold capacitor | |||
void discharge_capacitor(void) { | |||
#ifdef OPEN_DRAIN_SUPPORT | |||
writePinLow(DISCHARGE_PIN); | |||
#else | |||
writePinLow(DISCHARGE_PIN); | |||
setPinOutput(DISCHARGE_PIN); | |||
#endif | |||
} | |||
// Charge the peak hold capacitor | |||
void charge_capacitor(uint8_t row) { | |||
#ifdef OPEN_DRAIN_SUPPORT | |||
writePinHigh(DISCHARGE_PIN); | |||
#else | |||
setPinInput(DISCHARGE_PIN); | |||
#endif | |||
writePinHigh(row_pins[row]); | |||
} | |||
// Initialize the peripherals pins | |||
int ec_init(void) { | |||
// Initialize ADC | |||
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); | |||
#ifdef OPEN_DRAIN_SUPPORT | |||
setPinOutputOpenDrain(DISCHARGE_PIN); | |||
#else | |||
setPinOutput(DISCHARGE_PIN); | |||
#endif | |||
// Initialize drive lines | |||
init_row(); | |||
// Initialize AMUXs | |||
init_amux(); | |||
return 0; | |||
} | |||
// Get the noise floor | |||
void ec_noise_floor(void) { | |||
// Initialize the noise floor | |||
for (uint8_t row = 0; row < MATRIX_ROWS; row++) { | |||
for (uint8_t col = 0; col < MATRIX_COLS; col++) { | |||
ec_config.noise_floor[row][col] = 0; | |||
} | |||
} | |||
// Sample the noise floor | |||
for (uint8_t i = 0; i < DEFAULT_NOISE_FLOOR_SAMPLING_COUNT; i++) { | |||
for (uint8_t amux = 0; amux < AMUX_COUNT; amux++) { | |||
disable_unused_amux(amux); | |||
for (uint8_t col = 0; col < amux_n_col_sizes[amux]; col++) { | |||
uint8_t adjusted_col = amux == 0 ? col : col + amux_n_col_sizes[amux - 1]; | |||
for (uint8_t row = 0; row < MATRIX_ROWS; row++) { | |||
ec_config.noise_floor[row][adjusted_col] += ec_readkey_raw(amux, row, col); | |||
} | |||
} | |||
} | |||
wait_ms(5); | |||
} | |||
// Average the noise floor | |||
for (uint8_t row = 0; row < MATRIX_ROWS; row++) { | |||
for (uint8_t col = 0; col < MATRIX_COLS; col++) { | |||
ec_config.noise_floor[row][col] /= DEFAULT_NOISE_FLOOR_SAMPLING_COUNT; | |||
} | |||
} | |||
} | |||
// Scan key values and update matrix state | |||
bool ec_matrix_scan(matrix_row_t current_matrix[]) { | |||
bool updated = false; | |||
for (uint8_t amux = 0; amux < AMUX_COUNT; amux++) { | |||
disable_unused_amux(amux); | |||
for (uint8_t col = 0; col < amux_n_col_sizes[amux]; col++) { | |||
for (uint8_t row = 0; row < MATRIX_ROWS; row++) { | |||
uint8_t adjusted_col = amux == 0 ? col : col + amux_n_col_sizes[amux - 1]; | |||
sw_value[row][adjusted_col] = ec_readkey_raw(amux, row, col); | |||
if (ec_config.bottoming_calibration) { | |||
if (ec_config.bottoming_calibration_starter[row][adjusted_col]) { | |||
ec_config.bottoming_reading[row][adjusted_col] = sw_value[row][adjusted_col]; | |||
ec_config.bottoming_calibration_starter[row][adjusted_col] = false; | |||
} else if (sw_value[row][adjusted_col] > ec_config.bottoming_reading[row][adjusted_col]) { | |||
ec_config.bottoming_reading[row][adjusted_col] = sw_value[row][adjusted_col]; | |||
} | |||
} else { | |||
updated |= ec_update_key(¤t_matrix[row], row, adjusted_col, sw_value[row][adjusted_col]); | |||
} | |||
} | |||
} | |||
} | |||
return ec_config.bottoming_calibration ? false : updated; | |||
} | |||
// Read the capacitive sensor value | |||
uint16_t ec_readkey_raw(uint8_t channel, uint8_t row, uint8_t col) { | |||
uint16_t sw_value = 0; | |||
// Select the multiplexer | |||
select_amux_channel(channel, col); | |||
// Set the row pin to low state to avoid ghosting | |||
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 ec_update_key(matrix_row_t* current_row, uint8_t row, uint8_t col, uint16_t sw_value) { | |||
bool current_state = (*current_row >> col) & 1; | |||
// Real Time Noise Floor Calibration | |||
if (sw_value < (ec_config.noise_floor[row][col] - NOISE_FLOOR_THRESHOLD)) { | |||
uprintf("Noise Floor Change: %d, %d, %d\n", row, col, sw_value); | |||
ec_config.noise_floor[row][col] = sw_value; | |||
ec_config.rescaled_mode_0_actuation_threshold[row][col] = rescale(ec_config.mode_0_actuation_threshold, 0, 1023, ec_config.noise_floor[row][col], eeprom_ec_config.bottoming_reading[row][col]); | |||
ec_config.rescaled_mode_0_release_threshold[row][col] = rescale(ec_config.mode_0_release_threshold, 0, 1023, ec_config.noise_floor[row][col], eeprom_ec_config.bottoming_reading[row][col]); | |||
ec_config.rescaled_mode_1_initial_deadzone_offset[row][col] = rescale(ec_config.mode_1_initial_deadzone_offset, 0, 1023, ec_config.noise_floor[row][col], eeprom_ec_config.bottoming_reading[row][col]); | |||
} | |||
// Normal board-wide APC | |||
if (ec_config.actuation_mode == 0) { | |||
if (current_state && sw_value < ec_config.rescaled_mode_0_release_threshold[row][col]) { | |||
*current_row &= ~(1 << col); | |||
uprintf("Key released: %d, %d, %d\n", row, col, sw_value); | |||
return true; | |||
} | |||
if ((!current_state) && sw_value > ec_config.rescaled_mode_0_actuation_threshold[row][col]) { | |||
*current_row |= (1 << col); | |||
uprintf("Key pressed: %d, %d, %d\n", row, col, sw_value); | |||
return true; | |||
} | |||
} | |||
// Rapid Trigger | |||
else if (ec_config.actuation_mode == 1) { | |||
// Is key in active zone? | |||
if (sw_value > ec_config.rescaled_mode_1_initial_deadzone_offset[row][col]) { | |||
// Is key pressed while in active zone? | |||
if (current_state) { | |||
// Is the key still moving down? | |||
if (sw_value > ec_config.extremum[row][col]) { | |||
ec_config.extremum[row][col] = sw_value; | |||
uprintf("Key pressed: %d, %d, %d\n", row, col, sw_value); | |||
} | |||
// Has key moved up enough to be released? | |||
else if (sw_value < ec_config.extremum[row][col] - ec_config.mode_1_release_offset) { | |||
ec_config.extremum[row][col] = sw_value; | |||
*current_row &= ~(1 << col); | |||
uprintf("Key released: %d, %d, %d\n", row, col, sw_value); | |||
return true; | |||
} | |||
} | |||
// Key is not pressed while in active zone | |||
else { | |||
// Is the key still moving up? | |||
if (sw_value < ec_config.extremum[row][col]) { | |||
ec_config.extremum[row][col] = sw_value; | |||
} | |||
// Has key moved down enough to be pressed? | |||
else if (sw_value > ec_config.extremum[row][col] + ec_config.mode_1_actuation_offset) { | |||
ec_config.extremum[row][col] = sw_value; | |||
*current_row |= (1 << col); | |||
uprintf("Key pressed: %d, %d, %d\n", row, col, sw_value); | |||
return true; | |||
} | |||
} | |||
} | |||
// Key is not in active zone | |||
else { | |||
// Check to avoid key being stuck in pressed state near the active zone threshold | |||
if (sw_value < ec_config.extremum[row][col]) { | |||
ec_config.extremum[row][col] = sw_value; | |||
*current_row &= ~(1 << col); | |||
return true; | |||
} | |||
} | |||
} | |||
return false; | |||
} | |||
// Print the matrix values | |||
void ec_print_matrix(void) { | |||
for (uint8_t row = 0; row < MATRIX_ROWS; row++) { | |||
for (uint8_t col = 0; col < MATRIX_COLS - 1; col++) { | |||
uprintf("%4d,", sw_value[row][col]); | |||
} | |||
uprintf("%4d\n", sw_value[row][MATRIX_COLS - 1]); | |||
} | |||
print("\n"); | |||
} | |||
// Rescale the value to a different range | |||
uint16_t rescale(uint16_t x, uint16_t in_min, uint16_t in_max, uint16_t out_min, uint16_t out_max) { | |||
return (x - in_min) * (out_max - out_min) / (in_max - in_min) + out_min; | |||
} |
@ -0,0 +1,72 @@ | |||
/* 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 3 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" | |||
#include "eeconfig.h" | |||
typedef struct PACKED { | |||
uint8_t actuation_mode; // 0: normal board-wide APC, 1: Rapid trigger from specific board-wide actuation point, 2: Rapid trigger from resting point | |||
uint16_t mode_0_actuation_threshold; // threshold for key press in mode 0 | |||
uint16_t mode_0_release_threshold; // threshold for key release in mode 0 | |||
uint16_t mode_1_initial_deadzone_offset; // threshold for key press in mode 1 | |||
uint8_t mode_1_actuation_offset; // offset for key press in mode 1 and 2 (1-255) | |||
uint8_t mode_1_release_offset; // offset for key release in mode 1 and 2 (1-255) | |||
uint16_t bottoming_reading[MATRIX_ROWS][MATRIX_COLS]; // bottoming reading | |||
} eeprom_ec_config_t; | |||
typedef struct { | |||
uint8_t actuation_mode; // 0: normal board-wide APC, 1: Rapid trigger from specific board-wide actuation point (it can be very near that baseline noise and be "full travel") | |||
uint16_t mode_0_actuation_threshold; // threshold for key press in mode 0 | |||
uint16_t mode_0_release_threshold; // threshold for key release in mode 0 | |||
uint16_t mode_1_initial_deadzone_offset; // threshold for key press in mode 1 (initial deadzone) | |||
uint16_t rescaled_mode_0_actuation_threshold[MATRIX_ROWS][MATRIX_COLS]; // threshold for key press in mode 0 rescaled to actual scale | |||
uint16_t rescaled_mode_0_release_threshold[MATRIX_ROWS][MATRIX_COLS]; // threshold for key release in mode 0 rescaled to actual scale | |||
uint16_t rescaled_mode_1_initial_deadzone_offset[MATRIX_ROWS][MATRIX_COLS]; // threshold for key press in mode 1 (initial deadzone) rescaled to actual scale | |||
uint8_t mode_1_actuation_offset; // offset for key press in mode 1 (1-255) | |||
uint8_t mode_1_release_offset; // offset for key release in mode 1 (1-255) | |||
uint16_t extremum[MATRIX_ROWS][MATRIX_COLS]; // extremum values for mode 1 | |||
uint16_t noise_floor[MATRIX_ROWS][MATRIX_COLS]; // noise floor detected during startup | |||
bool bottoming_calibration; // calibration mode for bottoming out values (true: calibration mode, false: normal mode) | |||
bool bottoming_calibration_starter[MATRIX_ROWS][MATRIX_COLS]; // calibration mode for bottoming out values (true: calibration mode, false: normal mode) | |||
uint16_t bottoming_reading[MATRIX_ROWS][MATRIX_COLS]; // bottoming reading | |||
} ec_config_t; | |||
// Check if the size of the reserved persistent memory is the same as the size of struct eeprom_ec_config_t | |||
_Static_assert(sizeof(eeprom_ec_config_t) == EECONFIG_KB_DATA_SIZE, "Mismatch in keyboard EECONFIG stored data"); | |||
extern eeprom_ec_config_t eeprom_ec_config; | |||
extern ec_config_t ec_config; | |||
void init_row(void); | |||
void init_amux(void); | |||
void select_amux_channel(uint8_t channel, uint8_t col); | |||
void disable_unused_amux(uint8_t channel); | |||
void discharge_capacitor(void); | |||
void charge_capacitor(uint8_t row); | |||
int ec_init(void); | |||
void ec_noise_floor(void); | |||
bool ec_matrix_scan(matrix_row_t current_matrix[]); | |||
uint16_t ec_readkey_raw(uint8_t channel, uint8_t row, uint8_t col); | |||
bool ec_update_key(matrix_row_t* current_row, uint8_t row, uint8_t col, uint16_t sw_value); | |||
void ec_print_matrix(void); | |||
uint16_t rescale(uint16_t x, uint16_t in_min, uint16_t in_max, uint16_t out_min, uint16_t out_max); |
@ -0,0 +1,26 @@ | |||
/* 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 3 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 "eeprom.h" | |||
#if (EECONFIG_KB_DATA_SIZE) > 0 | |||
# define EEPROM_KB_PARTIAL_UPDATE(__struct, __field) eeprom_update_block(&(__struct.__field), (void *)((void *)(EECONFIG_KB_DATABLOCK) + offsetof(typeof(__struct), __field)), sizeof(__struct.__field)) | |||
#endif | |||
#if (EECONFIG_USER_DATA_SIZE) > 0 | |||
# define EEPROM_USER_PARTIAL_UPDATE(__struct, __field) eeprom_update_block(&(__struct.__field), (void *)((void *)(EECONFIG_USER_DATABLOCK) + offsetof(typeof(__struct), __field)), sizeof(__struct.__field)) | |||
#endif |
@ -1,158 +0,0 @@ | |||
/* 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 "action.h" | |||
#include "via.h" | |||
#ifdef VIA_ENABLE | |||
void apc_init_thresholds(void); | |||
void apc_set_threshold(bool is_for_actuation); | |||
// Declaring an _apc_config_t struct that will store our data | |||
typedef struct _apc_config_t { | |||
uint16_t actuation_threshold; | |||
uint16_t release_threshold; | |||
} apc_config; | |||
// Check if the size of the reserved persistent memory is the same as the size of struct apc_config | |||
_Static_assert(sizeof(apc_config) == EECONFIG_USER_DATA_SIZE, "Mismatch in keyboard EECONFIG stored data"); | |||
// Declaring a new variable apc of type apc_config | |||
apc_config apc; | |||
// Declaring enums for VIA config menu | |||
enum via_apc_enums { | |||
// clang-format off | |||
id_apc_actuation_threshold = 1, | |||
id_apc_release_threshold = 2 | |||
// clang-format on | |||
}; | |||
// Initializing persistent memory configuration: default values are declared and stored in PMEM | |||
void eeconfig_init_user(void) { | |||
// Default values | |||
apc.actuation_threshold = DEFAULT_ACTUATION_LEVEL; | |||
apc.release_threshold = DEFAULT_RELEASE_LEVEL; | |||
// Write default value to EEPROM now | |||
eeconfig_update_user_datablock(&apc); | |||
} | |||
// On Keyboard startup | |||
void keyboard_post_init_user(void) { | |||
// Read custom menu variables from memory | |||
eeconfig_read_user_datablock(&apc); | |||
apc_init_thresholds(); | |||
} | |||
// Handle the data received by the keyboard from the VIA menus | |||
void apc_config_set_value(uint8_t *data) { | |||
// data = [ value_id, value_data ] | |||
uint8_t *value_id = &(data[0]); | |||
uint8_t *value_data = &(data[1]); | |||
switch (*value_id) { | |||
case id_apc_actuation_threshold: { | |||
apc.actuation_threshold = value_data[1] | (value_data[0] << 8); | |||
apc_set_threshold(true); | |||
break; | |||
} | |||
case id_apc_release_threshold: { | |||
apc.release_threshold = value_data[1] | (value_data[0] << 8); | |||
apc_set_threshold(false); | |||
break; | |||
} | |||
} | |||
} | |||
// Handle the data sent by the keyboard to the VIA menus | |||
void apc_config_get_value(uint8_t *data) { | |||
// data = [ value_id, value_data ] | |||
uint8_t *value_id = &(data[0]); | |||
uint8_t *value_data = &(data[1]); | |||
switch (*value_id) { | |||
case id_apc_actuation_threshold: { | |||
value_data[0] = apc.actuation_threshold >> 8; | |||
value_data[1] = apc.actuation_threshold & 0xFF; | |||
break; | |||
} | |||
case id_apc_release_threshold: { | |||
value_data[0] = apc.release_threshold >> 8; | |||
value_data[1] = apc.release_threshold & 0xFF; | |||
break; | |||
} | |||
} | |||
} | |||
// Save the data to persistent memory after changes are made | |||
void apc_config_save(void) { | |||
eeconfig_update_user_datablock(&apc); | |||
} | |||
void via_custom_value_command_kb(uint8_t *data, uint8_t length) { | |||
// data = [ command_id, channel_id, value_id, value_data ] | |||
uint8_t *command_id = &(data[0]); | |||
uint8_t *channel_id = &(data[1]); | |||
uint8_t *value_id_and_data = &(data[2]); | |||
if (*channel_id == id_custom_channel) { | |||
switch (*command_id) { | |||
case id_custom_set_value: { | |||
apc_config_set_value(value_id_and_data); | |||
break; | |||
} | |||
case id_custom_get_value: { | |||
apc_config_get_value(value_id_and_data); | |||
break; | |||
} | |||
case id_custom_save: { | |||
apc_config_save(); | |||
break; | |||
} | |||
default: { | |||
// Unhandled message. | |||
*command_id = id_unhandled; | |||
break; | |||
} | |||
} | |||
return; | |||
} | |||
*command_id = id_unhandled; | |||
} | |||
// Initialize the thresholds | |||
void apc_init_thresholds(void) { | |||
ecsm_config.ecsm_actuation_threshold = apc.actuation_threshold; | |||
ecsm_config.ecsm_release_threshold = apc.release_threshold; | |||
// Update the ecsm_config | |||
ecsm_update(&ecsm_config); | |||
} | |||
// Set the thresholds | |||
void apc_set_threshold(bool is_for_actuation) { | |||
if (is_for_actuation) { | |||
ecsm_config.ecsm_actuation_threshold = apc.actuation_threshold; | |||
} else { | |||
ecsm_config.ecsm_release_threshold = apc.release_threshold; | |||
} | |||
// Update the ecsm_config | |||
ecsm_update(&ecsm_config); | |||
} | |||
#endif // VIA_ENABLE |
@ -0,0 +1,363 @@ | |||
/* 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 3 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 "eeprom_tools.h" | |||
#include "ec_switch_matrix.h" | |||
#include "action.h" | |||
#include "print.h" | |||
#include "via.h" | |||
#ifdef VIA_ENABLE | |||
void ec_rescale_values(uint8_t item); | |||
void ec_save_threshold_data(uint8_t option); | |||
void ec_save_bottoming_reading(void); | |||
void ec_show_calibration_data(void); | |||
void ec_clear_bottoming_calibration_data(void); | |||
// Declaring enums for VIA config menu | |||
enum via_enums { | |||
// clang-format off | |||
id_actuation_mode = 1, | |||
id_mode_0_actuation_threshold = 2, | |||
id_mode_0_release_threshold = 3, | |||
id_save_threshold_data = 4, | |||
id_mode_1_initial_deadzone_offset = 5, | |||
id_mode_1_actuation_offset = 6, | |||
id_mode_1_release_offset = 7, | |||
id_bottoming_calibration = 8, | |||
id_noise_floor_calibration = 9, | |||
id_show_calibration_data = 10, | |||
id_clear_bottoming_calibration_data = 11 | |||
// clang-format on | |||
}; | |||
// Handle the data received by the keyboard from the VIA menus | |||
void via_config_set_value(uint8_t *data) { | |||
// data = [ value_id, value_data ] | |||
uint8_t *value_id = &(data[0]); | |||
uint8_t *value_data = &(data[1]); | |||
switch (*value_id) { | |||
case id_actuation_mode: { | |||
eeprom_ec_config.actuation_mode = value_data[0]; | |||
ec_config.actuation_mode = eeprom_ec_config.actuation_mode; | |||
if (ec_config.actuation_mode == 0) { | |||
uprintf("#########################\n"); | |||
uprintf("# Actuation Mode: APC #\n"); | |||
uprintf("#########################\n"); | |||
} else if (ec_config.actuation_mode == 1) { | |||
uprintf("#################################\n"); | |||
uprintf("# Actuation Mode: Rapid Trigger #\n"); | |||
uprintf("#################################\n"); | |||
} | |||
EEPROM_KB_PARTIAL_UPDATE(eeprom_ec_config, actuation_mode); | |||
break; | |||
} | |||
case id_mode_0_actuation_threshold: { | |||
ec_config.mode_0_actuation_threshold = value_data[1] | (value_data[0] << 8); | |||
uprintf("APC Mode Actuation Threshold: %d\n", ec_config.mode_0_actuation_threshold); | |||
break; | |||
} | |||
case id_mode_0_release_threshold: { | |||
ec_config.mode_0_release_threshold = value_data[1] | (value_data[0] << 8); | |||
uprintf("APC Mode Release Threshold: %d\n", ec_config.mode_0_release_threshold); | |||
break; | |||
} | |||
case id_mode_1_initial_deadzone_offset: { | |||
ec_config.mode_1_initial_deadzone_offset = value_data[1] | (value_data[0] << 8); | |||
uprintf("Rapid Trigger Mode Initial Deadzone Offset: %d\n", ec_config.mode_1_initial_deadzone_offset); | |||
break; | |||
} | |||
case id_mode_1_actuation_offset: { | |||
ec_config.mode_1_actuation_offset = value_data[0]; | |||
uprintf("Rapid Trigger Mode Actuation Offset: %d\n", ec_config.mode_1_actuation_offset); | |||
break; | |||
} | |||
case id_mode_1_release_offset: { | |||
ec_config.mode_1_release_offset = value_data[0]; | |||
uprintf("Rapid Trigger Mode Release Offset: %d\n", ec_config.mode_1_release_offset); | |||
break; | |||
} | |||
case id_bottoming_calibration: { | |||
if (value_data[0] == 1) { | |||
ec_config.bottoming_calibration = true; | |||
uprintf("##############################\n"); | |||
uprintf("# Bottoming calibration mode #\n"); | |||
uprintf("##############################\n"); | |||
} else { | |||
ec_config.bottoming_calibration = false; | |||
ec_save_bottoming_reading(); | |||
uprintf("## Bottoming calibration done ##\n"); | |||
ec_show_calibration_data(); | |||
} | |||
break; | |||
} | |||
case id_save_threshold_data: { | |||
ec_save_threshold_data(value_data[0]); | |||
break; | |||
} | |||
case id_noise_floor_calibration: { | |||
if (value_data[0] == 0) { | |||
ec_noise_floor(); | |||
ec_rescale_values(0); | |||
ec_rescale_values(1); | |||
ec_rescale_values(2); | |||
uprintf("#############################\n"); | |||
uprintf("# Noise floor data acquired #\n"); | |||
uprintf("#############################\n"); | |||
break; | |||
} | |||
} | |||
case id_show_calibration_data: { | |||
if (value_data[0] == 0) { | |||
ec_show_calibration_data(); | |||
break; | |||
} | |||
} | |||
case id_clear_bottoming_calibration_data: { | |||
if (value_data[0] == 0) { | |||
ec_clear_bottoming_calibration_data(); | |||
} | |||
} | |||
default: { | |||
// Unhandled value. | |||
break; | |||
} | |||
} | |||
} | |||
// Handle the data sent by the keyboard to the VIA menus | |||
void via_config_get_value(uint8_t *data) { | |||
// data = [ value_id, value_data ] | |||
uint8_t *value_id = &(data[0]); | |||
uint8_t *value_data = &(data[1]); | |||
switch (*value_id) { | |||
case id_actuation_mode: { | |||
value_data[0] = eeprom_ec_config.actuation_mode; | |||
break; | |||
} | |||
case id_mode_0_actuation_threshold: { | |||
value_data[0] = eeprom_ec_config.mode_0_actuation_threshold >> 8; | |||
value_data[1] = eeprom_ec_config.mode_0_actuation_threshold & 0xFF; | |||
break; | |||
} | |||
case id_mode_0_release_threshold: { | |||
value_data[0] = eeprom_ec_config.mode_0_release_threshold >> 8; | |||
value_data[1] = eeprom_ec_config.mode_0_release_threshold & 0xFF; | |||
break; | |||
} | |||
case id_mode_1_initial_deadzone_offset: { | |||
value_data[0] = eeprom_ec_config.mode_1_initial_deadzone_offset >> 8; | |||
value_data[1] = eeprom_ec_config.mode_1_initial_deadzone_offset & 0xFF; | |||
break; | |||
} | |||
case id_mode_1_actuation_offset: { | |||
value_data[0] = eeprom_ec_config.mode_1_actuation_offset; | |||
break; | |||
} | |||
case id_mode_1_release_offset: { | |||
value_data[0] = eeprom_ec_config.mode_1_release_offset; | |||
break; | |||
} | |||
default: { | |||
// Unhandled value. | |||
break; | |||
} | |||
} | |||
} | |||
// Handle the commands sent and received by the keyboard with VIA | |||
void via_custom_value_command_kb(uint8_t *data, uint8_t length) { | |||
// data = [ command_id, channel_id, value_id, value_data ] | |||
uint8_t *command_id = &(data[0]); | |||
uint8_t *channel_id = &(data[1]); | |||
uint8_t *value_id_and_data = &(data[2]); | |||
if (*channel_id == id_custom_channel) { | |||
switch (*command_id) { | |||
case id_custom_set_value: { | |||
via_config_set_value(value_id_and_data); | |||
break; | |||
} | |||
case id_custom_get_value: { | |||
via_config_get_value(value_id_and_data); | |||
break; | |||
} | |||
case id_custom_save: { | |||
// Bypass the save function in favor of pinpointed saves | |||
break; | |||
} | |||
default: { | |||
// Unhandled message. | |||
*command_id = id_unhandled; | |||
break; | |||
} | |||
} | |||
return; | |||
} | |||
*command_id = id_unhandled; | |||
} | |||
// Rescale the values received by VIA to fit the new range | |||
void ec_rescale_values(uint8_t item) { | |||
switch (item) { | |||
// Rescale the APC mode actuation thresholds | |||
case 0: | |||
for (uint8_t row = 0; row < MATRIX_ROWS; row++) { | |||
for (uint8_t col = 0; col < MATRIX_COLS; col++) { | |||
ec_config.rescaled_mode_0_actuation_threshold[row][col] = rescale(ec_config.mode_0_actuation_threshold, 0, 1023, ec_config.noise_floor[row][col], eeprom_ec_config.bottoming_reading[row][col]); | |||
} | |||
} | |||
break; | |||
// Rescale the APC mode release thresholds | |||
case 1: | |||
for (uint8_t row = 0; row < MATRIX_ROWS; row++) { | |||
for (uint8_t col = 0; col < MATRIX_COLS; col++) { | |||
ec_config.rescaled_mode_0_release_threshold[row][col] = rescale(ec_config.mode_0_release_threshold, 0, 1023, ec_config.noise_floor[row][col], eeprom_ec_config.bottoming_reading[row][col]); | |||
} | |||
} | |||
break; | |||
// Rescale the Rapid Trigger mode initial deadzone offsets | |||
case 2: | |||
for (uint8_t row = 0; row < MATRIX_ROWS; row++) { | |||
for (uint8_t col = 0; col < MATRIX_COLS; col++) { | |||
ec_config.rescaled_mode_1_initial_deadzone_offset[row][col] = rescale(ec_config.mode_1_initial_deadzone_offset, 0, 1023, ec_config.noise_floor[row][col], eeprom_ec_config.bottoming_reading[row][col]); | |||
} | |||
} | |||
break; | |||
default: | |||
// Unhandled item. | |||
break; | |||
} | |||
} | |||
void ec_save_threshold_data(uint8_t option) { | |||
// Save APC mode thresholds and rescale them for runtime usage | |||
if (option == 0) { | |||
eeprom_ec_config.mode_0_actuation_threshold = ec_config.mode_0_actuation_threshold; | |||
eeprom_ec_config.mode_0_release_threshold = ec_config.mode_0_release_threshold; | |||
ec_rescale_values(0); | |||
ec_rescale_values(1); | |||
} | |||
// Save Rapid Trigger mode thresholds and rescale them for runtime usage | |||
else if (option == 1) { | |||
eeprom_ec_config.mode_1_initial_deadzone_offset = ec_config.mode_1_initial_deadzone_offset; | |||
eeprom_ec_config.mode_1_actuation_offset = ec_config.mode_1_actuation_offset; | |||
eeprom_ec_config.mode_1_release_offset = ec_config.mode_1_release_offset; | |||
ec_rescale_values(2); | |||
} | |||
eeconfig_update_kb_datablock(&eeprom_ec_config); | |||
uprintf("####################################\n"); | |||
uprintf("# New thresholds applied and saved #\n"); | |||
uprintf("####################################\n"); | |||
} | |||
// Save the bottoming reading | |||
void ec_save_bottoming_reading(void) { | |||
for (uint8_t row = 0; row < MATRIX_ROWS; row++) { | |||
for (uint8_t col = 0; col < MATRIX_COLS; col++) { | |||
// If the bottom reading doesn't go over the noise floor by BOTTOMING_CALIBRATION_THRESHOLD, it is likely that: | |||
// 1. The key is not actually in the matrix | |||
// 2. The key is on an alternative layout, therefore not being pressed | |||
// 3. The key in in the current layout but not being pressed | |||
if (ec_config.bottoming_reading[row][col] < (ec_config.noise_floor[row][col] + BOTTOMING_CALIBRATION_THRESHOLD)) { | |||
eeprom_ec_config.bottoming_reading[row][col] = 1023; | |||
} else { | |||
eeprom_ec_config.bottoming_reading[row][col] = ec_config.bottoming_reading[row][col]; | |||
} | |||
} | |||
} | |||
// Rescale the values to fit the new range for runtime usage | |||
ec_rescale_values(0); | |||
ec_rescale_values(1); | |||
ec_rescale_values(2); | |||
eeconfig_update_kb_datablock(&eeprom_ec_config); | |||
} | |||
// Show the calibration data | |||
void ec_show_calibration_data(void) { | |||
uprintf("\n###############\n"); | |||
uprintf("# Noise Floor #\n"); | |||
uprintf("###############\n"); | |||
for (uint8_t row = 0; row < MATRIX_ROWS; row++) { | |||
for (uint8_t col = 0; col < MATRIX_COLS - 1; col++) { | |||
uprintf("%4d,", ec_config.noise_floor[row][col]); | |||
} | |||
uprintf("%4d\n", ec_config.noise_floor[row][MATRIX_COLS - 1]); | |||
} | |||
uprintf("\n######################\n"); | |||
uprintf("# Bottoming Readings #\n"); | |||
uprintf("######################\n"); | |||
for (uint8_t row = 0; row < MATRIX_ROWS; row++) { | |||
for (uint8_t col = 0; col < MATRIX_COLS - 1; col++) { | |||
uprintf("%4d,", eeprom_ec_config.bottoming_reading[row][col]); | |||
} | |||
uprintf("%4d\n", eeprom_ec_config.bottoming_reading[row][MATRIX_COLS - 1]); | |||
} | |||
uprintf("\n######################################\n"); | |||
uprintf("# Rescaled APC Mode Actuation Points #\n"); | |||
uprintf("######################################\n"); | |||
uprintf("Original APC Mode Actuation Point: %4d\n", ec_config.mode_0_actuation_threshold); | |||
for (uint8_t row = 0; row < MATRIX_ROWS; row++) { | |||
for (uint8_t col = 0; col < MATRIX_COLS - 1; col++) { | |||
uprintf("%4d,", ec_config.rescaled_mode_0_actuation_threshold[row][col]); | |||
} | |||
uprintf("%4d\n", ec_config.rescaled_mode_0_actuation_threshold[row][MATRIX_COLS - 1]); | |||
} | |||
uprintf("\n######################################\n"); | |||
uprintf("# Rescaled APC Mode Release Points #\n"); | |||
uprintf("######################################\n"); | |||
uprintf("Original APC Mode Release Point: %4d\n", ec_config.mode_0_release_threshold); | |||
for (uint8_t row = 0; row < MATRIX_ROWS; row++) { | |||
for (uint8_t col = 0; col < MATRIX_COLS - 1; col++) { | |||
uprintf("%4d,", ec_config.rescaled_mode_0_release_threshold[row][col]); | |||
} | |||
uprintf("%4d\n", ec_config.rescaled_mode_0_release_threshold[row][MATRIX_COLS - 1]); | |||
} | |||
uprintf("\n#######################################################\n"); | |||
uprintf("# Rescaled Rapid Trigger Mode Initial Deadzone Offset #\n"); | |||
uprintf("#######################################################\n"); | |||
uprintf("Original Rapid Trigger Mode Initial Deadzone Offset: %4d\n", ec_config.mode_1_initial_deadzone_offset); | |||
for (uint8_t row = 0; row < MATRIX_ROWS; row++) { | |||
for (uint8_t col = 0; col < MATRIX_COLS - 1; col++) { | |||
uprintf("%4d,", ec_config.rescaled_mode_1_initial_deadzone_offset[row][col]); | |||
} | |||
uprintf("%4d\n", ec_config.rescaled_mode_1_initial_deadzone_offset[row][MATRIX_COLS - 1]); | |||
} | |||
print("\n"); | |||
} | |||
// Clear the calibration data | |||
void ec_clear_bottoming_calibration_data(void) { | |||
// Clear the EEPROM data | |||
eeconfig_init_kb(); | |||
// Reset the runtime values to the EEPROM values | |||
keyboard_post_init_kb(); | |||
uprintf("######################################\n"); | |||
uprintf("# Bottoming calibration data cleared #\n"); | |||
uprintf("######################################\n"); | |||
} | |||
#endif // VIA_ENABLE |
@ -1,165 +0,0 @@ | |||
/* 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(¤t_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"); | |||
} |
@ -1,36 +0,0 @@ | |||
/* 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); |
@ -1,3 +1 @@ | |||
VIA_ENABLE = yes | |||
SRC += via_apc.c |
@ -1,156 +0,0 @@ | |||
/* 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 "action.h" | |||
#include "via.h" | |||
void apc_init_thresholds(void); | |||
void apc_set_threshold(bool is_for_actuation); | |||
// Declaring an _apc_config_t struct that will store our data | |||
typedef struct _apc_config_t { | |||
uint16_t actuation_threshold; | |||
uint16_t release_threshold; | |||
} apc_config; | |||
// Check if the size of the reserved persistent memory is the same as the size of struct apc_config | |||
_Static_assert(sizeof(apc_config) == EECONFIG_USER_DATA_SIZE, "Mismatch in keyboard EECONFIG stored data"); | |||
// Declaring a new variable apc of type apc_config | |||
apc_config apc; | |||
// Declaring enums for VIA config menu | |||
enum via_apc_enums { | |||
// clang-format off | |||
id_apc_actuation_threshold = 1, | |||
id_apc_release_threshold = 2 | |||
// clang-format on | |||
}; | |||
// Initializing persistent memory configuration: default values are declared and stored in PMEM | |||
void eeconfig_init_user(void) { | |||
// Default values | |||
apc.actuation_threshold = DEFAULT_ACTUATION_LEVEL; | |||
apc.release_threshold = DEFAULT_RELEASE_LEVEL; | |||
// Write default value to EEPROM now | |||
eeconfig_update_user_datablock(&apc); | |||
} | |||
// On Keyboard startup | |||
void keyboard_post_init_user(void) { | |||
// Read custom menu variables from memory | |||
eeconfig_read_user_datablock(&apc); | |||
apc_init_thresholds(); | |||
} | |||
// Handle the data received by the keyboard from the VIA menus | |||
void apc_config_set_value(uint8_t *data) { | |||
// data = [ value_id, value_data ] | |||
uint8_t *value_id = &(data[0]); | |||
uint8_t *value_data = &(data[1]); | |||
switch (*value_id) { | |||
case id_apc_actuation_threshold: { | |||
apc.actuation_threshold = value_data[1] | (value_data[0] << 8); | |||
apc_set_threshold(true); | |||
break; | |||
} | |||
case id_apc_release_threshold: { | |||
apc.release_threshold = value_data[1] | (value_data[0] << 8); | |||
apc_set_threshold(false); | |||
break; | |||
} | |||
} | |||
} | |||
// Handle the data sent by the keyboard to the VIA menus | |||
void apc_config_get_value(uint8_t *data) { | |||
// data = [ value_id, value_data ] | |||
uint8_t *value_id = &(data[0]); | |||
uint8_t *value_data = &(data[1]); | |||
switch (*value_id) { | |||
case id_apc_actuation_threshold: { | |||
value_data[0] = apc.actuation_threshold >> 8; | |||
value_data[1] = apc.actuation_threshold & 0xFF; | |||
break; | |||
} | |||
case id_apc_release_threshold: { | |||
value_data[0] = apc.release_threshold >> 8; | |||
value_data[1] = apc.release_threshold & 0xFF; | |||
break; | |||
} | |||
} | |||
} | |||
// Save the data to persistent memory after changes are made | |||
void apc_config_save(void) { | |||
eeconfig_update_user_datablock(&apc); | |||
} | |||
void via_custom_value_command_kb(uint8_t *data, uint8_t length) { | |||
// data = [ command_id, channel_id, value_id, value_data ] | |||
uint8_t *command_id = &(data[0]); | |||
uint8_t *channel_id = &(data[1]); | |||
uint8_t *value_id_and_data = &(data[2]); | |||
if (*channel_id == id_custom_channel) { | |||
switch (*command_id) { | |||
case id_custom_set_value: { | |||
apc_config_set_value(value_id_and_data); | |||
break; | |||
} | |||
case id_custom_get_value: { | |||
apc_config_get_value(value_id_and_data); | |||
break; | |||
} | |||
case id_custom_save: { | |||
apc_config_save(); | |||
break; | |||
} | |||
default: { | |||
// Unhandled message. | |||
*command_id = id_unhandled; | |||
break; | |||
} | |||
} | |||
return; | |||
} | |||
*command_id = id_unhandled; | |||
} | |||
// Initialize the thresholds | |||
void apc_init_thresholds(void) { | |||
ecsm_config.ecsm_actuation_threshold = apc.actuation_threshold; | |||
ecsm_config.ecsm_release_threshold = apc.release_threshold; | |||
// Update the ecsm_config | |||
ecsm_update(&ecsm_config); | |||
} | |||
// Set the thresholds | |||
void apc_set_threshold(bool is_for_actuation) { | |||
if (is_for_actuation) { | |||
ecsm_config.ecsm_actuation_threshold = apc.actuation_threshold; | |||
} else { | |||
ecsm_config.ecsm_release_threshold = apc.release_threshold; | |||
} | |||
// Update the ecsm_config | |||
ecsm_update(&ecsm_config); | |||
} |
@ -0,0 +1,3 @@ | |||
ifeq ($(strip $(VIA_ENABLE)), yes) | |||
SRC += keyboards/cipulot/common/via_ec.c | |||
endif |
@ -1,4 +1,4 @@ | |||
CUSTOM_MATRIX = lite | |||
SRC += matrix.c ec_switch_matrix.c | |||
ANALOG_DRIVER_REQUIRED = yes | |||
SRC += keyboards/cipulot/common/matrix.c keyboards/cipulot/common/ec_board.c keyboards/cipulot/common/ec_switch_matrix.c | |||
OPT = 2 |
@ -1,183 +0,0 @@ | |||
/* 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_0); | |||
writePinLow(APLEX_EN_PIN_0); | |||
setPinOutput(APLEX_EN_PIN_1); | |||
writePinLow(APLEX_EN_PIN_1); | |||
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 | |||
if (channel == 0) { | |||
writePinHigh(APLEX_EN_PIN_0); | |||
select_mux(col); | |||
writePinLow(APLEX_EN_PIN_0); | |||
} else { | |||
writePinHigh(APLEX_EN_PIN_1); | |||
select_mux(col); | |||
writePinLow(APLEX_EN_PIN_1); | |||
} | |||
// 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; | |||
// Disable AMUX of channel 1 | |||
writePinHigh(APLEX_EN_PIN_1); | |||
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(¤t_matrix[row], row, col, ecsm_sw_value[row][col]); | |||
} | |||
} | |||
// Disable AMUX of channel 1 | |||
writePinHigh(APLEX_EN_PIN_0); | |||
for (int col = 0; col < (sizeof(col_channels) - 1); col++) { | |||
for (int row = 0; row < MATRIX_ROWS; row++) { | |||
ecsm_sw_value[row][col + 8] = ecsm_readkey_raw(1, row, col); | |||
updated |= ecsm_update_key(¤t_matrix[row], row, col + 8, ecsm_sw_value[row][col + 8]); | |||
} | |||
} | |||
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"); | |||
} |
@ -1,36 +0,0 @@ | |||
/* 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); |
@ -1,3 +1 @@ | |||
VIA_ENABLE = yes | |||
SRC += via_apc.c |
@ -1,156 +0,0 @@ | |||
/* 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 "action.h" | |||
#include "via.h" | |||
void apc_init_thresholds(void); | |||
void apc_set_threshold(bool is_for_actuation); | |||
// Declaring an _apc_config_t struct that will store our data | |||
typedef struct _apc_config_t { | |||
uint16_t actuation_threshold; | |||
uint16_t release_threshold; | |||
} apc_config; | |||
// Check if the size of the reserved persistent memory is the same as the size of struct apc_config | |||
_Static_assert(sizeof(apc_config) == EECONFIG_USER_DATA_SIZE, "Mismatch in keyboard EECONFIG stored data"); | |||
// Declaring a new variable apc of type apc_config | |||
apc_config apc; | |||
// Declaring enums for VIA config menu | |||
enum via_apc_enums { | |||
// clang-format off | |||
id_apc_actuation_threshold = 1, | |||
id_apc_release_threshold = 2 | |||
// clang-format on | |||
}; | |||
// Initializing persistent memory configuration: default values are declared and stored in PMEM | |||
void eeconfig_init_user(void) { | |||
// Default values | |||
apc.actuation_threshold = DEFAULT_ACTUATION_LEVEL; | |||
apc.release_threshold = DEFAULT_RELEASE_LEVEL; | |||
// Write default value to EEPROM now | |||
eeconfig_update_user_datablock(&apc); | |||
} | |||
// On Keyboard startup | |||
void keyboard_post_init_user(void) { | |||
// Read custom menu variables from memory | |||
eeconfig_read_user_datablock(&apc); | |||
apc_init_thresholds(); | |||
} | |||
// Handle the data received by the keyboard from the VIA menus | |||
void apc_config_set_value(uint8_t *data) { | |||
// data = [ value_id, value_data ] | |||
uint8_t *value_id = &(data[0]); | |||
uint8_t *value_data = &(data[1]); | |||
switch (*value_id) { | |||
case id_apc_actuation_threshold: { | |||
apc.actuation_threshold = value_data[1] | (value_data[0] << 8); | |||
apc_set_threshold(true); | |||
break; | |||
} | |||
case id_apc_release_threshold: { | |||
apc.release_threshold = value_data[1] | (value_data[0] << 8); | |||
apc_set_threshold(false); | |||
break; | |||
} | |||
} | |||
} | |||
// Handle the data sent by the keyboard to the VIA menus | |||
void apc_config_get_value(uint8_t *data) { | |||
// data = [ value_id, value_data ] | |||
uint8_t *value_id = &(data[0]); | |||
uint8_t *value_data = &(data[1]); | |||
switch (*value_id) { | |||
case id_apc_actuation_threshold: { | |||
value_data[0] = apc.actuation_threshold >> 8; | |||
value_data[1] = apc.actuation_threshold & 0xFF; | |||
break; | |||
} | |||
case id_apc_release_threshold: { | |||
value_data[0] = apc.release_threshold >> 8; | |||
value_data[1] = apc.release_threshold & 0xFF; | |||
break; | |||
} | |||
} | |||
} | |||
// Save the data to persistent memory after changes are made | |||
void apc_config_save(void) { | |||
eeconfig_update_user_datablock(&apc); | |||
} | |||
void via_custom_value_command_kb(uint8_t *data, uint8_t length) { | |||
// data = [ command_id, channel_id, value_id, value_data ] | |||
uint8_t *command_id = &(data[0]); | |||
uint8_t *channel_id = &(data[1]); | |||
uint8_t *value_id_and_data = &(data[2]); | |||
if (*channel_id == id_custom_channel) { | |||
switch (*command_id) { | |||
case id_custom_set_value: { | |||
apc_config_set_value(value_id_and_data); | |||
break; | |||
} | |||
case id_custom_get_value: { | |||
apc_config_get_value(value_id_and_data); | |||
break; | |||
} | |||
case id_custom_save: { | |||
apc_config_save(); | |||
break; | |||
} | |||
default: { | |||
// Unhandled message. | |||
*command_id = id_unhandled; | |||
break; | |||
} | |||
} | |||
return; | |||
} | |||
*command_id = id_unhandled; | |||
} | |||
// Initialize the thresholds | |||
void apc_init_thresholds(void) { | |||
ecsm_config.ecsm_actuation_threshold = apc.actuation_threshold; | |||
ecsm_config.ecsm_release_threshold = apc.release_threshold; | |||
// Update the ecsm_config | |||
ecsm_update(&ecsm_config); | |||
} | |||
// Set the thresholds | |||
void apc_set_threshold(bool is_for_actuation) { | |||
if (is_for_actuation) { | |||
ecsm_config.ecsm_actuation_threshold = apc.actuation_threshold; | |||
} else { | |||
ecsm_config.ecsm_release_threshold = apc.release_threshold; | |||
} | |||
// Update the ecsm_config | |||
ecsm_update(&ecsm_config); | |||
} |
@ -1,44 +0,0 @@ | |||
/* 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 "matrix.h" | |||
/* matrix state(1:on, 0:off) */ | |||
extern matrix_row_t raw_matrix[MATRIX_ROWS]; // raw values | |||
extern matrix_row_t matrix[MATRIX_ROWS]; // debounced values | |||
void matrix_init_custom(void) { | |||
// Default values, overwritten by VIA if enabled later | |||
ecsm_config.ecsm_actuation_threshold = DEFAULT_ACTUATION_LEVEL; | |||
ecsm_config.ecsm_release_threshold = DEFAULT_RELEASE_LEVEL; | |||
ecsm_init(&ecsm_config); | |||
} | |||
bool matrix_scan_custom(matrix_row_t current_matrix[]) { | |||
bool updated = ecsm_matrix_scan(current_matrix); | |||
// RAW matrix values on console | |||
#ifdef CONSOLE_ENABLE | |||
static int cnt = 0; | |||
if (cnt++ == 350) { | |||
cnt = 0; | |||
ecsm_print_matrix(); | |||
} | |||
#endif | |||
return updated; | |||
} |
@ -0,0 +1,3 @@ | |||
ifeq ($(strip $(VIA_ENABLE)), yes) | |||
SRC += keyboards/cipulot/common/via_ec.c | |||
endif |
@ -1,4 +1,4 @@ | |||
CUSTOM_MATRIX = lite | |||
SRC += matrix.c ec_switch_matrix.c | |||
ANALOG_DRIVER_REQUIRED = yes | |||
SRC += keyboards/cipulot/common/matrix.c keyboards/cipulot/common/ec_board.c keyboards/cipulot/common/ec_switch_matrix.c | |||
OPT = 3 |
@ -1,183 +0,0 @@ | |||
/* 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_0); | |||
writePinLow(APLEX_EN_PIN_0); | |||
setPinOutput(APLEX_EN_PIN_1); | |||
writePinLow(APLEX_EN_PIN_1); | |||
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 | |||
if (channel == 0) { | |||
writePinHigh(APLEX_EN_PIN_0); | |||
select_mux(col); | |||
writePinLow(APLEX_EN_PIN_0); | |||
} else { | |||
writePinHigh(APLEX_EN_PIN_1); | |||
select_mux(col); | |||
writePinLow(APLEX_EN_PIN_1); | |||
} | |||
// 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; | |||
// Disable AMUX of channel 1 | |||
writePinHigh(APLEX_EN_PIN_1); | |||
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(¤t_matrix[row], row, col, ecsm_sw_value[row][col]); | |||
} | |||
} | |||
// Disable AMUX of channel 1 | |||
writePinHigh(APLEX_EN_PIN_0); | |||
for (int col = 0; col < sizeof(col_channels); col++) { | |||
for (int row = 0; row < MATRIX_ROWS; row++) { | |||
ecsm_sw_value[row][col + 8] = ecsm_readkey_raw(1, row, col); | |||
updated |= ecsm_update_key(¤t_matrix[row], row, col + 8, ecsm_sw_value[row][col + 8]); | |||
} | |||
} | |||
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"); | |||
} |
@ -1,36 +0,0 @@ | |||
/* 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); |
@ -1,3 +1 @@ | |||
VIA_ENABLE = yes | |||
SRC += via_apc.c |
@ -1,156 +0,0 @@ | |||
/* 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 "action.h" | |||
#include "via.h" | |||
void apc_init_thresholds(void); | |||
void apc_set_threshold(bool is_for_actuation); | |||
// Declaring an _apc_config_t struct that will store our data | |||
typedef struct _apc_config_t { | |||
uint16_t actuation_threshold; | |||
uint16_t release_threshold; | |||
} apc_config; | |||
// Check if the size of the reserved persistent memory is the same as the size of struct apc_config | |||
_Static_assert(sizeof(apc_config) == EECONFIG_USER_DATA_SIZE, "Mismatch in keyboard EECONFIG stored data"); | |||
// Declaring a new variable apc of type apc_config | |||
apc_config apc; | |||
// Declaring enums for VIA config menu | |||
enum via_apc_enums { | |||
// clang-format off | |||
id_apc_actuation_threshold = 1, | |||
id_apc_release_threshold = 2 | |||
// clang-format on | |||
}; | |||
// Initializing persistent memory configuration: default values are declared and stored in PMEM | |||
void eeconfig_init_user(void) { | |||
// Default values | |||
apc.actuation_threshold = DEFAULT_ACTUATION_LEVEL; | |||
apc.release_threshold = DEFAULT_RELEASE_LEVEL; | |||
// Write default value to EEPROM now | |||
eeconfig_update_user_datablock(&apc); | |||
} | |||
// On Keyboard startup | |||
void keyboard_post_init_user(void) { | |||
// Read custom menu variables from memory | |||
eeconfig_read_user_datablock(&apc); | |||
apc_init_thresholds(); | |||
} | |||
// Handle the data received by the keyboard from the VIA menus | |||
void apc_config_set_value(uint8_t *data) { | |||
// data = [ value_id, value_data ] | |||
uint8_t *value_id = &(data[0]); | |||
uint8_t *value_data = &(data[1]); | |||
switch (*value_id) { | |||
case id_apc_actuation_threshold: { | |||
apc.actuation_threshold = value_data[1] | (value_data[0] << 8); | |||
apc_set_threshold(true); | |||
break; | |||
} | |||
case id_apc_release_threshold: { | |||
apc.release_threshold = value_data[1] | (value_data[0] << 8); | |||
apc_set_threshold(false); | |||
break; | |||
} | |||
} | |||
} | |||
// Handle the data sent by the keyboard to the VIA menus | |||
void apc_config_get_value(uint8_t *data) { | |||
// data = [ value_id, value_data ] | |||
uint8_t *value_id = &(data[0]); | |||
uint8_t *value_data = &(data[1]); | |||
switch (*value_id) { | |||
case id_apc_actuation_threshold: { | |||
value_data[0] = apc.actuation_threshold >> 8; | |||
value_data[1] = apc.actuation_threshold & 0xFF; | |||
break; | |||
} | |||
case id_apc_release_threshold: { | |||
value_data[0] = apc.release_threshold >> 8; | |||
value_data[1] = apc.release_threshold & 0xFF; | |||
break; | |||
} | |||
} | |||
} | |||
// Save the data to persistent memory after changes are made | |||
void apc_config_save(void) { | |||
eeconfig_update_user_datablock(&apc); | |||
} | |||
void via_custom_value_command_kb(uint8_t *data, uint8_t length) { | |||
// data = [ command_id, channel_id, value_id, value_data ] | |||
uint8_t *command_id = &(data[0]); | |||
uint8_t *channel_id = &(data[1]); | |||
uint8_t *value_id_and_data = &(data[2]); | |||
if (*channel_id == id_custom_channel) { | |||
switch (*command_id) { | |||
case id_custom_set_value: { | |||
apc_config_set_value(value_id_and_data); | |||
break; | |||
} | |||
case id_custom_get_value: { | |||
apc_config_get_value(value_id_and_data); | |||
break; | |||
} | |||
case id_custom_save: { | |||
apc_config_save(); | |||
break; | |||
} | |||
default: { | |||
// Unhandled message. | |||
*command_id = id_unhandled; | |||
break; | |||
} | |||
} | |||
return; | |||
} | |||
*command_id = id_unhandled; | |||
} | |||
// Initialize the thresholds | |||
void apc_init_thresholds(void) { | |||
ecsm_config.ecsm_actuation_threshold = apc.actuation_threshold; | |||
ecsm_config.ecsm_release_threshold = apc.release_threshold; | |||
// Update the ecsm_config | |||
ecsm_update(&ecsm_config); | |||
} | |||
// Set the thresholds | |||
void apc_set_threshold(bool is_for_actuation) { | |||
if (is_for_actuation) { | |||
ecsm_config.ecsm_actuation_threshold = apc.actuation_threshold; | |||
} else { | |||
ecsm_config.ecsm_release_threshold = apc.release_threshold; | |||
} | |||
// Update the ecsm_config | |||
ecsm_update(&ecsm_config); | |||
} |
@ -1,44 +0,0 @@ | |||
/* 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 "matrix.h" | |||
/* matrix state(1:on, 0:off) */ | |||
extern matrix_row_t raw_matrix[MATRIX_ROWS]; // raw values | |||
extern matrix_row_t matrix[MATRIX_ROWS]; // debounced values | |||
void matrix_init_custom(void) { | |||
// Default values, overwritten by VIA if enabled later | |||
ecsm_config.ecsm_actuation_threshold = DEFAULT_ACTUATION_LEVEL; | |||
ecsm_config.ecsm_release_threshold = DEFAULT_RELEASE_LEVEL; | |||
ecsm_init(&ecsm_config); | |||
} | |||
bool matrix_scan_custom(matrix_row_t current_matrix[]) { | |||
bool updated = ecsm_matrix_scan(current_matrix); | |||
// RAW matrix values on console | |||
#ifdef CONSOLE_ENABLE | |||
static int cnt = 0; | |||
if (cnt++ == 350) { | |||
cnt = 0; | |||
ecsm_print_matrix(); | |||
} | |||
#endif | |||
return updated; | |||
} |
@ -0,0 +1,3 @@ | |||
ifeq ($(strip $(VIA_ENABLE)), yes) | |||
SRC += keyboards/cipulot/common/via_ec.c | |||
endif |
@ -1,4 +1,4 @@ | |||
CUSTOM_MATRIX = lite | |||
SRC += matrix.c ec_switch_matrix.c | |||
ANALOG_DRIVER_REQUIRED = yes | |||
SRC += keyboards/cipulot/common/matrix.c keyboards/cipulot/common/ec_board.c keyboards/cipulot/common/ec_switch_matrix.c | |||
OPT = 3 |
@ -1,183 +0,0 @@ | |||
/* 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_0); | |||
writePinLow(APLEX_EN_PIN_0); | |||
setPinOutput(APLEX_EN_PIN_1); | |||
writePinLow(APLEX_EN_PIN_1); | |||
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 | |||
if (channel == 0) { | |||
writePinHigh(APLEX_EN_PIN_0); | |||
select_mux(col); | |||
writePinLow(APLEX_EN_PIN_0); | |||
} else { | |||
writePinHigh(APLEX_EN_PIN_1); | |||
select_mux(col); | |||
writePinLow(APLEX_EN_PIN_1); | |||
} | |||
// 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; | |||
// Disable AMUX of channel 1 | |||
writePinHigh(APLEX_EN_PIN_1); | |||
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(¤t_matrix[row], row, col, ecsm_sw_value[row][col]); | |||
} | |||
} | |||
// Disable AMUX of channel 1 | |||
writePinHigh(APLEX_EN_PIN_0); | |||
for (int col = 0; col < sizeof(col_channels); col++) { | |||
for (int row = 0; row < MATRIX_ROWS; row++) { | |||
ecsm_sw_value[row][col + 8] = ecsm_readkey_raw(1, row, col); | |||
updated |= ecsm_update_key(¤t_matrix[row], row, col + 8, ecsm_sw_value[row][col + 8]); | |||
} | |||
} | |||
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"); | |||
} |
@ -1,36 +0,0 @@ | |||
/* 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); |
@ -1,3 +1 @@ | |||
VIA_ENABLE = yes | |||
SRC += via_apc.c |
@ -1,156 +0,0 @@ | |||
/* 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 "action.h" | |||
#include "via.h" | |||
void apc_init_thresholds(void); | |||
void apc_set_threshold(bool is_for_actuation); | |||
// Declaring an _apc_config_t struct that will store our data | |||
typedef struct _apc_config_t { | |||
uint16_t actuation_threshold; | |||
uint16_t release_threshold; | |||
} apc_config; | |||
// Check if the size of the reserved persistent memory is the same as the size of struct apc_config | |||
_Static_assert(sizeof(apc_config) == EECONFIG_USER_DATA_SIZE, "Mismatch in keyboard EECONFIG stored data"); | |||
// Declaring a new variable apc of type apc_config | |||
apc_config apc; | |||
// Declaring enums for VIA config menu | |||
enum via_apc_enums { | |||
// clang-format off | |||
id_apc_actuation_threshold = 1, | |||
id_apc_release_threshold = 2 | |||
// clang-format on | |||
}; | |||
// Initializing persistent memory configuration: default values are declared and stored in PMEM | |||
void eeconfig_init_user(void) { | |||
// Default values | |||
apc.actuation_threshold = DEFAULT_ACTUATION_LEVEL; | |||
apc.release_threshold = DEFAULT_RELEASE_LEVEL; | |||
// Write default value to EEPROM now | |||
eeconfig_update_user_datablock(&apc); | |||
} | |||
// On Keyboard startup | |||
void keyboard_post_init_user(void) { | |||
// Read custom menu variables from memory | |||
eeconfig_read_user_datablock(&apc); | |||
apc_init_thresholds(); | |||
} | |||
// Handle the data received by the keyboard from the VIA menus | |||
void apc_config_set_value(uint8_t *data) { | |||
// data = [ value_id, value_data ] | |||
uint8_t *value_id = &(data[0]); | |||
uint8_t *value_data = &(data[1]); | |||
switch (*value_id) { | |||
case id_apc_actuation_threshold: { | |||
apc.actuation_threshold = value_data[1] | (value_data[0] << 8); | |||
apc_set_threshold(true); | |||
break; | |||
} | |||
case id_apc_release_threshold: { | |||
apc.release_threshold = value_data[1] | (value_data[0] << 8); | |||
apc_set_threshold(false); | |||
break; | |||
} | |||
} | |||
} | |||
// Handle the data sent by the keyboard to the VIA menus | |||
void apc_config_get_value(uint8_t *data) { | |||
// data = [ value_id, value_data ] | |||
uint8_t *value_id = &(data[0]); | |||
uint8_t *value_data = &(data[1]); | |||
switch (*value_id) { | |||
case id_apc_actuation_threshold: { | |||
value_data[0] = apc.actuation_threshold >> 8; | |||
value_data[1] = apc.actuation_threshold & 0xFF; | |||
break; | |||
} | |||
case id_apc_release_threshold: { | |||
value_data[0] = apc.release_threshold >> 8; | |||
value_data[1] = apc.release_threshold & 0xFF; | |||
break; | |||
} | |||
} | |||
} | |||
// Save the data to persistent memory after changes are made | |||
void apc_config_save(void) { | |||
eeconfig_update_user_datablock(&apc); | |||
} | |||
void via_custom_value_command_kb(uint8_t *data, uint8_t length) { | |||
// data = [ command_id, channel_id, value_id, value_data ] | |||
uint8_t *command_id = &(data[0]); | |||
uint8_t *channel_id = &(data[1]); | |||
uint8_t *value_id_and_data = &(data[2]); | |||
if (*channel_id == id_custom_channel) { | |||
switch (*command_id) { | |||
case id_custom_set_value: { | |||
apc_config_set_value(value_id_and_data); | |||
break; | |||
} | |||
case id_custom_get_value: { | |||
apc_config_get_value(value_id_and_data); | |||
break; | |||
} | |||
case id_custom_save: { | |||
apc_config_save(); | |||
break; | |||
} | |||
default: { | |||
// Unhandled message. | |||
*command_id = id_unhandled; | |||
break; | |||
} | |||
} | |||
return; | |||
} | |||
*command_id = id_unhandled; | |||
} | |||
// Initialize the thresholds | |||
void apc_init_thresholds(void) { | |||
ecsm_config.ecsm_actuation_threshold = apc.actuation_threshold; | |||
ecsm_config.ecsm_release_threshold = apc.release_threshold; | |||
// Update the ecsm_config | |||
ecsm_update(&ecsm_config); | |||
} | |||
// Set the thresholds | |||
void apc_set_threshold(bool is_for_actuation) { | |||
if (is_for_actuation) { | |||
ecsm_config.ecsm_actuation_threshold = apc.actuation_threshold; | |||
} else { | |||
ecsm_config.ecsm_release_threshold = apc.release_threshold; | |||
} | |||
// Update the ecsm_config | |||
ecsm_update(&ecsm_config); | |||
} |
@ -1,44 +0,0 @@ | |||
/* 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 "matrix.h" | |||
/* matrix state(1:on, 0:off) */ | |||
extern matrix_row_t raw_matrix[MATRIX_ROWS]; // raw values | |||
extern matrix_row_t matrix[MATRIX_ROWS]; // debounced values | |||
void matrix_init_custom(void) { | |||
// Default values, overwritten by VIA if enabled later | |||
ecsm_config.ecsm_actuation_threshold = DEFAULT_ACTUATION_LEVEL; | |||
ecsm_config.ecsm_release_threshold = DEFAULT_RELEASE_LEVEL; | |||
ecsm_init(&ecsm_config); | |||
} | |||
bool matrix_scan_custom(matrix_row_t current_matrix[]) { | |||
bool updated = ecsm_matrix_scan(current_matrix); | |||
// RAW matrix values on console | |||
#ifdef CONSOLE_ENABLE | |||
static int cnt = 0; | |||
if (cnt++ == 350) { | |||
cnt = 0; | |||
ecsm_print_matrix(); | |||
} | |||
#endif | |||
return updated; | |||
} |
@ -0,0 +1,3 @@ | |||
ifeq ($(strip $(VIA_ENABLE)), yes) | |||
SRC += keyboards/cipulot/common/via_ec.c | |||
endif |
@ -1,4 +1,4 @@ | |||
CUSTOM_MATRIX = lite | |||
SRC += matrix.c ec_switch_matrix.c | |||
ANALOG_DRIVER_REQUIRED = yes | |||
SRC += keyboards/cipulot/common/matrix.c keyboards/cipulot/common/ec_board.c keyboards/cipulot/common/ec_switch_matrix.c | |||
OPT = 3 |
@ -1,183 +0,0 @@ | |||
/* 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_0); | |||
writePinLow(APLEX_EN_PIN_0); | |||
setPinOutput(APLEX_EN_PIN_1); | |||
writePinLow(APLEX_EN_PIN_1); | |||
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 | |||
if (channel == 0) { | |||
writePinHigh(APLEX_EN_PIN_0); | |||
select_mux(col); | |||
writePinLow(APLEX_EN_PIN_0); | |||
} else { | |||
writePinHigh(APLEX_EN_PIN_1); | |||
select_mux(col); | |||
writePinLow(APLEX_EN_PIN_1); | |||
} | |||
// 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; | |||
// Disable AMUX of channel 1 | |||
writePinHigh(APLEX_EN_PIN_1); | |||
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(¤t_matrix[row], row, col, ecsm_sw_value[row][col]); | |||
} | |||
} | |||
// Disable AMUX of channel 1 | |||
writePinHigh(APLEX_EN_PIN_0); | |||
for (int col = 0; col < (sizeof(col_channels) - 1); col++) { | |||
for (int row = 0; row < MATRIX_ROWS; row++) { | |||
ecsm_sw_value[row][col + 8] = ecsm_readkey_raw(1, row, col); | |||
updated |= ecsm_update_key(¤t_matrix[row], row, col + 8, ecsm_sw_value[row][col + 8]); | |||
} | |||
} | |||
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"); | |||
} |
@ -1,36 +0,0 @@ | |||
/* 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); |
@ -1,3 +1 @@ | |||
VIA_ENABLE = yes | |||
SRC += via_apc.c |
@ -1,156 +0,0 @@ | |||
/* 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 "action.h" | |||
#include "via.h" | |||
void apc_init_thresholds(void); | |||
void apc_set_threshold(bool is_for_actuation); | |||
// Declaring an _apc_config_t struct that will store our data | |||
typedef struct _apc_config_t { | |||
uint16_t actuation_threshold; | |||
uint16_t release_threshold; | |||
} apc_config; | |||
// Check if the size of the reserved persistent memory is the same as the size of struct apc_config | |||
_Static_assert(sizeof(apc_config) == EECONFIG_USER_DATA_SIZE, "Mismatch in keyboard EECONFIG stored data"); | |||
// Declaring a new variable apc of type apc_config | |||
apc_config apc; | |||
// Declaring enums for VIA config menu | |||
enum via_apc_enums { | |||
// clang-format off | |||
id_apc_actuation_threshold = 1, | |||
id_apc_release_threshold = 2 | |||
// clang-format on | |||
}; | |||
// Initializing persistent memory configuration: default values are declared and stored in PMEM | |||
void eeconfig_init_user(void) { | |||
// Default values | |||
apc.actuation_threshold = DEFAULT_ACTUATION_LEVEL; | |||
apc.release_threshold = DEFAULT_RELEASE_LEVEL; | |||
// Write default value to EEPROM now | |||
eeconfig_update_user_datablock(&apc); | |||
} | |||
// On Keyboard startup | |||
void keyboard_post_init_user(void) { | |||
// Read custom menu variables from memory | |||
eeconfig_read_user_datablock(&apc); | |||
apc_init_thresholds(); | |||
} | |||
// Handle the data received by the keyboard from the VIA menus | |||
void apc_config_set_value(uint8_t *data) { | |||
// data = [ value_id, value_data ] | |||
uint8_t *value_id = &(data[0]); | |||
uint8_t *value_data = &(data[1]); | |||
switch (*value_id) { | |||
case id_apc_actuation_threshold: { | |||
apc.actuation_threshold = value_data[1] | (value_data[0] << 8); | |||
apc_set_threshold(true); | |||
break; | |||
} | |||
case id_apc_release_threshold: { | |||
apc.release_threshold = value_data[1] | (value_data[0] << 8); | |||
apc_set_threshold(false); | |||
break; | |||
} | |||
} | |||
} | |||
// Handle the data sent by the keyboard to the VIA menus | |||
void apc_config_get_value(uint8_t *data) { | |||
// data = [ value_id, value_data ] | |||
uint8_t *value_id = &(data[0]); | |||
uint8_t *value_data = &(data[1]); | |||
switch (*value_id) { | |||
case id_apc_actuation_threshold: { | |||
value_data[0] = apc.actuation_threshold >> 8; | |||
value_data[1] = apc.actuation_threshold & 0xFF; | |||
break; | |||
} | |||
case id_apc_release_threshold: { | |||
value_data[0] = apc.release_threshold >> 8; | |||
value_data[1] = apc.release_threshold & 0xFF; | |||
break; | |||
} | |||
} | |||
} | |||
// Save the data to persistent memory after changes are made | |||
void apc_config_save(void) { | |||
eeconfig_update_user_datablock(&apc); | |||
} | |||
void via_custom_value_command_kb(uint8_t *data, uint8_t length) { | |||
// data = [ command_id, channel_id, value_id, value_data ] | |||
uint8_t *command_id = &(data[0]); | |||
uint8_t *channel_id = &(data[1]); | |||
uint8_t *value_id_and_data = &(data[2]); | |||
if (*channel_id == id_custom_channel) { | |||
switch (*command_id) { | |||
case id_custom_set_value: { | |||
apc_config_set_value(value_id_and_data); | |||
break; | |||
} | |||
case id_custom_get_value: { | |||
apc_config_get_value(value_id_and_data); | |||
break; | |||
} | |||
case id_custom_save: { | |||
apc_config_save(); | |||
break; | |||
} | |||
default: { | |||
// Unhandled message. | |||
*command_id = id_unhandled; | |||
break; | |||
} | |||
} | |||
return; | |||
} | |||
*command_id = id_unhandled; | |||
} | |||
// Initialize the thresholds | |||
void apc_init_thresholds(void) { | |||
ecsm_config.ecsm_actuation_threshold = apc.actuation_threshold; | |||
ecsm_config.ecsm_release_threshold = apc.release_threshold; | |||
// Update the ecsm_config | |||
ecsm_update(&ecsm_config); | |||
} | |||
// Set the thresholds | |||
void apc_set_threshold(bool is_for_actuation) { | |||
if (is_for_actuation) { | |||
ecsm_config.ecsm_actuation_threshold = apc.actuation_threshold; | |||
} else { | |||
ecsm_config.ecsm_release_threshold = apc.release_threshold; | |||
} | |||
// Update the ecsm_config | |||
ecsm_update(&ecsm_config); | |||
} |
@ -1,44 +0,0 @@ | |||
/* 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 "matrix.h" | |||
/* matrix state(1:on, 0:off) */ | |||
extern matrix_row_t raw_matrix[MATRIX_ROWS]; // raw values | |||
extern matrix_row_t matrix[MATRIX_ROWS]; // debounced values | |||
void matrix_init_custom(void) { | |||
// Default values, overwritten by VIA if enabled later | |||
ecsm_config.ecsm_actuation_threshold = DEFAULT_ACTUATION_LEVEL; | |||
ecsm_config.ecsm_release_threshold = DEFAULT_RELEASE_LEVEL; | |||
ecsm_init(&ecsm_config); | |||
} | |||
bool matrix_scan_custom(matrix_row_t current_matrix[]) { | |||
bool updated = ecsm_matrix_scan(current_matrix); | |||
// RAW matrix values on console | |||
#ifdef CONSOLE_ENABLE | |||
static int cnt = 0; | |||
if (cnt++ == 350) { | |||
cnt = 0; | |||
ecsm_print_matrix(); | |||
} | |||
#endif | |||
return updated; | |||
} |
@ -0,0 +1,3 @@ | |||
ifeq ($(strip $(VIA_ENABLE)), yes) | |||
SRC += keyboards/cipulot/common/via_ec.c | |||
endif |
@ -1,4 +1,4 @@ | |||
CUSTOM_MATRIX = lite | |||
SRC += matrix.c ec_switch_matrix.c | |||
ANALOG_DRIVER_REQUIRED = yes | |||
SRC += keyboards/cipulot/common/matrix.c keyboards/cipulot/common/ec_board.c keyboards/cipulot/common/ec_switch_matrix.c | |||
OPT = 2 |
@ -1,183 +0,0 @@ | |||
/* 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_0); | |||
writePinLow(APLEX_EN_PIN_0); | |||
setPinOutput(APLEX_EN_PIN_1); | |||
writePinLow(APLEX_EN_PIN_1); | |||
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 | |||
if (channel == 0) { | |||
writePinHigh(APLEX_EN_PIN_0); | |||
select_mux(col); | |||
writePinLow(APLEX_EN_PIN_0); | |||
} else { | |||
writePinHigh(APLEX_EN_PIN_1); | |||
select_mux(col); | |||
writePinLow(APLEX_EN_PIN_1); | |||
} | |||
// 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; | |||
// Disable AMUX of channel 1 | |||
writePinHigh(APLEX_EN_PIN_1); | |||
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(¤t_matrix[row], row, col, ecsm_sw_value[row][col]); | |||
} | |||
} | |||
// Disable AMUX of channel 1 | |||
writePinHigh(APLEX_EN_PIN_0); | |||
for (int col = 0; col < (sizeof(col_channels) - 1); col++) { | |||
for (int row = 0; row < MATRIX_ROWS; row++) { | |||
ecsm_sw_value[row][col + 8] = ecsm_readkey_raw(1, row, col); | |||
updated |= ecsm_update_key(¤t_matrix[row], row, col + 8, ecsm_sw_value[row][col + 8]); | |||
} | |||
} | |||
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"); | |||
} |
@ -1,36 +0,0 @@ | |||
/* 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); |
@ -1,3 +1 @@ | |||
VIA_ENABLE = yes | |||
SRC += via_apc.c |
@ -1,156 +0,0 @@ | |||
/* 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 "action.h" | |||
#include "via.h" | |||
void apc_init_thresholds(void); | |||
void apc_set_threshold(bool is_for_actuation); | |||
// Declaring an _apc_config_t struct that will store our data | |||
typedef struct _apc_config_t { | |||
uint16_t actuation_threshold; | |||
uint16_t release_threshold; | |||
} apc_config; | |||
// Check if the size of the reserved persistent memory is the same as the size of struct apc_config | |||
_Static_assert(sizeof(apc_config) == EECONFIG_USER_DATA_SIZE, "Mismatch in keyboard EECONFIG stored data"); | |||
// Declaring a new variable apc of type apc_config | |||
apc_config apc; | |||
// Declaring enums for VIA config menu | |||
enum via_apc_enums { | |||
// clang-format off | |||
id_apc_actuation_threshold = 1, | |||
id_apc_release_threshold = 2 | |||
// clang-format on | |||
}; | |||
// Initializing persistent memory configuration: default values are declared and stored in PMEM | |||
void eeconfig_init_user(void) { | |||
// Default values | |||
apc.actuation_threshold = DEFAULT_ACTUATION_LEVEL; | |||
apc.release_threshold = DEFAULT_RELEASE_LEVEL; | |||
// Write default value to EEPROM now | |||
eeconfig_update_user_datablock(&apc); | |||
} | |||
// On Keyboard startup | |||
void keyboard_post_init_user(void) { | |||
// Read custom menu variables from memory | |||
eeconfig_read_user_datablock(&apc); | |||
apc_init_thresholds(); | |||
} | |||
// Handle the data received by the keyboard from the VIA menus | |||
void apc_config_set_value(uint8_t *data) { | |||
// data = [ value_id, value_data ] | |||
uint8_t *value_id = &(data[0]); | |||
uint8_t *value_data = &(data[1]); | |||
switch (*value_id) { | |||
case id_apc_actuation_threshold: { | |||
apc.actuation_threshold = value_data[1] | (value_data[0] << 8); | |||
apc_set_threshold(true); | |||
break; | |||
} | |||
case id_apc_release_threshold: { | |||
apc.release_threshold = value_data[1] | (value_data[0] << 8); | |||
apc_set_threshold(false); | |||
break; | |||
} | |||
} | |||
} | |||
// Handle the data sent by the keyboard to the VIA menus | |||
void apc_config_get_value(uint8_t *data) { | |||
// data = [ value_id, value_data ] | |||
uint8_t *value_id = &(data[0]); | |||
uint8_t *value_data = &(data[1]); | |||
switch (*value_id) { | |||
case id_apc_actuation_threshold: { | |||
value_data[0] = apc.actuation_threshold >> 8; | |||
value_data[1] = apc.actuation_threshold & 0xFF; | |||
break; | |||
} | |||
case id_apc_release_threshold: { | |||
value_data[0] = apc.release_threshold >> 8; | |||
value_data[1] = apc.release_threshold & 0xFF; | |||
break; | |||
} | |||
} | |||
} | |||
// Save the data to persistent memory after changes are made | |||
void apc_config_save(void) { | |||
eeconfig_update_user_datablock(&apc); | |||
} | |||
void via_custom_value_command_kb(uint8_t *data, uint8_t length) { | |||
// data = [ command_id, channel_id, value_id, value_data ] | |||
uint8_t *command_id = &(data[0]); | |||
uint8_t *channel_id = &(data[1]); | |||
uint8_t *value_id_and_data = &(data[2]); | |||
if (*channel_id == id_custom_channel) { | |||
switch (*command_id) { | |||
case id_custom_set_value: { | |||
apc_config_set_value(value_id_and_data); | |||
break; | |||
} | |||
case id_custom_get_value: { | |||
apc_config_get_value(value_id_and_data); | |||
break; | |||
} | |||
case id_custom_save: { | |||
apc_config_save(); | |||
break; | |||
} | |||
default: { | |||
// Unhandled message. | |||
*command_id = id_unhandled; | |||
break; | |||
} | |||
} | |||
return; | |||
} | |||
*command_id = id_unhandled; | |||
} | |||
// Initialize the thresholds | |||
void apc_init_thresholds(void) { | |||
ecsm_config.ecsm_actuation_threshold = apc.actuation_threshold; | |||
ecsm_config.ecsm_release_threshold = apc.release_threshold; | |||
// Update the ecsm_config | |||
ecsm_update(&ecsm_config); | |||
} | |||
// Set the thresholds | |||
void apc_set_threshold(bool is_for_actuation) { | |||
if (is_for_actuation) { | |||
ecsm_config.ecsm_actuation_threshold = apc.actuation_threshold; | |||
} else { | |||
ecsm_config.ecsm_release_threshold = apc.release_threshold; | |||
} | |||
// Update the ecsm_config | |||
ecsm_update(&ecsm_config); | |||
} |
@ -1,44 +0,0 @@ | |||
/* 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 "matrix.h" | |||
/* matrix state(1:on, 0:off) */ | |||
extern matrix_row_t raw_matrix[MATRIX_ROWS]; // raw values | |||
extern matrix_row_t matrix[MATRIX_ROWS]; // debounced values | |||
void matrix_init_custom(void) { | |||
// Default values, overwritten by VIA if enabled later | |||
ecsm_config.ecsm_actuation_threshold = DEFAULT_ACTUATION_LEVEL; | |||
ecsm_config.ecsm_release_threshold = DEFAULT_RELEASE_LEVEL; | |||
ecsm_init(&ecsm_config); | |||
} | |||
bool matrix_scan_custom(matrix_row_t current_matrix[]) { | |||
bool updated = ecsm_matrix_scan(current_matrix); | |||
// RAW matrix values on console | |||
#ifdef CONSOLE_ENABLE | |||
static int cnt = 0; | |||
if (cnt++ == 350) { | |||
cnt = 0; | |||
ecsm_print_matrix(); | |||
} | |||
#endif | |||
return updated; | |||
} |
@ -0,0 +1,3 @@ | |||
ifeq ($(strip $(VIA_ENABLE)), yes) | |||
SRC += keyboards/cipulot/common/via_ec.c | |||
endif |