Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / obmc-console / 7a765956ab33769880a42aafe1b7287ddf2dd126
commit7a765956ab33769880a42aafe1b7287ddf2dd126[log] [tgz]
authorAndrew Jeffery <andrew@codeconstruct.com.au>Mon Feb 03 16:47:40 2025 +1030
committerAndrew Jeffery <andrew@codeconstruct.com.au>Mon Feb 03 16:50:39 2025 +1030
tree02ac34d41cc2730e12aabf3890835d33ce92c58e
parent4ec26bb16e3a8ef10b4c00a50605c70e2a5c228b [diff]
config.h: Include stddef.h for size_t

Address the following clang-tidy issue:

```
Error while processing .../obmc-console/config.h.
.../obmc-console/config.h:36:49: error: unknown type name 'size_t' [clang-diagnostic-error]
   36 | int config_parse_bytesize(const char *size_str, size_t *size);
      |                                                 ^
```

Fixes: 1e04f449b7f0 ("use iniparser dependency for config file parsing")
Change-Id: I22adfc548d1f8837fda8920267a16e93c17c8475
Signed-off-by: Andrew Jeffery <andrew@codeconstruct.com.au>
2 files changed
tree: 02ac34d41cc2730e12aabf3890835d33ce92c58e
  1. conf/
  2. docs/
  3. subprojects/
  4. test/
  5. .clang-format
  6. .clang-tidy
  7. .gitignore
  8. .travis.yml
  9. CHANGELOG.md
  10. config-internal.h
  11. config.c
  12. config.h
  13. console-client.c
  14. console-dbus.c
  15. console-mux.c
  16. console-mux.h
  17. console-server.c
  18. console-server.h
  19. console-socket.c
  20. LICENSE
  21. log-handler.c
  22. meson.build
  23. meson.options
  24. OWNERS
  25. README.md
  26. ringbuffer.c
  27. socket-handler.c
  28. tty-handler.c
  29. util.c
  30. util.h
README.md

obmc-console

To Build

To build this project, run the following shell commands:

meson setup build
meson compile -C build

To test:

dbus-run-session 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.

Mux Support

In some hardware designs, multiple UARTS may be available behind a Mux. Please reference docs/mux-support.md in that case.

Sample Development Setup

For developing obmc-console, we can use pseudo terminals (pty's) in Linux.

The socat command will output names of 2 pty's, one of which is the master and the other one is the slave. The master pty can be used to emulate a UART.

$ socat -d -d pty,raw,echo=0,link=pty1 pty,raw,echo=0,link=pty2

$ obmc-console-server --console-id dev $(realpath pty2)

$ obmc-console-client -i dev

# this message should appear for the client
$ echo "hi" > pty1