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 27801c135cSArtem B. Bityutskiy #define dbg_err(fmt, ...) ubi_err(fmt, ##__VA_ARGS__) 28801c135cSArtem B. Bityutskiy 29c8566350SArtem Bityutskiy #define ubi_assert(expr) do { \ 30c8566350SArtem Bityutskiy if (unlikely(!(expr))) { \ 31c8566350SArtem Bityutskiy printk(KERN_CRIT "UBI assert failed in %s at %u (pid %d)\n", \ 32c8566350SArtem Bityutskiy __func__, __LINE__, current->pid); \ 33c8566350SArtem Bityutskiy ubi_dbg_dump_stack(); \ 34c8566350SArtem Bityutskiy } \ 35c8566350SArtem Bityutskiy } while (0) 36801c135cSArtem B. Bityutskiy 37801c135cSArtem B. Bityutskiy #define dbg_msg(fmt, ...) \ 38d19bafd9SArtem Bityutskiy printk(KERN_DEBUG "UBI DBG (pid %d): %s: " fmt "\n", \ 39cb53b3b9SHarvey Harrison current->pid, __func__, ##__VA_ARGS__) 40801c135cSArtem B. Bityutskiy 41b342efd4SArtem Bityutskiy #define dbg_do_msg(typ, fmt, ...) do { \ 42b342efd4SArtem Bityutskiy if (ubi_msg_flags & typ) \ 43b342efd4SArtem Bityutskiy dbg_msg(fmt, ##__VA_ARGS__); \ 44b342efd4SArtem Bityutskiy } while (0) 45b342efd4SArtem Bityutskiy 46801c135cSArtem B. Bityutskiy #define ubi_dbg_dump_stack() dump_stack() 47801c135cSArtem B. Bityutskiy 48801c135cSArtem B. Bityutskiy struct ubi_ec_hdr; 49801c135cSArtem B. Bityutskiy struct ubi_vid_hdr; 50801c135cSArtem B. Bityutskiy struct ubi_volume; 51801c135cSArtem B. Bityutskiy struct ubi_vtbl_record; 52801c135cSArtem B. Bityutskiy struct ubi_scan_volume; 53801c135cSArtem B. Bityutskiy struct ubi_scan_leb; 54801c135cSArtem B. Bityutskiy struct ubi_mkvol_req; 55801c135cSArtem B. Bityutskiy 56801c135cSArtem B. Bityutskiy void ubi_dbg_dump_ec_hdr(const struct ubi_ec_hdr *ec_hdr); 57801c135cSArtem B. Bityutskiy void ubi_dbg_dump_vid_hdr(const struct ubi_vid_hdr *vid_hdr); 58801c135cSArtem B. Bityutskiy void ubi_dbg_dump_vol_info(const struct ubi_volume *vol); 59801c135cSArtem B. Bityutskiy void ubi_dbg_dump_vtbl_record(const struct ubi_vtbl_record *r, int idx); 60801c135cSArtem B. Bityutskiy void ubi_dbg_dump_sv(const struct ubi_scan_volume *sv); 61801c135cSArtem B. Bityutskiy void ubi_dbg_dump_seb(const struct ubi_scan_leb *seb, int type); 62801c135cSArtem B. Bityutskiy void ubi_dbg_dump_mkvol_req(const struct ubi_mkvol_req *req); 63867996b1SArtem Bityutskiy void ubi_dbg_dump_flash(struct ubi_device *ubi, int pnum, int offset, int len); 64801c135cSArtem B. Bityutskiy 65b342efd4SArtem Bityutskiy extern unsigned int ubi_msg_flags; 66b342efd4SArtem Bityutskiy 67b342efd4SArtem Bityutskiy /* 68b342efd4SArtem Bityutskiy * Debugging message type flags (must match msg_type_names in debug.c). 69b342efd4SArtem Bityutskiy * 70b342efd4SArtem Bityutskiy * UBI_MSG_GEN: general messages 71b342efd4SArtem Bityutskiy * UBI_MSG_EBA: journal messages 72b342efd4SArtem Bityutskiy * UBI_MSG_WL: mount messages 73b342efd4SArtem Bityutskiy * UBI_MSG_IO: commit messages 74b342efd4SArtem Bityutskiy * UBI_MSG_BLD: LEB find messages 75b342efd4SArtem Bityutskiy */ 76b342efd4SArtem Bityutskiy enum { 77b342efd4SArtem Bityutskiy UBI_MSG_GEN = 0x1, 78b342efd4SArtem Bityutskiy UBI_MSG_EBA = 0x2, 79b342efd4SArtem Bityutskiy UBI_MSG_WL = 0x4, 80b342efd4SArtem Bityutskiy UBI_MSG_IO = 0x8, 81b342efd4SArtem Bityutskiy UBI_MSG_BLD = 0x10, 82b342efd4SArtem Bityutskiy }; 83b342efd4SArtem Bityutskiy 8431532494SArtem Bityutskiy #define ubi_dbg_print_hex_dump(l, ps, pt, r, g, b, len, a) \ 8531532494SArtem Bityutskiy print_hex_dump(l, ps, pt, r, g, b, len, a) 8631532494SArtem Bityutskiy 87c8566350SArtem Bityutskiy /* General debugging messages */ 88b342efd4SArtem Bityutskiy #define dbg_gen(fmt, ...) dbg_do_msg(UBI_MSG_GEN, fmt, ##__VA_ARGS__) 89801c135cSArtem B. Bityutskiy 9085c6e6e2SArtem Bityutskiy /* Messages from the eraseblock association sub-system */ 91b342efd4SArtem Bityutskiy #define dbg_eba(fmt, ...) dbg_do_msg(UBI_MSG_EBA, fmt, ##__VA_ARGS__) 92801c135cSArtem B. Bityutskiy 9385c6e6e2SArtem Bityutskiy /* Messages from the wear-leveling sub-system */ 94b342efd4SArtem Bityutskiy #define dbg_wl(fmt, ...) dbg_do_msg(UBI_MSG_WL, fmt, ##__VA_ARGS__) 95801c135cSArtem B. Bityutskiy 9685c6e6e2SArtem Bityutskiy /* Messages from the input/output sub-system */ 97b342efd4SArtem Bityutskiy #define dbg_io(fmt, ...) dbg_do_msg(UBI_MSG_IO, fmt, ##__VA_ARGS__) 98801c135cSArtem B. Bityutskiy 99801c135cSArtem B. Bityutskiy /* Initialization and build messages */ 100b342efd4SArtem Bityutskiy #define dbg_bld(fmt, ...) dbg_do_msg(UBI_MSG_BLD, fmt, ##__VA_ARGS__) 101801c135cSArtem B. Bityutskiy 10240a71a87SArtem Bityutskiy #ifdef CONFIG_MTD_UBI_DEBUG_PARANOID 10340a71a87SArtem Bityutskiy int ubi_dbg_check_all_ff(struct ubi_device *ubi, int pnum, int offset, int len); 1046e9065d7SArtem Bityutskiy int ubi_dbg_check_write(struct ubi_device *ubi, const void *buf, int pnum, 1056e9065d7SArtem Bityutskiy int offset, int len); 10640a71a87SArtem Bityutskiy #else 10740a71a87SArtem Bityutskiy #define ubi_dbg_check_all_ff(ubi, pnum, offset, len) 0 1086e9065d7SArtem Bityutskiy #define ubi_dbg_check_write(ubi, buf, pnum, offset, len) 0 10940a71a87SArtem Bityutskiy #endif 11040a71a87SArtem Bityutskiy 111c8566350SArtem Bityutskiy #ifdef CONFIG_MTD_UBI_DEBUG_DISABLE_BGT 112c8566350SArtem Bityutskiy #define DBG_DISABLE_BGT 1 113c8566350SArtem Bityutskiy #else 114c8566350SArtem Bityutskiy #define DBG_DISABLE_BGT 0 115c8566350SArtem Bityutskiy #endif 116c8566350SArtem Bityutskiy 117801c135cSArtem B. Bityutskiy #ifdef CONFIG_MTD_UBI_DEBUG_EMULATE_BITFLIPS 118801c135cSArtem B. Bityutskiy /** 119801c135cSArtem B. Bityutskiy * ubi_dbg_is_bitflip - if it is time to emulate a bit-flip. 120801c135cSArtem B. Bityutskiy * 121801c135cSArtem B. Bityutskiy * Returns non-zero if a bit-flip should be emulated, otherwise returns zero. 122801c135cSArtem B. Bityutskiy */ 123801c135cSArtem B. Bityutskiy static inline int ubi_dbg_is_bitflip(void) 124801c135cSArtem B. Bityutskiy { 125801c135cSArtem B. Bityutskiy return !(random32() % 200); 126801c135cSArtem B. Bityutskiy } 127801c135cSArtem B. Bityutskiy #else 128801c135cSArtem B. Bityutskiy #define ubi_dbg_is_bitflip() 0 129801c135cSArtem B. Bityutskiy #endif 130801c135cSArtem B. Bityutskiy 131801c135cSArtem B. Bityutskiy #ifdef CONFIG_MTD_UBI_DEBUG_EMULATE_WRITE_FAILURES 132801c135cSArtem B. Bityutskiy /** 133801c135cSArtem B. Bityutskiy * ubi_dbg_is_write_failure - if it is time to emulate a write failure. 134801c135cSArtem B. Bityutskiy * 135801c135cSArtem B. Bityutskiy * Returns non-zero if a write failure should be emulated, otherwise returns 136801c135cSArtem B. Bityutskiy * zero. 137801c135cSArtem B. Bityutskiy */ 138801c135cSArtem B. Bityutskiy static inline int ubi_dbg_is_write_failure(void) 139801c135cSArtem B. Bityutskiy { 140801c135cSArtem B. Bityutskiy return !(random32() % 500); 141801c135cSArtem B. Bityutskiy } 142801c135cSArtem B. Bityutskiy #else 143801c135cSArtem B. Bityutskiy #define ubi_dbg_is_write_failure() 0 144801c135cSArtem B. Bityutskiy #endif 145801c135cSArtem B. Bityutskiy 146801c135cSArtem B. Bityutskiy #ifdef CONFIG_MTD_UBI_DEBUG_EMULATE_ERASE_FAILURES 147801c135cSArtem B. Bityutskiy /** 148801c135cSArtem B. Bityutskiy * ubi_dbg_is_erase_failure - if its time to emulate an erase failure. 149801c135cSArtem B. Bityutskiy * 150801c135cSArtem B. Bityutskiy * Returns non-zero if an erase failure should be emulated, otherwise returns 151801c135cSArtem B. Bityutskiy * zero. 152801c135cSArtem B. Bityutskiy */ 153801c135cSArtem B. Bityutskiy static inline int ubi_dbg_is_erase_failure(void) 154801c135cSArtem B. Bityutskiy { 155801c135cSArtem B. Bityutskiy return !(random32() % 400); 156801c135cSArtem B. Bityutskiy } 157801c135cSArtem B. Bityutskiy #else 158801c135cSArtem B. Bityutskiy #define ubi_dbg_is_erase_failure() 0 159801c135cSArtem B. Bityutskiy #endif 160801c135cSArtem B. Bityutskiy 161c8566350SArtem Bityutskiy #else 162c8566350SArtem Bityutskiy 163c8566350SArtem Bityutskiy #define ubi_assert(expr) ({}) 164c8566350SArtem Bityutskiy #define dbg_err(fmt, ...) ({}) 165c8566350SArtem Bityutskiy #define dbg_msg(fmt, ...) ({}) 166c8566350SArtem Bityutskiy #define dbg_gen(fmt, ...) ({}) 167c8566350SArtem Bityutskiy #define dbg_eba(fmt, ...) ({}) 168c8566350SArtem Bityutskiy #define dbg_wl(fmt, ...) ({}) 169c8566350SArtem Bityutskiy #define dbg_io(fmt, ...) ({}) 170c8566350SArtem Bityutskiy #define dbg_bld(fmt, ...) ({}) 171c8566350SArtem Bityutskiy #define ubi_dbg_dump_stack() ({}) 172c8566350SArtem Bityutskiy #define ubi_dbg_dump_ec_hdr(ec_hdr) ({}) 173c8566350SArtem Bityutskiy #define ubi_dbg_dump_vid_hdr(vid_hdr) ({}) 174c8566350SArtem Bityutskiy #define ubi_dbg_dump_vol_info(vol) ({}) 175c8566350SArtem Bityutskiy #define ubi_dbg_dump_vtbl_record(r, idx) ({}) 176c8566350SArtem Bityutskiy #define ubi_dbg_dump_sv(sv) ({}) 177c8566350SArtem Bityutskiy #define ubi_dbg_dump_seb(seb, type) ({}) 178c8566350SArtem Bityutskiy #define ubi_dbg_dump_mkvol_req(req) ({}) 179867996b1SArtem Bityutskiy #define ubi_dbg_dump_flash(ubi, pnum, offset, len) ({}) 18031532494SArtem Bityutskiy #define ubi_dbg_print_hex_dump(l, ps, pt, r, g, b, len, a) ({}) 181c8566350SArtem Bityutskiy 182c8566350SArtem Bityutskiy #define DBG_DISABLE_BGT 0 183c8566350SArtem Bityutskiy #define ubi_dbg_is_bitflip() 0 184c8566350SArtem Bityutskiy #define ubi_dbg_is_write_failure() 0 185c8566350SArtem Bityutskiy #define ubi_dbg_is_erase_failure() 0 1861398788fSArtem Bityutskiy #define ubi_dbg_check_all_ff(ubi, pnum, offset, len) 0 1876e9065d7SArtem Bityutskiy #define ubi_dbg_check_write(ubi, buf, pnum, offset, len) 0 188c8566350SArtem Bityutskiy 189c8566350SArtem Bityutskiy #endif /* !CONFIG_MTD_UBI_DEBUG */ 190801c135cSArtem B. Bityutskiy #endif /* !__UBI_DEBUG_H__ */ 191