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.

Sign up for GitHub

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

Jump to bottom

Add support for hardware and board initialisation overrides. #8330

Merged
merged 10 commits into from
Apr 12, 2020
Merged

Add support for hardware and board initialisation overrides. #8330

merged 10 commits into from
Apr 12, 2020

Conversation

tzarc
Copy link
Member

@tzarc tzarc commented Mar 7, 2020 •
edited
Loading

Description

ChibiOS board files aren't normally able to be overridden without making duplicates of the definitions, and modding them.

This PR introduces some new API methods and provides a way to override the initialisation files such that hooking the early bootup sequence can be achieved whilst retaining the original ChibiOS board definitions.

Effective changes, replacing modifications for each board definition's board.c:

  • __early_init has been overridden, and now has qmk api equivalents early_hardware_init_pre and early_hardware_init_post
  • boardInit has been overridden, and now has qmk api equivalent board_init

See documentation for notes on the constraints for usage -- any board developer that has previously overridden these will likely know the constraints already.

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.
  • 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 tzarc requested a review from a team March 7, 2020 00:00
@tzarc
Copy link
Member Author

tzarc commented Mar 7, 2020

Any ideas where these new APIs should be documented?

@tzarc
Copy link
Member Author

tzarc commented Mar 7, 2020

I've made the early_hardware_init_pre a no-op for now, so that we're not attempting to enter bootloader twice. Will have a followup set of PRs which migrate existing usage of the __early_init currently in use by keyboards, and once all the migration is complete, it can probably be swapped back in.

@tzarc
Copy link
Member Author

tzarc commented Mar 7, 2020

Initial testing makes it possible to remove the custom board definitions from the test projects I've been working with (BOARD = ...... in rules.mk), dropping back to the ChibiOS-supplied ones.

This was referenced Mar 8, 2020
Merged
Merged
@tzarc
Copy link
Member Author

tzarc commented Mar 21, 2020

Seems to work fine for both Proton-C (F303), custom L082, custom G431, custom G474.

zvecr
zvecr requested changes Apr 12, 2020
View reviewed changes
Copy link
Member

@zvecr zvecr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tested, working. Just a small suggestion

