ram.c 20.5 KB
Newer Older
1
2
3
4
/*
 * RAM Oops/Panic logger
 *
 * Copyright (C) 2010 Marco Stornelli <marco.stornelli@gmail.com>
Kees Cook's avatar
Kees Cook committed
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>
Kees Cook's avatar
Kees Cook committed
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)");

Anton Vorontsov's avatar
Anton Vorontsov committed
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)");
Anton Vorontsov's avatar
Anton Vorontsov committed
86

Kees Cook's avatar
Kees Cook committed
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
93
	phys_addr_t phys_addr;
	unsigned long size;
94
	unsigned int memtype;
Kees Cook's avatar
Kees Cook committed
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
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 ftrace_read_cnt;
107
	unsigned int pmsg_read_cnt;
Kees Cook's avatar
Kees Cook committed
108
109
	struct pstore_info pstore;
};
110

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

Kees Cook's avatar
Kees Cook committed
114
115
116
117
static int ramoops_pstore_open(struct pstore_info *psi)
{
	struct ramoops_context *cxt = psi->data;

118
	cxt->dump_read_cnt = 0;
119
	cxt->console_read_cnt = 0;
120
	cxt->ftrace_read_cnt = 0;
121
	cxt->pmsg_read_cnt = 0;
Kees Cook's avatar
Kees Cook committed
122
123
124
	return 0;
}

125
126
127
128
129
130
131
132
133
134
135
136
137
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];
138
139
	if (!prz)
		return NULL;
140

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

	if (!persistent_ram_old_size(prz))
		return NULL;
147
148
149
150
151
152
153

	*typep = type;
	*id = i;

	return prz;
}

154
static int ramoops_read_kmsg_hdr(char *buffer, struct timespec *time,
155
156
157
				  bool *compressed)
{
	char data_type;
158
	int header_length = 0;
159

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

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

Kees Cook's avatar
Kees Cook committed
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
				   ssize_t *ecc_notice_size,
187
				   struct pstore_info *psi)
188
{
Kees Cook's avatar
Kees Cook committed
189
190
	ssize_t size;
	struct ramoops_context *cxt = psi->data;
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
	struct persistent_ram_zone *prz = NULL;
	int header_length = 0;

	/* 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) {
		prz = ramoops_get_next_prz(cxt->przs, &cxt->dump_read_cnt,
					   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;
		}
	}
Kees Cook's avatar
Kees Cook committed
218

219
	if (!prz_ok(prz))
220
221
		prz = ramoops_get_next_prz(&cxt->cprz, &cxt->console_read_cnt,
					   1, id, type, PSTORE_TYPE_CONSOLE, 0);
222
	if (!prz_ok(prz))
223
224
		prz = ramoops_get_next_prz(&cxt->fprz, &cxt->ftrace_read_cnt,
					   1, id, type, PSTORE_TYPE_FTRACE, 0);
225
226
227
	if (!prz_ok(prz))
		prz = ramoops_get_next_prz(&cxt->mprz, &cxt->pmsg_read_cnt,
					   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);
Kees Cook's avatar
Kees Cook committed
237
238
239
	if (*buf == NULL)
		return -ENOMEM;

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;
Kees Cook's avatar
Kees Cook committed
244
245
}

246
247
static size_t ramoops_write_kmsg_hdr(struct persistent_ram_zone *prz,
				     bool compressed)
248
249
{
	char *hdr;
250
	struct timespec timestamp;
251
252
	size_t len;

253
254
255
256
257
	/* Report zeroed timestamp if called before timekeeping has resumed. */
	if (__getnstimeofday(&timestamp)) {
		timestamp.tv_sec = 0;
		timestamp.tv_nsec = 0;
	}
258
259
260
	hdr = kasprintf(GFP_ATOMIC, RAMOOPS_KERNMSG_HDR "%lu.%lu-%c\n",
		(long)timestamp.tv_sec, (long)(timestamp.tv_nsec / 1000),
		compressed ? 'C' : 'D');
261
262
263
264
265
266
267
268
	WARN_ON_ONCE(!hdr);
	len = hdr ? strlen(hdr) : 0;
	persistent_ram_write(prz, hdr, len);
	kfree(hdr);

	return len;
}

