diff options
| author | Joel Challis <git@zvecr.com> | 2023-11-22 00:41:19 +0000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-11-22 11:41:19 +1100 |
| commit | 7ae826476e782ff80ac94d4211bb9f7bb6c42040 (patch) | |
| tree | d46072faf496f2ec35e644adf1c86d1147fa11c4 /docs | |
| parent | 46b996a55e370b7c370dc0b092100a61121f9ddd (diff) | |
Move BACKLIGHT_PWM_PERIOD to correct docs section (#22480)
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/feature_backlight.md | 13 |
1 files changed, 7 insertions, 6 deletions
diff --git a/docs/feature_backlight.md b/docs/feature_backlight.md index 89916aa813..69391fcefe 100644 --- a/docs/feature_backlight.md +++ b/docs/feature_backlight.md @@ -40,7 +40,6 @@ Add the following to your `config.h`: |`BACKLIGHT_DEFAULT_ON` |`true` |Enable backlight upon clearing the EEPROM | |`BACKLIGHT_DEFAULT_BREATHING`|`false` |Whether to enable backlight breathing upon clearing the EEPROM | |`BACKLIGHT_DEFAULT_LEVEL` |`BACKLIGHT_LEVELS`|The default backlight level to use upon clearing the EEPROM | -|`BACKLIGHT_PWM_PERIOD` |2048Hz |Defaults to `BACKLIGHT_PWM_COUNTER_FREQUENCY / 2048`, which results in a PWM frequency of 2048Hz. | Unless you are designing your own keyboard, you generally should not need to change the `BACKLIGHT_PIN` or `BACKLIGHT_ON_STATE`. @@ -174,11 +173,13 @@ Depending on the ChibiOS board configuration, you may need to enable PWM at the The following `#define`s apply only to the `pwm` driver: -|Define |Default |Description | -|-----------------------|--------|-----------------------------------| -|`BACKLIGHT_PWM_DRIVER` |`PWMD4` |The PWM driver to use | -|`BACKLIGHT_PWM_CHANNEL`|`3` |The PWM channel to use | -|`BACKLIGHT_PAL_MODE` |`2` |The pin alternative function to use| +|Define |Default |Description | +|-----------------------|-------------|---------------------------------------------------------------| +|`BACKLIGHT_PWM_DRIVER` |`PWMD4` |The PWM driver to use | +|`BACKLIGHT_PWM_CHANNEL`|`3` |The PWM channel to use | +|`BACKLIGHT_PAL_MODE` |`2` |The pin alternative function to use | +|`BACKLIGHT_PWM_PERIOD` |*Not defined*|The PWM period in counter ticks - Default is platform dependent| + Refer to the ST datasheet for your particular MCU to determine these values. For example, these defaults are set up for pin `B8` on a Proton-C (STM32F303) using `TIM4_CH3` on AF2. Unless you are designing your own keyboard, you generally should not need to change them. |