1801c135cSArtem B. Bityutskiy /* 2801c135cSArtem B. Bityutskiy * Copyright (c) International Business Machines Corp., 2006 3801c135cSArtem B. Bityutskiy * 4801c135cSArtem B. Bityutskiy * This program is free software; you can redistribute it and/or modify 5801c135cSArtem B. Bityutskiy * it under the terms of the GNU General Public License as published by 6801c135cSArtem B. Bityutskiy * the Free Software Foundation; either version 2 of the License, or 7801c135cSArtem B. Bityutskiy * (at your option) any later version. 8801c135cSArtem B. Bityutskiy * 9801c135cSArtem B. Bityutskiy * This program is distributed in the hope that it will be useful, 10801c135cSArtem B. Bityutskiy * but WITHOUT ANY WARRANTY; without even the implied warranty of 11801c135cSArtem B. Bityutskiy * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See 12801c135cSArtem B. Bityutskiy * the GNU General Public License for more details. 13801c135cSArtem B. Bityutskiy * 14801c135cSArtem B. Bityutskiy * You should have received a copy of the GNU General Public License 15801c135cSArtem B. Bityutskiy * along with this program; if not, write to the Free Software 16801c135cSArtem B. Bityutskiy * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA 17801c135cSArtem B. Bityutskiy * 18801c135cSArtem B. Bityutskiy * Author: Artem Bityutskiy (Битюцкий Артём) 19801c135cSArtem B. Bityutskiy */ 20801c135cSArtem B. Bityutskiy 21801c135cSArtem B. Bityutskiy #ifndef __UBI_DEBUG_H__ 22801c135cSArtem B. Bityutskiy #define __UBI_DEBUG_H__ 23801c135cSArtem B. Bityutskiy 24801c135cSArtem B. Bityutskiy #ifdef CONFIG_MTD_UBI_DEBUG 25801c135cSArtem B. Bityutskiy #include <linux/random.h> 26801c135cSArtem B. Bityutskiy 27c8566350SArtem Bityutskiy #define ubi_assert(expr) do { \ 28c8566350SArtem Bityutskiy if (unlikely(!(expr))) { \ 29c8566350SArtem Bityutskiy printk(KERN_CRIT "UBI assert failed in %s at %u (pid %d)\n", \ 30c8566350SArtem Bityutskiy __func__, __LINE__, current->pid); \ 31c8566350SArtem Bityutskiy ubi_dbg_dump_stack(); \ 32c8566350SArtem Bityutskiy } \ 33c8566350SArtem Bityutskiy } while (0) 34801c135cSArtem B. Bityutskiy 35ab50ff68SArtem Bityutskiy #define dbg_err(fmt, ...) ubi_err(fmt, ##__VA_ARGS__) 36b342efd4SArtem Bityutskiy 37801c135cSArtem B. Bityutskiy #define ubi_dbg_dump_stack() dump_stack() 38801c135cSArtem B. Bityutskiy 39ab50ff68SArtem Bityutskiy #define ubi_dbg_print_hex_dump(l, ps, pt, r, g, b, len, a) \ 40ab50ff68SArtem Bityutskiy print_hex_dump(l, ps, pt, r, g, b, len, a) 41ab50ff68SArtem Bityutskiy 42ab50ff68SArtem Bityutskiy #define ubi_dbg_msg(type, fmt, ...) \ 43ab50ff68SArtem Bityutskiy pr_debug("UBI DBG " type ": " fmt "\n", ##__VA_ARGS__) 44ab50ff68SArtem Bityutskiy 45ab50ff68SArtem Bityutskiy /* Just a debugging messages not related to any specific UBI subsystem */ 4672f0d453SArtem Bityutskiy #define dbg_msg(fmt, ...) \ 4772f0d453SArtem Bityutskiy printk(KERN_DEBUG "UBI DBG (pid %d): %s: " fmt "\n", \ 4872f0d453SArtem Bityutskiy current->pid, __func__, ##__VA_ARGS__) 4972f0d453SArtem Bityutskiy 50ab50ff68SArtem Bityutskiy /* General debugging messages */ 51ab50ff68SArtem Bityutskiy #define dbg_gen(fmt, ...) ubi_dbg_msg("gen", fmt, ##__VA_ARGS__) 52ab50ff68SArtem Bityutskiy /* Messages from the eraseblock association sub-system */ 53ab50ff68SArtem Bityutskiy #define dbg_eba(fmt, ...) ubi_dbg_msg("eba", fmt, ##__VA_ARGS__) 54ab50ff68SArtem Bityutskiy /* Messages from the wear-leveling sub-system */ 55ab50ff68SArtem Bityutskiy #define dbg_wl(fmt, ...) ubi_dbg_msg("wl", fmt, ##__VA_ARGS__) 56ab50ff68SArtem Bityutskiy /* Messages from the input/output sub-system */ 57ab50ff68SArtem Bityutskiy #define dbg_io(fmt, ...) ubi_dbg_msg("io", fmt, ##__VA_ARGS__) 58ab50ff68SArtem Bityutskiy /* Initialization and build messages */ 59ab50ff68SArtem Bityutskiy #define dbg_bld(fmt, ...) ubi_dbg_msg("bld", fmt, ##__VA_ARGS__) 60ab50ff68SArtem Bityutskiy 61801c135cSArtem B. Bityutskiy void ubi_dbg_dump_ec_hdr(const struct ubi_ec_hdr *ec_hdr); 62801c135cSArtem B. Bityutskiy void ubi_dbg_dump_vid_hdr(const struct ubi_vid_hdr *vid_hdr); 63801c135cSArtem B. Bityutskiy void ubi_dbg_dump_vol_info(const struct ubi_volume *vol); 64801c135cSArtem B. Bityutskiy void ubi_dbg_dump_vtbl_record(const struct ubi_vtbl_record *r, int idx); 65801c135cSArtem B. Bityutskiy void ubi_dbg_dump_sv(const struct ubi_scan_volume *sv); 66801c135cSArtem B. Bityutskiy void ubi_dbg_dump_seb(const struct ubi_scan_leb *seb, int type); 67801c135cSArtem B. Bityutskiy void ubi_dbg_dump_mkvol_req(const struct ubi_mkvol_req *req); 68867996b1SArtem Bityutskiy void ubi_dbg_dump_flash(struct ubi_device *ubi, int pnum, int offset, int len); 6940a71a87SArtem Bityutskiy int ubi_dbg_check_all_ff(struct ubi_device *ubi, int pnum, int offset, int len); 706e9065d7SArtem Bityutskiy int ubi_dbg_check_write(struct ubi_device *ubi, const void *buf, int pnum, 716e9065d7SArtem Bityutskiy int offset, int len); 722a734bb8SArtem Bityutskiy int ubi_debugging_init_dev(struct ubi_device *ubi); 732a734bb8SArtem Bityutskiy void ubi_debugging_exit_dev(struct ubi_device *ubi); 742a734bb8SArtem Bityutskiy int ubi_debugfs_init(void); 752a734bb8SArtem Bityutskiy void ubi_debugfs_exit(void); 762a734bb8SArtem Bityutskiy int ubi_debugfs_init_dev(struct ubi_device *ubi); 772a734bb8SArtem Bityutskiy void ubi_debugfs_exit_dev(struct ubi_device *ubi); 782a734bb8SArtem Bityutskiy 792a734bb8SArtem Bityutskiy /* 802a734bb8SArtem Bityutskiy * The UBI debugfs directory name pattern and maximum name length (3 for "ubi" 812a734bb8SArtem Bityutskiy * + 2 for the number plus 1 for the trailing zero byte. 822a734bb8SArtem Bityutskiy */ 832a734bb8SArtem Bityutskiy #define UBI_DFS_DIR_NAME "ubi%d" 842a734bb8SArtem Bityutskiy #define UBI_DFS_DIR_LEN (3 + 2 + 1) 852a734bb8SArtem Bityutskiy 862a734bb8SArtem Bityutskiy /** 872a734bb8SArtem Bityutskiy * struct ubi_debug_info - debugging information for an UBI device. 882a734bb8SArtem Bityutskiy * 892a734bb8SArtem Bityutskiy * @chk_gen: if UBI general extra checks are enabled 902a734bb8SArtem Bityutskiy * @chk_io: if UBI I/O extra checks are enabled 91cd6d8567SArtem Bityutskiy * @disable_bgt: disable the background task for testing purposes 92cd6d8567SArtem Bityutskiy * @emulate_bitflips: emulate bit-flips for testing purposes 93cd6d8567SArtem Bityutskiy * @emulate_io_failures: emulate write/erase failures for testing purposes 942a734bb8SArtem Bityutskiy * @dfs_dir_name: name of debugfs directory containing files of this UBI device 952a734bb8SArtem Bityutskiy * @dfs_dir: direntry object of the UBI device debugfs directory 962a734bb8SArtem Bityutskiy * @dfs_chk_gen: debugfs knob to enable UBI general extra checks 972a734bb8SArtem Bityutskiy * @dfs_chk_io: debugfs knob to enable UBI I/O extra checks 98cd6d8567SArtem Bityutskiy * @dfs_disable_bgt: debugfs knob to disable the background task 99cd6d8567SArtem Bityutskiy * @dfs_emulate_bitflips: debugfs knob to emulate bit-flips 100cd6d8567SArtem Bityutskiy * @dfs_emulate_io_failures: debugfs knob to emulate write/erase failures 1012a734bb8SArtem Bityutskiy */ 1022a734bb8SArtem Bityutskiy struct ubi_debug_info { 1032a734bb8SArtem Bityutskiy unsigned int chk_gen:1; 1042a734bb8SArtem Bityutskiy unsigned int chk_io:1; 105cd6d8567SArtem Bityutskiy unsigned int disable_bgt:1; 106cd6d8567SArtem Bityutskiy unsigned int emulate_bitflips:1; 107cd6d8567SArtem Bityutskiy unsigned int emulate_io_failures:1; 1082a734bb8SArtem Bityutskiy char dfs_dir_name[UBI_DFS_DIR_LEN + 1]; 1092a734bb8SArtem Bityutskiy struct dentry *dfs_dir; 1102a734bb8SArtem Bityutskiy struct dentry *dfs_chk_gen; 1112a734bb8SArtem Bityutskiy struct dentry *dfs_chk_io; 112cd6d8567SArtem Bityutskiy struct dentry *dfs_disable_bgt; 113cd6d8567SArtem Bityutskiy struct dentry *dfs_emulate_bitflips; 114cd6d8567SArtem Bityutskiy struct dentry *dfs_emulate_io_failures; 11528237e45SArtem Bityutskiy }; 11628237e45SArtem Bityutskiy 11728237e45SArtem Bityutskiy /** 11828237e45SArtem Bityutskiy * ubi_dbg_is_bgt_disabled - if the background thread is disabled. 11927a0f2a3SArtem Bityutskiy * @ubi: UBI device description object 12028237e45SArtem Bityutskiy * 12128237e45SArtem Bityutskiy * Returns non-zero if the UBI background thread is disabled for testing 12228237e45SArtem Bityutskiy * purposes. 12328237e45SArtem Bityutskiy */ 12427a0f2a3SArtem Bityutskiy static inline int ubi_dbg_is_bgt_disabled(const struct ubi_device *ubi) 12528237e45SArtem Bityutskiy { 126cd6d8567SArtem Bityutskiy return ubi->dbg->disable_bgt; 12728237e45SArtem Bityutskiy } 12828237e45SArtem Bityutskiy 129801c135cSArtem B. Bityutskiy /** 130801c135cSArtem B. Bityutskiy * ubi_dbg_is_bitflip - if it is time to emulate a bit-flip. 13127a0f2a3SArtem Bityutskiy * @ubi: UBI device description object 132801c135cSArtem B. Bityutskiy * 133801c135cSArtem B. Bityutskiy * Returns non-zero if a bit-flip should be emulated, otherwise returns zero. 134801c135cSArtem B. Bityutskiy */ 13527a0f2a3SArtem Bityutskiy static inline int ubi_dbg_is_bitflip(const struct ubi_device *ubi) 136801c135cSArtem B. Bityutskiy { 137cd6d8567SArtem Bityutskiy if (ubi->dbg->emulate_bitflips) 138801c135cSArtem B. Bityutskiy return !(random32() % 200); 13928237e45SArtem Bityutskiy return 0; 140801c135cSArtem B. Bityutskiy } 141801c135cSArtem B. Bityutskiy 142801c135cSArtem B. Bityutskiy /** 143801c135cSArtem B. Bityutskiy * ubi_dbg_is_write_failure - if it is time to emulate a write failure. 14427a0f2a3SArtem Bityutskiy * @ubi: UBI device description object 145801c135cSArtem B. Bityutskiy * 146801c135cSArtem B. Bityutskiy * Returns non-zero if a write failure should be emulated, otherwise returns 147801c135cSArtem B. Bityutskiy * zero. 148801c135cSArtem B. Bityutskiy */ 14927a0f2a3SArtem Bityutskiy static inline int ubi_dbg_is_write_failure(const struct ubi_device *ubi) 150801c135cSArtem B. Bityutskiy { 151cd6d8567SArtem Bityutskiy if (ubi->dbg->emulate_io_failures) 152801c135cSArtem B. Bityutskiy return !(random32() % 500); 15328237e45SArtem Bityutskiy return 0; 154801c135cSArtem B. Bityutskiy } 155801c135cSArtem B. Bityutskiy 156801c135cSArtem B. Bityutskiy /** 157801c135cSArtem B. Bityutskiy * ubi_dbg_is_erase_failure - if its time to emulate an erase failure. 15827a0f2a3SArtem Bityutskiy * @ubi: UBI device description object 159801c135cSArtem B. Bityutskiy * 160801c135cSArtem B. Bityutskiy * Returns non-zero if an erase failure should be emulated, otherwise returns 161801c135cSArtem B. Bityutskiy * zero. 162801c135cSArtem B. Bityutskiy */ 16327a0f2a3SArtem Bityutskiy static inline int ubi_dbg_is_erase_failure(const struct ubi_device *ubi) 164801c135cSArtem B. Bityutskiy { 165cd6d8567SArtem Bityutskiy if (ubi->dbg->emulate_io_failures) 166801c135cSArtem B. Bityutskiy return !(random32() % 400); 16728237e45SArtem Bityutskiy return 0; 168801c135cSArtem B. Bityutskiy } 169801c135cSArtem B. Bityutskiy 170c8566350SArtem Bityutskiy #else 171c8566350SArtem Bityutskiy 1723802243aSArtem Bityutskiy /* Use "if (0)" to make compiler check arguments even if debugging is off */ 1733802243aSArtem Bityutskiy #define ubi_assert(expr) do { \ 1743802243aSArtem Bityutskiy if (0) { \ 1753802243aSArtem Bityutskiy printk(KERN_CRIT "UBI assert failed in %s at %u (pid %d)\n", \ 1763802243aSArtem Bityutskiy __func__, __LINE__, current->pid); \ 1773802243aSArtem Bityutskiy } \ 1783802243aSArtem Bityutskiy } while (0) 1793802243aSArtem Bityutskiy 1803802243aSArtem Bityutskiy #define dbg_err(fmt, ...) do { \ 1813802243aSArtem Bityutskiy if (0) \ 1823802243aSArtem Bityutskiy ubi_err(fmt, ##__VA_ARGS__); \ 1833802243aSArtem Bityutskiy } while (0) 1843802243aSArtem Bityutskiy 185ab50ff68SArtem Bityutskiy #define ubi_dbg_msg(fmt, ...) do { \ 1863802243aSArtem Bityutskiy if (0) \ 1879efabc84SArtem Bityutskiy printk(KERN_DEBUG fmt "\n", ##__VA_ARGS__); \ 1883802243aSArtem Bityutskiy } while (0) 1893802243aSArtem Bityutskiy 190ab50ff68SArtem Bityutskiy #define dbg_msg(fmt, ...) ubi_dbg_msg(fmt, ##__VA_ARGS__) 191ab50ff68SArtem Bityutskiy #define dbg_gen(fmt, ...) ubi_dbg_msg(fmt, ##__VA_ARGS__) 192ab50ff68SArtem Bityutskiy #define dbg_eba(fmt, ...) ubi_dbg_msg(fmt, ##__VA_ARGS__) 193ab50ff68SArtem Bityutskiy #define dbg_wl(fmt, ...) ubi_dbg_msg(fmt, ##__VA_ARGS__) 194ab50ff68SArtem Bityutskiy #define dbg_io(fmt, ...) ubi_dbg_msg(fmt, ##__VA_ARGS__) 195ab50ff68SArtem Bityutskiy #define dbg_bld(fmt, ...) ubi_dbg_msg(fmt, ##__VA_ARGS__) 1963802243aSArtem Bityutskiy 197ebfce01aSArtem Bityutskiy static inline void ubi_dbg_dump_stack(void) { return; } 198ebfce01aSArtem Bityutskiy static inline void 199ebfce01aSArtem Bityutskiy ubi_dbg_dump_ec_hdr(const struct ubi_ec_hdr *ec_hdr) { return; } 200ebfce01aSArtem Bityutskiy static inline void 201ebfce01aSArtem Bityutskiy ubi_dbg_dump_vid_hdr(const struct ubi_vid_hdr *vid_hdr) { return; } 202ebfce01aSArtem Bityutskiy static inline void 203ebfce01aSArtem Bityutskiy ubi_dbg_dump_vol_info(const struct ubi_volume *vol) { return; } 204ebfce01aSArtem Bityutskiy static inline void 205ebfce01aSArtem Bityutskiy ubi_dbg_dump_vtbl_record(const struct ubi_vtbl_record *r, int idx) { return; } 206ebfce01aSArtem Bityutskiy static inline void ubi_dbg_dump_sv(const struct ubi_scan_volume *sv) { return; } 207ebfce01aSArtem Bityutskiy static inline void ubi_dbg_dump_seb(const struct ubi_scan_leb *seb, 208ebfce01aSArtem Bityutskiy int type) { return; } 209ebfce01aSArtem Bityutskiy static inline void 210ebfce01aSArtem Bityutskiy ubi_dbg_dump_mkvol_req(const struct ubi_mkvol_req *req) { return; } 211ebfce01aSArtem Bityutskiy static inline void ubi_dbg_dump_flash(struct ubi_device *ubi, 212ebfce01aSArtem Bityutskiy int pnum, int offset, int len) { return; } 213ebfce01aSArtem Bityutskiy static inline void 214ebfce01aSArtem Bityutskiy ubi_dbg_print_hex_dump(const char *l, const char *ps, int pt, int r, 215ebfce01aSArtem Bityutskiy int g, const void *b, size_t len, bool a) { return; } 216ebfce01aSArtem Bityutskiy static inline int ubi_dbg_check_all_ff(struct ubi_device *ubi, 217ebfce01aSArtem Bityutskiy int pnum, int offset, 218ebfce01aSArtem Bityutskiy int len) { return 0; } 219ebfce01aSArtem Bityutskiy static inline int ubi_dbg_check_write(struct ubi_device *ubi, 220ebfce01aSArtem Bityutskiy const void *buf, int pnum, 221ebfce01aSArtem Bityutskiy int offset, int len) { return 0; } 222c8566350SArtem Bityutskiy 2232a734bb8SArtem Bityutskiy static inline int ubi_debugging_init_dev(struct ubi_device *ubi) { return 0; } 2242a734bb8SArtem Bityutskiy static inline void ubi_debugging_exit_dev(struct ubi_device *ubi) { return; } 2252a734bb8SArtem Bityutskiy static inline int ubi_debugfs_init(void) { return 0; } 2262a734bb8SArtem Bityutskiy static inline void ubi_debugfs_exit(void) { return; } 2272a734bb8SArtem Bityutskiy static inline int ubi_debugfs_init_dev(struct ubi_device *ubi) { return 0; } 2282a734bb8SArtem Bityutskiy static inline void ubi_debugfs_exit_dev(struct ubi_device *ubi) { return; } 2292a734bb8SArtem Bityutskiy 23027a0f2a3SArtem Bityutskiy static inline int 23127a0f2a3SArtem Bityutskiy ubi_dbg_is_bgt_disabled(const struct ubi_device *ubi) { return 0; } 23227a0f2a3SArtem Bityutskiy static inline int ubi_dbg_is_bitflip(const struct ubi_device *ubi) { return 0; } 23327a0f2a3SArtem Bityutskiy static inline int 23427a0f2a3SArtem Bityutskiy ubi_dbg_is_write_failure(const struct ubi_device *ubi) { return 0; } 23527a0f2a3SArtem Bityutskiy static inline int 23627a0f2a3SArtem Bityutskiy ubi_dbg_is_erase_failure(const struct ubi_device *ubi) { return 0; } 2372a734bb8SArtem Bityutskiy 238c8566350SArtem Bityutskiy #endif /* !CONFIG_MTD_UBI_DEBUG */ 239801c135cSArtem B. Bityutskiy #endif /* !__UBI_DEBUG_H__ */ 240