mirrors/qmk_firmware
1
0
Fork 1
mirror of https://github.com/qmk/qmk_firmware synced 2024-11-18 18:04:57 +00:00
Code Issues Projects Releases Packages Wiki Activity

[Keyboard] Convert ErgoDox EZ to Matrix Lite (#10189)

Browse source 
* Convert ErgoDox EZ to lite matrix

* Add initial config from Dactyl config

Based on ErinCall's work to generalize the mcp i/o expander matrix code

* formatting

* Fix number of pins

* Remove unused defines
This commit is contained in:
Drashna Jaelre 2020-09-30 16:52:47 -07:00 committed by GitHub
parent 482c9fbbf2
commit 11c308d436
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
5 changed files with 147 additions and 214 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
keyboards/ergodox_ez/config.h
View file

@ -32,6 +32,16 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
#define MATRIX_ROWS_PER_SIDE (MATRIX_ROWS / 2) #define MATRIX_ROWS_PER_SIDE (MATRIX_ROWS / 2)
#define MATRIX_COLS 6 #define MATRIX_COLS 6
#define COL_EXPANDED { true, true, true, true, true, true, true, false, false, false, false, false, false, false }
#define MATRIX_ONBOARD_ROW_PINS { 0, 0, 0, 0, 0, 0, 0, B0, B1, B2, B3, D2, D3, C6 }
#define MATRIX_ONBOARD_COL_PINS { F0, F1, F4, F5, F6, F7 }
#define DIODE_DIRECTION COL2ROW
#define EXPANDER_COL_REGISTER GPIOB
#define EXPANDER_ROW_REGISTER GPIOA
#define MATRIX_EXPANDER_COL_PINS { 5, 4, 3, 2, 1, 0 }
#define MATRIX_EXPANDER_ROW_PINS { 0, 1, 2, 3, 4, 5, 6 }
#define MOUSEKEY_INTERVAL 20 #define MOUSEKEY_INTERVAL 20
#define MOUSEKEY_DELAY 0 #define MOUSEKEY_DELAY 0
#define MOUSEKEY_TIME_TO_MAX 60 #define MOUSEKEY_TIME_TO_MAX 60

2
keyboards/ergodox_ez/ergodox_ez.c
View file

@ -1,4 +1,4 @@
#include QMK_KEYBOARD_H #include "ergodox_ez.h"
extern inline void ergodox_board_led_on(void); extern inline void ergodox_board_led_on(void);
extern inline void ergodox_right_led_1_on(void); extern inline void ergodox_right_led_1_on(void);

4
keyboards/ergodox_ez/ergodox_ez.h
View file

@ -4,10 +4,6 @@
#include <stdint.h> #include <stdint.h>
#include <stdbool.h> #include <stdbool.h>
#include "i2c_master.h" #include "i2c_master.h"
#include <util/delay.h>
#define CPU_PRESCALE(n) (CLKPR = 0x80, CLKPR = (n))
#define CPU_16MHz 0x00
// I2C aliases and register addresses (see "mcp23018.md") // I2C aliases and register addresses (see "mcp23018.md")
#define I2C_ADDR 0b0100000 #define I2C_ADDR 0b0100000

325
keyboards/ergodox_ez/matrix.c
View file

@ -30,7 +30,8 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
#include "util.h" #include "util.h"
#include "matrix.h" #include "matrix.h"
#include "debounce.h" #include "debounce.h"
#include QMK_KEYBOARD_H #include "ergodox_ez.h"
/* /*
* This constant define not debouncing time in msecs, assuming eager_pr. * This constant define not debouncing time in msecs, assuming eager_pr.
@ -45,8 +46,8 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
*/ */
/* matrix state(1:on, 0:off) */ /* matrix state(1:on, 0:off) */
static matrix_row_t raw_matrix[MATRIX_ROWS]; // raw values extern matrix_row_t matrix[MATRIX_ROWS]; // debounced values
static matrix_row_t matrix[MATRIX_ROWS]; // debounced values extern matrix_row_t raw_matrix[MATRIX_ROWS]; // raw values
static matrix_row_t read_cols(uint8_t row); static matrix_row_t read_cols(uint8_t row);
static void init_cols(void); static void init_cols(void);
@ -54,132 +55,62 @@ static void unselect_rows(void);
static void select_row(uint8_t row); static void select_row(uint8_t row);
static uint8_t mcp23018_reset_loop; static uint8_t mcp23018_reset_loop;
// static uint16_t mcp23018_reset_loop;
__attribute__((weak)) void matrix_init_user(void) {} void matrix_init_custom(void) {
// initialize row and col
__attribute__((weak)) void matrix_scan_user(void) {} mcp23018_status = init_mcp23018();
__attribute__((weak)) void matrix_init_kb(void) { matrix_init_user(); } unselect_rows();
init_cols();
__attribute__((weak)) void matrix_scan_kb(void) { matrix_scan_user(); }
inline uint8_t matrix_rows(void) { return MATRIX_ROWS; }
inline uint8_t matrix_cols(void) { return MATRIX_COLS; }
void matrix_init(void) {
// initialize row and col
mcp23018_status = init_mcp23018();
unselect_rows();
init_cols();
// initialize matrix state: all keys off
for (uint8_t i = 0; i < MATRIX_ROWS; i++) {
matrix[i] = 0;
raw_matrix[i] = 0;
}
debounce_init(MATRIX_ROWS);
matrix_init_quantum();
}
void matrix_power_up(void) {
mcp23018_status = init_mcp23018();
unselect_rows();
init_cols();
// initialize matrix state: all keys off
for (uint8_t i = 0; i < MATRIX_ROWS; i++) {
matrix[i] = 0;
}
} }
// Reads and stores a row, returning // Reads and stores a row, returning
// whether a change occurred. // whether a change occurred.
static inline bool store_raw_matrix_row(uint8_t index) { static inline bool store_raw_matrix_row(uint8_t index) {
matrix_row_t temp = read_cols(index); matrix_row_t temp = read_cols(index);
if (raw_matrix[index] != temp) { if (raw_matrix[index] != temp) {
raw_matrix[index] = temp; raw_matrix[index] = temp;
return true; return true;
} }
return false; return false;
} }
uint8_t matrix_scan(void) { bool matrix_scan_custom(matrix_row_t current_matrix[]) {
if (mcp23018_status) { // if there was an error if (mcp23018_status) { // if there was an error
if (++mcp23018_reset_loop == 0) { if (++mcp23018_reset_loop == 0) {
// if (++mcp23018_reset_loop >= 1300) { print("trying to reset mcp23018\n");
// since mcp23018_reset_loop is 8 bit - we'll try to reset once in 255 matrix scans mcp23018_status = init_mcp23018();
// this will be approx bit more frequent than once per second if (mcp23018_status) {
print("trying to reset mcp23018\n"); print("left side not responding\n");
mcp23018_status = init_mcp23018(); } else {
if (mcp23018_status) { print("left side attached\n");
print("left side not responding\n"); ergodox_blink_all_leds();
} else {
print("left side attached\n");
ergodox_blink_all_leds();
#ifdef RGB_MATRIX_ENABLE #ifdef RGB_MATRIX_ENABLE
rgb_matrix_init(); // re-init driver on reconnect rgb_matrix_init(); // re-init driver on reconnect
#endif #endif
} }
}
} }
}
#ifdef LEFT_LEDS #ifdef LEFT_LEDS
mcp23018_status = ergodox_left_leds_update(); mcp23018_status = ergodox_left_leds_update();
#endif // LEFT_LEDS #endif // LEFT_LEDS
bool changed = false; bool changed = false;
for (uint8_t i = 0; i < MATRIX_ROWS_PER_SIDE; i++) { for (uint8_t i = 0; i < MATRIX_ROWS_PER_SIDE; i++) {
// select rows from left and right hands // select rows from left and right hands
uint8_t left_index = i; uint8_t left_index = i;
uint8_t right_index = i + MATRIX_ROWS_PER_SIDE; uint8_t right_index = i + MATRIX_ROWS_PER_SIDE;
select_row(left_index); select_row(left_index);
select_row(right_index); select_row(right_index);
// we don't need a 30us delay anymore, because selecting a changed |= store_raw_matrix_row(left_index);
// left-hand row requires more than 30us for i2c. changed |= store_raw_matrix_row(right_index);
changed |= store_raw_matrix_row(left_index); unselect_rows();
changed |= store_raw_matrix_row(right_index); }
unselect_rows(); return changed;
}
debounce(raw_matrix, matrix, MATRIX_ROWS, changed);
matrix_scan_quantum();
return 1;
}
bool matrix_is_modified(void) // deprecated and evidently not called.
{
return true;
}
inline bool matrix_is_on(uint8_t row, uint8_t col) { return (matrix[row] & ((matrix_row_t)1 << col)); }
inline matrix_row_t matrix_get_row(uint8_t row) { return matrix[row]; }
void matrix_print(void) {
print("\nr/c 0123456789ABCDEF\n");
for (uint8_t row = 0; row < MATRIX_ROWS; row++) {
phex(row);
print(": ");
pbin_reverse16(matrix_get_row(row));
print("\n");
}
}
uint8_t matrix_key_count(void) {
uint8_t count = 0;
for (uint8_t i = 0; i < MATRIX_ROWS; i++) {
count += bitpop16(matrix[i]);
}
return count;
} }
/* Column pin configuration /* Column pin configuration
@ -193,42 +124,43 @@ uint8_t matrix_key_count(void) {
* pin: B5 B4 B3 B2 B1 B0 * pin: B5 B4 B3 B2 B1 B0
*/ */
static void init_cols(void) { static void init_cols(void) {
// init on mcp23018 // init on mcp23018
// not needed, already done as part of init_mcp23018() // not needed, already done as part of init_mcp23018()
// init on teensy // init on teensy
// Input with pull-up(DDR:0, PORT:1) setPinInputHigh(F0);
DDRF &= ~(1 << 7 | 1 << 6 | 1 << 5 | 1 << 4 | 1 << 1 | 1 << 0); setPinInputHigh(F1);
PORTF |= (1 << 7 | 1 << 6 | 1 << 5 | 1 << 4 | 1 << 1 | 1 << 0); setPinInputHigh(F4);
setPinInputHigh(F5);
setPinInputHigh(F6);
setPinInputHigh(F7);
} }
static matrix_row_t read_cols(uint8_t row) { static matrix_row_t read_cols(uint8_t row) {
if (row < 7) { if (row < 7) {
if (mcp23018_status) { // if there was an error if (mcp23018_status) { // if there was an error
return 0; return 0;
} else {
uint8_t data = 0;
// reading GPIOB (column port) since in mcp23018's sequential mode
// it is addressed directly after writing to GPIOA in select_row()
mcp23018_status = i2c_start(I2C_ADDR_READ, ERGODOX_EZ_I2C_TIMEOUT); if (mcp23018_status) goto out;
mcp23018_status = i2c_read_nack(ERGODOX_EZ_I2C_TIMEOUT); if (mcp23018_status < 0) goto out;
data = ~((uint8_t)mcp23018_status);
mcp23018_status = I2C_STATUS_SUCCESS;
out:
i2c_stop();
return data;
}
} else { } else {
uint8_t data = 0; /* read from teensy
// reading GPIOB (column port) since in mcp23018's sequential mode * bitmask is 0b11110011, but we want those all
// it is addressed directly after writing to GPIOA in select_row() * in the lower six bits.
mcp23018_status = i2c_start(I2C_ADDR_READ, ERGODOX_EZ_I2C_TIMEOUT); * we'll return 1s for the top two, but that's harmless.
if (mcp23018_status) goto out; */
mcp23018_status = i2c_read_nack(ERGODOX_EZ_I2C_TIMEOUT);
if (mcp23018_status < 0) goto out;
data = ~((uint8_t)mcp23018_status);
mcp23018_status = I2C_STATUS_SUCCESS;
out:
i2c_stop();
return data;
}
} else {
/* read from teensy
* bitmask is 0b11110011, but we want those all
* in the lower six bits.
* we'll return 1s for the top two, but that's harmless.
*/
return ~((PINF & 0x03) | ((PINF & 0xF0) >> 2)); return ~((PINF & 0x03) | ((PINF & 0xF0) >> 2));
} }
} }
/* Row pin configuration /* Row pin configuration
@ -242,69 +174,64 @@ static matrix_row_t read_cols(uint8_t row) {
* pin: A0 A1 A2 A3 A4 A5 A6 * pin: A0 A1 A2 A3 A4 A5 A6
*/ */
static void unselect_rows(void) { static void unselect_rows(void) {
// no need to unselect on mcp23018, because the select step sets all // no need to unselect on mcp23018, because the select step sets all
// the other row bits high, and it's not changing to a different // the other row bits high, and it's not changing to a different
// direction // direction
// unselect on teensy // unselect on teensy
// Hi-Z(DDR:0, PORT:0) to unselect setPinInput(B0);
DDRB &= ~(1 << 0 | 1 << 1 | 1 << 2 | 1 << 3); setPinInput(B1);
PORTB &= ~(1 << 0 | 1 << 1 | 1 << 2 | 1 << 3); setPinInput(B2);
DDRD &= ~(1 << 2 | 1 << 3); setPinInput(B3);
PORTD &= ~(1 << 2 | 1 << 3); setPinInput(D2);
DDRC &= ~(1 << 6); setPinInput(D3);
PORTC &= ~(1 << 6); setPinInput(C6);
} }
static void select_row(uint8_t row) { static void select_row(uint8_t row) {
if (row < 7) { if (row < 7) {
// select on mcp23018 // select on mcp23018
if (mcp23018_status) { // if there was an error if (!mcp23018_status) {
// do nothing // set active row low : 0
// set other rows hi-Z : 1
mcp23018_status = i2c_start(I2C_ADDR_WRITE, ERGODOX_EZ_I2C_TIMEOUT); if (mcp23018_status) goto out;
mcp23018_status = i2c_write(GPIOA, ERGODOX_EZ_I2C_TIMEOUT); if (mcp23018_status) goto out;
mcp23018_status = i2c_write(0xFF & ~(1 << row), ERGODOX_EZ_I2C_TIMEOUT); if (mcp23018_status) goto out;
out:
i2c_stop();
}
} else { } else {
// set active row low : 0 // select on teensy
// set other rows hi-Z : 1 // Output low(DDR:1, PORT:0) to select
mcp23018_status = i2c_start(I2C_ADDR_WRITE, ERGODOX_EZ_I2C_TIMEOUT); switch (row) {
if (mcp23018_status) goto out; case 7:
mcp23018_status = i2c_write(GPIOA, ERGODOX_EZ_I2C_TIMEOUT); setPinOutput(B0);
if (mcp23018_status) goto out; writePinLow(B0);
mcp23018_status = i2c_write(0xFF & ~(1 << row), ERGODOX_EZ_I2C_TIMEOUT); break;
if (mcp23018_status) goto out; case 8:
out: setPinOutput(B1);
i2c_stop(); writePinLow(B1);
break;
case 9:
setPinOutput(B2);
writePinLow(B2);
break;
case 10:
setPinOutput(B3);
writePinLow(B3);
break;
case 11:
setPinOutput(D2);
writePinLow(D2);
break;
case 12:
setPinOutput(D3);
writePinLow(D3);
break;
case 13:
setPinOutput(C6);
writePinLow(C6);
break;
}
} }
} else {
// select on teensy
// Output low(DDR:1, PORT:0) to select
switch (row) {
case 7:
DDRB |= (1 << 0);
PORTB &= ~(1 << 0);
break;
case 8:
DDRB |= (1 << 1);
PORTB &= ~(1 << 1);
break;
case 9:
DDRB |= (1 << 2);
PORTB &= ~(1 << 2);
break;
case 10:
DDRB |= (1 << 3);
PORTB &= ~(1 << 3);
break;
case 11:
DDRD |= (1 << 2);
PORTD &= ~(1 << 2);
break;
case 12:
DDRD |= (1 << 3);
PORTD &= ~(1 << 3);
break;
case 13:
DDRC |= (1 << 6);
PORTC &= ~(1 << 6);
break;
}
}
} }

