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