Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / obmc-console / d0a85567791e6c9349883834908a5bdf4a8ae49b
commitd0a85567791e6c9349883834908a5bdf4a8ae49b[log] [tgz]
authorAndrew Jeffery <andrew@aj.id.au>Tue Apr 18 06:22:39 2023 +0930
committerAndrew Jeffery <andrew@aj.id.au>Thu Apr 20 13:21:34 2023 +0930
tree0df6129a825f45a8ca572f1f50f0e9d14d5c747e
parentd30d7573adc3753503a56944e980e21c934d013b [diff]
obmc-console: Convert build to meson

The project is seeing some activity recently, so let's align it with the
desires here:

https://gerrit.openbmc.org/c/openbmc/docs/+/47732

Signed-off-by: Andrew Jeffery <andrew@aj.id.au>
Change-Id: I96941365440c9c164d222b4d18e6a57409819308
4 files changed
tree: 0df6129a825f45a8ca572f1f50f0e9d14d5c747e
  1. conf/
  2. test/
  3. .gitignore
  4. .travis.yml
  5. bootstrap.sh
  6. config.c
  7. configure.ac
  8. console-client.c
  9. console-server.c
  10. console-server.h
  11. console-socket.c
  12. LICENSE
  13. log-handler.c
  14. Makefile.am
  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

Note: In addition to a toolchain and autoconf tools, this requires autotools-archive to be installed.

To build this project, run the following shell commands:

./bootstrap.sh
./configure ${CONFIGURE_FLAGS}
make

To fully clean the repository, run:

./bootstrap.sh clean

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.