1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
|
/* Copyright 2017 The Chromium OS Authors. All rights reserved.
* Use of this source code is governed by a BSD-style license that can be
* found in the LICENSE file.
*/
#ifndef __CROS_EC_EVENT_LOG_H
#define __CROS_EC_EVENT_LOG_H
#include "config.h"
#include "common.h"
#include "compile_time_macros.h"
#include "stddef.h"
enum flash_event_type {
FE_LOG_START = 0,
FE_LOG_CORRUPTED = 1,
FE_TPM_I2C_ERROR = 2,
FE_LOG_OVERFLOWS = 3, /* A single byte, overflow counter. */
FE_LOG_LOCKS = 4, /* A single byte, lock failures counter. */
/*
* Fixed padding value makes it easier to parse log space
* snapshots.
*/
FE_LOG_PAD = 253,
/* A test event, the highest possible event type value. */
FE_LOG_TEST = 254,
};
struct flash_log_entry {
/*
* Until real wall clock time is available this is a monotonically
* increasing entry number.
*
* TODO(vbendeb): however unlikely, there could be multiple events
* logged within the same 1 second interval. There needs to be a
* way to handle this. Maybe storing incremental time, having only
* the very first entry in the log carry the real time. Maybe
* enhancing the log traversion function to allow multiple entries
* with the same timestamp value.
*/
uint32_t timestamp;
uint8_t size; /* [7:6] caller-def'd [5:0] payload size in bytes. */
uint8_t type; /* event type, caller-defined */
uint8_t crc;
uint8_t payload[0]; /* optional additional data payload: 0..63 bytes. */
} __packed;
/* Returned in the "type" field, when there is no entry available */
#define FLASH_LOG_NO_ENTRY 0xff
#define MAX_FLASH_LOG_PAYLOAD_SIZE ((1 << 6) - 1)
#define FLASH_LOG_PAYLOAD_SIZE_MASK (MAX_FLASH_LOG_PAYLOAD_SIZE)
#define FLASH_LOG_PAYLOAD_SIZE(size) ((size)&FLASH_LOG_PAYLOAD_SIZE_MASK)
/* Size of log entry for a specific payload size. */
#define FLASH_LOG_ENTRY_SIZE(payload_sz) \
((FLASH_LOG_PAYLOAD_SIZE(payload_sz) + \
sizeof(struct flash_log_entry) + CONFIG_FLASH_WRITE_SIZE - 1) & \
~(CONFIG_FLASH_WRITE_SIZE - 1))
/*
* Flash log implementation expects minimum flash write size not to exceed the
* log header structure size.
*
* It will be easy to extend implementation to cover larger write sizes if
* necessary.
*/
BUILD_ASSERT(sizeof(struct flash_log_entry) >= CONFIG_FLASH_WRITE_SIZE);
/* A helper structure to represent maximum size flash elog event entry. */
union entry_u {
uint8_t entry[FLASH_LOG_ENTRY_SIZE(MAX_FLASH_LOG_PAYLOAD_SIZE)];
struct flash_log_entry r;
};
#define COMPACTION_SPACE_PRESERVE (CONFIG_FLASH_LOG_SPACE / 4)
#define STARTUP_LOG_FULL_WATERMARK (CONFIG_FLASH_LOG_SPACE * 3 / 4)
#define RUN_TIME_LOG_FULL_WATERMARK (CONFIG_FLASH_LOG_SPACE * 9 / 10)
/*
* Add an entry to the event log. No errors are reported, as there is little
* we can do if logging attempt fails.
*/
void flash_log_add_event(uint8_t type, uint8_t size, void *payload);
/*
* Report the next event after the passed in number.
*
* Return
* - positive integer - the size of the retrieved event
* - 0 if there is no more events
* - -EC_ERROR_BUSY if event logging is in progress
* - -EC_ERROR_MEMORY_ALLOCATION if event body does not fit into the buffer
* - -EC_ERROR_INVAL in case log storage is corrupted
*/
int flash_log_dequeue_event(uint32_t event_after, void *buffer,
size_t buffer_size);
void flash_log_register_flash_control_callback(
void (*flash_control)(int enable));
#if defined(TEST_BUILD)
void flash_log_init(void);
extern uint8_t log_event_in_progress;
extern uint32_t lock_failures_count;
#endif
#endif /* __CROS_EC_EVENT_LOG_H */
|
