Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / obmc-console / 59d29a9f6e86ebe7663555904be08adaf6ebc981
commit59d29a9f6e86ebe7663555904be08adaf6ebc981[log] [tgz]
authorAndrew Jeffery <andrew@aj.id.au>Tue Apr 18 21:41:22 2023 +0930
committerAndrew Jeffery <andrew@aj.id.au>Fri Apr 21 10:49:13 2023 +0930
tree4e0c945ff210eff990a0c48de3e0472050b7d755
parent1b8684418bc3af9ab72e1deea19793373bd8ecad [diff]
obmc-console: Add clang-tidy configuration

The introduced configuration disables several checks that aren't helpful
in the obmc-console codebase.

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