Add hotfix for chibios keyboards not wake #10088

LSChyi · 2020-08-19T08:39:57Z

Reconnect the USB if users wake up a computer from the keyboard to restore the USB state.

Description

Keyboards using STM32 controllers with Chibios are suffering from keyboards that are frozen due to the USB state detection problem when waking up the computer from that keyboard. The hotfix forces the keyboard to reconnect to the computer.

Types of Changes

Issues Fixed or Closed by This PR

[Bug] keyboard stops responding after power cycles and found where goes wrong #9962

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).

tzarc · 2020-08-20T11:13:28Z

Tested this PR against my MacBook Pro once I'd worked out the timing when the KB actually enters suspend.
This PR definitely gets the keyboard working again, but it doesn't seem to actually wake up the computer it's connected to on the first keypress -- a second one is required to get it to actually wake.

LSChyi · 2020-08-20T12:02:55Z

A stupid idea: if I call the usbWakeupHost(&USB_DRIVER); twice, will it solve the problem?

tzarc · 2020-08-21T23:27:03Z

Sadly not. Tapping something twice is definitely better than locking up the keyboard, though.

tzarc

I think I'd prefer to get this in as-is, and treat the double-tap requirement for wakeup as a separate issue.

fauxpark · 2020-08-22T04:23:49Z

I have a feeling the solution to that will be to completely revert this and use a different approach. I especially am not fond of the 1.5 second blocking wait here.

tzarc · 2020-08-22T12:00:38Z

I have a feeling the solution to that will be to completely revert this and use a different approach. I especially am not fond of the 1.5 second blocking wait here.

Neither; however a temporary solution that doesn't result in a lockup seemed like it was a step in the right direction for now.

LSChyi · 2020-08-23T15:03:20Z

@fauxpark I found that even if I disable the 1.5 seconds blocking wait, the keyboard can back to work without any problem, so most likely the current configuration for STM32F401 or the Chibios implementation has some problem.

@tzarc can you try to disable the 1.5 seconds blocking and see if you need a second press to wake the computer? I can wake the computer in just one keypress with/without the 1.5 seconds wait, so I can not test the problem you have, thank you, guys!

tzarc · 2020-08-24T02:40:18Z

It seems removing the wait_ms(1500) works perfectly fine as well, on the F401.

drashna · 2020-08-24T05:40:23Z

I have a feeling the solution to that will be to completely revert this and use a different approach. I especially am not fond of the 1.5 second blocking wait here.

Maybe, but periodically, we (ZSA) have had reports of this, and it creates a very bad user experience. A fix that mostly works is better than none at all.

And yeah, I'd rather a fully flushed out solution, but ... if it works now...

It seems removing the wait_ms(1500) works perfectly fine as well, on the F401.

I'd almost be inclined to say make it a define, so it can be adjusted/disabled.

fauxpark · 2020-08-24T05:42:41Z

@drashna the thing is, I'm not seeing this issue on my Proton-C... so I think your problem lies elsewhere.

tzarc · 2020-08-24T05:55:03Z

I'd almost be inclined to say make it a define, so it can be adjusted/disabled.

Agreed -- I've had cases where things like the SPLIT_USB_DETECT timeout isn't long enough, and I'd be surprised if this isn't in a similar boat. Something like this, I guess:

#if defined(USB_SUSPEND_RESTART_DELAY) && (USB_SUSPEND_RESTART_DELAY > 0)
wait_ms(USB_SUSPEND_RESTART_DELAY);
#endif

tzarc · 2020-08-24T05:56:47Z

@drashna the thing is, I'm not seeing this issue on my Proton-C... so I think your problem lies elsewhere.

Pretty sure this specific trigger scenario is limited to OTG-based STM32's... I'm not sure if it solves F303 or any other non-OTG MCU, as we don't have any specific reproduction scenarios for that case. It definitely helps with OTG devices, though.

LSChyi · 2020-08-24T06:00:45Z

