xref: /linux/include/linux/pstore.h (revision 67a101f573b0cb1043c8c305112113450cb9fdbf)
1ca01d6ddSTony Luck /*
2ca01d6ddSTony Luck  * Persistent Storage - pstore.h
3ca01d6ddSTony Luck  *
4ca01d6ddSTony Luck  * Copyright (C) 2010 Intel Corporation <tony.luck@intel.com>
5ca01d6ddSTony Luck  *
6ca01d6ddSTony Luck  * This code is the generic layer to export data records from platform
7ca01d6ddSTony Luck  * level persistent storage via a file system.
8ca01d6ddSTony Luck  *
9ca01d6ddSTony Luck  *  This program is free software; you can redistribute it and/or modify
10ca01d6ddSTony Luck  *  it under the terms of the GNU General Public License version 2 as
11ca01d6ddSTony Luck  *  published by the Free Software Foundation.
12ca01d6ddSTony Luck  *
13ca01d6ddSTony Luck  *  This program is distributed in the hope that it will be useful,
14ca01d6ddSTony Luck  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
15ca01d6ddSTony Luck  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16ca01d6ddSTony Luck  *  GNU General Public License for more details.
17ca01d6ddSTony Luck  *
18ca01d6ddSTony Luck  *  You should have received a copy of the GNU General Public License
19ca01d6ddSTony Luck  *  along with this program; if not, write to the Free Software
20ca01d6ddSTony Luck  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
21ca01d6ddSTony Luck  */
22ca01d6ddSTony Luck #ifndef _LINUX_PSTORE_H
23ca01d6ddSTony Luck #define _LINUX_PSTORE_H
24ca01d6ddSTony Luck 
253d6d8d20SKees Cook #include <linux/time.h>
263d6d8d20SKees Cook #include <linux/kmsg_dump.h>
27*67a101f5SAnton Vorontsov #include <linux/mutex.h>
28*67a101f5SAnton Vorontsov #include <linux/types.h>
29*67a101f5SAnton Vorontsov #include <linux/spinlock.h>
30*67a101f5SAnton Vorontsov #include <linux/errno.h>
313d6d8d20SKees Cook 
32ca01d6ddSTony Luck /* types */
33ca01d6ddSTony Luck enum pstore_type_id {
34ca01d6ddSTony Luck 	PSTORE_TYPE_DMESG	= 0,
35ca01d6ddSTony Luck 	PSTORE_TYPE_MCE		= 1,
36f29e5956SAnton Vorontsov 	PSTORE_TYPE_CONSOLE	= 2,
37060287b8SAnton Vorontsov 	PSTORE_TYPE_FTRACE	= 3,
38ca01d6ddSTony Luck 	PSTORE_TYPE_UNKNOWN	= 255
39ca01d6ddSTony Luck };
40ca01d6ddSTony Luck 
41*67a101f5SAnton Vorontsov struct module;
42*67a101f5SAnton Vorontsov 
43ca01d6ddSTony Luck struct pstore_info {
44ca01d6ddSTony Luck 	struct module	*owner;
45ca01d6ddSTony Luck 	char		*name;
46abd4d558SDon Zickus 	spinlock_t	buf_lock;	/* serialize access to 'buf' */
47ca01d6ddSTony Luck 	char		*buf;
48ca01d6ddSTony Luck 	size_t		bufsize;
49f6f82851SKees Cook 	struct mutex	read_mutex;	/* serialize open/read/close */
5006cf91b4SChen Gong 	int		(*open)(struct pstore_info *psi);
5106cf91b4SChen Gong 	int		(*close)(struct pstore_info *psi);
528d38d74bSChen Gong 	ssize_t		(*read)(u64 *id, enum pstore_type_id *type,
53f6f82851SKees Cook 			struct timespec *time, char **buf,
54f6f82851SKees Cook 			struct pstore_info *psi);
553d6d8d20SKees Cook 	int		(*write)(enum pstore_type_id type,
563d6d8d20SKees Cook 			enum kmsg_dump_reason reason, u64 *id,
57b238b8faSChen Gong 			unsigned int part, size_t size, struct pstore_info *psi);
58897dba02SAnton Vorontsov 	int		(*write_buf)(enum pstore_type_id type,
59897dba02SAnton Vorontsov 			enum kmsg_dump_reason reason, u64 *id,
60897dba02SAnton Vorontsov 			unsigned int part, const char *buf, size_t size,
61897dba02SAnton Vorontsov 			struct pstore_info *psi);
6256280682SMatthew Garrett 	int		(*erase)(enum pstore_type_id type, u64 id,
63638c1fd3SMatthew Garrett 			struct pstore_info *psi);
64638c1fd3SMatthew Garrett 	void		*data;
65ca01d6ddSTony Luck };
66ca01d6ddSTony Luck 
67060287b8SAnton Vorontsov 
68060287b8SAnton Vorontsov #ifdef CONFIG_PSTORE_FTRACE
69060287b8SAnton Vorontsov extern void pstore_ftrace_call(unsigned long ip, unsigned long parent_ip);
70060287b8SAnton Vorontsov #else
71060287b8SAnton Vorontsov static inline void pstore_ftrace_call(unsigned long ip, unsigned long parent_ip)
72060287b8SAnton Vorontsov { }
73060287b8SAnton Vorontsov #endif
74060287b8SAnton Vorontsov 
75ca01d6ddSTony Luck #ifdef CONFIG_PSTORE
76ca01d6ddSTony Luck extern int pstore_register(struct pstore_info *);
77ca01d6ddSTony Luck #else
78ca01d6ddSTony Luck static inline int
79ca01d6ddSTony Luck pstore_register(struct pstore_info *psi)
80ca01d6ddSTony Luck {
81ca01d6ddSTony Luck 	return -ENODEV;
82ca01d6ddSTony Luck }
83ca01d6ddSTony Luck #endif
84ca01d6ddSTony Luck 
85ca01d6ddSTony Luck #endif /*_LINUX_PSTORE_H*/
86