| commit | 13d3aa75ca429f3ea7245bcb4ef352f27e57c424 | [log] [tgz] |
|---|---|---|
| author | George Liu <liuxiwei@ieisystem.com> | Mon Aug 05 13:39:17 2024 +0800 |
| committer | George Liu <liuxiwei@ieisystem.com> | Mon Aug 05 13:50:38 2024 +0800 |
| tree | a84394689229f780b841cf66dd3cea661bf786ac | |
| parent | 289e64791e447ae75676204528e50f8230aa9095 [diff] |
docs/mux-support.md: README.md: Fix MD041 warnings The following warnings are generated by using markdownlint analysis: ``` docs/mux-support.md:1 MD041/first-line-heading/first-line-h1 First line in a file should be a top-level heading [Context: "## Mux Support"] ``` Refer to markdown-lint [1] to fix MD041 [1]: https://github.com/updownpress/markdown-lint/blob/master/rules/041-first-line-h1.md Signed-off-by: George Liu <liuxiwei@ieisystem.com> Change-Id: Id2dc44fd63b40492a67965c4a51aceeb67b9307d
To build this project, run the following shell commands:
meson setup build meson compile -C build
To test:
meson test -C build
Running the server requires a serial port (e.g. /dev/ttyS0):
touch obmc-console.conf ./obmc-console-server --config obmc-console.conf ttyS0
To connect to the server, simply run the client:
./obmc-console-client
To disconnect the client, use the standard ~. combination.
This shows how the host UART connection is abstracted within the BMC as a Unix domain socket.
+---------------------------------------------------------------------------------------------+
| |
| obmc-console-client unix domain socket obmc-console-server |
| |
| +----------------------+ +------------------------+ |
| | client.2200.conf | +---------------------+ | server.ttyVUART0.conf | |
+---+--+ +----------------------+ | | +------------------------+ +--------+-------+
Network | 2200 +--> +->+ @obmc-console.host0 +<-+ <--+ /dev/ttyVUART0 | UARTs
+---+--+ | console-id = "host0" | | | | console-id = "host0" | +--------+-------+
| | | +---------------------+ | | |
| +----------------------+ +------------------------+ |
| |
| |
| |
+---------------------------------------------------------------------------------------------+
This supports multiple independent consoles. The console-id is a unique portion for the unix domain socket created by the obmc-console-server instance. The server needs to know this because it needs to know what to name the pipe; the client needs to know it as it needs to form the abstract socket name to which to connect.
In some hardware designs, multiple UARTS may be available behind a Mux. Please reference docs/mux-support.md in that case.
For developing obmc-console, we can use pseudo terminals (pty's) in Linux.
The socat command will output names of 2 pty's, one of which is the master and the other one is the slave. The master pty can be used to emulate a UART.
$ socat -d -d pty,raw,echo=0,link=pty1 pty,raw,echo=0,link=pty2 $ obmc-console-server --console-id dev $(realpath pty2) $ obmc-console-client -i dev # this message should appear for the client $ echo "hi" > pty1