docs: added TIOCSERGSTRUCT ioctl docs#18521
Merged
linguini1 merged 1 commit intoapache:masterfrom Mar 11, 2026
Merged
Conversation
arjav1528
requested review from
Donny9,
GUIDINGLI,
acassis,
btashton,
hartmannathan and
xiaoxiang781216
as code owners
github-actions
bot
added
Area: Documentation
michallenc
requested changes
Mar 10, 2026
arjav1528
force-pushed
the
dev-issue-15778
branch
from
0f534f3 to
5861d0a
Compare
linguini1
reviewed
Mar 10, 2026
linguini1
reviewed
Mar 10, 2026
linguini1
reviewed
Mar 10, 2026
Add a new section documenting the TIOCSERGSTRUCT debug ioctl and CONFIG_SERIAL_TIOCSERGSTRUCT Kconfig option. The section covers enabling the feature, how the ioctl copies driver-internal state to user space, example usage with the 16550 UART driver, and a warning about the non-stable nature of exposed structures. Signed-off-by: Arjav Patel <arjav1528@gmail.com>
arjav1528
force-pushed
the
dev-issue-15778
branch
from
5861d0a to
cc51f61
Compare
hartmannathan
approved these changes
Mar 10, 2026
Contributor
hartmannathan
left a comment
hartmannathan
left a comment
There was a problem hiding this comment.
Thank you for helping to improve documentation!
acassis
approved these changes
Mar 10, 2026
michallenc
approved these changes
Mar 10, 2026
xiaoxiang781216
approved these changes
Mar 11, 2026
linguini1
approved these changes
Mar 11, 2026
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
6 participants
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.
Fixes #15778
Summary
Add user-facing documentation for the
TIOCSERGSTRUCTdebug ioctl and itsCONFIG_SERIAL_TIOCSERGSTRUCTKconfig option to the serial driver documentation.Changes
Extends
Documentation/components/drivers/character/serial.rstwith a newSerial Debug Structure (TIOCSERGSTRUCT) section covering:
CONFIG_DEBUG_FEATURES,MCU_SERIALor16550_UART, and driver-level support (63+ drivers across ARM, ARM64,RISC-V, Xtensa, and MIPS already implement it).
menuconfignavigation path.not be used in production code.
Testing
headings, code blocks, notes, and warnings.