xref: /linux/include/linux/pstore.h (revision 4413e16d9d21673bb5048a2e542f1aaa00015c2e)
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 	PSTORE_TYPE_UNKNOWN	= 255
39 };
40 
41 struct module;
42 
43 struct pstore_info {
44 	struct module	*owner;
45 	char		*name;
46 	spinlock_t	buf_lock;	/* serialize access to 'buf' */
47 	char		*buf;
48 	size_t		bufsize;
49 	struct mutex	read_mutex;	/* serialize open/read/close */
50 	int		(*open)(struct pstore_info *psi);
51 	int		(*close)(struct pstore_info *psi);
52 	ssize_t		(*read)(u64 *id, enum pstore_type_id *type,
53 			struct timespec *time, char **buf,
54 			struct pstore_info *psi);
55 	int		(*write)(enum pstore_type_id type,
56 			enum kmsg_dump_reason reason, u64 *id,
57 			unsigned int part, size_t size, struct pstore_info *psi);
58 	int		(*write_buf)(enum pstore_type_id type,
59 			enum kmsg_dump_reason reason, u64 *id,
60 			unsigned int part, const char *buf, size_t size,
61 			struct pstore_info *psi);
62 	int		(*erase)(enum pstore_type_id type, u64 id,
63 			struct pstore_info *psi);
64 	void		*data;
65 };
66 
67 
68 #ifdef CONFIG_PSTORE_FTRACE
69 extern void pstore_ftrace_call(unsigned long ip, unsigned long parent_ip);
70 #else
71 static inline void pstore_ftrace_call(unsigned long ip, unsigned long parent_ip)
72 { }
73 #endif
74 
75 #ifdef CONFIG_PSTORE
76 extern int pstore_register(struct pstore_info *);
77 #else
78 static inline int
79 pstore_register(struct pstore_info *psi)
80 {
81 	return -ENODEV;
82 }
83 #endif
84 
85 #endif /*_LINUX_PSTORE_H*/
86