ram.c 24.5 KB
Newer Older
1 2 3 4
/*
 * RAM Oops/Panic logger
 *
 * Copyright (C) 2010 Marco Stornelli <marco.stornelli@gmail.com>
K
Kees Cook 已提交
5
 * Copyright (C) 2011 Kees Cook <keescook@chromium.org>
6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * version 2 as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA
 *
 */

23 24
#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt

25
#include <linux/kernel.h>
26
#include <linux/err.h>
27
#include <linux/module.h>
28
#include <linux/version.h>
K
Kees Cook 已提交
29
#include <linux/pstore.h>
30 31
#include <linux/io.h>
#include <linux/ioport.h>
32
#include <linux/platform_device.h>
33
#include <linux/slab.h>
34
#include <linux/compiler.h>
35
#include <linux/pstore_ram.h>
36 37
#include <linux/of.h>
#include <linux/of_address.h>
38 39

#define RAMOOPS_KERNMSG_HDR "===="
40
#define MIN_MEM_SIZE 4096UL
41

42 43 44 45
static ulong record_size = MIN_MEM_SIZE;
module_param(record_size, ulong, 0400);
MODULE_PARM_DESC(record_size,
		"size of each dump done on oops/panic");
46

47 48 49 50
static ulong ramoops_console_size = MIN_MEM_SIZE;
module_param_named(console_size, ramoops_console_size, ulong, 0400);
MODULE_PARM_DESC(console_size, "size of kernel console log");

51 52 53 54
static ulong ramoops_ftrace_size = MIN_MEM_SIZE;
module_param_named(ftrace_size, ramoops_ftrace_size, ulong, 0400);
MODULE_PARM_DESC(ftrace_size, "size of ftrace log");

55 56 57 58
static ulong ramoops_pmsg_size = MIN_MEM_SIZE;
module_param_named(pmsg_size, ramoops_pmsg_size, ulong, 0400);
MODULE_PARM_DESC(pmsg_size, "size of user space message log");

59
static unsigned long long mem_address;
60
module_param_hw(mem_address, ullong, other, 0400);
61 62 63 64 65 66 67 68
MODULE_PARM_DESC(mem_address,
		"start of reserved RAM used to store oops/panic logs");

static ulong mem_size;
module_param(mem_size, ulong, 0400);
MODULE_PARM_DESC(mem_size,
		"size of reserved RAM used to store oops/panic logs");

69 70 71 72 73
static unsigned int mem_type;
module_param(mem_type, uint, 0600);
MODULE_PARM_DESC(mem_type,
		"set to 1 to try to use unbuffered memory (default 0)");

74 75 76 77 78
static int dump_oops = 1;
module_param(dump_oops, int, 0600);
MODULE_PARM_DESC(dump_oops,
		"set to 1 to dump oopses, 0 to only dump panics (default 1)");

A
Anton Vorontsov 已提交
79 80 81
static int ramoops_ecc;
module_param_named(ecc, ramoops_ecc, int, 0600);
MODULE_PARM_DESC(ramoops_ecc,
82 83 84
		"if non-zero, the option enables ECC support and specifies "
		"ECC buffer size in bytes (1 is a special value, means 16 "
		"bytes ECC)");
A
Anton Vorontsov 已提交
85

K
Kees Cook 已提交
86
struct ramoops_context {
87 88 89 90
	struct persistent_ram_zone **dprzs;	/* Oops dump zones */
	struct persistent_ram_zone *cprz;	/* Console zone */
	struct persistent_ram_zone **fprzs;	/* Ftrace zones */
	struct persistent_ram_zone *mprz;	/* PMSG zone */
91 92
	phys_addr_t phys_addr;
	unsigned long size;
93
	unsigned int memtype;
K
Kees Cook 已提交
94
	size_t record_size;
95
	size_t console_size;
96
	size_t ftrace_size;
97
	size_t pmsg_size;
98
	int dump_oops;
99
	u32 flags;
100
	struct persistent_ram_ecc_info ecc_info;
101 102
	unsigned int max_dump_cnt;
	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 max_ftrace_cnt;
107
	unsigned int ftrace_read_cnt;
108
	unsigned int pmsg_read_cnt;
K
Kees Cook 已提交
109 110
	struct pstore_info pstore;
};
111

112 113 114
static struct platform_device *dummy;
static struct ramoops_platform_data *dummy_data;

K
Kees Cook 已提交
115 116 117 118
static int ramoops_pstore_open(struct pstore_info *psi)
{
	struct ramoops_context *cxt = psi->data;

119
	cxt->dump_read_cnt = 0;
120
	cxt->console_read_cnt = 0;
121
	cxt->ftrace_read_cnt = 0;
122
	cxt->pmsg_read_cnt = 0;
K
Kees Cook 已提交
123 124 125
	return 0;
}

