ACPI: button: Add DMI quirk for Acer Switch 10 SW5-032 lid-switch
[linux/fpc-iii.git] / fs / pstore / ram.c
blob8caff834f002668eb79d84d2adf8c108dbc2c640
1 // SPDX-License-Identifier: GPL-2.0-only
2 /*
3 * RAM Oops/Panic logger
5 * Copyright (C) 2010 Marco Stornelli <marco.stornelli@gmail.com>
6 * Copyright (C) 2011 Kees Cook <keescook@chromium.org>
7 */
9 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
11 #include <linux/kernel.h>
12 #include <linux/err.h>
13 #include <linux/module.h>
14 #include <linux/version.h>
15 #include <linux/pstore.h>
16 #include <linux/io.h>
17 #include <linux/ioport.h>
18 #include <linux/platform_device.h>
19 #include <linux/slab.h>
20 #include <linux/compiler.h>
21 #include <linux/pstore_ram.h>
22 #include <linux/of.h>
23 #include <linux/of_address.h>
25 #define RAMOOPS_KERNMSG_HDR "===="
26 #define MIN_MEM_SIZE 4096UL
28 static ulong record_size = MIN_MEM_SIZE;
29 module_param(record_size, ulong, 0400);
30 MODULE_PARM_DESC(record_size,
31 "size of each dump done on oops/panic");
33 static ulong ramoops_console_size = MIN_MEM_SIZE;
34 module_param_named(console_size, ramoops_console_size, ulong, 0400);
35 MODULE_PARM_DESC(console_size, "size of kernel console log");
37 static ulong ramoops_ftrace_size = MIN_MEM_SIZE;
38 module_param_named(ftrace_size, ramoops_ftrace_size, ulong, 0400);
39 MODULE_PARM_DESC(ftrace_size, "size of ftrace log");
41 static ulong ramoops_pmsg_size = MIN_MEM_SIZE;
42 module_param_named(pmsg_size, ramoops_pmsg_size, ulong, 0400);
43 MODULE_PARM_DESC(pmsg_size, "size of user space message log");
45 static unsigned long long mem_address;
46 module_param_hw(mem_address, ullong, other, 0400);
47 MODULE_PARM_DESC(mem_address,
48 "start of reserved RAM used to store oops/panic logs");
50 static ulong mem_size;
51 module_param(mem_size, ulong, 0400);
52 MODULE_PARM_DESC(mem_size,
53 "size of reserved RAM used to store oops/panic logs");
55 static unsigned int mem_type;
56 module_param(mem_type, uint, 0600);
57 MODULE_PARM_DESC(mem_type,
58 "set to 1 to try to use unbuffered memory (default 0)");
60 static int dump_oops = 1;
61 module_param(dump_oops, int, 0600);
62 MODULE_PARM_DESC(dump_oops,
63 "set to 1 to dump oopses, 0 to only dump panics (default 1)");
65 static int ramoops_ecc;
66 module_param_named(ecc, ramoops_ecc, int, 0600);
67 MODULE_PARM_DESC(ramoops_ecc,
68 "if non-zero, the option enables ECC support and specifies "
69 "ECC buffer size in bytes (1 is a special value, means 16 "
70 "bytes ECC)");
72 struct ramoops_context {
73 struct persistent_ram_zone **dprzs; /* Oops dump zones */
74 struct persistent_ram_zone *cprz; /* Console zone */
75 struct persistent_ram_zone **fprzs; /* Ftrace zones */
76 struct persistent_ram_zone *mprz; /* PMSG zone */
77 phys_addr_t phys_addr;
78 unsigned long size;
79 unsigned int memtype;
80 size_t record_size;
81 size_t console_size;
82 size_t ftrace_size;
83 size_t pmsg_size;
84 int dump_oops;
85 u32 flags;
86 struct persistent_ram_ecc_info ecc_info;
87 unsigned int max_dump_cnt;
88 unsigned int dump_write_cnt;
89 /* _read_cnt need clear on ramoops_pstore_open */
90 unsigned int dump_read_cnt;
91 unsigned int console_read_cnt;
92 unsigned int max_ftrace_cnt;
93 unsigned int ftrace_read_cnt;
94 unsigned int pmsg_read_cnt;
95 struct pstore_info pstore;
98 static struct platform_device *dummy;
100 static int ramoops_pstore_open(struct pstore_info *psi)
102 struct ramoops_context *cxt = psi->data;
104 cxt->dump_read_cnt = 0;
105 cxt->console_read_cnt = 0;
106 cxt->ftrace_read_cnt = 0;
107 cxt->pmsg_read_cnt = 0;
108 return 0;
111 static struct persistent_ram_zone *
112 ramoops_get_next_prz(struct persistent_ram_zone *przs[], int id,
113 struct pstore_record *record)
115 struct persistent_ram_zone *prz;
117 /* Give up if we never existed or have hit the end. */
118 if (!przs)
119 return NULL;
121 prz = przs[id];
122 if (!prz)
123 return NULL;
125 /* Update old/shadowed buffer. */
126 if (prz->type == PSTORE_TYPE_DMESG)
127 persistent_ram_save_old(prz);
129 if (!persistent_ram_old_size(prz))
130 return NULL;
132 record->type = prz->type;
133 record->id = id;
135 return prz;
138 static int ramoops_read_kmsg_hdr(char *buffer, struct timespec64 *time,
139 bool *compressed)
141 char data_type;
142 int header_length = 0;
144 if (sscanf(buffer, RAMOOPS_KERNMSG_HDR "%lld.%lu-%c\n%n",
145 (time64_t *)&time->tv_sec, &time->tv_nsec, &data_type,
146 &header_length) == 3) {
147 time->tv_nsec *= 1000;
148 if (data_type == 'C')
149 *compressed = true;
150 else
151 *compressed = false;
152 } else if (sscanf(buffer, RAMOOPS_KERNMSG_HDR "%lld.%lu\n%n",
153 (time64_t *)&time->tv_sec, &time->tv_nsec,
154 &header_length) == 2) {
155 time->tv_nsec *= 1000;
156 *compressed = false;
157 } else {
158 time->tv_sec = 0;
159 time->tv_nsec = 0;
160 *compressed = false;
162 return header_length;
165 static bool prz_ok(struct persistent_ram_zone *prz)
167 return !!prz && !!(persistent_ram_old_size(prz) +
168 persistent_ram_ecc_string(prz, NULL, 0));
171 static ssize_t ftrace_log_combine(struct persistent_ram_zone *dest,
172 struct persistent_ram_zone *src)
174 size_t dest_size, src_size, total, dest_off, src_off;
175 size_t dest_idx = 0, src_idx = 0, merged_idx = 0;
176 void *merged_buf;
177 struct pstore_ftrace_record *drec, *srec, *mrec;
178 size_t record_size = sizeof(struct pstore_ftrace_record);
180 dest_off = dest->old_log_size % record_size;
181 dest_size = dest->old_log_size - dest_off;
183 src_off = src->old_log_size % record_size;
184 src_size = src->old_log_size - src_off;
186 total = dest_size + src_size;
187 merged_buf = kmalloc(total, GFP_KERNEL);
188 if (!merged_buf)
189 return -ENOMEM;
191 drec = (struct pstore_ftrace_record *)(dest->old_log + dest_off);
192 srec = (struct pstore_ftrace_record *)(src->old_log + src_off);
193 mrec = (struct pstore_ftrace_record *)(merged_buf);
195 while (dest_size > 0 && src_size > 0) {
196 if (pstore_ftrace_read_timestamp(&drec[dest_idx]) <
197 pstore_ftrace_read_timestamp(&srec[src_idx])) {
198 mrec[merged_idx++] = drec[dest_idx++];
199 dest_size -= record_size;
200 } else {
201 mrec[merged_idx++] = srec[src_idx++];
202 src_size -= record_size;
206 while (dest_size > 0) {
207 mrec[merged_idx++] = drec[dest_idx++];
208 dest_size -= record_size;
211 while (src_size > 0) {
212 mrec[merged_idx++] = srec[src_idx++];
213 src_size -= record_size;
216 kfree(dest->old_log);
217 dest->old_log = merged_buf;
218 dest->old_log_size = total;
220 return 0;
223 static ssize_t ramoops_pstore_read(struct pstore_record *record)
225 ssize_t size = 0;
226 struct ramoops_context *cxt = record->psi->data;
227 struct persistent_ram_zone *prz = NULL;
228 int header_length = 0;
229 bool free_prz = false;
232 * Ramoops headers provide time stamps for PSTORE_TYPE_DMESG, but
233 * PSTORE_TYPE_CONSOLE and PSTORE_TYPE_FTRACE don't currently have
234 * valid time stamps, so it is initialized to zero.
236 record->time.tv_sec = 0;
237 record->time.tv_nsec = 0;
238 record->compressed = false;
240 /* Find the next valid persistent_ram_zone for DMESG */
241 while (cxt->dump_read_cnt < cxt->max_dump_cnt && !prz) {
242 prz = ramoops_get_next_prz(cxt->dprzs, cxt->dump_read_cnt++,
243 record);
244 if (!prz_ok(prz))
245 continue;
246 header_length = ramoops_read_kmsg_hdr(persistent_ram_old(prz),
247 &record->time,
248 &record->compressed);
249 /* Clear and skip this DMESG record if it has no valid header */
250 if (!header_length) {
251 persistent_ram_free_old(prz);
252 persistent_ram_zap(prz);
253 prz = NULL;
257 if (!prz_ok(prz) && !cxt->console_read_cnt++)
258 prz = ramoops_get_next_prz(&cxt->cprz, 0 /* single */, record);
260 if (!prz_ok(prz) && !cxt->pmsg_read_cnt++)
261 prz = ramoops_get_next_prz(&cxt->mprz, 0 /* single */, record);
263 /* ftrace is last since it may want to dynamically allocate memory. */
264 if (!prz_ok(prz)) {
265 if (!(cxt->flags & RAMOOPS_FLAG_FTRACE_PER_CPU) &&
266 !cxt->ftrace_read_cnt++) {
267 prz = ramoops_get_next_prz(cxt->fprzs, 0 /* single */,
268 record);
269 } else {
271 * Build a new dummy record which combines all the
272 * per-cpu records including metadata and ecc info.
274 struct persistent_ram_zone *tmp_prz, *prz_next;
276 tmp_prz = kzalloc(sizeof(struct persistent_ram_zone),
277 GFP_KERNEL);
278 if (!tmp_prz)
279 return -ENOMEM;
280 prz = tmp_prz;
281 free_prz = true;
283 while (cxt->ftrace_read_cnt < cxt->max_ftrace_cnt) {
284 prz_next = ramoops_get_next_prz(cxt->fprzs,
285 cxt->ftrace_read_cnt++, record);
287 if (!prz_ok(prz_next))
288 continue;
290 tmp_prz->ecc_info = prz_next->ecc_info;
291 tmp_prz->corrected_bytes +=
292 prz_next->corrected_bytes;
293 tmp_prz->bad_blocks += prz_next->bad_blocks;
294 size = ftrace_log_combine(tmp_prz, prz_next);
295 if (size)
296 goto out;
298 record->id = 0;
302 if (!prz_ok(prz)) {
303 size = 0;
304 goto out;
307 size = persistent_ram_old_size(prz) - header_length;
309 /* ECC correction notice */
310 record->ecc_notice_size = persistent_ram_ecc_string(prz, NULL, 0);
312 record->buf = kmalloc(size + record->ecc_notice_size + 1, GFP_KERNEL);
313 if (record->buf == NULL) {
314 size = -ENOMEM;
315 goto out;
318 memcpy(record->buf, (char *)persistent_ram_old(prz) + header_length,
319 size);
321 persistent_ram_ecc_string(prz, record->buf + size,
322 record->ecc_notice_size + 1);
324 out:
325 if (free_prz) {
326 kfree(prz->old_log);
327 kfree(prz);
330 return size;
333 static size_t ramoops_write_kmsg_hdr(struct persistent_ram_zone *prz,
334 struct pstore_record *record)
336 char hdr[36]; /* "===="(4), %lld(20), "."(1), %06lu(6), "-%c\n"(3) */
337 size_t len;
339 len = scnprintf(hdr, sizeof(hdr),
340 RAMOOPS_KERNMSG_HDR "%lld.%06lu-%c\n",
341 (time64_t)record->time.tv_sec,
342 record->time.tv_nsec / 1000,
343 record->compressed ? 'C' : 'D');
344 persistent_ram_write(prz, hdr, len);
346 return len;
349 static int notrace ramoops_pstore_write(struct pstore_record *record)
351 struct ramoops_context *cxt = record->psi->data;
352 struct persistent_ram_zone *prz;
353 size_t size, hlen;
355 if (record->type == PSTORE_TYPE_CONSOLE) {
356 if (!cxt->cprz)
357 return -ENOMEM;
358 persistent_ram_write(cxt->cprz, record->buf, record->size);
359 return 0;
360 } else if (record->type == PSTORE_TYPE_FTRACE) {
361 int zonenum;
363 if (!cxt->fprzs)
364 return -ENOMEM;
366 * Choose zone by if we're using per-cpu buffers.
368 if (cxt->flags & RAMOOPS_FLAG_FTRACE_PER_CPU)
369 zonenum = smp_processor_id();
370 else
371 zonenum = 0;
373 persistent_ram_write(cxt->fprzs[zonenum], record->buf,
374 record->size);
375 return 0;
376 } else if (record->type == PSTORE_TYPE_PMSG) {
377 pr_warn_ratelimited("PMSG shouldn't call %s\n", __func__);
378 return -EINVAL;
381 if (record->type != PSTORE_TYPE_DMESG)
382 return -EINVAL;
385 * Out of the various dmesg dump types, ramoops is currently designed
386 * to only store crash logs, rather than storing general kernel logs.
388 if (record->reason != KMSG_DUMP_OOPS &&
389 record->reason != KMSG_DUMP_PANIC)
390 return -EINVAL;
392 /* Skip Oopes when configured to do so. */
393 if (record->reason == KMSG_DUMP_OOPS && !cxt->dump_oops)
394 return -EINVAL;
397 * Explicitly only take the first part of any new crash.
398 * If our buffer is larger than kmsg_bytes, this can never happen,
399 * and if our buffer is smaller than kmsg_bytes, we don't want the
400 * report split across multiple records.
402 if (record->part != 1)
403 return -ENOSPC;
405 if (!cxt->dprzs)
406 return -ENOSPC;
408 prz = cxt->dprzs[cxt->dump_write_cnt];
410 /* Build header and append record contents. */
411 hlen = ramoops_write_kmsg_hdr(prz, record);
412 if (!hlen)
413 return -ENOMEM;
415 size = record->size;
416 if (size + hlen > prz->buffer_size)
417 size = prz->buffer_size - hlen;
418 persistent_ram_write(prz, record->buf, size);
420 cxt->dump_write_cnt = (cxt->dump_write_cnt + 1) % cxt->max_dump_cnt;
422 return 0;
425 static int notrace ramoops_pstore_write_user(struct pstore_record *record,
426 const char __user *buf)
428 if (record->type == PSTORE_TYPE_PMSG) {
429 struct ramoops_context *cxt = record->psi->data;
431 if (!cxt->mprz)
432 return -ENOMEM;
433 return persistent_ram_write_user(cxt->mprz, buf, record->size);
436 return -EINVAL;
439 static int ramoops_pstore_erase(struct pstore_record *record)
441 struct ramoops_context *cxt = record->psi->data;
442 struct persistent_ram_zone *prz;
444 switch (record->type) {
445 case PSTORE_TYPE_DMESG:
446 if (record->id >= cxt->max_dump_cnt)
447 return -EINVAL;
448 prz = cxt->dprzs[record->id];
449 break;
450 case PSTORE_TYPE_CONSOLE:
451 prz = cxt->cprz;
452 break;
453 case PSTORE_TYPE_FTRACE:
454 if (record->id >= cxt->max_ftrace_cnt)
455 return -EINVAL;
456 prz = cxt->fprzs[record->id];
457 break;
458 case PSTORE_TYPE_PMSG:
459 prz = cxt->mprz;
460 break;
461 default:
462 return -EINVAL;
465 persistent_ram_free_old(prz);
466 persistent_ram_zap(prz);
468 return 0;
471 static struct ramoops_context oops_cxt = {
472 .pstore = {
473 .owner = THIS_MODULE,
474 .name = "ramoops",
475 .open = ramoops_pstore_open,
476 .read = ramoops_pstore_read,
477 .write = ramoops_pstore_write,
478 .write_user = ramoops_pstore_write_user,
479 .erase = ramoops_pstore_erase,
483 static void ramoops_free_przs(struct ramoops_context *cxt)
485 int i;
487 /* Free dump PRZs */
488 if (cxt->dprzs) {
489 for (i = 0; i < cxt->max_dump_cnt; i++)
490 persistent_ram_free(cxt->dprzs[i]);
492 kfree(cxt->dprzs);
493 cxt->max_dump_cnt = 0;
496 /* Free ftrace PRZs */
497 if (cxt->fprzs) {
498 for (i = 0; i < cxt->max_ftrace_cnt; i++)
499 persistent_ram_free(cxt->fprzs[i]);
500 kfree(cxt->fprzs);
501 cxt->max_ftrace_cnt = 0;
505 static int ramoops_init_przs(const char *name,
506 struct device *dev, struct ramoops_context *cxt,
507 struct persistent_ram_zone ***przs,
508 phys_addr_t *paddr, size_t mem_sz,
509 ssize_t record_size,
510 unsigned int *cnt, u32 sig, u32 flags)
512 int err = -ENOMEM;
513 int i;
514 size_t zone_sz;
515 struct persistent_ram_zone **prz_ar;
517 /* Allocate nothing for 0 mem_sz or 0 record_size. */
518 if (mem_sz == 0 || record_size == 0) {
519 *cnt = 0;
520 return 0;
524 * If we have a negative record size, calculate it based on
525 * mem_sz / *cnt. If we have a positive record size, calculate
526 * cnt from mem_sz / record_size.
528 if (record_size < 0) {
529 if (*cnt == 0)
530 return 0;
531 record_size = mem_sz / *cnt;
532 if (record_size == 0) {
533 dev_err(dev, "%s record size == 0 (%zu / %u)\n",
534 name, mem_sz, *cnt);
535 goto fail;
537 } else {
538 *cnt = mem_sz / record_size;
539 if (*cnt == 0) {
540 dev_err(dev, "%s record count == 0 (%zu / %zu)\n",
541 name, mem_sz, record_size);
542 goto fail;
546 if (*paddr + mem_sz - cxt->phys_addr > cxt->size) {
547 dev_err(dev, "no room for %s mem region (0x%zx@0x%llx) in (0x%lx@0x%llx)\n",
548 name,
549 mem_sz, (unsigned long long)*paddr,
550 cxt->size, (unsigned long long)cxt->phys_addr);
551 goto fail;
554 zone_sz = mem_sz / *cnt;
555 if (!zone_sz) {
556 dev_err(dev, "%s zone size == 0\n", name);
557 goto fail;
560 prz_ar = kcalloc(*cnt, sizeof(**przs), GFP_KERNEL);
561 if (!prz_ar)
562 goto fail;
564 for (i = 0; i < *cnt; i++) {
565 char *label;
567 if (*cnt == 1)
568 label = kasprintf(GFP_KERNEL, "ramoops:%s", name);
569 else
570 label = kasprintf(GFP_KERNEL, "ramoops:%s(%d/%d)",
571 name, i, *cnt - 1);
572 prz_ar[i] = persistent_ram_new(*paddr, zone_sz, sig,
573 &cxt->ecc_info,
574 cxt->memtype, flags, label);
575 if (IS_ERR(prz_ar[i])) {
576 err = PTR_ERR(prz_ar[i]);
577 dev_err(dev, "failed to request %s mem region (0x%zx@0x%llx): %d\n",
578 name, record_size,
579 (unsigned long long)*paddr, err);
581 while (i > 0) {
582 i--;
583 persistent_ram_free(prz_ar[i]);
585 kfree(prz_ar);
586 goto fail;
588 *paddr += zone_sz;
589 prz_ar[i]->type = pstore_name_to_type(name);
592 *przs = prz_ar;
593 return 0;
595 fail:
596 *cnt = 0;
597 return err;
600 static int ramoops_init_prz(const char *name,
601 struct device *dev, struct ramoops_context *cxt,
602 struct persistent_ram_zone **prz,
603 phys_addr_t *paddr, size_t sz, u32 sig)
605 char *label;
607 if (!sz)
608 return 0;
610 if (*paddr + sz - cxt->phys_addr > cxt->size) {
611 dev_err(dev, "no room for %s mem region (0x%zx@0x%llx) in (0x%lx@0x%llx)\n",
612 name, sz, (unsigned long long)*paddr,
613 cxt->size, (unsigned long long)cxt->phys_addr);
614 return -ENOMEM;
617 label = kasprintf(GFP_KERNEL, "ramoops:%s", name);
618 *prz = persistent_ram_new(*paddr, sz, sig, &cxt->ecc_info,
619 cxt->memtype, PRZ_FLAG_ZAP_OLD, label);
620 if (IS_ERR(*prz)) {
621 int err = PTR_ERR(*prz);
623 dev_err(dev, "failed to request %s mem region (0x%zx@0x%llx): %d\n",
624 name, sz, (unsigned long long)*paddr, err);
625 return err;
628 *paddr += sz;
629 (*prz)->type = pstore_name_to_type(name);
631 return 0;
634 static int ramoops_parse_dt_size(struct platform_device *pdev,
635 const char *propname, u32 *value)
637 u32 val32 = 0;
638 int ret;
640 ret = of_property_read_u32(pdev->dev.of_node, propname, &val32);
641 if (ret < 0 && ret != -EINVAL) {
642 dev_err(&pdev->dev, "failed to parse property %s: %d\n",
643 propname, ret);
644 return ret;
647 if (val32 > INT_MAX) {
648 dev_err(&pdev->dev, "%s %u > INT_MAX\n", propname, val32);
649 return -EOVERFLOW;
652 *value = val32;
653 return 0;
656 static int ramoops_parse_dt(struct platform_device *pdev,
657 struct ramoops_platform_data *pdata)
659 struct device_node *of_node = pdev->dev.of_node;
660 struct device_node *parent_node;
661 struct resource *res;
662 u32 value;
663 int ret;
665 dev_dbg(&pdev->dev, "using Device Tree\n");
667 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
668 if (!res) {
669 dev_err(&pdev->dev,
670 "failed to locate DT /reserved-memory resource\n");
671 return -EINVAL;
674 pdata->mem_size = resource_size(res);
675 pdata->mem_address = res->start;
676 pdata->mem_type = of_property_read_bool(of_node, "unbuffered");
677 pdata->dump_oops = !of_property_read_bool(of_node, "no-dump-oops");
679 #define parse_size(name, field) { \
680 ret = ramoops_parse_dt_size(pdev, name, &value); \
681 if (ret < 0) \
682 return ret; \
683 field = value; \
686 parse_size("record-size", pdata->record_size);
687 parse_size("console-size", pdata->console_size);
688 parse_size("ftrace-size", pdata->ftrace_size);
689 parse_size("pmsg-size", pdata->pmsg_size);
690 parse_size("ecc-size", pdata->ecc_info.ecc_size);
691 parse_size("flags", pdata->flags);
693 #undef parse_size
696 * Some old Chromebooks relied on the kernel setting the
697 * console_size and pmsg_size to the record size since that's
698 * what the downstream kernel did. These same Chromebooks had
699 * "ramoops" straight under the root node which isn't
700 * according to the current upstream bindings (though it was
701 * arguably acceptable under a prior version of the bindings).
702 * Let's make those old Chromebooks work by detecting that
703 * we're not a child of "reserved-memory" and mimicking the
704 * expected behavior.
706 parent_node = of_get_parent(of_node);
707 if (!of_node_name_eq(parent_node, "reserved-memory") &&
708 !pdata->console_size && !pdata->ftrace_size &&
709 !pdata->pmsg_size && !pdata->ecc_info.ecc_size) {
710 pdata->console_size = pdata->record_size;
711 pdata->pmsg_size = pdata->record_size;
713 of_node_put(parent_node);
715 return 0;
718 static int ramoops_probe(struct platform_device *pdev)
720 struct device *dev = &pdev->dev;
721 struct ramoops_platform_data *pdata = dev->platform_data;
722 struct ramoops_platform_data pdata_local;
723 struct ramoops_context *cxt = &oops_cxt;
724 size_t dump_mem_sz;
725 phys_addr_t paddr;
726 int err = -EINVAL;
729 * Only a single ramoops area allowed at a time, so fail extra
730 * probes.
732 if (cxt->max_dump_cnt) {
733 pr_err("already initialized\n");
734 goto fail_out;
737 if (dev_of_node(dev) && !pdata) {
738 pdata = &pdata_local;
739 memset(pdata, 0, sizeof(*pdata));
741 err = ramoops_parse_dt(pdev, pdata);
742 if (err < 0)
743 goto fail_out;
746 /* Make sure we didn't get bogus platform data pointer. */
747 if (!pdata) {
748 pr_err("NULL platform data\n");
749 goto fail_out;
752 if (!pdata->mem_size || (!pdata->record_size && !pdata->console_size &&
753 !pdata->ftrace_size && !pdata->pmsg_size)) {
754 pr_err("The memory size and the record/console size must be "
755 "non-zero\n");
756 goto fail_out;
759 if (pdata->record_size && !is_power_of_2(pdata->record_size))
760 pdata->record_size = rounddown_pow_of_two(pdata->record_size);
761 if (pdata->console_size && !is_power_of_2(pdata->console_size))
762 pdata->console_size = rounddown_pow_of_two(pdata->console_size);
763 if (pdata->ftrace_size && !is_power_of_2(pdata->ftrace_size))
764 pdata->ftrace_size = rounddown_pow_of_two(pdata->ftrace_size);
765 if (pdata->pmsg_size && !is_power_of_2(pdata->pmsg_size))
766 pdata->pmsg_size = rounddown_pow_of_two(pdata->pmsg_size);
768 cxt->size = pdata->mem_size;
769 cxt->phys_addr = pdata->mem_address;
770 cxt->memtype = pdata->mem_type;
771 cxt->record_size = pdata->record_size;
772 cxt->console_size = pdata->console_size;
773 cxt->ftrace_size = pdata->ftrace_size;
774 cxt->pmsg_size = pdata->pmsg_size;
775 cxt->dump_oops = pdata->dump_oops;
776 cxt->flags = pdata->flags;
777 cxt->ecc_info = pdata->ecc_info;
779 paddr = cxt->phys_addr;
781 dump_mem_sz = cxt->size - cxt->console_size - cxt->ftrace_size
782 - cxt->pmsg_size;
783 err = ramoops_init_przs("dmesg", dev, cxt, &cxt->dprzs, &paddr,
784 dump_mem_sz, cxt->record_size,
785 &cxt->max_dump_cnt, 0, 0);
786 if (err)
787 goto fail_out;
789 err = ramoops_init_prz("console", dev, cxt, &cxt->cprz, &paddr,
790 cxt->console_size, 0);
791 if (err)
792 goto fail_init_cprz;
794 cxt->max_ftrace_cnt = (cxt->flags & RAMOOPS_FLAG_FTRACE_PER_CPU)
795 ? nr_cpu_ids
796 : 1;
797 err = ramoops_init_przs("ftrace", dev, cxt, &cxt->fprzs, &paddr,
798 cxt->ftrace_size, -1,
799 &cxt->max_ftrace_cnt, LINUX_VERSION_CODE,
800 (cxt->flags & RAMOOPS_FLAG_FTRACE_PER_CPU)
801 ? PRZ_FLAG_NO_LOCK : 0);
802 if (err)
803 goto fail_init_fprz;
805 err = ramoops_init_prz("pmsg", dev, cxt, &cxt->mprz, &paddr,
806 cxt->pmsg_size, 0);
807 if (err)
808 goto fail_init_mprz;
810 cxt->pstore.data = cxt;
812 * Prepare frontend flags based on which areas are initialized.
813 * For ramoops_init_przs() cases, the "max count" variable tells
814 * if there are regions present. For ramoops_init_prz() cases,
815 * the single region size is how to check.
817 cxt->pstore.flags = 0;
818 if (cxt->max_dump_cnt)
819 cxt->pstore.flags |= PSTORE_FLAGS_DMESG;
820 if (cxt->console_size)
821 cxt->pstore.flags |= PSTORE_FLAGS_CONSOLE;
822 if (cxt->max_ftrace_cnt)
823 cxt->pstore.flags |= PSTORE_FLAGS_FTRACE;
824 if (cxt->pmsg_size)
825 cxt->pstore.flags |= PSTORE_FLAGS_PMSG;
828 * Since bufsize is only used for dmesg crash dumps, it
829 * must match the size of the dprz record (after PRZ header
830 * and ECC bytes have been accounted for).
832 if (cxt->pstore.flags & PSTORE_FLAGS_DMESG) {
833 cxt->pstore.bufsize = cxt->dprzs[0]->buffer_size;
834 cxt->pstore.buf = kzalloc(cxt->pstore.bufsize, GFP_KERNEL);
835 if (!cxt->pstore.buf) {
836 pr_err("cannot allocate pstore crash dump buffer\n");
837 err = -ENOMEM;
838 goto fail_clear;
842 err = pstore_register(&cxt->pstore);
843 if (err) {
844 pr_err("registering with pstore failed\n");
845 goto fail_buf;
849 * Update the module parameter variables as well so they are visible
850 * through /sys/module/ramoops/parameters/
852 mem_size = pdata->mem_size;
853 mem_address = pdata->mem_address;
854 record_size = pdata->record_size;
855 dump_oops = pdata->dump_oops;
856 ramoops_console_size = pdata->console_size;
857 ramoops_pmsg_size = pdata->pmsg_size;
858 ramoops_ftrace_size = pdata->ftrace_size;
860 pr_info("using 0x%lx@0x%llx, ecc: %d\n",
861 cxt->size, (unsigned long long)cxt->phys_addr,
862 cxt->ecc_info.ecc_size);
864 return 0;
866 fail_buf:
867 kfree(cxt->pstore.buf);
868 fail_clear:
869 cxt->pstore.bufsize = 0;
870 persistent_ram_free(cxt->mprz);
871 fail_init_mprz:
872 fail_init_fprz:
873 persistent_ram_free(cxt->cprz);
874 fail_init_cprz:
875 ramoops_free_przs(cxt);
876 fail_out:
877 return err;
880 static int ramoops_remove(struct platform_device *pdev)
882 struct ramoops_context *cxt = &oops_cxt;
884 pstore_unregister(&cxt->pstore);
886 kfree(cxt->pstore.buf);
887 cxt->pstore.bufsize = 0;
889 persistent_ram_free(cxt->mprz);
890 persistent_ram_free(cxt->cprz);
891 ramoops_free_przs(cxt);
893 return 0;
896 static const struct of_device_id dt_match[] = {
897 { .compatible = "ramoops" },
901 static struct platform_driver ramoops_driver = {
902 .probe = ramoops_probe,
903 .remove = ramoops_remove,
904 .driver = {
905 .name = "ramoops",
906 .of_match_table = dt_match,
910 static inline void ramoops_unregister_dummy(void)
912 platform_device_unregister(dummy);
913 dummy = NULL;
916 static void __init ramoops_register_dummy(void)
918 struct ramoops_platform_data pdata;
921 * Prepare a dummy platform data structure to carry the module
922 * parameters. If mem_size isn't set, then there are no module
923 * parameters, and we can skip this.
925 if (!mem_size)
926 return;
928 pr_info("using module parameters\n");
930 memset(&pdata, 0, sizeof(pdata));
931 pdata.mem_size = mem_size;
932 pdata.mem_address = mem_address;
933 pdata.mem_type = mem_type;
934 pdata.record_size = record_size;
935 pdata.console_size = ramoops_console_size;
936 pdata.ftrace_size = ramoops_ftrace_size;
937 pdata.pmsg_size = ramoops_pmsg_size;
938 pdata.dump_oops = dump_oops;
939 pdata.flags = RAMOOPS_FLAG_FTRACE_PER_CPU;
942 * For backwards compatibility ramoops.ecc=1 means 16 bytes ECC
943 * (using 1 byte for ECC isn't much of use anyway).
945 pdata.ecc_info.ecc_size = ramoops_ecc == 1 ? 16 : ramoops_ecc;
947 dummy = platform_device_register_data(NULL, "ramoops", -1,
948 &pdata, sizeof(pdata));
949 if (IS_ERR(dummy)) {
950 pr_info("could not create platform device: %ld\n",
951 PTR_ERR(dummy));
952 dummy = NULL;
953 ramoops_unregister_dummy();
957 static int __init ramoops_init(void)
959 int ret;
961 ramoops_register_dummy();
962 ret = platform_driver_register(&ramoops_driver);
963 if (ret != 0)
964 ramoops_unregister_dummy();
966 return ret;
968 postcore_initcall(ramoops_init);
970 static void __exit ramoops_exit(void)
972 platform_driver_unregister(&ramoops_driver);
973 ramoops_unregister_dummy();
975 module_exit(ramoops_exit);
977 MODULE_LICENSE("GPL");
978 MODULE_AUTHOR("Marco Stornelli <marco.stornelli@gmail.com>");
979 MODULE_DESCRIPTION("RAM Oops/Panic logger/driver");