Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / obmc-console / ed04991236db13e25bc50cd613c348cd94fe0a83
commited04991236db13e25bc50cd613c348cd94fe0a83[log] [tgz]
authorPatrick Williams <patrick@stwcx.xyz>Thu Dec 08 06:13:13 2022 -0600
committerPatrick Williams <patrick@stwcx.xyz>Thu Dec 08 06:13:13 2022 -0600
tree6f03bcfb6ab312f818e07c492a3dd8d23ad9f1b5
parentbbc95526c6b612ec42f45e3d554d01324477c4e7 [diff]
prettier: re-format

Prettier is enabled in openbmc-build-scripts on Markdown, JSON, and YAML
files to have consistent formatting for these file types.  Re-run the
formatter on the whole repository.

Change-Id: I81cb995cc3c633d3c8fdc8cc109e9f0afec01ec5
Signed-off-by: Patrick Williams <patrick@stwcx.xyz>
2 files changed
tree: 6f03bcfb6ab312f818e07c492a3dd8d23ad9f1b5
  1. conf/
  2. test/
  3. .gitignore
  4. .travis.yml
  5. bootstrap.sh
  6. config.c
  7. configure.ac
  8. console-client.c
  9. console-server.c
  10. console-server.h
  11. console-socket.c
  12. LICENSE
  13. log-handler.c
  14. Makefile.am
  15. OWNERS
  16. README.md
  17. ringbuffer.c
  18. socket-handler.c
  19. tty-handler.c
  20. 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.