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
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
|
/* Copyright 2012 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.
*
* Panic handling, including displaying a message on the panic reporting
* device, which is currently the UART.
*/
#ifndef __CROS_EC_PANIC_H
#define __CROS_EC_PANIC_H
#include "software_panic.h"
#include <stdarg.h>
#ifdef __cplusplus
extern "C" {
#endif
/* ARM Cortex-Mx registers saved on panic */
struct cortex_panic_data {
uint32_t regs[12]; /* psp, ipsr, msp, r4-r11, lr(=exc_return).
* In version 1, that was uint32_t regs[11] =
* psp, ipsr, lr, r4-r11
*/
uint32_t frame[8]; /* r0-r3, r12, lr, pc, xPSR */
uint32_t mmfs;
uint32_t bfar;
uint32_t mfar;
uint32_t shcsr;
uint32_t hfsr;
uint32_t dfsr;
};
/* NDS32 N8 registers saved on panic */
struct nds32_n8_panic_data {
uint32_t itype;
uint32_t regs[16]; /* r0-r10, r15, fp, gp, lp, sp */
uint32_t ipc;
uint32_t ipsw;
};
/* RISC-V RV32I registers saved on panic */
struct rv32i_panic_data {
uint32_t regs[31]; /* sp, ra, gp, tp, a0-a7, t0-t6 s0-s11 */
uint32_t mepc; /* mepc */
uint32_t mcause; /* mcause */
};
/* x86 registers saved on panic */
struct x86_panic_data {
uint32_t vector; /* Exception vector number */
/* Data pushed when exception handler called */
uint32_t error_code;
uint32_t eip;
uint32_t cs;
uint32_t eflags;
/* General purpose registers */
uint32_t eax;
uint32_t ebx;
uint32_t ecx;
uint32_t edx;
uint32_t esi;
uint32_t edi;
/* Task id at time of panic */
uint8_t task_id;
};
/* Data saved across reboots */
struct panic_data {
uint8_t arch; /* Architecture (PANIC_ARCH_*) */
uint8_t struct_version; /* Structure version (currently 2) */
uint8_t flags; /* Flags (PANIC_DATA_FLAG_*) */
uint8_t reserved; /* Reserved; set 0 */
/* core specific panic data */
union {
struct cortex_panic_data cm; /* Cortex-Mx registers */
struct nds32_n8_panic_data nds_n8; /* NDS32 N8 registers */
struct x86_panic_data x86; /* Intel x86 */
struct rv32i_panic_data riscv; /* RISC-V RV32I */
};
/*
* These fields go at the END of the struct so we can find it at the
* end of memory.
*/
uint32_t struct_size; /* Size of this struct */
uint32_t magic; /* PANIC_SAVE_MAGIC if valid */
};
#define PANIC_DATA_MAGIC 0x21636e50 /* "Pnc!" */
enum panic_arch {
PANIC_ARCH_CORTEX_M = 1, /* Cortex-M architecture */
PANIC_ARCH_NDS32_N8 = 2, /* NDS32 N8 architecture */
PANIC_ARCH_X86 = 3, /* Intel x86 */
PANIC_ARCH_RISCV_RV32I = 4, /* RISC-V RV32I */
};
/* Use PANIC_DATA_PTR to refer to the persistent storage location */
#define PANIC_DATA_PTR ((struct panic_data *)CONFIG_PANIC_DATA_BASE)
/* Flags for panic_data.flags */
/* panic_data.frame is valid */
#define PANIC_DATA_FLAG_FRAME_VALID BIT(0)
/* Already printed at console */
#define PANIC_DATA_FLAG_OLD_CONSOLE BIT(1)
/* Already returned via host command */
#define PANIC_DATA_FLAG_OLD_HOSTCMD BIT(2)
/* Already reported via host event */
#define PANIC_DATA_FLAG_OLD_HOSTEVENT BIT(3)
/**
* Write a string to the panic reporting device
*
* This function will not return until the string has left the UART
* data register. Any previously queued UART traffic is displayed first.
*
* @param ch Character to write
*/
void panic_puts(const char *s);
/**
* Very basic printf() for use in panic situations
*
* See panic_vprintf() for full details
*
* @param format printf-style format string
* @param ... Arguments to process
*/
void panic_printf(const char *format, ...);
/*
* Print saved panic information
*
* @param pdata pointer to saved panic data
*/
void panic_data_print(const struct panic_data *pdata);
/**
* Report an assertion failure and reset
*
* @param msg Assertion expression or other message
* @param func Function name where assertion happened
* @param fname File name where assertion happened
* @param linenum Line number where assertion happened
*/
#ifdef CONFIG_DEBUG_ASSERT_BRIEF
void panic_assert_fail(const char *fname, int linenum)
__attribute__((noreturn));
#else
void panic_assert_fail(const char *msg, const char *func, const char *fname,
int linenum) __attribute__((noreturn));
#endif
/**
* Display a custom panic message and reset
*
* @param msg Panic message
*/
void panic(const char *msg) __attribute__((noreturn));
/**
* Display a default message and reset
*/
void panic_reboot(void) __attribute__((noreturn));
#ifdef CONFIG_SOFTWARE_PANIC
/**
* Store a panic log and halt the system for a software-related reason, such as
* stack overflow or assertion failure.
*/
void software_panic(uint32_t reason, uint32_t info) __attribute__((noreturn));
/**
* Log a panic in the panic log, but don't halt the system. Normally
* called on the subsequent reboot after panic detection.
*/
void panic_set_reason(uint32_t reason, uint32_t info, uint8_t exception);
/**
* Retrieve the currently stored panic reason + info.
*/
void panic_get_reason(uint32_t *reason, uint32_t *info, uint8_t *exception);
#endif
/**
* Enable/disable bus fault handler
*
* @param ignored Non-zero if ignoring bus fault
*/
void ignore_bus_fault(int ignored);
/**
* Return a pointer to the saved data from a previous panic.
*
* @param pointer to the panic data, or NULL if none available (for example,
* the last reboot was not caused by a panic).
*/
struct panic_data *panic_get_data(void);
/**
* Chip-specific implementation for backing up panic data to persistent
* storage. This function is used to ensure that the panic data can survive loss
* of VCC power rail.
*
* There is no generic restore function provided since every chip can decide
* when it is safe to restore panic data during the system initialization step.
*/
void chip_panic_data_backup(void);
#ifdef __cplusplus
}
#endif
#endif /* __CROS_EC_PANIC_H */
|
