err.no Git - linux-2.6/blob - drivers/mtd/ubi/upd.c

   1 /*
   2  * Copyright (c) International Business Machines Corp., 2006
   3  * Copyright (c) Nokia Corporation, 2006
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See
  13  * the GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program; if not, write to the Free Software
  17  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  18  *
  19  * Author: Artem Bityutskiy (Битюцкий Артём)
  20  *
  21  * Jan 2007: Alexander Schmidt, hacked per-volume update.
  22  */
  23
  24 /*
  25  * This file contains implementation of the volume update functionality.
  26  *
  27  * The update operation is based on the per-volume update marker which is
  28  * stored in the volume table. The update marker is set before the update
  29  * starts, and removed after the update has been finished. So if the update was
  30  * interrupted by an unclean re-boot or due to some other reasons, the update
  31  * marker stays on the flash media and UBI finds it when it attaches the MTD
  32  * device next time. If the update marker is set for a volume, the volume is
  33  * treated as damaged and most I/O operations are prohibited. Only a new update
  34  * operation is allowed.
  35  *
  36  * Note, in general it is possible to implement the update operation as a
  37  * transaction with a roll-back capability.
  38  */
  39
  40 #include <linux/err.h>
  41 #include <asm/uaccess.h>
  42 #include <asm/div64.h>
  43 #include "ubi.h"
  44
  45 /**
  46  * set_update_marker - set update marker.
  47  * @ubi: UBI device description object
  48  * @vol_id: volume ID
  49  *
  50  * This function sets the update marker flag for volume @vol_id. Returns zero
  51  * in case of success and a negative error code in case of failure.
  52  */
  53 static int set_update_marker(struct ubi_device *ubi, int vol_id)
  54 {
  55         int err;
  56         struct ubi_vtbl_record vtbl_rec;
  57         struct ubi_volume *vol = ubi->volumes[vol_id];
  58
  59         dbg_msg("set update marker for volume %d", vol_id);
  60
  61         if (vol->upd_marker) {
  62                 ubi_assert(ubi->vtbl[vol_id].upd_marker);
  63                 dbg_msg("already set");
  64                 return 0;
  65         }
  66
  67         memcpy(&vtbl_rec, &ubi->vtbl[vol_id], sizeof(struct ubi_vtbl_record));
  68         vtbl_rec.upd_marker = 1;
  69
  70         mutex_lock(&ubi->volumes_mutex);
  71         err = ubi_change_vtbl_record(ubi, vol_id, &vtbl_rec);
  72         mutex_unlock(&ubi->volumes_mutex);
  73         vol->upd_marker = 1;
  74         return err;
  75 }
  76
  77 /**
  78  * clear_update_marker - clear update marker.
  79  * @ubi: UBI device description object
  80  * @vol_id: volume ID
  81  * @bytes: new data size in bytes
  82  *
  83  * This function clears the update marker for volume @vol_id, sets new volume
  84  * data size and clears the "corrupted" flag (static volumes only). Returns
  85  * zero in case of success and a negative error code in case of failure.
  86  */
  87 static int clear_update_marker(struct ubi_device *ubi, int vol_id, long long bytes)
  88 {
  89         int err;
  90         uint64_t tmp;
  91         struct ubi_vtbl_record vtbl_rec;
  92         struct ubi_volume *vol = ubi->volumes[vol_id];
  93
  94         dbg_msg("clear update marker for volume %d", vol_id);
  95
  96         memcpy(&vtbl_rec, &ubi->vtbl[vol_id], sizeof(struct ubi_vtbl_record));
  97         ubi_assert(vol->upd_marker && vtbl_rec.upd_marker);
  98         vtbl_rec.upd_marker = 0;
  99
 100         if (vol->vol_type == UBI_STATIC_VOLUME) {
 101                 vol->corrupted = 0;
 102                 vol->used_bytes = tmp = bytes;
 103                 vol->last_eb_bytes = do_div(tmp, vol->usable_leb_size);
 104                 vol->used_ebs = tmp;
 105                 if (vol->last_eb_bytes)
 106                         vol->used_ebs += 1;
 107                 else
 108                         vol->last_eb_bytes = vol->usable_leb_size;
 109         }
 110
 111         mutex_lock(&ubi->volumes_mutex);
 112         err = ubi_change_vtbl_record(ubi, vol_id, &vtbl_rec);
 113         mutex_unlock(&ubi->volumes_mutex);
 114         vol->upd_marker = 0;
 115         return err;
 116 }
 117
 118 /**
 119  * ubi_start_update - start volume update.
 120  * @ubi: UBI device description object
 121  * @vol_id: volume ID
 122  * @bytes: update bytes
 123  *
 124  * This function starts volume update operation. If @bytes is zero, the volume
 125  * is just wiped out. Returns zero in case of success and a negative error code
 126  * in case of failure.
 127  */
 128 int ubi_start_update(struct ubi_device *ubi, int vol_id, long long bytes)
 129 {
 130         int i, err;
 131         uint64_t tmp;
 132         struct ubi_volume *vol = ubi->volumes[vol_id];
 133
 134         dbg_msg("start update of volume %d, %llu bytes", vol_id, bytes);
 135         vol->updating = 1;
 136
 137         err = set_update_marker(ubi, vol_id);
 138         if (err)
 139                 return err;
 140
 141         /* Before updating - wipe out the volume */
 142         for (i = 0; i < vol->reserved_pebs; i++) {
 143                 err = ubi_eba_unmap_leb(ubi, vol, i);
 144                 if (err)
 145                         return err;
 146         }
 147
 148         if (bytes == 0) {
 149                 err = clear_update_marker(ubi, vol_id, 0);
 150                 if (err)
 151                         return err;
 152                 err = ubi_wl_flush(ubi);
 153                 if (!err)
 154                         vol->updating = 0;
 155         }
 156
 157         vol->upd_buf = vmalloc(ubi->leb_size);
 158         if (!vol->upd_buf)
 159                 return -ENOMEM;
 160
 161         tmp = bytes;
 162         vol->upd_ebs = !!do_div(tmp, vol->usable_leb_size);
 163         vol->upd_ebs += tmp;
 164         vol->upd_bytes = bytes;
 165         vol->upd_received = 0;
 166         return 0;
 167 }
 168
 169 /**
 170  * write_leb - write update data.
 171  * @ubi: UBI device description object
 172  * @vol_id: volume ID
 173  * @lnum: logical eraseblock number
 174  * @buf: data to write
 175  * @len: data size
 176  * @used_ebs: how many logical eraseblocks will this volume contain (static
 177  * volumes only)
 178  *
 179  * This function writes update data to corresponding logical eraseblock. In
 180  * case of dynamic volume, this function checks if the data contains 0xFF bytes
 181  * at the end. If yes, the 0xFF bytes are cut and not written. So if the whole
 182  * buffer contains only 0xFF bytes, the LEB is left unmapped.
 183  *
 184  * The reason why we skip the trailing 0xFF bytes in case of dynamic volume is
 185  * that we want to make sure that more data may be appended to the logical
 186  * eraseblock in future. Indeed, writing 0xFF bytes may have side effects and
 187  * this PEB won't be writable anymore. So if one writes the file-system image
 188  * to the UBI volume where 0xFFs mean free space - UBI makes sure this free
 189  * space is writable after the update.
 190  *
 191  * We do not do this for static volumes because they are read-only. But this
 192  * also cannot be done because we have to store per-LEB CRC and the correct
 193  * data length.
 194  *
 195  * This function returns zero in case of success and a negative error code in
 196  * case of failure.
 197  */
 198 static int write_leb(struct ubi_device *ubi, int vol_id, int lnum, void *buf,
 199                      int len, int used_ebs)
 200 {
 201         int err, l;
 202         struct ubi_volume *vol = ubi->volumes[vol_id];
 203
 204         if (vol->vol_type == UBI_DYNAMIC_VOLUME) {
 205                 l = ALIGN(len, ubi->min_io_size);
 206                 memset(buf + len, 0xFF, l - len);
 207
 208                 l = ubi_calc_data_len(ubi, buf, l);
 209                 if (l == 0) {
 210                         dbg_msg("all %d bytes contain 0xFF - skip", len);
 211                         return 0;
 212                 }
 213                 if (len != l)
 214                         dbg_msg("skip last %d bytes (0xFF)", len - l);
 215
 216                 err = ubi_eba_write_leb(ubi, vol, lnum, buf, 0, l, UBI_UNKNOWN);
 217         } else {
 218                 /*
 219                  * When writing static volume, and this is the last logical
 220                  * eraseblock, the length (@len) does not have to be aligned to
 221                  * the minimal flash I/O unit. The 'ubi_eba_write_leb_st()'
 222                  * function accepts exact (unaligned) length and stores it in
 223                  * the VID header. And it takes care of proper alignment by
 224                  * padding the buffer. Here we just make sure the padding will
 225                  * contain zeros, not random trash.
 226                  */
 227                 memset(buf + len, 0, vol->usable_leb_size - len);
 228                 err = ubi_eba_write_leb_st(ubi, vol, lnum, buf, len,
 229                                            UBI_UNKNOWN, used_ebs);
 230         }
 231
 232         return err;
 233 }
 234
 235 /**
 236  * ubi_more_update_data - write more update data.
 237  * @vol: volume description object
 238  * @buf: write data (user-space memory buffer)
 239  * @count: how much bytes to write
 240  *
 241  * This function writes more data to the volume which is being updated. It may
 242  * be called arbitrary number of times until all of the update data arrive.
 243  * This function returns %0 in case of success, number of bytes written during
 244  * the last call if the whole volume update was successfully finished, and a
 245  * negative error code in case of failure.
 246  */
 247 int ubi_more_update_data(struct ubi_device *ubi, int vol_id,
 248                          const void __user *buf, int count)
 249 {
 250         uint64_t tmp;
 251         struct ubi_volume *vol = ubi->volumes[vol_id];
 252         int lnum, offs, err = 0, len, to_write = count;
 253
 254         dbg_msg("write %d of %lld bytes, %lld already passed",
 255                 count, vol->upd_bytes, vol->upd_received);
 256
 257         if (ubi->ro_mode)
 258                 return -EROFS;
 259
 260         tmp = vol->upd_received;
 261         offs = do_div(tmp, vol->usable_leb_size);
 262         lnum = tmp;
 263
 264         if (vol->upd_received + count > vol->upd_bytes)
 265                 to_write = count = vol->upd_bytes - vol->upd_received;
 266
 267         /*
 268          * When updating volumes, we accumulate whole logical eraseblock of
 269          * data and write it at once.
 270          */
 271         if (offs != 0) {
 272                 /*
 273                  * This is a write to the middle of the logical eraseblock. We
 274                  * copy the data to our update buffer and wait for more data or
 275                  * flush it if the whole eraseblock is written or the update
 276                  * is finished.
 277                  */
 278
 279                 len = vol->usable_leb_size - offs;
 280                 if (len > count)
 281                         len = count;
 282
 283                 err = copy_from_user(vol->upd_buf + offs, buf, len);
 284                 if (err)
 285                         return -EFAULT;
 286
 287                 if (offs + len == vol->usable_leb_size ||
 288                     vol->upd_received + len == vol->upd_bytes) {
 289                         int flush_len = offs + len;
 290
 291                         /*
 292                          * OK, we gathered either the whole eraseblock or this
 293                          * is the last chunk, it's time to flush the buffer.
 294                          */
 295                         ubi_assert(flush_len <= vol->usable_leb_size);
 296                         err = write_leb(ubi, vol_id, lnum, vol->upd_buf,
 297                                         flush_len, vol->upd_ebs);
 298                         if (err)
 299                                 return err;
 300                 }
 301
 302                 vol->upd_received += len;
 303                 count -= len;
 304                 buf += len;
 305                 lnum += 1;
 306         }
 307
 308         /*
 309          * If we've got more to write, let's continue. At this point we know we
 310          * are starting from the beginning of an eraseblock.
 311          */
 312         while (count) {
 313                 if (count > vol->usable_leb_size)
 314                         len = vol->usable_leb_size;
 315                 else
 316                         len = count;
 317
 318                 err = copy_from_user(vol->upd_buf, buf, len);
 319                 if (err)
 320                         return -EFAULT;
 321
 322                 if (len == vol->usable_leb_size ||
 323                     vol->upd_received + len == vol->upd_bytes) {
 324                         err = write_leb(ubi, vol_id, lnum, vol->upd_buf, len,
 325                                         vol->upd_ebs);
 326                         if (err)
 327                                 break;
 328                 }
 329
 330                 vol->upd_received += len;
 331                 count -= len;
 332                 lnum += 1;
 333                 buf += len;
 334         }
 335
 336         ubi_assert(vol->upd_received <= vol->upd_bytes);
 337         if (vol->upd_received == vol->upd_bytes) {
 338                 /* The update is finished, clear the update marker */
 339                 err = clear_update_marker(ubi, vol_id, vol->upd_bytes);
 340                 if (err)
 341                         return err;
 342                 err = ubi_wl_flush(ubi);
 343                 if (err == 0) {
 344                         err = to_write;
 345                         vfree(vol->upd_buf);
 346                         vol->updating = 0;
 347                 }
 348         }
 349
 350         return err;
 351 }