coreboot/util/board_status
Michael Büchler a132aba399 board_status/getrevision.sh: Ignore non-annotated tags
Local tags (e.g. to keep track of builds) should not be used to describe
a board status report. This has happened in some cases, e.g. [1].

According to the Git 2.41.0 manual for git-describe, the '--tagged'
parameter is a way to also use any "lightweight (non-annotated) tag" in
addition to annotated tags, which are always used even without this
parameter. All coreboot release tags seem to be annotated, so this
option should be safe to drop.

[1] https://review.coreboot.org/plugins/gitiles/board-status/+/b8c47429bad5afc5cd7f798cad3dece9790a1f83

Signed-off-by: Michael Büchler <michael.buechler@posteo.net>
Change-Id: I54b302415e569a3385559cc85323ce34462042ad
Reviewed-on: https://review.coreboot.org/c/coreboot/+/79837
Reviewed-by: Matt DeVillier <matt.devillier@gmail.com>
Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
2025-02-14 17:10:47 +00:00
..
go/src
.gitignore .gitignore: Split into subdirectory files 2020-10-30 07:05:27 +00:00
board_status.sh util/board_status: Switch branch to main for uploading results 2023-08-21 12:14:56 +00:00
description.md util: Add description.md to each util 2018-07-26 13:26:50 +00:00
getrevision.sh board_status/getrevision.sh: Ignore non-annotated tags 2025-02-14 17:10:47 +00:00
README.md Documentation: util/board_status/README formatting 2021-02-15 18:22:59 +00:00
set_up_live_image.sh treewide: use /usr/bin/env where appropriate 2018-11-17 07:32:03 +00:00

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.