Loading...
1// SPDX-License-Identifier: GPL-2.0-or-later
2/*
3 * Copyright (c) International Business Machines Corp., 2006
4 *
5 * Author: Artem Bityutskiy (Битюцкий Артём)
6 */
7
8#include "ubi.h"
9#include <linux/debugfs.h>
10#include <linux/uaccess.h>
11#include <linux/module.h>
12#include <linux/seq_file.h>
13#include <linux/fault-inject.h>
14
15#ifdef CONFIG_MTD_UBI_FAULT_INJECTION
16static DECLARE_FAULT_ATTR(fault_eccerr_attr);
17static DECLARE_FAULT_ATTR(fault_bitflips_attr);
18static DECLARE_FAULT_ATTR(fault_read_failure_attr);
19static DECLARE_FAULT_ATTR(fault_write_failure_attr);
20static DECLARE_FAULT_ATTR(fault_erase_failure_attr);
21static DECLARE_FAULT_ATTR(fault_power_cut_attr);
22static DECLARE_FAULT_ATTR(fault_io_ff_attr);
23static DECLARE_FAULT_ATTR(fault_io_ff_bitflips_attr);
24static DECLARE_FAULT_ATTR(fault_bad_hdr_attr);
25static DECLARE_FAULT_ATTR(fault_bad_hdr_ebadmsg_attr);
26
27#define FAIL_ACTION(name, fault_attr) \
28bool should_fail_##name(void) \
29{ \
30 return should_fail(&fault_attr, 1); \
31}
32
33FAIL_ACTION(eccerr, fault_eccerr_attr)
34FAIL_ACTION(bitflips, fault_bitflips_attr)
35FAIL_ACTION(read_failure, fault_read_failure_attr)
36FAIL_ACTION(write_failure, fault_write_failure_attr)
37FAIL_ACTION(erase_failure, fault_erase_failure_attr)
38FAIL_ACTION(power_cut, fault_power_cut_attr)
39FAIL_ACTION(io_ff, fault_io_ff_attr)
40FAIL_ACTION(io_ff_bitflips, fault_io_ff_bitflips_attr)
41FAIL_ACTION(bad_hdr, fault_bad_hdr_attr)
42FAIL_ACTION(bad_hdr_ebadmsg, fault_bad_hdr_ebadmsg_attr)
43#endif
44
45/**
46 * ubi_dump_flash - dump a region of flash.
47 * @ubi: UBI device description object
48 * @pnum: the physical eraseblock number to dump
49 * @offset: the starting offset within the physical eraseblock to dump
50 * @len: the length of the region to dump
51 */
52void ubi_dump_flash(struct ubi_device *ubi, int pnum, int offset, int len)
53{
54 int err;
55 size_t read;
56 void *buf;
57 loff_t addr = (loff_t)pnum * ubi->peb_size + offset;
58
59 buf = vmalloc(len);
60 if (!buf)
61 return;
62 err = mtd_read(ubi->mtd, addr, len, &read, buf);
63 if (err && err != -EUCLEAN) {
64 ubi_err(ubi, "err %d while reading %d bytes from PEB %d:%d, read %zd bytes",
65 err, len, pnum, offset, read);
66 goto out;
67 }
68
69 ubi_msg(ubi, "dumping %d bytes of data from PEB %d, offset %d",
70 len, pnum, offset);
71 print_hex_dump(KERN_DEBUG, "", DUMP_PREFIX_OFFSET, 32, 1, buf, len, 1);
72out:
73 vfree(buf);
74 return;
75}
76
77/**
78 * ubi_dump_ec_hdr - dump an erase counter header.
79 * @ec_hdr: the erase counter header to dump
80 */
81void ubi_dump_ec_hdr(const struct ubi_ec_hdr *ec_hdr)
82{
83 pr_err("Erase counter header dump:\n");
84 pr_err("\tmagic %#08x\n", be32_to_cpu(ec_hdr->magic));
85 pr_err("\tversion %d\n", (int)ec_hdr->version);
86 pr_err("\tec %llu\n", (long long)be64_to_cpu(ec_hdr->ec));
87 pr_err("\tvid_hdr_offset %d\n", be32_to_cpu(ec_hdr->vid_hdr_offset));
88 pr_err("\tdata_offset %d\n", be32_to_cpu(ec_hdr->data_offset));
89 pr_err("\timage_seq %d\n", be32_to_cpu(ec_hdr->image_seq));
90 pr_err("\thdr_crc %#08x\n", be32_to_cpu(ec_hdr->hdr_crc));
91 pr_err("erase counter header hexdump:\n");
92 print_hex_dump(KERN_DEBUG, "", DUMP_PREFIX_OFFSET, 32, 1,
93 ec_hdr, UBI_EC_HDR_SIZE, 1);
94}
95
96/**
97 * ubi_dump_vid_hdr - dump a volume identifier header.
98 * @vid_hdr: the volume identifier header to dump
99 */
100void ubi_dump_vid_hdr(const struct ubi_vid_hdr *vid_hdr)
101{
102 pr_err("Volume identifier header dump:\n");
103 pr_err("\tmagic %08x\n", be32_to_cpu(vid_hdr->magic));
104 pr_err("\tversion %d\n", (int)vid_hdr->version);
105 pr_err("\tvol_type %d\n", (int)vid_hdr->vol_type);
106 pr_err("\tcopy_flag %d\n", (int)vid_hdr->copy_flag);
107 pr_err("\tcompat %d\n", (int)vid_hdr->compat);
108 pr_err("\tvol_id %d\n", be32_to_cpu(vid_hdr->vol_id));
109 pr_err("\tlnum %d\n", be32_to_cpu(vid_hdr->lnum));
110 pr_err("\tdata_size %d\n", be32_to_cpu(vid_hdr->data_size));
111 pr_err("\tused_ebs %d\n", be32_to_cpu(vid_hdr->used_ebs));
112 pr_err("\tdata_pad %d\n", be32_to_cpu(vid_hdr->data_pad));
113 pr_err("\tsqnum %llu\n",
114 (unsigned long long)be64_to_cpu(vid_hdr->sqnum));
115 pr_err("\thdr_crc %08x\n", be32_to_cpu(vid_hdr->hdr_crc));
116 pr_err("Volume identifier header hexdump:\n");
117 print_hex_dump(KERN_DEBUG, "", DUMP_PREFIX_OFFSET, 32, 1,
118 vid_hdr, UBI_VID_HDR_SIZE, 1);
119}
120
121/**
122 * ubi_dump_vol_info - dump volume information.
123 * @vol: UBI volume description object
124 */
125void ubi_dump_vol_info(const struct ubi_volume *vol)
126{
127 pr_err("Volume information dump:\n");
128 pr_err("\tvol_id %d\n", vol->vol_id);
129 pr_err("\treserved_pebs %d\n", vol->reserved_pebs);
130 pr_err("\talignment %d\n", vol->alignment);
131 pr_err("\tdata_pad %d\n", vol->data_pad);
132 pr_err("\tvol_type %d\n", vol->vol_type);
133 pr_err("\tname_len %d\n", vol->name_len);
134 pr_err("\tusable_leb_size %d\n", vol->usable_leb_size);
135 pr_err("\tused_ebs %d\n", vol->used_ebs);
136 pr_err("\tused_bytes %lld\n", vol->used_bytes);
137 pr_err("\tlast_eb_bytes %d\n", vol->last_eb_bytes);
138 pr_err("\tcorrupted %d\n", vol->corrupted);
139 pr_err("\tupd_marker %d\n", vol->upd_marker);
140 pr_err("\tskip_check %d\n", vol->skip_check);
141
142 if (vol->name_len <= UBI_VOL_NAME_MAX &&
143 strnlen(vol->name, vol->name_len + 1) == vol->name_len) {
144 pr_err("\tname %s\n", vol->name);
145 } else {
146 pr_err("\t1st 5 characters of name: %c%c%c%c%c\n",
147 vol->name[0], vol->name[1], vol->name[2],
148 vol->name[3], vol->name[4]);
149 }
150}
151
152/**
153 * ubi_dump_vtbl_record - dump a &struct ubi_vtbl_record object.
154 * @r: the object to dump
155 * @idx: volume table index
156 */
157void ubi_dump_vtbl_record(const struct ubi_vtbl_record *r, int idx)
158{
159 int name_len = be16_to_cpu(r->name_len);
160
161 pr_err("Volume table record %d dump:\n", idx);
162 pr_err("\treserved_pebs %d\n", be32_to_cpu(r->reserved_pebs));
163 pr_err("\talignment %d\n", be32_to_cpu(r->alignment));
164 pr_err("\tdata_pad %d\n", be32_to_cpu(r->data_pad));
165 pr_err("\tvol_type %d\n", (int)r->vol_type);
166 pr_err("\tupd_marker %d\n", (int)r->upd_marker);
167 pr_err("\tname_len %d\n", name_len);
168
169 if (r->name[0] == '\0') {
170 pr_err("\tname NULL\n");
171 return;
172 }
173
174 if (name_len <= UBI_VOL_NAME_MAX &&
175 strnlen(&r->name[0], name_len + 1) == name_len) {
176 pr_err("\tname %s\n", &r->name[0]);
177 } else {
178 pr_err("\t1st 5 characters of name: %c%c%c%c%c\n",
179 r->name[0], r->name[1], r->name[2], r->name[3],
180 r->name[4]);
181 }
182 pr_err("\tcrc %#08x\n", be32_to_cpu(r->crc));
183}
184
185/**
186 * ubi_dump_av - dump a &struct ubi_ainf_volume object.
187 * @av: the object to dump
188 */
189void ubi_dump_av(const struct ubi_ainf_volume *av)
190{
191 pr_err("Volume attaching information dump:\n");
192 pr_err("\tvol_id %d\n", av->vol_id);
193 pr_err("\thighest_lnum %d\n", av->highest_lnum);
194 pr_err("\tleb_count %d\n", av->leb_count);
195 pr_err("\tcompat %d\n", av->compat);
196 pr_err("\tvol_type %d\n", av->vol_type);
197 pr_err("\tused_ebs %d\n", av->used_ebs);
198 pr_err("\tlast_data_size %d\n", av->last_data_size);
199 pr_err("\tdata_pad %d\n", av->data_pad);
200}
201
202/**
203 * ubi_dump_aeb - dump a &struct ubi_ainf_peb object.
204 * @aeb: the object to dump
205 * @type: object type: 0 - not corrupted, 1 - corrupted
206 */
207void ubi_dump_aeb(const struct ubi_ainf_peb *aeb, int type)
208{
209 pr_err("eraseblock attaching information dump:\n");
210 pr_err("\tec %d\n", aeb->ec);
211 pr_err("\tpnum %d\n", aeb->pnum);
212 if (type == 0) {
213 pr_err("\tlnum %d\n", aeb->lnum);
214 pr_err("\tscrub %d\n", aeb->scrub);
215 pr_err("\tsqnum %llu\n", aeb->sqnum);
216 }
217}
218
219/**
220 * ubi_dump_mkvol_req - dump a &struct ubi_mkvol_req object.
221 * @req: the object to dump
222 */
223void ubi_dump_mkvol_req(const struct ubi_mkvol_req *req)
224{
225 char nm[17];
226
227 pr_err("Volume creation request dump:\n");
228 pr_err("\tvol_id %d\n", req->vol_id);
229 pr_err("\talignment %d\n", req->alignment);
230 pr_err("\tbytes %lld\n", (long long)req->bytes);
231 pr_err("\tvol_type %d\n", req->vol_type);
232 pr_err("\tname_len %d\n", req->name_len);
233
234 memcpy(nm, req->name, 16);
235 nm[16] = 0;
236 pr_err("\t1st 16 characters of name: %s\n", nm);
237}
238
239/*
240 * Root directory for UBI stuff in debugfs. Contains sub-directories which
241 * contain the stuff specific to particular UBI devices.
242 */
243static struct dentry *dfs_rootdir;
244
245#ifdef CONFIG_MTD_UBI_FAULT_INJECTION
246static void dfs_create_fault_entry(struct dentry *parent)
247{
248 struct dentry *dir;
249
250 dir = debugfs_create_dir("fault_inject", parent);
251 if (IS_ERR_OR_NULL(dir)) {
252 int err = dir ? PTR_ERR(dir) : -ENODEV;
253
254 pr_warn("UBI error: cannot create \"fault_inject\" debugfs directory, error %d\n",
255 err);
256 return;
257 }
258
259 fault_create_debugfs_attr("emulate_eccerr", dir,
260 &fault_eccerr_attr);
261
262 fault_create_debugfs_attr("emulate_read_failure", dir,
263 &fault_read_failure_attr);
264
265 fault_create_debugfs_attr("emulate_bitflips", dir,
266 &fault_bitflips_attr);
267
268 fault_create_debugfs_attr("emulate_write_failure", dir,
269 &fault_write_failure_attr);
270
271 fault_create_debugfs_attr("emulate_erase_failure", dir,
272 &fault_erase_failure_attr);
273
274 fault_create_debugfs_attr("emulate_power_cut", dir,
275 &fault_power_cut_attr);
276
277 fault_create_debugfs_attr("emulate_io_ff", dir,
278 &fault_io_ff_attr);
279
280 fault_create_debugfs_attr("emulate_io_ff_bitflips", dir,
281 &fault_io_ff_bitflips_attr);
282
283 fault_create_debugfs_attr("emulate_bad_hdr", dir,
284 &fault_bad_hdr_attr);
285
286 fault_create_debugfs_attr("emulate_bad_hdr_ebadmsg", dir,
287 &fault_bad_hdr_ebadmsg_attr);
288}
289#endif
290
291/**
292 * ubi_debugfs_init - create UBI debugfs directory.
293 *
294 * Create UBI debugfs directory. Returns zero in case of success and a negative
295 * error code in case of failure.
296 */
297int ubi_debugfs_init(void)
298{
299 if (!IS_ENABLED(CONFIG_DEBUG_FS))
300 return 0;
301
302 dfs_rootdir = debugfs_create_dir("ubi", NULL);
303 if (IS_ERR_OR_NULL(dfs_rootdir)) {
304 int err = dfs_rootdir ? PTR_ERR(dfs_rootdir) : -ENODEV;
305
306 pr_err("UBI error: cannot create \"ubi\" debugfs directory, error %d\n",
307 err);
308 return err;
309 }
310
311#ifdef CONFIG_MTD_UBI_FAULT_INJECTION
312 dfs_create_fault_entry(dfs_rootdir);
313#endif
314
315 return 0;
316}
317
318/**
319 * ubi_debugfs_exit - remove UBI debugfs directory.
320 */
321void ubi_debugfs_exit(void)
322{
323 if (IS_ENABLED(CONFIG_DEBUG_FS))
324 debugfs_remove(dfs_rootdir);
325}
326
327/* Read an UBI debugfs file */
328static ssize_t dfs_file_read(struct file *file, char __user *user_buf,
329 size_t count, loff_t *ppos)
330{
331 unsigned long ubi_num = (unsigned long)file->private_data;
332 struct dentry *dent = file->f_path.dentry;
333 struct ubi_device *ubi;
334 struct ubi_debug_info *d;
335 char buf[16];
336 int val;
337
338 ubi = ubi_get_device(ubi_num);
339 if (!ubi)
340 return -ENODEV;
341 d = &ubi->dbg;
342
343 if (dent == d->dfs_chk_gen)
344 val = d->chk_gen;
345 else if (dent == d->dfs_chk_io)
346 val = d->chk_io;
347 else if (dent == d->dfs_chk_fastmap)
348 val = d->chk_fastmap;
349 else if (dent == d->dfs_disable_bgt)
350 val = d->disable_bgt;
351 else if (dent == d->dfs_emulate_bitflips)
352 val = d->emulate_bitflips;
353 else if (dent == d->dfs_emulate_io_failures)
354 val = d->emulate_io_failures;
355 else if (dent == d->dfs_emulate_failures) {
356 snprintf(buf, sizeof(buf), "0x%04x\n", d->emulate_failures);
357 count = simple_read_from_buffer(user_buf, count, ppos,
358 buf, strlen(buf));
359 goto out;
360 } else if (dent == d->dfs_emulate_power_cut) {
361 snprintf(buf, sizeof(buf), "%u\n", d->emulate_power_cut);
362 count = simple_read_from_buffer(user_buf, count, ppos,
363 buf, strlen(buf));
364 goto out;
365 } else if (dent == d->dfs_power_cut_min) {
366 snprintf(buf, sizeof(buf), "%u\n", d->power_cut_min);
367 count = simple_read_from_buffer(user_buf, count, ppos,
368 buf, strlen(buf));
369 goto out;
370 } else if (dent == d->dfs_power_cut_max) {
371 snprintf(buf, sizeof(buf), "%u\n", d->power_cut_max);
372 count = simple_read_from_buffer(user_buf, count, ppos,
373 buf, strlen(buf));
374 goto out;
375 } else {
376 count = -EINVAL;
377 goto out;
378 }
379
380 if (val)
381 buf[0] = '1';
382 else
383 buf[0] = '0';
384 buf[1] = '\n';
385 buf[2] = 0x00;
386
387 count = simple_read_from_buffer(user_buf, count, ppos, buf, 2);
388
389out:
390 ubi_put_device(ubi);
391 return count;
392}
393
394/* Write an UBI debugfs file */
395static ssize_t dfs_file_write(struct file *file, const char __user *user_buf,
396 size_t count, loff_t *ppos)
397{
398 unsigned long ubi_num = (unsigned long)file->private_data;
399 struct dentry *dent = file->f_path.dentry;
400 struct ubi_device *ubi;
401 struct ubi_debug_info *d;
402 size_t buf_size;
403 char buf[16] = {0};
404 int val;
405
406 ubi = ubi_get_device(ubi_num);
407 if (!ubi)
408 return -ENODEV;
409 d = &ubi->dbg;
410
411 buf_size = min_t(size_t, count, (sizeof(buf) - 1));
412 if (copy_from_user(buf, user_buf, buf_size)) {
413 count = -EFAULT;
414 goto out;
415 }
416
417 if (dent == d->dfs_emulate_failures) {
418 if (kstrtouint(buf, 0, &d->emulate_failures) != 0)
419 count = -EINVAL;
420 goto out;
421 } else if (dent == d->dfs_power_cut_min) {
422 if (kstrtouint(buf, 0, &d->power_cut_min) != 0)
423 count = -EINVAL;
424 goto out;
425 } else if (dent == d->dfs_power_cut_max) {
426 if (kstrtouint(buf, 0, &d->power_cut_max) != 0)
427 count = -EINVAL;
428 goto out;
429 } else if (dent == d->dfs_emulate_power_cut) {
430 if (kstrtoint(buf, 0, &val) != 0)
431 count = -EINVAL;
432 else
433 d->emulate_power_cut = val;
434 goto out;
435 }
436
437 if (buf[0] == '1')
438 val = 1;
439 else if (buf[0] == '0')
440 val = 0;
441 else {
442 count = -EINVAL;
443 goto out;
444 }
445
446 if (dent == d->dfs_chk_gen)
447 d->chk_gen = val;
448 else if (dent == d->dfs_chk_io)
449 d->chk_io = val;
450 else if (dent == d->dfs_chk_fastmap)
451 d->chk_fastmap = val;
452 else if (dent == d->dfs_disable_bgt)
453 d->disable_bgt = val;
454 else if (dent == d->dfs_emulate_bitflips)
455 d->emulate_bitflips = val;
456 else if (dent == d->dfs_emulate_io_failures)
457 d->emulate_io_failures = val;
458 else
459 count = -EINVAL;
460
461out:
462 ubi_put_device(ubi);
463 return count;
464}
465
466/* File operations for all UBI debugfs files except
467 * detailed_erase_block_info
468 */
469static const struct file_operations dfs_fops = {
470 .read = dfs_file_read,
471 .write = dfs_file_write,
472 .open = simple_open,
473 .llseek = no_llseek,
474 .owner = THIS_MODULE,
475};
476
477/* As long as the position is less then that total number of erase blocks,
478 * we still have more to print.
479 */
480static void *eraseblk_count_seq_start(struct seq_file *s, loff_t *pos)
481{
482 struct ubi_device *ubi = s->private;
483
484 if (*pos < ubi->peb_count)
485 return pos;
486
487 return NULL;
488}
489
490/* Since we are using the position as the iterator, we just need to check if we
491 * are done and increment the position.
492 */
493static void *eraseblk_count_seq_next(struct seq_file *s, void *v, loff_t *pos)
494{
495 struct ubi_device *ubi = s->private;
496
497 (*pos)++;
498
499 if (*pos < ubi->peb_count)
500 return pos;
501
502 return NULL;
503}
504
505static void eraseblk_count_seq_stop(struct seq_file *s, void *v)
506{
507}
508
509static int eraseblk_count_seq_show(struct seq_file *s, void *iter)
510{
511 struct ubi_device *ubi = s->private;
512 struct ubi_wl_entry *wl;
513 int *block_number = iter;
514 int erase_count = -1;
515 int err;
516
517 /* If this is the start, print a header */
518 if (*block_number == 0)
519 seq_puts(s, "physical_block_number\terase_count\n");
520
521 err = ubi_io_is_bad(ubi, *block_number);
522 if (err)
523 return err;
524
525 spin_lock(&ubi->wl_lock);
526
527 wl = ubi->lookuptbl[*block_number];
528 if (wl)
529 erase_count = wl->ec;
530
531 spin_unlock(&ubi->wl_lock);
532
533 if (erase_count < 0)
534 return 0;
535
536 seq_printf(s, "%-22d\t%-11d\n", *block_number, erase_count);
537
538 return 0;
539}
540
541static const struct seq_operations eraseblk_count_seq_ops = {
542 .start = eraseblk_count_seq_start,
543 .next = eraseblk_count_seq_next,
544 .stop = eraseblk_count_seq_stop,
545 .show = eraseblk_count_seq_show
546};
547
548static int eraseblk_count_open(struct inode *inode, struct file *f)
549{
550 struct seq_file *s;
551 int err;
552
553 err = seq_open(f, &eraseblk_count_seq_ops);
554 if (err)
555 return err;
556
557 s = f->private_data;
558 s->private = ubi_get_device((unsigned long)inode->i_private);
559
560 if (!s->private)
561 return -ENODEV;
562 else
563 return 0;
564}
565
566static int eraseblk_count_release(struct inode *inode, struct file *f)
567{
568 struct seq_file *s = f->private_data;
569 struct ubi_device *ubi = s->private;
570
571 ubi_put_device(ubi);
572
573 return seq_release(inode, f);
574}
575
576static const struct file_operations eraseblk_count_fops = {
577 .owner = THIS_MODULE,
578 .open = eraseblk_count_open,
579 .read = seq_read,
580 .llseek = seq_lseek,
581 .release = eraseblk_count_release,
582};
583
584/**
585 * ubi_debugfs_init_dev - initialize debugfs for an UBI device.
586 * @ubi: UBI device description object
587 *
588 * This function creates all debugfs files for UBI device @ubi. Returns zero in
589 * case of success and a negative error code in case of failure.
590 */
591int ubi_debugfs_init_dev(struct ubi_device *ubi)
592{
593 unsigned long ubi_num = ubi->ubi_num;
594 struct ubi_debug_info *d = &ubi->dbg;
595 umode_t mode = S_IRUSR | S_IWUSR;
596 int n;
597
598 if (!IS_ENABLED(CONFIG_DEBUG_FS))
599 return 0;
600
601 n = snprintf(d->dfs_dir_name, UBI_DFS_DIR_LEN + 1, UBI_DFS_DIR_NAME,
602 ubi->ubi_num);
603 if (n > UBI_DFS_DIR_LEN) {
604 /* The array size is too small */
605 return -EINVAL;
606 }
607
608 d->dfs_dir = debugfs_create_dir(d->dfs_dir_name, dfs_rootdir);
609
610 d->dfs_chk_gen = debugfs_create_file("chk_gen", mode, d->dfs_dir,
611 (void *)ubi_num, &dfs_fops);
612
613 d->dfs_chk_io = debugfs_create_file("chk_io", mode, d->dfs_dir,
614 (void *)ubi_num, &dfs_fops);
615
616 d->dfs_chk_fastmap = debugfs_create_file("chk_fastmap", mode,
617 d->dfs_dir, (void *)ubi_num,
618 &dfs_fops);
619
620 d->dfs_disable_bgt = debugfs_create_file("tst_disable_bgt", mode,
621 d->dfs_dir, (void *)ubi_num,
622 &dfs_fops);
623
624 d->dfs_emulate_bitflips = debugfs_create_file("tst_emulate_bitflips",
625 mode, d->dfs_dir,
626 (void *)ubi_num,
627 &dfs_fops);
628
629 d->dfs_emulate_io_failures = debugfs_create_file("tst_emulate_io_failures",
630 mode, d->dfs_dir,
631 (void *)ubi_num,
632 &dfs_fops);
633
634 d->dfs_emulate_power_cut = debugfs_create_file("tst_emulate_power_cut",
635 mode, d->dfs_dir,
636 (void *)ubi_num,
637 &dfs_fops);
638
639 d->dfs_power_cut_min = debugfs_create_file("tst_emulate_power_cut_min",
640 mode, d->dfs_dir,
641 (void *)ubi_num, &dfs_fops);
642
643 d->dfs_power_cut_max = debugfs_create_file("tst_emulate_power_cut_max",
644 mode, d->dfs_dir,
645 (void *)ubi_num, &dfs_fops);
646
647 debugfs_create_file("detailed_erase_block_info", S_IRUSR, d->dfs_dir,
648 (void *)ubi_num, &eraseblk_count_fops);
649
650#ifdef CONFIG_MTD_UBI_FAULT_INJECTION
651 d->dfs_emulate_failures = debugfs_create_file("emulate_failures",
652 mode, d->dfs_dir,
653 (void *)ubi_num,
654 &dfs_fops);
655#endif
656 return 0;
657}
658
659/**
660 * ubi_debugfs_exit_dev - free all debugfs files corresponding to device @ubi
661 * @ubi: UBI device description object
662 */
663void ubi_debugfs_exit_dev(struct ubi_device *ubi)
664{
665 if (IS_ENABLED(CONFIG_DEBUG_FS))
666 debugfs_remove_recursive(ubi->dbg.dfs_dir);
667}
668
669/**
670 * ubi_dbg_power_cut - emulate a power cut if it is time to do so
671 * @ubi: UBI device description object
672 * @caller: Flags set to indicate from where the function is being called
673 *
674 * Returns non-zero if a power cut was emulated, zero if not.
675 */
676int ubi_dbg_power_cut(struct ubi_device *ubi, int caller)
677{
678 unsigned int range;
679
680 if ((ubi->dbg.emulate_power_cut & caller) == 0)
681 return 0;
682
683 if (ubi->dbg.power_cut_counter == 0) {
684 ubi->dbg.power_cut_counter = ubi->dbg.power_cut_min;
685
686 if (ubi->dbg.power_cut_max > ubi->dbg.power_cut_min) {
687 range = ubi->dbg.power_cut_max - ubi->dbg.power_cut_min;
688 ubi->dbg.power_cut_counter += get_random_u32_below(range);
689 }
690 return 0;
691 }
692
693 ubi->dbg.power_cut_counter--;
694 if (ubi->dbg.power_cut_counter)
695 return 0;
696
697 return 1;
698}
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
21#include "ubi.h"
22#include <linux/debugfs.h>
23#include <linux/uaccess.h>
24#include <linux/module.h>
25#include <linux/seq_file.h>
26
27
28/**
29 * ubi_dump_flash - dump a region of flash.
30 * @ubi: UBI device description object
31 * @pnum: the physical eraseblock number to dump
32 * @offset: the starting offset within the physical eraseblock to dump
33 * @len: the length of the region to dump
34 */
35void ubi_dump_flash(struct ubi_device *ubi, int pnum, int offset, int len)
36{
37 int err;
38 size_t read;
39 void *buf;
40 loff_t addr = (loff_t)pnum * ubi->peb_size + offset;
41
42 buf = vmalloc(len);
43 if (!buf)
44 return;
45 err = mtd_read(ubi->mtd, addr, len, &read, buf);
46 if (err && err != -EUCLEAN) {
47 ubi_err(ubi, "err %d while reading %d bytes from PEB %d:%d, read %zd bytes",
48 err, len, pnum, offset, read);
49 goto out;
50 }
51
52 ubi_msg(ubi, "dumping %d bytes of data from PEB %d, offset %d",
53 len, pnum, offset);
54 print_hex_dump(KERN_DEBUG, "", DUMP_PREFIX_OFFSET, 32, 1, buf, len, 1);
55out:
56 vfree(buf);
57 return;
58}
59
60/**
61 * ubi_dump_ec_hdr - dump an erase counter header.
62 * @ec_hdr: the erase counter header to dump
63 */
64void ubi_dump_ec_hdr(const struct ubi_ec_hdr *ec_hdr)
65{
66 pr_err("Erase counter header dump:\n");
67 pr_err("\tmagic %#08x\n", be32_to_cpu(ec_hdr->magic));
68 pr_err("\tversion %d\n", (int)ec_hdr->version);
69 pr_err("\tec %llu\n", (long long)be64_to_cpu(ec_hdr->ec));
70 pr_err("\tvid_hdr_offset %d\n", be32_to_cpu(ec_hdr->vid_hdr_offset));
71 pr_err("\tdata_offset %d\n", be32_to_cpu(ec_hdr->data_offset));
72 pr_err("\timage_seq %d\n", be32_to_cpu(ec_hdr->image_seq));
73 pr_err("\thdr_crc %#08x\n", be32_to_cpu(ec_hdr->hdr_crc));
74 pr_err("erase counter header hexdump:\n");
75 print_hex_dump(KERN_DEBUG, "", DUMP_PREFIX_OFFSET, 32, 1,
76 ec_hdr, UBI_EC_HDR_SIZE, 1);
77}
78
79/**
80 * ubi_dump_vid_hdr - dump a volume identifier header.
81 * @vid_hdr: the volume identifier header to dump
82 */
83void ubi_dump_vid_hdr(const struct ubi_vid_hdr *vid_hdr)
84{
85 pr_err("Volume identifier header dump:\n");
86 pr_err("\tmagic %08x\n", be32_to_cpu(vid_hdr->magic));
87 pr_err("\tversion %d\n", (int)vid_hdr->version);
88 pr_err("\tvol_type %d\n", (int)vid_hdr->vol_type);
89 pr_err("\tcopy_flag %d\n", (int)vid_hdr->copy_flag);
90 pr_err("\tcompat %d\n", (int)vid_hdr->compat);
91 pr_err("\tvol_id %d\n", be32_to_cpu(vid_hdr->vol_id));
92 pr_err("\tlnum %d\n", be32_to_cpu(vid_hdr->lnum));
93 pr_err("\tdata_size %d\n", be32_to_cpu(vid_hdr->data_size));
94 pr_err("\tused_ebs %d\n", be32_to_cpu(vid_hdr->used_ebs));
95 pr_err("\tdata_pad %d\n", be32_to_cpu(vid_hdr->data_pad));
96 pr_err("\tsqnum %llu\n",
97 (unsigned long long)be64_to_cpu(vid_hdr->sqnum));
98 pr_err("\thdr_crc %08x\n", be32_to_cpu(vid_hdr->hdr_crc));
99 pr_err("Volume identifier header hexdump:\n");
100 print_hex_dump(KERN_DEBUG, "", DUMP_PREFIX_OFFSET, 32, 1,
101 vid_hdr, UBI_VID_HDR_SIZE, 1);
102}
103
104/**
105 * ubi_dump_vol_info - dump volume information.
106 * @vol: UBI volume description object
107 */
108void ubi_dump_vol_info(const struct ubi_volume *vol)
109{
110 pr_err("Volume information dump:\n");
111 pr_err("\tvol_id %d\n", vol->vol_id);
112 pr_err("\treserved_pebs %d\n", vol->reserved_pebs);
113 pr_err("\talignment %d\n", vol->alignment);
114 pr_err("\tdata_pad %d\n", vol->data_pad);
115 pr_err("\tvol_type %d\n", vol->vol_type);
116 pr_err("\tname_len %d\n", vol->name_len);
117 pr_err("\tusable_leb_size %d\n", vol->usable_leb_size);
118 pr_err("\tused_ebs %d\n", vol->used_ebs);
119 pr_err("\tused_bytes %lld\n", vol->used_bytes);
120 pr_err("\tlast_eb_bytes %d\n", vol->last_eb_bytes);
121 pr_err("\tcorrupted %d\n", vol->corrupted);
122 pr_err("\tupd_marker %d\n", vol->upd_marker);
123
124 if (vol->name_len <= UBI_VOL_NAME_MAX &&
125 strnlen(vol->name, vol->name_len + 1) == vol->name_len) {
126 pr_err("\tname %s\n", vol->name);
127 } else {
128 pr_err("\t1st 5 characters of name: %c%c%c%c%c\n",
129 vol->name[0], vol->name[1], vol->name[2],
130 vol->name[3], vol->name[4]);
131 }
132}
133
134/**
135 * ubi_dump_vtbl_record - dump a &struct ubi_vtbl_record object.
136 * @r: the object to dump
137 * @idx: volume table index
138 */
139void ubi_dump_vtbl_record(const struct ubi_vtbl_record *r, int idx)
140{
141 int name_len = be16_to_cpu(r->name_len);
142
143 pr_err("Volume table record %d dump:\n", idx);
144 pr_err("\treserved_pebs %d\n", be32_to_cpu(r->reserved_pebs));
145 pr_err("\talignment %d\n", be32_to_cpu(r->alignment));
146 pr_err("\tdata_pad %d\n", be32_to_cpu(r->data_pad));
147 pr_err("\tvol_type %d\n", (int)r->vol_type);
148 pr_err("\tupd_marker %d\n", (int)r->upd_marker);
149 pr_err("\tname_len %d\n", name_len);
150
151 if (r->name[0] == '\0') {
152 pr_err("\tname NULL\n");
153 return;
154 }
155
156 if (name_len <= UBI_VOL_NAME_MAX &&
157 strnlen(&r->name[0], name_len + 1) == name_len) {
158 pr_err("\tname %s\n", &r->name[0]);
159 } else {
160 pr_err("\t1st 5 characters of name: %c%c%c%c%c\n",
161 r->name[0], r->name[1], r->name[2], r->name[3],
162 r->name[4]);
163 }
164 pr_err("\tcrc %#08x\n", be32_to_cpu(r->crc));
165}
166
167/**
168 * ubi_dump_av - dump a &struct ubi_ainf_volume object.
169 * @av: the object to dump
170 */
171void ubi_dump_av(const struct ubi_ainf_volume *av)
172{
173 pr_err("Volume attaching information dump:\n");
174 pr_err("\tvol_id %d\n", av->vol_id);
175 pr_err("\thighest_lnum %d\n", av->highest_lnum);
176 pr_err("\tleb_count %d\n", av->leb_count);
177 pr_err("\tcompat %d\n", av->compat);
178 pr_err("\tvol_type %d\n", av->vol_type);
179 pr_err("\tused_ebs %d\n", av->used_ebs);
180 pr_err("\tlast_data_size %d\n", av->last_data_size);
181 pr_err("\tdata_pad %d\n", av->data_pad);
182}
183
184/**
185 * ubi_dump_aeb - dump a &struct ubi_ainf_peb object.
186 * @aeb: the object to dump
187 * @type: object type: 0 - not corrupted, 1 - corrupted
188 */
189void ubi_dump_aeb(const struct ubi_ainf_peb *aeb, int type)
190{
191 pr_err("eraseblock attaching information dump:\n");
192 pr_err("\tec %d\n", aeb->ec);
193 pr_err("\tpnum %d\n", aeb->pnum);
194 if (type == 0) {
195 pr_err("\tlnum %d\n", aeb->lnum);
196 pr_err("\tscrub %d\n", aeb->scrub);
197 pr_err("\tsqnum %llu\n", aeb->sqnum);
198 }
199}
200
201/**
202 * ubi_dump_mkvol_req - dump a &struct ubi_mkvol_req object.
203 * @req: the object to dump
204 */
205void ubi_dump_mkvol_req(const struct ubi_mkvol_req *req)
206{
207 char nm[17];
208
209 pr_err("Volume creation request dump:\n");
210 pr_err("\tvol_id %d\n", req->vol_id);
211 pr_err("\talignment %d\n", req->alignment);
212 pr_err("\tbytes %lld\n", (long long)req->bytes);
213 pr_err("\tvol_type %d\n", req->vol_type);
214 pr_err("\tname_len %d\n", req->name_len);
215
216 memcpy(nm, req->name, 16);
217 nm[16] = 0;
218 pr_err("\t1st 16 characters of name: %s\n", nm);
219}
220
221/*
222 * Root directory for UBI stuff in debugfs. Contains sub-directories which
223 * contain the stuff specific to particular UBI devices.
224 */
225static struct dentry *dfs_rootdir;
226
227/**
228 * ubi_debugfs_init - create UBI debugfs directory.
229 *
230 * Create UBI debugfs directory. Returns zero in case of success and a negative
231 * error code in case of failure.
232 */
233int ubi_debugfs_init(void)
234{
235 if (!IS_ENABLED(CONFIG_DEBUG_FS))
236 return 0;
237
238 dfs_rootdir = debugfs_create_dir("ubi", NULL);
239 if (IS_ERR_OR_NULL(dfs_rootdir)) {
240 int err = dfs_rootdir ? PTR_ERR(dfs_rootdir) : -ENODEV;
241
242 pr_err("UBI error: cannot create \"ubi\" debugfs directory, error %d\n",
243 err);
244 return err;
245 }
246
247 return 0;
248}
249
250/**
251 * ubi_debugfs_exit - remove UBI debugfs directory.
252 */
253void ubi_debugfs_exit(void)
254{
255 if (IS_ENABLED(CONFIG_DEBUG_FS))
256 debugfs_remove(dfs_rootdir);
257}
258
259/* Read an UBI debugfs file */
260static ssize_t dfs_file_read(struct file *file, char __user *user_buf,
261 size_t count, loff_t *ppos)
262{
263 unsigned long ubi_num = (unsigned long)file->private_data;
264 struct dentry *dent = file->f_path.dentry;
265 struct ubi_device *ubi;
266 struct ubi_debug_info *d;
267 char buf[8];
268 int val;
269
270 ubi = ubi_get_device(ubi_num);
271 if (!ubi)
272 return -ENODEV;
273 d = &ubi->dbg;
274
275 if (dent == d->dfs_chk_gen)
276 val = d->chk_gen;
277 else if (dent == d->dfs_chk_io)
278 val = d->chk_io;
279 else if (dent == d->dfs_chk_fastmap)
280 val = d->chk_fastmap;
281 else if (dent == d->dfs_disable_bgt)
282 val = d->disable_bgt;
283 else if (dent == d->dfs_emulate_bitflips)
284 val = d->emulate_bitflips;
285 else if (dent == d->dfs_emulate_io_failures)
286 val = d->emulate_io_failures;
287 else if (dent == d->dfs_emulate_power_cut) {
288 snprintf(buf, sizeof(buf), "%u\n", d->emulate_power_cut);
289 count = simple_read_from_buffer(user_buf, count, ppos,
290 buf, strlen(buf));
291 goto out;
292 } else if (dent == d->dfs_power_cut_min) {
293 snprintf(buf, sizeof(buf), "%u\n", d->power_cut_min);
294 count = simple_read_from_buffer(user_buf, count, ppos,
295 buf, strlen(buf));
296 goto out;
297 } else if (dent == d->dfs_power_cut_max) {
298 snprintf(buf, sizeof(buf), "%u\n", d->power_cut_max);
299 count = simple_read_from_buffer(user_buf, count, ppos,
300 buf, strlen(buf));
301 goto out;
302 }
303 else {
304 count = -EINVAL;
305 goto out;
306 }
307
308 if (val)
309 buf[0] = '1';
310 else
311 buf[0] = '0';
312 buf[1] = '\n';
313 buf[2] = 0x00;
314
315 count = simple_read_from_buffer(user_buf, count, ppos, buf, 2);
316
317out:
318 ubi_put_device(ubi);
319 return count;
320}
321
322/* Write an UBI debugfs file */
323static ssize_t dfs_file_write(struct file *file, const char __user *user_buf,
324 size_t count, loff_t *ppos)
325{
326 unsigned long ubi_num = (unsigned long)file->private_data;
327 struct dentry *dent = file->f_path.dentry;
328 struct ubi_device *ubi;
329 struct ubi_debug_info *d;
330 size_t buf_size;
331 char buf[8] = {0};
332 int val;
333
334 ubi = ubi_get_device(ubi_num);
335 if (!ubi)
336 return -ENODEV;
337 d = &ubi->dbg;
338
339 buf_size = min_t(size_t, count, (sizeof(buf) - 1));
340 if (copy_from_user(buf, user_buf, buf_size)) {
341 count = -EFAULT;
342 goto out;
343 }
344
345 if (dent == d->dfs_power_cut_min) {
346 if (kstrtouint(buf, 0, &d->power_cut_min) != 0)
347 count = -EINVAL;
348 goto out;
349 } else if (dent == d->dfs_power_cut_max) {
350 if (kstrtouint(buf, 0, &d->power_cut_max) != 0)
351 count = -EINVAL;
352 goto out;
353 } else if (dent == d->dfs_emulate_power_cut) {
354 if (kstrtoint(buf, 0, &val) != 0)
355 count = -EINVAL;
356 else
357 d->emulate_power_cut = val;
358 goto out;
359 }
360
361 if (buf[0] == '1')
362 val = 1;
363 else if (buf[0] == '0')
364 val = 0;
365 else {
366 count = -EINVAL;
367 goto out;
368 }
369
370 if (dent == d->dfs_chk_gen)
371 d->chk_gen = val;
372 else if (dent == d->dfs_chk_io)
373 d->chk_io = val;
374 else if (dent == d->dfs_chk_fastmap)
375 d->chk_fastmap = val;
376 else if (dent == d->dfs_disable_bgt)
377 d->disable_bgt = val;
378 else if (dent == d->dfs_emulate_bitflips)
379 d->emulate_bitflips = val;
380 else if (dent == d->dfs_emulate_io_failures)
381 d->emulate_io_failures = val;
382 else
383 count = -EINVAL;
384
385out:
386 ubi_put_device(ubi);
387 return count;
388}
389
390/* File operations for all UBI debugfs files except
391 * detailed_erase_block_info
392 */
393static const struct file_operations dfs_fops = {
394 .read = dfs_file_read,
395 .write = dfs_file_write,
396 .open = simple_open,
397 .llseek = no_llseek,
398 .owner = THIS_MODULE,
399};
400
401/* As long as the position is less then that total number of erase blocks,
402 * we still have more to print.
403 */
404static void *eraseblk_count_seq_start(struct seq_file *s, loff_t *pos)
405{
406 struct ubi_device *ubi = s->private;
407
408 if (*pos == 0)
409 return SEQ_START_TOKEN;
410
411 if (*pos < ubi->peb_count)
412 return pos;
413
414 return NULL;
415}
416
417/* Since we are using the position as the iterator, we just need to check if we
418 * are done and increment the position.
419 */
420static void *eraseblk_count_seq_next(struct seq_file *s, void *v, loff_t *pos)
421{
422 struct ubi_device *ubi = s->private;
423
424 if (v == SEQ_START_TOKEN)
425 return pos;
426 (*pos)++;
427
428 if (*pos < ubi->peb_count)
429 return pos;
430
431 return NULL;
432}
433
434static void eraseblk_count_seq_stop(struct seq_file *s, void *v)
435{
436}
437
438static int eraseblk_count_seq_show(struct seq_file *s, void *iter)
439{
440 struct ubi_device *ubi = s->private;
441 struct ubi_wl_entry *wl;
442 int *block_number = iter;
443 int erase_count = -1;
444 int err;
445
446 /* If this is the start, print a header */
447 if (iter == SEQ_START_TOKEN) {
448 seq_puts(s,
449 "physical_block_number\terase_count\tblock_status\tread_status\n");
450 return 0;
451 }
452
453 err = ubi_io_is_bad(ubi, *block_number);
454 if (err)
455 return err;
456
457 spin_lock(&ubi->wl_lock);
458
459 wl = ubi->lookuptbl[*block_number];
460 if (wl)
461 erase_count = wl->ec;
462
463 spin_unlock(&ubi->wl_lock);
464
465 if (erase_count < 0)
466 return 0;
467
468 seq_printf(s, "%-22d\t%-11d\n", *block_number, erase_count);
469
470 return 0;
471}
472
473static const struct seq_operations eraseblk_count_seq_ops = {
474 .start = eraseblk_count_seq_start,
475 .next = eraseblk_count_seq_next,
476 .stop = eraseblk_count_seq_stop,
477 .show = eraseblk_count_seq_show
478};
479
480static int eraseblk_count_open(struct inode *inode, struct file *f)
481{
482 struct seq_file *s;
483 int err;
484
485 err = seq_open(f, &eraseblk_count_seq_ops);
486 if (err)
487 return err;
488
489 s = f->private_data;
490 s->private = ubi_get_device((unsigned long)inode->i_private);
491
492 if (!s->private)
493 return -ENODEV;
494 else
495 return 0;
496}
497
498static int eraseblk_count_release(struct inode *inode, struct file *f)
499{
500 struct seq_file *s = f->private_data;
501 struct ubi_device *ubi = s->private;
502
503 ubi_put_device(ubi);
504
505 return seq_release(inode, f);
506}
507
508static const struct file_operations eraseblk_count_fops = {
509 .owner = THIS_MODULE,
510 .open = eraseblk_count_open,
511 .read = seq_read,
512 .llseek = seq_lseek,
513 .release = eraseblk_count_release,
514};
515
516/**
517 * ubi_debugfs_init_dev - initialize debugfs for an UBI device.
518 * @ubi: UBI device description object
519 *
520 * This function creates all debugfs files for UBI device @ubi. Returns zero in
521 * case of success and a negative error code in case of failure.
522 */
523int ubi_debugfs_init_dev(struct ubi_device *ubi)
524{
525 int err, n;
526 unsigned long ubi_num = ubi->ubi_num;
527 const char *fname;
528 struct dentry *dent;
529 struct ubi_debug_info *d = &ubi->dbg;
530
531 if (!IS_ENABLED(CONFIG_DEBUG_FS))
532 return 0;
533
534 n = snprintf(d->dfs_dir_name, UBI_DFS_DIR_LEN + 1, UBI_DFS_DIR_NAME,
535 ubi->ubi_num);
536 if (n == UBI_DFS_DIR_LEN) {
537 /* The array size is too small */
538 fname = UBI_DFS_DIR_NAME;
539 dent = ERR_PTR(-EINVAL);
540 goto out;
541 }
542
543 fname = d->dfs_dir_name;
544 dent = debugfs_create_dir(fname, dfs_rootdir);
545 if (IS_ERR_OR_NULL(dent))
546 goto out;
547 d->dfs_dir = dent;
548
549 fname = "chk_gen";
550 dent = debugfs_create_file(fname, S_IWUSR, d->dfs_dir, (void *)ubi_num,
551 &dfs_fops);
552 if (IS_ERR_OR_NULL(dent))
553 goto out_remove;
554 d->dfs_chk_gen = dent;
555
556 fname = "chk_io";
557 dent = debugfs_create_file(fname, S_IWUSR, d->dfs_dir, (void *)ubi_num,
558 &dfs_fops);
559 if (IS_ERR_OR_NULL(dent))
560 goto out_remove;
561 d->dfs_chk_io = dent;
562
563 fname = "chk_fastmap";
564 dent = debugfs_create_file(fname, S_IWUSR, d->dfs_dir, (void *)ubi_num,
565 &dfs_fops);
566 if (IS_ERR_OR_NULL(dent))
567 goto out_remove;
568 d->dfs_chk_fastmap = dent;
569
570 fname = "tst_disable_bgt";
571 dent = debugfs_create_file(fname, S_IWUSR, d->dfs_dir, (void *)ubi_num,
572 &dfs_fops);
573 if (IS_ERR_OR_NULL(dent))
574 goto out_remove;
575 d->dfs_disable_bgt = dent;
576
577 fname = "tst_emulate_bitflips";
578 dent = debugfs_create_file(fname, S_IWUSR, d->dfs_dir, (void *)ubi_num,
579 &dfs_fops);
580 if (IS_ERR_OR_NULL(dent))
581 goto out_remove;
582 d->dfs_emulate_bitflips = dent;
583
584 fname = "tst_emulate_io_failures";
585 dent = debugfs_create_file(fname, S_IWUSR, d->dfs_dir, (void *)ubi_num,
586 &dfs_fops);
587 if (IS_ERR_OR_NULL(dent))
588 goto out_remove;
589 d->dfs_emulate_io_failures = dent;
590
591 fname = "tst_emulate_power_cut";
592 dent = debugfs_create_file(fname, S_IWUSR, d->dfs_dir, (void *)ubi_num,
593 &dfs_fops);
594 if (IS_ERR_OR_NULL(dent))
595 goto out_remove;
596 d->dfs_emulate_power_cut = dent;
597
598 fname = "tst_emulate_power_cut_min";
599 dent = debugfs_create_file(fname, S_IWUSR, d->dfs_dir, (void *)ubi_num,
600 &dfs_fops);
601 if (IS_ERR_OR_NULL(dent))
602 goto out_remove;
603 d->dfs_power_cut_min = dent;
604
605 fname = "tst_emulate_power_cut_max";
606 dent = debugfs_create_file(fname, S_IWUSR, d->dfs_dir, (void *)ubi_num,
607 &dfs_fops);
608 if (IS_ERR_OR_NULL(dent))
609 goto out_remove;
610 d->dfs_power_cut_max = dent;
611
612 fname = "detailed_erase_block_info";
613 dent = debugfs_create_file(fname, S_IRUSR, d->dfs_dir, (void *)ubi_num,
614 &eraseblk_count_fops);
615 if (IS_ERR_OR_NULL(dent))
616 goto out_remove;
617
618 return 0;
619
620out_remove:
621 debugfs_remove_recursive(d->dfs_dir);
622out:
623 err = dent ? PTR_ERR(dent) : -ENODEV;
624 ubi_err(ubi, "cannot create \"%s\" debugfs file or directory, error %d\n",
625 fname, err);
626 return err;
627}
628
629/**
630 * dbg_debug_exit_dev - free all debugfs files corresponding to device @ubi
631 * @ubi: UBI device description object
632 */
633void ubi_debugfs_exit_dev(struct ubi_device *ubi)
634{
635 if (IS_ENABLED(CONFIG_DEBUG_FS))
636 debugfs_remove_recursive(ubi->dbg.dfs_dir);
637}
638
639/**
640 * ubi_dbg_power_cut - emulate a power cut if it is time to do so
641 * @ubi: UBI device description object
642 * @caller: Flags set to indicate from where the function is being called
643 *
644 * Returns non-zero if a power cut was emulated, zero if not.
645 */
646int ubi_dbg_power_cut(struct ubi_device *ubi, int caller)
647{
648 unsigned int range;
649
650 if ((ubi->dbg.emulate_power_cut & caller) == 0)
651 return 0;
652
653 if (ubi->dbg.power_cut_counter == 0) {
654 ubi->dbg.power_cut_counter = ubi->dbg.power_cut_min;
655
656 if (ubi->dbg.power_cut_max > ubi->dbg.power_cut_min) {
657 range = ubi->dbg.power_cut_max - ubi->dbg.power_cut_min;
658 ubi->dbg.power_cut_counter += prandom_u32() % range;
659 }
660 return 0;
661 }
662
663 ubi->dbg.power_cut_counter--;
664 if (ubi->dbg.power_cut_counter)
665 return 0;
666
667 ubi_msg(ubi, "XXXXXXXXXXXXXXX emulating a power cut XXXXXXXXXXXXXXXX");
668 ubi_ro_mode(ubi);
669 return 1;
670}