[mirror_ubuntu-artful-kernel.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/time.h>
#include <linux/kmsg_dump.h>

/* types */
enum pstore_type_id {
	PSTORE_TYPE_DMESG	= 0,
	PSTORE_TYPE_MCE		= 1,
	PSTORE_TYPE_CONSOLE	= 2,
	PSTORE_TYPE_UNKNOWN	= 255
};

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		(*open)(struct pstore_info *psi);
	int		(*close)(struct pstore_info *psi);
	ssize_t		(*read)(u64 *id, enum pstore_type_id *type,
			struct timespec *time, char **buf,
			struct pstore_info *psi);
	int		(*write)(enum pstore_type_id type,
			enum kmsg_dump_reason reason, u64 *id,
			unsigned int part, 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, size_t size,
			struct pstore_info *psi);
	int		(*erase)(enum pstore_type_id type, u64 id,
			struct pstore_info *psi);
	void		*data;
};

#ifdef CONFIG_PSTORE
extern int pstore_register(struct pstore_info *);
#else
static inline int
pstore_register(struct pstore_info *psi)
{
	return -ENODEV;
}
#endif

#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
3d6d8d20 KC	25	#include <linux/time.h>
	26	#include <linux/kmsg_dump.h>
	27
ca01d6dd TL	28	/* types */
	29	enum pstore_type_id {
	30	PSTORE_TYPE_DMESG = 0,
	31	PSTORE_TYPE_MCE = 1,
f29e5956	32	PSTORE_TYPE_CONSOLE = 2,
ca01d6dd TL	33	PSTORE_TYPE_UNKNOWN = 255
	34	};
	35
	36	struct pstore_info {
	37	struct module *owner;
	38	char *name;
abd4d558	39	spinlock_t buf_lock; /* serialize access to 'buf' */
ca01d6dd TL	40	char *buf;
ca01d6dd TL	41	size_t bufsize;
f6f82851	42	struct mutex read_mutex; /* serialize open/read/close */
06cf91b4 CG	43	int (open)(struct pstore_info psi);
06cf91b4 CG	44	int (close)(struct pstore_info psi);
8d38d74b	45	ssize_t (read)(u64 id, enum pstore_type_id *type,
f6f82851 KC	46	struct timespec time, char *buf,
f6f82851 KC	47	struct pstore_info *psi);
3d6d8d20 KC	48	int (*write)(enum pstore_type_id type,
3d6d8d20 KC	49	enum kmsg_dump_reason reason, u64 *id,
b238b8fa	50	unsigned int part, size_t size, struct pstore_info *psi);
897dba02 AV	51	int (*write_buf)(enum pstore_type_id type,
	52	enum kmsg_dump_reason reason, u64 *id,
	53	unsigned int part, const char *buf, size_t size,
	54	struct pstore_info *psi);
56280682	55	int (*erase)(enum pstore_type_id type, u64 id,
638c1fd3	56	struct pstore_info *psi);
638c1fd3	57	void *data;
ca01d6dd TL	58	};
	59
	60	#ifdef CONFIG_PSTORE
	61	extern int pstore_register(struct pstore_info *);
ca01d6dd TL	62	#else
	63	static inline int
	64	pstore_register(struct pstore_info *psi)
	65	{
	66	return -ENODEV;
	67	}
ca01d6dd TL	68	#endif
	69
	70	#endif /_LINUX_PSTORE_H/