aboutsummaryrefslogtreecommitdiff
path: root/docs/feature_backlight.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/feature_backlight.md')
-rw-r--r--docs/feature_backlight.md12
1 files changed, 6 insertions, 6 deletions
diff --git a/docs/feature_backlight.md b/docs/feature_backlight.md
index d47ecc682..79782cf56 100644
--- a/docs/feature_backlight.md
+++ b/docs/feature_backlight.md
@@ -8,7 +8,7 @@ The MCU can only supply so much current to its GPIO pins. Instead of powering th
8 8
9Most keyboards have backlighting enabled by default if they support it, but if it is not working for you, check that your `rules.mk` includes the following: 9Most keyboards have backlighting enabled by default if they support it, but if it is not working for you, check that your `rules.mk` includes the following:
10 10
11```makefile 11```make
12BACKLIGHT_ENABLE = yes 12BACKLIGHT_ENABLE = yes
13``` 13```
14 14
@@ -54,7 +54,7 @@ If backlight breathing is enabled (see below), the following functions are also
54 54
55To select which driver to use, configure your `rules.mk` with the following: 55To select which driver to use, configure your `rules.mk` with the following:
56 56
57```makefile 57```make
58BACKLIGHT_DRIVER = software 58BACKLIGHT_DRIVER = software
59``` 59```
60 60
@@ -87,7 +87,7 @@ This functionality is configured at the keyboard level with the `BACKLIGHT_ON_ST
87 87
88The `pwm` driver is configured by default, however the equivalent setting within `rules.mk` would be: 88The `pwm` driver is configured by default, however the equivalent setting within `rules.mk` would be:
89 89
90```makefile 90```make
91BACKLIGHT_DRIVER = pwm 91BACKLIGHT_DRIVER = pwm
92``` 92```
93 93
@@ -143,7 +143,7 @@ The breathing effect is the same as in the hardware PWM implementation.
143 143
144While still in its early stages, ARM backlight support aims to eventually have feature parity with AVR. The `pwm` driver is configured by default, however the equivalent setting within `rules.mk` would be: 144While still in its early stages, ARM backlight support aims to eventually have feature parity with AVR. The `pwm` driver is configured by default, however the equivalent setting within `rules.mk` would be:
145 145
146```makefile 146```make
147BACKLIGHT_DRIVER = pwm 147BACKLIGHT_DRIVER = pwm
148``` 148```
149 149
@@ -167,7 +167,7 @@ Currently only hardware PWM is supported, not timer assisted, and does not provi
167 167
168In this mode, PWM is "emulated" while running other keyboard tasks. It offers maximum hardware compatibility without extra platform configuration. The tradeoff is the backlight might jitter when the keyboard is busy. To enable, add this to your `rules.mk`: 168In this mode, PWM is "emulated" while running other keyboard tasks. It offers maximum hardware compatibility without extra platform configuration. The tradeoff is the backlight might jitter when the keyboard is busy. To enable, add this to your `rules.mk`:
169 169
170```makefile 170```make
171BACKLIGHT_DRIVER = software 171BACKLIGHT_DRIVER = software
172``` 172```
173 173
@@ -188,7 +188,7 @@ To activate multiple backlight pins, add something like this to your `config.h`,
188 188
189If none of the above drivers apply to your board (for example, you are using a separate IC to control the backlight), you can implement a custom backlight driver using this simple API provided by QMK. To enable, add this to your `rules.mk`: 189If none of the above drivers apply to your board (for example, you are using a separate IC to control the backlight), you can implement a custom backlight driver using this simple API provided by QMK. To enable, add this to your `rules.mk`:
190 190
191```makefile 191```make
192BACKLIGHT_DRIVER = custom 192BACKLIGHT_DRIVER = custom
193``` 193```
194 194