Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
tjh.dev
kernel
os
linux
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/*
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
24 * changes.
25 */
26
27#ifdef CONFIG_MTD_UBI_DEBUG
28
29#include "ubi.h"
30#include <linux/module.h>
31#include <linux/moduleparam.h>
32
33unsigned int ubi_chk_flags;
34unsigned int ubi_tst_flags;
35
36module_param_named(debug_chks, ubi_chk_flags, uint, S_IRUGO | S_IWUSR);
37module_param_named(debug_tsts, ubi_chk_flags, uint, S_IRUGO | S_IWUSR);
38
39MODULE_PARM_DESC(debug_chks, "Debug check flags");
40MODULE_PARM_DESC(debug_tsts, "Debug special test flags");
41
42/**
43 * ubi_dbg_dump_ec_hdr - dump an erase counter header.
44 * @ec_hdr: the erase counter header to dump
45 */
46void ubi_dbg_dump_ec_hdr(const struct ubi_ec_hdr *ec_hdr)
47{
48 printk(KERN_DEBUG "Erase counter header dump:\n");
49 printk(KERN_DEBUG "\tmagic %#08x\n",
50 be32_to_cpu(ec_hdr->magic));
51 printk(KERN_DEBUG "\tversion %d\n", (int)ec_hdr->version);
52 printk(KERN_DEBUG "\tec %llu\n",
53 (long long)be64_to_cpu(ec_hdr->ec));
54 printk(KERN_DEBUG "\tvid_hdr_offset %d\n",
55 be32_to_cpu(ec_hdr->vid_hdr_offset));
56 printk(KERN_DEBUG "\tdata_offset %d\n",
57 be32_to_cpu(ec_hdr->data_offset));
58 printk(KERN_DEBUG "\timage_seq %d\n",
59 be32_to_cpu(ec_hdr->image_seq));
60 printk(KERN_DEBUG "\thdr_crc %#08x\n",
61 be32_to_cpu(ec_hdr->hdr_crc));
62 printk(KERN_DEBUG "erase counter header hexdump:\n");
63 print_hex_dump(KERN_DEBUG, "", DUMP_PREFIX_OFFSET, 32, 1,
64 ec_hdr, UBI_EC_HDR_SIZE, 1);
65}
66
67/**
68 * ubi_dbg_dump_vid_hdr - dump a volume identifier header.
69 * @vid_hdr: the volume identifier header to dump
70 */
71void ubi_dbg_dump_vid_hdr(const struct ubi_vid_hdr *vid_hdr)
72{
73 printk(KERN_DEBUG "Volume identifier header dump:\n");
74 printk(KERN_DEBUG "\tmagic %08x\n", be32_to_cpu(vid_hdr->magic));
75 printk(KERN_DEBUG "\tversion %d\n", (int)vid_hdr->version);
76 printk(KERN_DEBUG "\tvol_type %d\n", (int)vid_hdr->vol_type);
77 printk(KERN_DEBUG "\tcopy_flag %d\n", (int)vid_hdr->copy_flag);
78 printk(KERN_DEBUG "\tcompat %d\n", (int)vid_hdr->compat);
79 printk(KERN_DEBUG "\tvol_id %d\n", be32_to_cpu(vid_hdr->vol_id));
80 printk(KERN_DEBUG "\tlnum %d\n", be32_to_cpu(vid_hdr->lnum));
81 printk(KERN_DEBUG "\tdata_size %d\n", be32_to_cpu(vid_hdr->data_size));
82 printk(KERN_DEBUG "\tused_ebs %d\n", be32_to_cpu(vid_hdr->used_ebs));
83 printk(KERN_DEBUG "\tdata_pad %d\n", be32_to_cpu(vid_hdr->data_pad));
84 printk(KERN_DEBUG "\tsqnum %llu\n",
85 (unsigned long long)be64_to_cpu(vid_hdr->sqnum));
86 printk(KERN_DEBUG "\thdr_crc %08x\n", be32_to_cpu(vid_hdr->hdr_crc));
87 printk(KERN_DEBUG "Volume identifier header hexdump:\n");
88 print_hex_dump(KERN_DEBUG, "", DUMP_PREFIX_OFFSET, 32, 1,
89 vid_hdr, UBI_VID_HDR_SIZE, 1);
90}
91
92/**
93 * ubi_dbg_dump_vol_info- dump volume information.
94 * @vol: UBI volume description object
95 */
96void ubi_dbg_dump_vol_info(const struct ubi_volume *vol)
97{
98 printk(KERN_DEBUG "Volume information dump:\n");
99 printk(KERN_DEBUG "\tvol_id %d\n", vol->vol_id);
100 printk(KERN_DEBUG "\treserved_pebs %d\n", vol->reserved_pebs);
101 printk(KERN_DEBUG "\talignment %d\n", vol->alignment);
102 printk(KERN_DEBUG "\tdata_pad %d\n", vol->data_pad);
103 printk(KERN_DEBUG "\tvol_type %d\n", vol->vol_type);
104 printk(KERN_DEBUG "\tname_len %d\n", vol->name_len);
105 printk(KERN_DEBUG "\tusable_leb_size %d\n", vol->usable_leb_size);
106 printk(KERN_DEBUG "\tused_ebs %d\n", vol->used_ebs);
107 printk(KERN_DEBUG "\tused_bytes %lld\n", vol->used_bytes);
108 printk(KERN_DEBUG "\tlast_eb_bytes %d\n", vol->last_eb_bytes);
109 printk(KERN_DEBUG "\tcorrupted %d\n", vol->corrupted);
110 printk(KERN_DEBUG "\tupd_marker %d\n", vol->upd_marker);
111
112 if (vol->name_len <= UBI_VOL_NAME_MAX &&
113 strnlen(vol->name, vol->name_len + 1) == vol->name_len) {
114 printk(KERN_DEBUG "\tname %s\n", vol->name);
115 } else {
116 printk(KERN_DEBUG "\t1st 5 characters of name: %c%c%c%c%c\n",
117 vol->name[0], vol->name[1], vol->name[2],
118 vol->name[3], vol->name[4]);
119 }
120}
121
122/**
123 * ubi_dbg_dump_vtbl_record - dump a &struct ubi_vtbl_record object.
124 * @r: the object to dump
125 * @idx: volume table index
126 */
127void ubi_dbg_dump_vtbl_record(const struct ubi_vtbl_record *r, int idx)
128{
129 int name_len = be16_to_cpu(r->name_len);
130
131 printk(KERN_DEBUG "Volume table record %d dump:\n", idx);
132 printk(KERN_DEBUG "\treserved_pebs %d\n",
133 be32_to_cpu(r->reserved_pebs));
134 printk(KERN_DEBUG "\talignment %d\n", be32_to_cpu(r->alignment));
135 printk(KERN_DEBUG "\tdata_pad %d\n", be32_to_cpu(r->data_pad));
136 printk(KERN_DEBUG "\tvol_type %d\n", (int)r->vol_type);
137 printk(KERN_DEBUG "\tupd_marker %d\n", (int)r->upd_marker);
138 printk(KERN_DEBUG "\tname_len %d\n", name_len);
139
140 if (r->name[0] == '\0') {
141 printk(KERN_DEBUG "\tname NULL\n");
142 return;
143 }
144
145 if (name_len <= UBI_VOL_NAME_MAX &&
146 strnlen(&r->name[0], name_len + 1) == name_len) {
147 printk(KERN_DEBUG "\tname %s\n", &r->name[0]);
148 } else {
149 printk(KERN_DEBUG "\t1st 5 characters of name: %c%c%c%c%c\n",
150 r->name[0], r->name[1], r->name[2], r->name[3],
151 r->name[4]);
152 }
153 printk(KERN_DEBUG "\tcrc %#08x\n", be32_to_cpu(r->crc));
154}
155
156/**
157 * ubi_dbg_dump_sv - dump a &struct ubi_scan_volume object.
158 * @sv: the object to dump
159 */
160void ubi_dbg_dump_sv(const struct ubi_scan_volume *sv)
161{
162 printk(KERN_DEBUG "Volume scanning information dump:\n");
163 printk(KERN_DEBUG "\tvol_id %d\n", sv->vol_id);
164 printk(KERN_DEBUG "\thighest_lnum %d\n", sv->highest_lnum);
165 printk(KERN_DEBUG "\tleb_count %d\n", sv->leb_count);
166 printk(KERN_DEBUG "\tcompat %d\n", sv->compat);
167 printk(KERN_DEBUG "\tvol_type %d\n", sv->vol_type);
168 printk(KERN_DEBUG "\tused_ebs %d\n", sv->used_ebs);
169 printk(KERN_DEBUG "\tlast_data_size %d\n", sv->last_data_size);
170 printk(KERN_DEBUG "\tdata_pad %d\n", sv->data_pad);
171}
172
173/**
174 * ubi_dbg_dump_seb - dump a &struct ubi_scan_leb object.
175 * @seb: the object to dump
176 * @type: object type: 0 - not corrupted, 1 - corrupted
177 */
178void ubi_dbg_dump_seb(const struct ubi_scan_leb *seb, int type)
179{
180 printk(KERN_DEBUG "eraseblock scanning information dump:\n");
181 printk(KERN_DEBUG "\tec %d\n", seb->ec);
182 printk(KERN_DEBUG "\tpnum %d\n", seb->pnum);
183 if (type == 0) {
184 printk(KERN_DEBUG "\tlnum %d\n", seb->lnum);
185 printk(KERN_DEBUG "\tscrub %d\n", seb->scrub);
186 printk(KERN_DEBUG "\tsqnum %llu\n", seb->sqnum);
187 }
188}
189
190/**
191 * ubi_dbg_dump_mkvol_req - dump a &struct ubi_mkvol_req object.
192 * @req: the object to dump
193 */
194void ubi_dbg_dump_mkvol_req(const struct ubi_mkvol_req *req)
195{
196 char nm[17];
197
198 printk(KERN_DEBUG "Volume creation request dump:\n");
199 printk(KERN_DEBUG "\tvol_id %d\n", req->vol_id);
200 printk(KERN_DEBUG "\talignment %d\n", req->alignment);
201 printk(KERN_DEBUG "\tbytes %lld\n", (long long)req->bytes);
202 printk(KERN_DEBUG "\tvol_type %d\n", req->vol_type);
203 printk(KERN_DEBUG "\tname_len %d\n", req->name_len);
204
205 memcpy(nm, req->name, 16);
206 nm[16] = 0;
207 printk(KERN_DEBUG "\t1st 16 characters of name: %s\n", nm);
208}
209
210/**
211 * ubi_dbg_dump_flash - dump a region of flash.
212 * @ubi: UBI device description object
213 * @pnum: the physical eraseblock number to dump
214 * @offset: the starting offset within the physical eraseblock to dump
215 * @len: the length of the region to dump
216 */
217void ubi_dbg_dump_flash(struct ubi_device *ubi, int pnum, int offset, int len)
218{
219 int err;
220 size_t read;
221 void *buf;
222 loff_t addr = (loff_t)pnum * ubi->peb_size + offset;
223
224 buf = vmalloc(len);
225 if (!buf)
226 return;
227 err = ubi->mtd->read(ubi->mtd, addr, len, &read, buf);
228 if (err && err != -EUCLEAN) {
229 ubi_err("error %d while reading %d bytes from PEB %d:%d, "
230 "read %zd bytes", err, len, pnum, offset, read);
231 goto out;
232 }
233
234 dbg_msg("dumping %d bytes of data from PEB %d, offset %d",
235 len, pnum, offset);
236 print_hex_dump(KERN_DEBUG, "", DUMP_PREFIX_OFFSET, 32, 1, buf, len, 1);
237out:
238 vfree(buf);
239 return;
240}
241
242#endif /* CONFIG_MTD_UBI_DEBUG */