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