hardware: ROWS, COLS, LED_COUNT and a bit of int8_t #432
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
In an attempt to move away from magic, global defines, move the `ROWS`, `COLS`, and `LED_COUNT` defines to the hardware class. Backwards-compatible defines are provided by `<Kaleidoscope.h>`. This is just a first step, no users are updated just yet. Signed-off-by: Gergely Nagy <algernon@keyboard.io>
Intended to make it easier for LED-using code to bail out early, this simple constant will tell us whether the board has LEDs or if it does not. Because this will be used regularly, by code not close to the hardware, `Kaleidoscope.has_leds` is an alias to `KeyboardHardware.has_leds`. Signed-off-by: Gergely Nagy <algernon@keyboard.io>
LED related functions should be as close to no-op on LED-less hardware as possible. For this reason, guard all relevant points with an early exit in the LED-less case. Signed-off-by: Gergely Nagy <algernon@keyboard.io>
This allows us to do `i < LED_COUNT` comparisons on boards with no LEDs. All places that did this comparison have been updated to use `int8_t`, as were all places that use a LED index. Together with the previous commits, fixes #385. Signed-off-by: Gergely Nagy <algernon@keyboard.io>
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The ultimate goal of this pull request was to eliminate the warnings emitted for boards with no LEDs. To achieve this, we changed the led index type from
uint8_ttoint8_t. But while there, the code has been cleaned up a little, by movingROWS,COLSandLED_COUNTinto the hardware classes, with the#define'd names referencing those.Furthermore, to make sure that the LED code does not cause any issues when included into boards with no LEDs, the code has been augmented with
if (!Kaleidoscope.has_leds) return;-like constructs, so that they bail out early on led-less keyboards.This fixed #385.