xref: /linux/include/linux/pstore.h (revision c4ee0af3fa0dc65f690fc908f02b8355f9576ea0)
1 /*
2  * Persistent Storage - pstore.h
3  *
4  * Copyright (C) 2010 Intel Corporation <tony.luck@intel.com>
5  *
6  * This code is the generic layer to export data records from platform
7  * level persistent storage via a file system.
8  *
9  *  This program is free software; you can redistribute it and/or modify
10  *  it under the terms of the GNU General Public License version 2 as
11  *  published by the Free Software Foundation.
12  *
13  *  This program is distributed in the hope that it will be useful,
14  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
15  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  *  GNU General Public License for more details.
17  *
18  *  You should have received a copy of the GNU General Public License
19  *  along with this program; if not, write to the Free Software
20  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
21  */
22 #ifndef _LINUX_PSTORE_H
23 #define _LINUX_PSTORE_H
24 
25 #include <linux/time.h>
26 #include <linux/kmsg_dump.h>
27 #include <linux/mutex.h>
28 #include <linux/types.h>
29 #include <linux/spinlock.h>
30 #include <linux/errno.h>
31 
32 /* types */
33 enum pstore_type_id {
34 	PSTORE_TYPE_DMESG	= 0,
35 	PSTORE_TYPE_MCE		= 1,
36 	PSTORE_TYPE_CONSOLE	= 2,
37 	PSTORE_TYPE_FTRACE	= 3,
38 	/* PPC64 partition types */
39 	PSTORE_TYPE_PPC_RTAS	= 4,
40 	PSTORE_TYPE_PPC_OF	= 5,
41 	PSTORE_TYPE_PPC_COMMON	= 6,
42 	PSTORE_TYPE_UNKNOWN	= 255
43 };
44 
45 struct module;
46 
47 struct pstore_info {
48 	struct module	*owner;
49 	char		*name;
50 	spinlock_t	buf_lock;	/* serialize access to 'buf' */
51 	char		*buf;
52 	size_t		bufsize;
53 	struct mutex	read_mutex;	/* serialize open/read/close */
54 	int		flags;
55 	int		(*open)(struct pstore_info *psi);
56 	int		(*close)(struct pstore_info *psi);
57 	ssize_t		(*read)(u64 *id, enum pstore_type_id *type,
58 			int *count, struct timespec *time, char **buf,
59 			bool *compressed, struct pstore_info *psi);
60 	int		(*write)(enum pstore_type_id type,
61 			enum kmsg_dump_reason reason, u64 *id,
62 			unsigned int part, int count, bool compressed,
63 			size_t size, struct pstore_info *psi);
64 	int		(*write_buf)(enum pstore_type_id type,
65 			enum kmsg_dump_reason reason, u64 *id,
66 			unsigned int part, const char *buf, bool compressed,
67 			size_t size, struct pstore_info *psi);
68 	int		(*erase)(enum pstore_type_id type, u64 id,
69 			int count, struct timespec time,
70 			struct pstore_info *psi);
71 	void		*data;
72 };
73 
74 #define	PSTORE_FLAGS_FRAGILE	1
75 
76 #ifdef CONFIG_PSTORE
77 extern int pstore_register(struct pstore_info *);
78 extern bool pstore_cannot_block_path(enum kmsg_dump_reason reason);
79 #else
80 static inline int
81 pstore_register(struct pstore_info *psi)
82 {
83 	return -ENODEV;
84 }
85 static inline bool
86 pstore_cannot_block_path(enum kmsg_dump_reason reason)
87 {
88 	return false;
89 }
90 #endif
91 
92 #endif /*_LINUX_PSTORE_H*/
93