Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / obmc-console / 0b7b047715669f1b9f24686c8a26efa47020548b
commit0b7b047715669f1b9f24686c8a26efa47020548b[log] [tgz]
authorAndrew Jeffery <andrew@aj.id.au>Wed Apr 19 12:48:51 2023 +0930
committerAndrew Jeffery <andrew@aj.id.au>Fri Apr 21 10:49:12 2023 +0930
tree42063e2971644c83e8953ce7750a6c014127a4a5
parent2834c5b149151347309948034da4d8bb86ca5fde [diff]
obmc-console: Fix readability-else-after-return

```
/usr/bin/clang-tidy -checks=-*, readability-else-after-return -export-fixes /tmp/tmpzmyw6on0/tmpdk8wt96i.yaml -p=build /mnt/host/andrew/home/andrew/src/openbmc/obmc-console/test/test-ringbuffer-boundary-poll.c
/mnt/host/andrew/home/andrew/src/openbmc/obmc-console/build/../ringbuffer.c:131:4: error: do not use 'else' after 'return' [readability-else-after-return,-warnings-as-errors]
        } else {
          ^~~~~~
```

Signed-off-by: Andrew Jeffery <andrew@aj.id.au>
Change-Id: Ic80538a64f061f9ed3d3d71293dcf4f3d99cb6e4
3 files changed
tree: 42063e2971644c83e8953ce7750a6c014127a4a5
  1. conf/
  2. test/
  3. .clang-format
  4. .gitignore
  5. .travis.yml
  6. bootstrap.sh
  7. config.c
  8. configure.ac
  9. console-client.c
  10. console-server.c
  11. console-server.h
  12. console-socket.c
  13. LICENSE
  14. log-handler.c
  15. Makefile.am
  16. meson.build
  17. meson_options.txt
  18. OWNERS
  19. README.md
  20. ringbuffer.c
  21. socket-handler.c
  22. tty-handler.c
  23. 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.