/*
 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							 
							
							
								Copyright  2012  Jun  Wako  < wakojun @ gmail . com > 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							 
							
							
								Copyright  2013  Oleg  Kostyuk  < cub . uanic @ gmail . com > 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							 
							
							
								
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							 
							
							
								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/>.
 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							 
							
							
								*/ 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							 
							
							
								
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							 
							
							
								# ifndef ERGODOX_EZ_CONFIG_H 
 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							 
							
							
								# define ERGODOX_EZ_CONFIG_H 
 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							 
							
							
								
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							 
							
							
								# include  "config_common.h" 
 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							 
							
							
								
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							 
							
							
								/* USB Device descriptor parameter */ 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							 
							
							
								# define VENDOR_ID       0xFEED 
 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							 
							
							
								# define PRODUCT_ID      0x1307 
 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							 
							
							
								# define DEVICE_VER      0x0001 
 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							 
							
							
								# define MANUFACTURER    ErgoDox EZ 
 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							 
							
							
								# define PRODUCT         ErgoDox EZ 
 
							 
						 
					
						
							
								
							 
							
								
									
										 
									 
								
							 
							
								 
							 
							
							
								# define DESCRIPTION     QMK keyboard firmware for 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>
											 
										 
										
											8 years ago 
										
									 
								 
							 
							
								
									
										 
									 
								
							 
							
								 
							 
							
							
								# define MATRIX_ROWS_PER_SIDE (MATRIX_ROWS  /  2) 
 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							 
							
							
								# define MATRIX_COLS 6 
 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							 
							
							
								
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							 
							
							
								# define MOUSEKEY_INTERVAL       20 
 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							 
							
							
								# define MOUSEKEY_DELAY          0 
 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							 
							
							
								# define MOUSEKEY_TIME_TO_MAX    60 
 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							 
							
							
								# define MOUSEKEY_MAX_SPEED      7 
 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							 
							
							
								# define MOUSEKEY_WHEEL_DELAY 0 
 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							 
							
							
								
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							 
							
							
								# 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() ( \ 
 
							 
						 
					
						
							
								
							 
							
								
									
										 
									 
								
							 
							
								 
							 
							
							
								    get_mods ( )  = =  ( MOD_BIT ( KC_LCTL )  |  MOD_BIT ( KC_RCTL ) )  | |  \
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							 
							
							
								    get_mods ( )  = =  ( MOD_BIT ( KC_LSFT )  |  MOD_BIT ( KC_RSFT ) )  \
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							 
							
							
								) 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							 
							
							
								
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							 
							
							
								/* number of backlight levels */ 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							 
							
							
								# define BACKLIGHT_LEVELS 3 
 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							 
							
							
								
							 
						 
					
						
							
								
							 
							
								
									
										 
									 
								
							 
							
								 
							 
							
							
								# ifndef LED_BRIGHTNESS_LO 
 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							 
							
							
								# define LED_BRIGHTNESS_LO       15 
 
							 
						 
					
						
							
								
							 
							
								
									
										 
									 
								
							 
							
								 
							 
							
							
								# endif 
 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							 
							
							
								# ifndef LED_BRIGHTNESS_HI 
 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							 
							
							
								# define LED_BRIGHTNESS_HI       255 
 
							 
						 
					
						
							
								
							 
							
								
									
										 
									 
								
							 
							
								 
							 
							
							
								# endif 
 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							 
							
							
								# define LED_BRIGHTNESS_DEFAULT (LED_BRIGHTNESS_HI) 
 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							 
							
							
								
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							 
							
							
								/* ws2812 RGB LED */ 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							 
							
							
								# define RGB_DI_PIN D7 
 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							 
							
							
								# define RGBLIGHT_ANIMATIONS 
 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							 
							
							
								# define RGBLED_NUM 15      // Number of LEDs
 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							 
							
							
								# define RGBLIGHT_HUE_STEP 12 
 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							 
							
							
								# define RGBLIGHT_SAT_STEP 255 
 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							 
							
							
								# define RGBLIGHT_VAL_STEP 12 
 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							 
							
							
								
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							 
							
							
								/* fix space cadet rollover issue */ 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							 
							
							
								# define DISABLE_SPACE_CADET_ROLLOVER 
 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							 
							
							
								
							 
						 
					
						
							
								
							 
							
								
									
										 
									 
								
							 
							
								 
							 
							
							
								# define RGBW_BB_TWI 
 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							 
							
							
								
							 
						 
					
						
							
								
							 
							
								
									
										 
									 
								
							 
							
								 
							 
							
							
								# define RGBW 1 
 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							 
							
							
								
							 
						 
					
						
							
								
							 
							
								
									
										 
									 
								
							 
							
								 
							 
							
							
								/*
 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							 
							
							
								 *  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>
											 
										 
										
											8 years ago 
										
									 
								 
							 
							
								
									
										 
									 
								
							 
							
								 
							 
							
							
								 *  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 . 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							 
							
							
								 */ 
							 
						 
					
						
							
								
							 
							
								
									
										 
									 
								
							 
							
								 
							 
							
							
								# define DEBOUNCE    10 
 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							 
							
							
								
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							 
							
							
								# define USB_MAX_POWER_CONSUMPTION 500 
 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							 
							
							
								
							 
						 
					
						
							
								
							 
							
								
									
										 
									 
								
							 
							
								 
							 
							
							
								// 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 
 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							 
							
							
								# define DRIVER_LED_TOTAL DRIVER_1_LED_TOTAL + DRIVER_2_LED_TOTAL 
 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							 
							
							
								
							 
						 
					
						
							
								
							 
							
								
									
										 
									 
								
							 
							
								 
							 
							
							
								// #define RGBLIGHT_COLOR_LAYER_0 0x00, 0x00, 0xFF
 
							 
						 
					
						
							
								
							 
							
								
									
										 
									 
								
							 
							
								 
							 
							
							
								/* #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 */ 
							 
						 
					
						
							
								
							 
							
								
									
										 
									 
								
							 
							
								 
							 
							
							
								
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							 
							
							
								/*
 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							 
							
							
								 *  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
 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							 
							
							
								//#define NO_ACTION_MACRO
 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							 
							
							
								//#define NO_ACTION_FUNCTION
 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							 
							
							
								//#define DEBUG_MATRIX_SCAN_RATE
 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							 
							
							
								
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							 
							
							
								# endif