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 (Битюцкий Артём)
21 /* This file mostly implements UBI kernel API functions */
23 #include <linux/module.h>
24 #include <linux/err.h>
25 #include <asm/div64.h>
29 * ubi_get_device_info - get information about UBI device.
30 * @ubi_num: UBI device number
31 * @di: the information is stored here
33 * This function returns %0 in case of success, %-EINVAL if the UBI device
34 * number is invalid, and %-ENODEV if there is no such UBI device.
36 int ubi_get_device_info(int ubi_num, struct ubi_device_info *di)
38 struct ubi_device *ubi;
40 if (ubi_num < 0 || ubi_num >= UBI_MAX_DEVICES)
43 ubi = ubi_get_device(ubi_num);
47 di->ubi_num = ubi->ubi_num;
48 di->leb_size = ubi->leb_size;
49 di->min_io_size = ubi->min_io_size;
50 di->ro_mode = ubi->ro_mode;
51 di->cdev = ubi->cdev.dev;
56 EXPORT_SYMBOL_GPL(ubi_get_device_info);
59 * ubi_get_volume_info - get information about UBI volume.
60 * @desc: volume descriptor
61 * @vi: the information is stored here
63 void ubi_get_volume_info(struct ubi_volume_desc *desc,
64 struct ubi_volume_info *vi)
66 const struct ubi_volume *vol = desc->vol;
67 const struct ubi_device *ubi = vol->ubi;
69 vi->vol_id = vol->vol_id;
70 vi->ubi_num = ubi->ubi_num;
71 vi->size = vol->reserved_pebs;
72 vi->used_bytes = vol->used_bytes;
73 vi->vol_type = vol->vol_type;
74 vi->corrupted = vol->corrupted;
75 vi->upd_marker = vol->upd_marker;
76 vi->alignment = vol->alignment;
77 vi->usable_leb_size = vol->usable_leb_size;
78 vi->name_len = vol->name_len;
80 vi->cdev = vol->cdev.dev;
82 EXPORT_SYMBOL_GPL(ubi_get_volume_info);
85 * ubi_open_volume - open UBI volume.
86 * @ubi_num: UBI device number
90 * The @mode parameter specifies if the volume should be opened in read-only
91 * mode, read-write mode, or exclusive mode. The exclusive mode guarantees that
92 * nobody else will be able to open this volume. UBI allows to have many volume
93 * readers and one writer at a time.
95 * If a static volume is being opened for the first time since boot, it will be
96 * checked by this function, which means it will be fully read and the CRC
97 * checksum of each logical eraseblock will be checked.
99 * This function returns volume descriptor in case of success and a negative
100 * error code in case of failure.
102 struct ubi_volume_desc *ubi_open_volume(int ubi_num, int vol_id, int mode)
105 struct ubi_volume_desc *desc;
106 struct ubi_device *ubi;
107 struct ubi_volume *vol;
109 dbg_gen("open device %d, volume %d, mode %d", ubi_num, vol_id, mode);
111 if (ubi_num < 0 || ubi_num >= UBI_MAX_DEVICES)
112 return ERR_PTR(-EINVAL);
114 if (mode != UBI_READONLY && mode != UBI_READWRITE &&
115 mode != UBI_EXCLUSIVE)
116 return ERR_PTR(-EINVAL);
119 * First of all, we have to get the UBI device to prevent its removal.
121 ubi = ubi_get_device(ubi_num);
123 return ERR_PTR(-ENODEV);
125 if (vol_id < 0 || vol_id >= ubi->vtbl_slots) {
130 desc = kmalloc(sizeof(struct ubi_volume_desc), GFP_KERNEL);
137 if (!try_module_get(THIS_MODULE))
140 spin_lock(&ubi->volumes_lock);
141 vol = ubi->volumes[vol_id];
154 if (vol->exclusive || vol->writers > 0)
160 if (vol->exclusive || vol->writers || vol->readers)
165 get_device(&vol->dev);
167 spin_unlock(&ubi->volumes_lock);
172 mutex_lock(&ubi->ckvol_mutex);
174 /* This is the first open - check the volume */
175 err = ubi_check_volume(ubi, vol_id);
177 mutex_unlock(&ubi->ckvol_mutex);
178 ubi_close_volume(desc);
182 ubi_warn("volume %d on UBI device %d is corrupted",
183 vol_id, ubi->ubi_num);
188 mutex_unlock(&ubi->ckvol_mutex);
193 spin_unlock(&ubi->volumes_lock);
194 module_put(THIS_MODULE);
199 dbg_err("cannot open device %d, volume %d, error %d",
200 ubi_num, vol_id, err);
203 EXPORT_SYMBOL_GPL(ubi_open_volume);
206 * ubi_open_volume_nm - open UBI volume by name.
207 * @ubi_num: UBI device number
211 * This function is similar to 'ubi_open_volume()', but opens a volume by name.
213 struct ubi_volume_desc *ubi_open_volume_nm(int ubi_num, const char *name,
216 int i, vol_id = -1, len;
217 struct ubi_device *ubi;
218 struct ubi_volume_desc *ret;
220 dbg_gen("open device %d, volume %s, mode %d", ubi_num, name, mode);
223 return ERR_PTR(-EINVAL);
225 len = strnlen(name, UBI_VOL_NAME_MAX + 1);
226 if (len > UBI_VOL_NAME_MAX)
227 return ERR_PTR(-EINVAL);
229 if (ubi_num < 0 || ubi_num >= UBI_MAX_DEVICES)
230 return ERR_PTR(-EINVAL);
232 ubi = ubi_get_device(ubi_num);
234 return ERR_PTR(-ENODEV);
236 spin_lock(&ubi->volumes_lock);
237 /* Walk all volumes of this UBI device */
238 for (i = 0; i < ubi->vtbl_slots; i++) {
239 struct ubi_volume *vol = ubi->volumes[i];
241 if (vol && len == vol->name_len && !strcmp(name, vol->name)) {
246 spin_unlock(&ubi->volumes_lock);
249 ret = ubi_open_volume(ubi_num, vol_id, mode);
251 ret = ERR_PTR(-ENODEV);
254 * We should put the UBI device even in case of success, because
255 * 'ubi_open_volume()' took a reference as well.
260 EXPORT_SYMBOL_GPL(ubi_open_volume_nm);
263 * ubi_close_volume - close UBI volume.
264 * @desc: volume descriptor
266 void ubi_close_volume(struct ubi_volume_desc *desc)
268 struct ubi_volume *vol = desc->vol;
269 struct ubi_device *ubi = vol->ubi;
271 dbg_gen("close device %d, volume %d, mode %d",
272 ubi->ubi_num, vol->vol_id, desc->mode);
274 spin_lock(&ubi->volumes_lock);
275 switch (desc->mode) {
286 spin_unlock(&ubi->volumes_lock);
289 put_device(&vol->dev);
291 module_put(THIS_MODULE);
293 EXPORT_SYMBOL_GPL(ubi_close_volume);
296 * ubi_leb_read - read data.
297 * @desc: volume descriptor
298 * @lnum: logical eraseblock number to read from
299 * @buf: buffer where to store the read data
300 * @offset: offset within the logical eraseblock to read from
301 * @len: how many bytes to read
302 * @check: whether UBI has to check the read data's CRC or not.
304 * This function reads data from offset @offset of logical eraseblock @lnum and
305 * stores the data at @buf. When reading from static volumes, @check specifies
306 * whether the data has to be checked or not. If yes, the whole logical
307 * eraseblock will be read and its CRC checksum will be checked (i.e., the CRC
308 * checksum is per-eraseblock). So checking may substantially slow down the
309 * read speed. The @check argument is ignored for dynamic volumes.
311 * In case of success, this function returns zero. In case of failure, this
312 * function returns a negative error code.
314 * %-EBADMSG error code is returned:
315 * o for both static and dynamic volumes if MTD driver has detected a data
316 * integrity problem (unrecoverable ECC checksum mismatch in case of NAND);
317 * o for static volumes in case of data CRC mismatch.
319 * If the volume is damaged because of an interrupted update this function just
320 * returns immediately with %-EBADF error code.
322 int ubi_leb_read(struct ubi_volume_desc *desc, int lnum, char *buf, int offset,
325 struct ubi_volume *vol = desc->vol;
326 struct ubi_device *ubi = vol->ubi;
327 int err, vol_id = vol->vol_id;
329 dbg_gen("read %d bytes from LEB %d:%d:%d", len, vol_id, lnum, offset);
331 if (vol_id < 0 || vol_id >= ubi->vtbl_slots || lnum < 0 ||
332 lnum >= vol->used_ebs || offset < 0 || len < 0 ||
333 offset + len > vol->usable_leb_size)
336 if (vol->vol_type == UBI_STATIC_VOLUME) {
337 if (vol->used_ebs == 0)
338 /* Empty static UBI volume */
340 if (lnum == vol->used_ebs - 1 &&
341 offset + len > vol->last_eb_bytes)
350 err = ubi_eba_read_leb(ubi, vol, lnum, buf, offset, len, check);
351 if (err && err == -EBADMSG && vol->vol_type == UBI_STATIC_VOLUME) {
352 ubi_warn("mark volume %d as corrupted", vol_id);
358 EXPORT_SYMBOL_GPL(ubi_leb_read);
361 * ubi_leb_write - write data.
362 * @desc: volume descriptor
363 * @lnum: logical eraseblock number to write to
364 * @buf: data to write
365 * @offset: offset within the logical eraseblock where to write
366 * @len: how many bytes to write
367 * @dtype: expected data type
369 * This function writes @len bytes of data from @buf to offset @offset of
370 * logical eraseblock @lnum. The @dtype argument describes expected lifetime of
373 * This function takes care of physical eraseblock write failures. If write to
374 * the physical eraseblock write operation fails, the logical eraseblock is
375 * re-mapped to another physical eraseblock, the data is recovered, and the
376 * write finishes. UBI has a pool of reserved physical eraseblocks for this.
378 * If all the data were successfully written, zero is returned. If an error
379 * occurred and UBI has not been able to recover from it, this function returns
380 * a negative error code. Note, in case of an error, it is possible that
381 * something was still written to the flash media, but that may be some
384 * If the volume is damaged because of an interrupted update this function just
385 * returns immediately with %-EBADF code.
387 int ubi_leb_write(struct ubi_volume_desc *desc, int lnum, const void *buf,
388 int offset, int len, int dtype)
390 struct ubi_volume *vol = desc->vol;
391 struct ubi_device *ubi = vol->ubi;
392 int vol_id = vol->vol_id;
394 dbg_gen("write %d bytes to LEB %d:%d:%d", len, vol_id, lnum, offset);
396 if (vol_id < 0 || vol_id >= ubi->vtbl_slots)
399 if (desc->mode == UBI_READONLY || vol->vol_type == UBI_STATIC_VOLUME)
402 if (lnum < 0 || lnum >= vol->reserved_pebs || offset < 0 || len < 0 ||
403 offset + len > vol->usable_leb_size ||
404 offset & (ubi->min_io_size - 1) || len & (ubi->min_io_size - 1))
407 if (dtype != UBI_LONGTERM && dtype != UBI_SHORTTERM &&
408 dtype != UBI_UNKNOWN)
417 return ubi_eba_write_leb(ubi, vol, lnum, buf, offset, len, dtype);
419 EXPORT_SYMBOL_GPL(ubi_leb_write);
422 * ubi_leb_change - change logical eraseblock atomically.
423 * @desc: volume descriptor
424 * @lnum: logical eraseblock number to change
425 * @buf: data to write
426 * @len: how many bytes to write
427 * @dtype: expected data type
429 * This function changes the contents of a logical eraseblock atomically. @buf
430 * has to contain new logical eraseblock data, and @len - the length of the
431 * data, which has to be aligned. The length may be shorter then the logical
432 * eraseblock size, ant the logical eraseblock may be appended to more times
433 * later on. This function guarantees that in case of an unclean reboot the old
434 * contents is preserved. Returns zero in case of success and a negative error
435 * code in case of failure.
437 int ubi_leb_change(struct ubi_volume_desc *desc, int lnum, const void *buf,
440 struct ubi_volume *vol = desc->vol;
441 struct ubi_device *ubi = vol->ubi;
442 int vol_id = vol->vol_id;
444 dbg_gen("atomically write %d bytes to LEB %d:%d", len, vol_id, lnum);
446 if (vol_id < 0 || vol_id >= ubi->vtbl_slots)
449 if (desc->mode == UBI_READONLY || vol->vol_type == UBI_STATIC_VOLUME)
452 if (lnum < 0 || lnum >= vol->reserved_pebs || len < 0 ||
453 len > vol->usable_leb_size || len & (ubi->min_io_size - 1))
456 if (dtype != UBI_LONGTERM && dtype != UBI_SHORTTERM &&
457 dtype != UBI_UNKNOWN)
466 return ubi_eba_atomic_leb_change(ubi, vol, lnum, buf, len, dtype);
468 EXPORT_SYMBOL_GPL(ubi_leb_change);
471 * ubi_leb_erase - erase logical eraseblock.
472 * @desc: volume descriptor
473 * @lnum: logical eraseblock number
475 * This function un-maps logical eraseblock @lnum and synchronously erases the
476 * correspondent physical eraseblock. Returns zero in case of success and a
477 * negative error code in case of failure.
479 * If the volume is damaged because of an interrupted update this function just
480 * returns immediately with %-EBADF code.
482 int ubi_leb_erase(struct ubi_volume_desc *desc, int lnum)
484 struct ubi_volume *vol = desc->vol;
485 struct ubi_device *ubi = vol->ubi;
488 dbg_gen("erase LEB %d:%d", vol->vol_id, lnum);
490 if (desc->mode == UBI_READONLY || vol->vol_type == UBI_STATIC_VOLUME)
493 if (lnum < 0 || lnum >= vol->reserved_pebs)
499 err = ubi_eba_unmap_leb(ubi, vol, lnum);
503 return ubi_wl_flush(ubi);
505 EXPORT_SYMBOL_GPL(ubi_leb_erase);
508 * ubi_leb_unmap - un-map logical eraseblock.
509 * @desc: volume descriptor
510 * @lnum: logical eraseblock number
512 * This function un-maps logical eraseblock @lnum and schedules the
513 * corresponding physical eraseblock for erasure, so that it will eventually be
514 * physically erased in background. This operation is much faster then the
517 * Unlike erase, the un-map operation does not guarantee that the logical
518 * eraseblock will contain all 0xFF bytes when UBI is initialized again. For
519 * example, if several logical eraseblocks are un-mapped, and an unclean reboot
520 * happens after this, the logical eraseblocks will not necessarily be
521 * un-mapped again when this MTD device is attached. They may actually be
522 * mapped to the same physical eraseblocks again. So, this function has to be
525 * In other words, when un-mapping a logical eraseblock, UBI does not store
526 * any information about this on the flash media, it just marks the logical
527 * eraseblock as "un-mapped" in RAM. If UBI is detached before the physical
528 * eraseblock is physically erased, it will be mapped again to the same logical
529 * eraseblock when the MTD device is attached again.
531 * The main and obvious use-case of this function is when the contents of a
532 * logical eraseblock has to be re-written. Then it is much more efficient to
533 * first un-map it, then write new data, rather then first erase it, then write
534 * new data. Note, once new data has been written to the logical eraseblock,
535 * UBI guarantees that the old contents has gone forever. In other words, if an
536 * unclean reboot happens after the logical eraseblock has been un-mapped and
537 * then written to, it will contain the last written data.
539 * This function returns zero in case of success and a negative error code in
540 * case of failure. If the volume is damaged because of an interrupted update
541 * this function just returns immediately with %-EBADF code.
543 int ubi_leb_unmap(struct ubi_volume_desc *desc, int lnum)
545 struct ubi_volume *vol = desc->vol;
546 struct ubi_device *ubi = vol->ubi;
548 dbg_gen("unmap LEB %d:%d", vol->vol_id, lnum);
550 if (desc->mode == UBI_READONLY || vol->vol_type == UBI_STATIC_VOLUME)
553 if (lnum < 0 || lnum >= vol->reserved_pebs)
559 return ubi_eba_unmap_leb(ubi, vol, lnum);
561 EXPORT_SYMBOL_GPL(ubi_leb_unmap);
564 * ubi_leb_map - map logical erasblock to a physical eraseblock.
565 * @desc: volume descriptor
566 * @lnum: logical eraseblock number
567 * @dtype: expected data type
569 * This function maps an un-mapped logical eraseblock @lnum to a physical
570 * eraseblock. This means, that after a successful invocation of this
571 * function the logical eraseblock @lnum will be empty (contain only %0xFF
572 * bytes) and be mapped to a physical eraseblock, even if an unclean reboot
575 * This function returns zero in case of success, %-EBADF if the volume is
576 * damaged because of an interrupted update, %-EBADMSG if the logical
577 * eraseblock is already mapped, and other negative error codes in case of
580 int ubi_leb_map(struct ubi_volume_desc *desc, int lnum, int dtype)
582 struct ubi_volume *vol = desc->vol;
583 struct ubi_device *ubi = vol->ubi;
585 dbg_gen("unmap LEB %d:%d", vol->vol_id, lnum);
587 if (desc->mode == UBI_READONLY || vol->vol_type == UBI_STATIC_VOLUME)
590 if (lnum < 0 || lnum >= vol->reserved_pebs)
593 if (dtype != UBI_LONGTERM && dtype != UBI_SHORTTERM &&
594 dtype != UBI_UNKNOWN)
600 if (vol->eba_tbl[lnum] >= 0)
603 return ubi_eba_write_leb(ubi, vol, lnum, NULL, 0, 0, dtype);
605 EXPORT_SYMBOL_GPL(ubi_leb_map);
608 * ubi_is_mapped - check if logical eraseblock is mapped.
609 * @desc: volume descriptor
610 * @lnum: logical eraseblock number
612 * This function checks if logical eraseblock @lnum is mapped to a physical
613 * eraseblock. If a logical eraseblock is un-mapped, this does not necessarily
614 * mean it will still be un-mapped after the UBI device is re-attached. The
615 * logical eraseblock may become mapped to the physical eraseblock it was last
618 * This function returns %1 if the LEB is mapped, %0 if not, and a negative
619 * error code in case of failure. If the volume is damaged because of an
620 * interrupted update this function just returns immediately with %-EBADF error
623 int ubi_is_mapped(struct ubi_volume_desc *desc, int lnum)
625 struct ubi_volume *vol = desc->vol;
627 dbg_gen("test LEB %d:%d", vol->vol_id, lnum);
629 if (lnum < 0 || lnum >= vol->reserved_pebs)
635 return vol->eba_tbl[lnum] >= 0;
637 EXPORT_SYMBOL_GPL(ubi_is_mapped);
640 * ubi_sync - synchronize UBI device buffers.
641 * @ubi_num: UBI device to synchronize
643 * The underlying MTD device may cache data in hardware or in software. This
644 * function ensures the caches are flushed. Returns zero in case of success and
645 * a negative error code in case of failure.
647 int ubi_sync(int ubi_num)
649 struct ubi_device *ubi;
651 ubi = ubi_get_device(ubi_num);
656 ubi->mtd->sync(ubi->mtd);
661 EXPORT_SYMBOL_GPL(ubi_sync);