[deliverable/linux.git] / include / linux / pstore.h

/*
 * Persistent Storage - pstore.h
 *
 * Copyright (C) 2010 Intel Corporation <tony.luck@intel.com>
 *
 * This code is the generic layer to export data records from platform
 * level persistent storage via a file system.
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License version 2 as
 *  published by the Free Software Foundation.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */
#ifndef _LINUX_PSTORE_H
#define _LINUX_PSTORE_H

#include <linux/compiler.h>
#include <linux/errno.h>
#include <linux/kmsg_dump.h>
#include <linux/mutex.h>
#include <linux/spinlock.h>
#include <linux/time.h>
#include <linux/types.h>

/* types */
enum pstore_type_id {
	PSTORE_TYPE_DMESG	= 0,
	PSTORE_TYPE_MCE		= 1,
	PSTORE_TYPE_CONSOLE	= 2,
	PSTORE_TYPE_FTRACE	= 3,
	/* PPC64 partition types */
	PSTORE_TYPE_PPC_RTAS	= 4,
	PSTORE_TYPE_PPC_OF	= 5,
	PSTORE_TYPE_PPC_COMMON	= 6,
	PSTORE_TYPE_PMSG	= 7,
	PSTORE_TYPE_PPC_OPAL	= 8,
	PSTORE_TYPE_UNKNOWN	= 255
};

struct module;

struct pstore_info {
	struct module	*owner;
	char		*name;
	spinlock_t	buf_lock;	/* serialize access to 'buf' */
	char		*buf;
	size_t		bufsize;
	struct mutex	read_mutex;	/* serialize open/read/close */
	int		flags;
	int		(*open)(struct pstore_info *psi);
	int		(*close)(struct pstore_info *psi);
	ssize_t		(*read)(u64 *id, enum pstore_type_id *type,
			int *count, struct timespec *time, char **buf,
			bool *compressed, ssize_t *ecc_notice_size,
			struct pstore_info *psi);
	int		(*write)(enum pstore_type_id type,
			enum kmsg_dump_reason reason, u64 *id,
			unsigned int part, int count, bool compressed,
			size_t size, struct pstore_info *psi);
	int		(*write_buf)(enum pstore_type_id type,
			enum kmsg_dump_reason reason, u64 *id,
			unsigned int part, const char *buf, bool compressed,
			size_t size, struct pstore_info *psi);
	int		(*write_buf_user)(enum pstore_type_id type,
			enum kmsg_dump_reason reason, u64 *id,
			unsigned int part, const char __user *buf,
			bool compressed, size_t size, struct pstore_info *psi);
	int		(*erase)(enum pstore_type_id type, u64 id,
			int count, struct timespec time,
			struct pstore_info *psi);
	void		*data;
};

#define PSTORE_FLAGS_DMESG	(1 << 0)
#define PSTORE_FLAGS_FRAGILE	PSTORE_FLAGS_DMESG
#define PSTORE_FLAGS_CONSOLE	(1 << 1)
#define PSTORE_FLAGS_FTRACE	(1 << 2)
#define PSTORE_FLAGS_PMSG	(1 << 3)

extern int pstore_register(struct pstore_info *);
extern void pstore_unregister(struct pstore_info *);
extern bool pstore_cannot_block_path(enum kmsg_dump_reason reason);

#endif /*_LINUX_PSTORE_H*/
Commit	Line	Data
ca01d6dd TL	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
5bf6d1b9 MS	25	#include <linux/compiler.h>
5bf6d1b9 MS	26	#include <linux/errno.h>
3d6d8d20	27	#include <linux/kmsg_dump.h>
67a101f5	28	#include <linux/mutex.h>
67a101f5	29	#include <linux/spinlock.h>
5bf6d1b9 MS	30	#include <linux/time.h>
5bf6d1b9 MS	31	#include <linux/types.h>
3d6d8d20	32
ca01d6dd TL	33	/* types */
	34	enum pstore_type_id {
	35	PSTORE_TYPE_DMESG = 0,
	36	PSTORE_TYPE_MCE = 1,
f29e5956	37	PSTORE_TYPE_CONSOLE = 2,
060287b8	38	PSTORE_TYPE_FTRACE = 3,
69020eea AB	39	/* PPC64 partition types */
69020eea AB	40	PSTORE_TYPE_PPC_RTAS = 4,
f33f748c	41	PSTORE_TYPE_PPC_OF = 5,
a5e4797b	42	PSTORE_TYPE_PPC_COMMON = 6,
9d5438f4	43	PSTORE_TYPE_PMSG = 7,
ae011d2e	44	PSTORE_TYPE_PPC_OPAL = 8,
ca01d6dd TL	45	PSTORE_TYPE_UNKNOWN = 255
	46	};
	47
67a101f5 AV	48	struct module;
67a101f5 AV	49
ca01d6dd TL	50	struct pstore_info {
	51	struct module *owner;
	52	char *name;
abd4d558	53	spinlock_t buf_lock; /* serialize access to 'buf' */
ca01d6dd TL	54	char *buf;
ca01d6dd TL	55	size_t bufsize;
f6f82851	56	struct mutex read_mutex; /* serialize open/read/close */
df36ac1b	57	int flags;
06cf91b4 CG	58	int (open)(struct pstore_info psi);
06cf91b4 CG	59	int (close)(struct pstore_info psi);
8d38d74b	60	ssize_t (read)(u64 id, enum pstore_type_id *type,
755d4fe4	61	int count, struct timespec time, char **buf,
8cfc8ddc GT	62	bool compressed, ssize_t ecc_notice_size,
8cfc8ddc GT	63	struct pstore_info *psi);
3d6d8d20 KC	64	int (*write)(enum pstore_type_id type,
3d6d8d20 KC	65	enum kmsg_dump_reason reason, u64 *id,
b3b515bb	66	unsigned int part, int count, bool compressed,
6bbbca73	67	size_t size, struct pstore_info *psi);
897dba02 AV	68	int (*write_buf)(enum pstore_type_id type,
897dba02 AV	69	enum kmsg_dump_reason reason, u64 *id,
b3b515bb	70	unsigned int part, const char *buf, bool compressed,
6bbbca73	71	size_t size, struct pstore_info *psi);
5bf6d1b9 MS	72	int (*write_buf_user)(enum pstore_type_id type,
	73	enum kmsg_dump_reason reason, u64 *id,
	74	unsigned int part, const char __user *buf,
	75	bool compressed, size_t size, struct pstore_info *psi);
56280682	76	int (*erase)(enum pstore_type_id type, u64 id,
755d4fe4 SA	77	int count, struct timespec time,
755d4fe4 SA	78	struct pstore_info *psi);
638c1fd3	79	void *data;
ca01d6dd TL	80	};
ca01d6dd TL	81
c950fd6f NK	82	#define PSTORE_FLAGS_DMESG (1 << 0)
	83	#define PSTORE_FLAGS_FRAGILE PSTORE_FLAGS_DMESG
	84	#define PSTORE_FLAGS_CONSOLE (1 << 1)
	85	#define PSTORE_FLAGS_FTRACE (1 << 2)
	86	#define PSTORE_FLAGS_PMSG (1 << 3)
	87
ca01d6dd	88	extern int pstore_register(struct pstore_info *);
ee1d2674	89	extern void pstore_unregister(struct pstore_info *);
9f244e9c	90	extern bool pstore_cannot_block_path(enum kmsg_dump_reason reason);
ca01d6dd TL	91
ca01d6dd TL	92	#endif /_LINUX_PSTORE_H/