blob: cb5edd64a3d3115ea0b28b0d0d83af2e61b3ef5c [file] [log] [blame]
Anton Vorontsovcddb8752012-05-17 00:15:08 -07001/*
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
Anton Vorontsov1894a252012-05-16 05:43:08 -070017#ifndef __LINUX_PSTORE_RAM_H__
18#define __LINUX_PSTORE_RAM_H__
Kyungmin Parkc3b92ce2010-10-27 15:34:52 -070019
Mark Salyzyn5bf6d1b2016-09-01 08:13:46 -070020#include <linux/compiler.h>
Anton Vorontsovcddb8752012-05-17 00:15:08 -070021#include <linux/device.h>
Mark Salyzyn5bf6d1b2016-09-01 08:13:46 -070022#include <linux/init.h>
Anton Vorontsovcddb8752012-05-17 00:15:08 -070023#include <linux/kernel.h>
24#include <linux/list.h>
25#include <linux/types.h>
Anton Vorontsovcddb8752012-05-17 00:15:08 -070026
Joel Fernandes469308032016-10-20 00:34:01 -070027/*
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
Anton Vorontsovcddb8752012-05-17 00:15:08 -070034struct persistent_ram_buffer;
Anton Vorontsov67a101f2012-07-17 11:37:07 -070035struct rs_control;
Anton Vorontsovcddb8752012-05-17 00:15:08 -070036
Arve Hjønnevågc31ad082012-05-22 16:33:23 -070037struct persistent_ram_ecc_info {
38 int block_size;
39 int ecc_size;
40 int symsize;
41 int poly;
42};
43
Anton Vorontsovcddb8752012-05-17 00:15:08 -070044struct persistent_ram_zone {
45 phys_addr_t paddr;
46 size_t size;
47 void *vaddr;
48 struct persistent_ram_buffer *buffer;
49 size_t buffer_size;
Joel Fernandes469308032016-10-20 00:34:01 -070050 u32 flags;
Joel Fernandesd97aff42016-10-20 00:34:00 -070051 raw_spinlock_t buffer_lock;
Anton Vorontsovcddb8752012-05-17 00:15:08 -070052
53 /* ECC correction */
Anton Vorontsovcddb8752012-05-17 00:15:08 -070054 char *par_buffer;
55 char *par_header;
56 struct rs_control *rs_decoder;
57 int corrected_bytes;
58 int bad_blocks;
Arve Hjønnevågc31ad082012-05-22 16:33:23 -070059 struct persistent_ram_ecc_info ecc_info;
Anton Vorontsovcddb8752012-05-17 00:15:08 -070060
61 char *old_log;
62 size_t old_log_size;
63};
64
Greg Kroah-Hartmanf568f6c2012-12-21 15:02:05 -080065struct persistent_ram_zone *persistent_ram_new(phys_addr_t start, size_t size,
Tony Lindgren027bc8b2014-09-16 13:50:01 -070066 u32 sig, struct persistent_ram_ecc_info *ecc_info,
Joel Fernandes469308032016-10-20 00:34:01 -070067 unsigned int memtype, u32 flags);
Anton Vorontsovcddb8752012-05-17 00:15:08 -070068void persistent_ram_free(struct persistent_ram_zone *prz);
Anton Vorontsovfce39792012-05-26 06:07:51 -070069void persistent_ram_zap(struct persistent_ram_zone *prz);
Anton Vorontsovcddb8752012-05-17 00:15:08 -070070
71int persistent_ram_write(struct persistent_ram_zone *prz, const void *s,
Mark Salyzyn5bf6d1b2016-09-01 08:13:46 -070072 unsigned int count);
73int persistent_ram_write_user(struct persistent_ram_zone *prz,
74 const void __user *s, unsigned int count);
Anton Vorontsovcddb8752012-05-17 00:15:08 -070075
Anton Vorontsov201e4ac2012-05-26 06:07:49 -070076void persistent_ram_save_old(struct persistent_ram_zone *prz);
Anton Vorontsovcddb8752012-05-17 00:15:08 -070077size_t persistent_ram_old_size(struct persistent_ram_zone *prz);
78void *persistent_ram_old(struct persistent_ram_zone *prz);
79void persistent_ram_free_old(struct persistent_ram_zone *prz);
80ssize_t persistent_ram_ecc_string(struct persistent_ram_zone *prz,
81 char *str, size_t len);
82
Arve Hjønnevåg085351f2014-05-02 20:23:21 -070083void ramoops_console_write_buf(const char *buf, size_t size);
84
Kyungmin Parkc3b92ce2010-10-27 15:34:52 -070085/*
86 * Ramoops platform data
87 * @mem_size memory size for ramoops
88 * @mem_address physical memory address to contain ramoops
89 */
90
91struct ramoops_platform_data {
92 unsigned long mem_size;
Wiebe, Wladislav (Nokia - DE/Ulm)764fd6392015-11-13 12:10:05 +000093 phys_addr_t mem_address;
Tony Lindgren027bc8b2014-09-16 13:50:01 -070094 unsigned int mem_type;
Sergiu Iordache3e5c4fa2011-07-26 16:08:59 -070095 unsigned long record_size;
Anton Vorontsovb5d38e92012-05-26 06:20:23 -070096 unsigned long console_size;
Anton Vorontsova694d1b2012-07-09 17:10:44 -070097 unsigned long ftrace_size;
Mark Salyzyn9d5438f2015-01-16 16:01:10 -080098 unsigned long pmsg_size;
Sergiu Iordache6b4d2a22011-07-26 16:08:58 -070099 int dump_oops;
Arve Hjønnevågc31ad082012-05-22 16:33:23 -0700100 struct persistent_ram_ecc_info ecc_info;
Kyungmin Parkc3b92ce2010-10-27 15:34:52 -0700101};
102
103#endif