Merge tag 'powerpc-4.20-2' of git://git.kernel.org/pub/scm/linux/kernel/git/powerpc...
[linux-block.git] / fs / pstore / ram.c
CommitLineData
56d611a0
MS
1/*
2 * RAM Oops/Panic logger
3 *
4 * Copyright (C) 2010 Marco Stornelli <marco.stornelli@gmail.com>
9ba80d99 5 * Copyright (C) 2011 Kees Cook <keescook@chromium.org>
56d611a0
MS
6 *
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
0169256e
MS
23#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
24
56d611a0 25#include <linux/kernel.h>
83c1b317 26#include <linux/err.h>
56d611a0 27#include <linux/module.h>
cbe7cbf5 28#include <linux/version.h>
9ba80d99 29#include <linux/pstore.h>
56d611a0
MS
30#include <linux/io.h>
31#include <linux/ioport.h>
c3b92ce9 32#include <linux/platform_device.h>
13aefd72 33#include <linux/slab.h>
24203036 34#include <linux/compiler.h>
1894a253 35#include <linux/pstore_ram.h>
35da6094
GH
36#include <linux/of.h>
37#include <linux/of_address.h>
56d611a0
MS
38
39#define RAMOOPS_KERNMSG_HDR "===="
3e5c4fad 40#define MIN_MEM_SIZE 4096UL
56d611a0 41
3e5c4fad
SI
42static ulong record_size = MIN_MEM_SIZE;
43module_param(record_size, ulong, 0400);
44MODULE_PARM_DESC(record_size,
45 "size of each dump done on oops/panic");
56d611a0 46
b5d38e9b
AV
47static ulong ramoops_console_size = MIN_MEM_SIZE;
48module_param_named(console_size, ramoops_console_size, ulong, 0400);
49MODULE_PARM_DESC(console_size, "size of kernel console log");
50
a694d1b5
AV
51static ulong ramoops_ftrace_size = MIN_MEM_SIZE;
52module_param_named(ftrace_size, ramoops_ftrace_size, ulong, 0400);
53MODULE_PARM_DESC(ftrace_size, "size of ftrace log");
54
9d5438f4
MS
55static ulong ramoops_pmsg_size = MIN_MEM_SIZE;
56module_param_named(pmsg_size, ramoops_pmsg_size, ulong, 0400);
57MODULE_PARM_DESC(pmsg_size, "size of user space message log");
58
764fd639 59static unsigned long long mem_address;
b90fe0c4 60module_param_hw(mem_address, ullong, other, 0400);
56d611a0
MS
61MODULE_PARM_DESC(mem_address,
62 "start of reserved RAM used to store oops/panic logs");
63
64static ulong mem_size;
65module_param(mem_size, ulong, 0400);
66MODULE_PARM_DESC(mem_size,
67 "size of reserved RAM used to store oops/panic logs");
68
027bc8b0
TL
69static unsigned int mem_type;
70module_param(mem_type, uint, 0600);
71MODULE_PARM_DESC(mem_type,
72 "set to 1 to try to use unbuffered memory (default 0)");
73
56d611a0
MS
74static int dump_oops = 1;
75module_param(dump_oops, int, 0600);
76MODULE_PARM_DESC(dump_oops,
77 "set to 1 to dump oopses, 0 to only dump panics (default 1)");
78
39eb7e97
AV
79static int ramoops_ecc;
80module_param_named(ecc, ramoops_ecc, int, 0600);
81MODULE_PARM_DESC(ramoops_ecc,
5ca5d4e6
AV
82 "if non-zero, the option enables ECC support and specifies "
83 "ECC buffer size in bytes (1 is a special value, means 16 "
84 "bytes ECC)");
39eb7e97 85
9ba80d99 86struct ramoops_context {
a5d23b95
KC
87 struct persistent_ram_zone **dprzs; /* Oops dump zones */
88 struct persistent_ram_zone *cprz; /* Console zone */
89 struct persistent_ram_zone **fprzs; /* Ftrace zones */
90 struct persistent_ram_zone *mprz; /* PMSG zone */
56d611a0
MS
91 phys_addr_t phys_addr;
92 unsigned long size;
027bc8b0 93 unsigned int memtype;
9ba80d99 94 size_t record_size;
b5d38e9b 95 size_t console_size;
a694d1b5 96 size_t ftrace_size;
9d5438f4 97 size_t pmsg_size;
6b4d2a27 98 int dump_oops;
a1cf53ac 99 u32 flags;
c31ad081 100 struct persistent_ram_ecc_info ecc_info;
cac2eb7b
AV
101 unsigned int max_dump_cnt;
102 unsigned int dump_write_cnt;
57fd8353 103 /* _read_cnt need clear on ramoops_pstore_open */
cac2eb7b 104 unsigned int dump_read_cnt;
b5d38e9b 105 unsigned int console_read_cnt;
a1cf53ac 106 unsigned int max_ftrace_cnt;
a694d1b5 107 unsigned int ftrace_read_cnt;
9d5438f4 108 unsigned int pmsg_read_cnt;
9ba80d99
KC
109 struct pstore_info pstore;
110};
56d611a0 111
13aefd72
MS
112static struct platform_device *dummy;
113static struct ramoops_platform_data *dummy_data;
114
9ba80d99
KC
115static int ramoops_pstore_open(struct pstore_info *psi)
116{
117 struct ramoops_context *cxt = psi->data;
118
cac2eb7b 119 cxt->dump_read_cnt = 0;
b5d38e9b 120 cxt->console_read_cnt = 0;
57fd8353 121 cxt->ftrace_read_cnt = 0;
9d5438f4 122 cxt->pmsg_read_cnt = 0;
9ba80d99
KC
123 return 0;
124}
125
755d66b4
AV
126static struct persistent_ram_zone *
127ramoops_get_next_prz(struct persistent_ram_zone *przs[], uint *c, uint max,
128 u64 *id,
129 enum pstore_type_id *typep, enum pstore_type_id type,
130 bool update)
131{
132 struct persistent_ram_zone *prz;
133 int i = (*c)++;
134
46418413
KC
135 /* Give up if we never existed or have hit the end. */
136 if (!przs || i >= max)
755d66b4
AV
137 return NULL;
138
139 prz = przs[i];
b0aa931f
LS
140 if (!prz)
141 return NULL;
755d66b4 142
aa9a4a1e
LS
143 /* Update old/shadowed buffer. */
144 if (update)
755d66b4 145 persistent_ram_save_old(prz);
aa9a4a1e
LS
146
147 if (!persistent_ram_old_size(prz))
148 return NULL;
755d66b4
AV
149
150 *typep = type;
151 *id = i;
152
153 return prz;
154}
155
7aaa822e 156static int ramoops_read_kmsg_hdr(char *buffer, struct timespec64 *time,
3f8f80f0
AB
157 bool *compressed)
158{
159 char data_type;
a28726b4 160 int header_length = 0;
3f8f80f0 161
e264abea
AB
162 if (sscanf(buffer, RAMOOPS_KERNMSG_HDR "%lld.%lu-%c\n%n",
163 (time64_t *)&time->tv_sec, &time->tv_nsec, &data_type,
7aaa822e 164 &header_length) == 3) {
3f8f80f0
AB
165 if (data_type == 'C')
166 *compressed = true;
167 else
168 *compressed = false;
e264abea
AB
169 } else if (sscanf(buffer, RAMOOPS_KERNMSG_HDR "%lld.%lu\n%n",
170 (time64_t *)&time->tv_sec, &time->tv_nsec,
7aaa822e
KC
171 &header_length) == 2) {
172 *compressed = false;
3f8f80f0
AB
173 } else {
174 time->tv_sec = 0;
175 time->tv_nsec = 0;
176 *compressed = false;
177 }
a28726b4 178 return header_length;
3f8f80f0
AB
179}
180
f44f9652
MS
181static bool prz_ok(struct persistent_ram_zone *prz)
182{
183 return !!prz && !!(persistent_ram_old_size(prz) +
184 persistent_ram_ecc_string(prz, NULL, 0));
185}
186
2fbea82b
JF
187static ssize_t ftrace_log_combine(struct persistent_ram_zone *dest,
188 struct persistent_ram_zone *src)
189{
190 size_t dest_size, src_size, total, dest_off, src_off;
191 size_t dest_idx = 0, src_idx = 0, merged_idx = 0;
192 void *merged_buf;
193 struct pstore_ftrace_record *drec, *srec, *mrec;
194 size_t record_size = sizeof(struct pstore_ftrace_record);
195
196 dest_off = dest->old_log_size % record_size;
197 dest_size = dest->old_log_size - dest_off;
198
199 src_off = src->old_log_size % record_size;
200 src_size = src->old_log_size - src_off;
201
202 total = dest_size + src_size;
203 merged_buf = kmalloc(total, GFP_KERNEL);
204 if (!merged_buf)
205 return -ENOMEM;
206
207 drec = (struct pstore_ftrace_record *)(dest->old_log + dest_off);
208 srec = (struct pstore_ftrace_record *)(src->old_log + src_off);
209 mrec = (struct pstore_ftrace_record *)(merged_buf);
210
211 while (dest_size > 0 && src_size > 0) {
212 if (pstore_ftrace_read_timestamp(&drec[dest_idx]) <
213 pstore_ftrace_read_timestamp(&srec[src_idx])) {
214 mrec[merged_idx++] = drec[dest_idx++];
215 dest_size -= record_size;
216 } else {
217 mrec[merged_idx++] = srec[src_idx++];
218 src_size -= record_size;
219 }
220 }
221
222 while (dest_size > 0) {
223 mrec[merged_idx++] = drec[dest_idx++];
224 dest_size -= record_size;
225 }
226
227 while (src_size > 0) {
228 mrec[merged_idx++] = srec[src_idx++];
229 src_size -= record_size;
230 }
231
232 kfree(dest->old_log);
233 dest->old_log = merged_buf;
234 dest->old_log_size = total;
235
236 return 0;
237}
238
125cc42b 239static ssize_t ramoops_pstore_read(struct pstore_record *record)
56d611a0 240{
2fbea82b 241 ssize_t size = 0;
125cc42b 242 struct ramoops_context *cxt = record->psi->data;
e036bd33
BZ
243 struct persistent_ram_zone *prz = NULL;
244 int header_length = 0;
2fbea82b 245 bool free_prz = false;
e036bd33 246
125cc42b
KC
247 /*
248 * Ramoops headers provide time stamps for PSTORE_TYPE_DMESG, but
e036bd33
BZ
249 * PSTORE_TYPE_CONSOLE and PSTORE_TYPE_FTRACE don't currently have
250 * valid time stamps, so it is initialized to zero.
251 */
125cc42b
KC
252 record->time.tv_sec = 0;
253 record->time.tv_nsec = 0;
254 record->compressed = false;
e036bd33
BZ
255
256 /* Find the next valid persistent_ram_zone for DMESG */
257 while (cxt->dump_read_cnt < cxt->max_dump_cnt && !prz) {
a5d23b95 258 prz = ramoops_get_next_prz(cxt->dprzs, &cxt->dump_read_cnt,
125cc42b
KC
259 cxt->max_dump_cnt, &record->id,
260 &record->type,
e036bd33
BZ
261 PSTORE_TYPE_DMESG, 1);
262 if (!prz_ok(prz))
263 continue;
264 header_length = ramoops_read_kmsg_hdr(persistent_ram_old(prz),
125cc42b
KC
265 &record->time,
266 &record->compressed);
e036bd33
BZ
267 /* Clear and skip this DMESG record if it has no valid header */
268 if (!header_length) {
269 persistent_ram_free_old(prz);
270 persistent_ram_zap(prz);
271 prz = NULL;
272 }
273 }
9ba80d99 274
f44f9652 275 if (!prz_ok(prz))
b5d38e9b 276 prz = ramoops_get_next_prz(&cxt->cprz, &cxt->console_read_cnt,
125cc42b
KC
277 1, &record->id, &record->type,
278 PSTORE_TYPE_CONSOLE, 0);
2fbea82b
JF
279
280 if (!prz_ok(prz))
281 prz = ramoops_get_next_prz(&cxt->mprz, &cxt->pmsg_read_cnt,
125cc42b
KC
282 1, &record->id, &record->type,
283 PSTORE_TYPE_PMSG, 0);
2fbea82b
JF
284
285 /* ftrace is last since it may want to dynamically allocate memory. */
46418413 286 if (!prz_ok(prz)) {
2fbea82b 287 if (!(cxt->flags & RAMOOPS_FLAG_FTRACE_PER_CPU)) {
a1cf53ac 288 prz = ramoops_get_next_prz(cxt->fprzs,
125cc42b
KC
289 &cxt->ftrace_read_cnt, 1, &record->id,
290 &record->type, PSTORE_TYPE_FTRACE, 0);
2fbea82b
JF
291 } else {
292 /*
293 * Build a new dummy record which combines all the
294 * per-cpu records including metadata and ecc info.
295 */
296 struct persistent_ram_zone *tmp_prz, *prz_next;
297
298 tmp_prz = kzalloc(sizeof(struct persistent_ram_zone),
299 GFP_KERNEL);
300 if (!tmp_prz)
301 return -ENOMEM;
302 free_prz = true;
303
304 while (cxt->ftrace_read_cnt < cxt->max_ftrace_cnt) {
305 prz_next = ramoops_get_next_prz(cxt->fprzs,
306 &cxt->ftrace_read_cnt,
125cc42b
KC
307 cxt->max_ftrace_cnt,
308 &record->id,
309 &record->type,
310 PSTORE_TYPE_FTRACE, 0);
2fbea82b
JF
311
312 if (!prz_ok(prz_next))
313 continue;
314
315 tmp_prz->ecc_info = prz_next->ecc_info;
316 tmp_prz->corrected_bytes +=
317 prz_next->corrected_bytes;
318 tmp_prz->bad_blocks += prz_next->bad_blocks;
319 size = ftrace_log_combine(tmp_prz, prz_next);
320 if (size)
321 goto out;
322 }
125cc42b 323 record->id = 0;
2fbea82b 324 prz = tmp_prz;
a1cf53ac
JF
325 }
326 }
327
2fbea82b
JF
328 if (!prz_ok(prz)) {
329 size = 0;
330 goto out;
331 }
896fc1f0 332
e036bd33 333 size = persistent_ram_old_size(prz) - header_length;
bd08ec33
AH
334
335 /* ECC correction notice */
125cc42b 336 record->ecc_notice_size = persistent_ram_ecc_string(prz, NULL, 0);
bd08ec33 337
125cc42b
KC
338 record->buf = kmalloc(size + record->ecc_notice_size + 1, GFP_KERNEL);
339 if (record->buf == NULL) {
2fbea82b
JF
340 size = -ENOMEM;
341 goto out;
342 }
9ba80d99 343
125cc42b
KC
344 memcpy(record->buf, (char *)persistent_ram_old(prz) + header_length,
345 size);
2fbea82b 346
125cc42b
KC
347 persistent_ram_ecc_string(prz, record->buf + size,
348 record->ecc_notice_size + 1);
bd08ec33 349
2fbea82b
JF
350out:
351 if (free_prz) {
352 kfree(prz->old_log);
353 kfree(prz);
354 }
355
8cfc8ddc 356 return size;
9ba80d99
KC
357}
358
3f8f80f0 359static size_t ramoops_write_kmsg_hdr(struct persistent_ram_zone *prz,
c7f3c595 360 struct pstore_record *record)
896fc1f0
AV
361{
362 char *hdr;
896fc1f0
AV
363 size_t len;
364
e264abea
AB
365 hdr = kasprintf(GFP_ATOMIC, RAMOOPS_KERNMSG_HDR "%lld.%06lu-%c\n",
366 (time64_t)record->time.tv_sec,
c7f3c595
KC
367 record->time.tv_nsec / 1000,
368 record->compressed ? 'C' : 'D');
896fc1f0
AV
369 WARN_ON_ONCE(!hdr);
370 len = hdr ? strlen(hdr) : 0;
371 persistent_ram_write(prz, hdr, len);
372 kfree(hdr);
373
374 return len;
375}
376
4c9ec219 377static int notrace ramoops_pstore_write(struct pstore_record *record)
9ba80d99 378{
b10b4711 379 struct ramoops_context *cxt = record->psi->data;
c6289378 380 struct persistent_ram_zone *prz;
b10b4711 381 size_t size, hlen;
9ba80d99 382
b10b4711 383 if (record->type == PSTORE_TYPE_CONSOLE) {
b5d38e9b
AV
384 if (!cxt->cprz)
385 return -ENOMEM;
b10b4711 386 persistent_ram_write(cxt->cprz, record->buf, record->size);
b5d38e9b 387 return 0;
b10b4711 388 } else if (record->type == PSTORE_TYPE_FTRACE) {
a1cf53ac
JF
389 int zonenum;
390
391 if (!cxt->fprzs)
a694d1b5 392 return -ENOMEM;
a1cf53ac
JF
393 /*
394 * Choose zone by if we're using per-cpu buffers.
395 */
396 if (cxt->flags & RAMOOPS_FLAG_FTRACE_PER_CPU)
397 zonenum = smp_processor_id();
398 else
399 zonenum = 0;
400
b10b4711
KC
401 persistent_ram_write(cxt->fprzs[zonenum], record->buf,
402 record->size);
a694d1b5 403 return 0;
b10b4711 404 } else if (record->type == PSTORE_TYPE_PMSG) {
d8991f51
JF
405 pr_warn_ratelimited("PMSG shouldn't call %s\n", __func__);
406 return -EINVAL;
b5d38e9b
AV
407 }
408
b10b4711 409 if (record->type != PSTORE_TYPE_DMESG)
9ba80d99 410 return -EINVAL;
56d611a0 411
b10b4711
KC
412 /*
413 * Out of the various dmesg dump types, ramoops is currently designed
9ba80d99
KC
414 * to only store crash logs, rather than storing general kernel logs.
415 */
b10b4711
KC
416 if (record->reason != KMSG_DUMP_OOPS &&
417 record->reason != KMSG_DUMP_PANIC)
9ba80d99 418 return -EINVAL;
fc2d557c 419
9ba80d99 420 /* Skip Oopes when configured to do so. */
b10b4711 421 if (record->reason == KMSG_DUMP_OOPS && !cxt->dump_oops)
9ba80d99
KC
422 return -EINVAL;
423
b10b4711
KC
424 /*
425 * Explicitly only take the first part of any new crash.
9ba80d99
KC
426 * If our buffer is larger than kmsg_bytes, this can never happen,
427 * and if our buffer is smaller than kmsg_bytes, we don't want the
428 * report split across multiple records.
429 */
b10b4711 430 if (record->part != 1)
9ba80d99 431 return -ENOSPC;
56d611a0 432
a5d23b95 433 if (!cxt->dprzs)
c6289378
AH
434 return -ENOSPC;
435
a5d23b95 436 prz = cxt->dprzs[cxt->dump_write_cnt];
c6289378 437
b10b4711 438 /* Build header and append record contents. */
c7f3c595 439 hlen = ramoops_write_kmsg_hdr(prz, record);
b10b4711 440 size = record->size;
896fc1f0
AV
441 if (size + hlen > prz->buffer_size)
442 size = prz->buffer_size - hlen;
b10b4711 443 persistent_ram_write(prz, record->buf, size);
56d611a0 444
cac2eb7b 445 cxt->dump_write_cnt = (cxt->dump_write_cnt + 1) % cxt->max_dump_cnt;
9ba80d99
KC
446
447 return 0;
448}
449
4c9ec219
KC
450static int notrace ramoops_pstore_write_user(struct pstore_record *record,
451 const char __user *buf)
5bf6d1b9 452{
fdd03118
KC
453 if (record->type == PSTORE_TYPE_PMSG) {
454 struct ramoops_context *cxt = record->psi->data;
5bf6d1b9
MS
455
456 if (!cxt->mprz)
457 return -ENOMEM;
fdd03118 458 return persistent_ram_write_user(cxt->mprz, buf, record->size);
5bf6d1b9
MS
459 }
460
461 return -EINVAL;
462}
463
a61072aa 464static int ramoops_pstore_erase(struct pstore_record *record)
9ba80d99 465{
a61072aa 466 struct ramoops_context *cxt = record->psi->data;
b5d38e9b 467 struct persistent_ram_zone *prz;
9ba80d99 468
a61072aa 469 switch (record->type) {
b5d38e9b 470 case PSTORE_TYPE_DMESG:
a61072aa 471 if (record->id >= cxt->max_dump_cnt)
b5d38e9b 472 return -EINVAL;
a61072aa 473 prz = cxt->dprzs[record->id];
b5d38e9b
AV
474 break;
475 case PSTORE_TYPE_CONSOLE:
476 prz = cxt->cprz;
477 break;
a694d1b5 478 case PSTORE_TYPE_FTRACE:
a61072aa 479 if (record->id >= cxt->max_ftrace_cnt)
a1cf53ac 480 return -EINVAL;
a61072aa 481 prz = cxt->fprzs[record->id];
a694d1b5 482 break;
9d5438f4
MS
483 case PSTORE_TYPE_PMSG:
484 prz = cxt->mprz;
485 break;
b5d38e9b 486 default:
9ba80d99 487 return -EINVAL;
b5d38e9b 488 }
9ba80d99 489
b5d38e9b
AV
490 persistent_ram_free_old(prz);
491 persistent_ram_zap(prz);
9ba80d99
KC
492
493 return 0;
56d611a0
MS
494}
495
9ba80d99
KC
496static struct ramoops_context oops_cxt = {
497 .pstore = {
498 .owner = THIS_MODULE,
499 .name = "ramoops",
500 .open = ramoops_pstore_open,
501 .read = ramoops_pstore_read,
4c9ec219
KC
502 .write = ramoops_pstore_write,
503 .write_user = ramoops_pstore_write_user,
9ba80d99
KC
504 .erase = ramoops_pstore_erase,
505 },
506};
507
f4c5d242
AV
508static void ramoops_free_przs(struct ramoops_context *cxt)
509{
510 int i;
511
a1cf53ac 512 /* Free dump PRZs */
a5d23b95 513 if (cxt->dprzs) {
a1cf53ac 514 for (i = 0; i < cxt->max_dump_cnt; i++)
a5d23b95 515 persistent_ram_free(cxt->dprzs[i]);
f4c5d242 516
a5d23b95 517 kfree(cxt->dprzs);
a1cf53ac
JF
518 cxt->max_dump_cnt = 0;
519 }
4407de74 520
a1cf53ac
JF
521 /* Free ftrace PRZs */
522 if (cxt->fprzs) {
523 for (i = 0; i < cxt->max_ftrace_cnt; i++)
524 persistent_ram_free(cxt->fprzs[i]);
525 kfree(cxt->fprzs);
526 cxt->max_ftrace_cnt = 0;
527 }
f4c5d242
AV
528}
529
c443a5f3
KC
530static int ramoops_init_przs(const char *name,
531 struct device *dev, struct ramoops_context *cxt,
de832092
KC
532 struct persistent_ram_zone ***przs,
533 phys_addr_t *paddr, size_t mem_sz,
534 ssize_t record_size,
535 unsigned int *cnt, u32 sig, u32 flags)
f4c5d242
AV
536{
537 int err = -ENOMEM;
538 int i;
de832092
KC
539 size_t zone_sz;
540 struct persistent_ram_zone **prz_ar;
f4c5d242 541
de832092
KC
542 /* Allocate nothing for 0 mem_sz or 0 record_size. */
543 if (mem_sz == 0 || record_size == 0) {
544 *cnt = 0;
f4c5d242 545 return 0;
c6289378
AH
546 }
547
de832092
KC
548 /*
549 * If we have a negative record size, calculate it based on
550 * mem_sz / *cnt. If we have a positive record size, calculate
551 * cnt from mem_sz / record_size.
552 */
553 if (record_size < 0) {
554 if (*cnt == 0)
555 return 0;
556 record_size = mem_sz / *cnt;
c443a5f3
KC
557 if (record_size == 0) {
558 dev_err(dev, "%s record size == 0 (%zu / %u)\n",
559 name, mem_sz, *cnt);
de832092 560 goto fail;
c443a5f3 561 }
de832092
KC
562 } else {
563 *cnt = mem_sz / record_size;
c443a5f3
KC
564 if (*cnt == 0) {
565 dev_err(dev, "%s record count == 0 (%zu / %zu)\n",
566 name, mem_sz, record_size);
de832092 567 goto fail;
c443a5f3 568 }
de832092 569 }
f4c5d242 570
de832092 571 if (*paddr + mem_sz - cxt->phys_addr > cxt->size) {
c443a5f3
KC
572 dev_err(dev, "no room for %s mem region (0x%zx@0x%llx) in (0x%lx@0x%llx)\n",
573 name,
de832092
KC
574 mem_sz, (unsigned long long)*paddr,
575 cxt->size, (unsigned long long)cxt->phys_addr);
576 goto fail;
f4c5d242
AV
577 }
578
de832092 579 zone_sz = mem_sz / *cnt;
c443a5f3
KC
580 if (!zone_sz) {
581 dev_err(dev, "%s zone size == 0\n", name);
de832092 582 goto fail;
c443a5f3 583 }
de832092
KC
584
585 prz_ar = kcalloc(*cnt, sizeof(**przs), GFP_KERNEL);
586 if (!prz_ar)
587 goto fail;
588
589 for (i = 0; i < *cnt; i++) {
1227daa4
KC
590 char *label;
591
592 if (*cnt == 1)
593 label = kasprintf(GFP_KERNEL, "ramoops:%s", name);
594 else
595 label = kasprintf(GFP_KERNEL, "ramoops:%s(%d/%d)",
596 name, i, *cnt - 1);
de832092 597 prz_ar[i] = persistent_ram_new(*paddr, zone_sz, sig,
1227daa4
KC
598 &cxt->ecc_info,
599 cxt->memtype, flags, label);
de832092
KC
600 if (IS_ERR(prz_ar[i])) {
601 err = PTR_ERR(prz_ar[i]);
c443a5f3
KC
602 dev_err(dev, "failed to request %s mem region (0x%zx@0x%llx): %d\n",
603 name, record_size,
604 (unsigned long long)*paddr, err);
4407de74
SAS
605
606 while (i > 0) {
607 i--;
de832092 608 persistent_ram_free(prz_ar[i]);
4407de74 609 }
de832092
KC
610 kfree(prz_ar);
611 goto fail;
f4c5d242 612 }
de832092 613 *paddr += zone_sz;
f4c5d242
AV
614 }
615
de832092 616 *przs = prz_ar;
f4c5d242 617 return 0;
de832092
KC
618
619fail:
620 *cnt = 0;
f4c5d242
AV
621 return err;
622}
623
c443a5f3
KC
624static int ramoops_init_prz(const char *name,
625 struct device *dev, struct ramoops_context *cxt,
f568f6ca
GKH
626 struct persistent_ram_zone **prz,
627 phys_addr_t *paddr, size_t sz, u32 sig)
b5d38e9b 628{
1227daa4
KC
629 char *label;
630
b5d38e9b
AV
631 if (!sz)
632 return 0;
633
c6289378 634 if (*paddr + sz - cxt->phys_addr > cxt->size) {
c443a5f3
KC
635 dev_err(dev, "no room for %s mem region (0x%zx@0x%llx) in (0x%lx@0x%llx)\n",
636 name, sz, (unsigned long long)*paddr,
c6289378 637 cxt->size, (unsigned long long)cxt->phys_addr);
b5d38e9b 638 return -ENOMEM;
c6289378 639 }
b5d38e9b 640
1227daa4 641 label = kasprintf(GFP_KERNEL, "ramoops:%s", name);
663deb47 642 *prz = persistent_ram_new(*paddr, sz, sig, &cxt->ecc_info,
1227daa4 643 cxt->memtype, 0, label);
b5d38e9b
AV
644 if (IS_ERR(*prz)) {
645 int err = PTR_ERR(*prz);
646
c443a5f3
KC
647 dev_err(dev, "failed to request %s mem region (0x%zx@0x%llx): %d\n",
648 name, sz, (unsigned long long)*paddr, err);
b5d38e9b
AV
649 return err;
650 }
651
652 persistent_ram_zap(*prz);
653
654 *paddr += sz;
655
656 return 0;
657}
658
35da6094
GH
659static int ramoops_parse_dt_size(struct platform_device *pdev,
660 const char *propname, u32 *value)
661{
662 u32 val32 = 0;
663 int ret;
664
665 ret = of_property_read_u32(pdev->dev.of_node, propname, &val32);
666 if (ret < 0 && ret != -EINVAL) {
667 dev_err(&pdev->dev, "failed to parse property %s: %d\n",
668 propname, ret);
669 return ret;
670 }
671
672 if (val32 > INT_MAX) {
673 dev_err(&pdev->dev, "%s %u > INT_MAX\n", propname, val32);
674 return -EOVERFLOW;
675 }
676
677 *value = val32;
678 return 0;
679}
680
681static int ramoops_parse_dt(struct platform_device *pdev,
682 struct ramoops_platform_data *pdata)
683{
684 struct device_node *of_node = pdev->dev.of_node;
529182e2 685 struct resource *res;
35da6094
GH
686 u32 value;
687 int ret;
688
689 dev_dbg(&pdev->dev, "using Device Tree\n");
690
529182e2
KC
691 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
692 if (!res) {
35da6094 693 dev_err(&pdev->dev,
529182e2
KC
694 "failed to locate DT /reserved-memory resource\n");
695 return -EINVAL;
35da6094
GH
696 }
697
529182e2
KC
698 pdata->mem_size = resource_size(res);
699 pdata->mem_address = res->start;
35da6094
GH
700 pdata->mem_type = of_property_read_bool(of_node, "unbuffered");
701 pdata->dump_oops = !of_property_read_bool(of_node, "no-dump-oops");
702
703#define parse_size(name, field) { \
704 ret = ramoops_parse_dt_size(pdev, name, &value); \
705 if (ret < 0) \
706 return ret; \
707 field = value; \
708 }
709
710 parse_size("record-size", pdata->record_size);
711 parse_size("console-size", pdata->console_size);
712 parse_size("ftrace-size", pdata->ftrace_size);
713 parse_size("pmsg-size", pdata->pmsg_size);
714 parse_size("ecc-size", pdata->ecc_info.ecc_size);
a1cf53ac 715 parse_size("flags", pdata->flags);
35da6094
GH
716
717#undef parse_size
718
719 return 0;
720}
721
f568f6ca 722static int ramoops_probe(struct platform_device *pdev)
56d611a0 723{
896fc1f0 724 struct device *dev = &pdev->dev;
35da6094 725 struct ramoops_platform_data *pdata = dev->platform_data;
56d611a0 726 struct ramoops_context *cxt = &oops_cxt;
f4c5d242
AV
727 size_t dump_mem_sz;
728 phys_addr_t paddr;
56d611a0
MS
729 int err = -EINVAL;
730
35da6094
GH
731 if (dev_of_node(dev) && !pdata) {
732 pdata = devm_kzalloc(&pdev->dev, sizeof(*pdata), GFP_KERNEL);
733 if (!pdata) {
c443a5f3 734 pr_err("cannot allocate platform data buffer\n");
35da6094
GH
735 err = -ENOMEM;
736 goto fail_out;
737 }
738
739 err = ramoops_parse_dt(pdev, pdata);
740 if (err < 0)
741 goto fail_out;
742 }
743
fc46d4e4
KC
744 /*
745 * Only a single ramoops area allowed at a time, so fail extra
9ba80d99
KC
746 * probes.
747 */
fc46d4e4
KC
748 if (cxt->max_dump_cnt) {
749 pr_err("already initialized\n");
9ba80d99 750 goto fail_out;
fc46d4e4
KC
751 }
752
753 /* Make sure we didn't get bogus platform data pointer. */
754 if (!pdata) {
755 pr_err("NULL platform data\n");
756 goto fail_out;
757 }
9ba80d99 758
a694d1b5 759 if (!pdata->mem_size || (!pdata->record_size && !pdata->console_size &&
9d5438f4 760 !pdata->ftrace_size && !pdata->pmsg_size)) {
b5d38e9b 761 pr_err("The memory size and the record/console size must be "
3e5c4fad 762 "non-zero\n");
9ba80d99 763 goto fail_out;
56d611a0
MS
764 }
765
3bd11cf5 766 if (pdata->record_size && !is_power_of_2(pdata->record_size))
b042e474 767 pdata->record_size = rounddown_pow_of_two(pdata->record_size);
3bd11cf5 768 if (pdata->console_size && !is_power_of_2(pdata->console_size))
b042e474 769 pdata->console_size = rounddown_pow_of_two(pdata->console_size);
3bd11cf5 770 if (pdata->ftrace_size && !is_power_of_2(pdata->ftrace_size))
b042e474 771 pdata->ftrace_size = rounddown_pow_of_two(pdata->ftrace_size);
9d5438f4
MS
772 if (pdata->pmsg_size && !is_power_of_2(pdata->pmsg_size))
773 pdata->pmsg_size = rounddown_pow_of_two(pdata->pmsg_size);
56d611a0 774
13aefd72
MS
775 cxt->size = pdata->mem_size;
776 cxt->phys_addr = pdata->mem_address;
027bc8b0 777 cxt->memtype = pdata->mem_type;
3e5c4fad 778 cxt->record_size = pdata->record_size;
b5d38e9b 779 cxt->console_size = pdata->console_size;
a694d1b5 780 cxt->ftrace_size = pdata->ftrace_size;
9d5438f4 781 cxt->pmsg_size = pdata->pmsg_size;
6b4d2a27 782 cxt->dump_oops = pdata->dump_oops;
a1cf53ac 783 cxt->flags = pdata->flags;
c31ad081 784 cxt->ecc_info = pdata->ecc_info;
56d611a0 785
f4c5d242 786 paddr = cxt->phys_addr;
896fc1f0 787
9d5438f4
MS
788 dump_mem_sz = cxt->size - cxt->console_size - cxt->ftrace_size
789 - cxt->pmsg_size;
a5d23b95 790 err = ramoops_init_przs("dump", dev, cxt, &cxt->dprzs, &paddr,
c443a5f3
KC
791 dump_mem_sz, cxt->record_size,
792 &cxt->max_dump_cnt, 0, 0);
b5d38e9b
AV
793 if (err)
794 goto fail_out;
795
c443a5f3 796 err = ramoops_init_prz("console", dev, cxt, &cxt->cprz, &paddr,
cbe7cbf5 797 cxt->console_size, 0);
b5d38e9b
AV
798 if (err)
799 goto fail_init_cprz;
800
a1cf53ac
JF
801 cxt->max_ftrace_cnt = (cxt->flags & RAMOOPS_FLAG_FTRACE_PER_CPU)
802 ? nr_cpu_ids
803 : 1;
c443a5f3
KC
804 err = ramoops_init_przs("ftrace", dev, cxt, &cxt->fprzs, &paddr,
805 cxt->ftrace_size, -1,
806 &cxt->max_ftrace_cnt, LINUX_VERSION_CODE,
a1cf53ac
JF
807 (cxt->flags & RAMOOPS_FLAG_FTRACE_PER_CPU)
808 ? PRZ_FLAG_NO_LOCK : 0);
a694d1b5
AV
809 if (err)
810 goto fail_init_fprz;
811
c443a5f3
KC
812 err = ramoops_init_prz("pmsg", dev, cxt, &cxt->mprz, &paddr,
813 cxt->pmsg_size, 0);
9d5438f4
MS
814 if (err)
815 goto fail_init_mprz;
816
9ba80d99 817 cxt->pstore.data = cxt;
b5d38e9b 818 /*
a384f641
AV
819 * Console can handle any buffer size, so prefer LOG_LINE_MAX. If we
820 * have to handle dumps, we must have at least record_size buffer. And
821 * for ftrace, bufsize is irrelevant (if bufsize is 0, buf will be
822 * ZERO_SIZE_PTR).
b5d38e9b 823 */
a384f641
AV
824 if (cxt->console_size)
825 cxt->pstore.bufsize = 1024; /* LOG_LINE_MAX */
826 cxt->pstore.bufsize = max(cxt->record_size, cxt->pstore.bufsize);
9ba80d99 827 cxt->pstore.buf = kmalloc(cxt->pstore.bufsize, GFP_KERNEL);
9ba80d99
KC
828 if (!cxt->pstore.buf) {
829 pr_err("cannot allocate pstore buffer\n");
47110b88 830 err = -ENOMEM;
9ba80d99
KC
831 goto fail_clear;
832 }
f88baf68 833 spin_lock_init(&cxt->pstore.buf_lock);
9ba80d99 834
79d955af
NK
835 cxt->pstore.flags = PSTORE_FLAGS_DMESG;
836 if (cxt->console_size)
837 cxt->pstore.flags |= PSTORE_FLAGS_CONSOLE;
838 if (cxt->ftrace_size)
839 cxt->pstore.flags |= PSTORE_FLAGS_FTRACE;
840 if (cxt->pmsg_size)
841 cxt->pstore.flags |= PSTORE_FLAGS_PMSG;
c950fd6f 842
9ba80d99 843 err = pstore_register(&cxt->pstore);
56d611a0 844 if (err) {
9ba80d99 845 pr_err("registering with pstore failed\n");
896fc1f0 846 goto fail_buf;
56d611a0
MS
847 }
848
c755201e
KC
849 /*
850 * Update the module parameter variables as well so they are visible
851 * through /sys/module/ramoops/parameters/
852 */
853 mem_size = pdata->mem_size;
854 mem_address = pdata->mem_address;
855 record_size = pdata->record_size;
856 dump_oops = pdata->dump_oops;
62f269ef
WL
857 ramoops_console_size = pdata->console_size;
858 ramoops_pmsg_size = pdata->pmsg_size;
859 ramoops_ftrace_size = pdata->ftrace_size;
c755201e 860
c31ad081 861 pr_info("attached 0x%lx@0x%llx, ecc: %d/%d\n",
d109a674 862 cxt->size, (unsigned long long)cxt->phys_addr,
c31ad081 863 cxt->ecc_info.ecc_size, cxt->ecc_info.block_size);
9ba80d99 864
56d611a0
MS
865 return 0;
866
9ba80d99
KC
867fail_buf:
868 kfree(cxt->pstore.buf);
869fail_clear:
870 cxt->pstore.bufsize = 0;
e976e564 871 persistent_ram_free(cxt->mprz);
9d5438f4 872fail_init_mprz:
a694d1b5 873fail_init_fprz:
e976e564 874 persistent_ram_free(cxt->cprz);
b5d38e9b 875fail_init_cprz:
f4c5d242 876 ramoops_free_przs(cxt);
9ba80d99 877fail_out:
56d611a0
MS
878 return err;
879}
880
ee1d2674 881static int ramoops_remove(struct platform_device *pdev)
56d611a0
MS
882{
883 struct ramoops_context *cxt = &oops_cxt;
884
ee1d2674 885 pstore_unregister(&cxt->pstore);
9ba80d99 886
9ba80d99
KC
887 kfree(cxt->pstore.buf);
888 cxt->pstore.bufsize = 0;
889
ee1d2674 890 persistent_ram_free(cxt->mprz);
ee1d2674
GT
891 persistent_ram_free(cxt->cprz);
892 ramoops_free_przs(cxt);
893
c3b92ce9 894 return 0;
56d611a0
MS
895}
896
35da6094
GH
897static const struct of_device_id dt_match[] = {
898 { .compatible = "ramoops" },
899 {}
900};
901
c3b92ce9 902static struct platform_driver ramoops_driver = {
924d3711 903 .probe = ramoops_probe,
ee1d2674 904 .remove = ramoops_remove,
c3b92ce9 905 .driver = {
35da6094
GH
906 .name = "ramoops",
907 .of_match_table = dt_match,
c3b92ce9
KP
908 },
909};
910
bac6f6cd 911static inline void ramoops_unregister_dummy(void)
c3b92ce9 912{
bac6f6cd
KC
913 platform_device_unregister(dummy);
914 dummy = NULL;
915
916 kfree(dummy_data);
917 dummy_data = NULL;
918}
919
920static void __init ramoops_register_dummy(void)
921{
922 /*
923 * Prepare a dummy platform data structure to carry the module
924 * parameters. If mem_size isn't set, then there are no module
925 * parameters, and we can skip this.
926 */
924d3711
AV
927 if (!mem_size)
928 return;
929
930 pr_info("using module parameters\n");
931
932 dummy_data = kzalloc(sizeof(*dummy_data), GFP_KERNEL);
933 if (!dummy_data) {
934 pr_info("could not allocate pdata\n");
935 return;
13aefd72
MS
936 }
937
924d3711
AV
938 dummy_data->mem_size = mem_size;
939 dummy_data->mem_address = mem_address;
07855056 940 dummy_data->mem_type = mem_type;
924d3711
AV
941 dummy_data->record_size = record_size;
942 dummy_data->console_size = ramoops_console_size;
a694d1b5 943 dummy_data->ftrace_size = ramoops_ftrace_size;
9d5438f4 944 dummy_data->pmsg_size = ramoops_pmsg_size;
924d3711 945 dummy_data->dump_oops = dump_oops;
a1cf53ac
JF
946 dummy_data->flags = RAMOOPS_FLAG_FTRACE_PER_CPU;
947
5ca5d4e6
AV
948 /*
949 * For backwards compatibility ramoops.ecc=1 means 16 bytes ECC
950 * (using 1 byte for ECC isn't much of use anyway).
951 */
c31ad081 952 dummy_data->ecc_info.ecc_size = ramoops_ecc == 1 ? 16 : ramoops_ecc;
924d3711
AV
953
954 dummy = platform_device_register_data(NULL, "ramoops", -1,
955 dummy_data, sizeof(struct ramoops_platform_data));
956 if (IS_ERR(dummy)) {
957 pr_info("could not create platform device: %ld\n",
958 PTR_ERR(dummy));
bac6f6cd
KC
959 dummy = NULL;
960 ramoops_unregister_dummy();
924d3711
AV
961 }
962}
963
964static int __init ramoops_init(void)
965{
bac6f6cd
KC
966 int ret;
967
924d3711 968 ramoops_register_dummy();
bac6f6cd
KC
969 ret = platform_driver_register(&ramoops_driver);
970 if (ret != 0)
971 ramoops_unregister_dummy();
972
973 return ret;
c3b92ce9 974}
41603165 975postcore_initcall(ramoops_init);
c3b92ce9
KP
976
977static void __exit ramoops_exit(void)
978{
979 platform_driver_unregister(&ramoops_driver);
bac6f6cd 980 ramoops_unregister_dummy();
c3b92ce9 981}
56d611a0
MS
982module_exit(ramoops_exit);
983
984MODULE_LICENSE("GPL");
985MODULE_AUTHOR("Marco Stornelli <marco.stornelli@gmail.com>");
986MODULE_DESCRIPTION("RAM Oops/Panic logger/driver");