ram.c 24.3 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 32
#include <linux/time.h>
#include <linux/io.h>
#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 38
#include <linux/of.h>
#include <linux/of_address.h>
39 40

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

43 44 45 46
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");
47

48 49 50 51
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");

52 53 54 55
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");

56 57 58 59
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");

60 61
static unsigned long long mem_address;
module_param(mem_address, ullong, 0400);
62 63 64 65 66 67 68 69
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");

70 71 72 73 74
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)");

75 76 77 78 79
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 已提交
80 81 82
static int ramoops_ecc;
module_param_named(ecc, ramoops_ecc, int, 0600);
MODULE_PARM_DESC(ramoops_ecc,
83 84 85
		"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 已提交
86

K
Kees Cook 已提交
87
struct ramoops_context {
88 89 90 91
	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 */
92 93
	phys_addr_t phys_addr;
	unsigned long size;
94
	unsigned int memtype;
K
Kees Cook 已提交
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
	u32 flags;
101
	struct persistent_ram_ecc_info ecc_info;
102 103
	unsigned int max_dump_cnt;
	unsigned int dump_write_cnt;
104
	/* _read_cnt need clear on ramoops_pstore_open */
105
	unsigned int dump_read_cnt;
106
	unsigned int console_read_cnt;
107
	unsigned int max_ftrace_cnt;
108
	unsigned int ftrace_read_cnt;
109
	unsigned int pmsg_read_cnt;
K
Kees Cook 已提交
110 111
	struct pstore_info pstore;
};
112

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

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

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

127 128 129 130 131 132 133 134 135 136 137 138 139
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)++;

	if (i >= max)
		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 timespec *time,
157 158 159
				  bool *compressed)
{
	char data_type;
160
	int header_length = 0;
161

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

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

185 186 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
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;
}

K
Kees Cook 已提交
237
static ssize_t ramoops_pstore_read(u64 *id, enum pstore_type_id *type,
238
				   int *count, struct timespec *time,
239
				   char **buf, bool *compressed,
240
				   ssize_t *ecc_notice_size,
241
				   struct pstore_info *psi)
242
{
243
	ssize_t size = 0;
K
Kees Cook 已提交
244
	struct ramoops_context *cxt = psi->data;
245 246
	struct persistent_ram_zone *prz = NULL;
	int header_length = 0;
247
	bool free_prz = false;
248 249 250 251 252 253 254 255 256 257 258

	/* Ramoops headers provide time stamps for PSTORE_TYPE_DMESG, but
	 * PSTORE_TYPE_CONSOLE and PSTORE_TYPE_FTRACE don't currently have
	 * valid time stamps, so it is initialized to zero.
	 */
	time->tv_sec = 0;
	time->tv_nsec = 0;
	*compressed = false;

	/* Find the next valid persistent_ram_zone for DMESG */
	while (cxt->dump_read_cnt < cxt->max_dump_cnt && !prz) {
259
		prz = ramoops_get_next_prz(cxt->dprzs, &cxt->dump_read_cnt,
260 261 262 263 264 265 266 267 268 269 270 271 272
					   cxt->max_dump_cnt, id, type,
					   PSTORE_TYPE_DMESG, 1);
		if (!prz_ok(prz))
			continue;
		header_length = ramoops_read_kmsg_hdr(persistent_ram_old(prz),
						      time, compressed);
		/* 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 已提交
273

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

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

	/* ftrace is last since it may want to dynamically allocate memory. */
283
	if (!prz_ok(prz) && cxt->fprzs) {
284
		if (!(cxt->flags & RAMOOPS_FLAG_FTRACE_PER_CPU)) {
285
			prz = ramoops_get_next_prz(cxt->fprzs,
286
					&cxt->ftrace_read_cnt, 1, id, type,
287
					PSTORE_TYPE_FTRACE, 0);
288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319
		} 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,
						cxt->max_ftrace_cnt, id,
						type, PSTORE_TYPE_FTRACE, 0);

				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;
			}
			*id = 0;
			prz = tmp_prz;
320 321 322
		}
	}

