diff options
| -rw-r--r-- | util/board_status/README | 50 | ||||
| -rw-r--r-- | util/board_status/README.md | 63 | ||||
| -rwxr-xr-x | util/board_status/board_status.sh | 4 |
3 files changed, 65 insertions, 52 deletions
diff --git a/util/board_status/README b/util/board_status/README deleted file mode 100644 index c462e7de2c..0000000000 --- a/util/board_status/README +++ /dev/null @@ -1,50 +0,0 @@ -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: [*] Use CMOS for configuration values - This option is also known as CONFIG_USE_OPTION_TABLE in Kconfig. -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 -s </dev/xxx>, board_status.sh 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 -========== -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. diff --git a/util/board_status/README.md b/util/board_status/README.md new file mode 100644 index 0000000000..89db5c8dce --- /dev/null +++ b/util/board_status/README.md @@ -0,0 +1,63 @@ +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: + +```shell +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. + +<kbd>Enter</kbd> 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](https://review.coreboot.org). + +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. diff --git a/util/board_status/board_status.sh b/util/board_status/board_status.sh index 1024ff67b2..292bffac73 100755 --- a/util/board_status/board_status.sh +++ b/util/board_status/board_status.sh @@ -32,11 +32,11 @@ case $(uname) in echo "Please install gmake, or build and install devel/gmake from ports." exit $EXIT_FAILURE else - MAKE=gmake + MAKE='gmake' fi ;; *) - MAKE=make + MAKE='make' ;; esac |