XIAO ESP32C6: seeed_xiao_connector.dtsi missing ledc0_default

[Gerriko]

Describe the bug

Documentation issue as described below

To Reproduce

• Read the docs

Expected behavior

• If following docs, ledc0_default is in the boards dtsi file.

Impact

• Confusion. Creates error in overlay file if one assumes ledc0_default exists in dtsi.

Logs and console output

• Not applicable.

Environment (please complete the following information):

• OS: Linux
• Toolchain: Zephyr SDK (latest)
• Zephyr (latest): 4.1
• Documentation online version (latest) 4.1

Additional context

I am using a XIAO ESP32C6 board.

I am attempting to get the basic blink_pwm example to work on this board (have it working, sort of).

To help me figure this out, I am working through the documentation and noticed an incongruency that caused me confusion.

As per the XIAO ESP32C6 product page, PWM is available for an LED: ESP32 LED Control (LEDC), which is compatible with: espressif,esp32-ledc

According to espressif,esp32-ledc documentation page (and is also stated in the espressif,esp32.yaml file), the ledc0_default should be defined in the board's dtsi file.

This is not the case.

Please review and consider correcting this text.

[henrikbrixandersen]

Please use our bug template when reporting bugs. You need to edit this issue to include the information requested in https://github.com/zephyrproject-rtos/zephyr/blob/main/.github/ISSUE_TEMPLATE/001_bug_report.md

[Gerriko]

This issue is related to documentation.
How is that a software bug? And how does my computer operating system or console logs have anything to do with a documentation issue.

[kartben]

This issue is related to documentation. How is that a software bug? And how does my computer operating system or console logs have anything to do with a documentation issue.

It can help us review and triage the bug properly, e.g. knowing what version of Zephyr you are using, whether this is something that used to work and doesn't anymore, etc. You can ignore the placeholders in that template that you think don't apply, but following it makes a huge difference in making sure bugs/issues get processed efficiently. Thank you!

[kartben]

the ledc0_default should be defined in the board's dtsi file.

No the binding file is basically providing an example of how one would provide the pinctrl configuration to the ledc node, it doesn't mean or imply that boards have one defined.

An overlay similar to samples/basic/blinky_pwm/boards/esp32c3_luatos_core.overlay would need to be added to the blink_pwm for it to work

[Gerriko]

@kartben I agree with your comment.

As noted, issue relates to documentation, in particular, this page: https://docs.zephyrproject.org/latest/build/dts/api/bindings/pwm/espressif%2Cesp32-ledc.html#std-dtcompatible-espressif-esp32-ledc

Here it states "The 'ledc0_default' node state is defined in <board>-pinctrl.dtsi."

In xiao_esp32c6-pinctrl.dtsi that is not the case.

Maybe it should state something like "... node state is typically or generally defined in..."

Alternatively the next paragraph could be modified... "If another GPIO mapping is desired, ..."

To: If 'ledc0_default' does not exist or another GPIO mapping is desired, ...

[github-actions]

This issue has been marked as stale because it has been open (more than) 60 days with no activity. Remove the stale label or add a comment saying that you would like to have the label removed otherwise this issue will automatically be closed in 14 days. Note, that you can always re-open a closed issue at any time.