coreboot-kgpe-d16/util/board_status
David Hendricks 09b573ff75 board_status: Point to documentation in header
This adds a pointer to the README and to the wiki in the header of
board_status.sh.

Change-Id: I5877a3bf3544f175ac74a5e5a8e1ef1cab366ab8
Signed-off-by: David Hendricks <david.hendricks@gmail.com>
Reviewed-on: https://review.coreboot.org/c/coreboot/+/21569
Reviewed-by: Jonathan Neuschäfer <j.neuschaefer@gmx.net>
Reviewed-by: Stefan Reinauer <stefan.reinauer@coreboot.org>
Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
2023-06-10 01:44:06 +00:00
..
go/src
.gitignore
README.md
board_status.sh board_status: Point to documentation in header 2023-06-10 01:44:06 +00:00
description.md
getrevision.sh
set_up_live_image.sh

README.md

General information on boot logs

To gather good boot logs, you must set the debug level to Spew.

If your board uses CMOS configuration[1], you can do it like this:

nvramtool -w debug_level=Spew

Else you will need to have to set the default log level at compile time, to do that go in Console ---> in make menuconfig, then set Default console log level to SPEW.

Reference:

[1] in make menuconfig you should have: General setup --->, [*] Use CMOS for configuration values. This option is also known as CONFIG_USE_OPTION_TABLE in Kconfig.

Gather information through SSH

board_status.sh can gather information through ssh with the -r option.

When using -r <host>, The script will attempt to log into root@host.

In order for -r <host> to work, the script has to be able to log into the remote host's root account, without having to provide a password.

That can be achieved with the use of SSH keys and ssh-agent.

board_status.sh expects the remote host to have the following programs in its path: cbmem, dmesg.

Boot log gathering through a serial port

When using board_status.sh -s </dev/xxx>, script starts by retrieving the boot log through the serial port.

To produce such logs, power off the board, run board_status.sh with the right arguments, power on the board.

At that point the logs will be displayed by board_status.sh as they are produced by the board.

Enter will have to be pressed once the board has booted and is in a state where the script is able to log into that board.

Publishing

It expects the user to already have an account in coreboot's Gerrit instance.

The -u switch will publish the results: It will make a git patch out of the status information, that will be directly pushed in the board-status repository.