projects / deliverable / linux.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
UBI: rename ubi_dbg_dump_vol_info
[deliverable/linux.git] / drivers / mtd / ubi / debug.h
CommitLineData
801c135c
AB		 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
ef7088e7 24void ubi_dump_flash(struct ubi_device *ubi, int pnum, int offset, int len);
a904e3f1
AB		 25void ubi_dump_ec_hdr(const struct ubi_ec_hdr *ec_hdr);
26void ubi_dump_vid_hdr(const struct ubi_vid_hdr *vid_hdr);
ef7088e7 27
801c135c
AB		 28#ifdef CONFIG_MTD_UBI_DEBUG
29#include <linux/random.h>
30
c8566350 31#define ubi_assert(expr) do { \
f2863c54
AB		 32 if (unlikely(!(expr))) { \
33 printk(KERN_CRIT "UBI assert failed in %s at %u (pid %d)\n", \
34 __func__, __LINE__, current->pid); \
25886a36 35 dump_stack(); \
f2863c54 36 } \
c8566350 37} while (0)
801c135c 38
ab50ff68 39#define dbg_err(fmt, ...) ubi_err(fmt, ##__VA_ARGS__)
b342efd4 40
31532494
AB		 41#define ubi_dbg_print_hex_dump(l, ps, pt, r, g, b, len, a) \
42 print_hex_dump(l, ps, pt, r, g, b, len, a)
43
ab50ff68
AB		 44#define ubi_dbg_msg(type, fmt, ...) \
45 pr_debug("UBI DBG " type ": " fmt "\n", ##__VA_ARGS__)
801c135c 46
ab50ff68 47/* Just a debugging messages not related to any specific UBI subsystem */
72f0d453
AB		 48#define dbg_msg(fmt, ...) \
49 printk(KERN_DEBUG "UBI DBG (pid %d): %s: " fmt "\n", \
50 current->pid, __func__, ##__VA_ARGS__)
51
ab50ff68
AB		 52/* General debugging messages */
53#define dbg_gen(fmt, ...) ubi_dbg_msg("gen", fmt, ##__VA_ARGS__)
85c6e6e2 54/* Messages from the eraseblock association sub-system */
ab50ff68 55#define dbg_eba(fmt, ...) ubi_dbg_msg("eba", fmt, ##__VA_ARGS__)
85c6e6e2 56/* Messages from the wear-leveling sub-system */
ab50ff68 57#define dbg_wl(fmt, ...) ubi_dbg_msg("wl", fmt, ##__VA_ARGS__)
85c6e6e2 58/* Messages from the input/output sub-system */
ab50ff68 59#define dbg_io(fmt, ...) ubi_dbg_msg("io", fmt, ##__VA_ARGS__)
801c135c 60/* Initialization and build messages */
ab50ff68
AB		 61#define dbg_bld(fmt, ...) ubi_dbg_msg("bld", fmt, ##__VA_ARGS__)
62
766381f0 63void ubi_dump_vol_info(const struct ubi_volume *vol);
ab50ff68
AB		 64void ubi_dbg_dump_vtbl_record(const struct ubi_vtbl_record *r, int idx);
65void ubi_dbg_dump_sv(const struct ubi_scan_volume *sv);
66void ubi_dbg_dump_seb(const struct ubi_scan_leb *seb, int type);
67void ubi_dbg_dump_mkvol_req(const struct ubi_mkvol_req *req);
2a734bb8
AB		 68int ubi_dbg_check_all_ff(struct ubi_device *ubi, int pnum, int offset, int len);
69int ubi_dbg_check_write(struct ubi_device *ubi, const void *buf, int pnum,
70 int offset, int len);
71int ubi_debugging_init_dev(struct ubi_device *ubi);
72void ubi_debugging_exit_dev(struct ubi_device *ubi);
73int ubi_debugfs_init(void);
74void ubi_debugfs_exit(void);
75int ubi_debugfs_init_dev(struct ubi_device *ubi);
76void ubi_debugfs_exit_dev(struct ubi_device *ubi);
92d124f5
AB		 77
78/*
2a734bb8
AB		 79 * The UBI debugfs directory name pattern and maximum name length (3 for "ubi"
80 * + 2 for the number plus 1 for the trailing zero byte.
81 */
82#define UBI_DFS_DIR_NAME "ubi%d"
83#define UBI_DFS_DIR_LEN (3 + 2 + 1)
84
85/**
86 * struct ubi_debug_info - debugging information for an UBI device.
92d124f5 87 *
2a734bb8
AB		 88 * @chk_gen: if UBI general extra checks are enabled
89 * @chk_io: if UBI I/O extra checks are enabled
cd6d8567
AB		 90 * @disable_bgt: disable the background task for testing purposes
91 * @emulate_bitflips: emulate bit-flips for testing purposes
92 * @emulate_io_failures: emulate write/erase failures for testing purposes
2a734bb8
AB		 93 * @dfs_dir_name: name of debugfs directory containing files of this UBI device
94 * @dfs_dir: direntry object of the UBI device debugfs directory
95 * @dfs_chk_gen: debugfs knob to enable UBI general extra checks
96 * @dfs_chk_io: debugfs knob to enable UBI I/O extra checks
cd6d8567
AB		 97 * @dfs_disable_bgt: debugfs knob to disable the background task
98 * @dfs_emulate_bitflips: debugfs knob to emulate bit-flips
99 * @dfs_emulate_io_failures: debugfs knob to emulate write/erase failures
92d124f5 100 */
2a734bb8
AB		 101struct ubi_debug_info {
102 unsigned int chk_gen:1;
103 unsigned int chk_io:1;
cd6d8567
AB		 104 unsigned int disable_bgt:1;
105 unsigned int emulate_bitflips:1;
106 unsigned int emulate_io_failures:1;
2a734bb8
AB		 107 char dfs_dir_name[UBI_DFS_DIR_LEN + 1];
108 struct dentry *dfs_dir;
109 struct dentry *dfs_chk_gen;
110 struct dentry *dfs_chk_io;
cd6d8567
AB		 111 struct dentry *dfs_disable_bgt;
112 struct dentry *dfs_emulate_bitflips;
113 struct dentry *dfs_emulate_io_failures;
28237e45
AB		 114};
115
116/**
117 * ubi_dbg_is_bgt_disabled - if the background thread is disabled.
27a0f2a3 118 * @ubi: UBI device description object
28237e45
AB		 119 *
120 * Returns non-zero if the UBI background thread is disabled for testing
121 * purposes.
122 */
27a0f2a3 123static inline int ubi_dbg_is_bgt_disabled(const struct ubi_device *ubi)
28237e45 124{
cd6d8567 125 return ubi->dbg->disable_bgt;
28237e45 126}
c8566350 127
801c135c
AB		 128/**
129 * ubi_dbg_is_bitflip - if it is time to emulate a bit-flip.
27a0f2a3 130 * @ubi: UBI device description object
801c135c
AB		 131 *
132 * Returns non-zero if a bit-flip should be emulated, otherwise returns zero.
133 */
27a0f2a3 134static inline int ubi_dbg_is_bitflip(const struct ubi_device *ubi)
801c135c 135{
cd6d8567 136 if (ubi->dbg->emulate_bitflips)
28237e45
AB		 137 return !(random32() % 200);
138 return 0;
801c135c 139}
801c135c 140
801c135c
AB		 141/**
142 * ubi_dbg_is_write_failure - if it is time to emulate a write failure.
27a0f2a3 143 * @ubi: UBI device description object
801c135c
AB		 144 *
145 * Returns non-zero if a write failure should be emulated, otherwise returns
146 * zero.
147 */
27a0f2a3 148static inline int ubi_dbg_is_write_failure(const struct ubi_device *ubi)
801c135c 149{
cd6d8567 150 if (ubi->dbg->emulate_io_failures)
28237e45
AB		 151 return !(random32() % 500);
152 return 0;
801c135c 153}
801c135c 154
801c135c
AB		 155/**
156 * ubi_dbg_is_erase_failure - if its time to emulate an erase failure.
27a0f2a3 157 * @ubi: UBI device description object
801c135c
AB		 158 *
159 * Returns non-zero if an erase failure should be emulated, otherwise returns
160 * zero.
161 */
27a0f2a3 162static inline int ubi_dbg_is_erase_failure(const struct ubi_device *ubi)
801c135c 163{
cd6d8567 164 if (ubi->dbg->emulate_io_failures)
801c135c 165 return !(random32() % 400);
28237e45 166 return 0;
801c135c 167}
801c135c 168
c8566350
AB		 169#else
170
3802243a
AB		 171/* Use "if (0)" to make compiler check arguments even if debugging is off */
172#define ubi_assert(expr) do { \
173 if (0) { \
174 printk(KERN_CRIT "UBI assert failed in %s at %u (pid %d)\n", \
175 __func__, __LINE__, current->pid); \
176 } \
177} while (0)
178
179#define dbg_err(fmt, ...) do { \
180 if (0) \
181 ubi_err(fmt, ##__VA_ARGS__); \
182} while (0)
183
ab50ff68 184#define ubi_dbg_msg(fmt, ...) do { \
3802243a 185 if (0) \
9efabc84 186 printk(KERN_DEBUG fmt "\n", ##__VA_ARGS__); \
3802243a
AB		 187} while (0)
188
ab50ff68
AB		 189#define dbg_msg(fmt, ...) ubi_dbg_msg(fmt, ##__VA_ARGS__)
190#define dbg_gen(fmt, ...) ubi_dbg_msg(fmt, ##__VA_ARGS__)
191#define dbg_eba(fmt, ...) ubi_dbg_msg(fmt, ##__VA_ARGS__)
192#define dbg_wl(fmt, ...) ubi_dbg_msg(fmt, ##__VA_ARGS__)
193#define dbg_io(fmt, ...) ubi_dbg_msg(fmt, ##__VA_ARGS__)
194#define dbg_bld(fmt, ...) ubi_dbg_msg(fmt, ##__VA_ARGS__)
3802243a 195
ebfce01a 196static inline void
766381f0 197ubi_dump_vol_info(const struct ubi_volume *vol) { return; }
ebfce01a
AB		 198static inline void
199ubi_dbg_dump_vtbl_record(const struct ubi_vtbl_record *r, int idx) { return; }
200static inline void ubi_dbg_dump_sv(const struct ubi_scan_volume *sv) { return; }
201static inline void ubi_dbg_dump_seb(const struct ubi_scan_leb *seb,
202 int type) { return; }
203static inline void
204ubi_dbg_dump_mkvol_req(const struct ubi_mkvol_req *req) { return; }
ebfce01a
AB		 205static inline void
206ubi_dbg_print_hex_dump(const char *l, const char *ps, int pt, int r,
207 int g, const void *b, size_t len, bool a) { return; }
ebfce01a
AB		 208static inline int ubi_dbg_check_all_ff(struct ubi_device *ubi,
209 int pnum, int offset,
210 int len) { return 0; }
211static inline int ubi_dbg_check_write(struct ubi_device *ubi,
212 const void *buf, int pnum,
213 int offset, int len) { return 0; }
c8566350 214
2a734bb8
AB		 215static inline int ubi_debugging_init_dev(struct ubi_device *ubi) { return 0; }
216static inline void ubi_debugging_exit_dev(struct ubi_device *ubi) { return; }
217static inline int ubi_debugfs_init(void) { return 0; }
218static inline void ubi_debugfs_exit(void) { return; }
219static inline int ubi_debugfs_init_dev(struct ubi_device *ubi) { return 0; }
220static inline void ubi_debugfs_exit_dev(struct ubi_device *ubi) { return; }
221
27a0f2a3
AB		 222static inline int
223ubi_dbg_is_bgt_disabled(const struct ubi_device *ubi) { return 0; }
224static inline int ubi_dbg_is_bitflip(const struct ubi_device *ubi) { return 0; }
225static inline int
226ubi_dbg_is_write_failure(const struct ubi_device *ubi) { return 0; }
227static inline int
228ubi_dbg_is_erase_failure(const struct ubi_device *ubi) { return 0; }
2a734bb8 229
c8566350 230#endif /* !CONFIG_MTD_UBI_DEBUG */
801c135c 231#endif /* !__UBI_DEBUG_H__ */
Linux kernel - Deliverables
This page took 0.373637 seconds and 5 git commands to generate.