[linux-2.6-block.git] / include / linux / pstore_ram.h

/*
 * Copyright (C) 2010 Marco Stornelli <marco.stornelli@gmail.com>
 * Copyright (C) 2011 Kees Cook <keescook@chromium.org>
 * Copyright (C) 2011 Google, Inc.
 *
 * This software is licensed under the terms of the GNU General Public
 * License version 2, as published by the Free Software Foundation, and
 * may be copied, distributed, and modified under those terms.
 *
 * 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.
 *
 */

#ifndef __LINUX_PSTORE_RAM_H__
#define __LINUX_PSTORE_RAM_H__

#include <linux/compiler.h>
#include <linux/device.h>
#include <linux/init.h>
#include <linux/kernel.h>
#include <linux/list.h>
#include <linux/types.h>

/*
 * Choose whether access to the RAM zone requires locking or not.  If a zone
 * can be written to from different CPUs like with ftrace for example, then
 * PRZ_FLAG_NO_LOCK is used. For all other cases, locking is required.
 */
#define PRZ_FLAG_NO_LOCK	BIT(0)

struct persistent_ram_buffer;
struct rs_control;

struct persistent_ram_ecc_info {
	int block_size;
	int ecc_size;
	int symsize;
	int poly;
	uint16_t *par;
};

struct persistent_ram_zone {
	phys_addr_t paddr;
	size_t size;
	void *vaddr;
	struct persistent_ram_buffer *buffer;
	size_t buffer_size;
	u32 flags;
	raw_spinlock_t buffer_lock;

	/* ECC correction */
	char *par_buffer;
	char *par_header;
	struct rs_control *rs_decoder;
	int corrected_bytes;
	int bad_blocks;
	struct persistent_ram_ecc_info ecc_info;

	char *old_log;
	size_t old_log_size;
};

struct persistent_ram_zone *persistent_ram_new(phys_addr_t start, size_t size,
			u32 sig, struct persistent_ram_ecc_info *ecc_info,
			unsigned int memtype, u32 flags);
void persistent_ram_free(struct persistent_ram_zone *prz);
void persistent_ram_zap(struct persistent_ram_zone *prz);

int persistent_ram_write(struct persistent_ram_zone *prz, const void *s,
			 unsigned int count);
int persistent_ram_write_user(struct persistent_ram_zone *prz,
			      const void __user *s, unsigned int count);

void persistent_ram_save_old(struct persistent_ram_zone *prz);
size_t persistent_ram_old_size(struct persistent_ram_zone *prz);
void *persistent_ram_old(struct persistent_ram_zone *prz);
void persistent_ram_free_old(struct persistent_ram_zone *prz);
ssize_t persistent_ram_ecc_string(struct persistent_ram_zone *prz,
	char *str, size_t len);

/*
 * Ramoops platform data
 * @mem_size	memory size for ramoops
 * @mem_address	physical memory address to contain ramoops
 */

#define RAMOOPS_FLAG_FTRACE_PER_CPU	BIT(0)

struct ramoops_platform_data {
	unsigned long	mem_size;
	phys_addr_t	mem_address;
	unsigned int	mem_type;
	unsigned long	record_size;
	unsigned long	console_size;
	unsigned long	ftrace_size;
	unsigned long	pmsg_size;
	int		dump_oops;
	u32		flags;
	struct persistent_ram_ecc_info ecc_info;
};

#endif
Commit	Line	Data
cddb8751 AV	1	/*
	2	* Copyright (C) 2010 Marco Stornelli <marco.stornelli@gmail.com>
	3	* Copyright (C) 2011 Kees Cook <keescook@chromium.org>
	4	* Copyright (C) 2011 Google, Inc.
	5	*
	6	* This software is licensed under the terms of the GNU General Public
	7	* License version 2, as published by the Free Software Foundation, and
	8	* may be copied, distributed, and modified under those terms.
	9	*
	10	* This program is distributed in the hope that it will be useful,
	11	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	12	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	13	* GNU General Public License for more details.
	14	*
	15	*/
	16
