Google Git
Sign in
gbmc/obmc-console/eea4c314208f428aa74e6139c63f43b5e753d134
commit
eea4c314208f428aa74e6139c63f43b5e753d134
[log]
author
Howard Chang <howard.chang.wiwynn@gmail.com>
Mon Mar 23 01:57:26 2026 +0000
committer
Howard Chang <howard.chang.wiwynn@gmail.com>
Thu Apr 23 07:20:10 2026 +0000
tree
0b1490930cfdf6800b8bba26fd9770f9acb92dfb
parent
1aeced9155d34fc51c5082b6cbb4a53509a0e076 [diff]
log-handler: Add secondary timestamped logging

Add an optional timestamped text log that improves the debugging
experience by allowing developers to easily inspect event
sequences using standard text tools.

Implement a sanitize_to_ascii_ansi() state machine to strip
escape sequences. When enabled via the log-timestamp
configuration, the system prepends each ASCII line with a
formatted timestamp and a seven-digit line count.

Change-Id: Iffe6c4e29642bbdb2bcb514e36fb5b3c76ba0767
Signed-off-by: Howard Chang <howard.chang.wiwynn@gmail.com>
8 files changed
tree: 0b1490930cfdf6800b8bba26fd9770f9acb92dfb
  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. text-log-handler.c
  29. tty-handler.c
  30. util.c
  31. 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