323 324 325 326
	if (!prz_ok(prz)) {
		size = 0;
		goto out;
	}
327

328
	size = persistent_ram_old_size(prz) - header_length;
329 330

	/* ECC correction notice */
331
	*ecc_notice_size = persistent_ram_ecc_string(prz, NULL, 0);
332

333
	*buf = kmalloc(size + *ecc_notice_size + 1, GFP_KERNEL);
334 335 336 337
	if (*buf == NULL) {
		size = -ENOMEM;
		goto out;
	}
K
Kees Cook 已提交
338

339
	memcpy(*buf, (char *)persistent_ram_old(prz) + header_length, size);
340

341
	persistent_ram_ecc_string(prz, *buf + size, *ecc_notice_size + 1);
342

343 344 345 346 347 348
out:
	if (free_prz) {
		kfree(prz->old_log);
		kfree(prz);
	}

349
	return size;
K
Kees Cook 已提交
350 351
}

352 353
static size_t ramoops_write_kmsg_hdr(struct persistent_ram_zone *prz,
				     bool compressed)
354 355
{
	char *hdr;
356
	struct timespec timestamp;
357 358
	size_t len;

359 360 361 362 363
	/* Report zeroed timestamp if called before timekeeping has resumed. */
	if (__getnstimeofday(&timestamp)) {
		timestamp.tv_sec = 0;
		timestamp.tv_nsec = 0;
	}
364 365 366
	hdr = kasprintf(GFP_ATOMIC, RAMOOPS_KERNMSG_HDR "%lu.%lu-%c\n",
		(long)timestamp.tv_sec, (long)(timestamp.tv_nsec / 1000),
		compressed ? 'C' : 'D');
367 368 369 370 371 372 373 374
	WARN_ON_ONCE(!hdr);
	len = hdr ? strlen(hdr) : 0;
	persistent_ram_write(prz, hdr, len);
	kfree(hdr);

	return len;
}

375 376 377
static int notrace ramoops_pstore_write_buf(enum pstore_type_id type,
					    enum kmsg_dump_reason reason,
					    u64 *id, unsigned int part,
378
					    const char *buf,
379
					    bool compressed, size_t size,
380
					    struct pstore_info *psi)
K
Kees Cook 已提交
381 382
{
	struct ramoops_context *cxt = psi->data;
383
	struct persistent_ram_zone *prz;
384
	size_t hlen;
K
Kees Cook 已提交
385

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

		if (!cxt->fprzs)
395
			return -ENOMEM;
396 397 398 399 400 401 402 403 404
		/*
		 * 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;

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

K
Kees Cook 已提交
411 412
	if (type != PSTORE_TYPE_DMESG)
		return -EINVAL;
413

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

K
Kees Cook 已提交
421
	/* Skip Oopes when configured to do so. */
422
	if (reason == KMSG_DUMP_OOPS && !cxt->dump_oops)
K
Kees Cook 已提交
423 424 425 426 427 428 429 430 431
		return -EINVAL;

	/* Explicitly only take the first part of any new crash.
	 * 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.
	 */
	if (part != 1)
		return -ENOSPC;
432

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

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

438
	hlen = ramoops_write_kmsg_hdr(prz, compressed);
439 440
	if (size + hlen > prz->buffer_size)
		size = prz->buffer_size - hlen;
441
	persistent_ram_write(prz, buf, size);
442

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

	return 0;
}

M
Mark Salyzyn 已提交
448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465
static int notrace 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)
{
	if (type == PSTORE_TYPE_PMSG) {
		struct ramoops_context *cxt = psi->data;

		if (!cxt->mprz)
			return -ENOMEM;
		return persistent_ram_write_user(cxt->mprz, buf, size);
	}

	return -EINVAL;
}

466
static int ramoops_pstore_erase(enum pstore_type_id type, u64 id, int count,
467
				struct timespec time, struct pstore_info *psi)
K
Kees Cook 已提交
468 469
{
	struct ramoops_context *cxt = psi->data;
470
	struct persistent_ram_zone *prz;
K
Kees Cook 已提交
471

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

493 494
	persistent_ram_free_old(prz);
	persistent_ram_zap(prz);
K
Kees Cook 已提交
495 496

	return 0;
497 498
}