ok, so maybe I use a name like OTG_BASED_USB to control whether to turn on this feature?

tzarc · 2020-08-24T06:07:42Z

ok, so maybe I use a name like OTG_BASED_USB to control whether to turn on this feature?

I wasn't seeing any issues with this implementation on non-OTG devices, so I'd rather keep it in on the off chance that it does indeed fix the sleep issue people were having on non-OTG devices too.

su8044 · 2020-09-11T21:22:30Z

Applied the latest version and it's working perfectly.
(edit: spelling)

firetech · 2021-05-08T14:51:54Z

This fix seems to have had the completely opposite effect on Ergodox Infinity (i.e. keyboard is now dead after it wakes the host, but works fine if I comment out the call to restart_usb_driver). I tried setting USB_SUSPEND_WAKEUP_DELAY, but it didn't help. I guess the best fix would be an #ifdef around restart_usb_driver, but what should it check for?

fauxpark · 2021-05-08T15:07:47Z

My opinion is still that I would rather this be reverted completely and the actual root cause identified and fixed. I'm not keen on having ifdefs like that in code that is supposed to Just Work for all ChibiOS boards, unless absolutely necessary.

LSChyi · 2021-05-08T15:27:42Z

@fauxpark I agree this is just a hotfix, as the title already said, is there any good suggestion for debugging this? Also, if it is the case as you said, that is, this behavior only happens on STM32F4 boards and not for every board, then I think in the end we will add an option to turn on/off this behavior for specific boards.

It seems to _cause_ the issue it intended to solve there.

Now only affects Ergodox Infinity, Whitefox and K-type, though. Switches over Ergodox Infinity to the `IC_TEENSY_3_1` board, since that was a nice place to implement the `restart_usb_driver` override. However, I would guess this issue is present for other K20x/Teensy 3.1 boards as well...

…2870) * Remove the #10088 hotfix for K20x MCU:s. It seems to _cause_ the issue it intended to solve there. * Cleaner way of removing #10088 hotfix. Now only affects Ergodox Infinity, Whitefox and K-type, though. Switches over Ergodox Infinity to the `IC_TEENSY_3_1` board, since that was a nice place to implement the `restart_usb_driver` override. However, I would guess this issue is present for other K20x/Teensy 3.1 boards as well... * Fix comment regarding `IC_TEENSY_3_1` for all keyboards using it.

…mk#12870) * Remove the qmk#10088 hotfix for K20x MCU:s. It seems to _cause_ the issue it intended to solve there. * Cleaner way of removing qmk#10088 hotfix. Now only affects Ergodox Infinity, Whitefox and K-type, though. Switches over Ergodox Infinity to the `IC_TEENSY_3_1` board, since that was a nice place to implement the `restart_usb_driver` override. However, I would guess this issue is present for other K20x/Teensy 3.1 boards as well... * Fix comment regarding `IC_TEENSY_3_1` for all keyboards using it.