126 127 128 129 130 131 132 133 134
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)
{
	struct persistent_ram_zone *prz;
	int i = (*c)++;

135 136
	/* Give up if we never existed or have hit the end. */
	if (!przs || i >= max)
137 138 139
		return NULL;

	prz = przs[i];
140 141
	if (!prz)
		return NULL;
142

143 144
	/* Update old/shadowed buffer. */
	if (update)
145
		persistent_ram_save_old(prz);
146 147 148

	if (!persistent_ram_old_size(prz))
		return NULL;
149 150 151 152 153 154 155

	*typep = type;
	*id = i;

	return prz;
}

156
static int ramoops_read_kmsg_hdr(char *buffer, struct timespec64 *time,
157 158 159
				  bool *compressed)
{
	char data_type;
160
	int header_length = 0;
161

162 163
	if (sscanf(buffer, RAMOOPS_KERNMSG_HDR "%lld.%lu-%c\n%n",
		   (time64_t *)&time->tv_sec, &time->tv_nsec, &data_type,
164
		   &header_length) == 3) {
165 166 167 168
		if (data_type == 'C')
			*compressed = true;
		else
			*compressed = false;
169 170
	} else if (sscanf(buffer, RAMOOPS_KERNMSG_HDR "%lld.%lu\n%n",
			  (time64_t *)&time->tv_sec, &time->tv_nsec,
171 172
			  &header_length) == 2) {
		*compressed = false;
173 174 175 176 177
	} else {
		time->tv_sec = 0;
		time->tv_nsec = 0;
		*compressed = false;
	}
178
	return header_length;
179 180
}

181 182 183 184 185 186
static bool prz_ok(struct persistent_ram_zone *prz)
{
	return !!prz && !!(persistent_ram_old_size(prz) +
			   persistent_ram_ecc_string(prz, NULL, 0));
}

187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238
static ssize_t ftrace_log_combine(struct persistent_ram_zone *dest,
				  struct persistent_ram_zone *src)
{
	size_t dest_size, src_size, total, dest_off, src_off;
	size_t dest_idx = 0, src_idx = 0, merged_idx = 0;
	void *merged_buf;
	struct pstore_ftrace_record *drec, *srec, *mrec;
	size_t record_size = sizeof(struct pstore_ftrace_record);

	dest_off = dest->old_log_size % record_size;
	dest_size = dest->old_log_size - dest_off;

	src_off = src->old_log_size % record_size;
	src_size = src->old_log_size - src_off;

	total = dest_size + src_size;
	merged_buf = kmalloc(total, GFP_KERNEL);
	if (!merged_buf)
		return -ENOMEM;

	drec = (struct pstore_ftrace_record *)(dest->old_log + dest_off);
	srec = (struct pstore_ftrace_record *)(src->old_log + src_off);
	mrec = (struct pstore_ftrace_record *)(merged_buf);

	while (dest_size > 0 && src_size > 0) {
		if (pstore_ftrace_read_timestamp(&drec[dest_idx]) <
		    pstore_ftrace_read_timestamp(&srec[src_idx])) {
			mrec[merged_idx++] = drec[dest_idx++];
			dest_size -= record_size;
		} else {
			mrec[merged_idx++] = srec[src_idx++];
			src_size -= record_size;
		}
	}

	while (dest_size > 0) {
		mrec[merged_idx++] = drec[dest_idx++];
		dest_size -= record_size;
	}

	while (src_size > 0) {
		mrec[merged_idx++] = srec[src_idx++];
		src_size -= record_size;
	}

	kfree(dest->old_log);
	dest->old_log = merged_buf;
	dest->old_log_size = total;

	return 0;
}

