drivers/mtd/ubi/debug.c

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