forked from qmk/qmk_firmware
-
Notifications
You must be signed in to change notification settings - Fork 401
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Indicator LEDs as config (qmk#10816)
* First pass * Add config options to docs * Update some wording * Slight tidy up of backlight caps logic * Init pin to correct state * Move init location * Reverse default state
- Loading branch information
Showing
4 changed files
with
144 additions
and
54 deletions.
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,137 @@ | ||
| /* Copyright 2020 zvecr<[email protected]> | ||
| * | ||
| * This program is free software: you can redistribute it and/or modify | ||
| * it under the terms of the GNU General Public License as published by | ||
| * the Free Software Foundation, either version 2 of the License, or | ||
| * (at your option) any later version. | ||
| * | ||
| * This program is distributed in the hope that it will be useful, | ||
| * but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
| * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
| * GNU General Public License for more details. | ||
| * | ||
| * You should have received a copy of the GNU General Public License | ||
| * along with this program. If not, see <http://www.gnu.org/licenses/>. | ||
| */ | ||
| #include "quantum.h" | ||
|
|
||
| #ifdef BACKLIGHT_ENABLE | ||
| # include "backlight.h" | ||
| extern backlight_config_t backlight_config; | ||
| #else | ||
| // Cannot use BACKLIGHT_CAPS_LOCK without backlight being enabled | ||
| # undef BACKLIGHT_CAPS_LOCK | ||
| #endif | ||
|
|
||
| #ifndef LED_PIN_ON_STATE | ||
| # define LED_PIN_ON_STATE 1 | ||
| #endif | ||
|
|
||
| #if defined(BACKLIGHT_CAPS_LOCK) | ||
| /** \brief Caps Lock indicator using backlight (for keyboards without dedicated LED) | ||
| */ | ||
| static void handle_backlight_caps_lock(led_t led_state) { | ||
| // Use backlight as Caps Lock indicator | ||
| uint8_t bl_toggle_lvl = 0; | ||
|
|
||
| if (led_state.caps_lock && !backlight_config.enable) { | ||
| // Turning Caps Lock ON and backlight is disabled in config | ||
| // Toggling backlight to the brightest level | ||
| bl_toggle_lvl = BACKLIGHT_LEVELS; | ||
| } else if (!led_state.caps_lock && backlight_config.enable) { | ||
| // Turning Caps Lock OFF and backlight is enabled in config | ||
| // Toggling backlight and restoring config level | ||
| bl_toggle_lvl = backlight_config.level; | ||
| } | ||
|
|
||
| // Set level without modify backlight_config to keep ability to restore state | ||
| backlight_set(bl_toggle_lvl); | ||
| } | ||
| #endif | ||
|
|
||
| /** \brief Lock LED set callback - keymap/user level | ||
| * | ||
| * \deprecated Use led_update_user() instead. | ||
| */ | ||
| __attribute__((weak)) void led_set_user(uint8_t usb_led) {} | ||
|
|
||
| /** \brief Lock LED set callback - keyboard level | ||
| * | ||
| * \deprecated Use led_update_kb() instead. | ||
| */ | ||
| __attribute__((weak)) void led_set_kb(uint8_t usb_led) { led_set_user(usb_led); } | ||
|
|
||
| /** \brief Lock LED update callback - keymap/user level | ||
| * | ||
| * \return True if led_update_kb() should run its own code, false otherwise. | ||
| */ | ||
| __attribute__((weak)) bool led_update_user(led_t led_state) { return true; } | ||
|
|
||
| /** \brief Lock LED update callback - keyboard level | ||
| * | ||
| * \return Ignored for now. | ||
| */ | ||
| __attribute__((weak)) bool led_update_kb(led_t led_state) { | ||
| bool res = led_update_user(led_state); | ||
| if (res) { | ||
| #if defined(LED_NUM_LOCK_PIN) || defined(LED_CAPS_LOCK_PIN) || defined(LED_SCROLL_LOCK_PIN) || defined(LED_COMPOSE_PIN) || defined(LED_KANA_PIN) | ||
| # if LED_PIN_ON_STATE == 0 | ||
| // invert the whole thing to avoid having to conditionally !led_state.x later | ||
| led_state.raw = ~led_state.raw; | ||
| # endif | ||
|
|
||
| # ifdef LED_NUM_LOCK_PIN | ||
| writePin(LED_NUM_LOCK_PIN, led_state.num_lock); | ||
| # endif | ||
| # ifdef LED_CAPS_LOCK_PIN | ||
| writePin(LED_CAPS_LOCK_PIN, led_state.caps_lock); | ||
| # endif | ||
| # ifdef LED_SCROLL_LOCK_PIN | ||
| writePin(LED_SCROLL_LOCK_PIN, led_state.scroll_lock); | ||
| # endif | ||
| # ifdef LED_COMPOSE_PIN | ||
| writePin(LED_COMPOSE_PIN, led_state.compose); | ||
| # endif | ||
| # ifdef LED_KANA_PIN | ||
| writePin(LED_KANA_PIN, led_state.kana); | ||
| # endif | ||
| #endif | ||
| } | ||
| return res; | ||
| } | ||
|
|
||
| /** \brief Initialise any LED related hardware and/or state | ||
| */ | ||
| __attribute__((weak)) void led_init_ports(void) { | ||
| #ifdef LED_NUM_LOCK_PIN | ||
| setPinOutput(LED_NUM_LOCK_PIN); | ||
| writePin(LED_NUM_LOCK_PIN, !LED_PIN_ON_STATE); | ||
| #endif | ||
| #ifdef LED_CAPS_LOCK_PIN | ||
| setPinOutput(LED_CAPS_LOCK_PIN); | ||
| writePin(LED_CAPS_LOCK_PIN, !LED_PIN_ON_STATE); | ||
| #endif | ||
| #ifdef LED_SCROLL_LOCK_PIN | ||
| setPinOutput(LED_SCROLL_LOCK_PIN); | ||
| writePin(LED_SCROLL_LOCK_PIN, !LED_PIN_ON_STATE); | ||
| #endif | ||
| #ifdef LED_COMPOSE_PIN | ||
| setPinOutput(LED_COMPOSE_PIN); | ||
| writePin(LED_COMPOSE_PIN, !LED_PIN_ON_STATE); | ||
| #endif | ||
| #ifdef LED_KANA_PIN | ||
| setPinOutput(LED_KANA_PIN); | ||
| writePin(LED_KANA_PIN, !LED_PIN_ON_STATE); | ||
| #endif | ||
| } | ||
|
|
||
| /** \brief Entrypoint for protocol to LED binding | ||
| */ | ||
| __attribute__((weak)) void led_set(uint8_t usb_led) { | ||
| #ifdef BACKLIGHT_CAPS_LOCK | ||
| handle_backlight_caps_lock((led_t)usb_led); | ||
| #endif | ||
|
|
||
| led_set_kb(usb_led); | ||
| led_update_kb((led_t)usb_led); | ||
| } |
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
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