[mirror_ubuntu-bionic-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>
#include <linux/mutex.h>
#include <linux/types.h>
#include <linux/spinlock.h>
#include <linux/errno.h>

/* types */
enum pstore_type_id {
	PSTORE_TYPE_DMESG	= 0,
	PSTORE_TYPE_MCE		= 1,
	PSTORE_TYPE_CONSOLE	= 2,
	PSTORE_TYPE_FTRACE	= 3,
	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		(*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_FTRACE
extern void pstore_ftrace_call(unsigned long ip, unsigned long parent_ip);
#else
static inline void pstore_ftrace_call(unsigned long ip, unsigned long parent_ip)
{ }
#endif

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