forked from zephyrproject-rtos/zephyr
-
Notifications
You must be signed in to change notification settings - Fork 2
Add comprehensive documentation for 12 peripheral drivers #306
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.
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
Draft
Copilot
wants to merge
7
commits into
main
Choose a base branch
from
copilot/add-peripheral-docs
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Co-authored-by: kartben <[email protected]>
Co-authored-by: kartben <[email protected]>
Co-authored-by: kartben <[email protected]>
Copilot
AI
changed the title
[WIP] Add documentation for missing peripheral files
Add comprehensive documentation for 12 peripheral drivers
Nov 22, 2025
Copilot finished work on behalf of
kartben
November 22, 2025 11:14
kartben
requested changes
Nov 22, 2025
Owner
kartben
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You.need to iterate further on audio
Co-authored-by: kartben <[email protected]>
Author
Expanded audio/index.rst with comprehensive content (136 → 969 words) in commit 872ee75. Added:
The documentation now matches the depth of other subsystem indexes like sensor/index.rst and display/index.rst. |
Co-authored-by: kartben <[email protected]>
Co-authored-by: kartben <[email protected]>
Copilot finished work on behalf of
kartben
November 22, 2025 11:22
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Twelve peripheral driver documentation files contained only skeletal structure (< 20 words each). This adds complete documentation modeled after
gpio.rst.Changes
Core peripherals - Added overview, devicetree config, and code examples:
counter.rst- Hardware timers/counters with alarm support (4 → 337 words)watchdog.rst- Watchdog timer configuration and feeding (4 → 390 words)pwm.rst- Pulse width modulation for LED dimming, motor control (7 → 402 words)adc.rst- Analog-to-digital conversion with channel config (8 → 406 words)spi.rst- Serial peripheral interface controller/peripheral modes (8 → 426 words)pcie.rst- PCIe device enumeration and BAR mapping (9 → 389 words)tgpio.rst- Time-aware GPIO with hardware timestamping (18 → 467 words)Communication - Added overview and usage patterns:
ipm.rst- Inter-processor mailbox for multi-core systems (7 → 391 words)i2c_eeprom_target.rst- Virtual EEPROM emulation via I2C target mode (6 → 399 words)Subsystem indexes - Added comprehensive architectural overview:
audio/index.rst- Audio subsystem comprehensive guide covering architecture, components (codec, DMIC, I2S, DAI), audio data formats, buffer management, and complete system examples (11 → 971 words)can/index.rst- CAN subsystem overview for controller and transceiver (12 → 196 words)Documentation structure
Each file follows consistent sections:
The audio documentation provides detailed coverage including:
Example from
counter.rst:Original prompt
💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.