Skip to content

Documentation: system: cu: document the cu serial terminal#19421

Open
JorgeGzm wants to merge 1 commit into
apache:masterfrom
JorgeGzm:linum-cu-rs485
Open

Documentation: system: cu: document the cu serial terminal#19421
JorgeGzm wants to merge 1 commit into
apache:masterfrom
JorgeGzm:linum-cu-rs485

Conversation

@JorgeGzm

Copy link
Copy Markdown
Contributor

Summary

The cu application had no documentation (the page was an empty stub).
This PR implements it:

  • Document the cu command: description, options, escape sequences,
    dependencies and limitations, plus a "Bridging two serial ports"
    section showing how to bind two ports to each other from the shell
    (bidirectional or unidirectional, including ports at different
    baud rates).
  • Add an rs485 configuration to the linum-stm32h753bi board (nsh +
    the two on-board RS-485 transceivers + cu), used to test the
    documented commands on real hardware.
  • The tests performed on the board are documented in the
    linum-stm32h753bi board documentation: bridging the console to an
    RS-485 bus with cu, binding the two buses to each other, and a
    loopback self-test between the two transceivers.

Impact

  • User: cu is now documented; linum-stm32h753bi gets a
    ready-to-use RS-485 configuration.
  • Build: none, documentation and new optional defconfig only.
  • Hardware: linum-stm32h753bi only.
  • Documentation: yes, this PR.
  • Compatibility: none.

Testing

All commands tested on the linum-stm32h753bi board (RS-485 loopback
A-A/B-B between the two on-board transceivers):

nsh> cat /dev/ttyS1 > /dev/ttyS2 &
nsh> cat /dev/ttyS2 > /dev/ttyS1 &
nsh> cu -l /dev/ttyS1 -s 115200
[typed characters come back through the bridge]
~.
  • tools/configure.sh linum-stm32h753bi:rs485 from distclean + full
    build (GCC with -Werror: no warnings).
  • sphinx-build: no warnings on the changed pages.
  • tools/checkpatch.sh: all checks pass.

The cu application page was an empty stub. Document the command:
description, options, escape sequences, configuration dependencies
and limitations.

Also add an rs485 configuration to the linum-stm32h753bi board with
the two on-board RS-485 transceivers (UART4 and USART6) and the cu
terminal enabled, plus a board documentation section showing how to
bridge the console to one of the RS-485 buses with cu. The RS-485
DE pins are handled automatically by the serial driver.

Tested on hardware.

Signed-off-by: Jorge Guzman <jorge.gzm@gmail.com>
@github-actions github-actions Bot added Area: Documentation Improvements or additions to documentation Size: M The size of the change in this PR is medium Board: arm labels Jul 13, 2026
@github-actions

Copy link
Copy Markdown

MemBrowse Memory Report

No memory changes detected for:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Area: Documentation Improvements or additions to documentation Board: arm Size: M The size of the change in this PR is medium

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants