drivers/mtd/ubi/debug.h

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