diff options
| author | Tom Hughes <tomhughes@chromium.org> | 2019-12-04 16:43:32 -0800 |
|---|---|---|
| committer | Commit Bot <commit-bot@chromium.org> | 2019-12-05 01:33:31 +0000 |
| commit | a4e6ec6c90f8da6ded2cbda3cf6f3d795739f97f (patch) | |
| tree | 0b4f389d4a0f054015cce7cded4880d94069c5a5 | |
| parent | e36f4da1fe29dbadd7313d164b333bc01db22ab3 (diff) | |
| download | chrome-ec-a4e6ec6c90f8da6ded2cbda3cf6f3d795739f97f.tar.gz | |
docs/fingerprint: Add details on FPMCU logs
BRANCH=none
BUG=none
TEST=view in gitiles
Change-Id: Ie3ef2dbbb9ffbe2592268eb2d23f1afe53594a25
Signed-off-by: Tom Hughes <tomhughes@chromium.org>
Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/1952098
Reviewed-by: Craig Hesling <hesling@chromium.org>
Commit-Queue: Craig Hesling <hesling@chromium.org>
| -rw-r--r-- | docs/fingerprint/fingerprint.md | 44 |
1 files changed, 42 insertions, 2 deletions
diff --git a/docs/fingerprint/fingerprint.md b/docs/fingerprint/fingerprint.md index b54b79d031..366640a924 100644 --- a/docs/fingerprint/fingerprint.md +++ b/docs/fingerprint/fingerprint.md @@ -16,7 +16,8 @@ build/<board>` or `make clobber` to prevent compilation errors. ## Software The main source code for fingerprint sensor functionality lives in the -[`common/fpsensor`] directory. +[`common/fpsensor`] directory. The driver code for specific sensors lives in the +[`driver/fingerprint`] directory. ## Hardware @@ -88,6 +89,42 @@ prevent you from uploading. (chroot) ~/trunk/src/platform/ec $ make BOARD=nocturne_fp run-host_command_fuzz ``` +## Logs + +[`timberslide`] is a simple daemon that collects logs from the FPMCU and writes +them to disk. [`timberslide`] reads from sysfs, where the kernel driver +[periodically dumps the FPMCU console output][cros_ec_debugfs]. [`timberslide`] +writes the resulting logs to `/var/log/cros_fp.log`. There are multiple +instances of [`timberslide`] that run; one for each MCU running the EC +codebase. + +### Starting timberslide + +```bash +(dut)$ start timberslide LOG_PATH=/sys/kernel/debug/cros_fp/console_log +``` + +### Stopping timberslide + +```bash +(dut)$ stop timberslide LOG_PATH=/sys/kernel/debug/cros_fp/console_log +``` + +### Manually running timberslide + +```bash +(dut)$ timberslide --device_log=/sys/kernel/debug/cros_fp/console_log +``` + +### Reading logs from kernel + +If [`timberslide`] is not running you can just `cat` the logs directly from the +kernel: + +```bash +(dut)$ cat /sys/kernel/debug/cros_fp/console_log +``` + ## Production Updates ### `fp_updater.sh` and `bio_fw_updater` @@ -220,7 +257,8 @@ Signature verification succeeded. about adding an EC command to show the Key ID (fingerprint) from the RO version. This would make it a lot easier during both development and testing. -[`common/fpsensor`]: https://chromium.googlesource.com/chromiumos/platform/ec/+/refs/heads/master/common/fpsensor/ +[`common/fpsensor`]: https://chromium.googlesource.com/chromiumos/platform/ec/+/master/common/fpsensor/ +[`driver/fingerprint`]: https://chromium.googlesource.com/chromiumos/platform/ec/+/master/driver/fingerprint [`nocturne_fp`]: https://chromium.googlesource.com/chromiumos/platform/ec/+/refs/heads/master/board/nocturne_fp/ [`nami_fp`]: https://chromium.googlesource.com/chromiumos/platform/ec/+/refs/heads/master/board/nami_fp/ [`hatch_fp`]: https://chromium.googlesource.com/chromiumos/platform/ec/+/refs/heads/master/board/hatch_fp/ @@ -240,3 +278,5 @@ This would make it a lot easier during both development and testing. [STM32F412]: https://www.st.com/resource/en/reference_manual/dm00180369.pdf [STM32H743]: https://www.st.com/resource/en/reference_manual/dm00314099.pdf [`board/nocturne_fp/dev_key.pem`]: https://chromium.googlesource.com/chromiumos/platform/ec/+/master/board/nocturne_fp/dev_key.pem +[`timberslide`]: https://chromium.googlesource.com/chromiumos/platform2/+/master/timberslide +[cros_ec_debugfs]: https://chromium.googlesource.com/chromiumos/third_party/kernel/+/9db44685934a2e4bc9180ea2de87a6c429672395/drivers/platform/chrome/cros_ec_debugfs.c |