K
Kees Cook 已提交
499 500 501 502 503 504
static struct ramoops_context oops_cxt = {
	.pstore = {
		.owner	= THIS_MODULE,
		.name	= "ramoops",
		.open	= ramoops_pstore_open,
		.read	= ramoops_pstore_read,
505
		.write_buf	= ramoops_pstore_write_buf,
M
Mark Salyzyn 已提交
506
		.write_buf_user	= ramoops_pstore_write_buf_user,
K
Kees Cook 已提交
507 508 509 510
		.erase	= ramoops_pstore_erase,
	},
};

511 512 513 514
static void ramoops_free_przs(struct ramoops_context *cxt)
{
	int i;

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

520
		kfree(cxt->dprzs);
521 522
		cxt->max_dump_cnt = 0;
	}
523

524 525 526 527 528 529 530
	/* 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;
	}
531 532
}

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

545 546 547
	/* Allocate nothing for 0 mem_sz or 0 record_size. */
	if (mem_sz == 0 || record_size == 0) {
		*cnt = 0;
548
		return 0;
549 550
	}

551 552 553 554 555 556 557 558 559
	/*
	 * 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;
560 561 562
		if (record_size == 0) {
			dev_err(dev, "%s record size == 0 (%zu / %u)\n",
				name, mem_sz, *cnt);
563
			goto fail;
564
		}
565 566
	} else {
		*cnt = mem_sz / record_size;
567 568 569
		if (*cnt == 0) {
			dev_err(dev, "%s record count == 0 (%zu / %zu)\n",
				name, mem_sz, record_size);
570
			goto fail;
571
		}
572
	}
573

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

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

	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,
594
						  &cxt->ecc_info,
595 596 597
						  cxt->memtype, flags);
		if (IS_ERR(prz_ar[i])) {
			err = PTR_ERR(prz_ar[i]);
598 599 600
			dev_err(dev, "failed to request %s mem region (0x%zx@0x%llx): %d\n",
				name, record_size,
				(unsigned long long)*paddr, err);
601 602 603

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

612
	*przs = prz_ar;
613
	return 0;
614 615 616

fail:
	*cnt = 0;
617 618 619
	return err;
}

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

628
	if (*paddr + sz - cxt->phys_addr > cxt->size) {
629 630
		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,
631
			cxt->size, (unsigned long long)cxt->phys_addr);
632
		return -ENOMEM;
633
	}
634

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

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

	persistent_ram_zap(*prz);

	*paddr += sz;

	return 0;
}

652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677
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;
678
	struct resource *res;
679 680 681 682 683
	u32 value;
	int ret;

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

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

691 692
	pdata->mem_size = resource_size(res);
	pdata->mem_address = res->start;
693 694 695 696 697 698 699 700 701 702 703 704 705 706 707
	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);
708
	parse_size("flags", pdata->flags);
709 710 711 712 713 714

#undef parse_size

	return 0;
}

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

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

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

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

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

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");
K
Kees Cook 已提交
756
		goto fail_out;
757 758
	}

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 766
	if (pdata->pmsg_size && !is_power_of_2(pdata->pmsg_size))
		pdata->pmsg_size = rounddown_pow_of_two(pdata->pmsg_size);
767

768 769
	cxt->size = pdata->mem_size;
	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;
778

779
	paddr = cxt->phys_addr;
780

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

789
	err = ramoops_init_prz("console", dev, cxt, &cxt->cprz, &paddr,
790
			       cxt->console_size, 0);
791 792 793
	if (err)
		goto fail_init_cprz;

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

805 806
	err = ramoops_init_prz("pmsg", dev, cxt, &cxt->mprz, &paddr,
				cxt->pmsg_size, 0);
807 808 809
	if (err)
		goto fail_init_mprz;

K
Kees Cook 已提交
810
	cxt->pstore.data = cxt;
811
	/*
812 813 814 815
	 * Console can handle any buffer size, so prefer LOG_LINE_MAX. If we
	 * have to handle dumps, we must have at least record_size buffer. And
	 * for ftrace, bufsize is irrelevant (if bufsize is 0, buf will be
	 * ZERO_SIZE_PTR).
816
	 */