239
static ssize_t ramoops_pstore_read(struct pstore_record *record)
240
{
241
	ssize_t size = 0;
242
	struct ramoops_context *cxt = record->psi->data;
243 244
	struct persistent_ram_zone *prz = NULL;
	int header_length = 0;
245
	bool free_prz = false;
246

247 248
	/*
	 * Ramoops headers provide time stamps for PSTORE_TYPE_DMESG, but
249 250 251
	 * PSTORE_TYPE_CONSOLE and PSTORE_TYPE_FTRACE don't currently have
	 * valid time stamps, so it is initialized to zero.
	 */
252 253 254
	record->time.tv_sec = 0;
	record->time.tv_nsec = 0;
	record->compressed = false;
255 256 257

	/* Find the next valid persistent_ram_zone for DMESG */
	while (cxt->dump_read_cnt < cxt->max_dump_cnt && !prz) {
258
		prz = ramoops_get_next_prz(cxt->dprzs, &cxt->dump_read_cnt,
259 260
					   cxt->max_dump_cnt, &record->id,
					   &record->type,
261 262 263 264
					   PSTORE_TYPE_DMESG, 1);
		if (!prz_ok(prz))
			continue;
		header_length = ramoops_read_kmsg_hdr(persistent_ram_old(prz),
265 266
						      &record->time,
						      &record->compressed);
267 268 269 270 271 272 273
		/* Clear and skip this DMESG record if it has no valid header */
		if (!header_length) {
			persistent_ram_free_old(prz);
			persistent_ram_zap(prz);
			prz = NULL;
		}
	}
K
Kees Cook 已提交
274

275
	if (!prz_ok(prz))
276
		prz = ramoops_get_next_prz(&cxt->cprz, &cxt->console_read_cnt,
277 278
					   1, &record->id, &record->type,
					   PSTORE_TYPE_CONSOLE, 0);
279 280 281

	if (!prz_ok(prz))
		prz = ramoops_get_next_prz(&cxt->mprz, &cxt->pmsg_read_cnt,
282 283
					   1, &record->id, &record->type,
					   PSTORE_TYPE_PMSG, 0);
284 285

	/* ftrace is last since it may want to dynamically allocate memory. */
286
	if (!prz_ok(prz)) {
287
		if (!(cxt->flags & RAMOOPS_FLAG_FTRACE_PER_CPU)) {
288
			prz = ramoops_get_next_prz(cxt->fprzs,
289 290
					&cxt->ftrace_read_cnt, 1, &record->id,
					&record->type, PSTORE_TYPE_FTRACE, 0);
291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306
		} else {
			/*
			 * Build a new dummy record which combines all the
			 * per-cpu records including metadata and ecc info.
			 */
			struct persistent_ram_zone *tmp_prz, *prz_next;

			tmp_prz = kzalloc(sizeof(struct persistent_ram_zone),
					  GFP_KERNEL);
			if (!tmp_prz)
				return -ENOMEM;
			free_prz = true;

			while (cxt->ftrace_read_cnt < cxt->max_ftrace_cnt) {
				prz_next = ramoops_get_next_prz(cxt->fprzs,
						&cxt->ftrace_read_cnt,
307 308 309 310
						cxt->max_ftrace_cnt,
						&record->id,
						&record->type,
						PSTORE_TYPE_FTRACE, 0);
311 312 313 314 315 316 317 318 319 320 321 322

				if (!prz_ok(prz_next))
					continue;

				tmp_prz->ecc_info = prz_next->ecc_info;
				tmp_prz->corrected_bytes +=
						prz_next->corrected_bytes;
				tmp_prz->bad_blocks += prz_next->bad_blocks;
				size = ftrace_log_combine(tmp_prz, prz_next);
				if (size)
					goto out;
			}
323
			record->id = 0;
324
			prz = tmp_prz;
325 326 327
		}
	}

328 329 330 331
	if (!prz_ok(prz)) {
		size = 0;
		goto out;
	}
332

333
	size = persistent_ram_old_size(prz) - header_length;
334 335

	/* ECC correction notice */
336
	record->ecc_notice_size = persistent_ram_ecc_string(prz, NULL, 0);
337

338 339
	record->buf = kmalloc(size + record->ecc_notice_size + 1, GFP_KERNEL);
	if (record->buf == NULL) {
340 341 342
		size = -ENOMEM;
		goto out;
	}
K
Kees Cook 已提交
343

344 345
	memcpy(record->buf, (char *)persistent_ram_old(prz) + header_length,
	       size);
346

347 348
	persistent_ram_ecc_string(prz, record->buf + size,
				  record->ecc_notice_size + 1);
349

350 351 352 353 354 355
out:
	if (free_prz) {
		kfree(prz->old_log);
		kfree(prz);
	}

356
	return size;
K
Kees Cook 已提交
357 358
}

359
static size_t ramoops_write_kmsg_hdr(struct persistent_ram_zone *prz,
360
				     struct pstore_record *record)
361 362 363 364
{
	char *hdr;
	size_t len;

365 366
	hdr = kasprintf(GFP_ATOMIC, RAMOOPS_KERNMSG_HDR "%lld.%06lu-%c\n",
		(time64_t)record->time.tv_sec,
367 368
		record->time.tv_nsec / 1000,
		record->compressed ? 'C' : 'D');
369 370 371 372 373 374 375 376
	WARN_ON_ONCE(!hdr);
	len = hdr ? strlen(hdr) : 0;
	persistent_ram_write(prz, hdr, len);
	kfree(hdr);

	return len;
}

