From b8f67d249ff4753ef46820948d02fb95c870d8b3 Mon Sep 17 00:00:00 2001 From: Cem Aksoylar Date: Tue, 10 Dec 2024 20:53:28 -0800 Subject: [PATCH] docs: Link to pin control page from lighting pages --- .../docs/development/hardware-integration/lighting/backlight.mdx | 1 + docs/docs/development/hardware-integration/lighting/underglow.md | 1 + 2 files changed, 2 insertions(+) diff --git a/docs/docs/development/hardware-integration/lighting/backlight.mdx b/docs/docs/development/hardware-integration/lighting/backlight.mdx index 67a9d1d8eaa..e1380899b43 100644 --- a/docs/docs/development/hardware-integration/lighting/backlight.mdx +++ b/docs/docs/development/hardware-integration/lighting/backlight.mdx @@ -32,6 +32,7 @@ endif # ZMK_BACKLIGHT ``` Create a `-pinctrl.dtsi` file if it does not already exist, and include it at the beginning of the `.dts` file. `CONFIG_PINCTRL=y` must be added to `_defconfig` if it isn't already enabled. +See the documentation page on [pin control](../pinctrl.mdx) for detailed information on setting up pins for hardware protocols such as PWM that is used for controlling backlight LEDs. The pinctrl file has a `&pinctrl` node that encompasses all pinctrl settings, including I2C or SPI peripherals (e.g. WS2812 LEDs, battery fuel gauges): diff --git a/docs/docs/development/hardware-integration/lighting/underglow.md b/docs/docs/development/hardware-integration/lighting/underglow.md index 11b172e47b4..ac661b0d232 100644 --- a/docs/docs/development/hardware-integration/lighting/underglow.md +++ b/docs/docs/development/hardware-integration/lighting/underglow.md @@ -7,6 +7,7 @@ description: Lighting system that controls strips of RGB LEDs. Please see [RGB underglow feature page](../../../features/underglow.md) for an introduction on the feature. Support for RGB underglow is always added to a board, not a shield. This is because the LED strip drivers rely on hardware-specific interfaces (e.g. SPI, I2S) and configurations, which shields do not control. +See the documentation page on [pin control](../pinctrl.mdx) for detailed information on setting up pins for hardware protocols such as SPI or PIO that are used for LED strips. Shields written for boards which support RGB underglow should add a `boards/` folder underneath the shield folder. Inside this `boards/` folder, create a `.overlay` for any of the boards the shield can be used with. Place all hardware-specific configurations in these `.overlay` files.