269
270
271
static int notrace ramoops_pstore_write_buf(enum pstore_type_id type,
					    enum kmsg_dump_reason reason,
					    u64 *id, unsigned int part,
272
					    const char *buf,
273
					    bool compressed, size_t size,
274
					    struct pstore_info *psi)
Kees Cook's avatar
Kees Cook committed
275
276
{
	struct ramoops_context *cxt = psi->data;
277
	struct persistent_ram_zone *prz;
278
	size_t hlen;
Kees Cook's avatar
Kees Cook committed
279

280
281
282
	if (type == PSTORE_TYPE_CONSOLE) {
		if (!cxt->cprz)
			return -ENOMEM;
283
		persistent_ram_write(cxt->cprz, buf, size);
284
		return 0;
285
286
287
288
289
	} else if (type == PSTORE_TYPE_FTRACE) {
		if (!cxt->fprz)
			return -ENOMEM;
		persistent_ram_write(cxt->fprz, buf, size);
		return 0;
290
	} else if (type == PSTORE_TYPE_PMSG) {
291
292
		pr_warn_ratelimited("PMSG shouldn't call %s\n", __func__);
		return -EINVAL;
293
294
	}

Kees Cook's avatar
Kees Cook committed
295
296
	if (type != PSTORE_TYPE_DMESG)
		return -EINVAL;
297

Kees Cook's avatar
Kees Cook committed
298
299
300
	/* Out of the various dmesg dump types, ramoops is currently designed
	 * to only store crash logs, rather than storing general kernel logs.
	 */
301
	if (reason != KMSG_DUMP_OOPS &&
WANG Cong's avatar
WANG Cong committed
302
	    reason != KMSG_DUMP_PANIC)
Kees Cook's avatar
Kees Cook committed
303
		return -EINVAL;
304

Kees Cook's avatar
Kees Cook committed
305
	/* Skip Oopes when configured to do so. */
306
	if (reason == KMSG_DUMP_OOPS && !cxt->dump_oops)
Kees Cook's avatar
Kees Cook committed
307
308
309
310
311
312
313
314
315
		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;
316

317
318
319
320
321
	if (!cxt->przs)
		return -ENOSPC;

	prz = cxt->przs[cxt->dump_write_cnt];

322
	hlen = ramoops_write_kmsg_hdr(prz, compressed);
323
324
	if (size + hlen > prz->buffer_size)
		size = prz->buffer_size - hlen;
325
	persistent_ram_write(prz, buf, size);
326

327
	cxt->dump_write_cnt = (cxt->dump_write_cnt + 1) % cxt->max_dump_cnt;
Kees Cook's avatar
Kees Cook committed
328
329
330
331

	return 0;
}

Mark Salyzyn's avatar
Mark Salyzyn committed
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
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;
}

350
static int ramoops_pstore_erase(enum pstore_type_id type, u64 id, int count,
351
				struct timespec time, struct pstore_info *psi)
Kees Cook's avatar
Kees Cook committed
352
353
{
	struct ramoops_context *cxt = psi->data;
354
	struct persistent_ram_zone *prz;
Kees Cook's avatar
Kees Cook committed
355

356
357
358
359
360
361
362
363
364
	switch (type) {
	case PSTORE_TYPE_DMESG:
		if (id >= cxt->max_dump_cnt)
			return -EINVAL;
		prz = cxt->przs[id];
		break;
	case PSTORE_TYPE_CONSOLE:
		prz = cxt->cprz;
		break;
365
366
367
	case PSTORE_TYPE_FTRACE:
		prz = cxt->fprz;
		break;
368
369
370
	case PSTORE_TYPE_PMSG:
		prz = cxt->mprz;
		break;
371
	default:
Kees Cook's avatar
Kees Cook committed
372
		return -EINVAL;
373
	}
Kees Cook's avatar
Kees Cook committed
374

375
376
	persistent_ram_free_old(prz);
	persistent_ram_zap(prz);
Kees Cook's avatar
Kees Cook committed
377
378

	return 0;
379
380
}

Kees Cook's avatar
Kees Cook committed
381
382
383
384
385
386
static struct ramoops_context oops_cxt = {
	.pstore = {
		.owner	= THIS_MODULE,
		.name	= "ramoops",
		.open	= ramoops_pstore_open,
		.read	= ramoops_pstore_read,
387
		.write_buf	= ramoops_pstore_write_buf,
Mark Salyzyn's avatar
Mark Salyzyn committed
388
		.write_buf_user	= ramoops_pstore_write_buf_user,
Kees Cook's avatar
Kees Cook committed
389
390
391
392
		.erase	= ramoops_pstore_erase,
	},
};