K
Kees Cook 已提交
377
static int notrace ramoops_pstore_write(struct pstore_record *record)
K
Kees Cook 已提交
378
{
379
	struct ramoops_context *cxt = record->psi->data;
380
	struct persistent_ram_zone *prz;
381
	size_t size, hlen;
K
Kees Cook 已提交
382

383
	if (record->type == PSTORE_TYPE_CONSOLE) {
384 385
		if (!cxt->cprz)
			return -ENOMEM;
386
		persistent_ram_write(cxt->cprz, record->buf, record->size);
387
		return 0;
388
	} else if (record->type == PSTORE_TYPE_FTRACE) {
389 390 391
		int zonenum;

		if (!cxt->fprzs)
392
			return -ENOMEM;
393 394 395 396 397 398 399 400
		/*
		 * Choose zone by if we're using per-cpu buffers.
		 */
		if (cxt->flags & RAMOOPS_FLAG_FTRACE_PER_CPU)
			zonenum = smp_processor_id();
		else
			zonenum = 0;

401 402
		persistent_ram_write(cxt->fprzs[zonenum], record->buf,
				     record->size);
403
		return 0;
404
	} else if (record->type == PSTORE_TYPE_PMSG) {
405 406
		pr_warn_ratelimited("PMSG shouldn't call %s\n", __func__);
		return -EINVAL;
407 408
	}

409
	if (record->type != PSTORE_TYPE_DMESG)
K
Kees Cook 已提交
410
		return -EINVAL;
411

412 413
	/*
	 * Out of the various dmesg dump types, ramoops is currently designed
K
Kees Cook 已提交
414 415
	 * to only store crash logs, rather than storing general kernel logs.
	 */
416 417
	if (record->reason != KMSG_DUMP_OOPS &&
	    record->reason != KMSG_DUMP_PANIC)
K
Kees Cook 已提交
418
		return -EINVAL;
419

K
Kees Cook 已提交
420
	/* Skip Oopes when configured to do so. */
421
	if (record->reason == KMSG_DUMP_OOPS && !cxt->dump_oops)
K
Kees Cook 已提交
422 423
		return -EINVAL;

424 425
	/*
	 * Explicitly only take the first part of any new crash.
K
Kees Cook 已提交
426 427 428 429
	 * If our buffer is larger than kmsg_bytes, this can never happen,
	 * and if our buffer is smaller than kmsg_bytes, we don't want the
	 * report split across multiple records.
	 */
430
	if (record->part != 1)
K
Kees Cook 已提交
431
		return -ENOSPC;
432

433
	if (!cxt->dprzs)
434 435
		return -ENOSPC;

436
	prz = cxt->dprzs[cxt->dump_write_cnt];
437

438
	/* Build header and append record contents. */
439
	hlen = ramoops_write_kmsg_hdr(prz, record);
440
	size = record->size;
441 442
	if (size + hlen > prz->buffer_size)
		size = prz->buffer_size - hlen;
443
	persistent_ram_write(prz, record->buf, size);
444

445
	cxt->dump_write_cnt = (cxt->dump_write_cnt + 1) % cxt->max_dump_cnt;
K
Kees Cook 已提交
446 447 448 449

	return 0;
}

K
Kees Cook 已提交
450 451
static int notrace ramoops_pstore_write_user(struct pstore_record *record,
					     const char __user *buf)
M
Mark Salyzyn 已提交
452
{
453 454
	if (record->type == PSTORE_TYPE_PMSG) {
		struct ramoops_context *cxt = record->psi->data;
M
Mark Salyzyn 已提交
455 456 457

		if (!cxt->mprz)
			return -ENOMEM;
458
		return persistent_ram_write_user(cxt->mprz, buf, record->size);
M
Mark Salyzyn 已提交
459 460 461 462 463
	}

	return -EINVAL;
}

464
static int ramoops_pstore_erase(struct pstore_record *record)
K
Kees Cook 已提交
465
{
466
	struct ramoops_context *cxt = record->psi->data;
467
	struct persistent_ram_zone *prz;
K
Kees Cook 已提交
468

469
	switch (record->type) {
470
	case PSTORE_TYPE_DMESG:
471
		if (record->id >= cxt->max_dump_cnt)
472
			return -EINVAL;
473
		prz = cxt->dprzs[record->id];
474 475 476 477
		break;
	case PSTORE_TYPE_CONSOLE:
		prz = cxt->cprz;
		break;
478
	case PSTORE_TYPE_FTRACE:
479
		if (record->id >= cxt->max_ftrace_cnt)
480
			return -EINVAL;
481
		prz = cxt->fprzs[record->id];
482
		break;
483 484 485
	case PSTORE_TYPE_PMSG:
		prz = cxt->mprz;
		break;
486
	default:
K
Kees Cook 已提交
487
		return -EINVAL;
488
	}
K
Kees Cook 已提交
489

490 491
	persistent_ram_free_old(prz);
	persistent_ram_zap(prz);
K
Kees Cook 已提交
492 493

	return 0;
494 495
}

