Commit | Line | Data |
---|---|---|
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 | |
42 | static unsigned long record_size = 4096; | |
43 | module_param(record_size, ulong, 0400); | |
44 | MODULE_PARM_DESC(record_size, | |
45 | "record size for MTD OOPS pages in bytes (default 4096)"); | |
4b23aff0 | 46 | |
2e386e4b SK |
47 | static char mtddev[80]; |
48 | module_param_string(mtddev, mtddev, 80, 0400); | |
49 | MODULE_PARM_DESC(mtddev, | |
50 | "name or index number of the MTD device to use"); | |
51 | ||
52 | static int dump_oops = 1; | |
53 | module_param(dump_oops, int, 0600); | |
54 | MODULE_PARM_DESC(dump_oops, | |
55 | "set to 1 to dump oopses, 0 to only dump panics (default 1)"); | |
56 | ||
7903cbab | 57 | static 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 |
72 | static void mark_page_used(struct mtdoops_context *cxt, int page) |
73 | { | |
74 | set_bit(page, cxt->oops_page_used); | |
75 | } | |
76 | ||
77 | static void mark_page_unused(struct mtdoops_context *cxt, int page) | |
78 | { | |
79 | clear_bit(page, cxt->oops_page_used); | |
80 | } | |
81 | ||
82 | static int page_is_used(struct mtdoops_context *cxt, int page) | |
83 | { | |
84 | return test_bit(page, cxt->oops_page_used); | |
85 | } | |
86 | ||
4b23aff0 RP |
87 | static void mtdoops_erase_callback(struct erase_info *done) |
88 | { | |
89 | wait_queue_head_t *wait_q = (wait_queue_head_t *)done->priv; | |
90 | wake_up(wait_q); | |
91 | } | |
92 | ||
be95745f | 93 | static int mtdoops_erase_block(struct mtdoops_context *cxt, int offset) |
4b23aff0 | 94 | { |
be95745f SK |
95 | struct mtd_info *mtd = cxt->mtd; |
96 | u32 start_page_offset = mtd_div_by_eb(offset, mtd) * mtd->erasesize; | |
9507b0c8 SK |
97 | u32 start_page = start_page_offset / record_size; |
98 | u32 erase_pages = mtd->erasesize / record_size; | |
4b23aff0 RP |
99 | struct erase_info erase; |
100 | DECLARE_WAITQUEUE(wait, current); | |
101 | wait_queue_head_t wait_q; | |
102 | int ret; | |
be95745f | 103 | int page; |
4b23aff0 RP |
104 | |
105 | init_waitqueue_head(&wait_q); | |
106 | erase.mtd = mtd; | |
107 | erase.callback = mtdoops_erase_callback; | |
108 | erase.addr = offset; | |
79dcd8e9 | 109 | erase.len = mtd->erasesize; |
4b23aff0 RP |
110 | erase.priv = (u_long)&wait_q; |
111 | ||
112 | set_current_state(TASK_INTERRUPTIBLE); | |
113 | add_wait_queue(&wait_q, &wait); | |
114 | ||
7e1f0dc0 | 115 | ret = mtd_erase(mtd, &erase); |
4b23aff0 RP |
116 | if (ret) { |
117 | set_current_state(TASK_RUNNING); | |
118 | remove_wait_queue(&wait_q, &wait); | |
a15b124f AB |
119 | printk(KERN_WARNING "mtdoops: erase of region [0x%llx, 0x%llx] on \"%s\" failed\n", |
120 | (unsigned long long)erase.addr, | |
2e386e4b | 121 | (unsigned long long)erase.len, mtddev); |
4b23aff0 RP |
122 | return ret; |
123 | } | |
124 | ||
125 | schedule(); /* Wait for erase to finish. */ | |
126 | remove_wait_queue(&wait_q, &wait); | |
127 | ||
be95745f SK |
128 | /* Mark pages as unused */ |
129 | for (page = start_page; page < start_page + erase_pages; page++) | |
130 | mark_page_unused(cxt, page); | |
131 | ||
4b23aff0 RP |
132 | return 0; |
133 | } | |
134 | ||
6ce0a856 | 135 | static void mtdoops_inc_counter(struct mtdoops_context *cxt) |
4b23aff0 | 136 | { |
4b23aff0 | 137 | cxt->nextpage++; |
ecd5b310 | 138 | if (cxt->nextpage >= cxt->oops_pages) |
4b23aff0 RP |
139 | cxt->nextpage = 0; |
140 | cxt->nextcount++; | |
141 | if (cxt->nextcount == 0xffffffff) | |
142 | cxt->nextcount = 0; | |
143 | ||
be95745f | 144 | if (page_is_used(cxt, cxt->nextpage)) { |
6ce0a856 RP |
145 | schedule_work(&cxt->work_erase); |
146 | return; | |
147 | } | |
4b23aff0 | 148 | |
a15b124f AB |
149 | printk(KERN_DEBUG "mtdoops: ready %d, %d (no erase)\n", |
150 | cxt->nextpage, cxt->nextcount); | |
4b23aff0 RP |
151 | } |
152 | ||
6ce0a856 RP |
153 | /* Scheduled work - when we can't proceed without erasing a block */ |
154 | static void mtdoops_workfunc_erase(struct work_struct *work) | |
4b23aff0 | 155 | { |
6ce0a856 RP |
156 | struct mtdoops_context *cxt = |
157 | container_of(work, struct mtdoops_context, work_erase); | |
4b23aff0 RP |
158 | struct mtd_info *mtd = cxt->mtd; |
159 | int i = 0, j, ret, mod; | |
160 | ||
161 | /* We were unregistered */ | |
162 | if (!mtd) | |
163 | return; | |
164 | ||
9507b0c8 | 165 | mod = (cxt->nextpage * record_size) % mtd->erasesize; |
4b23aff0 | 166 | if (mod != 0) { |
9507b0c8 | 167 | cxt->nextpage = cxt->nextpage + ((mtd->erasesize - mod) / record_size); |
ecd5b310 | 168 | if (cxt->nextpage >= cxt->oops_pages) |
4b23aff0 RP |
169 | cxt->nextpage = 0; |
170 | } | |
171 | ||
9cb93fbb | 172 | while ((ret = mtd_block_isbad(mtd, cxt->nextpage * record_size)) > 0) { |
4b23aff0 | 173 | badblock: |
9507b0c8 SK |
174 | printk(KERN_WARNING "mtdoops: bad block at %08lx\n", |
175 | cxt->nextpage * record_size); | |
4b23aff0 | 176 | i++; |
9507b0c8 | 177 | cxt->nextpage = cxt->nextpage + (mtd->erasesize / record_size); |
ecd5b310 | 178 | if (cxt->nextpage >= cxt->oops_pages) |
4b23aff0 | 179 | cxt->nextpage = 0; |
9507b0c8 | 180 | if (i == cxt->oops_pages / (mtd->erasesize / record_size)) { |
a15b124f | 181 | printk(KERN_ERR "mtdoops: all blocks bad!\n"); |
4b23aff0 RP |
182 | return; |
183 | } | |
184 | } | |
185 | ||
9cb93fbb BN |
186 | if (ret < 0) { |
187 | printk(KERN_ERR "mtdoops: mtd_block_isbad failed, aborting\n"); | |
188 | return; | |
189 | } | |
190 | ||
4b23aff0 | 191 | for (j = 0, ret = -1; (j < 3) && (ret < 0); j++) |
9507b0c8 | 192 | ret = mtdoops_erase_block(cxt, cxt->nextpage * record_size); |
4b23aff0 | 193 | |
2986bd2a | 194 | if (ret >= 0) { |
a15b124f AB |
195 | printk(KERN_DEBUG "mtdoops: ready %d, %d\n", |
196 | cxt->nextpage, cxt->nextcount); | |
2986bd2a | 197 | return; |
4b23aff0 RP |
198 | } |
199 | ||
bb4a0986 | 200 | if (ret == -EIO) { |
5942ddbc | 201 | ret = mtd_block_markbad(mtd, cxt->nextpage * record_size); |
bb4a0986 | 202 | if (ret < 0 && ret != -EOPNOTSUPP) { |
a15b124f | 203 | printk(KERN_ERR "mtdoops: block_markbad failed, aborting\n"); |
2986bd2a RP |
204 | return; |
205 | } | |
206 | } | |
207 | goto badblock; | |
4b23aff0 RP |
208 | } |
209 | ||
621e4f8e | 210 | static void mtdoops_write(struct mtdoops_context *cxt, int panic) |
4b23aff0 | 211 | { |
6ce0a856 RP |
212 | struct mtd_info *mtd = cxt->mtd; |
213 | size_t retlen; | |
2e386e4b | 214 | u32 *hdr; |
6ce0a856 | 215 | int ret; |
4b23aff0 | 216 | |
2e386e4b SK |
217 | /* Add mtdoops header to the buffer */ |
218 | hdr = cxt->oops_buf; | |
219 | hdr[0] = cxt->nextcount; | |
220 | hdr[1] = MTDOOPS_KERNMSG_MAGIC; | |
6ce0a856 | 221 | |
016c1291 | 222 | if (panic) { |
7ae79d7f AB |
223 | ret = mtd_panic_write(mtd, cxt->nextpage * record_size, |
224 | record_size, &retlen, cxt->oops_buf); | |
016c1291 AB |
225 | if (ret == -EOPNOTSUPP) { |
226 | printk(KERN_ERR "mtdoops: Cannot write from panic without panic_write\n"); | |
227 | return; | |
228 | } | |
229 | } else | |
eda95cbf AB |
230 | ret = mtd_write(mtd, cxt->nextpage * record_size, |
231 | record_size, &retlen, cxt->oops_buf); | |
6ce0a856 | 232 | |
9507b0c8 SK |
233 | if (retlen != record_size || ret < 0) |
234 | printk(KERN_ERR "mtdoops: write failure at %ld (%td of %ld written), error %d\n", | |
235 | cxt->nextpage * record_size, retlen, record_size, ret); | |
be95745f | 236 | mark_page_used(cxt, cxt->nextpage); |
2e386e4b | 237 | memset(cxt->oops_buf, 0xff, record_size); |
6ce0a856 RP |
238 | |
239 | mtdoops_inc_counter(cxt); | |
621e4f8e RP |
240 | } |
241 | ||
621e4f8e RP |
242 | static void mtdoops_workfunc_write(struct work_struct *work) |
243 | { | |
244 | struct mtdoops_context *cxt = | |
245 | container_of(work, struct mtdoops_context, work_write); | |
246 | ||
247 | mtdoops_write(cxt, 0); | |
a15b124f | 248 | } |
4b23aff0 | 249 | |
6ce0a856 | 250 | static void find_next_position(struct mtdoops_context *cxt) |
4b23aff0 RP |
251 | { |
252 | struct mtd_info *mtd = cxt->mtd; | |
2986bd2a | 253 | int ret, page, maxpos = 0; |
f0482ee3 | 254 | u32 count[2], maxcount = 0xffffffff; |
4b23aff0 RP |
255 | size_t retlen; |
256 | ||
257 | for (page = 0; page < cxt->oops_pages; page++) { | |
bb4a0986 | 258 | if (mtd_block_isbad(mtd, page * record_size)) |
3538c563 | 259 | continue; |
be95745f SK |
260 | /* Assume the page is used */ |
261 | mark_page_used(cxt, page); | |
329ad399 AB |
262 | ret = mtd_read(mtd, page * record_size, MTDOOPS_HEADER_SIZE, |
263 | &retlen, (u_char *)&count[0]); | |
2e386e4b | 264 | if (retlen != MTDOOPS_HEADER_SIZE || |
d57f4054 | 265 | (ret < 0 && !mtd_is_bitflip(ret))) { |
2e386e4b SK |
266 | printk(KERN_ERR "mtdoops: read failure at %ld (%td of %d read), err %d\n", |
267 | page * record_size, retlen, | |
268 | MTDOOPS_HEADER_SIZE, ret); | |
2986bd2a RP |
269 | continue; |
270 | } | |
271 | ||
be95745f SK |
272 | if (count[0] == 0xffffffff && count[1] == 0xffffffff) |
273 | mark_page_unused(cxt, page); | |
cd409c61 | 274 | if (count[0] == 0xffffffff || count[1] != MTDOOPS_KERNMSG_MAGIC) |
4b23aff0 RP |
275 | continue; |
276 | if (maxcount == 0xffffffff) { | |
f0482ee3 | 277 | maxcount = count[0]; |
4b23aff0 | 278 | maxpos = page; |
a15b124f | 279 | } else if (count[0] < 0x40000000 && maxcount > 0xc0000000) { |
f0482ee3 | 280 | maxcount = count[0]; |
4b23aff0 | 281 | maxpos = page; |
a15b124f | 282 | } else if (count[0] > maxcount && count[0] < 0xc0000000) { |
f0482ee3 | 283 | maxcount = count[0]; |
4b23aff0 | 284 | maxpos = page; |
a15b124f AB |
285 | } else if (count[0] > maxcount && count[0] > 0xc0000000 |
286 | && maxcount > 0x80000000) { | |
f0482ee3 | 287 | maxcount = count[0]; |
4b23aff0 RP |
288 | maxpos = page; |
289 | } | |
290 | } | |
291 | if (maxcount == 0xffffffff) { | |
cd409c61 MC |
292 | cxt->nextpage = cxt->oops_pages - 1; |
293 | cxt->nextcount = 0; | |
294 | } | |
295 | else { | |
296 | cxt->nextpage = maxpos; | |
297 | cxt->nextcount = maxcount; | |
4b23aff0 | 298 | } |
4b23aff0 | 299 | |
6ce0a856 | 300 | mtdoops_inc_counter(cxt); |
4b23aff0 RP |
301 | } |
302 | ||
2e386e4b | 303 | static void mtdoops_do_dump(struct kmsg_dumper *dumper, |
e2ae715d | 304 | enum kmsg_dump_reason reason) |
2e386e4b SK |
305 | { |
306 | struct mtdoops_context *cxt = container_of(dumper, | |
307 | struct mtdoops_context, dump); | |
fc2d557c | 308 | |
2e386e4b SK |
309 | /* Only dump oopses if dump_oops is set */ |
310 | if (reason == KMSG_DUMP_OOPS && !dump_oops) | |
311 | return; | |
312 | ||
e2ae715d KS |
313 | kmsg_dump_get_buffer(dumper, true, cxt->oops_buf + MTDOOPS_HEADER_SIZE, |
314 | record_size - MTDOOPS_HEADER_SIZE, NULL); | |
2e386e4b SK |
315 | |
316 | /* Panics must be written immediately */ | |
016c1291 AB |
317 | if (reason != KMSG_DUMP_OOPS) |
318 | mtdoops_write(cxt, 1); | |
2e386e4b SK |
319 | |
320 | /* For other cases, schedule work to write it "nicely" */ | |
321 | schedule_work(&cxt->work_write); | |
322 | } | |
4b23aff0 RP |
323 | |
324 | static void mtdoops_notify_add(struct mtd_info *mtd) | |
325 | { | |
326 | struct mtdoops_context *cxt = &oops_cxt; | |
2e386e4b SK |
327 | u64 mtdoops_pages = div_u64(mtd->size, record_size); |
328 | int err; | |
4b23aff0 | 329 | |
2e386e4b | 330 | if (!strcmp(mtd->name, mtddev)) |
e2a0f25b AH |
331 | cxt->mtd_index = mtd->index; |
332 | ||
a15b124f | 333 | if (mtd->index != cxt->mtd_index || cxt->mtd_index < 0) |
4b23aff0 RP |
334 | return; |
335 | ||
a15b124f AB |
336 | if (mtd->size < mtd->erasesize * 2) { |
337 | printk(KERN_ERR "mtdoops: MTD partition %d not big enough for mtdoops\n", | |
338 | mtd->index); | |
4b23aff0 RP |
339 | return; |
340 | } | |
9507b0c8 | 341 | if (mtd->erasesize < record_size) { |
a15b124f AB |
342 | printk(KERN_ERR "mtdoops: eraseblock size of MTD partition %d too small\n", |
343 | mtd->index); | |
79dcd8e9 RP |
344 | return; |
345 | } | |
1114e3d0 SK |
346 | if (mtd->size > MTDOOPS_MAX_MTD_SIZE) { |
347 | printk(KERN_ERR "mtdoops: mtd%d is too large (limit is %d MiB)\n", | |
348 | mtd->index, MTDOOPS_MAX_MTD_SIZE / 1024 / 1024); | |
349 | return; | |
350 | } | |
351 | ||
be95745f SK |
352 | /* oops_page_used is a bit field */ |
353 | cxt->oops_page_used = vmalloc(DIV_ROUND_UP(mtdoops_pages, | |
556f0635 | 354 | BITS_PER_LONG) * sizeof(unsigned long)); |
be95745f | 355 | if (!cxt->oops_page_used) { |
2e386e4b SK |
356 | printk(KERN_ERR "mtdoops: could not allocate page array\n"); |
357 | return; | |
358 | } | |
359 | ||
e2ae715d | 360 | cxt->dump.max_reason = KMSG_DUMP_OOPS; |
2e386e4b SK |
361 | cxt->dump.dump = mtdoops_do_dump; |
362 | err = kmsg_dump_register(&cxt->dump); | |
363 | if (err) { | |
364 | printk(KERN_ERR "mtdoops: registering kmsg dumper failed, error %d\n", err); | |
365 | vfree(cxt->oops_page_used); | |
366 | cxt->oops_page_used = NULL; | |
be95745f SK |
367 | return; |
368 | } | |
4b23aff0 | 369 | |
1114e3d0 | 370 | cxt->mtd = mtd; |
9507b0c8 | 371 | cxt->oops_pages = (int)mtd->size / record_size; |
6ce0a856 | 372 | find_next_position(cxt); |
79dcd8e9 | 373 | printk(KERN_INFO "mtdoops: Attached to MTD device %d\n", mtd->index); |
4b23aff0 RP |
374 | } |
375 | ||
376 | static void mtdoops_notify_remove(struct mtd_info *mtd) | |
377 | { | |
378 | struct mtdoops_context *cxt = &oops_cxt; | |
379 | ||
a15b124f | 380 | if (mtd->index != cxt->mtd_index || cxt->mtd_index < 0) |
4b23aff0 RP |
381 | return; |
382 | ||
2e386e4b SK |
383 | if (kmsg_dump_unregister(&cxt->dump) < 0) |
384 | printk(KERN_WARNING "mtdoops: could not unregister kmsg_dumper\n"); | |
385 | ||
4b23aff0 | 386 | cxt->mtd = NULL; |
43829731 TH |
387 | flush_work(&cxt->work_erase); |
388 | flush_work(&cxt->work_write); | |
4b23aff0 RP |
389 | } |
390 | ||
4b23aff0 RP |
391 | |
392 | static struct mtd_notifier mtdoops_notifier = { | |
393 | .add = mtdoops_notify_add, | |
394 | .remove = mtdoops_notify_remove, | |
395 | }; | |
396 | ||
2e386e4b | 397 | static int __init mtdoops_init(void) |
4b23aff0 RP |
398 | { |
399 | struct mtdoops_context *cxt = &oops_cxt; | |
2e386e4b SK |
400 | int mtd_index; |
401 | char *endp; | |
4b23aff0 | 402 | |
2e386e4b SK |
403 | if (strlen(mtddev) == 0) { |
404 | printk(KERN_ERR "mtdoops: mtd device (mtddev=name/number) must be supplied\n"); | |
405 | return -EINVAL; | |
406 | } | |
9507b0c8 SK |
407 | if ((record_size & 4095) != 0) { |
408 | printk(KERN_ERR "mtdoops: record_size must be a multiple of 4096\n"); | |
409 | return -EINVAL; | |
410 | } | |
411 | if (record_size < 4096) { | |
412 | printk(KERN_ERR "mtdoops: record_size must be over 4096 bytes\n"); | |
413 | return -EINVAL; | |
414 | } | |
2e386e4b SK |
415 | |
416 | /* Setup the MTD device to use */ | |
4b23aff0 | 417 | cxt->mtd_index = -1; |
2e386e4b SK |
418 | mtd_index = simple_strtoul(mtddev, &endp, 0); |
419 | if (*endp == '\0') | |
420 | cxt->mtd_index = mtd_index; | |
2e386e4b | 421 | |
9507b0c8 | 422 | cxt->oops_buf = vmalloc(record_size); |
4b23aff0 | 423 | if (!cxt->oops_buf) { |
a15b124f | 424 | printk(KERN_ERR "mtdoops: failed to allocate buffer workspace\n"); |
4b23aff0 RP |
425 | return -ENOMEM; |
426 | } | |
2e386e4b | 427 | memset(cxt->oops_buf, 0xff, record_size); |
4b23aff0 | 428 | |
6ce0a856 RP |
429 | INIT_WORK(&cxt->work_erase, mtdoops_workfunc_erase); |
430 | INIT_WORK(&cxt->work_write, mtdoops_workfunc_write); | |
4b23aff0 | 431 | |
4b23aff0 RP |
432 | register_mtd_user(&mtdoops_notifier); |
433 | return 0; | |
434 | } | |
435 | ||
2e386e4b | 436 | static void __exit mtdoops_exit(void) |
4b23aff0 RP |
437 | { |
438 | struct mtdoops_context *cxt = &oops_cxt; | |
439 | ||
440 | unregister_mtd_user(&mtdoops_notifier); | |
4b23aff0 | 441 | vfree(cxt->oops_buf); |
be95745f | 442 | vfree(cxt->oops_page_used); |
4b23aff0 RP |
443 | } |
444 | ||
445 | ||
2e386e4b SK |
446 | module_init(mtdoops_init); |
447 | module_exit(mtdoops_exit); | |
4b23aff0 RP |
448 | |
449 | MODULE_LICENSE("GPL"); | |
450 | MODULE_AUTHOR("Richard Purdie <rpurdie@openedhand.com>"); | |
451 | MODULE_DESCRIPTION("MTD Oops/Panic console logger/driver"); |