| commit | 86e3fd70f003264a05a09452c60ea8b9da6be287 | [log] [tgz] |
|---|---|---|
| author | Andrew Jeffery <andrew@aj.id.au> | Fri Apr 21 16:14:17 2023 +0930 |
| committer | Andrew Jeffery <andrew@aj.id.au> | Fri Apr 21 16:20:13 2023 +0930 |
| tree | 624b7432dcaa88e6fdefad0b99942579e84d6813 | |
| parent | dd4fa59109501b69b9fb0af94b8afb8c3778fa3d [diff] |
meson: Install obmc-console-server in $sbindir for consistency
Currently the autotools build and the systemd service units expect
obmc-console-server to be installed in ${sbindir}. This probably still
isn't quite right (`${libexecdir}/obmc-console/` might be a better
choice by [1]) but at least it's consistent.
[1] https://github.com/openbmc/docs/blob/master/anti-patterns.md#incorrect-placement-of-executables-in-sbin-usrsbin-or-bin-usrbin
Signed-off-by: Andrew Jeffery <andrew@aj.id.au>
Change-Id: I6db11d0916ce40d0dcae4617d1ae1ddab3fe9a81
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
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
+---+--+ | 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.