Allow keyboards/keymaps to execute code at each main loop iteration #10530

tzarc · 2020-10-04T02:35:35Z

Description

When developing some lower-power modes, there was a need to be able to execute __WFI() (wait for interrupt) at the end of each loop iteration in order to get the MCU to go into sleep mode, after all QMK-related processing had occurred.

This PR is an extension of that requirement, alowing for keyboards/keymaps to arbitrarily execute some "housekeeping" code at each iteration of the main loop.

Example:

void housekeeping_task_kb() {
    __WFI();
}

Types of Changes

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

Erovia

__attribute__((weak)) ✔️

… of executing code for each main loop iteration.

… of executing code for each main loop iteration. (#10530)

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

Gentoli · 2020-12-27T02:40:39Z

tmk_core/protocol/arm_atsam/main_arm_atsam.c

+
+        // Run housekeeping
+        housekeeping_task_kb();
+        housekeeping_task_user();


The arm_atsam implementation calls keyboard_task(); in its loop, thus the housekeeping calls should be covered by that.

Good catch; if you can raise a PR for it, it would be wonderful.

* 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

… of executing code for each main loop iteration. (qmk#10530)

tzarc added enhancement needs doc core labels Oct 4, 2020

tzarc requested a review from a team October 4, 2020 02:35

tzarc self-assigned this Oct 4, 2020

tzarc added hacktoberfest-accepted All the good issues to tackle during Hacktoberfest! documentation and removed hacktoberfest-accepted All the good issues to tackle during Hacktoberfest! needs doc labels Oct 4, 2020

Erovia approved these changes Oct 4, 2020

View reviewed changes

Erovia requested a review from a team October 4, 2020 11:34

tzarc added hacktoberfest-accepted All the good issues to tackle during Hacktoberfest! and removed hacktoberfest-accepted All the good issues to tackle during Hacktoberfest! labels Oct 5, 2020

skullydazed force-pushed the develop branch from fa8cf59 to cce70f1 Compare October 18, 2020 21:10

Add housekeeping task callbacks so that keyboards/keymaps are capable…

cea5e2b

… of executing code for each main loop iteration.

tzarc force-pushed the housekeeping branch from 2b5682b to cea5e2b Compare October 23, 2020 03:45

tzarc merged commit eee2f77 into qmk:develop Oct 23, 2020

tzarc deleted the housekeeping branch October 23, 2020 04:58

noroadsleft pushed a commit that referenced this pull request Oct 23, 2020

Add housekeeping task callbacks so that keyboards/keymaps are capable…

811e348

… of executing code for each main loop iteration. (#10530)

skullydazed pushed a commit that referenced this pull request Oct 28, 2020

Add housekeeping task callbacks so that keyboards/keymaps are capable…

bdce0a7

… of executing code for each main loop iteration. (#10530)

noroadsleft pushed a commit that referenced this pull request Oct 30, 2020

Add housekeeping task callbacks so that keyboards/keymaps are capable…

c4ecae1

… of executing code for each main loop iteration. (#10530)

Gentoli reviewed Dec 27, 2020

View reviewed changes

Gentoli mentioned this pull request Jan 23, 2021

Remove duplicated housekeeping call from arm_atsam #11672

Merged

14 tasks

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

Add housekeeping task callbacks so that keyboards/keymaps are capable…

5d2480d

… of executing code for each main loop iteration. (qmk#10530)

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Allow keyboards/keymaps to execute code at each main loop iteration #10530

Allow keyboards/keymaps to execute code at each main loop iteration #10530

tzarc commented Oct 4, 2020 •

edited

Loading

Erovia left a comment

Gentoli Dec 27, 2020 •

edited

Loading

tzarc Dec 29, 2020

Allow keyboards/keymaps to execute code at each main loop iteration #10530

Allow keyboards/keymaps to execute code at each main loop iteration #10530

Conversation

tzarc commented Oct 4, 2020 • edited Loading

Description

Types of Changes

Checklist

Erovia left a comment

Choose a reason for hiding this comment

Gentoli Dec 27, 2020 • edited Loading

Choose a reason for hiding this comment

tzarc Dec 29, 2020

Choose a reason for hiding this comment

tzarc commented Oct 4, 2020 •

edited

Loading

Gentoli Dec 27, 2020 •

edited

Loading