| commit | 6422215d34e8ddd9e3d3a04572afcd02ddc67627 | [log] [tgz] |
|---|---|---|
| author | Andrew Jeffery <andrew@aj.id.au> | Wed Apr 19 12:51:24 2023 +0930 |
| committer | Andrew Jeffery <andrew@aj.id.au> | Fri Apr 21 10:49:12 2023 +0930 |
| tree | e6ad9646372068e2ba9edb320bb913c96013726c | |
| parent | 0b7b047715669f1b9f24686c8a26efa47020548b [diff] |
obmc-console: Fix readability-inconsistent-declaration-parameter-name
```
/usr/bin/clang-tidy -checks=-*, readability-inconsistent-declaration-parameter-name -export-fixes /tmp/tmppaj3mheq/tmphdn64rrm.yaml -p=build /mnt/host/andrew/home/andrew/src/openbmc/obmc-console/console-server.c
../console-server.h:82:16: error: function 'console_poller_register' has a definition with different parameter names [readability-inconsistent-declaration-parameter-name,-warnings-as-errors]
struct poller *console_poller_register(struct console *console,
^
../console-server.c:538:16: note: the definition seen here
struct poller *console_poller_register(struct console *console,
^
/mnt/host/andrew/home/andrew/src/openbmc/obmc-console/build/../console-server.h:82:16: note: differing parameters are named here: ('event_fn'), in definition: ('poller_fn')
struct poller *console_poller_register(struct console *console,
^
/mnt/host/andrew/home/andrew/src/openbmc/obmc-console/build/../console-server.h:93:6: error: function 'console_poller_set_timeout' has a definition with different parameter names [readability-inconsistent-declaration-parameter-name,-warnings-as-errors]
void console_poller_set_timeout(struct console *console, struct poller *poller,
^
../console-server.c:644:6: note: the definition seen here
void console_poller_set_timeout(struct console *console __attribute__((unused)),
^
/mnt/host/andrew/home/andrew/src/openbmc/obmc-console/build/../console-server.h:93:6: note: differing parameters are named here: ('interval'), in definition: ('tv')
void console_poller_set_timeout(struct console *console, struct poller *poller,
^
5 warnings generated.
```
Signed-off-by: Andrew Jeffery <andrew@aj.id.au>
Change-Id: Ic9910bc7e716477b8e0eb0e40f32567972cc4529
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
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 to the server, simply run the client:
./obmc-console-client
To disconnect the client, use the standard ~. combination.
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.