tmk_core/protocol/chibios/main.c Outdated Show resolved Hide resolved
@zvecr zvecr requested a review from a team April 12, 2020 23:13
@zvecr zvecr requested a review from a team April 12, 2020 23:39
@tzarc tzarc merged commit 05e9ff6 into qmk:master Apr 12, 2020
calmh added a commit to calmh/qmk_firmware that referenced this pull request Apr 13, 2020
@calmh
Merge branch 'master' into calmh
a855052 
* master: (973 commits)
  Fix AVR SPI parameter configuration, remove timeouts due to sync protocol. (qmk#8775)
  VIA Support: Jane V2 (qmk#8735)
  Add a simple custom keymap for Gergo. (qmk#8662)
  Add via support to keebio/bdn9 (qmk#8620)
  DP60 VIA cleanups (qmk#8697)
  Adding Niu Mini to VIA (qmk#8702)
  Allow trailing whitespace in markdown docs, for formatting purposes. (qmk#8774)
  Add support for hardware and board initialisation overrides. (qmk#8330)
  [Keyboard] Add IDOBAO ID80 (qmk#8728)
  [Keyboard] Quefrency Rev2 Caps Lock LED, set lighting defaults (qmk#8729)
  [Keyboard] Add handwired Fc200rt qmk board (qmk#8726)
  Bugfix for quantum/dip_switch.c (qmk#8731)
  Add *OPT aliases for *ALT keycodes and macros (qmk#8714)
  [Keymap] Add keymap for Nyquist rev3 (qmk#8706)
  format code according to conventions [skip ci]
  Added Workman ZXCVM variation (qmk#8686)
  [Keyboard] jotpad16 status leds (qmk#8643)
  [Keyboard] Add handwired BDN9-BLE (qmk#8192)
  Fix bug with layer caching in get_event_keycode (qmk#8693)
  [Keyboard] Add CannonKeys Atlas keyboard (qmk#8207)
  ...
Quarren42 pushed a commit to Quarren42/qmk_firmware that referenced this pull request Apr 15, 2020
@tzarc @zvecr @Quarren42
Add support for hardware and board initialisation overrides. (qmk#8330)
c93cc28 
* Add support for hardware and board initialisation overrides.

* qmk cformat.

* Add some documentation.

* Docs clarity.

* Make early_hardware_init_pre a no-op for now, until migrations occur.

* Doco update

* Make distinction between keyboard and ChibiOS board in docs

* Doc anchors.

* Update tmk_core/protocol/chibios/main.c

Co-Authored-By: Joel Challis <[email protected]>

* Rework bootloader entry to be off by default, allow opting-in.

Co-authored-by: Joel Challis <[email protected]>
kylekuj pushed a commit to kylekuj/qmk_firmware that referenced this pull request Apr 21, 2020
@tzarc @zvecr @kujawakk
Add support for hardware and board initialisation overrides. (qmk#8330)
01b52d1 
* Add support for hardware and board initialisation overrides.

* qmk cformat.

* Add some documentation.

* Docs clarity.

* Make early_hardware_init_pre a no-op for now, until migrations occur.

* Doco update

* Make distinction between keyboard and ChibiOS board in docs

* Doc anchors.

* Update tmk_core/protocol/chibios/main.c

Co-Authored-By: Joel Challis <[email protected]>

* Rework bootloader entry to be off by default, allow opting-in.

Co-authored-by: Joel Challis <[email protected]>
violet-fish pushed a commit to violet-fish/qmk_firmware that referenced this pull request May 3, 2020
@tzarc @zvecr @violet-fish
Add support for hardware and board initialisation overrides. (qmk#8330)
56d03bb 
* Add support for hardware and board initialisation overrides.

* qmk cformat.

* Add some documentation.

* Docs clarity.

* Make early_hardware_init_pre a no-op for now, until migrations occur.

* Doco update

* Make distinction between keyboard and ChibiOS board in docs

* Doc anchors.

* Update tmk_core/protocol/chibios/main.c

Co-Authored-By: Joel Challis <[email protected]>

* Rework bootloader entry to be off by default, allow opting-in.

Co-authored-by: Joel Challis <[email protected]>
bitherder pushed a commit to bitherder/qmk_firmware that referenced this pull request May 15, 2020
@tzarc @zvecr @lorenzoernesto
Add support for hardware and board initialisation overrides. (qmk#8330)
b7bc79a 
* Add support for hardware and board initialisation overrides.

* qmk cformat.

* Add some documentation.

* Docs clarity.

* Make early_hardware_init_pre a no-op for now, until migrations occur.

* Doco update

* Make distinction between keyboard and ChibiOS board in docs

* Doc anchors.

* Update tmk_core/protocol/chibios/main.c

Co-Authored-By: Joel Challis <[email protected]>

* Rework bootloader entry to be off by default, allow opting-in.

Co-authored-by: Joel Challis <[email protected]>
drashna pushed a commit to zsa/qmk_firmware that referenced this pull request May 24, 2020
@tzarc @zvecr @drashna
Add support for hardware and board initialisation overrides. (qmk#8330)
04a5b8a 
* Add support for hardware and board initialisation overrides.

* qmk cformat.

* Add some documentation.

* Docs clarity.

* Make early_hardware_init_pre a no-op for now, until migrations occur.

* Doco update

* Make distinction between keyboard and ChibiOS board in docs

* Doc anchors.

* Update tmk_core/protocol/chibios/main.c

Co-Authored-By: Joel Challis <[email protected]>

* Rework bootloader entry to be off by default, allow opting-in.

Co-authored-by: Joel Challis <[email protected]>
sowbug pushed a commit to sowbug/qmk_firmware that referenced this pull request May 24, 2020
@tzarc @zvecr @sowbug
Add support for hardware and board initialisation overrides. (qmk#8330)
d4a21b0 
* Add support for hardware and board initialisation overrides.

* qmk cformat.

* Add some documentation.

* Docs clarity.

* Make early_hardware_init_pre a no-op for now, until migrations occur.

* Doco update

* Make distinction between keyboard and ChibiOS board in docs

* Doc anchors.

* Update tmk_core/protocol/chibios/main.c

Co-Authored-By: Joel Challis <[email protected]>

* Rework bootloader entry to be off by default, allow opting-in.

Co-authored-by: Joel Challis <[email protected]>
fdidron pushed a commit to zsa/qmk_firmware that referenced this pull request Jun 12, 2020
@tzarc @zvecr @fdidron
Add support for hardware and board initialisation overrides. (qmk#8330)
da7b769 
* Add support for hardware and board initialisation overrides.

* qmk cformat.

* Add some documentation.

* Docs clarity.

* Make early_hardware_init_pre a no-op for now, until migrations occur.

* Doco update

* Make distinction between keyboard and ChibiOS board in docs

* Doc anchors.

* Update tmk_core/protocol/chibios/main.c

Co-Authored-By: Joel Challis <[email protected]>

* Rework bootloader entry to be off by default, allow opting-in.

Co-authored-by: Joel Challis <[email protected]>
turky pushed a commit to turky/qmk_firmware that referenced this pull request Jun 13, 2020
@tzarc @zvecr @turky
Add support for hardware and board initialisation overrides. (qmk#8330)
3054f38 
* Add support for hardware and board initialisation overrides.

* qmk cformat.

* Add some documentation.

* Docs clarity.

* Make early_hardware_init_pre a no-op for now, until migrations occur.

* Doco update

* Make distinction between keyboard and ChibiOS board in docs

* Doc anchors.

* Update tmk_core/protocol/chibios/main.c

Co-Authored-By: Joel Challis <[email protected]>

* Rework bootloader entry to be off by default, allow opting-in.

Co-authored-by: Joel Challis <[email protected]>
jakobaa pushed a commit to jakobaa/qmk_firmware that referenced this pull request Jul 7, 2020
@tzarc @zvecr @jakobaa
Add support for hardware and board initialisation overrides. (qmk#8330)
1d964ce 
* Add support for hardware and board initialisation overrides.

* qmk cformat.

* Add some documentation.

* Docs clarity.

* Make early_hardware_init_pre a no-op for now, until migrations occur.

* Doco update

* Make distinction between keyboard and ChibiOS board in docs

* Doc anchors.

* Update tmk_core/protocol/chibios/main.c

Co-Authored-By: Joel Challis <[email protected]>

* Rework bootloader entry to be off by default, allow opting-in.

Co-authored-by: Joel Challis <[email protected]>
@tzarc tzarc deleted the init-hooks branch September 10, 2020 02:27
BorisTestov pushed a commit to BorisTestov/qmk_firmware that referenced this pull request May 23, 2024
@tzarc @zvecr
Add support for hardware and board initialisation overrides. (qmk#8330)
ff44db7 
* Add support for hardware and board initialisation overrides.

* qmk cformat.

* Add some documentation.

* Docs clarity.

* Make early_hardware_init_pre a no-op for now, until migrations occur.

* Doco update

* Make distinction between keyboard and ChibiOS board in docs

* Doc anchors.

* Update tmk_core/protocol/chibios/main.c

Co-Authored-By: Joel Challis <[email protected]>

* Rework bootloader entry to be off by default, allow opting-in.

Co-authored-by: Joel Challis <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@zvecr zvecr zvecr approved these changes

Assignees
No one assigned
Labels
core enhancement
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@tzarc @zvecr