* Branch point for 2020 November 28 Breaking Change * Remove matrix_col_t to allow MATRIX_ROWS > 32 (qmk#10183) * Add support for soft serial to ATmega32U2 (qmk#10204) * Change MIDI velocity implementation to allow direct control of velocity value (qmk#9940) * Add ability to build a subset of all keyboards based on platform. * Actually use eeprom_driver_init(). * Make bootloader_jump weak for ChibiOS. (qmk#10417) * Joystick 16-bit support (qmk#10439) * Per-encoder resolutions (qmk#10259) * Share button state from mousekey to pointing_device (qmk#10179) * Add hotfix for chibios keyboards not wake (qmk#10088) * Add advanced/efficient RGB Matrix Indicators (qmk#8564) * Naming change. * Support for STM32 GPIOF,G,H,I,J,K (qmk#10206) * Add milc as a dependency and remove the installed milc (qmk#10563) * ChibiOS upgrade: early init conversions (qmk#10214) * ChibiOS upgrade: configuration file migrator (qmk#9952) * Haptic and solenoid cleanup (qmk#9700) * XD75 cleanup (qmk#10524) * OLED display update interval support (qmk#10388) * Add definition based on currently-selected serial driver. (qmk#10716) * New feature: Retro Tapping per key (qmk#10622) * Allow for modification of output RGB values when using rgblight/rgb_matrix. (qmk#10638) * Add housekeeping task callbacks so that keyboards/keymaps are capable of executing code for each main loop iteration. (qmk#10530) * Rescale both ChibiOS and AVR backlighting. * Reduce Helix keyboard build variation (qmk#8669) * Minor change to behavior allowing display updates to continue between task ticks (qmk#10750) * Some GPIO manipulations in matrix.c change to atomic. (qmk#10491) * qmk cformat (qmk#10767) * [Keyboard] Update the Speedo firmware for v3.0 (qmk#10657) * Maartenwut/Maarten namechange to evyd13/Evy (qmk#10274) * [quantum] combine repeated lines of code (qmk#10837) * Add step sequencer feature (qmk#9703) * aeboards/ext65 refactor (qmk#10820) * Refactor xelus/dawn60 for Rev2 later (qmk#10584) * add DEBUG_MATRIX_SCAN_RATE_ENABLE to common_features.mk (qmk#10824) * [Core] Added `add_oneshot_mods` & `del_oneshot_mods` (qmk#10549) * update chibios os usb for the otg driver (qmk#8893) * Remove HD44780 References, Part 4 (qmk#10735) * [Keyboard] Add Valor FRL TKL (+refactor) (qmk#10512) * Fix cursor position bug in oled_write_raw functions (qmk#10800) * Fixup version.h writing when using SKIP_VERSION=yes (qmk#10972) * Allow for certain code in the codebase assuming length of string. (qmk#10974) * Add AT90USB support for serial.c (qmk#10706) * Auto shift: support repeats and early registration (qmk#9826) * Rename ledmatrix.h to match .c file (qmk#7949) * Split RGB_MATRIX_ENABLE into _ENABLE and _DRIVER (qmk#10231) * Split LED_MATRIX_ENABLE into _ENABLE and _DRIVER (qmk#10840) * Merge point for 2020 Nov 28 Breaking Change

tzarc requested a review from a team August 19, 2020 10:16

tzarc added bug core good first issue needs testing labels Aug 19, 2020

tzarc approved these changes Aug 21, 2020

View reviewed changes

tzarc requested a review from a team August 21, 2020 23:43

tzarc mentioned this pull request Aug 24, 2020

Planck EZ freezes when any key is pressed while suspended #6369

Open

noroadsleft force-pushed the develop branch from 9b5e04f to cbcfa54 Compare August 27, 2020 20:35

LSChyi force-pushed the develop branch from a092322 to 27b55cb Compare August 29, 2020 11:38

noroadsleft force-pushed the develop branch 2 times, most recently from 3a8e1b8 to a1b96ba Compare September 4, 2020 22:03

LSChyi force-pushed the develop branch from 27b55cb to 3c9df25 Compare September 5, 2020 04:55

drashna approved these changes Sep 6, 2020

View reviewed changes

noroadsleft force-pushed the develop branch from a1b96ba to 3430907 Compare September 12, 2020 11:46

Add hotfix for chibios keyboards not wake

02516cb

stdvar mentioned this pull request Apr 11, 2021

Workaround SN32 USB code deficiencies for remote wakeup to work SonixQMK/qmk_firmware#28

Closed

14 tasks

firetech mentioned this pull request May 9, 2021

Trigger a wakeup after USB Reset on ChibiOS #12831

Merged

14 tasks

firetech added a commit to firetech/qmk_firmware that referenced this pull request May 11, 2021

Remove the qmk#10088 hotfix for K20x MCU:s.

bc8a81b

It seems to _cause_ the issue it intended to solve there.

firetech mentioned this pull request May 11, 2021

Remove the #10088 hotfix for Teensy 3.1-like Input:Club keyboards #12870

Merged

14 tasks

firetech added a commit to firetech/qmk_firmware that referenced this pull request Jun 3, 2021

Remove the qmk#10088 hotfix for K20x MCU:s.

ac0ef11

It seems to _cause_ the issue it intended to solve there.

firetech added a commit to firetech/qmk_firmware that referenced this pull request Jun 5, 2021

Remove the qmk#10088 hotfix for K20x MCU:s.

21d2204

It seems to _cause_ the issue it intended to solve there.

firetech added a commit to firetech/qmk_firmware that referenced this pull request Jun 8, 2021

Remove the qmk#10088 hotfix for K20x MCU:s.

947fee8

It seems to _cause_ the issue it intended to solve there.

firetech added a commit to firetech/qmk_firmware that referenced this pull request Jun 10, 2021

Remove the qmk#10088 hotfix for K20x MCU:s.

28628a2

It seems to _cause_ the issue it intended to solve there.

lokher mentioned this pull request Oct 30, 2021

Fix remote wakeup issue #14988

Closed

14 tasks

sigprof mentioned this pull request Feb 13, 2022

IC_TEENSY3_1 board config wakes from sleep successfully #16326

Closed

9 tasks

KarlK90 mentioned this pull request Feb 23, 2023

[Bug] Fix non-functional S3 wakeup / resume from suspense #19780

Merged

14 tasks

BorisTestov pushed a commit to BorisTestov/qmk_firmware that referenced this pull request May 23, 2024

Add hotfix for chibios keyboards not wake (qmk#10088)

c876f15

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add hotfix for chibios keyboards not wake #10088

Add hotfix for chibios keyboards not wake #10088

LSChyi commented Aug 19, 2020 •

edited

Loading

tzarc commented Aug 20, 2020

LSChyi commented Aug 20, 2020

tzarc commented Aug 21, 2020

tzarc left a comment

fauxpark commented Aug 22, 2020

tzarc commented Aug 22, 2020

LSChyi commented Aug 23, 2020 •

edited

Loading

tzarc commented Aug 24, 2020 •

edited

Loading

drashna commented Aug 24, 2020 •

edited

Loading

fauxpark commented Aug 24, 2020

tzarc commented Aug 24, 2020

tzarc commented Aug 24, 2020

LSChyi commented Aug 24, 2020

tzarc commented Aug 24, 2020

su8044 commented Sep 11, 2020 •

edited

Loading

firetech commented May 8, 2021

fauxpark commented May 8, 2021

LSChyi commented May 8, 2021

Add hotfix for chibios keyboards not wake #10088

Add hotfix for chibios keyboards not wake #10088

Conversation

LSChyi commented Aug 19, 2020 • edited Loading

Description

Types of Changes

Issues Fixed or Closed by This PR

Checklist

tzarc commented Aug 20, 2020

LSChyi commented Aug 20, 2020

tzarc commented Aug 21, 2020

tzarc left a comment

Choose a reason for hiding this comment

fauxpark commented Aug 22, 2020

tzarc commented Aug 22, 2020

LSChyi commented Aug 23, 2020 • edited Loading

tzarc commented Aug 24, 2020 • edited Loading

drashna commented Aug 24, 2020 • edited Loading

fauxpark commented Aug 24, 2020

tzarc commented Aug 24, 2020

tzarc commented Aug 24, 2020

LSChyi commented Aug 24, 2020

tzarc commented Aug 24, 2020

su8044 commented Sep 11, 2020 • edited Loading

firetech commented May 8, 2021

fauxpark commented May 8, 2021

LSChyi commented May 8, 2021

LSChyi commented Aug 19, 2020 •

edited

Loading

LSChyi commented Aug 23, 2020 •

edited

Loading

tzarc commented Aug 24, 2020 •

edited

Loading

drashna commented Aug 24, 2020 •

edited

Loading

su8044 commented Sep 11, 2020 •

edited

Loading