2 * Copyright (c) International Business Machines Corp., 2006
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.
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.
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
18 * Author: Artem Bityutskiy (Битюцкий Артём)
21 #ifndef __UBI_DEBUG_H__
22 #define __UBI_DEBUG_H__
24 void ubi_dump_flash(struct ubi_device *ubi, int pnum, int offset, int len);
25 void ubi_dump_ec_hdr(const struct ubi_ec_hdr *ec_hdr);
26 void ubi_dump_vid_hdr(const struct ubi_vid_hdr *vid_hdr);
28 #ifdef CONFIG_MTD_UBI_DEBUG
29 #include <linux/random.h>
31 #define ubi_assert(expr) do { \
32 if (unlikely(!(expr))) { \
33 printk(KERN_CRIT "UBI assert failed in %s at %u (pid %d)\n", \
34 __func__, __LINE__, current->pid); \
39 #define dbg_err(fmt, ...) ubi_err(fmt, ##__VA_ARGS__)
41 #define ubi_dbg_print_hex_dump(l, ps, pt, r, g, b, len, a) \
42 print_hex_dump(l, ps, pt, r, g, b, len, a)
44 #define ubi_dbg_msg(type, fmt, ...) \
45 pr_debug("UBI DBG " type ": " fmt "\n", ##__VA_ARGS__)
47 /* Just a debugging messages not related to any specific UBI subsystem */
48 #define dbg_msg(fmt, ...) \
49 printk(KERN_DEBUG "UBI DBG (pid %d): %s: " fmt "\n", \
50 current->pid, __func__, ##__VA_ARGS__)
52 /* General debugging messages */
53 #define dbg_gen(fmt, ...) ubi_dbg_msg("gen", fmt, ##__VA_ARGS__)
54 /* Messages from the eraseblock association sub-system */
55 #define dbg_eba(fmt, ...) ubi_dbg_msg("eba", fmt, ##__VA_ARGS__)
56 /* Messages from the wear-leveling sub-system */
57 #define dbg_wl(fmt, ...) ubi_dbg_msg("wl", fmt, ##__VA_ARGS__)
58 /* Messages from the input/output sub-system */
59 #define dbg_io(fmt, ...) ubi_dbg_msg("io", fmt, ##__VA_ARGS__)
60 /* Initialization and build messages */
61 #define dbg_bld(fmt, ...) ubi_dbg_msg("bld", fmt, ##__VA_ARGS__)
63 void ubi_dump_vol_info(const struct ubi_volume *vol);
64 void ubi_dump_vtbl_record(const struct ubi_vtbl_record *r, int idx);
65 void ubi_dump_sv(const struct ubi_scan_volume *sv);
66 void ubi_dump_seb(const struct ubi_scan_leb *seb, int type);
67 void ubi_dbg_dump_mkvol_req(const struct ubi_mkvol_req *req);
68 int ubi_dbg_check_all_ff(struct ubi_device *ubi, int pnum, int offset, int len);
69 int ubi_dbg_check_write(struct ubi_device *ubi, const void *buf, int pnum,
71 int ubi_debugging_init_dev(struct ubi_device *ubi);
72 void ubi_debugging_exit_dev(struct ubi_device *ubi);
73 int ubi_debugfs_init(void);
74 void ubi_debugfs_exit(void);
75 int ubi_debugfs_init_dev(struct ubi_device *ubi);
76 void ubi_debugfs_exit_dev(struct ubi_device *ubi);
79 * The UBI debugfs directory name pattern and maximum name length (3 for "ubi"
80 * + 2 for the number plus 1 for the trailing zero byte.
82 #define UBI_DFS_DIR_NAME "ubi%d"
83 #define UBI_DFS_DIR_LEN (3 + 2 + 1)
86 * struct ubi_debug_info - debugging information for an UBI device.
88 * @chk_gen: if UBI general extra checks are enabled
89 * @chk_io: if UBI I/O extra checks are enabled
90 * @disable_bgt: disable the background task for testing purposes
91 * @emulate_bitflips: emulate bit-flips for testing purposes
92 * @emulate_io_failures: emulate write/erase failures for testing purposes
93 * @dfs_dir_name: name of debugfs directory containing files of this UBI device
94 * @dfs_dir: direntry object of the UBI device debugfs directory
95 * @dfs_chk_gen: debugfs knob to enable UBI general extra checks
96 * @dfs_chk_io: debugfs knob to enable UBI I/O extra checks
97 * @dfs_disable_bgt: debugfs knob to disable the background task
98 * @dfs_emulate_bitflips: debugfs knob to emulate bit-flips
99 * @dfs_emulate_io_failures: debugfs knob to emulate write/erase failures
101 struct ubi_debug_info {
102 unsigned int chk_gen:1;
103 unsigned int chk_io:1;
104 unsigned int disable_bgt:1;
105 unsigned int emulate_bitflips:1;
106 unsigned int emulate_io_failures:1;
107 char dfs_dir_name[UBI_DFS_DIR_LEN + 1];
108 struct dentry *dfs_dir;
109 struct dentry *dfs_chk_gen;
110 struct dentry *dfs_chk_io;
111 struct dentry *dfs_disable_bgt;
112 struct dentry *dfs_emulate_bitflips;
113 struct dentry *dfs_emulate_io_failures;
117 * ubi_dbg_is_bgt_disabled - if the background thread is disabled.
118 * @ubi: UBI device description object
120 * Returns non-zero if the UBI background thread is disabled for testing
123 static inline int ubi_dbg_is_bgt_disabled(const struct ubi_device *ubi)
125 return ubi->dbg->disable_bgt;
129 * ubi_dbg_is_bitflip - if it is time to emulate a bit-flip.
130 * @ubi: UBI device description object
132 * Returns non-zero if a bit-flip should be emulated, otherwise returns zero.
134 static inline int ubi_dbg_is_bitflip(const struct ubi_device *ubi)
136 if (ubi->dbg->emulate_bitflips)
137 return !(random32() % 200);
142 * ubi_dbg_is_write_failure - if it is time to emulate a write failure.
143 * @ubi: UBI device description object
145 * Returns non-zero if a write failure should be emulated, otherwise returns
148 static inline int ubi_dbg_is_write_failure(const struct ubi_device *ubi)
150 if (ubi->dbg->emulate_io_failures)
151 return !(random32() % 500);
156 * ubi_dbg_is_erase_failure - if its time to emulate an erase failure.
157 * @ubi: UBI device description object
159 * Returns non-zero if an erase failure should be emulated, otherwise returns
162 static inline int ubi_dbg_is_erase_failure(const struct ubi_device *ubi)
164 if (ubi->dbg->emulate_io_failures)
165 return !(random32() % 400);
171 /* Use "if (0)" to make compiler check arguments even if debugging is off */
172 #define ubi_assert(expr) do { \
174 printk(KERN_CRIT "UBI assert failed in %s at %u (pid %d)\n", \
175 __func__, __LINE__, current->pid); \
179 #define dbg_err(fmt, ...) do { \
181 ubi_err(fmt, ##__VA_ARGS__); \
184 #define ubi_dbg_msg(fmt, ...) do { \
186 printk(KERN_DEBUG fmt "\n", ##__VA_ARGS__); \
189 #define dbg_msg(fmt, ...) ubi_dbg_msg(fmt, ##__VA_ARGS__)
190 #define dbg_gen(fmt, ...) ubi_dbg_msg(fmt, ##__VA_ARGS__)
191 #define dbg_eba(fmt, ...) ubi_dbg_msg(fmt, ##__VA_ARGS__)
192 #define dbg_wl(fmt, ...) ubi_dbg_msg(fmt, ##__VA_ARGS__)
193 #define dbg_io(fmt, ...) ubi_dbg_msg(fmt, ##__VA_ARGS__)
194 #define dbg_bld(fmt, ...) ubi_dbg_msg(fmt, ##__VA_ARGS__)
197 ubi_dump_vol_info(const struct ubi_volume *vol) { return; }
199 ubi_dump_vtbl_record(const struct ubi_vtbl_record *r, int idx) { return; }
200 static inline void ubi_dump_sv(const struct ubi_scan_volume *sv) { return; }
201 static inline void ubi_dump_seb(const struct ubi_scan_leb *seb,
202 int type) { return; }
204 ubi_dbg_dump_mkvol_req(const struct ubi_mkvol_req *req) { return; }
206 ubi_dbg_print_hex_dump(const char *l, const char *ps, int pt, int r,
207 int g, const void *b, size_t len, bool a) { return; }
208 static inline int ubi_dbg_check_all_ff(struct ubi_device *ubi,
209 int pnum, int offset,
210 int len) { return 0; }
211 static inline int ubi_dbg_check_write(struct ubi_device *ubi,
212 const void *buf, int pnum,
213 int offset, int len) { return 0; }
215 static inline int ubi_debugging_init_dev(struct ubi_device *ubi) { return 0; }
216 static inline void ubi_debugging_exit_dev(struct ubi_device *ubi) { return; }
217 static inline int ubi_debugfs_init(void) { return 0; }
218 static inline void ubi_debugfs_exit(void) { return; }
219 static inline int ubi_debugfs_init_dev(struct ubi_device *ubi) { return 0; }
220 static inline void ubi_debugfs_exit_dev(struct ubi_device *ubi) { return; }
223 ubi_dbg_is_bgt_disabled(const struct ubi_device *ubi) { return 0; }
224 static inline int ubi_dbg_is_bitflip(const struct ubi_device *ubi) { return 0; }
226 ubi_dbg_is_write_failure(const struct ubi_device *ubi) { return 0; }
228 ubi_dbg_is_erase_failure(const struct ubi_device *ubi) { return 0; }
230 #endif /* !CONFIG_MTD_UBI_DEBUG */
231 #endif /* !__UBI_DEBUG_H__ */