xref: /openbmc/linux/include/linux/pstore_ram.h (revision 275876e2)
1 /*
2  * Copyright (C) 2010 Marco Stornelli <marco.stornelli@gmail.com>
3  * Copyright (C) 2011 Kees Cook <keescook@chromium.org>
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 struct rs_control;
28 
29 struct persistent_ram_ecc_info {
30 	int block_size;
31 	int ecc_size;
32 	int symsize;
33 	int poly;
34 };
35 
36 struct persistent_ram_zone {
37 	phys_addr_t paddr;
38 	size_t size;
39 	void *vaddr;
40 	struct persistent_ram_buffer *buffer;
41 	size_t buffer_size;
42 
43 	/* ECC correction */
44 	char *par_buffer;
45 	char *par_header;
46 	struct rs_control *rs_decoder;
47 	int corrected_bytes;
48 	int bad_blocks;
49 	struct persistent_ram_ecc_info ecc_info;
50 
51 	char *old_log;
52 	size_t old_log_size;
53 };
54 
55 struct persistent_ram_zone *persistent_ram_new(phys_addr_t start, size_t size,
56 			u32 sig, struct persistent_ram_ecc_info *ecc_info);
57 void persistent_ram_free(struct persistent_ram_zone *prz);
58 void persistent_ram_zap(struct persistent_ram_zone *prz);
59 
60 int persistent_ram_write(struct persistent_ram_zone *prz, const void *s,
61 	unsigned int count);
62 
63 void persistent_ram_save_old(struct persistent_ram_zone *prz);
64 size_t persistent_ram_old_size(struct persistent_ram_zone *prz);
65 void *persistent_ram_old(struct persistent_ram_zone *prz);
66 void persistent_ram_free_old(struct persistent_ram_zone *prz);
67 ssize_t persistent_ram_ecc_string(struct persistent_ram_zone *prz,
68 	char *str, size_t len);
69 
70 /*
71  * Ramoops platform data
72  * @mem_size	memory size for ramoops
73  * @mem_address	physical memory address to contain ramoops
74  */
75 
76 struct ramoops_platform_data {
77 	unsigned long	mem_size;
78 	unsigned long	mem_address;
79 	unsigned long	record_size;
80 	unsigned long	console_size;
81 	unsigned long	ftrace_size;
82 	int		dump_oops;
83 	struct persistent_ram_ecc_info ecc_info;
84 };
85 
86 #endif
87