• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * RAM Oops/Panic logger
3  *
4  * Copyright (C) 2010 Marco Stornelli <marco.stornelli@gmail.com>
5  * Copyright (C) 2011 Kees Cook <keescook@chromium.org>
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 
23 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
24 
25 #include <linux/kernel.h>
26 #include <linux/err.h>
27 #include <linux/module.h>
28 #include <linux/version.h>
29 #include <linux/pstore.h>
30 #include <linux/time.h>
31 #include <linux/io.h>
32 #include <linux/ioport.h>
33 #include <linux/platform_device.h>
34 #include <linux/slab.h>
35 #include <linux/compiler.h>
36 #include <linux/pstore_ram.h>
37 #include <linux/of.h>
38 #include <linux/of_address.h>
39 
40 #define RAMOOPS_KERNMSG_HDR "===="
41 #define MIN_MEM_SIZE 4096UL
42 
43 static ulong record_size = MIN_MEM_SIZE;
44 module_param(record_size, ulong, 0400);
45 MODULE_PARM_DESC(record_size,
46 		"size of each dump done on oops/panic");
47 
48 static ulong ramoops_console_size = MIN_MEM_SIZE;
49 module_param_named(console_size, ramoops_console_size, ulong, 0400);
50 MODULE_PARM_DESC(console_size, "size of kernel console log");
51 
52 static ulong ramoops_ftrace_size = MIN_MEM_SIZE;
53 module_param_named(ftrace_size, ramoops_ftrace_size, ulong, 0400);
54 MODULE_PARM_DESC(ftrace_size, "size of ftrace log");
55 
56 static ulong ramoops_pmsg_size = MIN_MEM_SIZE;
57 module_param_named(pmsg_size, ramoops_pmsg_size, ulong, 0400);
58 MODULE_PARM_DESC(pmsg_size, "size of user space message log");
59 
60 static ulong mem_address;
61 module_param(mem_address, ulong, 0400);
62 MODULE_PARM_DESC(mem_address,
63 		"start of reserved RAM used to store oops/panic logs");
64 
65 static ulong mem_size;
66 module_param(mem_size, ulong, 0400);
67 MODULE_PARM_DESC(mem_size,
68 		"size of reserved RAM used to store oops/panic logs");
69 
70 static unsigned int mem_type;
71 module_param(mem_type, uint, 0600);
72 MODULE_PARM_DESC(mem_type,
73 		"set to 1 to try to use unbuffered memory (default 0)");
74 
75 static int dump_oops = 1;
76 module_param(dump_oops, int, 0600);
77 MODULE_PARM_DESC(dump_oops,
78 		"set to 1 to dump oopses, 0 to only dump panics (default 1)");
79 
80 static int ramoops_ecc;
81 module_param_named(ecc, ramoops_ecc, int, 0600);
82 MODULE_PARM_DESC(ramoops_ecc,
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)");
86 
87 struct ramoops_context {
88 	struct persistent_ram_zone **przs;
89 	struct persistent_ram_zone *cprz;
90 	struct persistent_ram_zone *fprz;
91 	struct persistent_ram_zone *mprz;
92 	phys_addr_t phys_addr;
93 	unsigned long size;
94 	unsigned int memtype;
95 	size_t record_size;
96 	size_t console_size;
97 	size_t ftrace_size;
98 	size_t pmsg_size;
99 	int dump_oops;
100 	struct persistent_ram_ecc_info ecc_info;
101 	unsigned int max_dump_cnt;
102 	unsigned int dump_write_cnt;
103 	/* _read_cnt need clear on ramoops_pstore_open */
104 	unsigned int dump_read_cnt;
105 	unsigned int console_read_cnt;
106 	unsigned int ftrace_read_cnt;
107 	unsigned int pmsg_read_cnt;
108 	struct pstore_info pstore;
109 };
110 
111 static struct platform_device *dummy;
112 static struct ramoops_platform_data *dummy_data;
113 
ramoops_pstore_open(struct pstore_info * psi)114 static int ramoops_pstore_open(struct pstore_info *psi)
115 {
116 	struct ramoops_context *cxt = psi->data;
117 
118 	cxt->dump_read_cnt = 0;
119 	cxt->console_read_cnt = 0;
120 	cxt->ftrace_read_cnt = 0;
121 	cxt->pmsg_read_cnt = 0;
122 	return 0;
123 }
124 
125 static struct persistent_ram_zone *
ramoops_get_next_prz(struct persistent_ram_zone * przs[],uint * c,uint max,u64 * id,enum pstore_type_id * typep,enum pstore_type_id type,bool update)126 ramoops_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];
138 	if (!prz)
139 		return NULL;
140 
141 	/* Update old/shadowed buffer. */
142 	if (update)
143 		persistent_ram_save_old(prz);
144 
145 	if (!persistent_ram_old_size(prz))
146 		return NULL;
147 
148 	*typep = type;
149 	*id = i;
150 
151 	return prz;
152 }
153 
ramoops_read_kmsg_hdr(char * buffer,struct timespec * time,bool * compressed)154 static int ramoops_read_kmsg_hdr(char *buffer, struct timespec *time,
155 				  bool *compressed)
156 {
157 	char data_type;
158 	int header_length = 0;
159 
160 	if (sscanf(buffer, RAMOOPS_KERNMSG_HDR "%lu.%lu-%c\n%n", &time->tv_sec,
161 			&time->tv_nsec, &data_type, &header_length) == 3) {
162 		if (data_type == 'C')
163 			*compressed = true;
164 		else
165 			*compressed = false;
166 	} else if (sscanf(buffer, RAMOOPS_KERNMSG_HDR "%lu.%lu\n%n",
167 			&time->tv_sec, &time->tv_nsec, &header_length) == 2) {
168 			*compressed = false;
169 	} else {
170 		time->tv_sec = 0;
171 		time->tv_nsec = 0;
172 		*compressed = false;
173 	}
174 	return header_length;
175 }
176 
prz_ok(struct persistent_ram_zone * prz)177 static 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 
ramoops_pstore_read(u64 * id,enum pstore_type_id * type,int * count,struct timespec * time,char ** buf,bool * compressed,struct pstore_info * psi)183 static ssize_t ramoops_pstore_read(u64 *id, enum pstore_type_id *type,
184 				   int *count, struct timespec *time,
185 				   char **buf, bool *compressed,
186 				   struct pstore_info *psi)
187 {
188 	ssize_t size;
189 	ssize_t ecc_notice_size;
190 	struct ramoops_context *cxt = psi->data;
191 	struct persistent_ram_zone *prz = NULL;
192 	int header_length = 0;
193 
194 	/* 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 
219 	if (!prz_ok(prz))
220 		prz = ramoops_get_next_prz(&cxt->cprz, &cxt->console_read_cnt,
221 					   1, id, type, PSTORE_TYPE_CONSOLE, 0);
222 	if (!prz_ok(prz))
223 		prz = ramoops_get_next_prz(&cxt->fprz, &cxt->ftrace_read_cnt,
224 					   1, id, type, PSTORE_TYPE_FTRACE, 0);
225 	if (!prz_ok(prz))
226 		prz = ramoops_get_next_prz(&cxt->mprz, &cxt->pmsg_read_cnt,
227 					   1, id, type, PSTORE_TYPE_PMSG, 0);
228 	if (!prz_ok(prz))
229 		return 0;
230 
231 	size = persistent_ram_old_size(prz) - header_length;
232 
233 	/* ECC correction notice */
234 	ecc_notice_size = persistent_ram_ecc_string(prz, NULL, 0);
235 
236 	*buf = kmalloc(size + ecc_notice_size + 1, GFP_KERNEL);
237 	if (*buf == NULL)
238 		return -ENOMEM;
239 
240 	memcpy(*buf, (char *)persistent_ram_old(prz) + header_length, size);
241 	persistent_ram_ecc_string(prz, *buf + size, ecc_notice_size + 1);
242 
243 	return size + ecc_notice_size;
244 }
245 
ramoops_write_kmsg_hdr(struct persistent_ram_zone * prz,bool compressed)246 static size_t ramoops_write_kmsg_hdr(struct persistent_ram_zone *prz,
247 				     bool compressed)
248 {
249 	char *hdr;
250 	struct timespec timestamp;
251 	size_t len;
252 
253 	/* Report zeroed timestamp if called before timekeeping has resumed. */
254 	if (__getnstimeofday(&timestamp)) {
255 		timestamp.tv_sec = 0;
256 		timestamp.tv_nsec = 0;
257 	}
258 	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');
261 	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 
ramoops_pstore_write_buf(enum pstore_type_id type,enum kmsg_dump_reason reason,u64 * id,unsigned int part,const char * buf,bool compressed,size_t size,struct pstore_info * psi)269 static int notrace ramoops_pstore_write_buf(enum pstore_type_id type,
270 					    enum kmsg_dump_reason reason,
271 					    u64 *id, unsigned int part,
272 					    const char *buf,
273 					    bool compressed, size_t size,
274 					    struct pstore_info *psi)
275 {
276 	struct ramoops_context *cxt = psi->data;
277 	struct persistent_ram_zone *prz;
278 	size_t hlen;
279 
280 	if (type == PSTORE_TYPE_CONSOLE) {
281 		if (!cxt->cprz)
282 			return -ENOMEM;
283 		persistent_ram_write(cxt->cprz, buf, size);
284 		return 0;
285 	} else if (type == PSTORE_TYPE_FTRACE) {
286 		if (!cxt->fprz)
287 			return -ENOMEM;
288 		persistent_ram_write(cxt->fprz, buf, size);
289 		return 0;
290 	} else if (type == PSTORE_TYPE_PMSG) {
291 		if (!cxt->mprz)
292 			return -ENOMEM;
293 		persistent_ram_write(cxt->mprz, buf, size);
294 		return 0;
295 	}
296 
297 	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 	 */
303 	if (reason != KMSG_DUMP_OOPS &&
304 	    reason != KMSG_DUMP_PANIC)
305 		return -EINVAL;
306 
307 	/* Skip Oopes when configured to do so. */
308 	if (reason == KMSG_DUMP_OOPS && !cxt->dump_oops)
309 		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;
318 
319 	if (!cxt->przs)
320 		return -ENOSPC;
321 
322 	prz = cxt->przs[cxt->dump_write_cnt];
323 
324 	/*
325 	 * Since this is a new crash dump, we need to reset the buffer in
326 	 * case it still has an old dump present. Without this, the new dump
327 	 * will get appended, which would seriously confuse anything trying
328 	 * to check dump file contents. Specifically, ramoops_read_kmsg_hdr()
329 	 * expects to find a dump header in the beginning of buffer data, so
330 	 * we must to reset the buffer values, in order to ensure that the
331 	 * header will be written to the beginning of the buffer.
332 	 */
333 	persistent_ram_zap(prz);
334 
335 	hlen = ramoops_write_kmsg_hdr(prz, compressed);
336 	if (size + hlen > prz->buffer_size)
337 		size = prz->buffer_size - hlen;
338 	persistent_ram_write(prz, buf, size);
339 
340 	cxt->dump_write_cnt = (cxt->dump_write_cnt + 1) % cxt->max_dump_cnt;
341 
342 	return 0;
343 }
344 
ramoops_pstore_write_buf_user(enum pstore_type_id type,enum kmsg_dump_reason reason,u64 * id,unsigned int part,const char __user * buf,bool compressed,size_t size,struct pstore_info * psi)345 static int notrace ramoops_pstore_write_buf_user(enum pstore_type_id type,
346 						 enum kmsg_dump_reason reason,
347 						 u64 *id, unsigned int part,
348 						 const char __user *buf,
349 						 bool compressed, size_t size,
350 						 struct pstore_info *psi)
351 {
352 	if (type == PSTORE_TYPE_PMSG) {
353 		struct ramoops_context *cxt = psi->data;
354 
355 		if (!cxt->mprz)
356 			return -ENOMEM;
357 		return persistent_ram_write_user(cxt->mprz, buf, size);
358 	}
359 
360 	return -EINVAL;
361 }
362 
ramoops_pstore_erase(enum pstore_type_id type,u64 id,int count,struct timespec time,struct pstore_info * psi)363 static int ramoops_pstore_erase(enum pstore_type_id type, u64 id, int count,
364 				struct timespec time, struct pstore_info *psi)
365 {
366 	struct ramoops_context *cxt = psi->data;
367 	struct persistent_ram_zone *prz;
368 
369 	switch (type) {
370 	case PSTORE_TYPE_DMESG:
371 		if (id >= cxt->max_dump_cnt)
372 			return -EINVAL;
373 		prz = cxt->przs[id];
374 		break;
375 	case PSTORE_TYPE_CONSOLE:
376 		prz = cxt->cprz;
377 		break;
378 	case PSTORE_TYPE_FTRACE:
379 		prz = cxt->fprz;
380 		break;
381 	case PSTORE_TYPE_PMSG:
382 		prz = cxt->mprz;
383 		break;
384 	default:
385 		return -EINVAL;
386 	}
387 
388 	persistent_ram_free_old(prz);
389 	persistent_ram_zap(prz);
390 
391 	return 0;
392 }
393 
394 static struct ramoops_context oops_cxt = {
395 	.pstore = {
396 		.owner	= THIS_MODULE,
397 		.name	= "ramoops",
398 		.open	= ramoops_pstore_open,
399 		.read	= ramoops_pstore_read,
400 		.write_buf	= ramoops_pstore_write_buf,
401 		.write_buf_user	= ramoops_pstore_write_buf_user,
402 		.erase	= ramoops_pstore_erase,
403 	},
404 };
405 
ramoops_free_przs(struct ramoops_context * cxt)406 static void ramoops_free_przs(struct ramoops_context *cxt)
407 {
408 	int i;
409 
410 	if (!cxt->przs)
411 		return;
412 
413 	for (i = 0; i < cxt->max_dump_cnt; i++)
414 		persistent_ram_free(cxt->przs[i]);
415 
416 	kfree(cxt->przs);
417 	cxt->max_dump_cnt = 0;
418 }
419 
ramoops_init_przs(struct device * dev,struct ramoops_context * cxt,phys_addr_t * paddr,size_t dump_mem_sz)420 static int ramoops_init_przs(struct device *dev, struct ramoops_context *cxt,
421 			     phys_addr_t *paddr, size_t dump_mem_sz)
422 {
423 	int err = -ENOMEM;
424 	int i;
425 
426 	if (!cxt->record_size)
427 		return 0;
428 
429 	if (*paddr + dump_mem_sz - cxt->phys_addr > cxt->size) {
430 		dev_err(dev, "no room for dumps\n");
431 		return -ENOMEM;
432 	}
433 
434 	cxt->max_dump_cnt = dump_mem_sz / cxt->record_size;
435 	if (!cxt->max_dump_cnt)
436 		return -ENOMEM;
437 
438 	cxt->przs = kzalloc(sizeof(*cxt->przs) * cxt->max_dump_cnt,
439 			     GFP_KERNEL);
440 	if (!cxt->przs) {
441 		dev_err(dev, "failed to initialize a prz array for dumps\n");
442 		goto fail_mem;
443 	}
444 
445 	for (i = 0; i < cxt->max_dump_cnt; i++) {
446 		cxt->przs[i] = persistent_ram_new(*paddr, cxt->record_size, 0,
447 						  &cxt->ecc_info,
448 						  cxt->memtype, 0);
449 		if (IS_ERR(cxt->przs[i])) {
450 			err = PTR_ERR(cxt->przs[i]);
451 			dev_err(dev, "failed to request mem region (0x%zx@0x%llx): %d\n",
452 				cxt->record_size, (unsigned long long)*paddr, err);
453 
454 			while (i > 0) {
455 				i--;
456 				persistent_ram_free(cxt->przs[i]);
457 			}
458 			goto fail_prz;
459 		}
460 		*paddr += cxt->record_size;
461 	}
462 
463 	return 0;
464 fail_prz:
465 	kfree(cxt->przs);
466 fail_mem:
467 	cxt->max_dump_cnt = 0;
468 	return err;
469 }
470 
ramoops_init_prz(struct device * dev,struct ramoops_context * cxt,struct persistent_ram_zone ** prz,phys_addr_t * paddr,size_t sz,u32 sig)471 static int ramoops_init_prz(struct device *dev, struct ramoops_context *cxt,
472 			    struct persistent_ram_zone **prz,
473 			    phys_addr_t *paddr, size_t sz, u32 sig)
474 {
475 	if (!sz)
476 		return 0;
477 
478 	if (*paddr + sz - cxt->phys_addr > cxt->size) {
479 		dev_err(dev, "no room for mem region (0x%zx@0x%llx) in (0x%lx@0x%llx)\n",
480 			sz, (unsigned long long)*paddr,
481 			cxt->size, (unsigned long long)cxt->phys_addr);
482 		return -ENOMEM;
483 	}
484 
485 	*prz = persistent_ram_new(*paddr, sz, sig, &cxt->ecc_info,
486 				  cxt->memtype, 0);
487 	if (IS_ERR(*prz)) {
488 		int err = PTR_ERR(*prz);
489 
490 		dev_err(dev, "failed to request mem region (0x%zx@0x%llx): %d\n",
491 			sz, (unsigned long long)*paddr, err);
492 		return err;
493 	}
494 
495 	persistent_ram_zap(*prz);
496 
497 	*paddr += sz;
498 
499 	return 0;
500 }
501 
ramoops_console_write_buf(const char * buf,size_t size)502 void notrace ramoops_console_write_buf(const char *buf, size_t size)
503 {
504 	struct ramoops_context *cxt = &oops_cxt;
505 	persistent_ram_write(cxt->cprz, buf, size);
506 }
507 
ramoops_parse_dt_size(struct platform_device * pdev,const char * propname,unsigned long * val)508 static int ramoops_parse_dt_size(struct platform_device *pdev,
509 		const char *propname, unsigned long *val)
510 {
511 	u64 val64;
512 	int ret;
513 
514 	ret = of_property_read_u64(pdev->dev.of_node, propname, &val64);
515 	if (ret == -EINVAL) {
516 		*val = 0;
517 		return 0;
518 	} else if (ret != 0) {
519 		dev_err(&pdev->dev, "failed to parse property %s: %d\n",
520 				propname, ret);
521 		return ret;
522 	}
523 
524 	if (val64 > ULONG_MAX) {
525 		dev_err(&pdev->dev, "invalid %s %llu\n", propname, val64);
526 		return -EOVERFLOW;
527 	}
528 
529 	*val = val64;
530 	return 0;
531 }
532 
ramoops_parse_dt(struct platform_device * pdev,struct ramoops_platform_data * pdata)533 static int ramoops_parse_dt(struct platform_device *pdev,
534 		struct ramoops_platform_data *pdata)
535 {
536 	struct device_node *of_node = pdev->dev.of_node;
537 	struct device_node *mem_region;
538 	struct resource res;
539 	u32 ecc_size;
540 	int ret;
541 
542 	dev_dbg(&pdev->dev, "using Device Tree\n");
543 
544 	mem_region = of_parse_phandle(of_node, "memory-region", 0);
545 	if (!mem_region) {
546 		dev_err(&pdev->dev, "no memory-region phandle\n");
547 		return -ENODEV;
548 	}
549 
550 	ret = of_address_to_resource(mem_region, 0, &res);
551 	of_node_put(mem_region);
552 	if (ret) {
553 		dev_err(&pdev->dev, "failed to translate memory-region to resource: %d\n",
554 				ret);
555 		return ret;
556 	}
557 
558 	pdata->mem_size = resource_size(&res);
559 	pdata->mem_address = res.start;
560 	pdata->mem_type = of_property_read_bool(of_node, "unbuffered");
561 	pdata->dump_oops = !of_property_read_bool(of_node, "no-dump-oops");
562 
563 	ret = ramoops_parse_dt_size(pdev, "record-size", &pdata->record_size);
564 	if (ret < 0)
565 		return ret;
566 
567 	ret = ramoops_parse_dt_size(pdev, "console-size", &pdata->console_size);
568 	if (ret < 0)
569 		return ret;
570 
571 	ret = ramoops_parse_dt_size(pdev, "ftrace-size", &pdata->ftrace_size);
572 	if (ret < 0)
573 		return ret;
574 
575 	ret = ramoops_parse_dt_size(pdev, "pmsg-size", &pdata->pmsg_size);
576 	if (ret < 0)
577 		return ret;
578 
579 	ret = of_property_read_u32(of_node, "ecc-size", &ecc_size);
580 	if (ret == 0) {
581 		if (ecc_size > INT_MAX) {
582 			dev_err(&pdev->dev, "invalid ecc-size %u\n", ecc_size);
583 			return -EOVERFLOW;
584 		}
585 		pdata->ecc_info.ecc_size = ecc_size;
586 	} else if (ret != -EINVAL) {
587 		return ret;
588 	}
589 
590 	return 0;
591 }
592 
ramoops_probe(struct platform_device * pdev)593 static int ramoops_probe(struct platform_device *pdev)
594 {
595 	struct device *dev = &pdev->dev;
596 	struct ramoops_platform_data *pdata = pdev->dev.platform_data;
597 	struct ramoops_context *cxt = &oops_cxt;
598 	size_t dump_mem_sz;
599 	phys_addr_t paddr;
600 	int err = -EINVAL;
601 
602 	if (dev->of_node && !pdata) {
603 		pdata = devm_kzalloc(&pdev->dev, sizeof(*pdata), GFP_KERNEL);
604 		if (!pdata) {
605 			err = -ENOMEM;
606 			goto fail_out;
607 		}
608 
609 		err = ramoops_parse_dt(pdev, pdata);
610 		if (err < 0)
611 			goto fail_out;
612 	}
613 
614 	/* Only a single ramoops area allowed at a time, so fail extra
615 	 * probes.
616 	 */
617 	if (cxt->max_dump_cnt)
618 		goto fail_out;
619 
620 	if (!pdata->mem_size || (!pdata->record_size && !pdata->console_size &&
621 			!pdata->ftrace_size && !pdata->pmsg_size)) {
622 		pr_err("The memory size and the record/console size must be "
623 			"non-zero\n");
624 		goto fail_out;
625 	}
626 
627 	if (pdata->record_size && !is_power_of_2(pdata->record_size))
628 		pdata->record_size = rounddown_pow_of_two(pdata->record_size);
629 	if (pdata->console_size && !is_power_of_2(pdata->console_size))
630 		pdata->console_size = rounddown_pow_of_two(pdata->console_size);
631 	if (pdata->ftrace_size && !is_power_of_2(pdata->ftrace_size))
632 		pdata->ftrace_size = rounddown_pow_of_two(pdata->ftrace_size);
633 	if (pdata->pmsg_size && !is_power_of_2(pdata->pmsg_size))
634 		pdata->pmsg_size = rounddown_pow_of_two(pdata->pmsg_size);
635 
636 	cxt->size = pdata->mem_size;
637 	cxt->phys_addr = pdata->mem_address;
638 	cxt->memtype = pdata->mem_type;
639 	cxt->record_size = pdata->record_size;
640 	cxt->console_size = pdata->console_size;
641 	cxt->ftrace_size = pdata->ftrace_size;
642 	cxt->pmsg_size = pdata->pmsg_size;
643 	cxt->dump_oops = pdata->dump_oops;
644 	cxt->ecc_info = pdata->ecc_info;
645 
646 	paddr = cxt->phys_addr;
647 
648 	dump_mem_sz = cxt->size - cxt->console_size - cxt->ftrace_size
649 			- cxt->pmsg_size;
650 	err = ramoops_init_przs(dev, cxt, &paddr, dump_mem_sz);
651 	if (err)
652 		goto fail_out;
653 
654 	err = ramoops_init_prz(dev, cxt, &cxt->cprz, &paddr,
655 			       cxt->console_size, 0);
656 	if (err)
657 		goto fail_init_cprz;
658 
659 	err = ramoops_init_prz(dev, cxt, &cxt->fprz, &paddr, cxt->ftrace_size,
660 			       LINUX_VERSION_CODE);
661 	if (err)
662 		goto fail_init_fprz;
663 
664 	err = ramoops_init_prz(dev, cxt, &cxt->mprz, &paddr, cxt->pmsg_size, 0);
665 	if (err)
666 		goto fail_init_mprz;
667 
668 	cxt->pstore.data = cxt;
669 	/*
670 	 * Console can handle any buffer size, so prefer LOG_LINE_MAX. If we
671 	 * have to handle dumps, we must have at least record_size buffer. And
672 	 * for ftrace, bufsize is irrelevant (if bufsize is 0, buf will be
673 	 * ZERO_SIZE_PTR).
674 	 */
675 	if (cxt->console_size)
676 		cxt->pstore.bufsize = 1024; /* LOG_LINE_MAX */
677 	cxt->pstore.bufsize = max(cxt->record_size, cxt->pstore.bufsize);
678 	cxt->pstore.buf = kmalloc(cxt->pstore.bufsize, GFP_KERNEL);
679 	spin_lock_init(&cxt->pstore.buf_lock);
680 	if (!cxt->pstore.buf) {
681 		pr_err("cannot allocate pstore buffer\n");
682 		err = -ENOMEM;
683 		goto fail_clear;
684 	}
685 
686 	err = pstore_register(&cxt->pstore);
687 	if (err) {
688 		pr_err("registering with pstore failed\n");
689 		goto fail_buf;
690 	}
691 
692 	/*
693 	 * Update the module parameter variables as well so they are visible
694 	 * through /sys/module/ramoops/parameters/
695 	 */
696 	mem_size = pdata->mem_size;
697 	mem_address = pdata->mem_address;
698 	record_size = pdata->record_size;
699 	dump_oops = pdata->dump_oops;
700 	ramoops_console_size = pdata->console_size;
701 	ramoops_pmsg_size = pdata->pmsg_size;
702 	ramoops_ftrace_size = pdata->ftrace_size;
703 
704 	pr_info("attached 0x%lx@0x%llx, ecc: %d/%d\n",
705 		cxt->size, (unsigned long long)cxt->phys_addr,
706 		cxt->ecc_info.ecc_size, cxt->ecc_info.block_size);
707 
708 	return 0;
709 
710 fail_buf:
711 	kfree(cxt->pstore.buf);
712 fail_clear:
713 	cxt->pstore.bufsize = 0;
714 	kfree(cxt->mprz);
715 fail_init_mprz:
716 	kfree(cxt->fprz);
717 fail_init_fprz:
718 	kfree(cxt->cprz);
719 fail_init_cprz:
720 	ramoops_free_przs(cxt);
721 fail_out:
722 	return err;
723 }
724 
ramoops_remove(struct platform_device * pdev)725 static int ramoops_remove(struct platform_device *pdev)
726 {
727 	struct ramoops_context *cxt = &oops_cxt;
728 
729 	pstore_unregister(&cxt->pstore);
730 
731 	kfree(cxt->pstore.buf);
732 	cxt->pstore.bufsize = 0;
733 
734 	persistent_ram_free(cxt->mprz);
735 	persistent_ram_free(cxt->fprz);
736 	persistent_ram_free(cxt->cprz);
737 	ramoops_free_przs(cxt);
738 
739 	return 0;
740 }
741 
742 static const struct of_device_id dt_match[] = {
743 	{ .compatible = "ramoops" },
744 	{}
745 };
746 
747 static struct platform_driver ramoops_driver = {
748 	.probe		= ramoops_probe,
749 	.remove		= ramoops_remove,
750 	.driver		= {
751 		.name		= "ramoops",
752 		.of_match_table	= dt_match,
753 	},
754 };
755 
ramoops_register_dummy(void)756 static void ramoops_register_dummy(void)
757 {
758 	if (!mem_size)
759 		return;
760 
761 	pr_info("using module parameters\n");
762 
763 	dummy_data = kzalloc(sizeof(*dummy_data), GFP_KERNEL);
764 	if (!dummy_data) {
765 		pr_info("could not allocate pdata\n");
766 		return;
767 	}
768 
769 	dummy_data->mem_size = mem_size;
770 	dummy_data->mem_address = mem_address;
771 	dummy_data->mem_type = mem_type;
772 	dummy_data->record_size = record_size;
773 	dummy_data->console_size = ramoops_console_size;
774 	dummy_data->ftrace_size = ramoops_ftrace_size;
775 	dummy_data->pmsg_size = ramoops_pmsg_size;
776 	dummy_data->dump_oops = dump_oops;
777 	/*
778 	 * For backwards compatibility ramoops.ecc=1 means 16 bytes ECC
779 	 * (using 1 byte for ECC isn't much of use anyway).
780 	 */
781 	dummy_data->ecc_info.ecc_size = ramoops_ecc == 1 ? 16 : ramoops_ecc;
782 
783 	dummy = platform_device_register_data(NULL, "ramoops", -1,
784 			dummy_data, sizeof(struct ramoops_platform_data));
785 	if (IS_ERR(dummy)) {
786 		pr_info("could not create platform device: %ld\n",
787 			PTR_ERR(dummy));
788 	}
789 }
790 
ramoops_init(void)791 static int __init ramoops_init(void)
792 {
793 	ramoops_register_dummy();
794 	return platform_driver_register(&ramoops_driver);
795 }
796 postcore_initcall(ramoops_init);
797 
ramoops_exit(void)798 static void __exit ramoops_exit(void)
799 {
800 	platform_driver_unregister(&ramoops_driver);
801 	platform_device_unregister(dummy);
802 	kfree(dummy_data);
803 }
804 module_exit(ramoops_exit);
805 
806 MODULE_LICENSE("GPL");
807 MODULE_AUTHOR("Marco Stornelli <marco.stornelli@gmail.com>");
808 MODULE_DESCRIPTION("RAM Oops/Panic logger/driver");
809