K
Kees Cook 已提交
496 497 498 499 500 501
static struct ramoops_context oops_cxt = {
	.pstore = {
		.owner	= THIS_MODULE,
		.name	= "ramoops",
		.open	= ramoops_pstore_open,
		.read	= ramoops_pstore_read,
K
Kees Cook 已提交
502 503
		.write	= ramoops_pstore_write,
		.write_user	= ramoops_pstore_write_user,
K
Kees Cook 已提交
504 505 506 507
		.erase	= ramoops_pstore_erase,
	},
};

508 509 510 511
static void ramoops_free_przs(struct ramoops_context *cxt)
{
	int i;

512
	/* Free dump PRZs */
513
	if (cxt->dprzs) {
514
		for (i = 0; i < cxt->max_dump_cnt; i++)
515
			persistent_ram_free(cxt->dprzs[i]);
516

517
		kfree(cxt->dprzs);
518 519
		cxt->max_dump_cnt = 0;
	}
520

521 522 523 524 525 526 527
	/* Free ftrace PRZs */
	if (cxt->fprzs) {
		for (i = 0; i < cxt->max_ftrace_cnt; i++)
			persistent_ram_free(cxt->fprzs[i]);
		kfree(cxt->fprzs);
		cxt->max_ftrace_cnt = 0;
	}
528 529
}

530 531
static int ramoops_init_przs(const char *name,
			     struct device *dev, struct ramoops_context *cxt,
532 533 534 535
			     struct persistent_ram_zone ***przs,
			     phys_addr_t *paddr, size_t mem_sz,
			     ssize_t record_size,
			     unsigned int *cnt, u32 sig, u32 flags)
536 537 538
{
	int err = -ENOMEM;
	int i;
539 540
	size_t zone_sz;
	struct persistent_ram_zone **prz_ar;
541

542 543 544
	/* Allocate nothing for 0 mem_sz or 0 record_size. */
	if (mem_sz == 0 || record_size == 0) {
		*cnt = 0;
545
		return 0;
546 547
	}

548 549 550 551 552 553 554 555 556
	/*
	 * If we have a negative record size, calculate it based on
	 * mem_sz / *cnt. If we have a positive record size, calculate
	 * cnt from mem_sz / record_size.
	 */
	if (record_size < 0) {
		if (*cnt == 0)
			return 0;
		record_size = mem_sz / *cnt;
557 558 559
		if (record_size == 0) {
			dev_err(dev, "%s record size == 0 (%zu / %u)\n",
				name, mem_sz, *cnt);
560
			goto fail;
561
		}
562 563
	} else {
		*cnt = mem_sz / record_size;
564 565 566
		if (*cnt == 0) {
			dev_err(dev, "%s record count == 0 (%zu / %zu)\n",
				name, mem_sz, record_size);
567
			goto fail;
568
		}
569
	}
570

571
	if (*paddr + mem_sz - cxt->phys_addr > cxt->size) {
572 573
		dev_err(dev, "no room for %s mem region (0x%zx@0x%llx) in (0x%lx@0x%llx)\n",
			name,
574 575 576
			mem_sz, (unsigned long long)*paddr,
			cxt->size, (unsigned long long)cxt->phys_addr);
		goto fail;
577 578
	}

579
	zone_sz = mem_sz / *cnt;
580 581
	if (!zone_sz) {
		dev_err(dev, "%s zone size == 0\n", name);
582
		goto fail;
583
	}
584 585 586 587 588 589 590

	prz_ar = kcalloc(*cnt, sizeof(**przs), GFP_KERNEL);
	if (!prz_ar)
		goto fail;

	for (i = 0; i < *cnt; i++) {
		prz_ar[i] = persistent_ram_new(*paddr, zone_sz, sig,
591
						  &cxt->ecc_info,
592 593 594
						  cxt->memtype, flags);
		if (IS_ERR(prz_ar[i])) {
			err = PTR_ERR(prz_ar[i]);
595 596 597
			dev_err(dev, "failed to request %s mem region (0x%zx@0x%llx): %d\n",
				name, record_size,
				(unsigned long long)*paddr, err);
598 599 600

			while (i > 0) {
				i--;
601
				persistent_ram_free(prz_ar[i]);
602
			}
603 604
			kfree(prz_ar);
			goto fail;
605
		}
606
		*paddr += zone_sz;
607 608
	}

609
	*przs = prz_ar;
610
	return 0;
611 612 613

fail:
	*cnt = 0;
614 615 616
	return err;
}

617 618
static int ramoops_init_prz(const char *name,
			    struct device *dev, struct ramoops_context *cxt,
619 620
			    struct persistent_ram_zone **prz,
			    phys_addr_t *paddr, size_t sz, u32 sig)
621 622 623 624
{
	if (!sz)
		return 0;

625
	if (*paddr + sz - cxt->phys_addr > cxt->size) {
626 627
		dev_err(dev, "no room for %s mem region (0x%zx@0x%llx) in (0x%lx@0x%llx)\n",
			name, sz, (unsigned long long)*paddr,
628
			cxt->size, (unsigned long long)cxt->phys_addr);
629
		return -ENOMEM;
630
	}
631

632 633
	*prz = persistent_ram_new(*paddr, sz, sig, &cxt->ecc_info,
				  cxt->memtype, 0);
634 635 636
	if (IS_ERR(*prz)) {
		int err = PTR_ERR(*prz);

637 638
		dev_err(dev, "failed to request %s mem region (0x%zx@0x%llx): %d\n",
			name, sz, (unsigned long long)*paddr, err);
639 640 641 642 643 644 645 646 647 648
		return err;
	}

	persistent_ram_zap(*prz);

	*paddr += sz;

	return 0;
}

649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674
static int ramoops_parse_dt_size(struct platform_device *pdev,
				 const char *propname, u32 *value)
{
	u32 val32 = 0;
	int ret;

	ret = of_property_read_u32(pdev->dev.of_node, propname, &val32);
	if (ret < 0 && ret != -EINVAL) {
		dev_err(&pdev->dev, "failed to parse property %s: %d\n",
			propname, ret);
		return ret;
	}

	if (val32 > INT_MAX) {
		dev_err(&pdev->dev, "%s %u > INT_MAX\n", propname, val32);
		return -EOVERFLOW;
	}

	*value = val32;
	return 0;
}

static int ramoops_parse_dt(struct platform_device *pdev,
			    struct ramoops_platform_data *pdata)
{
	struct device_node *of_node = pdev->dev.of_node;
675
	struct resource *res;
676 677 678 679 680
	u32 value;
	int ret;

	dev_dbg(&pdev->dev, "using Device Tree\n");

681 682
	res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
	if (!res) {
683
		dev_err(&pdev->dev,
684 685
			"failed to locate DT /reserved-memory resource\n");
		return -EINVAL;
686 687
	}

688 689
	pdata->mem_size = resource_size(res);
	pdata->mem_address = res->start;
690 691 692 693 694 695 696 697 698 699 700 701 702 703 704
	pdata->mem_type = of_property_read_bool(of_node, "unbuffered");
	pdata->dump_oops = !of_property_read_bool(of_node, "no-dump-oops");

#define parse_size(name, field) {					\
		ret = ramoops_parse_dt_size(pdev, name, &value);	\
		if (ret < 0)						\
			return ret;					\
		field = value;						\
	}

	parse_size("record-size", pdata->record_size);
	parse_size("console-size", pdata->console_size);
	parse_size("ftrace-size", pdata->ftrace_size);
	parse_size("pmsg-size", pdata->pmsg_size);
	parse_size("ecc-size", pdata->ecc_info.ecc_size);
705
	parse_size("flags", pdata->flags);
706 707 708 709 710 711

#undef parse_size

	return 0;
}

