Merge tag 'v4.8-rc1' into patchwork
[deliverable/linux.git] / drivers / mtd / ubi / debug.c
CommitLineData
801c135c
AB
1/*
2 * Copyright (c) International Business Machines Corp., 2006
3 *
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation; either version 2 of the License, or
7 * (at your option) any later version.
8 *
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See
12 * the GNU General Public License for more details.
13 *
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software
16 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17 *
18 * Author: Artem Bityutskiy (Битюцкий Артём)
19 */
20
801c135c 21#include "ubi.h"
2a734bb8
AB
22#include <linux/debugfs.h>
23#include <linux/uaccess.h>
b342efd4 24#include <linux/module.h>
801c135c 25
ef7088e7
AB
26
27/**
28 * ubi_dump_flash - dump a region of flash.
29 * @ubi: UBI device description object
30 * @pnum: the physical eraseblock number to dump
31 * @offset: the starting offset within the physical eraseblock to dump
32 * @len: the length of the region to dump
33 */
34void ubi_dump_flash(struct ubi_device *ubi, int pnum, int offset, int len)
35{
36 int err;
37 size_t read;
38 void *buf;
39 loff_t addr = (loff_t)pnum * ubi->peb_size + offset;
40
41 buf = vmalloc(len);
42 if (!buf)
43 return;
44 err = mtd_read(ubi->mtd, addr, len, &read, buf);
45 if (err && err != -EUCLEAN) {
32608703 46 ubi_err(ubi, "err %d while reading %d bytes from PEB %d:%d, read %zd bytes",
049333ce 47 err, len, pnum, offset, read);
ef7088e7
AB
48 goto out;
49 }
50
32608703 51 ubi_msg(ubi, "dumping %d bytes of data from PEB %d, offset %d",
ef7088e7
AB
52 len, pnum, offset);
53 print_hex_dump(KERN_DEBUG, "", DUMP_PREFIX_OFFSET, 32, 1, buf, len, 1);
54out:
55 vfree(buf);
56 return;
57}
58
801c135c 59/**
a904e3f1 60 * ubi_dump_ec_hdr - dump an erase counter header.
801c135c
AB
61 * @ec_hdr: the erase counter header to dump
62 */
a904e3f1 63void ubi_dump_ec_hdr(const struct ubi_ec_hdr *ec_hdr)
801c135c 64{
e28453bb
AB
65 pr_err("Erase counter header dump:\n");
66 pr_err("\tmagic %#08x\n", be32_to_cpu(ec_hdr->magic));
67 pr_err("\tversion %d\n", (int)ec_hdr->version);
68 pr_err("\tec %llu\n", (long long)be64_to_cpu(ec_hdr->ec));
69 pr_err("\tvid_hdr_offset %d\n", be32_to_cpu(ec_hdr->vid_hdr_offset));
70 pr_err("\tdata_offset %d\n", be32_to_cpu(ec_hdr->data_offset));
71 pr_err("\timage_seq %d\n", be32_to_cpu(ec_hdr->image_seq));
72 pr_err("\thdr_crc %#08x\n", be32_to_cpu(ec_hdr->hdr_crc));
73 pr_err("erase counter header hexdump:\n");
6986646b
AB
74 print_hex_dump(KERN_DEBUG, "", DUMP_PREFIX_OFFSET, 32, 1,
75 ec_hdr, UBI_EC_HDR_SIZE, 1);
801c135c
AB
76}
77
78/**
a904e3f1 79 * ubi_dump_vid_hdr - dump a volume identifier header.
801c135c
AB
80 * @vid_hdr: the volume identifier header to dump
81 */
a904e3f1 82void ubi_dump_vid_hdr(const struct ubi_vid_hdr *vid_hdr)
801c135c 83{
e28453bb
AB
84 pr_err("Volume identifier header dump:\n");
85 pr_err("\tmagic %08x\n", be32_to_cpu(vid_hdr->magic));
86 pr_err("\tversion %d\n", (int)vid_hdr->version);
87 pr_err("\tvol_type %d\n", (int)vid_hdr->vol_type);
88 pr_err("\tcopy_flag %d\n", (int)vid_hdr->copy_flag);
89 pr_err("\tcompat %d\n", (int)vid_hdr->compat);
90 pr_err("\tvol_id %d\n", be32_to_cpu(vid_hdr->vol_id));
91 pr_err("\tlnum %d\n", be32_to_cpu(vid_hdr->lnum));
92 pr_err("\tdata_size %d\n", be32_to_cpu(vid_hdr->data_size));
93 pr_err("\tused_ebs %d\n", be32_to_cpu(vid_hdr->used_ebs));
94 pr_err("\tdata_pad %d\n", be32_to_cpu(vid_hdr->data_pad));
95 pr_err("\tsqnum %llu\n",
3261ebd7 96 (unsigned long long)be64_to_cpu(vid_hdr->sqnum));
e28453bb
AB
97 pr_err("\thdr_crc %08x\n", be32_to_cpu(vid_hdr->hdr_crc));
98 pr_err("Volume identifier header hexdump:\n");
c8566350
AB
99 print_hex_dump(KERN_DEBUG, "", DUMP_PREFIX_OFFSET, 32, 1,
100 vid_hdr, UBI_VID_HDR_SIZE, 1);
801c135c
AB
101}
102
103/**
766381f0 104 * ubi_dump_vol_info - dump volume information.
801c135c
AB
105 * @vol: UBI volume description object
106 */
766381f0 107void ubi_dump_vol_info(const struct ubi_volume *vol)
801c135c 108{
e28453bb
AB
109 pr_err("Volume information dump:\n");
110 pr_err("\tvol_id %d\n", vol->vol_id);
111 pr_err("\treserved_pebs %d\n", vol->reserved_pebs);
112 pr_err("\talignment %d\n", vol->alignment);
113 pr_err("\tdata_pad %d\n", vol->data_pad);
114 pr_err("\tvol_type %d\n", vol->vol_type);
115 pr_err("\tname_len %d\n", vol->name_len);
116 pr_err("\tusable_leb_size %d\n", vol->usable_leb_size);
117 pr_err("\tused_ebs %d\n", vol->used_ebs);
118 pr_err("\tused_bytes %lld\n", vol->used_bytes);
119 pr_err("\tlast_eb_bytes %d\n", vol->last_eb_bytes);
120 pr_err("\tcorrupted %d\n", vol->corrupted);
121 pr_err("\tupd_marker %d\n", vol->upd_marker);
801c135c
AB
122
123 if (vol->name_len <= UBI_VOL_NAME_MAX &&
124 strnlen(vol->name, vol->name_len + 1) == vol->name_len) {
e28453bb 125 pr_err("\tname %s\n", vol->name);
801c135c 126 } else {
e28453bb 127 pr_err("\t1st 5 characters of name: %c%c%c%c%c\n",
c8566350
AB
128 vol->name[0], vol->name[1], vol->name[2],
129 vol->name[3], vol->name[4]);
801c135c
AB
130 }
131}
132
133/**
1f021e1d 134 * ubi_dump_vtbl_record - dump a &struct ubi_vtbl_record object.
801c135c
AB
135 * @r: the object to dump
136 * @idx: volume table index
137 */
1f021e1d 138void ubi_dump_vtbl_record(const struct ubi_vtbl_record *r, int idx)
801c135c 139{
3261ebd7 140 int name_len = be16_to_cpu(r->name_len);
801c135c 141
e28453bb
AB
142 pr_err("Volume table record %d dump:\n", idx);
143 pr_err("\treserved_pebs %d\n", be32_to_cpu(r->reserved_pebs));
144 pr_err("\talignment %d\n", be32_to_cpu(r->alignment));
145 pr_err("\tdata_pad %d\n", be32_to_cpu(r->data_pad));
146 pr_err("\tvol_type %d\n", (int)r->vol_type);
147 pr_err("\tupd_marker %d\n", (int)r->upd_marker);
148 pr_err("\tname_len %d\n", name_len);
801c135c
AB
149
150 if (r->name[0] == '\0') {
e28453bb 151 pr_err("\tname NULL\n");
801c135c
AB
152 return;
153 }
154
155 if (name_len <= UBI_VOL_NAME_MAX &&
156 strnlen(&r->name[0], name_len + 1) == name_len) {
e28453bb 157 pr_err("\tname %s\n", &r->name[0]);
801c135c 158 } else {
e28453bb 159 pr_err("\t1st 5 characters of name: %c%c%c%c%c\n",
801c135c
AB
160 r->name[0], r->name[1], r->name[2], r->name[3],
161 r->name[4]);
162 }
e28453bb 163 pr_err("\tcrc %#08x\n", be32_to_cpu(r->crc));
801c135c
AB
164}
165
166/**
517af48c
AB
167 * ubi_dump_av - dump a &struct ubi_ainf_volume object.
168 * @av: the object to dump
801c135c 169 */
517af48c 170void ubi_dump_av(const struct ubi_ainf_volume *av)
801c135c 171{
e28453bb
AB
172 pr_err("Volume attaching information dump:\n");
173 pr_err("\tvol_id %d\n", av->vol_id);
174 pr_err("\thighest_lnum %d\n", av->highest_lnum);
175 pr_err("\tleb_count %d\n", av->leb_count);
176 pr_err("\tcompat %d\n", av->compat);
177 pr_err("\tvol_type %d\n", av->vol_type);
178 pr_err("\tused_ebs %d\n", av->used_ebs);
179 pr_err("\tlast_data_size %d\n", av->last_data_size);
180 pr_err("\tdata_pad %d\n", av->data_pad);
801c135c
AB
181}
182
183/**
2c5ec5ce
AB
184 * ubi_dump_aeb - dump a &struct ubi_ainf_peb object.
185 * @aeb: the object to dump
801c135c
AB
186 * @type: object type: 0 - not corrupted, 1 - corrupted
187 */
2c5ec5ce 188void ubi_dump_aeb(const struct ubi_ainf_peb *aeb, int type)
801c135c 189{
e28453bb
AB
190 pr_err("eraseblock attaching information dump:\n");
191 pr_err("\tec %d\n", aeb->ec);
192 pr_err("\tpnum %d\n", aeb->pnum);
801c135c 193 if (type == 0) {
e28453bb
AB
194 pr_err("\tlnum %d\n", aeb->lnum);
195 pr_err("\tscrub %d\n", aeb->scrub);
196 pr_err("\tsqnum %llu\n", aeb->sqnum);
801c135c
AB
197 }
198}
199
200/**
718c00bb 201 * ubi_dump_mkvol_req - dump a &struct ubi_mkvol_req object.
801c135c
AB
202 * @req: the object to dump
203 */
718c00bb 204void ubi_dump_mkvol_req(const struct ubi_mkvol_req *req)
801c135c
AB
205{
206 char nm[17];
207
e28453bb
AB
208 pr_err("Volume creation request dump:\n");
209 pr_err("\tvol_id %d\n", req->vol_id);
210 pr_err("\talignment %d\n", req->alignment);
211 pr_err("\tbytes %lld\n", (long long)req->bytes);
212 pr_err("\tvol_type %d\n", req->vol_type);
213 pr_err("\tname_len %d\n", req->name_len);
801c135c
AB
214
215 memcpy(nm, req->name, 16);
216 nm[16] = 0;
e28453bb 217 pr_err("\t1st 16 characters of name: %s\n", nm);
801c135c
AB
218}
219
2a734bb8
AB
220/*
221 * Root directory for UBI stuff in debugfs. Contains sub-directories which
222 * contain the stuff specific to particular UBI devices.
223 */
224static struct dentry *dfs_rootdir;
225
226/**
227 * ubi_debugfs_init - create UBI debugfs directory.
228 *
229 * Create UBI debugfs directory. Returns zero in case of success and a negative
230 * error code in case of failure.
231 */
232int ubi_debugfs_init(void)
233{
903e0e4e 234 if (!IS_ENABLED(CONFIG_DEBUG_FS))
e9b4cf20
AB
235 return 0;
236
2a734bb8
AB
237 dfs_rootdir = debugfs_create_dir("ubi", NULL);
238 if (IS_ERR_OR_NULL(dfs_rootdir)) {
97cb69dd 239 int err = dfs_rootdir ? PTR_ERR(dfs_rootdir) : -ENODEV;
2a734bb8 240
32608703
TB
241 pr_err("UBI error: cannot create \"ubi\" debugfs directory, error %d\n",
242 err);
2a734bb8
AB
243 return err;
244 }
245
246 return 0;
247}
248
249/**
250 * ubi_debugfs_exit - remove UBI debugfs directory.
251 */
252void ubi_debugfs_exit(void)
253{
903e0e4e 254 if (IS_ENABLED(CONFIG_DEBUG_FS))
e9b4cf20 255 debugfs_remove(dfs_rootdir);
2a734bb8
AB
256}
257
258/* Read an UBI debugfs file */
259static ssize_t dfs_file_read(struct file *file, char __user *user_buf,
260 size_t count, loff_t *ppos)
261{
262 unsigned long ubi_num = (unsigned long)file->private_data;
263 struct dentry *dent = file->f_path.dentry;
264 struct ubi_device *ubi;
265 struct ubi_debug_info *d;
50269067 266 char buf[8];
2a734bb8
AB
267 int val;
268
269 ubi = ubi_get_device(ubi_num);
270 if (!ubi)
271 return -ENODEV;
eab73772 272 d = &ubi->dbg;
2a734bb8
AB
273
274 if (dent == d->dfs_chk_gen)
275 val = d->chk_gen;
276 else if (dent == d->dfs_chk_io)
277 val = d->chk_io;
5fa7fa5d
RW
278 else if (dent == d->dfs_chk_fastmap)
279 val = d->chk_fastmap;
cd6d8567
AB
280 else if (dent == d->dfs_disable_bgt)
281 val = d->disable_bgt;
282 else if (dent == d->dfs_emulate_bitflips)
283 val = d->emulate_bitflips;
284 else if (dent == d->dfs_emulate_io_failures)
285 val = d->emulate_io_failures;
50269067 286 else if (dent == d->dfs_emulate_power_cut) {
287 snprintf(buf, sizeof(buf), "%u\n", d->emulate_power_cut);
288 count = simple_read_from_buffer(user_buf, count, ppos,
289 buf, strlen(buf));
290 goto out;
291 } else if (dent == d->dfs_power_cut_min) {
292 snprintf(buf, sizeof(buf), "%u\n", d->power_cut_min);
293 count = simple_read_from_buffer(user_buf, count, ppos,
294 buf, strlen(buf));
295 goto out;
296 } else if (dent == d->dfs_power_cut_max) {
297 snprintf(buf, sizeof(buf), "%u\n", d->power_cut_max);
298 count = simple_read_from_buffer(user_buf, count, ppos,
299 buf, strlen(buf));
300 goto out;
301 }
2a734bb8
AB
302 else {
303 count = -EINVAL;
304 goto out;
305 }
306
307 if (val)
308 buf[0] = '1';
309 else
310 buf[0] = '0';
311 buf[1] = '\n';
312 buf[2] = 0x00;
313
314 count = simple_read_from_buffer(user_buf, count, ppos, buf, 2);
315
316out:
317 ubi_put_device(ubi);
318 return count;
319}
320
321/* Write an UBI debugfs file */
322static ssize_t dfs_file_write(struct file *file, const char __user *user_buf,
323 size_t count, loff_t *ppos)
324{
325 unsigned long ubi_num = (unsigned long)file->private_data;
326 struct dentry *dent = file->f_path.dentry;
327 struct ubi_device *ubi;
328 struct ubi_debug_info *d;
329 size_t buf_size;
50269067 330 char buf[8] = {0};
2a734bb8
AB
331 int val;
332
333 ubi = ubi_get_device(ubi_num);
334 if (!ubi)
335 return -ENODEV;
eab73772 336 d = &ubi->dbg;
2a734bb8
AB
337
338 buf_size = min_t(size_t, count, (sizeof(buf) - 1));
339 if (copy_from_user(buf, user_buf, buf_size)) {
340 count = -EFAULT;
341 goto out;
342 }
343
50269067 344 if (dent == d->dfs_power_cut_min) {
345 if (kstrtouint(buf, 0, &d->power_cut_min) != 0)
346 count = -EINVAL;
347 goto out;
348 } else if (dent == d->dfs_power_cut_max) {
349 if (kstrtouint(buf, 0, &d->power_cut_max) != 0)
350 count = -EINVAL;
351 goto out;
352 } else if (dent == d->dfs_emulate_power_cut) {
353 if (kstrtoint(buf, 0, &val) != 0)
354 count = -EINVAL;
24663e72
DC
355 else
356 d->emulate_power_cut = val;
50269067 357 goto out;
358 }
359
2a734bb8
AB
360 if (buf[0] == '1')
361 val = 1;
362 else if (buf[0] == '0')
363 val = 0;
364 else {
365 count = -EINVAL;
366 goto out;
367 }
368
369 if (dent == d->dfs_chk_gen)
370 d->chk_gen = val;
371 else if (dent == d->dfs_chk_io)
372 d->chk_io = val;
5fa7fa5d
RW
373 else if (dent == d->dfs_chk_fastmap)
374 d->chk_fastmap = val;
cd6d8567
AB
375 else if (dent == d->dfs_disable_bgt)
376 d->disable_bgt = val;
377 else if (dent == d->dfs_emulate_bitflips)
378 d->emulate_bitflips = val;
379 else if (dent == d->dfs_emulate_io_failures)
380 d->emulate_io_failures = val;
2a734bb8
AB
381 else
382 count = -EINVAL;
383
384out:
385 ubi_put_device(ubi);
386 return count;
387}
388
2a734bb8
AB
389/* File operations for all UBI debugfs files */
390static const struct file_operations dfs_fops = {
391 .read = dfs_file_read,
392 .write = dfs_file_write,
234e3405 393 .open = simple_open,
2a734bb8
AB
394 .llseek = no_llseek,
395 .owner = THIS_MODULE,
396};
397
398/**
399 * ubi_debugfs_init_dev - initialize debugfs for an UBI device.
400 * @ubi: UBI device description object
401 *
402 * This function creates all debugfs files for UBI device @ubi. Returns zero in
403 * case of success and a negative error code in case of failure.
404 */
405int ubi_debugfs_init_dev(struct ubi_device *ubi)
406{
407 int err, n;
408 unsigned long ubi_num = ubi->ubi_num;
409 const char *fname;
410 struct dentry *dent;
eab73772 411 struct ubi_debug_info *d = &ubi->dbg;
2a734bb8 412
903e0e4e 413 if (!IS_ENABLED(CONFIG_DEBUG_FS))
e9b4cf20
AB
414 return 0;
415
2a734bb8
AB
416 n = snprintf(d->dfs_dir_name, UBI_DFS_DIR_LEN + 1, UBI_DFS_DIR_NAME,
417 ubi->ubi_num);
418 if (n == UBI_DFS_DIR_LEN) {
419 /* The array size is too small */
420 fname = UBI_DFS_DIR_NAME;
421 dent = ERR_PTR(-EINVAL);
422 goto out;
423 }
424
425 fname = d->dfs_dir_name;
426 dent = debugfs_create_dir(fname, dfs_rootdir);
427 if (IS_ERR_OR_NULL(dent))
428 goto out;
429 d->dfs_dir = dent;
430
431 fname = "chk_gen";
432 dent = debugfs_create_file(fname, S_IWUSR, d->dfs_dir, (void *)ubi_num,
433 &dfs_fops);
434 if (IS_ERR_OR_NULL(dent))
435 goto out_remove;
436 d->dfs_chk_gen = dent;
437
438 fname = "chk_io";
439 dent = debugfs_create_file(fname, S_IWUSR, d->dfs_dir, (void *)ubi_num,
440 &dfs_fops);
441 if (IS_ERR_OR_NULL(dent))
442 goto out_remove;
443 d->dfs_chk_io = dent;
444
5fa7fa5d
RW
445 fname = "chk_fastmap";
446 dent = debugfs_create_file(fname, S_IWUSR, d->dfs_dir, (void *)ubi_num,
447 &dfs_fops);
448 if (IS_ERR_OR_NULL(dent))
449 goto out_remove;
450 d->dfs_chk_fastmap = dent;
451
cd6d8567
AB
452 fname = "tst_disable_bgt";
453 dent = debugfs_create_file(fname, S_IWUSR, d->dfs_dir, (void *)ubi_num,
454 &dfs_fops);
455 if (IS_ERR_OR_NULL(dent))
456 goto out_remove;
457 d->dfs_disable_bgt = dent;
458
459 fname = "tst_emulate_bitflips";
460 dent = debugfs_create_file(fname, S_IWUSR, d->dfs_dir, (void *)ubi_num,
461 &dfs_fops);
462 if (IS_ERR_OR_NULL(dent))
463 goto out_remove;
464 d->dfs_emulate_bitflips = dent;
465
466 fname = "tst_emulate_io_failures";
467 dent = debugfs_create_file(fname, S_IWUSR, d->dfs_dir, (void *)ubi_num,
468 &dfs_fops);
469 if (IS_ERR_OR_NULL(dent))
470 goto out_remove;
471 d->dfs_emulate_io_failures = dent;
472
50269067 473 fname = "tst_emulate_power_cut";
474 dent = debugfs_create_file(fname, S_IWUSR, d->dfs_dir, (void *)ubi_num,
475 &dfs_fops);
476 if (IS_ERR_OR_NULL(dent))
477 goto out_remove;
478 d->dfs_emulate_power_cut = dent;
479
480 fname = "tst_emulate_power_cut_min";
481 dent = debugfs_create_file(fname, S_IWUSR, d->dfs_dir, (void *)ubi_num,
482 &dfs_fops);
483 if (IS_ERR_OR_NULL(dent))
484 goto out_remove;
485 d->dfs_power_cut_min = dent;
486
487 fname = "tst_emulate_power_cut_max";
488 dent = debugfs_create_file(fname, S_IWUSR, d->dfs_dir, (void *)ubi_num,
489 &dfs_fops);
490 if (IS_ERR_OR_NULL(dent))
491 goto out_remove;
492 d->dfs_power_cut_max = dent;
493
2a734bb8
AB
494 return 0;
495
496out_remove:
497 debugfs_remove_recursive(d->dfs_dir);
498out:
499 err = dent ? PTR_ERR(dent) : -ENODEV;
32608703 500 ubi_err(ubi, "cannot create \"%s\" debugfs file or directory, error %d\n",
2a734bb8
AB
501 fname, err);
502 return err;
503}
504
505/**
506 * dbg_debug_exit_dev - free all debugfs files corresponding to device @ubi
507 * @ubi: UBI device description object
508 */
509void ubi_debugfs_exit_dev(struct ubi_device *ubi)
510{
903e0e4e 511 if (IS_ENABLED(CONFIG_DEBUG_FS))
eab73772 512 debugfs_remove_recursive(ubi->dbg.dfs_dir);
2a734bb8 513}
50269067 514
515/**
516 * ubi_dbg_power_cut - emulate a power cut if it is time to do so
517 * @ubi: UBI device description object
518 * @caller: Flags set to indicate from where the function is being called
519 *
520 * Returns non-zero if a power cut was emulated, zero if not.
521 */
522int ubi_dbg_power_cut(struct ubi_device *ubi, int caller)
523{
524 unsigned int range;
525
526 if ((ubi->dbg.emulate_power_cut & caller) == 0)
527 return 0;
528
529 if (ubi->dbg.power_cut_counter == 0) {
530 ubi->dbg.power_cut_counter = ubi->dbg.power_cut_min;
531
532 if (ubi->dbg.power_cut_max > ubi->dbg.power_cut_min) {
533 range = ubi->dbg.power_cut_max - ubi->dbg.power_cut_min;
534 ubi->dbg.power_cut_counter += prandom_u32() % range;
535 }
536 return 0;
537 }
538
539 ubi->dbg.power_cut_counter--;
540 if (ubi->dbg.power_cut_counter)
541 return 0;
542
543 ubi_msg(ubi, "XXXXXXXXXXXXXXX emulating a power cut XXXXXXXXXXXXXXXX");
544 ubi_ro_mode(ubi);
545 return 1;
546}
This page took 0.726117 seconds and 5 git commands to generate.