Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

kint36: switch to sym_eager_pk debouncing #12626

Merged
merged 1 commit into from
Apr 20, 2021

Conversation

stapelberg
Copy link
Contributor

@stapelberg stapelberg commented Apr 19, 2021

Description

This change shaves off ≈5ms of input latency by switching to eager debouncing.

Before:

% benchstat screenlog-kint36.0
name                 time/op
KeypressToLEDReport  7.61ms ± 8%

After:

% benchstat screenlog-kint36-eager.0
name                 time/op
KeypressToLEDReport  2.12ms ±16%

Types of Changes

  • Core
  • Bugfix
  • New feature
  • Enhancement/optimization
  • Keyboard (addition or update)
  • Keymap/layout/userspace (addition or update)
  • Documentation

Checklist

  • My code follows the code style of this project: C, Python
  • I have read the PR Checklist document and have made the appropriate changes.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • I have tested the changes and verified that they work and don't break anything (as well as I can manage).

@drashna drashna requested a review from a team April 20, 2021 04:00
@drashna
Copy link
Member

drashna commented Apr 20, 2021

Thanks!

@drashna drashna merged commit 3d32cbb into qmk:develop Apr 20, 2021
@stapelberg stapelberg deleted the kint36-latency branch May 15, 2021 06:54
noroadsleft added a commit that referenced this pull request May 29, 2021
* Add Per Key functionality for AutoShift (#11536)

* LED Matrix: Reactive effect buffers & advanced indicators (#12588)

* [Keyboard] kint36: switch to sym_eager_pk debouncing (#12626)

* [Keyboard] kint2pp: reduce input latency by ≈10ms (#12625)

* LED Matrix: Split (#12633)

* [CI] Format code according to conventions (#12650)

* feat: infinite timeout for leader key (#6580)

* feat: implement leader_no_timeout logic

* docs(leader_key): infinite leader timeout docs

* Format code according to conventions (#12680)

* Update ADC driver for STM32F1xx, STM32F3xx, STM32F4xx (#12403)

* Fix default ADC_RESOLUTION for ADCv3 (and ADCv4)

Recent ChibiOS update removed ADC_CFGR1_RES_10BIT from the ADCv3 headers
(that macro should not have been there, because ADCv3 has CFGR instead of
CFGR1).  Fix the default value for ADC_RESOLUTION to use ADC_CFGR_RES_10BITS
if it is defined (that name is used for ADCv3 and ADCv4).

* Update ADC docs to match the actually used resolution

ADC driver for ChibiOS actually uses the 10-bit resolution by default
(probably to match AVR); fix the documentation accordingly.  Also add
both ADC_CFGR_RES_10BITS and ADC_CFGR1_RES_10BIT constants (these names
differ according to the ADC implementation in the particular MCU).

* Fix pinToMux() for B12 and B13 on STM32F3xx

Testing on STM32F303CCT6 revealed that the ADC mux values for B12 and
B13 pins were wrong.

* Add support for all possible analog pins on STM32F1xx

Added ADC mux values for pins A0...A7, B0, B1, C0...C5 on STM32F1xx
(they are the same at least for STM32F103x8 and larger F103 devices, and
also F102, F105, F107 families).  Actually tested on STM32F103C8T6
(therefore pins C0...C5 were not tested).

Pins F6...F10, which are present on STM32F103x[C-G] in 144-pin packages,
cannot be supported at the moment, because those pins are connected only
to ADC3, but the ChibiOS ADC driver for STM32F1xx supports only ADC1.

* Add support for all possible analog pins on STM32F4xx

Added ADC mux values for pins A0...A7, B0, B1, C0...C5 and optionally
F3...F10 (if STM32_ADC_USE_ADC3 is enabled).  These mux values are
apparently the same for all F4xx devices, except some smaller devices may
not have ADC3.

Actually tested on STM32F401CCU6, STM32F401CEU6, STM32F411CEU6 (using
various WeAct “Blackpill” boards); only pins A0...A7, B0, B1 were tested.

Pins F3...F10 are inside `#if STM32_ADC_USE_ADC3` because some devices
which don't have ADC3 also don't have the GPIOF port, therefore the code
which refers to Fx pins does not compile.

* Fix STM32F3xx ADC mux table in documentation

The ADC driver documentation had some errors in the mux table for STM32F3xx.
Fix this table to match the datasheet and the actual code (mux settings for
B12 and B13 were also tested on a real STM32F303CCT6 chip).

* Add STM32F1xx ADC pins to the documentation

* Add STM32F4xx ADC pins to the documentation

* Add initial support for tinyuf2 bootloader (when hosted on F411 blackpill) (#12600)

* Add support for jumping to tinyuf2 bootloader. Adds blackpill UF2 example.

* Update flashing.md

* Update chconf.h

* Update config.h

* Update halconf.h

* Update mcuconf.h

* eeprom driver: Refactor where eeprom driver initialisation (and EEPROM emulation initialisation) occurs to make it non-target-specific. (#12671)

* Add support for MCU = STM32F446 (#12619)

* Add support for MCU = STM32F446

* Update platforms/chibios/GENERIC_STM32_F446XE/configs/config.h

* Restore mcuconf.h to the one used by RT-STM32F446RE-NUCLEO64

* stm32f446: update mcuconf.h and board.h for 16MHz operation, with USB enabled, and other peripherals disabled.

* Format code according to conventions (#12682)

* Format code according to conventions (#12687)

* Add STM32L433 and L443 support (#12063)

* initial L433 commit

* change to XC

* fix L433

* disable all peripherals

* update system and peripheral clocks

* 433 change

* use its own board  files

* revert its own board files

* l433 specific change

* fix stm32l432xx define

* remove duplicate #define

* fix bootloader jump

* move to L443xx and add i2c2, spi2, usart3 to mcuconf.h

* move to L443

* move to L443

* fix sdmmc in mcuconf.h

* include STM32L443

* add L443

* Include L443 in compatible microcontrollers

* Include L443 in compatible microcontrollers

* Update config bootloader jump description

* Update ChibiOS define reasoning

* Update quantum/mcu_selection.mk

* fix git conflict

* Updated Function96 with V2 files and removed chconf.h and halconf.h (#12613)

* Fix bad PR merge for #6580. (#12721)

* Change RGB/LED Matrix to use a simple define for USB suspend (#12697)

* [CI] Format code according to conventions (#12731)

* Fixing transport's led/rgb matrix suspend state logic (#12770)

* [CI] Format code according to conventions (#12772)

* Fix comment parsing (#12750)

* Added OLED fade out support (#12086)

* fix some references to bin/qmk that slipped in (#12832)

* Resolve a number of warnings in `qmk generate-api` (#12833)

* New command: qmk console (#12828)

* stash poc

* stash

* tidy up implementation

* Tidy up slightly for review

* Tidy up slightly for review

* Bodge environment to make tests pass

* Refactor away from asyncio due to windows issues

* Filter devices

* align vid/pid printing

* Add hidapi to the installers

* start preparing for multiple hid_listeners

* udev rules for hid_listen

* refactor to move closer to end state

* very basic implementation of the threaded model

* refactor how vid/pid/index are supplied and parsed

* windows improvements

* read the report directly when usage page isn't available

* add per-device colors, the choice to show names or numbers, and refactor

* add timestamps

* Add support for showing bootloaders

* tweak the color for bootloaders

* Align bootloader disconnect with connect color

* add support for showing all bootloaders

* fix the pyusb check

* tweaks

* fix exception

* hide a stack trace behind -v

* add --no-bootloaders option

* add documentation for qmk console

* Apply suggestions from code review

* pyformat

* clean up and flesh out KNOWN_BOOTLOADERS

* Remove pointless SERIAL_LINK_ENABLE rules (#12846)

* Make Swap Hands use PROGMEM (#12284)

This converts the array that the Swap Hands feature uses to use PROGMEM,
and to read from that array, as such. Since this array never changes at
runtime, there is no reason to keep it in memory. Especially for AVR
boards, as memory is a precious resource.

* Fix another bin/qmk reference (#12856)

* [Keymap] Turn OLED off on suspend in soundmonster keymap (#10419)

* Fixup build errors on `develop` branch. (#12723)

* LED Matrix: Effects! (#12651)

* Fix syntax error when compiling for ARM (#12866)

* Remove KEYMAP and LAYOUT_kc (#12160)

* alias KEYMAP to LAYOUT

* remove KEYMAP and LAYOUT_kc

* Add setup, clone, and env to the list of commands we allow even with broken modules (#12868)

* Rename `point_t` -> `led_point_t` (#12864)

* [Keyboard] updated a vendor name / fixed minor keymap issues (#12881)

* Add missing LED Matrix suspend code to suspend.c (#12878)

* LED Matrix: Documentation (#12685)

* Deprecate `send_unicode_hex_string()` (#12602)

* Fix spelling mistake regarding LED Matrix in split_common. (#12888)

* [Keymap] Fix QWERTY/DVORAK status output for kzar keymap (#12895)

* Use milc.subcommand.config instead of qmk.cli.config (#12915)

* Use milc.subcommand.config instead

* pyformat

* remove the config test

* Add function to allow repeated blinking of one layer (#12237)

* Implement function rgblight_blink_layer_repeat to allow repeated blinking of one layer at a time

* Update doc

* Rework rgblight blinking according to requested change

* optimize storage

* Fixup housekeeping from being invoked twice per loop. (#12933)

* matrix: wait for row signal to go HIGH for every row (#12945)

I noticed this discrepancy (last row of the matrix treated differently than the
others) when optimizing the input latency of my keyboard controller, see also
https://michael.stapelberg.ch/posts/2021-05-08-keyboard-input-latency-qmk-kinesis/

Before this commit, when tuning the delays I noticed ghost key presses when
pressing the F2 key, which is on the last row of the keyboard matrix: the
dead_grave key, which is on the first row of the keyboard matrix, would be
incorrectly detected as pressed.

After this commit, all keyboard matrix rows are interpreted correctly.

I suspect that my setup is more susceptible to this nuance than others because I
use GPIO_INPUT_PIN_DELAY=0 and hence don’t have another delay that might mask
the problem.

* ensure we do not conflict with existing keymap aliases (#12976)

* Add support for up to 4 IS31FL3733 drivers (#12342)

* Convert Encoder callbacks to be boolean functions (#12805)

* [Keyboard] Fix Terrazzo build failure (#12977)

* Do not hard set config in CPTC files (#11864)

* [Keyboard] Corne - Remove legacy revision support (#12226)

* [Keymap] Update to Drashna keymap and user code (based on develop) (#12936)

* Add Full-duplex serial driver for ARM boards (#9842)

* Document LED_MATRIX_FRAMEBUFFER_EFFECTS (#12987)

* Backlight: add defines for default level and breathing state (#12560)

* Add dire message about LUFA mass storage bootloader (#13014)

* [Keyboard] Remove redundant legacy and common headers for crkbd (#13023)

Was causing compiler errors on some systems.

* Fix keyboards/keymaps for boolean encoder callback changes (#12985)

* `backlight.c`: include `eeprom.h` (#13024)

* Add changelog for 2021-05-29 Breaking Changes merge (#12939)

* Add ChangeLog for 2021-05-29 Breaking Changes Merge: initial version

* Add recent develop changes

* Sort recent develop changes

* Remove sections for ChibiOS changes per tzarc

No ChibiOS changes this round.

* Add and sort recent develop changes

* add notes about keyboard moves/deletions

* import changelog for PR 12172

Documents the change to BOOTMAGIC_ENABLE.

* update section headings

* re-sort changelog

* add additional note regarding Bootmagic changes

* remove changelog timestamp

* update dates in main Breaking Changes docs

* fix broken section anchors in previous changelogs

* add link to backlight/eeprom patch to changelog

* highlight some more changes

* link PRs from section headers

* Restore standard readme

* run: qmk cformat --core-only
@badgersow
Copy link

I would like to comment on this, in case somebody googles the problem and ends up here.

I've soldered a Kint36 controller to my KB605 on a weekend and I've noticed that when I type, once in every couple minutes I'm having repeated key presses. For example when I type "of", the keyboard can receive "ofo". It's pretty hard to reproduce on purpose, but it happens regularily when I just type naturally. My typing speed is around 55-60WPM.

I've used Karabiner-EventViewer to monitor the keypresses on my macOS and the picture was something like:

o - down
f - down
o - up
o - down
o - up
f - up

I've seen it happening with different keys, so it shouldn't be a faulty switch. I've also never seen this problem with previous native Kinesis controller, so it's safe to assume the problem came with Kint36.

I've tried different things, but eventually I've set the debouncing algorithm to sym_defer_g and it helped. I've never seen a repeated keypress ever since.

Because this was my first soldering experience, it's very much possible that I've messed with something and made a bad soldering joint without understanding it. Maybe sym_defer_g is just masking the problem I've introduced with my expert soldering skills. Or maybe Kint36 really should have sym_defer_g in some cases. I don't know how to check this. I'm happy to do any experiments to get to the root of this problem, if there any suggestions about testing I can do (@stapelberg maybe you have any ideas on the top of your head). If not - that's also fine, because the controller seems to work perfectly with the new debouncing algorithm setting.

Still, if somebody else is in the same situation, I hope they will come to this PR and try what I did - this might save a lot of time.

@stapelberg
Copy link
Contributor Author

Thanks for reporting this!

I've tried different things, but eventually I've set the debouncing algorithm to sym_defer_g and it helped. I've never seen a repeated keypress ever since.

Alternatively, can you try sym_eager_pk, but increase

from its default 5ms to, say, 20ms?

If that doesn’t help, perhaps it is time to implement asym_eager_defer_pk, as mentioned on https://beta.docs.qmk.fm/using-qmk/software-features/feature_debounce_type

@stapelberg
Copy link
Contributor Author

If that doesn’t help, perhaps it is time to implement asym_eager_defer_pk, as mentioned on https://beta.docs.qmk.fm/using-qmk/software-features/feature_debounce_type

I implemented debounce algorithm asym_eager_defer_pk in commit kinx-project@335d803 (branch https://github.com/kinx-project/qmk_firmware/commits/kint41-upstream-debounce). If you want to give that a shot (I’m testing it on my keyboard currently), please let me know how it goes!

@badgersow
Copy link

badgersow commented Jun 6, 2021

Thanks for letting me know. During the week I've played with the timeout on eager_pk and with the value of 30 milliseconds I don't see any problems. With 25 I still had very rare chatter (1-2 times per day).
To be honest, I don't know how to interpret that, because Cherry MX claims to have at most 5 ms of bouncing. It is also clearly not a problem with noise, because I'm getting repeated strokes, not just random keys. On the other hand, I know that Ergodox uses 30ms of eager debounce by default. It will be interesting to know what Kinesis Controller does by default.

I’m testing it on my keyboard currently

Are you testing 5ms for asymmetrical algorithm? What previous timeout for eager_pk did you have on Kint 3.6?

@stapelberg
Copy link
Contributor Author

Thanks for letting me know. During the week I've played with the timeout on eager_pk and with the value of 30 milliseconds I don't see any problems. With 25 I still had very rare chatter (1-2 times per day).
To be honest, I don't know how to interpret that, because Cherry MX claims to have at most 5 ms of bouncing.

Cherry’s claim seems to be overly optimistic indeed. In a different firmware project, I have previously bumped debounce time from Cherry’s 5ms claim to 10ms observed, then to 20ms as the key switches aged: kinx-project/mk66f-fw@36f3df7

It is also clearly not a problem with noise, because I'm getting repeated strokes, not just random keys.

I think it is noise, but only for pressed keys. (They get detected as unpressed, then pressed, then unpressed, …)

Are you testing 5ms for asymmetrical algorithm?

Yes, I’m currently testing with 5ms debounce time with asym_eager_defer_pk, and it seems to work well.

What previous timeout for eager_pk did you have on Kint 3.6?

You can see the history at https://github.com/qmk/qmk_firmware/blame/master/keyboards/kinesis/kint36/config.h — we always defined DEBOUNCE as 5ms, just like most other QMK keyboards.

@badgersow
Copy link

I've just merged your branch to mine and compiled an asymmetrical algorithm. I'll try it over the week and let you know how it goes.
I've also noticed commits to support Teensy 4.1 from you. When it is mostly working, if you need help with testing it, I'm happy to try it.

spRite75 added a commit to spRite75/qmk_firmware that referenced this pull request Jun 7, 2021
* Keyboard: Planck THK (qmk#12597)

Co-authored-by: Ryan <[email protected]>
Co-authored-by: Jack Humbert <[email protected]>
Co-authored-by: Drashna Jaelre <[email protected]>

* [Keymap] update gunp layout for Planck (qmk#12926)

Co-authored-by: Ryan <[email protected]>

* [Keyboard] SKErgo (qmk#12923)

Co-authored-by: Drashna Jaelre <[email protected]>
Co-authored-by: Ryan <[email protected]>

* [Keyboard] Adjustments to Gust Rev1.2 (qmk#12716)

Co-authored-by: Eithan Shavit <[email protected]>

* [Keyboard] Add RGB Matrix support for Bear65 PCB (qmk#12961)

Co-authored-by: Drashna Jaelre <[email protected]>

* [Keymap] Add mercutio keymap and update readme.md for layouts (qmk#12973)

Co-authored-by: Drashna Jaelre <[email protected]>
Co-authored-by: Ryan <[email protected]>
Co-authored-by: Jonavin <=>

* [Keymap] Add new keymap for ut472 (qmk#12974)

* [Keyboard] Removed LAYOUTS = ortho_6x16 (qmk#12983)

Removed ortho_6x16 community layout support by commenting out the line.

This can be reversed if that layout ever gets added.

* Document RGB_MATRIX_FRAMEBUFFER_EFFECTS (qmk#12984)

* [Keyboard] Fix Clawsome/Sedan matrix and default keymap (qmk#13007)

* Add keymap with scrolling mode for the Ploopy Nano trackball (qmk#13013)

Co-authored-by: Drashna Jaelre <[email protected]>

* [Keyboard] Fix Delilah VIA Keymap (qmk#13008)

Co-authored-by: Drashna Jaelre <[email protected]>

* [Keyboard] Add F.Me Macropad (qmk#12658)

Co-authored-by: Drashna Jaelre <[email protected]>
Co-authored-by: Ryan <[email protected]>

* [Keyboard] Add VIA to Aves65 (qmk#12990)

* [Keyboard] Add Jabberwocky Keyboard (qmk#12500)

Co-authored-by: Drashna Jaelre <[email protected]>
Co-authored-by: Ryan <[email protected]>
Co-authored-by: Rossman360 <[email protected]>

* [Keyboard] Corgi keyboard (qmk#12311)

Co-authored-by: Drashna Jaelre <[email protected]>
Co-authored-by: Ryan <[email protected]>

* [Keymap] add personal keymap files, and sofle_rgb default maps, (qmk#12267)

* Sofle rev1 Keymap - featuring keyboard pets (qmk#12499)

Co-authored-by: Drashna Jaelre <[email protected]>
Co-authored-by: Ryan <[email protected]>

* CLI/c2json: Print 'cpp' error when executed in verbose mode (qmk#12869)

Co-authored-by: Ryan <[email protected]>

* World domination (qmk#13021)

Co-authored-by: Nick Brassel <[email protected]>
Co-authored-by: Ryan <[email protected]>

* 2021 May 29 Breaking Changes Update (qmk#13034)

* Add Per Key functionality for AutoShift (qmk#11536)

* LED Matrix: Reactive effect buffers & advanced indicators (qmk#12588)

* [Keyboard] kint36: switch to sym_eager_pk debouncing (qmk#12626)

* [Keyboard] kint2pp: reduce input latency by ≈10ms (qmk#12625)

* LED Matrix: Split (qmk#12633)

* [CI] Format code according to conventions (qmk#12650)

* feat: infinite timeout for leader key (qmk#6580)

* feat: implement leader_no_timeout logic

* docs(leader_key): infinite leader timeout docs

* Format code according to conventions (qmk#12680)

* Update ADC driver for STM32F1xx, STM32F3xx, STM32F4xx (qmk#12403)

* Fix default ADC_RESOLUTION for ADCv3 (and ADCv4)

Recent ChibiOS update removed ADC_CFGR1_RES_10BIT from the ADCv3 headers
(that macro should not have been there, because ADCv3 has CFGR instead of
CFGR1).  Fix the default value for ADC_RESOLUTION to use ADC_CFGR_RES_10BITS
if it is defined (that name is used for ADCv3 and ADCv4).

* Update ADC docs to match the actually used resolution

ADC driver for ChibiOS actually uses the 10-bit resolution by default
(probably to match AVR); fix the documentation accordingly.  Also add
both ADC_CFGR_RES_10BITS and ADC_CFGR1_RES_10BIT constants (these names
differ according to the ADC implementation in the particular MCU).

* Fix pinToMux() for B12 and B13 on STM32F3xx

Testing on STM32F303CCT6 revealed that the ADC mux values for B12 and
B13 pins were wrong.

* Add support for all possible analog pins on STM32F1xx

Added ADC mux values for pins A0...A7, B0, B1, C0...C5 on STM32F1xx
(they are the same at least for STM32F103x8 and larger F103 devices, and
also F102, F105, F107 families).  Actually tested on STM32F103C8T6
(therefore pins C0...C5 were not tested).

Pins F6...F10, which are present on STM32F103x[C-G] in 144-pin packages,
cannot be supported at the moment, because those pins are connected only
to ADC3, but the ChibiOS ADC driver for STM32F1xx supports only ADC1.

* Add support for all possible analog pins on STM32F4xx

Added ADC mux values for pins A0...A7, B0, B1, C0...C5 and optionally
F3...F10 (if STM32_ADC_USE_ADC3 is enabled).  These mux values are
apparently the same for all F4xx devices, except some smaller devices may
not have ADC3.

Actually tested on STM32F401CCU6, STM32F401CEU6, STM32F411CEU6 (using
various WeAct “Blackpill” boards); only pins A0...A7, B0, B1 were tested.

Pins F3...F10 are inside `#if STM32_ADC_USE_ADC3` because some devices
which don't have ADC3 also don't have the GPIOF port, therefore the code
which refers to Fx pins does not compile.

* Fix STM32F3xx ADC mux table in documentation

The ADC driver documentation had some errors in the mux table for STM32F3xx.
Fix this table to match the datasheet and the actual code (mux settings for
B12 and B13 were also tested on a real STM32F303CCT6 chip).

* Add STM32F1xx ADC pins to the documentation

* Add STM32F4xx ADC pins to the documentation

* Add initial support for tinyuf2 bootloader (when hosted on F411 blackpill) (qmk#12600)

* Add support for jumping to tinyuf2 bootloader. Adds blackpill UF2 example.

* Update flashing.md

* Update chconf.h

* Update config.h

* Update halconf.h

* Update mcuconf.h

* eeprom driver: Refactor where eeprom driver initialisation (and EEPROM emulation initialisation) occurs to make it non-target-specific. (qmk#12671)

* Add support for MCU = STM32F446 (qmk#12619)

* Add support for MCU = STM32F446

* Update platforms/chibios/GENERIC_STM32_F446XE/configs/config.h

* Restore mcuconf.h to the one used by RT-STM32F446RE-NUCLEO64

* stm32f446: update mcuconf.h and board.h for 16MHz operation, with USB enabled, and other peripherals disabled.

* Format code according to conventions (qmk#12682)

* Format code according to conventions (qmk#12687)

* Add STM32L433 and L443 support (qmk#12063)

* initial L433 commit

* change to XC

* fix L433

* disable all peripherals

* update system and peripheral clocks

* 433 change

* use its own board  files

* revert its own board files

* l433 specific change

* fix stm32l432xx define

* remove duplicate #define

* fix bootloader jump

* move to L443xx and add i2c2, spi2, usart3 to mcuconf.h

* move to L443

* move to L443

* fix sdmmc in mcuconf.h

* include STM32L443

* add L443

* Include L443 in compatible microcontrollers

* Include L443 in compatible microcontrollers

* Update config bootloader jump description

* Update ChibiOS define reasoning

* Update quantum/mcu_selection.mk

* fix git conflict

* Updated Function96 with V2 files and removed chconf.h and halconf.h (qmk#12613)

* Fix bad PR merge for qmk#6580. (qmk#12721)

* Change RGB/LED Matrix to use a simple define for USB suspend (qmk#12697)

* [CI] Format code according to conventions (qmk#12731)

* Fixing transport's led/rgb matrix suspend state logic (qmk#12770)

* [CI] Format code according to conventions (qmk#12772)

* Fix comment parsing (qmk#12750)

* Added OLED fade out support (qmk#12086)

* fix some references to bin/qmk that slipped in (qmk#12832)

* Resolve a number of warnings in `qmk generate-api` (qmk#12833)

* New command: qmk console (qmk#12828)

* stash poc

* stash

* tidy up implementation

* Tidy up slightly for review

* Tidy up slightly for review

* Bodge environment to make tests pass

* Refactor away from asyncio due to windows issues

* Filter devices

* align vid/pid printing

* Add hidapi to the installers

* start preparing for multiple hid_listeners

* udev rules for hid_listen

* refactor to move closer to end state

* very basic implementation of the threaded model

* refactor how vid/pid/index are supplied and parsed

* windows improvements

* read the report directly when usage page isn't available

* add per-device colors, the choice to show names or numbers, and refactor

* add timestamps

* Add support for showing bootloaders

* tweak the color for bootloaders

* Align bootloader disconnect with connect color

* add support for showing all bootloaders

* fix the pyusb check

* tweaks

* fix exception

* hide a stack trace behind -v

* add --no-bootloaders option

* add documentation for qmk console

* Apply suggestions from code review

* pyformat

* clean up and flesh out KNOWN_BOOTLOADERS

* Remove pointless SERIAL_LINK_ENABLE rules (qmk#12846)

* Make Swap Hands use PROGMEM (qmk#12284)

This converts the array that the Swap Hands feature uses to use PROGMEM,
and to read from that array, as such. Since this array never changes at
runtime, there is no reason to keep it in memory. Especially for AVR
boards, as memory is a precious resource.

* Fix another bin/qmk reference (qmk#12856)

* [Keymap] Turn OLED off on suspend in soundmonster keymap (qmk#10419)

* Fixup build errors on `develop` branch. (qmk#12723)

* LED Matrix: Effects! (qmk#12651)

* Fix syntax error when compiling for ARM (qmk#12866)

* Remove KEYMAP and LAYOUT_kc (qmk#12160)

* alias KEYMAP to LAYOUT

* remove KEYMAP and LAYOUT_kc

* Add setup, clone, and env to the list of commands we allow even with broken modules (qmk#12868)

* Rename `point_t` -> `led_point_t` (qmk#12864)

* [Keyboard] updated a vendor name / fixed minor keymap issues (qmk#12881)

* Add missing LED Matrix suspend code to suspend.c (qmk#12878)

* LED Matrix: Documentation (qmk#12685)

* Deprecate `send_unicode_hex_string()` (qmk#12602)

* Fix spelling mistake regarding LED Matrix in split_common. (qmk#12888)

* [Keymap] Fix QWERTY/DVORAK status output for kzar keymap (qmk#12895)

* Use milc.subcommand.config instead of qmk.cli.config (qmk#12915)

* Use milc.subcommand.config instead

* pyformat

* remove the config test

* Add function to allow repeated blinking of one layer (qmk#12237)

* Implement function rgblight_blink_layer_repeat to allow repeated blinking of one layer at a time

* Update doc

* Rework rgblight blinking according to requested change

* optimize storage

* Fixup housekeeping from being invoked twice per loop. (qmk#12933)

* matrix: wait for row signal to go HIGH for every row (qmk#12945)

I noticed this discrepancy (last row of the matrix treated differently than the
others) when optimizing the input latency of my keyboard controller, see also
https://michael.stapelberg.ch/posts/2021-05-08-keyboard-input-latency-qmk-kinesis/

Before this commit, when tuning the delays I noticed ghost key presses when
pressing the F2 key, which is on the last row of the keyboard matrix: the
dead_grave key, which is on the first row of the keyboard matrix, would be
incorrectly detected as pressed.

After this commit, all keyboard matrix rows are interpreted correctly.

I suspect that my setup is more susceptible to this nuance than others because I
use GPIO_INPUT_PIN_DELAY=0 and hence don’t have another delay that might mask
the problem.

* ensure we do not conflict with existing keymap aliases (qmk#12976)

* Add support for up to 4 IS31FL3733 drivers (qmk#12342)

* Convert Encoder callbacks to be boolean functions (qmk#12805)

* [Keyboard] Fix Terrazzo build failure (qmk#12977)

* Do not hard set config in CPTC files (qmk#11864)

* [Keyboard] Corne - Remove legacy revision support (qmk#12226)

* [Keymap] Update to Drashna keymap and user code (based on develop) (qmk#12936)

* Add Full-duplex serial driver for ARM boards (qmk#9842)

* Document LED_MATRIX_FRAMEBUFFER_EFFECTS (qmk#12987)

* Backlight: add defines for default level and breathing state (qmk#12560)

* Add dire message about LUFA mass storage bootloader (qmk#13014)

* [Keyboard] Remove redundant legacy and common headers for crkbd (qmk#13023)

Was causing compiler errors on some systems.

* Fix keyboards/keymaps for boolean encoder callback changes (qmk#12985)

* `backlight.c`: include `eeprom.h` (qmk#13024)

* Add changelog for 2021-05-29 Breaking Changes merge (qmk#12939)

* Add ChangeLog for 2021-05-29 Breaking Changes Merge: initial version

* Add recent develop changes

* Sort recent develop changes

* Remove sections for ChibiOS changes per tzarc

No ChibiOS changes this round.

* Add and sort recent develop changes

* add notes about keyboard moves/deletions

* import changelog for PR 12172

Documents the change to BOOTMAGIC_ENABLE.

* update section headings

* re-sort changelog

* add additional note regarding Bootmagic changes

* remove changelog timestamp

* update dates in main Breaking Changes docs

* fix broken section anchors in previous changelogs

* add link to backlight/eeprom patch to changelog

* highlight some more changes

* link PRs from section headers

* Restore standard readme

* run: qmk cformat --core-only

* CLI: Fix automagic (qmk#13046)

* merge/um70:via: Avoid sprintf() to make the code fit into flash (qmk#12919)

The code using sprintf() did not fit into flash when `merge/um70:via`
was compiled with avr-gcc 5.4.0:

     * The firmware is too large! 29756/28672 (1084 bytes over)

Replacing `sprintf(wpm_str, " %03d", current_wpm);` with custom
formatting code reduces the firmware size by 1504 bytes, which is enough
to make the `merge/um70:via` firmware fit:

    * The firmware size is approaching the maximum - 28252/28672 (98%, 420 bytes free)

* [Keyboard] jabberwocky via support (qmk#13029)

* [Keyboard] Added BOP support (qmk#12991)

Co-authored-by: Ryan <[email protected]>
Co-authored-by: Brandon Lewis <[email protected]>

* [Keyboard] Unicomp Mini M (qmk#12892)

* [Keyboard] Add Rubi Numpad (qmk#12283)

Co-authored-by: Drashna Jaelre <[email protected]>
Co-authored-by: Ryan <[email protected]>

* [Keymap] lja83's Planck keymap (qmk#12809)

Co-authored-by: Ryan <[email protected]>
Co-authored-by: Drashna Jaelre <[email protected]>
Co-authored-by: Jeff Apczynski <[email protected]>

* VIA compile fixes (qmk#13054)

* fix missing arg (qmk#13068)

* [Keymap] merge jdelkins userspace and associated keymaps (qmk#11276)

* [Keymap] merge jdelkins userspace and associated keymaps

* Add copyright & license info

* Change rgblight_config.enable to rgblight_is_enabled()

* Update keyboards/dz60/keymaps/jdelkins/keymap.c

Co-authored-by: Drashna Jaelre <[email protected]>

* Update keyboards/dz60/keymaps/jdelkins/keymap.c

Co-authored-by: Drashna Jaelre <[email protected]>

* Update keyboards/dz60/keymaps/jdelkins/keymap.c

Co-authored-by: Drashna Jaelre <[email protected]>

* Remove superfluous includes

* Change EXTRAFLAGS+=-flto to LTO_ENABLE=yes

* Remove unnecessary jdelkins_ss symlink in users

* Add copyright and license notices

* Use preferred way to determine capslock / numlock state

Co-authored-by: Drashna Jaelre <[email protected]>

* Add #pragma once to a header

Co-authored-by: Drashna Jaelre <[email protected]>

* Include QMK_KEYBOARD_H only once, in userspace header

* Remove unnecessary initialization in matrix_init_keymap

* Do process_record_keymap before cases handled in process_record_user

* Reorganize & simplify secrets feature enablement

* Use tap_code16

Co-authored-by: Ryan <[email protected]>

* Remove superfluous break

Co-authored-by: Ryan <[email protected]>

* Remove copyright from rules.mk

Co-authored-by: Ryan <[email protected]>

* Remove copyright from rules.mk

Co-authored-by: Ryan <[email protected]>

* Use tap_code16

Co-authored-by: Ryan <[email protected]>

* include "print.h" instead of <print.h>

Co-authored-by: Ryan <[email protected]>

* Use tap_cod16

Co-authored-by: Ryan <[email protected]>

* Use tap_code16

Co-authored-by: Ryan <[email protected]>

* Use tap_code16

Co-authored-by: Ryan <[email protected]>

* Use tap_code16

Co-authored-by: Ryan <[email protected]>

* Remove copyright from rules.mk

Co-authored-by: Ryan <[email protected]>

* add #pragma once to a header

Co-authored-by: Ryan <[email protected]>

* include "print.h" instead of <print.h>

Co-authored-by: Ryan <[email protected]>

* Remove copyright from rules.mk

Co-authored-by: Ryan <[email protected]>

* Remove copyright from rules.mk

Co-authored-by: Ryan <[email protected]>

* Remove copyright from rules.mk

Co-authored-by: Ryan <[email protected]>

* Use tap_code16

Co-authored-by: Ryan <[email protected]>

* Use tap_code16

Co-authored-by: Ryan <[email protected]>

* Use :flash target where possible

* Remove special case flash target and use PROGRAM_CMD

* dz60/jdelkins_ss: use tap_code16

Co-authored-by: Drashna Jaelre <[email protected]>
Co-authored-by: Ryan <[email protected]>

* Fix up WS2812 SPI driver on F072. (qmk#13022)

* Update noroadsleft userspace and keymaps (2021-06-02) (qmk#13086)

* Tidy up spi_master includes (qmk#13053)

* `qmk multibuild`: Fix bug with Path objects (qmk#13093)

* [Keymap] Update bcat's split_3x6_3 for Crkbd legacy removal (qmk#13097)

* Fix caps lock indicator on Bear65 PCB (qmk#12966)

* kbdfans/kbd67/rev2: add LAYOUT_65_ansi_split_space layout data (qmk#13102)

* Fix includes for pmw3360 driver (qmk#13108)

* update feature_layers.md translation (qmk#12752)

* Update Japanese document (qmk#10670)

Co-authored-by: Takeshi ISHII <[email protected]>

* JETVAN: Add initial support (qmk#12790)

Co-authored-by: Ryan <[email protected]>

* Corrected Number-pad numbers (qmk#13057)

* [Keymap] add id80/ansi/keymaps/msf (qmk#11957)

* Fixed ISO keyboard layout for the Mysterium rev1.1 board (qmk#12531)

* [Keyboard] add molecule (qmk#12601)

Co-authored-by: Ryan <[email protected]>
Co-authored-by: Drashna Jaelre <[email protected]>

* [Keyboard] Add program yoink via keymap (qmk#12645)

Co-authored-by: Ryan <[email protected]>

* [Docs] added basic midi documention of common features (qmk#13113)

Co-authored-by: precondition <[email protected]>
Co-authored-by: Ryan <[email protected]>
Co-authored-by: Joel Challis <[email protected]>

* Add default `ortho_1x1` layout (qmk#13118)

Co-authored-by: Erovia <[email protected]>
Co-authored-by: Ryan <[email protected]>
Co-authored-by: Jack Humbert <[email protected]>
Co-authored-by: Drashna Jaelre <[email protected]>
Co-authored-by: Gun Pinyo <[email protected]>
Co-authored-by: C1intMason <[email protected]>
Co-authored-by: Eithan Shavit <[email protected]>
Co-authored-by: Eithan Shavit <[email protected]>
Co-authored-by: stanrc85 <[email protected]>
Co-authored-by: Jonavin <[email protected]>
Co-authored-by: Stefano Pace <[email protected]>
Co-authored-by: James Young <[email protected]>
Co-authored-by: peepeetee <[email protected]>
Co-authored-by: Sean Browning <[email protected]>
Co-authored-by: Maddie O'Brien <[email protected]>
Co-authored-by: rainkeebs <[email protected]>
Co-authored-by: thompson-ele <[email protected]>
Co-authored-by: Evelien-Lillian Dekkers <[email protected]>
Co-authored-by: nopunin10did <[email protected]>
Co-authored-by: Rossman360 <[email protected]>
Co-authored-by: Christian Sandven <[email protected]>
Co-authored-by: DaneEvans <[email protected]>
Co-authored-by: CodeFreak <[email protected]>
Co-authored-by: Nick Brassel <[email protected]>
Co-authored-by: Sergey Vlasov <[email protected]>
Co-authored-by: lukeski14 <[email protected]>
Co-authored-by: Brandon Lewis <[email protected]>
Co-authored-by: Brandon Lewis <[email protected]>
Co-authored-by: Lander <[email protected]>
Co-authored-by: Gregorio <[email protected]>
Co-authored-by: Jeff Apczynski <[email protected]>
Co-authored-by: Jeff Apczynski <[email protected]>
Co-authored-by: Xelus22 <[email protected]>
Co-authored-by: Joel Elkins <[email protected]>
Co-authored-by: Jonathan Rascher <[email protected]>
Co-authored-by: umi <[email protected]>
Co-authored-by: shela <[email protected]>
Co-authored-by: Takeshi ISHII <[email protected]>
Co-authored-by: TerryMathews <[email protected]>
Co-authored-by: Nathan_Blais <[email protected]>
Co-authored-by: Miguel Filipe <[email protected]>
Co-authored-by: HalfHeuslerAlloy <[email protected]>
Co-authored-by: bbrfkr <[email protected]>
Co-authored-by: Matthew Dias <[email protected]>
Co-authored-by: wxyangf <[email protected]>
Co-authored-by: precondition <[email protected]>
Co-authored-by: Joel Challis <[email protected]>
@badgersow
Copy link

As promised, status update from me.
I've been using this new debouncing setting for 2 weeks and I've bumped it to 20ms eventually. I've also tried sym_defer_g with 5ms and quickly realized that I need to bump the timeout as well.
So, the conclusion is that I don't have a problem with algorithm, I have a problem with small timeout and the value 20-30ms seems to work fine for me for every algorithm I've tried.

@stapelberg
Copy link
Contributor Author

Thanks for reporting back! I’ll send PRs to increase the debounce value to 20ms.

Out of curiosity, how many years old are the Cherry switches on your board?

stapelberg added a commit to kinx-project/qmk_firmware that referenced this pull request Jun 26, 2021
@badgersow
Copy link

Thanks for doing this.

Out of curiosity, how many years old are the Cherry switches on your board?

I've bought the new keyboard and have been using it for 3 years. Sticker on the bottom says 2016, but I don't know if that means it was assembled in 2016 or not.

drashna pushed a commit that referenced this pull request Jul 1, 2021
jakeprime pushed a commit to jakeprime/qmk_firmware that referenced this pull request Jul 10, 2021
HokieGeek pushed a commit to HokieGeek/qmk_firmware that referenced this pull request Jul 11, 2021
* Add Per Key functionality for AutoShift (qmk#11536)

* LED Matrix: Reactive effect buffers & advanced indicators (qmk#12588)

* [Keyboard] kint36: switch to sym_eager_pk debouncing (qmk#12626)

* [Keyboard] kint2pp: reduce input latency by ≈10ms (qmk#12625)

* LED Matrix: Split (qmk#12633)

* [CI] Format code according to conventions (qmk#12650)

* feat: infinite timeout for leader key (qmk#6580)

* feat: implement leader_no_timeout logic

* docs(leader_key): infinite leader timeout docs

* Format code according to conventions (qmk#12680)

* Update ADC driver for STM32F1xx, STM32F3xx, STM32F4xx (qmk#12403)

* Fix default ADC_RESOLUTION for ADCv3 (and ADCv4)

Recent ChibiOS update removed ADC_CFGR1_RES_10BIT from the ADCv3 headers
(that macro should not have been there, because ADCv3 has CFGR instead of
CFGR1).  Fix the default value for ADC_RESOLUTION to use ADC_CFGR_RES_10BITS
if it is defined (that name is used for ADCv3 and ADCv4).

* Update ADC docs to match the actually used resolution

ADC driver for ChibiOS actually uses the 10-bit resolution by default
(probably to match AVR); fix the documentation accordingly.  Also add
both ADC_CFGR_RES_10BITS and ADC_CFGR1_RES_10BIT constants (these names
differ according to the ADC implementation in the particular MCU).

* Fix pinToMux() for B12 and B13 on STM32F3xx

Testing on STM32F303CCT6 revealed that the ADC mux values for B12 and
B13 pins were wrong.

* Add support for all possible analog pins on STM32F1xx

Added ADC mux values for pins A0...A7, B0, B1, C0...C5 on STM32F1xx
(they are the same at least for STM32F103x8 and larger F103 devices, and
also F102, F105, F107 families).  Actually tested on STM32F103C8T6
(therefore pins C0...C5 were not tested).

Pins F6...F10, which are present on STM32F103x[C-G] in 144-pin packages,
cannot be supported at the moment, because those pins are connected only
to ADC3, but the ChibiOS ADC driver for STM32F1xx supports only ADC1.

* Add support for all possible analog pins on STM32F4xx

Added ADC mux values for pins A0...A7, B0, B1, C0...C5 and optionally
F3...F10 (if STM32_ADC_USE_ADC3 is enabled).  These mux values are
apparently the same for all F4xx devices, except some smaller devices may
not have ADC3.

Actually tested on STM32F401CCU6, STM32F401CEU6, STM32F411CEU6 (using
various WeAct “Blackpill” boards); only pins A0...A7, B0, B1 were tested.

Pins F3...F10 are inside `#if STM32_ADC_USE_ADC3` because some devices
which don't have ADC3 also don't have the GPIOF port, therefore the code
which refers to Fx pins does not compile.

* Fix STM32F3xx ADC mux table in documentation

The ADC driver documentation had some errors in the mux table for STM32F3xx.
Fix this table to match the datasheet and the actual code (mux settings for
B12 and B13 were also tested on a real STM32F303CCT6 chip).

* Add STM32F1xx ADC pins to the documentation

* Add STM32F4xx ADC pins to the documentation

* Add initial support for tinyuf2 bootloader (when hosted on F411 blackpill) (qmk#12600)

* Add support for jumping to tinyuf2 bootloader. Adds blackpill UF2 example.

* Update flashing.md

* Update chconf.h

* Update config.h

* Update halconf.h

* Update mcuconf.h

* eeprom driver: Refactor where eeprom driver initialisation (and EEPROM emulation initialisation) occurs to make it non-target-specific. (qmk#12671)

* Add support for MCU = STM32F446 (qmk#12619)

* Add support for MCU = STM32F446

* Update platforms/chibios/GENERIC_STM32_F446XE/configs/config.h

* Restore mcuconf.h to the one used by RT-STM32F446RE-NUCLEO64

* stm32f446: update mcuconf.h and board.h for 16MHz operation, with USB enabled, and other peripherals disabled.

* Format code according to conventions (qmk#12682)

* Format code according to conventions (qmk#12687)

* Add STM32L433 and L443 support (qmk#12063)

* initial L433 commit

* change to XC

* fix L433

* disable all peripherals

* update system and peripheral clocks

* 433 change

* use its own board  files

* revert its own board files

* l433 specific change

* fix stm32l432xx define

* remove duplicate #define

* fix bootloader jump

* move to L443xx and add i2c2, spi2, usart3 to mcuconf.h

* move to L443

* move to L443

* fix sdmmc in mcuconf.h

* include STM32L443

* add L443

* Include L443 in compatible microcontrollers

* Include L443 in compatible microcontrollers

* Update config bootloader jump description

* Update ChibiOS define reasoning

* Update quantum/mcu_selection.mk

* fix git conflict

* Updated Function96 with V2 files and removed chconf.h and halconf.h (qmk#12613)

* Fix bad PR merge for qmk#6580. (qmk#12721)

* Change RGB/LED Matrix to use a simple define for USB suspend (qmk#12697)

* [CI] Format code according to conventions (qmk#12731)

* Fixing transport's led/rgb matrix suspend state logic (qmk#12770)

* [CI] Format code according to conventions (qmk#12772)

* Fix comment parsing (qmk#12750)

* Added OLED fade out support (qmk#12086)

* fix some references to bin/qmk that slipped in (qmk#12832)

* Resolve a number of warnings in `qmk generate-api` (qmk#12833)

* New command: qmk console (qmk#12828)

* stash poc

* stash

* tidy up implementation

* Tidy up slightly for review

* Tidy up slightly for review

* Bodge environment to make tests pass

* Refactor away from asyncio due to windows issues

* Filter devices

* align vid/pid printing

* Add hidapi to the installers

* start preparing for multiple hid_listeners

* udev rules for hid_listen

* refactor to move closer to end state

* very basic implementation of the threaded model

* refactor how vid/pid/index are supplied and parsed

* windows improvements

* read the report directly when usage page isn't available

* add per-device colors, the choice to show names or numbers, and refactor

* add timestamps

* Add support for showing bootloaders

* tweak the color for bootloaders

* Align bootloader disconnect with connect color

* add support for showing all bootloaders

* fix the pyusb check

* tweaks

* fix exception

* hide a stack trace behind -v

* add --no-bootloaders option

* add documentation for qmk console

* Apply suggestions from code review

* pyformat

* clean up and flesh out KNOWN_BOOTLOADERS

* Remove pointless SERIAL_LINK_ENABLE rules (qmk#12846)

* Make Swap Hands use PROGMEM (qmk#12284)

This converts the array that the Swap Hands feature uses to use PROGMEM,
and to read from that array, as such. Since this array never changes at
runtime, there is no reason to keep it in memory. Especially for AVR
boards, as memory is a precious resource.

* Fix another bin/qmk reference (qmk#12856)

* [Keymap] Turn OLED off on suspend in soundmonster keymap (qmk#10419)

* Fixup build errors on `develop` branch. (qmk#12723)

* LED Matrix: Effects! (qmk#12651)

* Fix syntax error when compiling for ARM (qmk#12866)

* Remove KEYMAP and LAYOUT_kc (qmk#12160)

* alias KEYMAP to LAYOUT

* remove KEYMAP and LAYOUT_kc

* Add setup, clone, and env to the list of commands we allow even with broken modules (qmk#12868)

* Rename `point_t` -> `led_point_t` (qmk#12864)

* [Keyboard] updated a vendor name / fixed minor keymap issues (qmk#12881)

* Add missing LED Matrix suspend code to suspend.c (qmk#12878)

* LED Matrix: Documentation (qmk#12685)

* Deprecate `send_unicode_hex_string()` (qmk#12602)

* Fix spelling mistake regarding LED Matrix in split_common. (qmk#12888)

* [Keymap] Fix QWERTY/DVORAK status output for kzar keymap (qmk#12895)

* Use milc.subcommand.config instead of qmk.cli.config (qmk#12915)

* Use milc.subcommand.config instead

* pyformat

* remove the config test

* Add function to allow repeated blinking of one layer (qmk#12237)

* Implement function rgblight_blink_layer_repeat to allow repeated blinking of one layer at a time

* Update doc

* Rework rgblight blinking according to requested change

* optimize storage

* Fixup housekeeping from being invoked twice per loop. (qmk#12933)

* matrix: wait for row signal to go HIGH for every row (qmk#12945)

I noticed this discrepancy (last row of the matrix treated differently than the
others) when optimizing the input latency of my keyboard controller, see also
https://michael.stapelberg.ch/posts/2021-05-08-keyboard-input-latency-qmk-kinesis/

Before this commit, when tuning the delays I noticed ghost key presses when
pressing the F2 key, which is on the last row of the keyboard matrix: the
dead_grave key, which is on the first row of the keyboard matrix, would be
incorrectly detected as pressed.

After this commit, all keyboard matrix rows are interpreted correctly.

I suspect that my setup is more susceptible to this nuance than others because I
use GPIO_INPUT_PIN_DELAY=0 and hence don’t have another delay that might mask
the problem.

* ensure we do not conflict with existing keymap aliases (qmk#12976)

* Add support for up to 4 IS31FL3733 drivers (qmk#12342)

* Convert Encoder callbacks to be boolean functions (qmk#12805)

* [Keyboard] Fix Terrazzo build failure (qmk#12977)

* Do not hard set config in CPTC files (qmk#11864)

* [Keyboard] Corne - Remove legacy revision support (qmk#12226)

* [Keymap] Update to Drashna keymap and user code (based on develop) (qmk#12936)

* Add Full-duplex serial driver for ARM boards (qmk#9842)

* Document LED_MATRIX_FRAMEBUFFER_EFFECTS (qmk#12987)

* Backlight: add defines for default level and breathing state (qmk#12560)

* Add dire message about LUFA mass storage bootloader (qmk#13014)

* [Keyboard] Remove redundant legacy and common headers for crkbd (qmk#13023)

Was causing compiler errors on some systems.

* Fix keyboards/keymaps for boolean encoder callback changes (qmk#12985)

* `backlight.c`: include `eeprom.h` (qmk#13024)

* Add changelog for 2021-05-29 Breaking Changes merge (qmk#12939)

* Add ChangeLog for 2021-05-29 Breaking Changes Merge: initial version

* Add recent develop changes

* Sort recent develop changes

* Remove sections for ChibiOS changes per tzarc

No ChibiOS changes this round.

* Add and sort recent develop changes

* add notes about keyboard moves/deletions

* import changelog for PR 12172

Documents the change to BOOTMAGIC_ENABLE.

* update section headings

* re-sort changelog

* add additional note regarding Bootmagic changes

* remove changelog timestamp

* update dates in main Breaking Changes docs

* fix broken section anchors in previous changelogs

* add link to backlight/eeprom patch to changelog

* highlight some more changes

* link PRs from section headers

* Restore standard readme

* run: qmk cformat --core-only
HokieGeek pushed a commit to HokieGeek/qmk_firmware that referenced this pull request Jul 11, 2021
wox pushed a commit to wox/qmk_firmware that referenced this pull request Aug 14, 2021
nhongooi pushed a commit to nhongooi/qmk_firmware that referenced this pull request Dec 5, 2021
nhongooi pushed a commit to nhongooi/qmk_firmware that referenced this pull request Dec 5, 2021
* Add Per Key functionality for AutoShift (qmk#11536)

* LED Matrix: Reactive effect buffers & advanced indicators (qmk#12588)

* [Keyboard] kint36: switch to sym_eager_pk debouncing (qmk#12626)

* [Keyboard] kint2pp: reduce input latency by ≈10ms (qmk#12625)

* LED Matrix: Split (qmk#12633)

* [CI] Format code according to conventions (qmk#12650)

* feat: infinite timeout for leader key (qmk#6580)

* feat: implement leader_no_timeout logic

* docs(leader_key): infinite leader timeout docs

* Format code according to conventions (qmk#12680)

* Update ADC driver for STM32F1xx, STM32F3xx, STM32F4xx (qmk#12403)

* Fix default ADC_RESOLUTION for ADCv3 (and ADCv4)

Recent ChibiOS update removed ADC_CFGR1_RES_10BIT from the ADCv3 headers
(that macro should not have been there, because ADCv3 has CFGR instead of
CFGR1).  Fix the default value for ADC_RESOLUTION to use ADC_CFGR_RES_10BITS
if it is defined (that name is used for ADCv3 and ADCv4).

* Update ADC docs to match the actually used resolution

ADC driver for ChibiOS actually uses the 10-bit resolution by default
(probably to match AVR); fix the documentation accordingly.  Also add
both ADC_CFGR_RES_10BITS and ADC_CFGR1_RES_10BIT constants (these names
differ according to the ADC implementation in the particular MCU).

* Fix pinToMux() for B12 and B13 on STM32F3xx

Testing on STM32F303CCT6 revealed that the ADC mux values for B12 and
B13 pins were wrong.

* Add support for all possible analog pins on STM32F1xx

Added ADC mux values for pins A0...A7, B0, B1, C0...C5 on STM32F1xx
(they are the same at least for STM32F103x8 and larger F103 devices, and
also F102, F105, F107 families).  Actually tested on STM32F103C8T6
(therefore pins C0...C5 were not tested).

Pins F6...F10, which are present on STM32F103x[C-G] in 144-pin packages,
cannot be supported at the moment, because those pins are connected only
to ADC3, but the ChibiOS ADC driver for STM32F1xx supports only ADC1.

* Add support for all possible analog pins on STM32F4xx

Added ADC mux values for pins A0...A7, B0, B1, C0...C5 and optionally
F3...F10 (if STM32_ADC_USE_ADC3 is enabled).  These mux values are
apparently the same for all F4xx devices, except some smaller devices may
not have ADC3.

Actually tested on STM32F401CCU6, STM32F401CEU6, STM32F411CEU6 (using
various WeAct “Blackpill” boards); only pins A0...A7, B0, B1 were tested.

Pins F3...F10 are inside `#if STM32_ADC_USE_ADC3` because some devices
which don't have ADC3 also don't have the GPIOF port, therefore the code
which refers to Fx pins does not compile.

* Fix STM32F3xx ADC mux table in documentation

The ADC driver documentation had some errors in the mux table for STM32F3xx.
Fix this table to match the datasheet and the actual code (mux settings for
B12 and B13 were also tested on a real STM32F303CCT6 chip).

* Add STM32F1xx ADC pins to the documentation

* Add STM32F4xx ADC pins to the documentation

* Add initial support for tinyuf2 bootloader (when hosted on F411 blackpill) (qmk#12600)

* Add support for jumping to tinyuf2 bootloader. Adds blackpill UF2 example.

* Update flashing.md

* Update chconf.h

* Update config.h

* Update halconf.h

* Update mcuconf.h

* eeprom driver: Refactor where eeprom driver initialisation (and EEPROM emulation initialisation) occurs to make it non-target-specific. (qmk#12671)

* Add support for MCU = STM32F446 (qmk#12619)

* Add support for MCU = STM32F446

* Update platforms/chibios/GENERIC_STM32_F446XE/configs/config.h

* Restore mcuconf.h to the one used by RT-STM32F446RE-NUCLEO64

* stm32f446: update mcuconf.h and board.h for 16MHz operation, with USB enabled, and other peripherals disabled.

* Format code according to conventions (qmk#12682)

* Format code according to conventions (qmk#12687)

* Add STM32L433 and L443 support (qmk#12063)

* initial L433 commit

* change to XC

* fix L433

* disable all peripherals

* update system and peripheral clocks

* 433 change

* use its own board  files

* revert its own board files

* l433 specific change

* fix stm32l432xx define

* remove duplicate #define

* fix bootloader jump

* move to L443xx and add i2c2, spi2, usart3 to mcuconf.h

* move to L443

* move to L443

* fix sdmmc in mcuconf.h

* include STM32L443

* add L443

* Include L443 in compatible microcontrollers

* Include L443 in compatible microcontrollers

* Update config bootloader jump description

* Update ChibiOS define reasoning

* Update quantum/mcu_selection.mk

* fix git conflict

* Updated Function96 with V2 files and removed chconf.h and halconf.h (qmk#12613)

* Fix bad PR merge for qmk#6580. (qmk#12721)

* Change RGB/LED Matrix to use a simple define for USB suspend (qmk#12697)

* [CI] Format code according to conventions (qmk#12731)

* Fixing transport's led/rgb matrix suspend state logic (qmk#12770)

* [CI] Format code according to conventions (qmk#12772)

* Fix comment parsing (qmk#12750)

* Added OLED fade out support (qmk#12086)

* fix some references to bin/qmk that slipped in (qmk#12832)

* Resolve a number of warnings in `qmk generate-api` (qmk#12833)

* New command: qmk console (qmk#12828)

* stash poc

* stash

* tidy up implementation

* Tidy up slightly for review

* Tidy up slightly for review

* Bodge environment to make tests pass

* Refactor away from asyncio due to windows issues

* Filter devices

* align vid/pid printing

* Add hidapi to the installers

* start preparing for multiple hid_listeners

* udev rules for hid_listen

* refactor to move closer to end state

* very basic implementation of the threaded model

* refactor how vid/pid/index are supplied and parsed

* windows improvements

* read the report directly when usage page isn't available

* add per-device colors, the choice to show names or numbers, and refactor

* add timestamps

* Add support for showing bootloaders

* tweak the color for bootloaders

* Align bootloader disconnect with connect color

* add support for showing all bootloaders

* fix the pyusb check

* tweaks

* fix exception

* hide a stack trace behind -v

* add --no-bootloaders option

* add documentation for qmk console

* Apply suggestions from code review

* pyformat

* clean up and flesh out KNOWN_BOOTLOADERS

* Remove pointless SERIAL_LINK_ENABLE rules (qmk#12846)

* Make Swap Hands use PROGMEM (qmk#12284)

This converts the array that the Swap Hands feature uses to use PROGMEM,
and to read from that array, as such. Since this array never changes at
runtime, there is no reason to keep it in memory. Especially for AVR
boards, as memory is a precious resource.

* Fix another bin/qmk reference (qmk#12856)

* [Keymap] Turn OLED off on suspend in soundmonster keymap (qmk#10419)

* Fixup build errors on `develop` branch. (qmk#12723)

* LED Matrix: Effects! (qmk#12651)

* Fix syntax error when compiling for ARM (qmk#12866)

* Remove KEYMAP and LAYOUT_kc (qmk#12160)

* alias KEYMAP to LAYOUT

* remove KEYMAP and LAYOUT_kc

* Add setup, clone, and env to the list of commands we allow even with broken modules (qmk#12868)

* Rename `point_t` -> `led_point_t` (qmk#12864)

* [Keyboard] updated a vendor name / fixed minor keymap issues (qmk#12881)

* Add missing LED Matrix suspend code to suspend.c (qmk#12878)

* LED Matrix: Documentation (qmk#12685)

* Deprecate `send_unicode_hex_string()` (qmk#12602)

* Fix spelling mistake regarding LED Matrix in split_common. (qmk#12888)

* [Keymap] Fix QWERTY/DVORAK status output for kzar keymap (qmk#12895)

* Use milc.subcommand.config instead of qmk.cli.config (qmk#12915)

* Use milc.subcommand.config instead

* pyformat

* remove the config test

* Add function to allow repeated blinking of one layer (qmk#12237)

* Implement function rgblight_blink_layer_repeat to allow repeated blinking of one layer at a time

* Update doc

* Rework rgblight blinking according to requested change

* optimize storage

* Fixup housekeeping from being invoked twice per loop. (qmk#12933)

* matrix: wait for row signal to go HIGH for every row (qmk#12945)

I noticed this discrepancy (last row of the matrix treated differently than the
others) when optimizing the input latency of my keyboard controller, see also
https://michael.stapelberg.ch/posts/2021-05-08-keyboard-input-latency-qmk-kinesis/

Before this commit, when tuning the delays I noticed ghost key presses when
pressing the F2 key, which is on the last row of the keyboard matrix: the
dead_grave key, which is on the first row of the keyboard matrix, would be
incorrectly detected as pressed.

After this commit, all keyboard matrix rows are interpreted correctly.

I suspect that my setup is more susceptible to this nuance than others because I
use GPIO_INPUT_PIN_DELAY=0 and hence don’t have another delay that might mask
the problem.

* ensure we do not conflict with existing keymap aliases (qmk#12976)

* Add support for up to 4 IS31FL3733 drivers (qmk#12342)

* Convert Encoder callbacks to be boolean functions (qmk#12805)

* [Keyboard] Fix Terrazzo build failure (qmk#12977)

* Do not hard set config in CPTC files (qmk#11864)

* [Keyboard] Corne - Remove legacy revision support (qmk#12226)

* [Keymap] Update to Drashna keymap and user code (based on develop) (qmk#12936)

* Add Full-duplex serial driver for ARM boards (qmk#9842)

* Document LED_MATRIX_FRAMEBUFFER_EFFECTS (qmk#12987)

* Backlight: add defines for default level and breathing state (qmk#12560)

* Add dire message about LUFA mass storage bootloader (qmk#13014)

* [Keyboard] Remove redundant legacy and common headers for crkbd (qmk#13023)

Was causing compiler errors on some systems.

* Fix keyboards/keymaps for boolean encoder callback changes (qmk#12985)

* `backlight.c`: include `eeprom.h` (qmk#13024)

* Add changelog for 2021-05-29 Breaking Changes merge (qmk#12939)

* Add ChangeLog for 2021-05-29 Breaking Changes Merge: initial version

* Add recent develop changes

* Sort recent develop changes

* Remove sections for ChibiOS changes per tzarc

No ChibiOS changes this round.

* Add and sort recent develop changes

* add notes about keyboard moves/deletions

* import changelog for PR 12172

Documents the change to BOOTMAGIC_ENABLE.

* update section headings

* re-sort changelog

* add additional note regarding Bootmagic changes

* remove changelog timestamp

* update dates in main Breaking Changes docs

* fix broken section anchors in previous changelogs

* add link to backlight/eeprom patch to changelog

* highlight some more changes

* link PRs from section headers

* Restore standard readme

* run: qmk cformat --core-only
nhongooi pushed a commit to nhongooi/qmk_firmware that referenced this pull request Dec 5, 2021
BorisTestov pushed a commit to BorisTestov/qmk_firmware that referenced this pull request May 23, 2024
* Add Per Key functionality for AutoShift (qmk#11536)

* LED Matrix: Reactive effect buffers & advanced indicators (qmk#12588)

* [Keyboard] kint36: switch to sym_eager_pk debouncing (qmk#12626)

* [Keyboard] kint2pp: reduce input latency by ≈10ms (qmk#12625)

* LED Matrix: Split (qmk#12633)

* [CI] Format code according to conventions (qmk#12650)

* feat: infinite timeout for leader key (qmk#6580)

* feat: implement leader_no_timeout logic

* docs(leader_key): infinite leader timeout docs

* Format code according to conventions (qmk#12680)

* Update ADC driver for STM32F1xx, STM32F3xx, STM32F4xx (qmk#12403)

* Fix default ADC_RESOLUTION for ADCv3 (and ADCv4)

Recent ChibiOS update removed ADC_CFGR1_RES_10BIT from the ADCv3 headers
(that macro should not have been there, because ADCv3 has CFGR instead of
CFGR1).  Fix the default value for ADC_RESOLUTION to use ADC_CFGR_RES_10BITS
if it is defined (that name is used for ADCv3 and ADCv4).

* Update ADC docs to match the actually used resolution

ADC driver for ChibiOS actually uses the 10-bit resolution by default
(probably to match AVR); fix the documentation accordingly.  Also add
both ADC_CFGR_RES_10BITS and ADC_CFGR1_RES_10BIT constants (these names
differ according to the ADC implementation in the particular MCU).

* Fix pinToMux() for B12 and B13 on STM32F3xx

Testing on STM32F303CCT6 revealed that the ADC mux values for B12 and
B13 pins were wrong.

* Add support for all possible analog pins on STM32F1xx

Added ADC mux values for pins A0...A7, B0, B1, C0...C5 on STM32F1xx
(they are the same at least for STM32F103x8 and larger F103 devices, and
also F102, F105, F107 families).  Actually tested on STM32F103C8T6
(therefore pins C0...C5 were not tested).

Pins F6...F10, which are present on STM32F103x[C-G] in 144-pin packages,
cannot be supported at the moment, because those pins are connected only
to ADC3, but the ChibiOS ADC driver for STM32F1xx supports only ADC1.

* Add support for all possible analog pins on STM32F4xx

Added ADC mux values for pins A0...A7, B0, B1, C0...C5 and optionally
F3...F10 (if STM32_ADC_USE_ADC3 is enabled).  These mux values are
apparently the same for all F4xx devices, except some smaller devices may
not have ADC3.

Actually tested on STM32F401CCU6, STM32F401CEU6, STM32F411CEU6 (using
various WeAct “Blackpill” boards); only pins A0...A7, B0, B1 were tested.

Pins F3...F10 are inside `#if STM32_ADC_USE_ADC3` because some devices
which don't have ADC3 also don't have the GPIOF port, therefore the code
which refers to Fx pins does not compile.

* Fix STM32F3xx ADC mux table in documentation

The ADC driver documentation had some errors in the mux table for STM32F3xx.
Fix this table to match the datasheet and the actual code (mux settings for
B12 and B13 were also tested on a real STM32F303CCT6 chip).

* Add STM32F1xx ADC pins to the documentation

* Add STM32F4xx ADC pins to the documentation

* Add initial support for tinyuf2 bootloader (when hosted on F411 blackpill) (qmk#12600)

* Add support for jumping to tinyuf2 bootloader. Adds blackpill UF2 example.

* Update flashing.md

* Update chconf.h

* Update config.h

* Update halconf.h

* Update mcuconf.h

* eeprom driver: Refactor where eeprom driver initialisation (and EEPROM emulation initialisation) occurs to make it non-target-specific. (qmk#12671)

* Add support for MCU = STM32F446 (qmk#12619)

* Add support for MCU = STM32F446

* Update platforms/chibios/GENERIC_STM32_F446XE/configs/config.h

* Restore mcuconf.h to the one used by RT-STM32F446RE-NUCLEO64

* stm32f446: update mcuconf.h and board.h for 16MHz operation, with USB enabled, and other peripherals disabled.

* Format code according to conventions (qmk#12682)

* Format code according to conventions (qmk#12687)

* Add STM32L433 and L443 support (qmk#12063)

* initial L433 commit

* change to XC

* fix L433

* disable all peripherals

* update system and peripheral clocks

* 433 change

* use its own board  files

* revert its own board files

* l433 specific change

* fix stm32l432xx define

* remove duplicate #define

* fix bootloader jump

* move to L443xx and add i2c2, spi2, usart3 to mcuconf.h

* move to L443

* move to L443

* fix sdmmc in mcuconf.h

* include STM32L443

* add L443

* Include L443 in compatible microcontrollers

* Include L443 in compatible microcontrollers

* Update config bootloader jump description

* Update ChibiOS define reasoning

* Update quantum/mcu_selection.mk

* fix git conflict

* Updated Function96 with V2 files and removed chconf.h and halconf.h (qmk#12613)

* Fix bad PR merge for qmk#6580. (qmk#12721)

* Change RGB/LED Matrix to use a simple define for USB suspend (qmk#12697)

* [CI] Format code according to conventions (qmk#12731)

* Fixing transport's led/rgb matrix suspend state logic (qmk#12770)

* [CI] Format code according to conventions (qmk#12772)

* Fix comment parsing (qmk#12750)

* Added OLED fade out support (qmk#12086)

* fix some references to bin/qmk that slipped in (qmk#12832)

* Resolve a number of warnings in `qmk generate-api` (qmk#12833)

* New command: qmk console (qmk#12828)

* stash poc

* stash

* tidy up implementation

* Tidy up slightly for review

* Tidy up slightly for review

* Bodge environment to make tests pass

* Refactor away from asyncio due to windows issues

* Filter devices

* align vid/pid printing

* Add hidapi to the installers

* start preparing for multiple hid_listeners

* udev rules for hid_listen

* refactor to move closer to end state

* very basic implementation of the threaded model

* refactor how vid/pid/index are supplied and parsed

* windows improvements

* read the report directly when usage page isn't available

* add per-device colors, the choice to show names or numbers, and refactor

* add timestamps

* Add support for showing bootloaders

* tweak the color for bootloaders

* Align bootloader disconnect with connect color

* add support for showing all bootloaders

* fix the pyusb check

* tweaks

* fix exception

* hide a stack trace behind -v

* add --no-bootloaders option

* add documentation for qmk console

* Apply suggestions from code review

* pyformat

* clean up and flesh out KNOWN_BOOTLOADERS

* Remove pointless SERIAL_LINK_ENABLE rules (qmk#12846)

* Make Swap Hands use PROGMEM (qmk#12284)

This converts the array that the Swap Hands feature uses to use PROGMEM,
and to read from that array, as such. Since this array never changes at
runtime, there is no reason to keep it in memory. Especially for AVR
boards, as memory is a precious resource.

* Fix another bin/qmk reference (qmk#12856)

* [Keymap] Turn OLED off on suspend in soundmonster keymap (qmk#10419)

* Fixup build errors on `develop` branch. (qmk#12723)

* LED Matrix: Effects! (qmk#12651)

* Fix syntax error when compiling for ARM (qmk#12866)

* Remove KEYMAP and LAYOUT_kc (qmk#12160)

* alias KEYMAP to LAYOUT

* remove KEYMAP and LAYOUT_kc

* Add setup, clone, and env to the list of commands we allow even with broken modules (qmk#12868)

* Rename `point_t` -> `led_point_t` (qmk#12864)

* [Keyboard] updated a vendor name / fixed minor keymap issues (qmk#12881)

* Add missing LED Matrix suspend code to suspend.c (qmk#12878)

* LED Matrix: Documentation (qmk#12685)

* Deprecate `send_unicode_hex_string()` (qmk#12602)

* Fix spelling mistake regarding LED Matrix in split_common. (qmk#12888)

* [Keymap] Fix QWERTY/DVORAK status output for kzar keymap (qmk#12895)

* Use milc.subcommand.config instead of qmk.cli.config (qmk#12915)

* Use milc.subcommand.config instead

* pyformat

* remove the config test

* Add function to allow repeated blinking of one layer (qmk#12237)

* Implement function rgblight_blink_layer_repeat to allow repeated blinking of one layer at a time

* Update doc

* Rework rgblight blinking according to requested change

* optimize storage

* Fixup housekeeping from being invoked twice per loop. (qmk#12933)

* matrix: wait for row signal to go HIGH for every row (qmk#12945)

I noticed this discrepancy (last row of the matrix treated differently than the
others) when optimizing the input latency of my keyboard controller, see also
https://michael.stapelberg.ch/posts/2021-05-08-keyboard-input-latency-qmk-kinesis/

Before this commit, when tuning the delays I noticed ghost key presses when
pressing the F2 key, which is on the last row of the keyboard matrix: the
dead_grave key, which is on the first row of the keyboard matrix, would be
incorrectly detected as pressed.

After this commit, all keyboard matrix rows are interpreted correctly.

I suspect that my setup is more susceptible to this nuance than others because I
use GPIO_INPUT_PIN_DELAY=0 and hence don’t have another delay that might mask
the problem.

* ensure we do not conflict with existing keymap aliases (qmk#12976)

* Add support for up to 4 IS31FL3733 drivers (qmk#12342)

* Convert Encoder callbacks to be boolean functions (qmk#12805)

* [Keyboard] Fix Terrazzo build failure (qmk#12977)

* Do not hard set config in CPTC files (qmk#11864)

* [Keyboard] Corne - Remove legacy revision support (qmk#12226)

* [Keymap] Update to Drashna keymap and user code (based on develop) (qmk#12936)

* Add Full-duplex serial driver for ARM boards (qmk#9842)

* Document LED_MATRIX_FRAMEBUFFER_EFFECTS (qmk#12987)

* Backlight: add defines for default level and breathing state (qmk#12560)

* Add dire message about LUFA mass storage bootloader (qmk#13014)

* [Keyboard] Remove redundant legacy and common headers for crkbd (qmk#13023)

Was causing compiler errors on some systems.

* Fix keyboards/keymaps for boolean encoder callback changes (qmk#12985)

* `backlight.c`: include `eeprom.h` (qmk#13024)

* Add changelog for 2021-05-29 Breaking Changes merge (qmk#12939)

* Add ChangeLog for 2021-05-29 Breaking Changes Merge: initial version

* Add recent develop changes

* Sort recent develop changes

* Remove sections for ChibiOS changes per tzarc

No ChibiOS changes this round.

* Add and sort recent develop changes

* add notes about keyboard moves/deletions

* import changelog for PR 12172

Documents the change to BOOTMAGIC_ENABLE.

* update section headings

* re-sort changelog

* add additional note regarding Bootmagic changes

* remove changelog timestamp

* update dates in main Breaking Changes docs

* fix broken section anchors in previous changelogs

* add link to backlight/eeprom patch to changelog

* highlight some more changes

* link PRs from section headers

* Restore standard readme

* run: qmk cformat --core-only
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants