xref: /linux-6.15/include/linux/pstore_ram.h (revision 6fcd5f2c)
1 /*
2  * Copyright (C) 2010 Marco Stornelli <[email protected]>
3  * Copyright (C) 2011 Kees Cook <[email protected]>
4  * Copyright (C) 2011 Google, Inc.
5  *
6  * This software is licensed under the terms of the GNU General Public
7  * License version 2, as published by the Free Software Foundation, and
8  * may be copied, distributed, and modified under those terms.
9  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  * GNU General Public License for more details.
14  *
15  */
16 
17 #ifndef __LINUX_PSTORE_RAM_H__
18 #define __LINUX_PSTORE_RAM_H__
19 
20 #include <linux/device.h>
21 #include <linux/kernel.h>
22 #include <linux/list.h>
23 #include <linux/types.h>
24 #include <linux/init.h>
25 
26 struct persistent_ram_buffer;
27 
28 struct persistent_ram_descriptor {
29 	const char	*name;
30 	phys_addr_t	size;
31 };
32 
33 struct persistent_ram {
34 	phys_addr_t	start;
35 	phys_addr_t	size;
36 
37 	int					num_descs;
38 	struct persistent_ram_descriptor	*descs;
39 
40 	struct list_head node;
41 };
42 
43 struct persistent_ram_zone {
44 	phys_addr_t paddr;
45 	size_t size;
46 	void *vaddr;
47 	struct persistent_ram_buffer *buffer;
48 	size_t buffer_size;
49 
50 	/* ECC correction */
51 	bool ecc;
52 	char *par_buffer;
53 	char *par_header;
54 	struct rs_control *rs_decoder;
55 	int corrected_bytes;
56 	int bad_blocks;
57 	int ecc_block_size;
58 	int ecc_size;
59 	int ecc_symsize;
60 	int ecc_poly;
61 
62 	char *old_log;
63 	size_t old_log_size;
64 };
65 
66 int persistent_ram_early_init(struct persistent_ram *ram);
67 
68 struct persistent_ram_zone * __init persistent_ram_new(phys_addr_t start,
69 						       size_t size,
70 						       bool ecc);
71 void persistent_ram_free(struct persistent_ram_zone *prz);
72 struct persistent_ram_zone *persistent_ram_init_ringbuffer(struct device *dev,
73 		bool ecc);
74 
75 int persistent_ram_write(struct persistent_ram_zone *prz, const void *s,
76 	unsigned int count);
77 
78 size_t persistent_ram_old_size(struct persistent_ram_zone *prz);
79 void *persistent_ram_old(struct persistent_ram_zone *prz);
80 void persistent_ram_free_old(struct persistent_ram_zone *prz);
81 ssize_t persistent_ram_ecc_string(struct persistent_ram_zone *prz,
82 	char *str, size_t len);
83 
84 /*
85  * Ramoops platform data
86  * @mem_size	memory size for ramoops
87  * @mem_address	physical memory address to contain ramoops
88  */
89 
90 struct ramoops_platform_data {
91 	unsigned long	mem_size;
92 	unsigned long	mem_address;
93 	unsigned long	record_size;
94 	int		dump_oops;
95 	bool		ecc;
96 };
97 
98 #endif
99