Emulation/switch-coreboot
1
0
Fork 0
mirror of https://github.com/fail0verflow/switch-coreboot.git synced 2025-05-04 01:39:18 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

UPSTREAM: board-status: Add README

Browse source 
It explains the prerequisites to run the script, some
background on how to setup the computer running the script,
and the board it gathers the information from.

That information is too long to fit inside the script's
help.

BUG=none
BRANCH=none
TEST=none

Change-Id: I140c19404433fbeb457a349f39ce26efbb312d13
Signed-off-by: Patrick Georgi <pgeorgi@chromium.org>
Original-Commit-Id: efd9dee646
Original-Change-Id: Iecba7310ff1583149c02728e955716775bcbbdc4
Original-Signed-off-by: Denis 'GNUtoo' Carikli <GNUtoo@no-log.org>
Original-Reviewed-on: https://review.coreboot.org/6660
Original-Tested-by: build bot (Jenkins)
Original-Reviewed-by: Martin Roth <martinroth@google.com>
Reviewed-on: https://chromium-review.googlesource.com/445151
This commit is contained in:
Denis 'GNUtoo' Carikli 2014-08-14 11:58:04 +02:00 • committed by chrome-bot
parent c1ad3c90e2
commit 84431edea7
1 changed files with 50 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

50
util/board_status/README Normal file
View file

@ -0,0 +1,50 @@
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
Rereference:
------------
[1] in make menuconfig you should have: [*] Use CMOS for configuration values
This option is also known as CONFIG_USE_OPTION_TABLE in Kconfig.
Information trough SSH
======================
board_status.sh can gather information trough 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 trough a serial port
=======================================
When using -s </dev/xxx>, board_status.sh starts by retrieving the
boot log trough 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
==========
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.
It expects the user to already have an account in coreboot's gerrit
instance.