Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / obmc-console / a72711af868568481db9767db902bbbacc2d62d9
commita72711af868568481db9767db902bbbacc2d62d9[log] [tgz]
authorAndrew Jeffery <andrew@aj.id.au>Tue Apr 18 18:19:41 2023 +0930
committerAndrew Jeffery <andrew@aj.id.au>Thu Apr 20 13:27:08 2023 +0930
tree0e27902bbda86d03b6bc4c5a7e893fefb2f16af9
parent4f79c0a1d178c9b4c93351722f33ad6876f3956e [diff]
obmc-console: Add clang-format configuration

And apply the formatting.

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

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.