xref: /linux/include/linux/pstore.h (revision f2ee442115c9b6219083c019939a9cc0c9abb2f8)
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 /* types */
26 enum pstore_type_id {
27 	PSTORE_TYPE_DMESG	= 0,
28 	PSTORE_TYPE_MCE		= 1,
29 	PSTORE_TYPE_UNKNOWN	= 255
30 };
31 
32 struct pstore_info {
33 	struct module	*owner;
34 	char		*name;
35 	spinlock_t	buf_lock;	/* serialize access to 'buf' */
36 	char		*buf;
37 	size_t		bufsize;
38 	int		(*open)(struct pstore_info *psi);
39 	int		(*close)(struct pstore_info *psi);
40 	ssize_t		(*read)(u64 *id, enum pstore_type_id *type,
41 			struct timespec *time, struct pstore_info *psi);
42 	int		(*write)(enum pstore_type_id type, u64 *id,
43 			unsigned int part, size_t size, struct pstore_info *psi);
44 	int		(*erase)(enum pstore_type_id type, u64 id,
45 			struct pstore_info *psi);
46 	void		*data;
47 };
48 
49 #ifdef CONFIG_PSTORE
50 extern int pstore_register(struct pstore_info *);
51 extern int pstore_write(enum pstore_type_id type, char *buf, size_t size);
52 #else
53 static inline int
54 pstore_register(struct pstore_info *psi)
55 {
56 	return -ENODEV;
57 }
58 static inline int
59 pstore_write(enum pstore_type_id type, char *buf, size_t size)
60 {
61 	return -ENODEV;
62 }
63 #endif
64 
65 #endif /*_LINUX_PSTORE_H*/
66