]> git.ipfire.org Git - thirdparty/kernel/stable.git/blame - drivers/mtd/mtdoops.c
Merge git://git.kernel.org/pub/scm/linux/kernel/git/davem/net
[thirdparty/kernel/stable.git] / drivers / mtd / mtdoops.c
CommitLineData
4b23aff0
RP
1/*
2 * MTD Oops/Panic logger
3 *
a1452a37 4 * Copyright © 2007 Nokia Corporation. All rights reserved.
4b23aff0
RP
5 *
6 * Author: Richard Purdie <rpurdie@openedhand.com>
7 *
8 * This program is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU General Public License
10 * version 2 as published by the Free Software Foundation.
11 *
12 * This program is distributed in the hope that it will be useful, but
13 * WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
20 * 02110-1301 USA
21 *
22 */
23
24#include <linux/kernel.h>
25#include <linux/module.h>
26#include <linux/console.h>
27#include <linux/vmalloc.h>
28#include <linux/workqueue.h>
29#include <linux/sched.h>
30#include <linux/wait.h>
621e4f8e 31#include <linux/delay.h>
f9f7dd22 32#include <linux/interrupt.h>
4b23aff0 33#include <linux/mtd/mtd.h>
2e386e4b 34#include <linux/kmsg_dump.h>
4b23aff0 35
1114e3d0
SK
36/* Maximum MTD partition size */
37#define MTDOOPS_MAX_MTD_SIZE (8 * 1024 * 1024)
38
f0482ee3 39#define MTDOOPS_KERNMSG_MAGIC 0x5d005d00
2e386e4b 40#define MTDOOPS_HEADER_SIZE 8
9507b0c8
SK
41
42static unsigned long record_size = 4096;
43module_param(record_size, ulong, 0400);
44MODULE_PARM_DESC(record_size,
45 "record size for MTD OOPS pages in bytes (default 4096)");
4b23aff0 46
2e386e4b
SK
47static char mtddev[80];
48module_param_string(mtddev, mtddev, 80, 0400);
49MODULE_PARM_DESC(mtddev,
50 "name or index number of the MTD device to use");
51
52static int dump_oops = 1;
53module_param(dump_oops, int, 0600);
54MODULE_PARM_DESC(dump_oops,
55 "set to 1 to dump oopses, 0 to only dump panics (default 1)");
56
7903cbab 57static struct mtdoops_context {
2e386e4b
SK
58 struct kmsg_dumper dump;
59
4b23aff0 60 int mtd_index;
6ce0a856
RP
61 struct work_struct work_erase;
62 struct work_struct work_write;
4b23aff0
RP
63 struct mtd_info *mtd;
64 int oops_pages;
65 int nextpage;
66 int nextcount;
be95745f 67 unsigned long *oops_page_used;
4b23aff0
RP
68
69 void *oops_buf;
4b23aff0
RP
70} oops_cxt;
71
be95745f
SK
72static void mark_page_used(struct mtdoops_context *cxt, int page)
73{
74 set_bit(page, cxt->oops_page_used);
75}
76
77static void mark_page_unused(struct mtdoops_context *cxt, int page)
78{
79 clear_bit(page, cxt->oops_page_used);
80}
81
82static int page_is_used(struct mtdoops_context *cxt, int page)
83{
84 return test_bit(page, cxt->oops_page_used);
85}
86
be95745f 87static int mtdoops_erase_block(struct mtdoops_context *cxt, int offset)
4b23aff0 88{
be95745f
SK
89 struct mtd_info *mtd = cxt->mtd;
90 u32 start_page_offset = mtd_div_by_eb(offset, mtd) * mtd->erasesize;
9507b0c8
SK
91 u32 start_page = start_page_offset / record_size;
92 u32 erase_pages = mtd->erasesize / record_size;
4b23aff0 93 struct erase_info erase;
4b23aff0 94 int ret;
be95745f 95 int page;
4b23aff0 96
4b23aff0 97 erase.addr = offset;
79dcd8e9 98 erase.len = mtd->erasesize;
4b23aff0 99
7e1f0dc0 100 ret = mtd_erase(mtd, &erase);
4b23aff0 101 if (ret) {
a15b124f
AB
102 printk(KERN_WARNING "mtdoops: erase of region [0x%llx, 0x%llx] on \"%s\" failed\n",
103 (unsigned long long)erase.addr,
2e386e4b 104 (unsigned long long)erase.len, mtddev);
4b23aff0
RP
105 return ret;
106 }
107
be95745f
SK
108 /* Mark pages as unused */
109 for (page = start_page; page < start_page + erase_pages; page++)
110 mark_page_unused(cxt, page);
111
4b23aff0
RP
112 return 0;
113}
114
6ce0a856 115static void mtdoops_inc_counter(struct mtdoops_context *cxt)
4b23aff0 116{
4b23aff0 117 cxt->nextpage++;
ecd5b310 118 if (cxt->nextpage >= cxt->oops_pages)
4b23aff0
RP
119 cxt->nextpage = 0;
120 cxt->nextcount++;
121 if (cxt->nextcount == 0xffffffff)
122 cxt->nextcount = 0;
123
be95745f 124 if (page_is_used(cxt, cxt->nextpage)) {
6ce0a856
RP
125 schedule_work(&cxt->work_erase);
126 return;
127 }
4b23aff0 128
a15b124f
AB
129 printk(KERN_DEBUG "mtdoops: ready %d, %d (no erase)\n",
130 cxt->nextpage, cxt->nextcount);
4b23aff0
RP
131}
132
6ce0a856
RP
133/* Scheduled work - when we can't proceed without erasing a block */
134static void mtdoops_workfunc_erase(struct work_struct *work)
4b23aff0 135{
6ce0a856
RP
136 struct mtdoops_context *cxt =
137 container_of(work, struct mtdoops_context, work_erase);
4b23aff0
RP
138 struct mtd_info *mtd = cxt->mtd;
139 int i = 0, j, ret, mod;
140
141 /* We were unregistered */
142 if (!mtd)
143 return;
144
9507b0c8 145 mod = (cxt->nextpage * record_size) % mtd->erasesize;
4b23aff0 146 if (mod != 0) {
9507b0c8 147 cxt->nextpage = cxt->nextpage + ((mtd->erasesize - mod) / record_size);
ecd5b310 148 if (cxt->nextpage >= cxt->oops_pages)
4b23aff0
RP
149 cxt->nextpage = 0;
150 }
151
9cb93fbb 152 while ((ret = mtd_block_isbad(mtd, cxt->nextpage * record_size)) > 0) {
4b23aff0 153badblock:
9507b0c8
SK
154 printk(KERN_WARNING "mtdoops: bad block at %08lx\n",
155 cxt->nextpage * record_size);
4b23aff0 156 i++;
9507b0c8 157 cxt->nextpage = cxt->nextpage + (mtd->erasesize / record_size);
ecd5b310 158 if (cxt->nextpage >= cxt->oops_pages)
4b23aff0 159 cxt->nextpage = 0;
9507b0c8 160 if (i == cxt->oops_pages / (mtd->erasesize / record_size)) {
a15b124f 161 printk(KERN_ERR "mtdoops: all blocks bad!\n");
4b23aff0
RP
162 return;
163 }
164 }
165
9cb93fbb
BN
166 if (ret < 0) {
167 printk(KERN_ERR "mtdoops: mtd_block_isbad failed, aborting\n");
168 return;
169 }
170
4b23aff0 171 for (j = 0, ret = -1; (j < 3) && (ret < 0); j++)
9507b0c8 172 ret = mtdoops_erase_block(cxt, cxt->nextpage * record_size);
4b23aff0 173
2986bd2a 174 if (ret >= 0) {
a15b124f
AB
175 printk(KERN_DEBUG "mtdoops: ready %d, %d\n",
176 cxt->nextpage, cxt->nextcount);
2986bd2a 177 return;
4b23aff0
RP
178 }
179
bb4a0986 180 if (ret == -EIO) {
5942ddbc 181 ret = mtd_block_markbad(mtd, cxt->nextpage * record_size);
bb4a0986 182 if (ret < 0 && ret != -EOPNOTSUPP) {
a15b124f 183 printk(KERN_ERR "mtdoops: block_markbad failed, aborting\n");
2986bd2a
RP
184 return;
185 }
186 }
187 goto badblock;
4b23aff0
RP
188}
189
621e4f8e 190static void mtdoops_write(struct mtdoops_context *cxt, int panic)
4b23aff0 191{
6ce0a856
RP
192 struct mtd_info *mtd = cxt->mtd;
193 size_t retlen;
2e386e4b 194 u32 *hdr;
6ce0a856 195 int ret;
4b23aff0 196
2e386e4b
SK
197 /* Add mtdoops header to the buffer */
198 hdr = cxt->oops_buf;
199 hdr[0] = cxt->nextcount;
200 hdr[1] = MTDOOPS_KERNMSG_MAGIC;
6ce0a856 201
016c1291 202 if (panic) {
7ae79d7f
AB
203 ret = mtd_panic_write(mtd, cxt->nextpage * record_size,
204 record_size, &retlen, cxt->oops_buf);
016c1291
AB
205 if (ret == -EOPNOTSUPP) {
206 printk(KERN_ERR "mtdoops: Cannot write from panic without panic_write\n");
207 return;
208 }
209 } else
eda95cbf
AB
210 ret = mtd_write(mtd, cxt->nextpage * record_size,
211 record_size, &retlen, cxt->oops_buf);
6ce0a856 212
9507b0c8
SK
213 if (retlen != record_size || ret < 0)
214 printk(KERN_ERR "mtdoops: write failure at %ld (%td of %ld written), error %d\n",
215 cxt->nextpage * record_size, retlen, record_size, ret);
be95745f 216 mark_page_used(cxt, cxt->nextpage);
2e386e4b 217 memset(cxt->oops_buf, 0xff, record_size);
6ce0a856
RP
218
219 mtdoops_inc_counter(cxt);
621e4f8e
RP
220}
221
621e4f8e
RP
222static void mtdoops_workfunc_write(struct work_struct *work)
223{
224 struct mtdoops_context *cxt =
225 container_of(work, struct mtdoops_context, work_write);
226
227 mtdoops_write(cxt, 0);
a15b124f 228}
4b23aff0 229
6ce0a856 230static void find_next_position(struct mtdoops_context *cxt)
4b23aff0
RP
231{
232 struct mtd_info *mtd = cxt->mtd;
2986bd2a 233 int ret, page, maxpos = 0;
f0482ee3 234 u32 count[2], maxcount = 0xffffffff;
4b23aff0
RP
235 size_t retlen;
236
237 for (page = 0; page < cxt->oops_pages; page++) {
bb4a0986 238 if (mtd_block_isbad(mtd, page * record_size))
3538c563 239 continue;
be95745f
SK
240 /* Assume the page is used */
241 mark_page_used(cxt, page);
329ad399
AB
242 ret = mtd_read(mtd, page * record_size, MTDOOPS_HEADER_SIZE,
243 &retlen, (u_char *)&count[0]);
2e386e4b 244 if (retlen != MTDOOPS_HEADER_SIZE ||
d57f4054 245 (ret < 0 && !mtd_is_bitflip(ret))) {
2e386e4b
SK
246 printk(KERN_ERR "mtdoops: read failure at %ld (%td of %d read), err %d\n",
247 page * record_size, retlen,
248 MTDOOPS_HEADER_SIZE, ret);
2986bd2a
RP
249 continue;
250 }
251
be95745f
SK
252 if (count[0] == 0xffffffff && count[1] == 0xffffffff)
253 mark_page_unused(cxt, page);
cd409c61 254 if (count[0] == 0xffffffff || count[1] != MTDOOPS_KERNMSG_MAGIC)
4b23aff0
RP
255 continue;
256 if (maxcount == 0xffffffff) {
f0482ee3 257 maxcount = count[0];
4b23aff0 258 maxpos = page;
a15b124f 259 } else if (count[0] < 0x40000000 && maxcount > 0xc0000000) {
f0482ee3 260 maxcount = count[0];
4b23aff0 261 maxpos = page;
a15b124f 262 } else if (count[0] > maxcount && count[0] < 0xc0000000) {
f0482ee3 263 maxcount = count[0];
4b23aff0 264 maxpos = page;
a15b124f
AB
265 } else if (count[0] > maxcount && count[0] > 0xc0000000
266 && maxcount > 0x80000000) {
f0482ee3 267 maxcount = count[0];
4b23aff0
RP
268 maxpos = page;
269 }
270 }
271 if (maxcount == 0xffffffff) {
cd409c61
MC
272 cxt->nextpage = cxt->oops_pages - 1;
273 cxt->nextcount = 0;
274 }
275 else {
276 cxt->nextpage = maxpos;
277 cxt->nextcount = maxcount;
4b23aff0 278 }
4b23aff0 279
6ce0a856 280 mtdoops_inc_counter(cxt);
4b23aff0
RP
281}
282
2e386e4b 283static void mtdoops_do_dump(struct kmsg_dumper *dumper,
e2ae715d 284 enum kmsg_dump_reason reason)
2e386e4b
SK
285{
286 struct mtdoops_context *cxt = container_of(dumper,
287 struct mtdoops_context, dump);
fc2d557c 288
2e386e4b
SK
289 /* Only dump oopses if dump_oops is set */
290 if (reason == KMSG_DUMP_OOPS && !dump_oops)
291 return;
292
e2ae715d
KS
293 kmsg_dump_get_buffer(dumper, true, cxt->oops_buf + MTDOOPS_HEADER_SIZE,
294 record_size - MTDOOPS_HEADER_SIZE, NULL);
2e386e4b
SK
295
296 /* Panics must be written immediately */
016c1291
AB
297 if (reason != KMSG_DUMP_OOPS)
298 mtdoops_write(cxt, 1);
2e386e4b
SK
299
300 /* For other cases, schedule work to write it "nicely" */
301 schedule_work(&cxt->work_write);
302}
4b23aff0
RP
303
304static void mtdoops_notify_add(struct mtd_info *mtd)
305{
306 struct mtdoops_context *cxt = &oops_cxt;
2e386e4b
SK
307 u64 mtdoops_pages = div_u64(mtd->size, record_size);
308 int err;
4b23aff0 309
2e386e4b 310 if (!strcmp(mtd->name, mtddev))
e2a0f25b
AH
311 cxt->mtd_index = mtd->index;
312
a15b124f 313 if (mtd->index != cxt->mtd_index || cxt->mtd_index < 0)
4b23aff0
RP
314 return;
315
a15b124f
AB
316 if (mtd->size < mtd->erasesize * 2) {
317 printk(KERN_ERR "mtdoops: MTD partition %d not big enough for mtdoops\n",
318 mtd->index);
4b23aff0
RP
319 return;
320 }
9507b0c8 321 if (mtd->erasesize < record_size) {
a15b124f
AB
322 printk(KERN_ERR "mtdoops: eraseblock size of MTD partition %d too small\n",
323 mtd->index);
79dcd8e9
RP
324 return;
325 }
1114e3d0
SK
326 if (mtd->size > MTDOOPS_MAX_MTD_SIZE) {
327 printk(KERN_ERR "mtdoops: mtd%d is too large (limit is %d MiB)\n",
328 mtd->index, MTDOOPS_MAX_MTD_SIZE / 1024 / 1024);
329 return;
330 }
331
be95745f 332 /* oops_page_used is a bit field */
42bc47b3
KC
333 cxt->oops_page_used =
334 vmalloc(array_size(sizeof(unsigned long),
335 DIV_ROUND_UP(mtdoops_pages,
336 BITS_PER_LONG)));
be95745f 337 if (!cxt->oops_page_used) {
2e386e4b
SK
338 printk(KERN_ERR "mtdoops: could not allocate page array\n");
339 return;
340 }
341
e2ae715d 342 cxt->dump.max_reason = KMSG_DUMP_OOPS;
2e386e4b
SK
343 cxt->dump.dump = mtdoops_do_dump;
344 err = kmsg_dump_register(&cxt->dump);
345 if (err) {
346 printk(KERN_ERR "mtdoops: registering kmsg dumper failed, error %d\n", err);
347 vfree(cxt->oops_page_used);
348 cxt->oops_page_used = NULL;
be95745f
SK
349 return;
350 }
4b23aff0 351
1114e3d0 352 cxt->mtd = mtd;
9507b0c8 353 cxt->oops_pages = (int)mtd->size / record_size;
6ce0a856 354 find_next_position(cxt);
79dcd8e9 355 printk(KERN_INFO "mtdoops: Attached to MTD device %d\n", mtd->index);
4b23aff0
RP
356}
357
358static void mtdoops_notify_remove(struct mtd_info *mtd)
359{
360 struct mtdoops_context *cxt = &oops_cxt;
361
a15b124f 362 if (mtd->index != cxt->mtd_index || cxt->mtd_index < 0)
4b23aff0
RP
363 return;
364
2e386e4b
SK
365 if (kmsg_dump_unregister(&cxt->dump) < 0)
366 printk(KERN_WARNING "mtdoops: could not unregister kmsg_dumper\n");
367
4b23aff0 368 cxt->mtd = NULL;
43829731
TH
369 flush_work(&cxt->work_erase);
370 flush_work(&cxt->work_write);
4b23aff0
RP
371}
372
4b23aff0
RP
373
374static struct mtd_notifier mtdoops_notifier = {
375 .add = mtdoops_notify_add,
376 .remove = mtdoops_notify_remove,
377};
378
2e386e4b 379static int __init mtdoops_init(void)
4b23aff0
RP
380{
381 struct mtdoops_context *cxt = &oops_cxt;
2e386e4b
SK
382 int mtd_index;
383 char *endp;
4b23aff0 384
2e386e4b
SK
385 if (strlen(mtddev) == 0) {
386 printk(KERN_ERR "mtdoops: mtd device (mtddev=name/number) must be supplied\n");
387 return -EINVAL;
388 }
9507b0c8
SK
389 if ((record_size & 4095) != 0) {
390 printk(KERN_ERR "mtdoops: record_size must be a multiple of 4096\n");
391 return -EINVAL;
392 }
393 if (record_size < 4096) {
394 printk(KERN_ERR "mtdoops: record_size must be over 4096 bytes\n");
395 return -EINVAL;
396 }
2e386e4b
SK
397
398 /* Setup the MTD device to use */
4b23aff0 399 cxt->mtd_index = -1;
2e386e4b
SK
400 mtd_index = simple_strtoul(mtddev, &endp, 0);
401 if (*endp == '\0')
402 cxt->mtd_index = mtd_index;
2e386e4b 403
9507b0c8 404 cxt->oops_buf = vmalloc(record_size);
4b23aff0 405 if (!cxt->oops_buf) {
a15b124f 406 printk(KERN_ERR "mtdoops: failed to allocate buffer workspace\n");
4b23aff0
RP
407 return -ENOMEM;
408 }
2e386e4b 409 memset(cxt->oops_buf, 0xff, record_size);
4b23aff0 410
6ce0a856
RP
411 INIT_WORK(&cxt->work_erase, mtdoops_workfunc_erase);
412 INIT_WORK(&cxt->work_write, mtdoops_workfunc_write);
4b23aff0 413
4b23aff0
RP
414 register_mtd_user(&mtdoops_notifier);
415 return 0;
416}
417
2e386e4b 418static void __exit mtdoops_exit(void)
4b23aff0
RP
419{
420 struct mtdoops_context *cxt = &oops_cxt;
421
422 unregister_mtd_user(&mtdoops_notifier);
4b23aff0 423 vfree(cxt->oops_buf);
be95745f 424 vfree(cxt->oops_page_used);
4b23aff0
RP
425}
426
427
2e386e4b
SK
428module_init(mtdoops_init);
429module_exit(mtdoops_exit);
4b23aff0
RP
430
431MODULE_LICENSE("GPL");
432MODULE_AUTHOR("Richard Purdie <rpurdie@openedhand.com>");
433MODULE_DESCRIPTION("MTD Oops/Panic console logger/driver");