20
keyboards/ergodox_ez/rules.mk
View file

@ -19,20 +19,20 @@ BOOTLOADER = halfkay
# Build Options # Build Options
# comment out to disable the options. # comment out to disable the options.
# #
BOOTMAGIC_ENABLE = no # Virtual DIP switch configuration BOOTMAGIC_ENABLE = no # Virtual DIP switch configuration
MOUSEKEY_ENABLE = yes # Mouse keys MOUSEKEY_ENABLE = yes # Mouse keys
EXTRAKEY_ENABLE = yes # Audio control and System control EXTRAKEY_ENABLE = yes # Audio control and System control
CONSOLE_ENABLE = no # Console for debug CONSOLE_ENABLE = no # Console for debug
COMMAND_ENABLE = yes # Commands for debug and configuration COMMAND_ENABLE = yes # Commands for debug and configuration
CUSTOM_MATRIX = yes # Custom matrix file for the ErgoDox EZ CUSTOM_MATRIX = lite # Custom matrix file for the ErgoDox EZ
NKRO_ENABLE = yes # USB Nkey Rollover - if this doesn't work, see here: https://github.com/tmk/tmk_keyboard/wiki/FAQ#nkro-doesnt-work NKRO_ENABLE = yes # USB Nkey Rollover - if this doesn't work, see here: https://github.com/tmk/tmk_keyboard/wiki/FAQ#nkro-doesnt-work
UNICODE_ENABLE = yes # Unicode UNICODE_ENABLE = yes # Unicode
SWAP_HANDS_ENABLE= yes # Allow swapping hands of keyboard SWAP_HANDS_ENABLE= yes # Allow swapping hands of keyboard
SLEEP_LED_ENABLE = no SLEEP_LED_ENABLE = no
API_SYSEX_ENABLE = no API_SYSEX_ENABLE = no
RGBLIGHT_ENABLE = yes RGBLIGHT_ENABLE = yes
RGB_MATRIX_ENABLE = no # enable later RGB_MATRIX_ENABLE = no # enable later
DEBOUNCE_TYPE = eager_pr DEBOUNCE_TYPE = eager_pr
# project specific files # project specific files