xref: /openbmc/linux/include/linux/pstore_ram.h (revision ae3473231e77a3f1909d48cd144cebe5e1d049b3)
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/compiler.h>
21 #include <linux/device.h>
22 #include <linux/init.h>
23 #include <linux/kernel.h>
24 #include <linux/list.h>
25 #include <linux/types.h>
26 
27 /*
28  * Choose whether access to the RAM zone requires locking or not.  If a zone
29  * can be written to from different CPUs like with ftrace for example, then
30  * PRZ_FLAG_NO_LOCK is used. For all other cases, locking is required.
31  */
32 #define PRZ_FLAG_NO_LOCK	BIT(0)
33 
34 struct persistent_ram_buffer;
35 struct rs_control;
36 
37 struct persistent_ram_ecc_info {
38 	int block_size;
39 	int ecc_size;
40 	int symsize;
41 	int poly;
42 };
43 
44 struct persistent_ram_zone {
45 	phys_addr_t paddr;
46 	size_t size;
47 	void *vaddr;
48 	struct persistent_ram_buffer *buffer;
49 	size_t buffer_size;
50 	u32 flags;
51 	raw_spinlock_t buffer_lock;
52 
53 	/* ECC correction */
54 	char *par_buffer;
55 	char *par_header;
56 	struct rs_control *rs_decoder;
57 	int corrected_bytes;
58 	int bad_blocks;
59 	struct persistent_ram_ecc_info ecc_info;
60 
61 	char *old_log;
62 	size_t old_log_size;
63 };
64 
65 struct persistent_ram_zone *persistent_ram_new(phys_addr_t start, size_t size,
66 			u32 sig, struct persistent_ram_ecc_info *ecc_info,
67 			unsigned int memtype, u32 flags);
68 void persistent_ram_free(struct persistent_ram_zone *prz);
69 void persistent_ram_zap(struct persistent_ram_zone *prz);
70 
71 int persistent_ram_write(struct persistent_ram_zone *prz, const void *s,
72 			 unsigned int count);
73 int persistent_ram_write_user(struct persistent_ram_zone *prz,
74 			      const void __user *s, unsigned int count);
75 
76 void persistent_ram_save_old(struct persistent_ram_zone *prz);
77 size_t persistent_ram_old_size(struct persistent_ram_zone *prz);
78 void *persistent_ram_old(struct persistent_ram_zone *prz);
79 void persistent_ram_free_old(struct persistent_ram_zone *prz);
80 ssize_t persistent_ram_ecc_string(struct persistent_ram_zone *prz,
81 	char *str, size_t len);
82 
83 /*
84  * Ramoops platform data
85  * @mem_size	memory size for ramoops
86  * @mem_address	physical memory address to contain ramoops
87  */
88 
89 #define RAMOOPS_FLAG_FTRACE_PER_CPU	BIT(0)
90 
91 struct ramoops_platform_data {
92 	unsigned long	mem_size;
93 	phys_addr_t	mem_address;
94 	unsigned int	mem_type;
95 	unsigned long	record_size;
96 	unsigned long	console_size;
97 	unsigned long	ftrace_size;
98 	unsigned long	pmsg_size;
99 	int		dump_oops;
100 	u32		flags;
101 	struct persistent_ram_ecc_info ecc_info;
102 };
103 
104 #endif
105