blob: ece0c6bbfcc5617f394092ec027f39ce3abc629d [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,
Aruna Balakrishnaiah69020ee2013-06-06 00:21:44 +053038 /* PPC64 partition types */
39 PSTORE_TYPE_PPC_RTAS = 4,
Aruna Balakrishnaiahf33f7482013-06-06 00:22:10 +053040 PSTORE_TYPE_PPC_OF = 5,
Aruna Balakrishnaiaha5e47972013-06-06 00:22:20 +053041 PSTORE_TYPE_PPC_COMMON = 6,
Tony Luckca01d6d2010-12-28 14:25:21 -080042 PSTORE_TYPE_UNKNOWN = 255
43};
44
Anton Vorontsov67a101f2012-07-17 11:37:07 -070045struct module;
46
Tony Luckca01d6d2010-12-28 14:25:21 -080047struct pstore_info {
48 struct module *owner;
49 char *name;
Don Zickusabd4d552011-08-12 10:54:51 -070050 spinlock_t buf_lock; /* serialize access to 'buf' */
Tony Luckca01d6d2010-12-28 14:25:21 -080051 char *buf;
52 size_t bufsize;
Kees Cookf6f82852011-11-17 12:58:07 -080053 struct mutex read_mutex; /* serialize open/read/close */
Luck, Tonydf36ac12013-12-18 15:17:10 -080054 int flags;
Chen Gong06cf91b2011-05-16 11:00:27 -070055 int (*open)(struct pstore_info *psi);
56 int (*close)(struct pstore_info *psi);
Chen Gong8d38d742011-05-16 10:58:57 -070057 ssize_t (*read)(u64 *id, enum pstore_type_id *type,
Seiji Aguchi755d4fe2012-11-26 16:07:44 -080058 int *count, struct timespec *time, char **buf,
Aruna Balakrishnaiah9a4e1392013-08-16 13:53:19 -070059 bool *compressed, struct pstore_info *psi);
Kees Cook3d6d8d22011-11-17 13:13:29 -080060 int (*write)(enum pstore_type_id type,
61 enum kmsg_dump_reason reason, u64 *id,
Aruna Balakrishnaiahb3b515b2013-08-16 13:52:47 -070062 unsigned int part, int count, bool compressed,
Aruna Balakrishnaiah6bbbca72013-06-27 14:02:56 +053063 size_t size, struct pstore_info *psi);
Anton Vorontsov897dba02012-07-09 17:10:40 -070064 int (*write_buf)(enum pstore_type_id type,
65 enum kmsg_dump_reason reason, u64 *id,
Aruna Balakrishnaiahb3b515b2013-08-16 13:52:47 -070066 unsigned int part, const char *buf, bool compressed,
Aruna Balakrishnaiah6bbbca72013-06-27 14:02:56 +053067 size_t size, struct pstore_info *psi);
Matthew Garrett56280682011-07-21 16:57:53 -040068 int (*erase)(enum pstore_type_id type, u64 id,
Seiji Aguchi755d4fe2012-11-26 16:07:44 -080069 int count, struct timespec time,
70 struct pstore_info *psi);
Matthew Garrett638c1fd2011-07-21 16:57:52 -040071 void *data;
Tony Luckca01d6d2010-12-28 14:25:21 -080072};
73
Luck, Tonydf36ac12013-12-18 15:17:10 -080074#define PSTORE_FLAGS_FRAGILE 1
75
Tony Luckca01d6d2010-12-28 14:25:21 -080076#ifdef CONFIG_PSTORE
77extern int pstore_register(struct pstore_info *);
Seiji Aguchi9f244e92013-01-11 18:09:41 +000078extern bool pstore_cannot_block_path(enum kmsg_dump_reason reason);
Tony Luckca01d6d2010-12-28 14:25:21 -080079#else
80static inline int
81pstore_register(struct pstore_info *psi)
82{
83 return -ENODEV;
84}
Seiji Aguchi9f244e92013-01-11 18:09:41 +000085static inline bool
86pstore_cannot_block_path(enum kmsg_dump_reason reason)
87{
88 return false;
89}
Tony Luckca01d6d2010-12-28 14:25:21 -080090#endif
91
92#endif /*_LINUX_PSTORE_H*/