xref: /linux/include/linux/pstore.h (revision a5e4797b0f46819a74a7233825137ed5d2f51b51)
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>
2767a101f5SAnton Vorontsov #include <linux/mutex.h>
2867a101f5SAnton Vorontsov #include <linux/types.h>
2967a101f5SAnton Vorontsov #include <linux/spinlock.h>
3067a101f5SAnton 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,
3869020eeaSAruna Balakrishnaiah 	/* PPC64 partition types */
3969020eeaSAruna Balakrishnaiah 	PSTORE_TYPE_PPC_RTAS	= 4,
40f33f748cSAruna Balakrishnaiah 	PSTORE_TYPE_PPC_OF	= 5,
41*a5e4797bSAruna Balakrishnaiah 	PSTORE_TYPE_PPC_COMMON	= 6,
42ca01d6ddSTony Luck 	PSTORE_TYPE_UNKNOWN	= 255
43ca01d6ddSTony Luck };
44ca01d6ddSTony Luck 
4567a101f5SAnton Vorontsov struct module;
4667a101f5SAnton Vorontsov 
47ca01d6ddSTony Luck struct pstore_info {
48ca01d6ddSTony Luck 	struct module	*owner;
49ca01d6ddSTony Luck 	char		*name;
50abd4d558SDon Zickus 	spinlock_t	buf_lock;	/* serialize access to 'buf' */
51ca01d6ddSTony Luck 	char		*buf;
52ca01d6ddSTony Luck 	size_t		bufsize;
53f6f82851SKees Cook 	struct mutex	read_mutex;	/* serialize open/read/close */
5406cf91b4SChen Gong 	int		(*open)(struct pstore_info *psi);
5506cf91b4SChen Gong 	int		(*close)(struct pstore_info *psi);
568d38d74bSChen Gong 	ssize_t		(*read)(u64 *id, enum pstore_type_id *type,
57755d4fe4SSeiji Aguchi 			int *count, struct timespec *time, char **buf,
58f6f82851SKees Cook 			struct pstore_info *psi);
593d6d8d20SKees Cook 	int		(*write)(enum pstore_type_id type,
603d6d8d20SKees Cook 			enum kmsg_dump_reason reason, u64 *id,
61755d4fe4SSeiji Aguchi 			unsigned int part, int count, size_t size,
62755d4fe4SSeiji Aguchi 			struct pstore_info *psi);
63897dba02SAnton Vorontsov 	int		(*write_buf)(enum pstore_type_id type,
64897dba02SAnton Vorontsov 			enum kmsg_dump_reason reason, u64 *id,
65897dba02SAnton Vorontsov 			unsigned int part, const char *buf, size_t size,
66897dba02SAnton Vorontsov 			struct pstore_info *psi);
6756280682SMatthew Garrett 	int		(*erase)(enum pstore_type_id type, u64 id,
68755d4fe4SSeiji Aguchi 			int count, struct timespec time,
69755d4fe4SSeiji Aguchi 			struct pstore_info *psi);
70638c1fd3SMatthew Garrett 	void		*data;
71ca01d6ddSTony Luck };
72ca01d6ddSTony Luck 
73ca01d6ddSTony Luck #ifdef CONFIG_PSTORE
74ca01d6ddSTony Luck extern int pstore_register(struct pstore_info *);
759f244e9cSSeiji Aguchi extern bool pstore_cannot_block_path(enum kmsg_dump_reason reason);
76ca01d6ddSTony Luck #else
77ca01d6ddSTony Luck static inline int
78ca01d6ddSTony Luck pstore_register(struct pstore_info *psi)
79ca01d6ddSTony Luck {
80ca01d6ddSTony Luck 	return -ENODEV;
81ca01d6ddSTony Luck }
829f244e9cSSeiji Aguchi static inline bool
839f244e9cSSeiji Aguchi pstore_cannot_block_path(enum kmsg_dump_reason reason)
849f244e9cSSeiji Aguchi {
859f244e9cSSeiji Aguchi 	return false;
869f244e9cSSeiji Aguchi }
87ca01d6ddSTony Luck #endif
88ca01d6ddSTony Luck 
89ca01d6ddSTony Luck #endif /*_LINUX_PSTORE_H*/
90