Skip to content

Codex-generated pull request #18

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
soburi merged 2 commits into from
Feb 11, 2026
Merged

Codex-generated pull request #18

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2acfe72
docs: improve configuration docs consistency and readability
soburi Feb 11, 2026
83e528a
Update documentation/configuration-guide.md
soburi Feb 11, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions documentation/configuration-guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -203,9 +203,9 @@ To correctly configure PWM and ADC, two independent items must be addressed:

This is similar to configuring GPIO:

1) **Derive from nexus connector maps**
1) **Derive from connector maps**

Provide connector mappings via the board’s nexus definitions (e.g., `pwm-map` and `io-channel-map`)
Provide connector mappings via the board’s connector definitions (e.g., `pwm-map` and `io-channel-map`)

```dts
/ {
Expand All @@ -231,7 +231,7 @@ This is similar to configuring GPIO:

2) **Explicit lists under `/zephyr,user`**

Set GPIO Pin lists in `/zephyr,user/pwm-pin-gpios` and `/zephyr,user/adc-pin-gpios`,
Set GPIO pin lists in `/zephyr,user/pwm-pin-gpios` and `/zephyr,user/adc-pin-gpios`.

```dts
/ {
Expand All @@ -253,7 +253,7 @@ This is similar to configuring GPIO:
ArduinoCore-Zephyr needs a list of available PWM/ADC channels.
You can provide it in either of the following ways (**lowest precedence rule first**):

1) **Derive from nexus connector maps**
1) **Derive from connector maps**
Copy link

Copilot AI Feb 11, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The heading has been updated to remove "nexus" from "Derive from nexus connector maps" to "Derive from connector maps". However, this section is part of "Pin association" instructions that reference line 208 which still uses "nexus definitions". For consistency with the changes made to this heading, ensure terminology is aligned throughout the section.

Copilot uses AI. Check for mistakes.

If the board defines `arduino_pwm` with `pwm-map` and/or `arduino_adc` with `io-channel-map`,
ArduinoCore-Zephyr can derive the channel lists from those maps.
Expand All @@ -262,7 +262,7 @@ You can provide it in either of the following ways (**lowest precedence rule fir

2) **Explicit lists under `/zephyr,user`**

Sets the PWM/ADC channels corresponding to the pins specified by `pwm-pin-gpios` and `adc-pin-gpios`.
Set the PWM/ADC channels corresponding to the pins specified by `pwm-pin-gpios` and `adc-pin-gpios`.
- PWM channels: `/zephyr,user/pwms`
- ADC channels: `/zephyr,user/io-channels`

Expand Down
6 changes: 3 additions & 3 deletions documentation/configuration-reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,7 @@ A. Devicetree node: `/zephyr,user`
```


### Port provisioning
### Channel provisioning

#### `io-channels`
- **Location:** `/zephyr,user`
Expand Down Expand Up @@ -215,7 +215,8 @@ B. Board devicetree constructs (board-provided defaults)
- **Precedence:**
- Lower than `/zephyr,user/adc-pin-gpios` (association)
- Lower than `/zephyr,user/io-channels` (provisioning)
- **Notes:** `io-channel-map`: left = connector pin id, right = target ADC controller/channel; ADC still needs per-channel config under the ADC device node.
- **Notes:**
- `io-channel-map`: left = connector pin id, right = target ADC controller/channel.
- ADC still requires per-channel configuration under the ADC device node,
regardless of how the channel list is obtained.
- **Example:**
Expand Down Expand Up @@ -376,4 +377,3 @@ B. Board devicetree constructs (board-provided defaults)
### PWM pin association source
- **Primary:** `/zephyr,user/pwm-pin-gpios`
- **Fallback:** connector `pwm-map` under `arduino_pwm`

Loading