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 24ebfce01aSArtem Bityutskiy struct ubi_ec_hdr; 25ebfce01aSArtem Bityutskiy struct ubi_vid_hdr; 26ebfce01aSArtem Bityutskiy struct ubi_volume; 27ebfce01aSArtem Bityutskiy struct ubi_vtbl_record; 28ebfce01aSArtem Bityutskiy struct ubi_scan_volume; 29ebfce01aSArtem Bityutskiy struct ubi_scan_leb; 30ebfce01aSArtem Bityutskiy struct ubi_mkvol_req; 31ebfce01aSArtem Bityutskiy 32801c135cSArtem B. Bityutskiy #ifdef CONFIG_MTD_UBI_DEBUG 33801c135cSArtem B. Bityutskiy #include <linux/random.h> 34801c135cSArtem B. Bityutskiy 35c8566350SArtem Bityutskiy #define ubi_assert(expr) do { \ 36c8566350SArtem Bityutskiy if (unlikely(!(expr))) { \ 37c8566350SArtem Bityutskiy printk(KERN_CRIT "UBI assert failed in %s at %u (pid %d)\n", \ 38c8566350SArtem Bityutskiy __func__, __LINE__, current->pid); \ 39c8566350SArtem Bityutskiy ubi_dbg_dump_stack(); \ 40c8566350SArtem Bityutskiy } \ 41c8566350SArtem Bityutskiy } while (0) 42801c135cSArtem B. Bityutskiy 43ab50ff68SArtem Bityutskiy #define dbg_err(fmt, ...) ubi_err(fmt, ##__VA_ARGS__) 44b342efd4SArtem Bityutskiy 45801c135cSArtem B. Bityutskiy #define ubi_dbg_dump_stack() dump_stack() 46801c135cSArtem B. Bityutskiy 47ab50ff68SArtem Bityutskiy #define ubi_dbg_print_hex_dump(l, ps, pt, r, g, b, len, a) \ 48ab50ff68SArtem Bityutskiy print_hex_dump(l, ps, pt, r, g, b, len, a) 49ab50ff68SArtem Bityutskiy 50ab50ff68SArtem Bityutskiy #define ubi_dbg_msg(type, fmt, ...) \ 51ab50ff68SArtem Bityutskiy pr_debug("UBI DBG " type ": " fmt "\n", ##__VA_ARGS__) 52ab50ff68SArtem Bityutskiy 53ab50ff68SArtem Bityutskiy /* Just a debugging messages not related to any specific UBI subsystem */ 54ab50ff68SArtem Bityutskiy #define dbg_msg(fmt, ...) ubi_dbg_msg("msg", fmt, ##__VA_ARGS__) 55ab50ff68SArtem Bityutskiy /* General debugging messages */ 56ab50ff68SArtem Bityutskiy #define dbg_gen(fmt, ...) ubi_dbg_msg("gen", fmt, ##__VA_ARGS__) 57ab50ff68SArtem Bityutskiy /* Messages from the eraseblock association sub-system */ 58ab50ff68SArtem Bityutskiy #define dbg_eba(fmt, ...) ubi_dbg_msg("eba", fmt, ##__VA_ARGS__) 59ab50ff68SArtem Bityutskiy /* Messages from the wear-leveling sub-system */ 60ab50ff68SArtem Bityutskiy #define dbg_wl(fmt, ...) ubi_dbg_msg("wl", fmt, ##__VA_ARGS__) 61ab50ff68SArtem Bityutskiy /* Messages from the input/output sub-system */ 62ab50ff68SArtem Bityutskiy #define dbg_io(fmt, ...) ubi_dbg_msg("io", fmt, ##__VA_ARGS__) 63ab50ff68SArtem Bityutskiy /* Initialization and build messages */ 64ab50ff68SArtem Bityutskiy #define dbg_bld(fmt, ...) ubi_dbg_msg("bld", fmt, ##__VA_ARGS__) 65ab50ff68SArtem Bityutskiy 66801c135cSArtem B. Bityutskiy void ubi_dbg_dump_ec_hdr(const struct ubi_ec_hdr *ec_hdr); 67801c135cSArtem B. Bityutskiy void ubi_dbg_dump_vid_hdr(const struct ubi_vid_hdr *vid_hdr); 68801c135cSArtem B. Bityutskiy void ubi_dbg_dump_vol_info(const struct ubi_volume *vol); 69801c135cSArtem B. Bityutskiy void ubi_dbg_dump_vtbl_record(const struct ubi_vtbl_record *r, int idx); 70801c135cSArtem B. Bityutskiy void ubi_dbg_dump_sv(const struct ubi_scan_volume *sv); 71801c135cSArtem B. Bityutskiy void ubi_dbg_dump_seb(const struct ubi_scan_leb *seb, int type); 72801c135cSArtem B. Bityutskiy void ubi_dbg_dump_mkvol_req(const struct ubi_mkvol_req *req); 73867996b1SArtem Bityutskiy void ubi_dbg_dump_flash(struct ubi_device *ubi, int pnum, int offset, int len); 7440a71a87SArtem Bityutskiy int ubi_dbg_check_all_ff(struct ubi_device *ubi, int pnum, int offset, int len); 756e9065d7SArtem Bityutskiy int ubi_dbg_check_write(struct ubi_device *ubi, const void *buf, int pnum, 766e9065d7SArtem Bityutskiy int offset, int len); 772a734bb8SArtem Bityutskiy int ubi_debugging_init_dev(struct ubi_device *ubi); 782a734bb8SArtem Bityutskiy void ubi_debugging_exit_dev(struct ubi_device *ubi); 792a734bb8SArtem Bityutskiy int ubi_debugfs_init(void); 802a734bb8SArtem Bityutskiy void ubi_debugfs_exit(void); 812a734bb8SArtem Bityutskiy int ubi_debugfs_init_dev(struct ubi_device *ubi); 822a734bb8SArtem Bityutskiy void ubi_debugfs_exit_dev(struct ubi_device *ubi); 832a734bb8SArtem Bityutskiy 842a734bb8SArtem Bityutskiy /* 852a734bb8SArtem Bityutskiy * The UBI debugfs directory name pattern and maximum name length (3 for "ubi" 862a734bb8SArtem Bityutskiy * + 2 for the number plus 1 for the trailing zero byte. 872a734bb8SArtem Bityutskiy */ 882a734bb8SArtem Bityutskiy #define UBI_DFS_DIR_NAME "ubi%d" 892a734bb8SArtem Bityutskiy #define UBI_DFS_DIR_LEN (3 + 2 + 1) 902a734bb8SArtem Bityutskiy 912a734bb8SArtem Bityutskiy /** 922a734bb8SArtem Bityutskiy * struct ubi_debug_info - debugging information for an UBI device. 932a734bb8SArtem Bityutskiy * 942a734bb8SArtem Bityutskiy * @chk_gen: if UBI general extra checks are enabled 952a734bb8SArtem Bityutskiy * @chk_io: if UBI I/O extra checks are enabled 962a734bb8SArtem Bityutskiy * @dfs_dir_name: name of debugfs directory containing files of this UBI device 972a734bb8SArtem Bityutskiy * @dfs_dir: direntry object of the UBI device debugfs directory 982a734bb8SArtem Bityutskiy * @dfs_chk_gen: debugfs knob to enable UBI general extra checks 992a734bb8SArtem Bityutskiy * @dfs_chk_io: debugfs knob to enable UBI I/O extra checks 1002a734bb8SArtem Bityutskiy */ 1012a734bb8SArtem Bityutskiy struct ubi_debug_info { 1022a734bb8SArtem Bityutskiy unsigned int chk_gen:1; 1032a734bb8SArtem Bityutskiy unsigned int chk_io:1; 1042a734bb8SArtem Bityutskiy char dfs_dir_name[UBI_DFS_DIR_LEN + 1]; 1052a734bb8SArtem Bityutskiy struct dentry *dfs_dir; 1062a734bb8SArtem Bityutskiy struct dentry *dfs_chk_gen; 1072a734bb8SArtem Bityutskiy struct dentry *dfs_chk_io; 1082a734bb8SArtem Bityutskiy }; 10940a71a87SArtem Bityutskiy 11028237e45SArtem Bityutskiy extern unsigned int ubi_tst_flags; 111c8566350SArtem Bityutskiy 11228237e45SArtem Bityutskiy /* 11328237e45SArtem Bityutskiy * Special testing flags. 11428237e45SArtem Bityutskiy * 11528237e45SArtem Bityutskiy * UBIFS_TST_DISABLE_BGT: disable the background thread 11628237e45SArtem Bityutskiy * UBI_TST_EMULATE_BITFLIPS: emulate bit-flips 11728237e45SArtem Bityutskiy * UBI_TST_EMULATE_WRITE_FAILURES: emulate write failures 11828237e45SArtem Bityutskiy * UBI_TST_EMULATE_ERASE_FAILURES: emulate erase failures 11928237e45SArtem Bityutskiy */ 12028237e45SArtem Bityutskiy enum { 12128237e45SArtem Bityutskiy UBI_TST_DISABLE_BGT = 0x1, 12228237e45SArtem Bityutskiy UBI_TST_EMULATE_BITFLIPS = 0x2, 12328237e45SArtem Bityutskiy UBI_TST_EMULATE_WRITE_FAILURES = 0x4, 12428237e45SArtem Bityutskiy UBI_TST_EMULATE_ERASE_FAILURES = 0x8, 12528237e45SArtem Bityutskiy }; 12628237e45SArtem Bityutskiy 12728237e45SArtem Bityutskiy /** 12828237e45SArtem Bityutskiy * ubi_dbg_is_bgt_disabled - if the background thread is disabled. 12928237e45SArtem Bityutskiy * 13028237e45SArtem Bityutskiy * Returns non-zero if the UBI background thread is disabled for testing 13128237e45SArtem Bityutskiy * purposes. 13228237e45SArtem Bityutskiy */ 13328237e45SArtem Bityutskiy static inline int ubi_dbg_is_bgt_disabled(void) 13428237e45SArtem Bityutskiy { 13528237e45SArtem Bityutskiy return ubi_tst_flags & UBI_TST_DISABLE_BGT; 13628237e45SArtem Bityutskiy } 13728237e45SArtem Bityutskiy 138801c135cSArtem B. Bityutskiy /** 139801c135cSArtem B. Bityutskiy * ubi_dbg_is_bitflip - if it is time to emulate a bit-flip. 140801c135cSArtem B. Bityutskiy * 141801c135cSArtem B. Bityutskiy * Returns non-zero if a bit-flip should be emulated, otherwise returns zero. 142801c135cSArtem B. Bityutskiy */ 143801c135cSArtem B. Bityutskiy static inline int ubi_dbg_is_bitflip(void) 144801c135cSArtem B. Bityutskiy { 14528237e45SArtem Bityutskiy if (ubi_tst_flags & UBI_TST_EMULATE_BITFLIPS) 146801c135cSArtem B. Bityutskiy return !(random32() % 200); 14728237e45SArtem Bityutskiy return 0; 148801c135cSArtem B. Bityutskiy } 149801c135cSArtem B. Bityutskiy 150801c135cSArtem B. Bityutskiy /** 151801c135cSArtem B. Bityutskiy * ubi_dbg_is_write_failure - if it is time to emulate a write failure. 152801c135cSArtem B. Bityutskiy * 153801c135cSArtem B. Bityutskiy * Returns non-zero if a write failure should be emulated, otherwise returns 154801c135cSArtem B. Bityutskiy * zero. 155801c135cSArtem B. Bityutskiy */ 156801c135cSArtem B. Bityutskiy static inline int ubi_dbg_is_write_failure(void) 157801c135cSArtem B. Bityutskiy { 15828237e45SArtem Bityutskiy if (ubi_tst_flags & UBI_TST_EMULATE_WRITE_FAILURES) 159801c135cSArtem B. Bityutskiy return !(random32() % 500); 16028237e45SArtem Bityutskiy return 0; 161801c135cSArtem B. Bityutskiy } 162801c135cSArtem B. Bityutskiy 163801c135cSArtem B. Bityutskiy /** 164801c135cSArtem B. Bityutskiy * ubi_dbg_is_erase_failure - if its time to emulate an erase failure. 165801c135cSArtem B. Bityutskiy * 166801c135cSArtem B. Bityutskiy * Returns non-zero if an erase failure should be emulated, otherwise returns 167801c135cSArtem B. Bityutskiy * zero. 168801c135cSArtem B. Bityutskiy */ 169801c135cSArtem B. Bityutskiy static inline int ubi_dbg_is_erase_failure(void) 170801c135cSArtem B. Bityutskiy { 17128237e45SArtem Bityutskiy if (ubi_tst_flags & UBI_TST_EMULATE_ERASE_FAILURES) 172801c135cSArtem B. Bityutskiy return !(random32() % 400); 17328237e45SArtem Bityutskiy return 0; 174801c135cSArtem B. Bityutskiy } 175801c135cSArtem B. Bityutskiy 176c8566350SArtem Bityutskiy #else 177c8566350SArtem Bityutskiy 1783802243aSArtem Bityutskiy /* Use "if (0)" to make compiler check arguments even if debugging is off */ 1793802243aSArtem Bityutskiy #define ubi_assert(expr) do { \ 1803802243aSArtem Bityutskiy if (0) { \ 1813802243aSArtem Bityutskiy printk(KERN_CRIT "UBI assert failed in %s at %u (pid %d)\n", \ 1823802243aSArtem Bityutskiy __func__, __LINE__, current->pid); \ 1833802243aSArtem Bityutskiy } \ 1843802243aSArtem Bityutskiy } while (0) 1853802243aSArtem Bityutskiy 1863802243aSArtem Bityutskiy #define dbg_err(fmt, ...) do { \ 1873802243aSArtem Bityutskiy if (0) \ 1883802243aSArtem Bityutskiy ubi_err(fmt, ##__VA_ARGS__); \ 1893802243aSArtem Bityutskiy } while (0) 1903802243aSArtem Bityutskiy 191ab50ff68SArtem Bityutskiy #define ubi_dbg_msg(fmt, ...) do { \ 1923802243aSArtem Bityutskiy if (0) \ 193ab50ff68SArtem Bityutskiy pr_debug(fmt "\n", ##__VA_ARGS__); \ 1943802243aSArtem Bityutskiy } while (0) 1953802243aSArtem Bityutskiy 196ab50ff68SArtem Bityutskiy #define dbg_msg(fmt, ...) ubi_dbg_msg(fmt, ##__VA_ARGS__) 197ab50ff68SArtem Bityutskiy #define dbg_gen(fmt, ...) ubi_dbg_msg(fmt, ##__VA_ARGS__) 198ab50ff68SArtem Bityutskiy #define dbg_eba(fmt, ...) ubi_dbg_msg(fmt, ##__VA_ARGS__) 199ab50ff68SArtem Bityutskiy #define dbg_wl(fmt, ...) ubi_dbg_msg(fmt, ##__VA_ARGS__) 200ab50ff68SArtem Bityutskiy #define dbg_io(fmt, ...) ubi_dbg_msg(fmt, ##__VA_ARGS__) 201ab50ff68SArtem Bityutskiy #define dbg_bld(fmt, ...) ubi_dbg_msg(fmt, ##__VA_ARGS__) 2023802243aSArtem Bityutskiy 203ebfce01aSArtem Bityutskiy static inline void ubi_dbg_dump_stack(void) { return; } 204ebfce01aSArtem Bityutskiy static inline void 205ebfce01aSArtem Bityutskiy ubi_dbg_dump_ec_hdr(const struct ubi_ec_hdr *ec_hdr) { return; } 206ebfce01aSArtem Bityutskiy static inline void 207ebfce01aSArtem Bityutskiy ubi_dbg_dump_vid_hdr(const struct ubi_vid_hdr *vid_hdr) { return; } 208ebfce01aSArtem Bityutskiy static inline void 209ebfce01aSArtem Bityutskiy ubi_dbg_dump_vol_info(const struct ubi_volume *vol) { return; } 210ebfce01aSArtem Bityutskiy static inline void 211ebfce01aSArtem Bityutskiy ubi_dbg_dump_vtbl_record(const struct ubi_vtbl_record *r, int idx) { return; } 212ebfce01aSArtem Bityutskiy static inline void ubi_dbg_dump_sv(const struct ubi_scan_volume *sv) { return; } 213ebfce01aSArtem Bityutskiy static inline void ubi_dbg_dump_seb(const struct ubi_scan_leb *seb, 214ebfce01aSArtem Bityutskiy int type) { return; } 215ebfce01aSArtem Bityutskiy static inline void 216ebfce01aSArtem Bityutskiy ubi_dbg_dump_mkvol_req(const struct ubi_mkvol_req *req) { return; } 217ebfce01aSArtem Bityutskiy static inline void ubi_dbg_dump_flash(struct ubi_device *ubi, 218ebfce01aSArtem Bityutskiy int pnum, int offset, int len) { return; } 219ebfce01aSArtem Bityutskiy static inline void 220ebfce01aSArtem Bityutskiy ubi_dbg_print_hex_dump(const char *l, const char *ps, int pt, int r, 221ebfce01aSArtem Bityutskiy int g, const void *b, size_t len, bool a) { return; } 222ebfce01aSArtem Bityutskiy static inline int ubi_dbg_check_all_ff(struct ubi_device *ubi, 223ebfce01aSArtem Bityutskiy int pnum, int offset, 224ebfce01aSArtem Bityutskiy int len) { return 0; } 225ebfce01aSArtem Bityutskiy static inline int ubi_dbg_check_write(struct ubi_device *ubi, 226ebfce01aSArtem Bityutskiy const void *buf, int pnum, 227ebfce01aSArtem Bityutskiy int offset, int len) { return 0; } 228c8566350SArtem Bityutskiy 2292a734bb8SArtem Bityutskiy static inline int ubi_debugging_init_dev(struct ubi_device *ubi) { return 0; } 2302a734bb8SArtem Bityutskiy static inline void ubi_debugging_exit_dev(struct ubi_device *ubi) { return; } 2312a734bb8SArtem Bityutskiy static inline int ubi_debugfs_init(void) { return 0; } 2322a734bb8SArtem Bityutskiy static inline void ubi_debugfs_exit(void) { return; } 2332a734bb8SArtem Bityutskiy static inline int ubi_debugfs_init_dev(struct ubi_device *ubi) { return 0; } 2342a734bb8SArtem Bityutskiy static inline void ubi_debugfs_exit_dev(struct ubi_device *ubi) { return; } 2352a734bb8SArtem Bityutskiy 2362a734bb8SArtem Bityutskiy static inline int ubi_dbg_is_bgt_disabled(void) { return 0; } 2372a734bb8SArtem Bityutskiy static inline int ubi_dbg_is_bitflip(void) { return 0; } 2382a734bb8SArtem Bityutskiy static inline int ubi_dbg_is_write_failure(void) { return 0; } 2392a734bb8SArtem Bityutskiy static inline int ubi_dbg_is_erase_failure(void) { return 0; } 2402a734bb8SArtem Bityutskiy 241c8566350SArtem Bityutskiy #endif /* !CONFIG_MTD_UBI_DEBUG */ 242801c135cSArtem B. Bityutskiy #endif /* !__UBI_DEBUG_H__ */ 243