Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / obmc-console / 2a5fface51431415ada38c947b4ebc06f0a9fbe5
commit2a5fface51431415ada38c947b4ebc06f0a9fbe5[log] [tgz]
authorWilly Tu <wltu@google.com>Thu Aug 31 13:53:31 2023 -0700
committerWilly Tu <wltu@google.com>Mon Sep 18 14:48:04 2023 +0000
tree67ddb08da82fea6925602c8c6598caf08bdbf0ba
parent7dc08baac216253b289f60c3cb0b39179f7aaefc [diff]
obmc-console-ssh: Add feature behind an option flag

Allow us to disable obmc-console-ssh if it is not needed. Default to be
enabled so there are no functional changes.

Change-Id: I3c83a3102626c5a511cae14c18ed284af6078edd
Signed-off-by: Willy Tu <wltu@google.com>
2 files changed
tree: 67ddb08da82fea6925602c8c6598caf08bdbf0ba
  1. conf/
  2. test/
  3. .clang-format
  4. .clang-tidy
  5. .gitignore
  6. .travis.yml
  7. CHANGELOG.md
  8. config.c
  9. console-client.c
  10. console-dbus.c
  11. console-server.c
  12. console-server.h
  13. console-socket.c
  14. LICENSE
  15. log-handler.c
  16. meson.build
  17. meson_options.txt
  18. OWNERS
  19. README.md
  20. ringbuffer.c
  21. socket-handler.c
  22. tty-handler.c
  23. util.c
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.