2 * Copyright (c) International Business Machines Corp., 2006
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.
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.
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
18 * Author: Artem Bityutskiy (Битюцкий Артём)
22 * Here we keep all the UBI debugging stuff which should normally be disabled
23 * and compiled-out, but it is extremely helpful when hunting bugs or doing big
27 #ifdef CONFIG_MTD_UBI_DEBUG
30 #include <linux/module.h>
31 #include <linux/moduleparam.h>
33 unsigned int ubi_msg_flags;
35 module_param_named(debug_msgs, ubi_msg_flags, uint, S_IRUGO | S_IWUSR);
37 MODULE_PARM_DESC(debug_msgs, "Debug message type flags");
40 * ubi_dbg_dump_ec_hdr - dump an erase counter header.
41 * @ec_hdr: the erase counter header to dump
43 void ubi_dbg_dump_ec_hdr(const struct ubi_ec_hdr *ec_hdr)
45 printk(KERN_DEBUG "Erase counter header dump:\n");
46 printk(KERN_DEBUG "\tmagic %#08x\n",
47 be32_to_cpu(ec_hdr->magic));
48 printk(KERN_DEBUG "\tversion %d\n", (int)ec_hdr->version);
49 printk(KERN_DEBUG "\tec %llu\n",
50 (long long)be64_to_cpu(ec_hdr->ec));
51 printk(KERN_DEBUG "\tvid_hdr_offset %d\n",
52 be32_to_cpu(ec_hdr->vid_hdr_offset));
53 printk(KERN_DEBUG "\tdata_offset %d\n",
54 be32_to_cpu(ec_hdr->data_offset));
55 printk(KERN_DEBUG "\timage_seq %d\n",
56 be32_to_cpu(ec_hdr->image_seq));
57 printk(KERN_DEBUG "\thdr_crc %#08x\n",
58 be32_to_cpu(ec_hdr->hdr_crc));
59 printk(KERN_DEBUG "erase counter header hexdump:\n");
60 print_hex_dump(KERN_DEBUG, "", DUMP_PREFIX_OFFSET, 32, 1,
61 ec_hdr, UBI_EC_HDR_SIZE, 1);
65 * ubi_dbg_dump_vid_hdr - dump a volume identifier header.
66 * @vid_hdr: the volume identifier header to dump
68 void ubi_dbg_dump_vid_hdr(const struct ubi_vid_hdr *vid_hdr)
70 printk(KERN_DEBUG "Volume identifier header dump:\n");
71 printk(KERN_DEBUG "\tmagic %08x\n", be32_to_cpu(vid_hdr->magic));
72 printk(KERN_DEBUG "\tversion %d\n", (int)vid_hdr->version);
73 printk(KERN_DEBUG "\tvol_type %d\n", (int)vid_hdr->vol_type);
74 printk(KERN_DEBUG "\tcopy_flag %d\n", (int)vid_hdr->copy_flag);
75 printk(KERN_DEBUG "\tcompat %d\n", (int)vid_hdr->compat);
76 printk(KERN_DEBUG "\tvol_id %d\n", be32_to_cpu(vid_hdr->vol_id));
77 printk(KERN_DEBUG "\tlnum %d\n", be32_to_cpu(vid_hdr->lnum));
78 printk(KERN_DEBUG "\tdata_size %d\n", be32_to_cpu(vid_hdr->data_size));
79 printk(KERN_DEBUG "\tused_ebs %d\n", be32_to_cpu(vid_hdr->used_ebs));
80 printk(KERN_DEBUG "\tdata_pad %d\n", be32_to_cpu(vid_hdr->data_pad));
81 printk(KERN_DEBUG "\tsqnum %llu\n",
82 (unsigned long long)be64_to_cpu(vid_hdr->sqnum));
83 printk(KERN_DEBUG "\thdr_crc %08x\n", be32_to_cpu(vid_hdr->hdr_crc));
84 printk(KERN_DEBUG "Volume identifier header hexdump:\n");
85 print_hex_dump(KERN_DEBUG, "", DUMP_PREFIX_OFFSET, 32, 1,
86 vid_hdr, UBI_VID_HDR_SIZE, 1);
90 * ubi_dbg_dump_vol_info- dump volume information.
91 * @vol: UBI volume description object
93 void ubi_dbg_dump_vol_info(const struct ubi_volume *vol)
95 printk(KERN_DEBUG "Volume information dump:\n");
96 printk(KERN_DEBUG "\tvol_id %d\n", vol->vol_id);
97 printk(KERN_DEBUG "\treserved_pebs %d\n", vol->reserved_pebs);
98 printk(KERN_DEBUG "\talignment %d\n", vol->alignment);
99 printk(KERN_DEBUG "\tdata_pad %d\n", vol->data_pad);
100 printk(KERN_DEBUG "\tvol_type %d\n", vol->vol_type);
101 printk(KERN_DEBUG "\tname_len %d\n", vol->name_len);
102 printk(KERN_DEBUG "\tusable_leb_size %d\n", vol->usable_leb_size);
103 printk(KERN_DEBUG "\tused_ebs %d\n", vol->used_ebs);
104 printk(KERN_DEBUG "\tused_bytes %lld\n", vol->used_bytes);
105 printk(KERN_DEBUG "\tlast_eb_bytes %d\n", vol->last_eb_bytes);
106 printk(KERN_DEBUG "\tcorrupted %d\n", vol->corrupted);
107 printk(KERN_DEBUG "\tupd_marker %d\n", vol->upd_marker);
109 if (vol->name_len <= UBI_VOL_NAME_MAX &&
110 strnlen(vol->name, vol->name_len + 1) == vol->name_len) {
111 printk(KERN_DEBUG "\tname %s\n", vol->name);
113 printk(KERN_DEBUG "\t1st 5 characters of name: %c%c%c%c%c\n",
114 vol->name[0], vol->name[1], vol->name[2],
115 vol->name[3], vol->name[4]);
120 * ubi_dbg_dump_vtbl_record - dump a &struct ubi_vtbl_record object.
121 * @r: the object to dump
122 * @idx: volume table index
124 void ubi_dbg_dump_vtbl_record(const struct ubi_vtbl_record *r, int idx)
126 int name_len = be16_to_cpu(r->name_len);
128 printk(KERN_DEBUG "Volume table record %d dump:\n", idx);
129 printk(KERN_DEBUG "\treserved_pebs %d\n",
130 be32_to_cpu(r->reserved_pebs));
131 printk(KERN_DEBUG "\talignment %d\n", be32_to_cpu(r->alignment));
132 printk(KERN_DEBUG "\tdata_pad %d\n", be32_to_cpu(r->data_pad));
133 printk(KERN_DEBUG "\tvol_type %d\n", (int)r->vol_type);
134 printk(KERN_DEBUG "\tupd_marker %d\n", (int)r->upd_marker);
135 printk(KERN_DEBUG "\tname_len %d\n", name_len);
137 if (r->name[0] == '\0') {
138 printk(KERN_DEBUG "\tname NULL\n");
142 if (name_len <= UBI_VOL_NAME_MAX &&
143 strnlen(&r->name[0], name_len + 1) == name_len) {
144 printk(KERN_DEBUG "\tname %s\n", &r->name[0]);
146 printk(KERN_DEBUG "\t1st 5 characters of name: %c%c%c%c%c\n",
147 r->name[0], r->name[1], r->name[2], r->name[3],
150 printk(KERN_DEBUG "\tcrc %#08x\n", be32_to_cpu(r->crc));
154 * ubi_dbg_dump_sv - dump a &struct ubi_scan_volume object.
155 * @sv: the object to dump
157 void ubi_dbg_dump_sv(const struct ubi_scan_volume *sv)
159 printk(KERN_DEBUG "Volume scanning information dump:\n");
160 printk(KERN_DEBUG "\tvol_id %d\n", sv->vol_id);
161 printk(KERN_DEBUG "\thighest_lnum %d\n", sv->highest_lnum);
162 printk(KERN_DEBUG "\tleb_count %d\n", sv->leb_count);
163 printk(KERN_DEBUG "\tcompat %d\n", sv->compat);
164 printk(KERN_DEBUG "\tvol_type %d\n", sv->vol_type);
165 printk(KERN_DEBUG "\tused_ebs %d\n", sv->used_ebs);
166 printk(KERN_DEBUG "\tlast_data_size %d\n", sv->last_data_size);
167 printk(KERN_DEBUG "\tdata_pad %d\n", sv->data_pad);
171 * ubi_dbg_dump_seb - dump a &struct ubi_scan_leb object.
172 * @seb: the object to dump
173 * @type: object type: 0 - not corrupted, 1 - corrupted
175 void ubi_dbg_dump_seb(const struct ubi_scan_leb *seb, int type)
177 printk(KERN_DEBUG "eraseblock scanning information dump:\n");
178 printk(KERN_DEBUG "\tec %d\n", seb->ec);
179 printk(KERN_DEBUG "\tpnum %d\n", seb->pnum);
181 printk(KERN_DEBUG "\tlnum %d\n", seb->lnum);
182 printk(KERN_DEBUG "\tscrub %d\n", seb->scrub);
183 printk(KERN_DEBUG "\tsqnum %llu\n", seb->sqnum);
188 * ubi_dbg_dump_mkvol_req - dump a &struct ubi_mkvol_req object.
189 * @req: the object to dump
191 void ubi_dbg_dump_mkvol_req(const struct ubi_mkvol_req *req)
195 printk(KERN_DEBUG "Volume creation request dump:\n");
196 printk(KERN_DEBUG "\tvol_id %d\n", req->vol_id);
197 printk(KERN_DEBUG "\talignment %d\n", req->alignment);
198 printk(KERN_DEBUG "\tbytes %lld\n", (long long)req->bytes);
199 printk(KERN_DEBUG "\tvol_type %d\n", req->vol_type);
200 printk(KERN_DEBUG "\tname_len %d\n", req->name_len);
202 memcpy(nm, req->name, 16);
204 printk(KERN_DEBUG "\t1st 16 characters of name: %s\n", nm);
208 * ubi_dbg_dump_flash - dump a region of flash.
209 * @ubi: UBI device description object
210 * @pnum: the physical eraseblock number to dump
211 * @offset: the starting offset within the physical eraseblock to dump
212 * @len: the length of the region to dump
214 void ubi_dbg_dump_flash(struct ubi_device *ubi, int pnum, int offset, int len)
219 loff_t addr = (loff_t)pnum * ubi->peb_size + offset;
224 err = ubi->mtd->read(ubi->mtd, addr, len, &read, buf);
225 if (err && err != -EUCLEAN) {
226 ubi_err("error %d while reading %d bytes from PEB %d:%d, "
227 "read %zd bytes", err, len, pnum, offset, read);
231 dbg_msg("dumping %d bytes of data from PEB %d, offset %d",
233 print_hex_dump(KERN_DEBUG, "", DUMP_PREFIX_OFFSET, 32, 1, buf, len, 1);
239 #endif /* CONFIG_MTD_UBI_DEBUG */