xref: /linux-6.15/include/linux/pstore.h (revision eecb2072)
1 /*
2  * Persistent Storage - pstore.h
3  *
4  * Copyright (C) 2010 Intel Corporation <[email protected]>
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 	struct mutex	read_mutex;	/* serialize open/read/close */
39 	int		(*open)(struct pstore_info *psi);
40 	int		(*close)(struct pstore_info *psi);
41 	ssize_t		(*read)(u64 *id, enum pstore_type_id *type,
42 			struct timespec *time, char **buf,
43 			struct pstore_info *psi);
44 	int		(*write)(enum pstore_type_id type, u64 *id,
45 			unsigned int part, size_t size, struct pstore_info *psi);
46 	int		(*erase)(enum pstore_type_id type, u64 id,
47 			struct pstore_info *psi);
48 	void		*data;
49 };
50 
51 #ifdef CONFIG_PSTORE
52 extern int pstore_register(struct pstore_info *);
53 extern int pstore_write(enum pstore_type_id type, char *buf, size_t size);
54 #else
55 static inline int
56 pstore_register(struct pstore_info *psi)
57 {
58 	return -ENODEV;
59 }
60 static inline int
61 pstore_write(enum pstore_type_id type, char *buf, size_t size)
62 {
63 	return -ENODEV;
64 }
65 #endif
66 
67 #endif /*_LINUX_PSTORE_H*/
68