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