Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / obmc-console / e3f1aa1ec8cecd58aa8f67702bd587c2989f787e
commite3f1aa1ec8cecd58aa8f67702bd587c2989f787e[log] [tgz]
authorAlexander Hansen <alexander.hansen@9elements.com>Wed Jul 10 11:57:17 2024 +0200
committerAndrew Jeffery <andrew@codeconstruct.com.au>Fri Jul 12 09:24:29 2024 +0930
tree075cc5f31f539a61ab769e261174a0063d5fd601
parentace05dccbbbf5a07ea2581fdf511078b6de6e0f6 [diff]
util: Consolidate ARRAY_SIZE() definitions

ARRAY_SIZE() was defined several times around the code-base.
Provide a single definition in util.h and include it where necessary.

Change-Id: Idc4cf030969ffc7f0928c6897a23962a70adcf05
Signed-off-by: Alexander Hansen <alexander.hansen@9elements.com>
4 files changed
tree: 075cc5f31f539a61ab769e261174a0063d5fd601
  1. conf/
  2. subprojects/
  3. test/
  4. .clang-format
  5. .clang-tidy
  6. .gitignore
  7. .travis.yml
  8. CHANGELOG.md
  9. config-internal.h
  10. config.c
  11. config.h
  12. console-client.c
  13. console-dbus.c
  14. console-server.c
  15. console-server.h
  16. console-socket.c
  17. LICENSE
  18. log-handler.c
  19. meson.build
  20. meson.options
  21. OWNERS
  22. README.md
  23. ringbuffer.c
  24. socket-handler.c
  25. tty-handler.c
  26. util.c
  27. util.h
README.md

To Build

To build this project, run the following shell commands:

meson setup build
meson compile -C build

To test:

meson test -C build

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
           +---+--+  | console-id = "host0" |  |                     |  |  console-id = "host0"  |  +--------+-------+
               |     |                      |  +---------------------+  |                        |           |
               |     +----------------------+                           +------------------------+           |
               |                                                                                             |
               |                                                                                             |
               |                                                                                             |
               +---------------------------------------------------------------------------------------------+

This supports multiple independent consoles. The console-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.