blob: e1461e143be27f66522d33e4cebc020351404e4c [file] [log] [blame]
Tony Luckca01d6d2010-12-28 14:25:21 -08001/*
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
Kees Cook3d6d8d22011-11-17 13:13:29 -080025#include <linux/time.h>
26#include <linux/kmsg_dump.h>
27
Tony Luckca01d6d2010-12-28 14:25:21 -080028/* types */
29enum pstore_type_id {
30 PSTORE_TYPE_DMESG = 0,
31 PSTORE_TYPE_MCE = 1,
32 PSTORE_TYPE_UNKNOWN = 255
33};
34
35struct pstore_info {
36 struct module *owner;
37 char *name;
Don Zickusabd4d552011-08-12 10:54:51 -070038 spinlock_t buf_lock; /* serialize access to 'buf' */
Tony Luckca01d6d2010-12-28 14:25:21 -080039 char *buf;
40 size_t bufsize;
Kees Cookf6f82852011-11-17 12:58:07 -080041 struct mutex read_mutex; /* serialize open/read/close */
Chen Gong06cf91b2011-05-16 11:00:27 -070042 int (*open)(struct pstore_info *psi);
43 int (*close)(struct pstore_info *psi);
Chen Gong8d38d742011-05-16 10:58:57 -070044 ssize_t (*read)(u64 *id, enum pstore_type_id *type,
Kees Cookf6f82852011-11-17 12:58:07 -080045 struct timespec *time, char **buf,
46 struct pstore_info *psi);
Kees Cook3d6d8d22011-11-17 13:13:29 -080047 int (*write)(enum pstore_type_id type,
48 enum kmsg_dump_reason reason, u64 *id,
Chen Gongb238b8f2011-10-12 09:17:24 -070049 unsigned int part, size_t size, struct pstore_info *psi);
Matthew Garrett56280682011-07-21 16:57:53 -040050 int (*erase)(enum pstore_type_id type, u64 id,
Matthew Garrett638c1fd2011-07-21 16:57:52 -040051 struct pstore_info *psi);
Matthew Garrett638c1fd2011-07-21 16:57:52 -040052 void *data;
Tony Luckca01d6d2010-12-28 14:25:21 -080053};
54
55#ifdef CONFIG_PSTORE
56extern int pstore_register(struct pstore_info *);
Tony Luckca01d6d2010-12-28 14:25:21 -080057#else
58static inline int
59pstore_register(struct pstore_info *psi)
60{
61 return -ENODEV;
62}
Tony Luckca01d6d2010-12-28 14:25:21 -080063#endif
64
65#endif /*_LINUX_PSTORE_H*/