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 void ubi_dump_flash(struct ubi_device *ubi, int pnum, int offset, int len);
25 void ubi_dump_ec_hdr(const struct ubi_ec_hdr *ec_hdr);
26 void ubi_dump_vid_hdr(const struct ubi_vid_hdr *vid_hdr);
27
28 #include <linux/random.h>
29
30 #define ubi_assert(expr) do { \
31 if (unlikely(!(expr))) { \
32 pr_crit("UBI assert failed in %s at %u (pid %d)\n", \
33 __func__, __LINE__, current->pid); \
34 dump_stack(); \
35 } \
36 } while (0)
37
38 #define ubi_dbg_print_hex_dump(l, ps, pt, r, g, b, len, a) \
39 print_hex_dump(l, ps, pt, r, g, b, len, a)
40
41 #define ubi_dbg_msg(type, fmt, ...) \
42 pr_debug("UBI DBG " type " (pid %d): " fmt "\n", current->pid, \
43 ##__VA_ARGS__)
44
45 /* General debugging messages */
46 #define dbg_gen(fmt, ...) ubi_dbg_msg("gen", fmt, ##__VA_ARGS__)
47 /* Messages from the eraseblock association sub-system */
48 #define dbg_eba(fmt, ...) ubi_dbg_msg("eba", fmt, ##__VA_ARGS__)
49 /* Messages from the wear-leveling sub-system */
50 #define dbg_wl(fmt, ...) ubi_dbg_msg("wl", fmt, ##__VA_ARGS__)
51 /* Messages from the input/output sub-system */
52 #define dbg_io(fmt, ...) ubi_dbg_msg("io", fmt, ##__VA_ARGS__)
53 /* Initialization and build messages */
54 #define dbg_bld(fmt, ...) ubi_dbg_msg("bld", fmt, ##__VA_ARGS__)
55
56 void ubi_dump_vol_info(const struct ubi_volume *vol);
57 void ubi_dump_vtbl_record(const struct ubi_vtbl_record *r, int idx);
58 void ubi_dump_av(const struct ubi_ainf_volume *av);
59 void ubi_dump_aeb(const struct ubi_ainf_peb *aeb, int type);
60 void ubi_dump_mkvol_req(const struct ubi_mkvol_req *req);
61 int ubi_self_check_all_ff(struct ubi_device *ubi, int pnum, int offset,
62 int len);
63 int ubi_debugfs_init(void);
64 void ubi_debugfs_exit(void);
65 int ubi_debugfs_init_dev(struct ubi_device *ubi);
66 void ubi_debugfs_exit_dev(struct ubi_device *ubi);
67
68 /**
69 * ubi_dbg_is_bgt_disabled - if the background thread is disabled.
70 * @ubi: UBI device description object
71 *
72 * Returns non-zero if the UBI background thread is disabled for testing
73 * purposes.
74 */
ubi_dbg_is_bgt_disabled(const struct ubi_device * ubi)75 static inline int ubi_dbg_is_bgt_disabled(const struct ubi_device *ubi)
76 {
77 return ubi->dbg.disable_bgt;
78 }
79
80 /**
81 * ubi_dbg_is_bitflip - if it is time to emulate a bit-flip.
82 * @ubi: UBI device description object
83 *
84 * Returns non-zero if a bit-flip should be emulated, otherwise returns zero.
85 */
ubi_dbg_is_bitflip(const struct ubi_device * ubi)86 static inline int ubi_dbg_is_bitflip(const struct ubi_device *ubi)
87 {
88 if (ubi->dbg.emulate_bitflips)
89 return !(prandom_u32() % 200);
90 return 0;
91 }
92
93 /**
94 * ubi_dbg_is_write_failure - if it is time to emulate a write failure.
95 * @ubi: UBI device description object
96 *
97 * Returns non-zero if a write failure should be emulated, otherwise returns
98 * zero.
99 */
ubi_dbg_is_write_failure(const struct ubi_device * ubi)100 static inline int ubi_dbg_is_write_failure(const struct ubi_device *ubi)
101 {
102 if (ubi->dbg.emulate_io_failures)
103 return !(prandom_u32() % 500);
104 return 0;
105 }
106
107 /**
108 * ubi_dbg_is_erase_failure - if its time to emulate an erase failure.
109 * @ubi: UBI device description object
110 *
111 * Returns non-zero if an erase failure should be emulated, otherwise returns
112 * zero.
113 */
ubi_dbg_is_erase_failure(const struct ubi_device * ubi)114 static inline int ubi_dbg_is_erase_failure(const struct ubi_device *ubi)
115 {
116 if (ubi->dbg.emulate_io_failures)
117 return !(prandom_u32() % 400);
118 return 0;
119 }
120
ubi_dbg_chk_io(const struct ubi_device * ubi)121 static inline int ubi_dbg_chk_io(const struct ubi_device *ubi)
122 {
123 return ubi->dbg.chk_io;
124 }
125
ubi_dbg_chk_gen(const struct ubi_device * ubi)126 static inline int ubi_dbg_chk_gen(const struct ubi_device *ubi)
127 {
128 return ubi->dbg.chk_gen;
129 }
130
ubi_dbg_chk_fastmap(const struct ubi_device * ubi)131 static inline int ubi_dbg_chk_fastmap(const struct ubi_device *ubi)
132 {
133 return ubi->dbg.chk_fastmap;
134 }
135
ubi_enable_dbg_chk_fastmap(struct ubi_device * ubi)136 static inline void ubi_enable_dbg_chk_fastmap(struct ubi_device *ubi)
137 {
138 ubi->dbg.chk_fastmap = 1;
139 }
140
141 int ubi_dbg_power_cut(struct ubi_device *ubi, int caller);
142 #endif /* !__UBI_DEBUG_H__ */
143
