blob: 7a034d62cf8c87f5812414bc8607613d28adf6ae [file] [log] [blame]
Marco Stornelli56d611a2010-05-26 14:43:54 -07001/*
2 * RAM Oops/Panic logger
3 *
4 * Copyright (C) 2010 Marco Stornelli <marco.stornelli@gmail.com>
Kees Cook9ba80d92012-05-03 15:45:02 +10005 * Copyright (C) 2011 Kees Cook <keescook@chromium.org>
Marco Stornelli56d611a2010-05-26 14:43:54 -07006 *
7 * This program is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU General Public License
9 * version 2 as published by the Free Software Foundation.
10 *
11 * This program is distributed in the hope that it will be useful, but
12 * WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
19 * 02110-1301 USA
20 *
21 */
22
Marco Stornelli01692562011-07-26 16:08:57 -070023#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
24
Marco Stornelli56d611a2010-05-26 14:43:54 -070025#include <linux/kernel.h>
James Bottomley83c1b312011-07-29 17:11:32 +040026#include <linux/err.h>
Marco Stornelli56d611a2010-05-26 14:43:54 -070027#include <linux/module.h>
Anton Vorontsovcbe7cbf2012-07-17 12:11:12 -070028#include <linux/version.h>
Kees Cook9ba80d92012-05-03 15:45:02 +100029#include <linux/pstore.h>
Marco Stornelli56d611a2010-05-26 14:43:54 -070030#include <linux/time.h>
31#include <linux/io.h>
32#include <linux/ioport.h>
Kyungmin Parkc3b92ce2010-10-27 15:34:52 -070033#include <linux/platform_device.h>
Marco Stornelli13aefd72011-07-26 16:08:57 -070034#include <linux/slab.h>
Anton Vorontsov24203032012-07-17 19:49:37 -070035#include <linux/compiler.h>
Anton Vorontsov1894a252012-05-16 05:43:08 -070036#include <linux/pstore_ram.h>
Greg Hackmann35da6092016-01-07 15:40:56 -080037#include <linux/of.h>
38#include <linux/of_address.h>
Marco Stornelli56d611a2010-05-26 14:43:54 -070039
40#define RAMOOPS_KERNMSG_HDR "===="
Sergiu Iordache3e5c4fa2011-07-26 16:08:59 -070041#define MIN_MEM_SIZE 4096UL
Marco Stornelli56d611a2010-05-26 14:43:54 -070042
Sergiu Iordache3e5c4fa2011-07-26 16:08:59 -070043static ulong record_size = MIN_MEM_SIZE;
44module_param(record_size, ulong, 0400);
45MODULE_PARM_DESC(record_size,
46 "size of each dump done on oops/panic");
Marco Stornelli56d611a2010-05-26 14:43:54 -070047
Anton Vorontsovb5d38e92012-05-26 06:20:23 -070048static ulong ramoops_console_size = MIN_MEM_SIZE;
49module_param_named(console_size, ramoops_console_size, ulong, 0400);
50MODULE_PARM_DESC(console_size, "size of kernel console log");
51
Anton Vorontsova694d1b2012-07-09 17:10:44 -070052static ulong ramoops_ftrace_size = MIN_MEM_SIZE;
53module_param_named(ftrace_size, ramoops_ftrace_size, ulong, 0400);
54MODULE_PARM_DESC(ftrace_size, "size of ftrace log");
55
Mark Salyzyn9d5438f2015-01-16 16:01:10 -080056static ulong ramoops_pmsg_size = MIN_MEM_SIZE;
57module_param_named(pmsg_size, ramoops_pmsg_size, ulong, 0400);
58MODULE_PARM_DESC(pmsg_size, "size of user space message log");
59
Wiebe, Wladislav (Nokia - DE/Ulm)764fd6392015-11-13 12:10:05 +000060static unsigned long long mem_address;
61module_param(mem_address, ullong, 0400);
Marco Stornelli56d611a2010-05-26 14:43:54 -070062MODULE_PARM_DESC(mem_address,
63 "start of reserved RAM used to store oops/panic logs");
64
65static ulong mem_size;
66module_param(mem_size, ulong, 0400);
67MODULE_PARM_DESC(mem_size,
68 "size of reserved RAM used to store oops/panic logs");
69
Tony Lindgren027bc8b2014-09-16 13:50:01 -070070static unsigned int mem_type;
71module_param(mem_type, uint, 0600);
72MODULE_PARM_DESC(mem_type,
73 "set to 1 to try to use unbuffered memory (default 0)");
74
Marco Stornelli56d611a2010-05-26 14:43:54 -070075static int dump_oops = 1;
76module_param(dump_oops, int, 0600);
77MODULE_PARM_DESC(dump_oops,
78 "set to 1 to dump oopses, 0 to only dump panics (default 1)");
79
Anton Vorontsov39eb7e972012-05-17 00:15:34 -070080static int ramoops_ecc;
81module_param_named(ecc, ramoops_ecc, int, 0600);
82MODULE_PARM_DESC(ramoops_ecc,
Anton Vorontsov5ca5d4e2012-07-09 17:03:19 -070083 "if non-zero, the option enables ECC support and specifies "
84 "ECC buffer size in bytes (1 is a special value, means 16 "
85 "bytes ECC)");
Anton Vorontsov39eb7e972012-05-17 00:15:34 -070086
Kees Cook9ba80d92012-05-03 15:45:02 +100087struct ramoops_context {
Anton Vorontsov896fc1f2012-05-17 00:15:18 -070088 struct persistent_ram_zone **przs;
Anton Vorontsovb5d38e92012-05-26 06:20:23 -070089 struct persistent_ram_zone *cprz;
Anton Vorontsova694d1b2012-07-09 17:10:44 -070090 struct persistent_ram_zone *fprz;
Mark Salyzyn9d5438f2015-01-16 16:01:10 -080091 struct persistent_ram_zone *mprz;
Marco Stornelli56d611a2010-05-26 14:43:54 -070092 phys_addr_t phys_addr;
93 unsigned long size;
Tony Lindgren027bc8b2014-09-16 13:50:01 -070094 unsigned int memtype;
Kees Cook9ba80d92012-05-03 15:45:02 +100095 size_t record_size;
Anton Vorontsovb5d38e92012-05-26 06:20:23 -070096 size_t console_size;
Anton Vorontsova694d1b2012-07-09 17:10:44 -070097 size_t ftrace_size;
Mark Salyzyn9d5438f2015-01-16 16:01:10 -080098 size_t 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;
Anton Vorontsovcac2eb72012-05-26 06:20:20 -0700101 unsigned int max_dump_cnt;
102 unsigned int dump_write_cnt;
Liu ShuoX57fd8352014-03-17 11:24:49 +1100103 /* _read_cnt need clear on ramoops_pstore_open */
Anton Vorontsovcac2eb72012-05-26 06:20:20 -0700104 unsigned int dump_read_cnt;
Anton Vorontsovb5d38e92012-05-26 06:20:23 -0700105 unsigned int console_read_cnt;
Anton Vorontsova694d1b2012-07-09 17:10:44 -0700106 unsigned int ftrace_read_cnt;
Mark Salyzyn9d5438f2015-01-16 16:01:10 -0800107 unsigned int pmsg_read_cnt;
Kees Cook9ba80d92012-05-03 15:45:02 +1000108 struct pstore_info pstore;
109};
Marco Stornelli56d611a2010-05-26 14:43:54 -0700110
Marco Stornelli13aefd72011-07-26 16:08:57 -0700111static struct platform_device *dummy;
112static struct ramoops_platform_data *dummy_data;
113
Kees Cook9ba80d92012-05-03 15:45:02 +1000114static int ramoops_pstore_open(struct pstore_info *psi)
Marco Stornelli56d611a2010-05-26 14:43:54 -0700115{
Kees Cook9ba80d92012-05-03 15:45:02 +1000116 struct ramoops_context *cxt = psi->data;
Marco Stornelli56d611a2010-05-26 14:43:54 -0700117
Anton Vorontsovcac2eb72012-05-26 06:20:20 -0700118 cxt->dump_read_cnt = 0;
Anton Vorontsovb5d38e92012-05-26 06:20:23 -0700119 cxt->console_read_cnt = 0;
Liu ShuoX57fd8352014-03-17 11:24:49 +1100120 cxt->ftrace_read_cnt = 0;
Mark Salyzyn9d5438f2015-01-16 16:01:10 -0800121 cxt->pmsg_read_cnt = 0;
Kees Cook9ba80d92012-05-03 15:45:02 +1000122 return 0;
123}
124
Anton Vorontsov755d66b2012-05-26 06:20:22 -0700125static struct persistent_ram_zone *
126ramoops_get_next_prz(struct persistent_ram_zone *przs[], uint *c, uint max,
127 u64 *id,
128 enum pstore_type_id *typep, enum pstore_type_id type,
129 bool update)
130{
131 struct persistent_ram_zone *prz;
132 int i = (*c)++;
133
134 if (i >= max)
135 return NULL;
136
137 prz = przs[i];
Liu ShuoXb0aa9312014-03-17 13:57:49 -0700138 if (!prz)
139 return NULL;
Anton Vorontsov755d66b2012-05-26 06:20:22 -0700140
Liu ShuoXaa9a4a12014-03-17 11:24:49 +1100141 /* Update old/shadowed buffer. */
142 if (update)
Anton Vorontsov755d66b2012-05-26 06:20:22 -0700143 persistent_ram_save_old(prz);
Liu ShuoXaa9a4a12014-03-17 11:24:49 +1100144
145 if (!persistent_ram_old_size(prz))
146 return NULL;
Anton Vorontsov755d66b2012-05-26 06:20:22 -0700147
148 *typep = type;
149 *id = i;
150
151 return prz;
152}
153
Ben Zhanga28726b2014-10-30 17:14:21 -0700154static int ramoops_read_kmsg_hdr(char *buffer, struct timespec *time,
Aruna Balakrishnaiah3f8f80f2013-08-16 13:58:00 -0700155 bool *compressed)
156{
157 char data_type;
Ben Zhanga28726b2014-10-30 17:14:21 -0700158 int header_length = 0;
Aruna Balakrishnaiah3f8f80f2013-08-16 13:58:00 -0700159
Ben Zhanga28726b2014-10-30 17:14:21 -0700160 if (sscanf(buffer, RAMOOPS_KERNMSG_HDR "%lu.%lu-%c\n%n", &time->tv_sec,
161 &time->tv_nsec, &data_type, &header_length) == 3) {
Aruna Balakrishnaiah3f8f80f2013-08-16 13:58:00 -0700162 if (data_type == 'C')
163 *compressed = true;
164 else
165 *compressed = false;
Ben Zhanga28726b2014-10-30 17:14:21 -0700166 } else if (sscanf(buffer, RAMOOPS_KERNMSG_HDR "%lu.%lu\n%n",
167 &time->tv_sec, &time->tv_nsec, &header_length) == 2) {
Aruna Balakrishnaiah3f8f80f2013-08-16 13:58:00 -0700168 *compressed = false;
169 } else {
170 time->tv_sec = 0;
171 time->tv_nsec = 0;
172 *compressed = false;
173 }
Ben Zhanga28726b2014-10-30 17:14:21 -0700174 return header_length;
Aruna Balakrishnaiah3f8f80f2013-08-16 13:58:00 -0700175}
176
Mark Salyzynf44f9652015-01-13 14:32:50 -0800177static bool prz_ok(struct persistent_ram_zone *prz)
178{
179 return !!prz && !!(persistent_ram_old_size(prz) +
180 persistent_ram_ecc_string(prz, NULL, 0));
181}
182
Kees Cook9ba80d92012-05-03 15:45:02 +1000183static ssize_t ramoops_pstore_read(u64 *id, enum pstore_type_id *type,
Seiji Aguchi755d4fe2012-11-26 16:07:44 -0800184 int *count, struct timespec *time,
Aruna Balakrishnaiah9a4e1392013-08-16 13:53:19 -0700185 char **buf, bool *compressed,
Geliang Tang8cfc8dd2016-02-18 22:04:22 +0800186 ssize_t *ecc_notice_size,
Aruna Balakrishnaiah9a4e1392013-08-16 13:53:19 -0700187 struct pstore_info *psi)
Kees Cook9ba80d92012-05-03 15:45:02 +1000188{
189 ssize_t size;
Kees Cook9ba80d92012-05-03 15:45:02 +1000190 struct ramoops_context *cxt = psi->data;
Ben Zhange036bd32015-05-21 09:50:34 -0700191 struct persistent_ram_zone *prz = NULL;
192 int header_length = 0;
Kees Cook9ba80d92012-05-03 15:45:02 +1000193
Ben Zhange036bd32015-05-21 09:50:34 -0700194 /* Ramoops headers provide time stamps for PSTORE_TYPE_DMESG, but
195 * PSTORE_TYPE_CONSOLE and PSTORE_TYPE_FTRACE don't currently have
196 * valid time stamps, so it is initialized to zero.
197 */
198 time->tv_sec = 0;
199 time->tv_nsec = 0;
200 *compressed = false;
201
202 /* Find the next valid persistent_ram_zone for DMESG */
203 while (cxt->dump_read_cnt < cxt->max_dump_cnt && !prz) {
204 prz = ramoops_get_next_prz(cxt->przs, &cxt->dump_read_cnt,
205 cxt->max_dump_cnt, id, type,
206 PSTORE_TYPE_DMESG, 1);
207 if (!prz_ok(prz))
208 continue;
209 header_length = ramoops_read_kmsg_hdr(persistent_ram_old(prz),
210 time, compressed);
211 /* Clear and skip this DMESG record if it has no valid header */
212 if (!header_length) {
213 persistent_ram_free_old(prz);
214 persistent_ram_zap(prz);
215 prz = NULL;
216 }
217 }
218
Mark Salyzynf44f9652015-01-13 14:32:50 -0800219 if (!prz_ok(prz))
Anton Vorontsovb5d38e92012-05-26 06:20:23 -0700220 prz = ramoops_get_next_prz(&cxt->cprz, &cxt->console_read_cnt,
221 1, id, type, PSTORE_TYPE_CONSOLE, 0);
Mark Salyzynf44f9652015-01-13 14:32:50 -0800222 if (!prz_ok(prz))
Anton Vorontsova694d1b2012-07-09 17:10:44 -0700223 prz = ramoops_get_next_prz(&cxt->fprz, &cxt->ftrace_read_cnt,
224 1, id, type, PSTORE_TYPE_FTRACE, 0);
Mark Salyzynf44f9652015-01-13 14:32:50 -0800225 if (!prz_ok(prz))
Mark Salyzyn9d5438f2015-01-16 16:01:10 -0800226 prz = ramoops_get_next_prz(&cxt->mprz, &cxt->pmsg_read_cnt,
227 1, id, type, PSTORE_TYPE_PMSG, 0);
228 if (!prz_ok(prz))
Anton Vorontsov755d66b2012-05-26 06:20:22 -0700229 return 0;
Anton Vorontsov896fc1f2012-05-17 00:15:18 -0700230
Ben Zhange036bd32015-05-21 09:50:34 -0700231 size = persistent_ram_old_size(prz) - header_length;
Arve Hjønnevågbd08ec32012-12-05 21:19:51 -0800232
233 /* ECC correction notice */
Geliang Tang8cfc8dd2016-02-18 22:04:22 +0800234 *ecc_notice_size = persistent_ram_ecc_string(prz, NULL, 0);
Arve Hjønnevågbd08ec32012-12-05 21:19:51 -0800235
Geliang Tang8cfc8dd2016-02-18 22:04:22 +0800236 *buf = kmalloc(size + *ecc_notice_size + 1, GFP_KERNEL);
Kees Cook9ba80d92012-05-03 15:45:02 +1000237 if (*buf == NULL)
238 return -ENOMEM;
Kees Cook9ba80d92012-05-03 15:45:02 +1000239
Ben Zhanga28726b2014-10-30 17:14:21 -0700240 memcpy(*buf, (char *)persistent_ram_old(prz) + header_length, size);
Geliang Tang8cfc8dd2016-02-18 22:04:22 +0800241 persistent_ram_ecc_string(prz, *buf + size, *ecc_notice_size + 1);
Arve Hjønnevågbd08ec32012-12-05 21:19:51 -0800242
Geliang Tang8cfc8dd2016-02-18 22:04:22 +0800243 return size;
Kees Cook9ba80d92012-05-03 15:45:02 +1000244}
245
Aruna Balakrishnaiah3f8f80f2013-08-16 13:58:00 -0700246static size_t ramoops_write_kmsg_hdr(struct persistent_ram_zone *prz,
247 bool compressed)
Anton Vorontsov896fc1f2012-05-17 00:15:18 -0700248{
249 char *hdr;
Kees Cook1e817fb2012-11-19 10:26:16 -0800250 struct timespec timestamp;
Anton Vorontsov896fc1f2012-05-17 00:15:18 -0700251 size_t len;
252
Kees Cook1e817fb2012-11-19 10:26:16 -0800253 /* Report zeroed timestamp if called before timekeeping has resumed. */
254 if (__getnstimeofday(&timestamp)) {
255 timestamp.tv_sec = 0;
256 timestamp.tv_nsec = 0;
257 }
Aruna Balakrishnaiah3f8f80f2013-08-16 13:58:00 -0700258 hdr = kasprintf(GFP_ATOMIC, RAMOOPS_KERNMSG_HDR "%lu.%lu-%c\n",
259 (long)timestamp.tv_sec, (long)(timestamp.tv_nsec / 1000),
260 compressed ? 'C' : 'D');
Anton Vorontsov896fc1f2012-05-17 00:15:18 -0700261 WARN_ON_ONCE(!hdr);
262 len = hdr ? strlen(hdr) : 0;
263 persistent_ram_write(prz, hdr, len);
264 kfree(hdr);
265
266 return len;
267}
268
Anton Vorontsov24203032012-07-17 19:49:37 -0700269static int notrace ramoops_pstore_write_buf(enum pstore_type_id type,
270 enum kmsg_dump_reason reason,
271 u64 *id, unsigned int part,
Aruna Balakrishnaiah6bbbca72013-06-27 14:02:56 +0530272 const char *buf,
Aruna Balakrishnaiahb3b515b2013-08-16 13:52:47 -0700273 bool compressed, size_t size,
Anton Vorontsov24203032012-07-17 19:49:37 -0700274 struct pstore_info *psi)
Kees Cook9ba80d92012-05-03 15:45:02 +1000275{
Kees Cook9ba80d92012-05-03 15:45:02 +1000276 struct ramoops_context *cxt = psi->data;
Arve Hjønnevågc6289372012-12-11 17:49:24 -0800277 struct persistent_ram_zone *prz;
Anton Vorontsov896fc1f2012-05-17 00:15:18 -0700278 size_t hlen;
Kees Cook9ba80d92012-05-03 15:45:02 +1000279
Anton Vorontsovb5d38e92012-05-26 06:20:23 -0700280 if (type == PSTORE_TYPE_CONSOLE) {
281 if (!cxt->cprz)
282 return -ENOMEM;
Anton Vorontsovc2b71132012-07-09 17:10:43 -0700283 persistent_ram_write(cxt->cprz, buf, size);
Anton Vorontsovb5d38e92012-05-26 06:20:23 -0700284 return 0;
Anton Vorontsova694d1b2012-07-09 17:10:44 -0700285 } else if (type == PSTORE_TYPE_FTRACE) {
286 if (!cxt->fprz)
287 return -ENOMEM;
288 persistent_ram_write(cxt->fprz, buf, size);
289 return 0;
Mark Salyzyn9d5438f2015-01-16 16:01:10 -0800290 } else if (type == PSTORE_TYPE_PMSG) {
291 if (!cxt->mprz)
292 return -ENOMEM;
293 persistent_ram_write(cxt->mprz, buf, size);
294 return 0;
Anton Vorontsovb5d38e92012-05-26 06:20:23 -0700295 }
296
Kees Cook9ba80d92012-05-03 15:45:02 +1000297 if (type != PSTORE_TYPE_DMESG)
298 return -EINVAL;
299
300 /* Out of the various dmesg dump types, ramoops is currently designed
301 * to only store crash logs, rather than storing general kernel logs.
302 */
Seiji Aguchifc2d5572011-01-12 16:59:29 -0800303 if (reason != KMSG_DUMP_OOPS &&
WANG Conga3dd3322012-01-12 17:20:11 -0800304 reason != KMSG_DUMP_PANIC)
Kees Cook9ba80d92012-05-03 15:45:02 +1000305 return -EINVAL;
Seiji Aguchifc2d5572011-01-12 16:59:29 -0800306
Kees Cook9ba80d92012-05-03 15:45:02 +1000307 /* Skip Oopes when configured to do so. */
Sergiu Iordache6b4d2a22011-07-26 16:08:58 -0700308 if (reason == KMSG_DUMP_OOPS && !cxt->dump_oops)
Kees Cook9ba80d92012-05-03 15:45:02 +1000309 return -EINVAL;
310
311 /* Explicitly only take the first part of any new crash.
312 * If our buffer is larger than kmsg_bytes, this can never happen,
313 * and if our buffer is smaller than kmsg_bytes, we don't want the
314 * report split across multiple records.
315 */
316 if (part != 1)
317 return -ENOSPC;
Marco Stornelli56d611a2010-05-26 14:43:54 -0700318
Arve Hjønnevågc6289372012-12-11 17:49:24 -0800319 if (!cxt->przs)
320 return -ENOSPC;
321
322 prz = cxt->przs[cxt->dump_write_cnt];
323
Aruna Balakrishnaiah3f8f80f2013-08-16 13:58:00 -0700324 hlen = ramoops_write_kmsg_hdr(prz, compressed);
Anton Vorontsov896fc1f2012-05-17 00:15:18 -0700325 if (size + hlen > prz->buffer_size)
326 size = prz->buffer_size - hlen;
Anton Vorontsovc2b71132012-07-09 17:10:43 -0700327 persistent_ram_write(prz, buf, size);
Marco Stornelli56d611a2010-05-26 14:43:54 -0700328
Anton Vorontsovcac2eb72012-05-26 06:20:20 -0700329 cxt->dump_write_cnt = (cxt->dump_write_cnt + 1) % cxt->max_dump_cnt;
Kees Cook9ba80d92012-05-03 15:45:02 +1000330
331 return 0;
Marco Stornelli56d611a2010-05-26 14:43:54 -0700332}
333
Seiji Aguchi755d4fe2012-11-26 16:07:44 -0800334static int ramoops_pstore_erase(enum pstore_type_id type, u64 id, int count,
Seiji Aguchia9efd392012-11-14 20:27:28 +0000335 struct timespec time, struct pstore_info *psi)
Kees Cook9ba80d92012-05-03 15:45:02 +1000336{
Kees Cook9ba80d92012-05-03 15:45:02 +1000337 struct ramoops_context *cxt = psi->data;
Anton Vorontsovb5d38e92012-05-26 06:20:23 -0700338 struct persistent_ram_zone *prz;
Kees Cook9ba80d92012-05-03 15:45:02 +1000339
Anton Vorontsovb5d38e92012-05-26 06:20:23 -0700340 switch (type) {
341 case PSTORE_TYPE_DMESG:
342 if (id >= cxt->max_dump_cnt)
343 return -EINVAL;
344 prz = cxt->przs[id];
345 break;
346 case PSTORE_TYPE_CONSOLE:
347 prz = cxt->cprz;
348 break;
Anton Vorontsova694d1b2012-07-09 17:10:44 -0700349 case PSTORE_TYPE_FTRACE:
350 prz = cxt->fprz;
351 break;
Mark Salyzyn9d5438f2015-01-16 16:01:10 -0800352 case PSTORE_TYPE_PMSG:
353 prz = cxt->mprz;
354 break;
Anton Vorontsovb5d38e92012-05-26 06:20:23 -0700355 default:
Kees Cook9ba80d92012-05-03 15:45:02 +1000356 return -EINVAL;
Anton Vorontsovb5d38e92012-05-26 06:20:23 -0700357 }
Kees Cook9ba80d92012-05-03 15:45:02 +1000358
Anton Vorontsovb5d38e92012-05-26 06:20:23 -0700359 persistent_ram_free_old(prz);
360 persistent_ram_zap(prz);
Kees Cook9ba80d92012-05-03 15:45:02 +1000361
362 return 0;
363}
364
365static struct ramoops_context oops_cxt = {
366 .pstore = {
367 .owner = THIS_MODULE,
368 .name = "ramoops",
369 .open = ramoops_pstore_open,
370 .read = ramoops_pstore_read,
Anton Vorontsovc2b71132012-07-09 17:10:43 -0700371 .write_buf = ramoops_pstore_write_buf,
Kees Cook9ba80d92012-05-03 15:45:02 +1000372 .erase = ramoops_pstore_erase,
373 },
374};
375
Anton Vorontsovf4c5d242012-05-26 06:20:21 -0700376static void ramoops_free_przs(struct ramoops_context *cxt)
377{
378 int i;
379
Liu ShuoX34f0ec82014-03-17 14:07:00 -0700380 cxt->max_dump_cnt = 0;
Anton Vorontsovf4c5d242012-05-26 06:20:21 -0700381 if (!cxt->przs)
382 return;
383
Anton Vorontsov90b58d92012-06-18 19:15:51 -0700384 for (i = 0; !IS_ERR_OR_NULL(cxt->przs[i]); i++)
Anton Vorontsovf4c5d242012-05-26 06:20:21 -0700385 persistent_ram_free(cxt->przs[i]);
386 kfree(cxt->przs);
387}
388
Greg Kroah-Hartmanf568f6c2012-12-21 15:02:05 -0800389static int ramoops_init_przs(struct device *dev, struct ramoops_context *cxt,
390 phys_addr_t *paddr, size_t dump_mem_sz)
Anton Vorontsovf4c5d242012-05-26 06:20:21 -0700391{
392 int err = -ENOMEM;
393 int i;
394
395 if (!cxt->record_size)
396 return 0;
397
Arve Hjønnevågc6289372012-12-11 17:49:24 -0800398 if (*paddr + dump_mem_sz - cxt->phys_addr > cxt->size) {
399 dev_err(dev, "no room for dumps\n");
400 return -ENOMEM;
401 }
402
Anton Vorontsovf4c5d242012-05-26 06:20:21 -0700403 cxt->max_dump_cnt = dump_mem_sz / cxt->record_size;
404 if (!cxt->max_dump_cnt)
405 return -ENOMEM;
406
407 cxt->przs = kzalloc(sizeof(*cxt->przs) * cxt->max_dump_cnt,
408 GFP_KERNEL);
409 if (!cxt->przs) {
410 dev_err(dev, "failed to initialize a prz array for dumps\n");
Liu ShuoX34f0ec82014-03-17 14:07:00 -0700411 goto fail_prz;
Anton Vorontsovf4c5d242012-05-26 06:20:21 -0700412 }
413
414 for (i = 0; i < cxt->max_dump_cnt; i++) {
long.wanglong07239fc2015-05-21 09:47:22 -0700415 cxt->przs[i] = persistent_ram_new(*paddr, cxt->record_size, 0,
Tony Lindgren027bc8b2014-09-16 13:50:01 -0700416 &cxt->ecc_info,
417 cxt->memtype);
Anton Vorontsovf4c5d242012-05-26 06:20:21 -0700418 if (IS_ERR(cxt->przs[i])) {
419 err = PTR_ERR(cxt->przs[i]);
420 dev_err(dev, "failed to request mem region (0x%zx@0x%llx): %d\n",
long.wanglong07239fc2015-05-21 09:47:22 -0700421 cxt->record_size, (unsigned long long)*paddr, err);
Anton Vorontsovf4c5d242012-05-26 06:20:21 -0700422 goto fail_prz;
423 }
long.wanglong07239fc2015-05-21 09:47:22 -0700424 *paddr += cxt->record_size;
Anton Vorontsovf4c5d242012-05-26 06:20:21 -0700425 }
426
427 return 0;
428fail_prz:
429 ramoops_free_przs(cxt);
430 return err;
431}
432
Greg Kroah-Hartmanf568f6c2012-12-21 15:02:05 -0800433static int ramoops_init_prz(struct device *dev, struct ramoops_context *cxt,
434 struct persistent_ram_zone **prz,
435 phys_addr_t *paddr, size_t sz, u32 sig)
Anton Vorontsovb5d38e92012-05-26 06:20:23 -0700436{
437 if (!sz)
438 return 0;
439
Arve Hjønnevågc6289372012-12-11 17:49:24 -0800440 if (*paddr + sz - cxt->phys_addr > cxt->size) {
441 dev_err(dev, "no room for mem region (0x%zx@0x%llx) in (0x%lx@0x%llx)\n",
442 sz, (unsigned long long)*paddr,
443 cxt->size, (unsigned long long)cxt->phys_addr);
Anton Vorontsovb5d38e92012-05-26 06:20:23 -0700444 return -ENOMEM;
Arve Hjønnevågc6289372012-12-11 17:49:24 -0800445 }
Anton Vorontsovb5d38e92012-05-26 06:20:23 -0700446
Tony Lindgren027bc8b2014-09-16 13:50:01 -0700447 *prz = persistent_ram_new(*paddr, sz, sig, &cxt->ecc_info, cxt->memtype);
Anton Vorontsovb5d38e92012-05-26 06:20:23 -0700448 if (IS_ERR(*prz)) {
449 int err = PTR_ERR(*prz);
450
451 dev_err(dev, "failed to request mem region (0x%zx@0x%llx): %d\n",
452 sz, (unsigned long long)*paddr, err);
453 return err;
454 }
455
456 persistent_ram_zap(*prz);
457
458 *paddr += sz;
459
460 return 0;
461}
462
Greg Hackmann35da6092016-01-07 15:40:56 -0800463static int ramoops_parse_dt_size(struct platform_device *pdev,
464 const char *propname, u32 *value)
465{
466 u32 val32 = 0;
467 int ret;
468
469 ret = of_property_read_u32(pdev->dev.of_node, propname, &val32);
470 if (ret < 0 && ret != -EINVAL) {
471 dev_err(&pdev->dev, "failed to parse property %s: %d\n",
472 propname, ret);
473 return ret;
474 }
475
476 if (val32 > INT_MAX) {
477 dev_err(&pdev->dev, "%s %u > INT_MAX\n", propname, val32);
478 return -EOVERFLOW;
479 }
480
481 *value = val32;
482 return 0;
483}
484
485static int ramoops_parse_dt(struct platform_device *pdev,
486 struct ramoops_platform_data *pdata)
487{
488 struct device_node *of_node = pdev->dev.of_node;
Kees Cook529182e2016-07-29 18:11:32 -0700489 struct resource *res;
Greg Hackmann35da6092016-01-07 15:40:56 -0800490 u32 value;
491 int ret;
492
493 dev_dbg(&pdev->dev, "using Device Tree\n");
494
Kees Cook529182e2016-07-29 18:11:32 -0700495 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
496 if (!res) {
Greg Hackmann35da6092016-01-07 15:40:56 -0800497 dev_err(&pdev->dev,
Kees Cook529182e2016-07-29 18:11:32 -0700498 "failed to locate DT /reserved-memory resource\n");
499 return -EINVAL;
Greg Hackmann35da6092016-01-07 15:40:56 -0800500 }
501
Kees Cook529182e2016-07-29 18:11:32 -0700502 pdata->mem_size = resource_size(res);
503 pdata->mem_address = res->start;
Greg Hackmann35da6092016-01-07 15:40:56 -0800504 pdata->mem_type = of_property_read_bool(of_node, "unbuffered");
505 pdata->dump_oops = !of_property_read_bool(of_node, "no-dump-oops");
506
507#define parse_size(name, field) { \
508 ret = ramoops_parse_dt_size(pdev, name, &value); \
509 if (ret < 0) \
510 return ret; \
511 field = value; \
512 }
513
514 parse_size("record-size", pdata->record_size);
515 parse_size("console-size", pdata->console_size);
516 parse_size("ftrace-size", pdata->ftrace_size);
517 parse_size("pmsg-size", pdata->pmsg_size);
518 parse_size("ecc-size", pdata->ecc_info.ecc_size);
519
520#undef parse_size
521
522 return 0;
523}
524
Greg Kroah-Hartmanf568f6c2012-12-21 15:02:05 -0800525static int ramoops_probe(struct platform_device *pdev)
Marco Stornelli56d611a2010-05-26 14:43:54 -0700526{
Anton Vorontsov896fc1f2012-05-17 00:15:18 -0700527 struct device *dev = &pdev->dev;
Greg Hackmann35da6092016-01-07 15:40:56 -0800528 struct ramoops_platform_data *pdata = dev->platform_data;
Marco Stornelli56d611a2010-05-26 14:43:54 -0700529 struct ramoops_context *cxt = &oops_cxt;
Anton Vorontsovf4c5d242012-05-26 06:20:21 -0700530 size_t dump_mem_sz;
531 phys_addr_t paddr;
Marco Stornelli56d611a2010-05-26 14:43:54 -0700532 int err = -EINVAL;
533
Greg Hackmann35da6092016-01-07 15:40:56 -0800534 if (dev_of_node(dev) && !pdata) {
535 pdata = devm_kzalloc(&pdev->dev, sizeof(*pdata), GFP_KERNEL);
536 if (!pdata) {
537 err = -ENOMEM;
538 goto fail_out;
539 }
540
541 err = ramoops_parse_dt(pdev, pdata);
542 if (err < 0)
543 goto fail_out;
544 }
545
Kees Cook9ba80d92012-05-03 15:45:02 +1000546 /* Only a single ramoops area allowed at a time, so fail extra
547 * probes.
548 */
Anton Vorontsovcac2eb72012-05-26 06:20:20 -0700549 if (cxt->max_dump_cnt)
Kees Cook9ba80d92012-05-03 15:45:02 +1000550 goto fail_out;
551
Anton Vorontsova694d1b2012-07-09 17:10:44 -0700552 if (!pdata->mem_size || (!pdata->record_size && !pdata->console_size &&
Mark Salyzyn9d5438f2015-01-16 16:01:10 -0800553 !pdata->ftrace_size && !pdata->pmsg_size)) {
Anton Vorontsovb5d38e92012-05-26 06:20:23 -0700554 pr_err("The memory size and the record/console size must be "
Sergiu Iordache3e5c4fa2011-07-26 16:08:59 -0700555 "non-zero\n");
Kees Cook9ba80d92012-05-03 15:45:02 +1000556 goto fail_out;
Marco Stornelli56d611a2010-05-26 14:43:54 -0700557 }
558
Maxime Bizon3bd11cf2013-08-30 18:06:41 +0200559 if (pdata->record_size && !is_power_of_2(pdata->record_size))
Maxime Bizonb042e472012-10-22 11:19:28 +0200560 pdata->record_size = rounddown_pow_of_two(pdata->record_size);
Maxime Bizon3bd11cf2013-08-30 18:06:41 +0200561 if (pdata->console_size && !is_power_of_2(pdata->console_size))
Maxime Bizonb042e472012-10-22 11:19:28 +0200562 pdata->console_size = rounddown_pow_of_two(pdata->console_size);
Maxime Bizon3bd11cf2013-08-30 18:06:41 +0200563 if (pdata->ftrace_size && !is_power_of_2(pdata->ftrace_size))
Maxime Bizonb042e472012-10-22 11:19:28 +0200564 pdata->ftrace_size = rounddown_pow_of_two(pdata->ftrace_size);
Mark Salyzyn9d5438f2015-01-16 16:01:10 -0800565 if (pdata->pmsg_size && !is_power_of_2(pdata->pmsg_size))
566 pdata->pmsg_size = rounddown_pow_of_two(pdata->pmsg_size);
Marco Stornelli56d611a2010-05-26 14:43:54 -0700567
Marco Stornelli13aefd72011-07-26 16:08:57 -0700568 cxt->size = pdata->mem_size;
569 cxt->phys_addr = pdata->mem_address;
Tony Lindgren027bc8b2014-09-16 13:50:01 -0700570 cxt->memtype = pdata->mem_type;
Sergiu Iordache3e5c4fa2011-07-26 16:08:59 -0700571 cxt->record_size = pdata->record_size;
Anton Vorontsovb5d38e92012-05-26 06:20:23 -0700572 cxt->console_size = pdata->console_size;
Anton Vorontsova694d1b2012-07-09 17:10:44 -0700573 cxt->ftrace_size = pdata->ftrace_size;
Mark Salyzyn9d5438f2015-01-16 16:01:10 -0800574 cxt->pmsg_size = pdata->pmsg_size;
Sergiu Iordache6b4d2a22011-07-26 16:08:58 -0700575 cxt->dump_oops = pdata->dump_oops;
Arve Hjønnevågc31ad082012-05-22 16:33:23 -0700576 cxt->ecc_info = pdata->ecc_info;
Marco Stornelli56d611a2010-05-26 14:43:54 -0700577
Anton Vorontsovf4c5d242012-05-26 06:20:21 -0700578 paddr = cxt->phys_addr;
Anton Vorontsov896fc1f2012-05-17 00:15:18 -0700579
Mark Salyzyn9d5438f2015-01-16 16:01:10 -0800580 dump_mem_sz = cxt->size - cxt->console_size - cxt->ftrace_size
581 - cxt->pmsg_size;
Anton Vorontsovf4c5d242012-05-26 06:20:21 -0700582 err = ramoops_init_przs(dev, cxt, &paddr, dump_mem_sz);
Anton Vorontsovb5d38e92012-05-26 06:20:23 -0700583 if (err)
584 goto fail_out;
585
Anton Vorontsovcbe7cbf2012-07-17 12:11:12 -0700586 err = ramoops_init_prz(dev, cxt, &cxt->cprz, &paddr,
587 cxt->console_size, 0);
Anton Vorontsovb5d38e92012-05-26 06:20:23 -0700588 if (err)
589 goto fail_init_cprz;
590
Anton Vorontsovcbe7cbf2012-07-17 12:11:12 -0700591 err = ramoops_init_prz(dev, cxt, &cxt->fprz, &paddr, cxt->ftrace_size,
592 LINUX_VERSION_CODE);
Anton Vorontsova694d1b2012-07-09 17:10:44 -0700593 if (err)
594 goto fail_init_fprz;
595
Mark Salyzyn9d5438f2015-01-16 16:01:10 -0800596 err = ramoops_init_prz(dev, cxt, &cxt->mprz, &paddr, cxt->pmsg_size, 0);
597 if (err)
598 goto fail_init_mprz;
599
Kees Cook9ba80d92012-05-03 15:45:02 +1000600 cxt->pstore.data = cxt;
Anton Vorontsovb5d38e92012-05-26 06:20:23 -0700601 /*
Anton Vorontsova384f6412012-07-19 15:47:11 -0700602 * Console can handle any buffer size, so prefer LOG_LINE_MAX. If we
603 * have to handle dumps, we must have at least record_size buffer. And
604 * for ftrace, bufsize is irrelevant (if bufsize is 0, buf will be
605 * ZERO_SIZE_PTR).
Anton Vorontsovb5d38e92012-05-26 06:20:23 -0700606 */
Anton Vorontsova384f6412012-07-19 15:47:11 -0700607 if (cxt->console_size)
608 cxt->pstore.bufsize = 1024; /* LOG_LINE_MAX */
609 cxt->pstore.bufsize = max(cxt->record_size, cxt->pstore.bufsize);
Kees Cook9ba80d92012-05-03 15:45:02 +1000610 cxt->pstore.buf = kmalloc(cxt->pstore.bufsize, GFP_KERNEL);
611 spin_lock_init(&cxt->pstore.buf_lock);
612 if (!cxt->pstore.buf) {
613 pr_err("cannot allocate pstore buffer\n");
Wei Yongjun47110b82013-05-07 19:39:20 +0800614 err = -ENOMEM;
Kees Cook9ba80d92012-05-03 15:45:02 +1000615 goto fail_clear;
616 }
617
Kees Cook9ba80d92012-05-03 15:45:02 +1000618 err = pstore_register(&cxt->pstore);
Marco Stornelli56d611a2010-05-26 14:43:54 -0700619 if (err) {
Kees Cook9ba80d92012-05-03 15:45:02 +1000620 pr_err("registering with pstore failed\n");
Anton Vorontsov896fc1f2012-05-17 00:15:18 -0700621 goto fail_buf;
Marco Stornelli56d611a2010-05-26 14:43:54 -0700622 }
623
Kees Cookc7552012012-01-12 17:20:59 -0800624 /*
625 * Update the module parameter variables as well so they are visible
626 * through /sys/module/ramoops/parameters/
627 */
628 mem_size = pdata->mem_size;
629 mem_address = pdata->mem_address;
630 record_size = pdata->record_size;
631 dump_oops = pdata->dump_oops;
Wang Long62f269e2015-03-09 07:39:07 +0000632 ramoops_console_size = pdata->console_size;
633 ramoops_pmsg_size = pdata->pmsg_size;
634 ramoops_ftrace_size = pdata->ftrace_size;
Kees Cookc7552012012-01-12 17:20:59 -0800635
Arve Hjønnevågc31ad082012-05-22 16:33:23 -0700636 pr_info("attached 0x%lx@0x%llx, ecc: %d/%d\n",
Randy Dunlapd109a672012-05-03 15:45:03 +1000637 cxt->size, (unsigned long long)cxt->phys_addr,
Arve Hjønnevågc31ad082012-05-22 16:33:23 -0700638 cxt->ecc_info.ecc_size, cxt->ecc_info.block_size);
Kees Cook9ba80d92012-05-03 15:45:02 +1000639
Marco Stornelli56d611a2010-05-26 14:43:54 -0700640 return 0;
641
Kees Cook9ba80d92012-05-03 15:45:02 +1000642fail_buf:
643 kfree(cxt->pstore.buf);
644fail_clear:
645 cxt->pstore.bufsize = 0;
Hiraku Toyookae976e562016-07-25 12:56:55 +0900646 persistent_ram_free(cxt->mprz);
Mark Salyzyn9d5438f2015-01-16 16:01:10 -0800647fail_init_mprz:
Hiraku Toyookae976e562016-07-25 12:56:55 +0900648 persistent_ram_free(cxt->fprz);
Anton Vorontsova694d1b2012-07-09 17:10:44 -0700649fail_init_fprz:
Hiraku Toyookae976e562016-07-25 12:56:55 +0900650 persistent_ram_free(cxt->cprz);
Anton Vorontsovb5d38e92012-05-26 06:20:23 -0700651fail_init_cprz:
Anton Vorontsovf4c5d242012-05-26 06:20:21 -0700652 ramoops_free_przs(cxt);
Kees Cook9ba80d92012-05-03 15:45:02 +1000653fail_out:
Marco Stornelli56d611a2010-05-26 14:43:54 -0700654 return err;
655}
656
Geliang Tangee1d2672015-10-20 00:39:03 -0700657static int ramoops_remove(struct platform_device *pdev)
Marco Stornelli56d611a2010-05-26 14:43:54 -0700658{
659 struct ramoops_context *cxt = &oops_cxt;
660
Geliang Tangee1d2672015-10-20 00:39:03 -0700661 pstore_unregister(&cxt->pstore);
Anton Vorontsovcac2eb72012-05-26 06:20:20 -0700662 cxt->max_dump_cnt = 0;
Kees Cook9ba80d92012-05-03 15:45:02 +1000663
Kees Cook9ba80d92012-05-03 15:45:02 +1000664 kfree(cxt->pstore.buf);
665 cxt->pstore.bufsize = 0;
666
Geliang Tangee1d2672015-10-20 00:39:03 -0700667 persistent_ram_free(cxt->mprz);
668 persistent_ram_free(cxt->fprz);
669 persistent_ram_free(cxt->cprz);
670 ramoops_free_przs(cxt);
671
Kyungmin Parkc3b92ce2010-10-27 15:34:52 -0700672 return 0;
Marco Stornelli56d611a2010-05-26 14:43:54 -0700673}
674
Greg Hackmann35da6092016-01-07 15:40:56 -0800675static const struct of_device_id dt_match[] = {
676 { .compatible = "ramoops" },
677 {}
678};
679
Kyungmin Parkc3b92ce2010-10-27 15:34:52 -0700680static struct platform_driver ramoops_driver = {
Anton Vorontsov924d3712012-06-18 19:15:50 -0700681 .probe = ramoops_probe,
Geliang Tangee1d2672015-10-20 00:39:03 -0700682 .remove = ramoops_remove,
Kyungmin Parkc3b92ce2010-10-27 15:34:52 -0700683 .driver = {
Greg Hackmann35da6092016-01-07 15:40:56 -0800684 .name = "ramoops",
685 .of_match_table = dt_match,
Kyungmin Parkc3b92ce2010-10-27 15:34:52 -0700686 },
687};
688
Anton Vorontsov924d3712012-06-18 19:15:50 -0700689static void ramoops_register_dummy(void)
Kyungmin Parkc3b92ce2010-10-27 15:34:52 -0700690{
Anton Vorontsov924d3712012-06-18 19:15:50 -0700691 if (!mem_size)
692 return;
Marco Stornelli13aefd72011-07-26 16:08:57 -0700693
Anton Vorontsov924d3712012-06-18 19:15:50 -0700694 pr_info("using module parameters\n");
695
696 dummy_data = kzalloc(sizeof(*dummy_data), GFP_KERNEL);
697 if (!dummy_data) {
698 pr_info("could not allocate pdata\n");
699 return;
Marco Stornelli13aefd72011-07-26 16:08:57 -0700700 }
701
Anton Vorontsov924d3712012-06-18 19:15:50 -0700702 dummy_data->mem_size = mem_size;
703 dummy_data->mem_address = mem_address;
Wang Long07855052015-05-21 09:52:29 -0700704 dummy_data->mem_type = mem_type;
Anton Vorontsov924d3712012-06-18 19:15:50 -0700705 dummy_data->record_size = record_size;
706 dummy_data->console_size = ramoops_console_size;
Anton Vorontsova694d1b2012-07-09 17:10:44 -0700707 dummy_data->ftrace_size = ramoops_ftrace_size;
Mark Salyzyn9d5438f2015-01-16 16:01:10 -0800708 dummy_data->pmsg_size = ramoops_pmsg_size;
Anton Vorontsov924d3712012-06-18 19:15:50 -0700709 dummy_data->dump_oops = dump_oops;
Anton Vorontsov5ca5d4e2012-07-09 17:03:19 -0700710 /*
711 * For backwards compatibility ramoops.ecc=1 means 16 bytes ECC
712 * (using 1 byte for ECC isn't much of use anyway).
713 */
Arve Hjønnevågc31ad082012-05-22 16:33:23 -0700714 dummy_data->ecc_info.ecc_size = ramoops_ecc == 1 ? 16 : ramoops_ecc;
Anton Vorontsov924d3712012-06-18 19:15:50 -0700715
716 dummy = platform_device_register_data(NULL, "ramoops", -1,
717 dummy_data, sizeof(struct ramoops_platform_data));
718 if (IS_ERR(dummy)) {
719 pr_info("could not create platform device: %ld\n",
720 PTR_ERR(dummy));
721 }
Kyungmin Parkc3b92ce2010-10-27 15:34:52 -0700722}
723
Anton Vorontsov924d3712012-06-18 19:15:50 -0700724static int __init ramoops_init(void)
725{
726 ramoops_register_dummy();
727 return platform_driver_register(&ramoops_driver);
728}
729postcore_initcall(ramoops_init);
730
Kyungmin Parkc3b92ce2010-10-27 15:34:52 -0700731static void __exit ramoops_exit(void)
732{
733 platform_driver_unregister(&ramoops_driver);
Jovi Zhangb4a871b2012-08-20 14:58:26 +0800734 platform_device_unregister(dummy);
Marco Stornelli13aefd72011-07-26 16:08:57 -0700735 kfree(dummy_data);
Kyungmin Parkc3b92ce2010-10-27 15:34:52 -0700736}
Marco Stornelli56d611a2010-05-26 14:43:54 -0700737module_exit(ramoops_exit);
738
739MODULE_LICENSE("GPL");
740MODULE_AUTHOR("Marco Stornelli <marco.stornelli@gmail.com>");
741MODULE_DESCRIPTION("RAM Oops/Panic logger/driver");