From b72a1aa3fec986bfa7e439b68d6b7546ab1e280b Mon Sep 17 00:00:00 2001 From: "Dustin L. Howett" Date: Sun, 1 Mar 2020 21:17:09 -0800 Subject: Rewrite the Bathroom Epiphanies Frosty Flake matrix and LED handling (#8243) * Keyboard: revamp frosty-flake leds This commit transitions bpiphany/frosty_flake to led_update_{kb,user} and rewrites the AVR bit twiddling logic to use the standard QMK GPIO API. * Keyboard: rewrite frosty_flake's matrix reader to be a lite custom matrix This commit replaces frosty_flake's custom matrix and debounce logic with a "lite" custom matrix. In addition to being somewhat clearer, this allows a consumer of the flake board to choose their own debouncing algorithm. The one closest to the implementation originally in use is sym_g, but this opens us up to supporting eager_pk and eager_pr. The original matrix code was 18 columns for 8 rows, but using a single row read and unpacking the bits into individual columns. To simplify, I've changed the key layout to be 8C 18R instead of 18C 8R: this lets us use a single read directly into the matrix _and_ drop down to a uint8_t instead of a uint32_t for matrix_row_t. Since we're no longer implementing our own debouncing and row unpacking, we save ~400 bytes on the final firmware image. Fully tested against a CM Storm QFR hosting the flake -- this commit message was written using the new matrix code. Firmware Sizes (assuming stock configuration as of 42d6270f2) Matrix+Debounce Size (bytes) --------------- ------------ original 17740 new + sym_g 17284 new + eager_pr 18106 new + eager_pk 18204 I expect that there are some scanning speed benefits as well. * Keyboard: update frosty_flake's UNUSED_PINS * Keyboard: Remove meaningless weak redefinitions from frosty These are not necessary (and all of them already live somewhere in Quantum). --- keyboards/bpiphany/frosty_flake/config.h | 6 +- keyboards/bpiphany/frosty_flake/frosty_flake.c | 73 ++++------------- keyboards/bpiphany/frosty_flake/frosty_flake.h | 58 +++++++++----- keyboards/bpiphany/frosty_flake/matrix.c | 106 +++++-------------------- keyboards/bpiphany/frosty_flake/rules.mk | 2 +- 5 files changed, 77 insertions(+), 168 deletions(-) diff --git a/keyboards/bpiphany/frosty_flake/config.h b/keyboards/bpiphany/frosty_flake/config.h index 250a1b775b..79bc31aec6 100644 --- a/keyboards/bpiphany/frosty_flake/config.h +++ b/keyboards/bpiphany/frosty_flake/config.h @@ -36,13 +36,13 @@ along with this program. If not, see . */ /* key matrix size */ -#define MATRIX_ROWS 8 // Row0 - Row7 in the schematic -#define MATRIX_COLS 18 // ColA - ColR in the schematic +#define MATRIX_ROWS 18 // ColA - ColR in the schematic +#define MATRIX_COLS 8 // Row0 - Row7 in the schematic /* * Keyboard Matrix Assignments */ -#define UNUSED_PINS { B0, C4, D3 } +#define UNUSED_PINS { C0, C1, C2, C3, C4, D2, D7 } /* Debounce reduces chatter (unintended double-presses) - set 0 if debouncing is not needed */ #define DEBOUNCE 5 diff --git a/keyboards/bpiphany/frosty_flake/frosty_flake.c b/keyboards/bpiphany/frosty_flake/frosty_flake.c index 1cd4760389..be4e1a3124 100644 --- a/keyboards/bpiphany/frosty_flake/frosty_flake.c +++ b/keyboards/bpiphany/frosty_flake/frosty_flake.c @@ -1,63 +1,24 @@ #include "frosty_flake.h" -void matrix_init_kb(void) { - // put your keyboard start-up code here - // runs once when the firmware starts up - - matrix_init_user(); +void keyboard_pre_init_kb() { + setPinOutput(B7); // num lock + writePinHigh(B7); + setPinOutput(C5); // caps lock + writePinHigh(C7); + setPinOutput(C6); // scroll lock + writePinHigh(C6); + + keyboard_pre_init_user(); } -void matrix_scan_kb(void) { - // put your looping keyboard code here - // runs every cycle (a lot) - - matrix_scan_user(); -} +bool led_update_kb(led_t usb_led) { + // user requests no further processing + if (!led_update_user(usb_led)) + return true; -bool process_record_kb(uint16_t keycode, keyrecord_t *record) { - // put your per-action keyboard code here - // runs for every action, just before processing by the firmware + writePin(C5, !usb_led.caps_lock); + writePin(B7, !usb_led.num_lock); + writePin(C6, !usb_led.scroll_lock); - return process_record_user(keycode, record); + return true; } - -void led_set_kb(uint8_t usb_led) { - DDRB |= (1<<7); - DDRC |= (1<<5) | (1<<6); - - print_dec(usb_led); - - if (usb_led & (1<. */ -#include -#include -#include #include -#include "print.h" -#include "debug.h" -#include "util.h" #include "matrix.h" -#ifndef DEBOUNCE -# define DEBOUNCE 5 -#endif -static uint8_t debouncing = DEBOUNCE; - -static matrix_row_t matrix[MATRIX_ROWS]; -static matrix_row_t matrix_debouncing[MATRIX_ROWS]; - -__attribute__ ((weak)) -void matrix_init_kb(void) { - matrix_init_user(); -} - -__attribute__ ((weak)) -void matrix_scan_kb(void) { - matrix_scan_user(); -} - -__attribute__ ((weak)) -void matrix_init_user(void) { -} - -__attribute__ ((weak)) -void matrix_scan_user(void) { -} - static matrix_row_t scan_col(void) { + // Each of the 8 columns is read off pins as below + // 7 6 5 4 3 2 1 0 + // ,--,--,--,--,--,--,--,--, + // |B0|B3|B2|B1|B6|B4|B5|C7| + // `--`--`--`--`--`--`--`--` return ( (PINC&(1<<7) ? 0 : ((matrix_row_t)1<<0)) | (PINB&(1<<5) ? 0 : ((matrix_row_t)1<<1)) | @@ -63,8 +36,8 @@ static matrix_row_t scan_col(void) { ); } -static void select_col(uint8_t col) { - switch (col) { +static void select_row(uint8_t row) { + switch (row) { case 0: PORTD = (PORTD & ~0b01111011) | 0b00011011; break; case 1: PORTD = (PORTD & ~0b01111011) | 0b01000011; break; case 2: PORTD = (PORTD & ~0b01111011) | 0b01101010; break; @@ -86,7 +59,7 @@ static void select_col(uint8_t col) { } } -void matrix_init(void) { +void matrix_init_custom(void) { /* Row output pins */ DDRD |= 0b01111011; /* Column input pins */ @@ -94,62 +67,19 @@ void matrix_init(void) { DDRB &= ~0b01111111; PORTC |= 0b10000000; PORTB |= 0b01111111; - - for (uint8_t i=0; i < MATRIX_ROWS; i++) - matrix[i] = matrix_debouncing[i] = 0; - - matrix_init_quantum(); } -uint8_t matrix_scan(void) { - for (uint8_t col = 0; col < MATRIX_COLS; col++) { - select_col(col); - _delay_us(3); - matrix_row_t col_scan = scan_col(); - for (uint8_t row = 0; row < MATRIX_ROWS; row++) { - bool prev_bit = matrix_debouncing[row] & ((matrix_row_t)1<