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 #ifndef __UBI_DEBUG_H__ 22 #define __UBI_DEBUG_H__ 23 24 #ifdef CONFIG_MTD_UBI_DEBUG 25 #include <linux/random.h> 26 27 #define ubi_assert(expr) BUG_ON(!(expr)) 28 #define dbg_err(fmt, ...) ubi_err(fmt, ##__VA_ARGS__) 29 #else 30 #define ubi_assert(expr) ({}) 31 #define dbg_err(fmt, ...) ({}) 32 #endif 33 34 #ifdef CONFIG_MTD_UBI_DEBUG_DISABLE_BGT 35 #define DBG_DISABLE_BGT 1 36 #else 37 #define DBG_DISABLE_BGT 0 38 #endif 39 40 #ifdef CONFIG_MTD_UBI_DEBUG_MSG 41 /* Generic debugging message */ 42 #define dbg_msg(fmt, ...) \ 43 printk(KERN_DEBUG "UBI DBG: %s: " fmt "\n", __FUNCTION__, ##__VA_ARGS__) 44 45 #define ubi_dbg_dump_stack() dump_stack() 46 47 struct ubi_ec_hdr; 48 struct ubi_vid_hdr; 49 struct ubi_volume; 50 struct ubi_vtbl_record; 51 struct ubi_scan_volume; 52 struct ubi_scan_leb; 53 struct ubi_mkvol_req; 54 55 void ubi_dbg_dump_ec_hdr(const struct ubi_ec_hdr *ec_hdr); 56 void ubi_dbg_dump_vid_hdr(const struct ubi_vid_hdr *vid_hdr); 57 void ubi_dbg_dump_vol_info(const struct ubi_volume *vol); 58 void ubi_dbg_dump_vtbl_record(const struct ubi_vtbl_record *r, int idx); 59 void ubi_dbg_dump_sv(const struct ubi_scan_volume *sv); 60 void ubi_dbg_dump_seb(const struct ubi_scan_leb *seb, int type); 61 void ubi_dbg_dump_mkvol_req(const struct ubi_mkvol_req *req); 62 void ubi_dbg_hexdump(const void *buf, int size); 63 64 #else 65 66 #define dbg_msg(fmt, ...) ({}) 67 #define ubi_dbg_dump_stack() ({}) 68 #define ubi_dbg_dump_ec_hdr(ec_hdr) ({}) 69 #define ubi_dbg_dump_vid_hdr(vid_hdr) ({}) 70 #define ubi_dbg_dump_vol_info(vol) ({}) 71 #define ubi_dbg_dump_vtbl_record(r, idx) ({}) 72 #define ubi_dbg_dump_sv(sv) ({}) 73 #define ubi_dbg_dump_seb(seb, type) ({}) 74 #define ubi_dbg_dump_mkvol_req(req) ({}) 75 #define ubi_dbg_hexdump(buf, size) ({}) 76 77 #endif /* CONFIG_MTD_UBI_DEBUG_MSG */ 78 79 #ifdef CONFIG_MTD_UBI_DEBUG_MSG_EBA 80 /* Messages from the eraseblock association unit */ 81 #define dbg_eba(fmt, ...) \ 82 printk(KERN_DEBUG "UBI DBG eba: %s: " fmt "\n", __FUNCTION__, \ 83 ##__VA_ARGS__) 84 #else 85 #define dbg_eba(fmt, ...) ({}) 86 #endif 87 88 #ifdef CONFIG_MTD_UBI_DEBUG_MSG_WL 89 /* Messages from the wear-leveling unit */ 90 #define dbg_wl(fmt, ...) \ 91 printk(KERN_DEBUG "UBI DBG wl: %s: " fmt "\n", __FUNCTION__, \ 92 ##__VA_ARGS__) 93 #else 94 #define dbg_wl(fmt, ...) ({}) 95 #endif 96 97 #ifdef CONFIG_MTD_UBI_DEBUG_MSG_IO 98 /* Messages from the input/output unit */ 99 #define dbg_io(fmt, ...) \ 100 printk(KERN_DEBUG "UBI DBG io: %s: " fmt "\n", __FUNCTION__, \ 101 ##__VA_ARGS__) 102 #else 103 #define dbg_io(fmt, ...) ({}) 104 #endif 105 106 #ifdef CONFIG_MTD_UBI_DEBUG_MSG_BLD 107 /* Initialization and build messages */ 108 #define dbg_bld(fmt, ...) \ 109 printk(KERN_DEBUG "UBI DBG bld: %s: " fmt "\n", __FUNCTION__, \ 110 ##__VA_ARGS__) 111 #else 112 #define dbg_bld(fmt, ...) ({}) 113 #endif 114 115 #ifdef CONFIG_MTD_UBI_DEBUG_EMULATE_BITFLIPS 116 /** 117 * ubi_dbg_is_bitflip - if it is time to emulate a bit-flip. 118 * 119 * Returns non-zero if a bit-flip should be emulated, otherwise returns zero. 120 */ 121 static inline int ubi_dbg_is_bitflip(void) 122 { 123 return !(random32() % 200); 124 } 125 #else 126 #define ubi_dbg_is_bitflip() 0 127 #endif 128 129 #ifdef CONFIG_MTD_UBI_DEBUG_EMULATE_WRITE_FAILURES 130 /** 131 * ubi_dbg_is_write_failure - if it is time to emulate a write failure. 132 * 133 * Returns non-zero if a write failure should be emulated, otherwise returns 134 * zero. 135 */ 136 static inline int ubi_dbg_is_write_failure(void) 137 { 138 return !(random32() % 500); 139 } 140 #else 141 #define ubi_dbg_is_write_failure() 0 142 #endif 143 144 #ifdef CONFIG_MTD_UBI_DEBUG_EMULATE_ERASE_FAILURES 145 /** 146 * ubi_dbg_is_erase_failure - if its time to emulate an erase failure. 147 * 148 * Returns non-zero if an erase failure should be emulated, otherwise returns 149 * zero. 150 */ 151 static inline int ubi_dbg_is_erase_failure(void) 152 { 153 return !(random32() % 400); 154 } 155 #else 156 #define ubi_dbg_is_erase_failure() 0 157 #endif 158 159 #endif /* !__UBI_DEBUG_H__ */ 160