393
394
395
396
397
398
399
static void ramoops_free_przs(struct ramoops_context *cxt)
{
	int i;

	if (!cxt->przs)
		return;

400
	for (i = 0; i < cxt->max_dump_cnt; i++)
401
		persistent_ram_free(cxt->przs[i]);
402

403
	kfree(cxt->przs);
404
	cxt->max_dump_cnt = 0;
405
406
}

407
static int ramoops_init_przs(struct device *dev, struct ramoops_context *cxt,
408
409
410
411
			     struct persistent_ram_zone ***przs,
			     phys_addr_t *paddr, size_t mem_sz,
			     ssize_t record_size,
			     unsigned int *cnt, u32 sig, u32 flags)
412
413
414
{
	int err = -ENOMEM;
	int i;
415
416
	size_t zone_sz;
	struct persistent_ram_zone **prz_ar;
417

418
419
420
	/* Allocate nothing for 0 mem_sz or 0 record_size. */
	if (mem_sz == 0 || record_size == 0) {
		*cnt = 0;
421
		return 0;
422
423
	}

424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
	/*
	 * 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;
		if (record_size == 0)
			goto fail;
	} else {
		*cnt = mem_sz / record_size;
		if (*cnt == 0)
			goto fail;
	}
440

441
442
443
444
445
	if (*paddr + mem_sz - cxt->phys_addr > cxt->size) {
		dev_err(dev, "no room for mem region (0x%zx@0x%llx) in (0x%lx@0x%llx)\n",
			mem_sz, (unsigned long long)*paddr,
			cxt->size, (unsigned long long)cxt->phys_addr);
		goto fail;
446
447
	}

448
449
450
451
452
453
454
455
456
457
	zone_sz = mem_sz / *cnt;
	if (!zone_sz)
		goto fail;

	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,
458
						  &cxt->ecc_info,
459
460
461
						  cxt->memtype, flags);
		if (IS_ERR(prz_ar[i])) {
			err = PTR_ERR(prz_ar[i]);
462
			dev_err(dev, "failed to request mem region (0x%zx@0x%llx): %d\n",
463
				record_size, (unsigned long long)*paddr, err);
464
465
466

			while (i > 0) {
				i--;
467
				persistent_ram_free(prz_ar[i]);
468
			}
469
470
			kfree(prz_ar);
			goto fail;
471
		}
472
		*paddr += zone_sz;
473
474
	}

475
	*przs = prz_ar;
476
	return 0;
477
478
479

fail:
	*cnt = 0;
480
481
482
	return err;
}

483
484
485
static int ramoops_init_prz(struct device *dev, struct ramoops_context *cxt,
			    struct persistent_ram_zone **prz,
			    phys_addr_t *paddr, size_t sz, u32 sig)
486
487
488
489
{
	if (!sz)
		return 0;

490
491
492
493
	if (*paddr + sz - cxt->phys_addr > cxt->size) {
		dev_err(dev, "no room for mem region (0x%zx@0x%llx) in (0x%lx@0x%llx)\n",
			sz, (unsigned long long)*paddr,
			cxt->size, (unsigned long long)cxt->phys_addr);
494
		return -ENOMEM;
495
	}
496

497
498
	*prz = persistent_ram_new(*paddr, sz, sig, &cxt->ecc_info,
				  cxt->memtype, 0);
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
	if (IS_ERR(*prz)) {
		int err = PTR_ERR(*prz);

		dev_err(dev, "failed to request mem region (0x%zx@0x%llx): %d\n",
			sz, (unsigned long long)*paddr, err);
		return err;
	}

	persistent_ram_zap(*prz);

	*paddr += sz;

	return 0;
}

514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
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;
540
	struct resource *res;
541
542
543
544
545
	u32 value;
	int ret;

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

546
547
	res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
	if (!res) {
548
		dev_err(&pdev->dev,
549
550
			"failed to locate DT /reserved-memory resource\n");
		return -EINVAL;
551
552
	}

553
554
	pdata->mem_size = resource_size(res);
	pdata->mem_address = res->start;
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
	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);

#undef parse_size

	return 0;
}

576
static int ramoops_probe(struct platform_device *pdev)
577
{
578
	struct device *dev = &pdev->dev;
579
	struct ramoops_platform_data *pdata = dev->platform_data;
580
	struct ramoops_context *cxt = &oops_cxt;
581
582
	size_t dump_mem_sz;
	phys_addr_t paddr;
583
584
	int err = -EINVAL;

585
586
587
588
589
590
591
592
593
594
595
596
	if (dev_of_node(dev) && !pdata) {
		pdata = devm_kzalloc(&pdev->dev, sizeof(*pdata), GFP_KERNEL);
		if (!pdata) {
			err = -ENOMEM;
			goto fail_out;
		}

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

Kees Cook's avatar
Kees Cook committed
597
598
599
	/* Only a single ramoops area allowed at a time, so fail extra
	 * probes.
	 */
600
	if (cxt->max_dump_cnt)
Kees Cook's avatar
Kees Cook committed
601
602
		goto fail_out;

603
	if (!pdata->mem_size || (!pdata->record_size && !pdata->console_size &&
604
			!pdata->ftrace_size && !pdata->pmsg_size)) {
605
		pr_err("The memory size and the record/console size must be "
606
			"non-zero\n");
Kees Cook's avatar
Kees Cook committed
607
		goto fail_out;
608
609
	}

610
	if (pdata->record_size && !is_power_of_2(pdata->record_size))
611
		pdata->record_size = rounddown_pow_of_two(pdata->record_size);
612
	if (pdata->console_size && !is_power_of_2(pdata->console_size))
613
		pdata->console_size = rounddown_pow_of_two(pdata->console_size);
614
	if (pdata->ftrace_size && !is_power_of_2(pdata->ftrace_size))
615
		pdata->ftrace_size = rounddown_pow_of_two(pdata->ftrace_size);
616
617
	if (pdata->pmsg_size && !is_power_of_2(pdata->pmsg_size))
		pdata->pmsg_size = rounddown_pow_of_two(pdata->pmsg_size);
618

619
620
	cxt->size = pdata->mem_size;
	cxt->phys_addr = pdata->mem_address;
621
	cxt->memtype = pdata->mem_type;
622
	cxt->record_size = pdata->record_size;
623
	cxt->console_size = pdata->console_size;
624
	cxt->ftrace_size = pdata->ftrace_size;
625
	cxt->pmsg_size = pdata->pmsg_size;
626
	cxt->dump_oops = pdata->dump_oops;
627
	cxt->ecc_info = pdata->ecc_info;
628

629
	paddr = cxt->phys_addr;
630

631
632
	dump_mem_sz = cxt->size - cxt->console_size - cxt->ftrace_size
			- cxt->pmsg_size;
633
634
	err = ramoops_init_przs(dev, cxt, &cxt->przs, &paddr, dump_mem_sz,
				cxt->record_size, &cxt->max_dump_cnt, 0, 0);
635
636
637
	if (err)
		goto fail_out;

638
639
	err = ramoops_init_prz(dev, cxt, &cxt->cprz, &paddr,
			       cxt->console_size, 0);
640
641
642
	if (err)
		goto fail_init_cprz;

643
644
	err = ramoops_init_prz(dev, cxt, &cxt->fprz, &paddr, cxt->ftrace_size,
			       LINUX_VERSION_CODE);
645
646
647
	if (err)
		goto fail_init_fprz;

648
649
650
651
	err = ramoops_init_prz(dev, cxt, &cxt->mprz, &paddr, cxt->pmsg_size, 0);
	if (err)
		goto fail_init_mprz;

Kees Cook's avatar
Kees Cook committed
652
	cxt->pstore.data = cxt;
653
	/*
654
655
656
657
	 * 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).
658
	 */
659
660
661
	if (cxt->console_size)
		cxt->pstore.bufsize = 1024; /* LOG_LINE_MAX */
	cxt->pstore.bufsize = max(cxt->record_size, cxt->pstore.bufsize);
Kees Cook's avatar
Kees Cook committed
662
663
664
	cxt->pstore.buf = kmalloc(cxt->pstore.bufsize, GFP_KERNEL);
	if (!cxt->pstore.buf) {
		pr_err("cannot allocate pstore buffer\n");
665
		err = -ENOMEM;
Kees Cook's avatar
Kees Cook committed
666
667
		goto fail_clear;
	}
668
	spin_lock_init(&cxt->pstore.buf_lock);
Kees Cook's avatar
Kees Cook committed
669

670
671
672
673
674
675
676
	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;
677

Kees Cook's avatar
Kees Cook committed
678
	err = pstore_register(&cxt->pstore);
679
	if (err) {
Kees Cook's avatar
Kees Cook committed
680
		pr_err("registering with pstore failed\n");
681
		goto fail_buf;
682
683
	}

684
685
686
687
688
689
690
691
	/*
	 * 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;
692
693
694
	ramoops_console_size = pdata->console_size;
	ramoops_pmsg_size = pdata->pmsg_size;
	ramoops_ftrace_size = pdata->ftrace_size;
695

696
	pr_info("attached 0x%lx@0x%llx, ecc: %d/%d\n",
697
		cxt->size, (unsigned long long)cxt->phys_addr,
698
		cxt->ecc_info.ecc_size, cxt->ecc_info.block_size);
Kees Cook's avatar
Kees Cook committed
699

700
701
	return 0;

Kees Cook's avatar
Kees Cook committed
702
703
704
705
fail_buf:
	kfree(cxt->pstore.buf);
fail_clear:
	cxt->pstore.bufsize = 0;
706
	persistent_ram_free(cxt->mprz);
707
fail_init_mprz:
708
	persistent_ram_free(cxt->fprz);
709
fail_init_fprz:
710
	persistent_ram_free(cxt->cprz);
711
fail_init_cprz:
712
	ramoops_free_przs(cxt);
Kees Cook's avatar
Kees Cook committed
713
fail_out:
714
715
716
	return err;
}

Geliang Tang's avatar
Geliang Tang committed
717
static int ramoops_remove(struct platform_device *pdev)
718
719
720
{
	struct ramoops_context *cxt = &oops_cxt;

Geliang Tang's avatar
Geliang Tang committed
721
	pstore_unregister(&cxt->pstore);
Kees Cook's avatar
Kees Cook committed
722
723
724
725

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

Geliang Tang's avatar
Geliang Tang committed
726
727
728
729
730
	persistent_ram_free(cxt->mprz);
	persistent_ram_free(cxt->fprz);
	persistent_ram_free(cxt->cprz);
	ramoops_free_przs(cxt);

731
	return 0;
732
733
}

734
735
736
737
738
static const struct of_device_id dt_match[] = {
	{ .compatible = "ramoops" },
	{}
};

739
static struct platform_driver ramoops_driver = {
740
	.probe		= ramoops_probe,
Geliang Tang's avatar
Geliang Tang committed
741
	.remove		= ramoops_remove,
742
	.driver		= {
743
744
		.name		= "ramoops",
		.of_match_table	= dt_match,
745
746
747
	},
};

748
static void ramoops_register_dummy(void)
749
{
750
751
752
753
754
755
756
757
758
	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;
759
760
	}

761
762
	dummy_data->mem_size = mem_size;
	dummy_data->mem_address = mem_address;
763
	dummy_data->mem_type = mem_type;
764
765
	dummy_data->record_size = record_size;
	dummy_data->console_size = ramoops_console_size;
766
	dummy_data->ftrace_size = ramoops_ftrace_size;
767
	dummy_data->pmsg_size = ramoops_pmsg_size;
768
	dummy_data->dump_oops = dump_oops;
769
770
771
772
	/*
	 * For backwards compatibility ramoops.ecc=1 means 16 bytes ECC
	 * (using 1 byte for ECC isn't much of use anyway).
	 */
773
	dummy_data->ecc_info.ecc_size = ramoops_ecc == 1 ? 16 : ramoops_ecc;
774
775
776
777
778
779
780
781
782
783
784
785
786

	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);
787
}
788
postcore_initcall(ramoops_init);
789
790
791
792

static void __exit ramoops_exit(void)
{
	platform_driver_unregister(&ramoops_driver);
793
	platform_device_unregister(dummy);
794
	kfree(dummy_data);
795
}
796
797
798
799
800
module_exit(ramoops_exit);

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