Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / obmc-console / a6b291048fcb0fb58ada2c47b29cbc80b5f5f514
commita6b291048fcb0fb58ada2c47b29cbc80b5f5f514[log] [tgz]
authorAlexander Hansen <alexander.hansen@9elements.com>Wed Jul 10 15:33:37 2024 +0200
committerAndrew Jeffery <andrew@codeconstruct.com.au>Wed Jul 24 17:01:17 2024 +0930
treed1511f0b6fc727d55c133c3a0b2693fe0ef87c50
parent312ecdc2b4bab980e7baeba2d3a75cd5266d6061 [diff]
console-server: Add UART Mux Support

This commit adds support for uart-muxes which can be controlled via
gpios.

Change-Id: I91a4de1962554adf4302a2a59d2b371f492dc21d
Signed-off-by: Alexander Hansen <alexander.hansen@9elements.com>
Signed-off-by: Andrew Jeffery <andrew@codeconstruct.com.au>
9 files changed
tree: d1511f0b6fc727d55c133c3a0b2693fe0ef87c50
  1. conf/
  2. subprojects/
  3. test/
  4. .clang-format
  5. .clang-tidy
  6. .gitignore
  7. .travis.yml
  8. CHANGELOG.md
  9. config-internal.h
  10. config.c
  11. config.h
  12. console-client.c
  13. console-dbus.c
  14. console-mux.c
  15. console-mux.h
  16. console-server.c
  17. console-server.h
  18. console-socket.c
  19. LICENSE
  20. log-handler.c
  21. meson.build
  22. meson.options
  23. OWNERS
  24. README.md
  25. ringbuffer.c
  26. socket-handler.c
  27. tty-handler.c
  28. util.c
  29. util.h
README.md

To Build

To build this project, run the following shell commands:

meson setup build
meson compile -C build

To test:

meson test -C build

To Run Server

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 Client

To connect to the server, simply run the client:

./obmc-console-client

To disconnect the client, use the standard ~. combination.

Underlying design

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.