diff options
| author | Hsuan Ting Chen <roccochen@chromium.org> | 2022-11-30 11:36:03 +0800 |
|---|---|---|
| committer | Felix Held <felix-coreboot@felixheld.de> | 2022-12-05 14:28:32 +0000 |
| commit | 06cd7dbe4c15dfb35f3f638a4d9768ace9740d06 (patch) | |
| tree | bbd34bbe19c0dae0bb669493a221511f0cea0c9a | |
| parent | 7bde4e80be27b35abf13114eb8b6096755458d2e (diff) | |
commonlib: Add essential comments for ELOG_CROS_DIAG_RESULT
ELOG_CROS_DIAG_RESULT_* codes should be consistent with the enum
definition of enumerated histograms.
Hence add comments based on the requirements of enum histograms in
histogram guidelines.
BUG=b:4047421
TEST=none
Change-Id: I1a1a7c863d5aa9496649f81dc94fd79a6ad482df
Signed-off-by: Hsuan Ting Chen <roccochen@chromium.org>
Reviewed-on: https://review.coreboot.org/c/coreboot/+/70145
Reviewed-by: Yu-Ping Wu <yupingso@google.com>
Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
| -rw-r--r-- | src/commonlib/bsd/include/commonlib/bsd/elog.h | 7 |
1 files changed, 6 insertions, 1 deletions
diff --git a/src/commonlib/bsd/include/commonlib/bsd/elog.h b/src/commonlib/bsd/include/commonlib/bsd/elog.h index 06ea5a77d5..1f39090390 100644 --- a/src/commonlib/bsd/include/commonlib/bsd/elog.h +++ b/src/commonlib/bsd/include/commonlib/bsd/elog.h @@ -316,7 +316,12 @@ struct elog_event_mem_cache_update { #define ELOG_CROS_DIAG_TYPE_STORAGE_TEST_EXTENDED 0x03 #define ELOG_CROS_DIAG_TYPE_MEMORY_QUICK 0x04 #define ELOG_CROS_DIAG_TYPE_MEMORY_FULL 0x05 -/* Result codes for elog_event_cros_diag_log in ELOG_CROS_DIAGNOSTICS_LOGS */ +/* + * Result codes for elog_event_cros_diag_log in ELOG_CROS_DIAGNOSTICS_LOGS + * + * These values are persisted to logs. Entries should not be renumbered and + * numeric values should never be reused. + */ #define ELOG_CROS_DIAG_RESULT_PASSED 0x01 #define ELOG_CROS_DIAG_RESULT_ERROR 0x02 #define ELOG_CROS_DIAG_RESULT_FAILED 0x03 |