2015-10-26 20:32:37 +00:00
/*
Copyright 2012 Jun Wako < wakojun @ gmail . com >
Copyright 2013 Oleg Kostyuk < cub . uanic @ gmail . com >
2020-10-13 11:35:36 +00:00
Copyright 2015 ZSA Technology Labs Inc ( @ zsa )
Copyright 2020 Christopher Courtney < drashna @ live . com > ( @ drashna )
2015-10-26 20:32:37 +00:00
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/>.
*/
2020-05-28 08:26:53 +00:00
# pragma once
2015-10-26 20:32:37 +00:00
2016-11-22 01:17:32 +00:00
# include "config_common.h"
2015-10-26 20:32:37 +00:00
/* USB Device descriptor parameter */
2020-10-13 11:35:36 +00:00
# define VENDOR_ID 0x3297
2015-10-26 20:32:37 +00:00
# define DEVICE_VER 0x0001
2020-10-13 11:35:36 +00:00
# define MANUFACTURER ZSA Technology Labs
# define PRODUCT_ID 0x4974
2015-10-26 20:32:37 +00:00
# define PRODUCT ErgoDox EZ
/* key matrix size */
# define MATRIX_ROWS 14
improve ergodox ez performance
With these changes, the ergodox ez goes from 315 scans per second
when no keys are pressed (~3.17ms/scan) to 447 (~2.24ms/scan).
The changes to the pin read are just condensing the logic, and
replacing a lot of conditional operations with a single bitwise
inversion.
The change to row scanning is more significant, and merits
explanation. In general, you can only scan one row of a keyboard
at a time, because if you scan two rows, you no longer know
which row is pulling a given column down. But in the Ergodox
design, this isn't the case; the left hand is controlled by an
I2C-based GPIO expander, and the columns and rows are *completely
separate* electrically from the columns and rows on the right-hand
side.
So simply reading rows in parallel offers two significant
improvements. One is that we no longer need the 30us delay after
each right-hand row, because we're spending more than 30us
communicating with the left hand over i2c. Another is that we're
no longer wastefully sending i2c messages to the left hand
to unselect rows when no rows had actually been selected in the
first place. These delays were, between them, coming out to
nearly 30% of the time spent in each scan.
Signed-off-by: seebs <seebs@seebs.net>
2017-11-18 22:11:26 +00:00
# define MATRIX_ROWS_PER_SIDE (MATRIX_ROWS / 2)
2015-10-26 20:32:37 +00:00
# define MATRIX_COLS 6
2020-09-30 23:52:47 +00:00
# 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 }
2017-08-24 02:29:07 +00:00
# define MOUSEKEY_INTERVAL 20
# define MOUSEKEY_DELAY 0
# define MOUSEKEY_TIME_TO_MAX 60
# define MOUSEKEY_MAX_SPEED 7
# define MOUSEKEY_WHEEL_DELAY 0
2019-10-09 22:23:57 +00:00
# define DEBOUNCE 30
2017-08-24 02:29:07 +00:00
# define TAPPING_TOGGLE 1
/* define if matrix has ghost */
//#define MATRIX_HAS_GHOST
# define TAPPING_TERM 200
# define IGNORE_MOD_TAP_INTERRUPT // this makes it possible to do rolling combos (zx) with keys that convert to other keys on hold (z becomes ctrl when you hold it, and when this option isn't enabled, z rapidly followed by x actually sends Ctrl-x. That's bad.)
/* Mechanical locking support. Use KC_LCAP, KC_LNUM or KC_LSCR instead in keymap */
# define LOCKING_SUPPORT_ENABLE
/* Locking resynchronize hack */
# define LOCKING_RESYNC_ENABLE
/* key combination for command */
# define IS_COMMAND() ( \
2019-01-27 08:28:40 +00:00
get_mods ( ) = = ( MOD_BIT ( KC_LCTL ) | MOD_BIT ( KC_RCTL ) ) | | \
get_mods ( ) = = ( MOD_BIT ( KC_LSFT ) | MOD_BIT ( KC_RSFT ) ) \
2017-08-24 02:29:07 +00:00
)
2015-10-26 20:32:37 +00:00
/* number of backlight levels */
# define BACKLIGHT_LEVELS 3
2017-11-23 21:34:50 +00:00
# ifndef LED_BRIGHTNESS_LO
2016-07-09 08:26:15 +00:00
# define LED_BRIGHTNESS_LO 15
2017-11-23 21:34:50 +00:00
# endif
# ifndef LED_BRIGHTNESS_HI
2016-07-09 08:26:15 +00:00
# define LED_BRIGHTNESS_HI 255
2017-11-23 21:34:50 +00:00
# endif
# define LED_BRIGHTNESS_DEFAULT (LED_BRIGHTNESS_HI)
2016-07-09 08:26:15 +00:00
2016-11-29 05:09:56 +00:00
/* ws2812 RGB LED */
# define RGB_DI_PIN D7
# define RGBLIGHT_ANIMATIONS
# define RGBLIGHT_HUE_STEP 12
# define RGBLIGHT_SAT_STEP 255
# define RGBLIGHT_VAL_STEP 12
2019-11-14 20:00:51 +00:00
// Pick one of the modes
// Defaults to 15 mirror, for legacy behavior
// #define ERGODOX_LED_15 // Addresses 15 LEDs, but same position on both halves
// #define ERGODOX_LED_15_MIRROR // Addresses 15 LEDs, but are mirrored
// #define ERGODOX_LED_30 // Addresses all 30 LED individually
2017-04-03 19:11:42 +00:00
/* fix space cadet rollover issue */
# define DISABLE_SPACE_CADET_ROLLOVER
2019-11-14 20:00:51 +00:00
# define RGBW
2016-07-09 08:26:15 +00:00
2019-08-22 00:19:07 +00:00
# define RGBLIGHT_SLEEP
2018-11-20 14:55:35 +00:00
/*
* The debounce filtering reports a key / switch change directly ,
* without any extra delay . After that the debounce logic will filter
* all further changes , until the key / switch reports the same state for
* the given count of scans .
* So a perfect switch will get a short debounce period and
* a bad key will get a much longer debounce period .
* The result is an adaptive debouncing period for each switch .
*
improve ergodox ez performance
With these changes, the ergodox ez goes from 315 scans per second
when no keys are pressed (~3.17ms/scan) to 447 (~2.24ms/scan).
The changes to the pin read are just condensing the logic, and
replacing a lot of conditional operations with a single bitwise
inversion.
The change to row scanning is more significant, and merits
explanation. In general, you can only scan one row of a keyboard
at a time, because if you scan two rows, you no longer know
which row is pulling a given column down. But in the Ergodox
design, this isn't the case; the left hand is controlled by an
I2C-based GPIO expander, and the columns and rows are *completely
separate* electrically from the columns and rows on the right-hand
side.
So simply reading rows in parallel offers two significant
improvements. One is that we no longer need the 30us delay after
each right-hand row, because we're spending more than 30us
communicating with the left hand over i2c. Another is that we're
no longer wastefully sending i2c messages to the left hand
to unselect rows when no rows had actually been selected in the
first place. These delays were, between them, coming out to
nearly 30% of the time spent in each scan.
Signed-off-by: seebs <seebs@seebs.net>
2017-11-18 22:11:26 +00:00
* If you don ' t define it here , the matrix code will default to
* 5 , which is now closer to 10 ms , but still plenty according to
* manufacturer specs .
*/
2015-10-26 20:32:37 +00:00
2016-12-15 04:24:40 +00:00
2018-05-09 13:43:36 +00:00
// RGB backlight
# define DRIVER_ADDR_1 0b1110100
# define DRIVER_ADDR_2 0b1110111
# define DRIVER_COUNT 2
# define DRIVER_1_LED_TOTAL 24
# define DRIVER_2_LED_TOTAL 24
2019-05-10 23:55:02 +00:00
# define DRIVER_LED_TOTAL (DRIVER_1_LED_TOTAL + DRIVER_2_LED_TOTAL)
2018-05-09 13:43:36 +00:00
2019-08-21 05:39:13 +00:00
# define RGB_MATRIX_LED_PROCESS_LIMIT 5
# define RGB_MATRIX_LED_FLUSH_LIMIT 26
2019-08-22 00:19:07 +00:00
# define RGB_DISABLE_WHEN_USB_SUSPENDED true
2017-11-06 14:00:05 +00:00
// #define RGBLIGHT_COLOR_LAYER_0 0x00, 0x00, 0xFF
2017-11-09 13:12:43 +00:00
/* #define RGBLIGHT_COLOR_LAYER_1 0x00, 0x00, 0xFF */
/* #define RGBLIGHT_COLOR_LAYER_2 0xFF, 0x00, 0x00 */
/* #define RGBLIGHT_COLOR_LAYER_3 0x00, 0xFF, 0x00 */
/* #define RGBLIGHT_COLOR_LAYER_4 0xFF, 0xFF, 0x00 */
/* #define RGBLIGHT_COLOR_LAYER_5 0x00, 0xFF, 0xFF */
/* #define RGBLIGHT_COLOR_LAYER_6 0xFF, 0x00, 0xFF */
/* #define RGBLIGHT_COLOR_LAYER_7 0xFF, 0xFF, 0xFF */
2017-11-06 14:00:05 +00:00
2015-10-26 20:32:37 +00:00
/*
* Feature disable options
* These options are also useful to firmware size reduction .
*/
/* disable debug print */
// #define NO_DEBUG
/* disable print */
// #define NO_PRINT
/* disable action features */
//#define NO_ACTION_LAYER
//#define NO_ACTION_TAPPING
//#define NO_ACTION_ONESHOT
2020-10-13 11:35:36 +00:00
# define NO_ACTION_MACRO
# define NO_ACTION_FUNCTION
2015-10-26 20:32:37 +00:00
//#define DEBUG_MATRIX_SCAN_RATE