blob: 75d01760c91197e0a44066773b52af5bc063349b [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>
Anton Vorontsov67a101f2012-07-17 11:37:07 -070027#include <linux/mutex.h>
28#include <linux/types.h>
29#include <linux/spinlock.h>
30#include <linux/errno.h>
Kees Cook3d6d8d22011-11-17 13:13:29 -080031
Tony Luckca01d6d2010-12-28 14:25:21 -080032/* types */
33enum pstore_type_id {
34 PSTORE_TYPE_DMESG = 0,
35 PSTORE_TYPE_MCE = 1,
Anton Vorontsovf29e5952012-05-26 06:20:19 -070036 PSTORE_TYPE_CONSOLE = 2,
Anton Vorontsov060287b2012-07-09 17:10:41 -070037 PSTORE_TYPE_FTRACE = 3,
Tony Luckca01d6d2010-12-28 14:25:21 -080038 PSTORE_TYPE_UNKNOWN = 255
39};
40
Anton Vorontsov67a101f2012-07-17 11:37:07 -070041struct module;
42
Tony Luckca01d6d2010-12-28 14:25:21 -080043struct pstore_info {
44 struct module *owner;
45 char *name;
Don Zickusabd4d552011-08-12 10:54:51 -070046 spinlock_t buf_lock; /* serialize access to 'buf' */
Tony Luckca01d6d2010-12-28 14:25:21 -080047 char *buf;
48 size_t bufsize;
Kees Cookf6f82852011-11-17 12:58:07 -080049 struct mutex read_mutex; /* serialize open/read/close */
Chen Gong06cf91b2011-05-16 11:00:27 -070050 int (*open)(struct pstore_info *psi);
51 int (*close)(struct pstore_info *psi);
Chen Gong8d38d742011-05-16 10:58:57 -070052 ssize_t (*read)(u64 *id, enum pstore_type_id *type,
Seiji Aguchi755d4fe2012-11-26 16:07:44 -080053 int *count, struct timespec *time, char **buf,
Kees Cookf6f82852011-11-17 12:58:07 -080054 struct pstore_info *psi);
Kees Cook3d6d8d22011-11-17 13:13:29 -080055 int (*write)(enum pstore_type_id type,
56 enum kmsg_dump_reason reason, u64 *id,
Seiji Aguchi755d4fe2012-11-26 16:07:44 -080057 unsigned int part, int count, size_t size,
58 struct pstore_info *psi);
Anton Vorontsov897dba02012-07-09 17:10:40 -070059 int (*write_buf)(enum pstore_type_id type,
60 enum kmsg_dump_reason reason, u64 *id,
61 unsigned int part, const char *buf, size_t size,
62 struct pstore_info *psi);
Matthew Garrett56280682011-07-21 16:57:53 -040063 int (*erase)(enum pstore_type_id type, u64 id,
Seiji Aguchi755d4fe2012-11-26 16:07:44 -080064 int count, struct timespec time,
65 struct pstore_info *psi);
Matthew Garrett638c1fd2011-07-21 16:57:52 -040066 void *data;
Tony Luckca01d6d2010-12-28 14:25:21 -080067};
68
69#ifdef CONFIG_PSTORE
70extern int pstore_register(struct pstore_info *);
Seiji Aguchi9f244e92013-01-11 18:09:41 +000071extern bool pstore_cannot_block_path(enum kmsg_dump_reason reason);
Tony Luckca01d6d2010-12-28 14:25:21 -080072#else
73static inline int
74pstore_register(struct pstore_info *psi)
75{
76 return -ENODEV;
77}
Seiji Aguchi9f244e92013-01-11 18:09:41 +000078static inline bool
79pstore_cannot_block_path(enum kmsg_dump_reason reason)
80{
81 return false;
82}
Tony Luckca01d6d2010-12-28 14:25:21 -080083#endif
84
85#endif /*_LINUX_PSTORE_H*/