712
static int ramoops_probe(struct platform_device *pdev)
713
{
714
	struct device *dev = &pdev->dev;
715
	struct ramoops_platform_data *pdata = dev->platform_data;
716
	struct ramoops_context *cxt = &oops_cxt;
717 718
	size_t dump_mem_sz;
	phys_addr_t paddr;
719 720
	int err = -EINVAL;

721 722 723
	if (dev_of_node(dev) && !pdata) {
		pdata = devm_kzalloc(&pdev->dev, sizeof(*pdata), GFP_KERNEL);
		if (!pdata) {
724
			pr_err("cannot allocate platform data buffer\n");
725 726 727 728 729 730 731 732 733
			err = -ENOMEM;
			goto fail_out;
		}

		err = ramoops_parse_dt(pdev, pdata);
		if (err < 0)
			goto fail_out;
	}

734 735
	/*
	 * Only a single ramoops area allowed at a time, so fail extra
K
Kees Cook 已提交
736 737
	 * probes.
	 */
738 739
	if (cxt->max_dump_cnt) {
		pr_err("already initialized\n");
K
Kees Cook 已提交
740
		goto fail_out;
741 742 743 744 745 746 747
	}

	/* Make sure we didn't get bogus platform data pointer. */
	if (!pdata) {
		pr_err("NULL platform data\n");
		goto fail_out;
	}
K
Kees Cook 已提交
748

749
	if (!pdata->mem_size || (!pdata->record_size && !pdata->console_size &&
750
			!pdata->ftrace_size && !pdata->pmsg_size)) {
751
		pr_err("The memory size and the record/console size must be "
752
			"non-zero\n");
K
Kees Cook 已提交
753
		goto fail_out;
754 755
	}

756
	if (pdata->record_size && !is_power_of_2(pdata->record_size))
757
		pdata->record_size = rounddown_pow_of_two(pdata->record_size);
758
	if (pdata->console_size && !is_power_of_2(pdata->console_size))
759
		pdata->console_size = rounddown_pow_of_two(pdata->console_size);
760
	if (pdata->ftrace_size && !is_power_of_2(pdata->ftrace_size))
761
		pdata->ftrace_size = rounddown_pow_of_two(pdata->ftrace_size);
762 763
	if (pdata->pmsg_size && !is_power_of_2(pdata->pmsg_size))
		pdata->pmsg_size = rounddown_pow_of_two(pdata->pmsg_size);
764

765 766
	cxt->size = pdata->mem_size;
	cxt->phys_addr = pdata->mem_address;
767
	cxt->memtype = pdata->mem_type;
768
	cxt->record_size = pdata->record_size;
769
	cxt->console_size = pdata->console_size;
770
	cxt->ftrace_size = pdata->ftrace_size;
771
	cxt->pmsg_size = pdata->pmsg_size;
772
	cxt->dump_oops = pdata->dump_oops;
773
	cxt->flags = pdata->flags;
774
	cxt->ecc_info = pdata->ecc_info;
775

776
	paddr = cxt->phys_addr;
777

778 779
	dump_mem_sz = cxt->size - cxt->console_size - cxt->ftrace_size
			- cxt->pmsg_size;
780
	err = ramoops_init_przs("dump", dev, cxt, &cxt->dprzs, &paddr,
781 782
				dump_mem_sz, cxt->record_size,
				&cxt->max_dump_cnt, 0, 0);
783 784 785
	if (err)
		goto fail_out;

786
	err = ramoops_init_prz("console", dev, cxt, &cxt->cprz, &paddr,
787
			       cxt->console_size, 0);
788 789 790
	if (err)
		goto fail_init_cprz;

791 792 793
	cxt->max_ftrace_cnt = (cxt->flags & RAMOOPS_FLAG_FTRACE_PER_CPU)
				? nr_cpu_ids
				: 1;
794 795 796
	err = ramoops_init_przs("ftrace", dev, cxt, &cxt->fprzs, &paddr,
				cxt->ftrace_size, -1,
				&cxt->max_ftrace_cnt, LINUX_VERSION_CODE,
797 798
				(cxt->flags & RAMOOPS_FLAG_FTRACE_PER_CPU)
					? PRZ_FLAG_NO_LOCK : 0);
799 800 801
	if (err)
		goto fail_init_fprz;

802 803
	err = ramoops_init_prz("pmsg", dev, cxt, &cxt->mprz, &paddr,
				cxt->pmsg_size, 0);
804 805 806
	if (err)
		goto fail_init_mprz;

K
Kees Cook 已提交
807
	cxt->pstore.data = cxt;
808
	/*
809 810 811
	 * Since bufsize is only used for dmesg crash dumps, it
	 * must match the size of the dprz record (after PRZ header
	 * and ECC bytes have been accounted for).
812
	 */
813 814
	cxt->pstore.bufsize = cxt->dprzs[0]->buffer_size;
	cxt->pstore.buf = kzalloc(cxt->pstore.bufsize, GFP_KERNEL);
K
Kees Cook 已提交
815
	if (!cxt->pstore.buf) {
816
		pr_err("cannot allocate pstore crash dump buffer\n");
817
		err = -ENOMEM;
K
Kees Cook 已提交
818 819
		goto fail_clear;
	}
820
	spin_lock_init(&cxt->pstore.buf_lock);
K
Kees Cook 已提交
821

822 823 824 825 826 827 828
	cxt->pstore.flags = PSTORE_FLAGS_DMESG;
	if (cxt->console_size)
		cxt->pstore.flags |= PSTORE_FLAGS_CONSOLE;
	if (cxt->ftrace_size)
		cxt->pstore.flags |= PSTORE_FLAGS_FTRACE;
	if (cxt->pmsg_size)
		cxt->pstore.flags |= PSTORE_FLAGS_PMSG;
829

K
Kees Cook 已提交
830
	err = pstore_register(&cxt->pstore);
831
	if (err) {
K
Kees Cook 已提交
832
		pr_err("registering with pstore failed\n");
833
		goto fail_buf;
834 835
	}

836 837 838 839 840 841 842 843
	/*
	 * Update the module parameter variables as well so they are visible
	 * through /sys/module/ramoops/parameters/
	 */
	mem_size = pdata->mem_size;
	mem_address = pdata->mem_address;
	record_size = pdata->record_size;
	dump_oops = pdata->dump_oops;
844 845 846
	ramoops_console_size = pdata->console_size;
	ramoops_pmsg_size = pdata->pmsg_size;
	ramoops_ftrace_size = pdata->ftrace_size;
847

848
	pr_info("attached 0x%lx@0x%llx, ecc: %d/%d\n",
849
		cxt->size, (unsigned long long)cxt->phys_addr,
850
		cxt->ecc_info.ecc_size, cxt->ecc_info.block_size);
K
Kees Cook 已提交
851

852 853
	return 0;

K
Kees Cook 已提交
854 855 856 857
fail_buf:
	kfree(cxt->pstore.buf);
fail_clear:
	cxt->pstore.bufsize = 0;
858
	persistent_ram_free(cxt->mprz);
859
fail_init_mprz:
860
fail_init_fprz:
861
	persistent_ram_free(cxt->cprz);
862
fail_init_cprz:
863
	ramoops_free_przs(cxt);
K
Kees Cook 已提交
864
fail_out:
865 866 867
	return err;
}

