Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / obmc-console / c9f4a556ddc4154909c8d83323ac3b7b3dc38a1c
commitc9f4a556ddc4154909c8d83323ac3b7b3dc38a1c[log] [tgz]
authorNinad Palsule <ninadpalsule@us.ibm.com>Thu Apr 27 21:30:19 2023 -0500
committerNinad Palsule <ninadpalsule@us.ibm.com>Fri Apr 28 02:31:34 2023 +0000
treeab5bae77ba37c2a945ef60bd9ac4b2bfb49b4810
parentb14ca19cf380efbf7a96a348cc6fc81e75bf0591 [diff]
Adding myself as a reviewer

Requesting to add me as a reviewer.

Change-Id: Id5b56cf4d2595fc909c6ba8be0c2cd7d777702ba
Signed-off-by: Ninad Palsule <ninadpalsule@us.ibm.com>
1 file changed
tree: ab5bae77ba37c2a945ef60bd9ac4b2bfb49b4810
  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

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.