Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / obmc-console / bd4af900acc889ef840b78b6707d54b084e51dbf
commitbd4af900acc889ef840b78b6707d54b084e51dbf[log] [tgz]
authorAndrew Geissler <geissonator@yahoo.com>Mon Feb 12 09:52:25 2024 -0500
committerAndrew Geissler <geissonator@yahoo.com>Tue Feb 13 07:20:35 2024 -0500
tree3f0c61ab62240dd4e1fd1e9e29160e84bb7d6f04
parent66ddf711d10cf684c8a179c4c2e6690e073990da [diff]
80-obmc-console-uart.rules: fix udevadm warnings

Without this change we get the following warnings:
```
udevadm verify

/usr/lib/udev/rules.d/80-obmc-console-uart.rules:1 style: a comma between tokens is expected.
/usr/lib/udev/rules.d/80-obmc-console-uart.rules:2 style: a comma between tokens is expected.
/usr/lib/udev/rules.d/80-obmc-console-uart.rules: udev rules have style issues.

41 udev rules files have been checked.
  Success: 40
  Fail:    1
```

Tested:
- Confirmed 'udevadm verify' returns no warnings

Change-Id: Ic1e1ddd212619fa5c9666adeb268bcfb60b0fb3a
Signed-off-by: Andrew Geissler <geissonator@yahoo.com>
1 file changed
tree: 3f0c61ab62240dd4e1fd1e9e29160e84bb7d6f04
  1. conf/
  2. test/
  3. .clang-format
  4. .clang-tidy
  5. .gitignore
  6. .travis.yml
  7. CHANGELOG.md
  8. config.c
  9. console-client.c
  10. console-dbus.c
  11. console-server.c
  12. console-server.h
  13. console-socket.c
  14. LICENSE
  15. log-handler.c
  16. meson.build
  17. meson.options
  18. OWNERS
  19. README.md
  20. ringbuffer.c
  21. socket-handler.c
  22. tty-handler.c
  23. util.c
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.