G
Geliang Tang 已提交
868
static int ramoops_remove(struct platform_device *pdev)
869 870 871
{
	struct ramoops_context *cxt = &oops_cxt;

G
Geliang Tang 已提交
872
	pstore_unregister(&cxt->pstore);
K
Kees Cook 已提交
873 874 875 876

	kfree(cxt->pstore.buf);
	cxt->pstore.bufsize = 0;

G
Geliang Tang 已提交
877 878 879 880
	persistent_ram_free(cxt->mprz);
	persistent_ram_free(cxt->cprz);
	ramoops_free_przs(cxt);

881
	return 0;
882 883
}

884 885 886 887 888
static const struct of_device_id dt_match[] = {
	{ .compatible = "ramoops" },
	{}
};

889
static struct platform_driver ramoops_driver = {
890
	.probe		= ramoops_probe,
G
Geliang Tang 已提交
891
	.remove		= ramoops_remove,
892
	.driver		= {
893 894
		.name		= "ramoops",
		.of_match_table	= dt_match,
895 896 897
	},
};

898
static inline void ramoops_unregister_dummy(void)
899
{
900 901 902 903 904 905 906 907 908 909 910 911 912 913
	platform_device_unregister(dummy);
	dummy = NULL;

	kfree(dummy_data);
	dummy_data = NULL;
}

static void __init ramoops_register_dummy(void)
{
	/*
	 * Prepare a dummy platform data structure to carry the module
	 * parameters. If mem_size isn't set, then there are no module
	 * parameters, and we can skip this.
	 */
914 915 916 917 918 919 920 921 922
	if (!mem_size)
		return;

	pr_info("using module parameters\n");

	dummy_data = kzalloc(sizeof(*dummy_data), GFP_KERNEL);
	if (!dummy_data) {
		pr_info("could not allocate pdata\n");
		return;
923 924
	}

925 926
	dummy_data->mem_size = mem_size;
	dummy_data->mem_address = mem_address;
927
	dummy_data->mem_type = mem_type;
928 929
	dummy_data->record_size = record_size;
	dummy_data->console_size = ramoops_console_size;
930
	dummy_data->ftrace_size = ramoops_ftrace_size;
931
	dummy_data->pmsg_size = ramoops_pmsg_size;
932
	dummy_data->dump_oops = dump_oops;
933 934
	dummy_data->flags = RAMOOPS_FLAG_FTRACE_PER_CPU;

935 936 937 938
	/*
	 * For backwards compatibility ramoops.ecc=1 means 16 bytes ECC
	 * (using 1 byte for ECC isn't much of use anyway).
	 */
939
	dummy_data->ecc_info.ecc_size = ramoops_ecc == 1 ? 16 : ramoops_ecc;
940 941 942 943 944 945

	dummy = platform_device_register_data(NULL, "ramoops", -1,
			dummy_data, sizeof(struct ramoops_platform_data));
	if (IS_ERR(dummy)) {
		pr_info("could not create platform device: %ld\n",
			PTR_ERR(dummy));
946 947
		dummy = NULL;
		ramoops_unregister_dummy();
948 949 950 951 952
	}
}

static int __init ramoops_init(void)
{
953 954
	int ret;

955
	ramoops_register_dummy();
956 957 958 959 960
	ret = platform_driver_register(&ramoops_driver);
	if (ret != 0)
		ramoops_unregister_dummy();

	return ret;
961
}
G
Geliang Tang 已提交
962
late_initcall(ramoops_init);
963 964 965 966

static void __exit ramoops_exit(void)
{
	platform_driver_unregister(&ramoops_driver);
967
	ramoops_unregister_dummy();
968
}
969 970 971 972 973
module_exit(ramoops_exit);

MODULE_LICENSE("GPL");
MODULE_AUTHOR("Marco Stornelli <marco.stornelli@gmail.com>");
MODULE_DESCRIPTION("RAM Oops/Panic logger/driver");