xref: /OK3568_Linux_fs/kernel/include/soc/rockchip/rk_minidump.h (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun /* SPDX-License-Identifier: GPL-2.0-only */
2*4882a593Smuzhiyun /*
3*4882a593Smuzhiyun  * Copyright (c) 2017-2021, The Linux Foundation. All rights reserved.
4*4882a593Smuzhiyun  * Copyright (c) 2023 Rockchip Electronics Co., Ltd.
5*4882a593Smuzhiyun  */
6*4882a593Smuzhiyun 
7*4882a593Smuzhiyun #ifndef __RK_MINIDUMP_H
8*4882a593Smuzhiyun #define __RK_MINIDUMP_H
9*4882a593Smuzhiyun 
10*4882a593Smuzhiyun #include <linux/types.h>
11*4882a593Smuzhiyun 
12*4882a593Smuzhiyun #define MD_MAX_NAME_LENGTH		16
13*4882a593Smuzhiyun /* md_region -  Minidump table entry
14*4882a593Smuzhiyun  * @name:	Entry name, Minidump will dump binary with this name.
15*4882a593Smuzhiyun  * @id:		Entry ID, used only for SDI dumps.
16*4882a593Smuzhiyun  * @virt_addr:  Address of the entry.
17*4882a593Smuzhiyun  * @phys_addr:	Physical address of the entry to dump.
18*4882a593Smuzhiyun  * @size:	Number of byte to dump from @address location
19*4882a593Smuzhiyun  *		it should be 4 byte aligned.
20*4882a593Smuzhiyun  */
21*4882a593Smuzhiyun struct md_region {
22*4882a593Smuzhiyun 	char	name[MD_MAX_NAME_LENGTH];
23*4882a593Smuzhiyun 	u32	id;
24*4882a593Smuzhiyun 	u64	virt_addr;
25*4882a593Smuzhiyun 	u64	phys_addr;
26*4882a593Smuzhiyun 	u64	size;
27*4882a593Smuzhiyun };
28*4882a593Smuzhiyun 
29*4882a593Smuzhiyun #if IS_REACHABLE(CONFIG_ROCKCHIP_MINIDUMP)
30*4882a593Smuzhiyun /*
31*4882a593Smuzhiyun  * Register an entry in Minidump table
32*4882a593Smuzhiyun  * Returns:
33*4882a593Smuzhiyun  *	region number: entry position in minidump table.
34*4882a593Smuzhiyun  *	Negative error number on failures.
35*4882a593Smuzhiyun  */
36*4882a593Smuzhiyun int rk_minidump_add_region(const struct md_region *entry);
37*4882a593Smuzhiyun int rk_minidump_remove_region(const struct md_region *entry);
38*4882a593Smuzhiyun /*
39*4882a593Smuzhiyun  * Update registered region address in Minidump table.
40*4882a593Smuzhiyun  * It does not hold any locks, so strictly serialize the region updates.
41*4882a593Smuzhiyun  * Returns:
42*4882a593Smuzhiyun  *	Zero: on successfully update
43*4882a593Smuzhiyun  *	Negetive error number on failures.
44*4882a593Smuzhiyun  */
45*4882a593Smuzhiyun int rk_minidump_update_region(int regno, const struct md_region *entry);
46*4882a593Smuzhiyun bool rk_minidump_enabled(void);
47*4882a593Smuzhiyun void rk_minidump_update_cpu_regs(struct pt_regs *regs);
48*4882a593Smuzhiyun #else
rk_minidump_add_region(const struct md_region * entry)49*4882a593Smuzhiyun static inline int rk_minidump_add_region(const struct md_region *entry)
50*4882a593Smuzhiyun {
51*4882a593Smuzhiyun 	/* Return quietly, if minidump is not supported */
52*4882a593Smuzhiyun 	return 0;
53*4882a593Smuzhiyun }
rk_minidump_remove_region(const struct md_region * entry)54*4882a593Smuzhiyun static inline int rk_minidump_remove_region(const struct md_region *entry)
55*4882a593Smuzhiyun {
56*4882a593Smuzhiyun 	return 0;
57*4882a593Smuzhiyun }
rk_minidump_update_region(int regno,const struct md_region * entry)58*4882a593Smuzhiyun static inline int rk_minidump_update_region(int regno, const struct md_region *entry)
59*4882a593Smuzhiyun {
60*4882a593Smuzhiyun 	return 0;
61*4882a593Smuzhiyun }
rk_minidump_enabled(void)62*4882a593Smuzhiyun static inline bool rk_minidump_enabled(void) { return false; }
rk_minidump_update_cpu_regs(struct pt_regs * regs)63*4882a593Smuzhiyun static inline void rk_minidump_update_cpu_regs(struct pt_regs *regs) { return; }
64*4882a593Smuzhiyun #endif
65*4882a593Smuzhiyun 
66*4882a593Smuzhiyun extern void rk_md_flush_dcache_area(void *addr, size_t len);
67*4882a593Smuzhiyun #endif /* __RK_MINIDUMP_H */
68