Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / obmc-console / 095db476d486199c607631c7ec8c4cc561e09f10
commit095db476d486199c607631c7ec8c4cc561e09f10[log] [tgz]
authorAndrew Jeffery <andrew@aj.id.au>Tue May 02 16:53:06 2023 +0930
committerAndrew Jeffery <andrew@aj.id.au>Tue May 02 23:34:17 2023 +0000
tree40b63968d87881a4d329dbc228fe28f2c21ab761
parent4dfefa972ddbe20c4d3164fd526f910c4ecd2966 [diff]
README: Convert the build instructions to meson

This probably should have been done before the removal of the autotools
build system, but who reads READMEs anyway.

Signed-off-by: Andrew Jeffery <andrew@aj.id.au>
Change-Id: I4483f6608fd54ac0db6d78a116185056b96adbfc
1 file changed
tree: 40b63968d87881a4d329dbc228fe28f2c21ab761
  1. conf/
  2. test/
  3. .clang-format
  4. .clang-tidy
  5. .gitignore
  6. .travis.yml
  7. config.c
  8. console-client.c
  9. console-dbus.c
  10. console-server.c
  11. console-server.h
  12. console-socket.c
  13. LICENSE
  14. log-handler.c
  15. meson.build
  16. meson_options.txt
  17. OWNERS
  18. README.md
  19. ringbuffer.c
  20. socket-handler.c
  21. tty-handler.c
  22. 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
           +---+--+  | socket-id = "host0" |  |                     |  | socket-id = "host0"    |  +--------+-------+
               |     |                     |  +---------------------+  |                        |           |
               |     +---------------------+                           +------------------------+           |
               |                                                                                            |
               |                                                                                            |
               |                                                                                            |
               +--------------------------------------------------------------------------------------------+

This supports multiple independent consoles. The socket-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.