817 818 819
	if (cxt->console_size)
		cxt->pstore.bufsize = 1024; /* LOG_LINE_MAX */
	cxt->pstore.bufsize = max(cxt->record_size, cxt->pstore.bufsize);
K
Kees Cook 已提交
820 821 822
	cxt->pstore.buf = kmalloc(cxt->pstore.bufsize, GFP_KERNEL);
	if (!cxt->pstore.buf) {
		pr_err("cannot allocate pstore buffer\n");
823
		err = -ENOMEM;
K
Kees Cook 已提交
824 825
		goto fail_clear;
	}
826
	spin_lock_init(&cxt->pstore.buf_lock);
K
Kees Cook 已提交
827

828 829 830 831 832 833 834
	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;
835

K
Kees Cook 已提交
836
	err = pstore_register(&cxt->pstore);
837
	if (err) {
K
Kees Cook 已提交
838
		pr_err("registering with pstore failed\n");
839
		goto fail_buf;
840 841
	}

842 843 844 845 846 847 848 849
	/*
	 * 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;
850 851 852
	ramoops_console_size = pdata->console_size;
	ramoops_pmsg_size = pdata->pmsg_size;
	ramoops_ftrace_size = pdata->ftrace_size;
853

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

858 859
	return 0;

K
Kees Cook 已提交
860 861 862 863
fail_buf:
	kfree(cxt->pstore.buf);
fail_clear:
	cxt->pstore.bufsize = 0;
864
	persistent_ram_free(cxt->mprz);
865
fail_init_mprz:
866
fail_init_fprz:
867
	persistent_ram_free(cxt->cprz);
868
fail_init_cprz:
869
	ramoops_free_przs(cxt);
K
Kees Cook 已提交
870
fail_out:
871 872 873
	return err;
}

G
Geliang Tang 已提交
874
static int ramoops_remove(struct platform_device *pdev)
875 876 877
{
	struct ramoops_context *cxt = &oops_cxt;

G
Geliang Tang 已提交
878
	pstore_unregister(&cxt->pstore);
K
Kees Cook 已提交
879 880 881 882

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

G
Geliang Tang 已提交
883 884 885 886
	persistent_ram_free(cxt->mprz);
	persistent_ram_free(cxt->cprz);
	ramoops_free_przs(cxt);

887
	return 0;
888 889
}

890 891 892 893 894
static const struct of_device_id dt_match[] = {
	{ .compatible = "ramoops" },
	{}
};

895
static struct platform_driver ramoops_driver = {
896
	.probe		= ramoops_probe,
G
Geliang Tang 已提交
897
	.remove		= ramoops_remove,
898
	.driver		= {
899 900
		.name		= "ramoops",
		.of_match_table	= dt_match,
901 902 903
	},
};

904
static void ramoops_register_dummy(void)
905
{
906 907 908 909 910 911 912 913 914
	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;
915 916
	}

917 918
	dummy_data->mem_size = mem_size;
	dummy_data->mem_address = mem_address;
919
	dummy_data->mem_type = mem_type;
920 921
	dummy_data->record_size = record_size;
	dummy_data->console_size = ramoops_console_size;
922
	dummy_data->ftrace_size = ramoops_ftrace_size;
923
	dummy_data->pmsg_size = ramoops_pmsg_size;
924
	dummy_data->dump_oops = dump_oops;
925 926
	dummy_data->flags = RAMOOPS_FLAG_FTRACE_PER_CPU;

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

	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));
	}
}

static int __init ramoops_init(void)
{
	ramoops_register_dummy();
	return platform_driver_register(&ramoops_driver);
945
}
946
postcore_initcall(ramoops_init);
947 948 949 950

static void __exit ramoops_exit(void)
{
	platform_driver_unregister(&ramoops_driver);
951
	platform_device_unregister(dummy);
952
	kfree(dummy_data);
953
}
954 955 956 957 958
module_exit(ramoops_exit);

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