util/board_status/README.md

   1 General information on boot logs
   2 ================================
   3
   4 To gather good boot logs, you must set the debug level to Spew.
   5
   6 If your board uses CMOS configuration[1], you can do it like this:
   7
   8 ```shell
   9 nvramtool -w debug_level=Spew
  10 ```
  11
  12 Else you will need to have to set the default log level at compile
  13 time, to do that go in `Console  --->` in make menuconfig, then set
  14 `Default console log level` to SPEW.
  15
  16 Reference:
  17 ----------
  18
  19 [1] in make menuconfig you should have: `General setup  --->`, `[*] Use CMOS for configuration values`.
  20     This option is also known as `CONFIG_USE_OPTION_TABLE` in `Kconfig`.
  21
  22 Gather information through SSH
  23 ==============================
  24
  25 `board_status.sh` can gather information through ssh with the `-r`
  26 option.
  27
  28 When using `-r <host>`, The script will attempt to log into
  29 root@host.
  30
  31 In order for `-r <host>` to work, the script has to be able
  32 to log into the remote host's root account, without having
  33 to provide a password.
  34
  35 That can be achieved with the use of SSH keys and ssh-agent.
  36
  37 `board_status.sh` expects the remote host to have the following
  38 programs in its path: `cbmem`, `dmesg`.
  39
  40 Boot log gathering through a serial port
  41 ========================================
  42
  43 When using `board_status.sh -s </dev/xxx>`, script starts by retrieving the
  44 boot log through the serial port.
  45
  46 To produce such logs, power off the board, run `board_status.sh`
  47 with the right arguments, power on the board.
  48
  49 At that point the logs will be displayed by `board_status.sh` as they
  50 are produced by the board.
  51
  52 <kbd>Enter</kbd> will have to be pressed once the board has booted and is in a
  53 state where the script is able to log into that board.
  54
  55 Publishing
  56 ==========
  57
  58 It expects the user to already have an account in
  59 [coreboot's Gerrit instance](https://review.coreboot.org).
  60
  61 The `-u` switch will publish the results: It will make a `git patch` out
  62 of the status information, that will be directly pushed in the
  63 board-status repository.