1894a253 AV	17	#ifndef __LINUX_PSTORE_RAM_H__
1894a253 AV	18	#define __LINUX_PSTORE_RAM_H__
c3b92ce9	19
5bf6d1b9	20	#include <linux/compiler.h>
cddb8751	21	#include <linux/device.h>
5bf6d1b9	22	#include <linux/init.h>
cddb8751 AV	23	#include <linux/kernel.h>
	24	#include <linux/list.h>
	25	#include <linux/types.h>
cddb8751	26
663deb47 JF	27	/*
	28	* Choose whether access to the RAM zone requires locking or not. If a zone
	29	* can be written to from different CPUs like with ftrace for example, then
	30	* PRZ_FLAG_NO_LOCK is used. For all other cases, locking is required.
	31	*/
	32	#define PRZ_FLAG_NO_LOCK BIT(0)
	33
cddb8751	34	struct persistent_ram_buffer;
67a101f5	35	struct rs_control;
cddb8751	36
c31ad081 AH	37	struct persistent_ram_ecc_info {
	38	int block_size;
	39	int ecc_size;
	40	int symsize;
	41	int poly;
f2531f19	42	uint16_t *par;
c31ad081 AH	43	};
c31ad081 AH	44
cddb8751 AV	45	struct persistent_ram_zone {
	46	phys_addr_t paddr;
	47	size_t size;
	48	void *vaddr;
	49	struct persistent_ram_buffer *buffer;
	50	size_t buffer_size;
663deb47	51	u32 flags;
10970449	52	raw_spinlock_t buffer_lock;
cddb8751 AV	53
cddb8751 AV	54	/* ECC correction */
cddb8751 AV	55	char *par_buffer;
	56	char *par_header;
	57	struct rs_control *rs_decoder;
	58	int corrected_bytes;
	59	int bad_blocks;
c31ad081	60	struct persistent_ram_ecc_info ecc_info;
cddb8751 AV	61
	62	char *old_log;
	63	size_t old_log_size;
	64	};
	65
f568f6ca	66	struct persistent_ram_zone *persistent_ram_new(phys_addr_t start, size_t size,
027bc8b0	67	u32 sig, struct persistent_ram_ecc_info *ecc_info,
663deb47	68	unsigned int memtype, u32 flags);
cddb8751	69	void persistent_ram_free(struct persistent_ram_zone *prz);
fce39793	70	void persistent_ram_zap(struct persistent_ram_zone *prz);
cddb8751 AV	71
cddb8751 AV	72	int persistent_ram_write(struct persistent_ram_zone prz, const void s,
5bf6d1b9 MS	73	unsigned int count);
	74	int persistent_ram_write_user(struct persistent_ram_zone *prz,
	75	const void __user *s, unsigned int count);
cddb8751	76
201e4aca	77	void persistent_ram_save_old(struct persistent_ram_zone *prz);
cddb8751 AV	78	size_t persistent_ram_old_size(struct persistent_ram_zone *prz);
	79	void persistent_ram_old(struct persistent_ram_zone prz);
	80	void persistent_ram_free_old(struct persistent_ram_zone *prz);
	81	ssize_t persistent_ram_ecc_string(struct persistent_ram_zone *prz,
	82	char *str, size_t len);
	83
c3b92ce9 KP	84	/*
	85	* Ramoops platform data
	86	* @mem_size memory size for ramoops
	87	* @mem_address physical memory address to contain ramoops
	88	*/
	89
a1cf53ac JF	90	#define RAMOOPS_FLAG_FTRACE_PER_CPU BIT(0)
a1cf53ac JF	91
c3b92ce9 KP	92	struct ramoops_platform_data {
c3b92ce9 KP	93	unsigned long mem_size;
764fd639	94	phys_addr_t mem_address;
027bc8b0	95	unsigned int mem_type;
3e5c4fad	96	unsigned long record_size;
b5d38e9b	97	unsigned long console_size;
a694d1b5	98	unsigned long ftrace_size;
9d5438f4	99	unsigned long pmsg_size;
6b4d2a27	100	int dump_oops;
a1cf53ac	101	u32 flags;
c31ad081	102	struct persistent_ram_ecc_info ecc_info;
c3b92ce9 KP	103	};
	104
	105	#endif