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 * This file includes implementation of UBI character device operations.
24 * There are two kinds of character devices in UBI: UBI character devices and
25 * UBI volume character devices. UBI character devices allow users to
26 * manipulate whole volumes: create, remove, and re-size them. Volume character
27 * devices provide volume I/O capabilities.
29 * Major and minor numbers are assigned dynamically to both UBI and volume
32 * Well, there is the third kind of character devices - the UBI control
33 * character device, which allows to manipulate by UBI devices - create and
34 * delete them. In other words, it is used for attaching and detaching MTD
38 #include <linux/module.h>
39 #include <linux/stat.h>
40 #include <linux/slab.h>
41 #include <linux/ioctl.h>
42 #include <linux/capability.h>
43 #include <linux/uaccess.h>
44 #include <linux/compat.h>
45 #include <linux/math64.h>
46 #include <mtd/ubi-user.h>
50 * get_exclusive - get exclusive access to an UBI volume.
51 * @desc: volume descriptor
53 * This function changes UBI volume open mode to "exclusive". Returns previous
54 * mode value (positive integer) in case of success and a negative error code
57 static int get_exclusive(struct ubi_volume_desc *desc)
60 struct ubi_volume *vol = desc->vol;
62 spin_lock(&vol->ubi->volumes_lock);
63 users = vol->readers + vol->writers + vol->exclusive;
64 ubi_assert(users > 0);
66 ubi_err("%d users for volume %d", users, vol->vol_id);
69 vol->readers = vol->writers = 0;
72 desc->mode = UBI_EXCLUSIVE;
74 spin_unlock(&vol->ubi->volumes_lock);
80 * revoke_exclusive - revoke exclusive mode.
81 * @desc: volume descriptor
82 * @mode: new mode to switch to
84 static void revoke_exclusive(struct ubi_volume_desc *desc, int mode)
86 struct ubi_volume *vol = desc->vol;
88 spin_lock(&vol->ubi->volumes_lock);
89 ubi_assert(vol->readers == 0 && vol->writers == 0);
90 ubi_assert(vol->exclusive == 1 && desc->mode == UBI_EXCLUSIVE);
92 if (mode == UBI_READONLY)
94 else if (mode == UBI_READWRITE)
98 spin_unlock(&vol->ubi->volumes_lock);
103 static int vol_cdev_open(struct inode *inode, struct file *file)
105 struct ubi_volume_desc *desc;
106 int vol_id = iminor(inode) - 1, mode, ubi_num;
108 ubi_num = ubi_major2num(imajor(inode));
112 if (file->f_mode & FMODE_WRITE)
113 mode = UBI_READWRITE;
117 dbg_gen("open device %d, volume %d, mode %d",
118 ubi_num, vol_id, mode);
120 desc = ubi_open_volume(ubi_num, vol_id, mode);
122 return PTR_ERR(desc);
124 file->private_data = desc;
128 static int vol_cdev_release(struct inode *inode, struct file *file)
130 struct ubi_volume_desc *desc = file->private_data;
131 struct ubi_volume *vol = desc->vol;
133 dbg_gen("release device %d, volume %d, mode %d",
134 vol->ubi->ubi_num, vol->vol_id, desc->mode);
137 ubi_warn("update of volume %d not finished, volume is damaged",
139 ubi_assert(!vol->changing_leb);
142 } else if (vol->changing_leb) {
143 dbg_gen("only %lld of %lld bytes received for atomic LEB change for volume %d:%d, cancel",
144 vol->upd_received, vol->upd_bytes, vol->ubi->ubi_num,
146 vol->changing_leb = 0;
150 ubi_close_volume(desc);
154 static loff_t vol_cdev_llseek(struct file *file, loff_t offset, int origin)
156 struct ubi_volume_desc *desc = file->private_data;
157 struct ubi_volume *vol = desc->vol;
161 /* Update is in progress, seeking is prohibited */
167 case 0: /* SEEK_SET */
170 case 1: /* SEEK_CUR */
171 new_offset = file->f_pos + offset;
173 case 2: /* SEEK_END */
174 new_offset = vol->used_bytes + offset;
180 if (new_offset < 0 || new_offset > vol->used_bytes) {
181 ubi_err("bad seek %lld", new_offset);
185 dbg_gen("seek volume %d, offset %lld, origin %d, new offset %lld",
186 vol->vol_id, offset, origin, new_offset);
188 file->f_pos = new_offset;
192 static int vol_cdev_fsync(struct file *file, loff_t start, loff_t end,
195 struct ubi_volume_desc *desc = file->private_data;
196 struct ubi_device *ubi = desc->vol->ubi;
197 struct inode *inode = file_inode(file);
199 mutex_lock(&inode->i_mutex);
200 err = ubi_sync(ubi->ubi_num);
201 mutex_unlock(&inode->i_mutex);
206 static ssize_t vol_cdev_read(struct file *file, __user char *buf, size_t count,
209 struct ubi_volume_desc *desc = file->private_data;
210 struct ubi_volume *vol = desc->vol;
211 struct ubi_device *ubi = vol->ubi;
212 int err, lnum, off, len, tbuf_size;
213 size_t count_save = count;
216 dbg_gen("read %zd bytes from offset %lld of volume %d",
217 count, *offp, vol->vol_id);
223 if (vol->upd_marker) {
224 ubi_err("damaged volume, update marker is set");
227 if (*offp == vol->used_bytes || count == 0)
231 dbg_gen("read from corrupted volume %d", vol->vol_id);
233 if (*offp + count > vol->used_bytes)
234 count_save = count = vol->used_bytes - *offp;
236 tbuf_size = vol->usable_leb_size;
237 if (count < tbuf_size)
238 tbuf_size = ALIGN(count, ubi->min_io_size);
239 tbuf = vmalloc(tbuf_size);
243 len = count > tbuf_size ? tbuf_size : count;
244 lnum = div_u64_rem(*offp, vol->usable_leb_size, &off);
249 if (off + len >= vol->usable_leb_size)
250 len = vol->usable_leb_size - off;
252 err = ubi_eba_read_leb(ubi, vol, lnum, tbuf, off, len, 0);
257 if (off == vol->usable_leb_size) {
259 off -= vol->usable_leb_size;
265 err = copy_to_user(buf, tbuf, len);
272 len = count > tbuf_size ? tbuf_size : count;
276 return err ? err : count_save - count;
280 * This function allows to directly write to dynamic UBI volumes, without
281 * issuing the volume update operation.
283 static ssize_t vol_cdev_direct_write(struct file *file, const char __user *buf,
284 size_t count, loff_t *offp)
286 struct ubi_volume_desc *desc = file->private_data;
287 struct ubi_volume *vol = desc->vol;
288 struct ubi_device *ubi = vol->ubi;
289 int lnum, off, len, tbuf_size, err = 0;
290 size_t count_save = count;
293 if (!vol->direct_writes)
296 dbg_gen("requested: write %zd bytes to offset %lld of volume %u",
297 count, *offp, vol->vol_id);
299 if (vol->vol_type == UBI_STATIC_VOLUME)
302 lnum = div_u64_rem(*offp, vol->usable_leb_size, &off);
303 if (off & (ubi->min_io_size - 1)) {
304 ubi_err("unaligned position");
308 if (*offp + count > vol->used_bytes)
309 count_save = count = vol->used_bytes - *offp;
311 /* We can write only in fractions of the minimum I/O unit */
312 if (count & (ubi->min_io_size - 1)) {
313 ubi_err("unaligned write length");
317 tbuf_size = vol->usable_leb_size;
318 if (count < tbuf_size)
319 tbuf_size = ALIGN(count, ubi->min_io_size);
320 tbuf = vmalloc(tbuf_size);
324 len = count > tbuf_size ? tbuf_size : count;
329 if (off + len >= vol->usable_leb_size)
330 len = vol->usable_leb_size - off;
332 err = copy_from_user(tbuf, buf, len);
338 err = ubi_eba_write_leb(ubi, vol, lnum, tbuf, off, len);
343 if (off == vol->usable_leb_size) {
345 off -= vol->usable_leb_size;
351 len = count > tbuf_size ? tbuf_size : count;
355 return err ? err : count_save - count;
358 static ssize_t vol_cdev_write(struct file *file, const char __user *buf,
359 size_t count, loff_t *offp)
362 struct ubi_volume_desc *desc = file->private_data;
363 struct ubi_volume *vol = desc->vol;
364 struct ubi_device *ubi = vol->ubi;
366 if (!vol->updating && !vol->changing_leb)
367 return vol_cdev_direct_write(file, buf, count, offp);
370 err = ubi_more_update_data(ubi, vol, buf, count);
372 err = ubi_more_leb_change_data(ubi, vol, buf, count);
375 ubi_err("cannot accept more %zd bytes of data, error %d",
382 * The operation is finished, @err contains number of actually
387 if (vol->changing_leb) {
388 revoke_exclusive(desc, UBI_READWRITE);
392 err = ubi_check_volume(ubi, vol->vol_id);
397 ubi_warn("volume %d on UBI device %d is corrupted",
398 vol->vol_id, ubi->ubi_num);
402 ubi_volume_notify(ubi, vol, UBI_VOLUME_UPDATED);
403 revoke_exclusive(desc, UBI_READWRITE);
409 static long vol_cdev_ioctl(struct file *file, unsigned int cmd,
413 struct ubi_volume_desc *desc = file->private_data;
414 struct ubi_volume *vol = desc->vol;
415 struct ubi_device *ubi = vol->ubi;
416 void __user *argp = (void __user *)arg;
419 /* Volume update command */
422 int64_t bytes, rsvd_bytes;
424 if (!capable(CAP_SYS_RESOURCE)) {
429 err = copy_from_user(&bytes, argp, sizeof(int64_t));
435 if (desc->mode == UBI_READONLY) {
440 rsvd_bytes = (long long)vol->reserved_pebs *
441 ubi->leb_size-vol->data_pad;
442 if (bytes < 0 || bytes > rsvd_bytes) {
447 err = get_exclusive(desc);
451 err = ubi_start_update(ubi, vol, bytes);
453 revoke_exclusive(desc, UBI_READWRITE);
457 /* Atomic logical eraseblock change command */
460 struct ubi_leb_change_req req;
462 err = copy_from_user(&req, argp,
463 sizeof(struct ubi_leb_change_req));
469 if (desc->mode == UBI_READONLY ||
470 vol->vol_type == UBI_STATIC_VOLUME) {
475 /* Validate the request */
477 if (req.lnum < 0 || req.lnum >= vol->reserved_pebs ||
478 req.bytes < 0 || req.lnum >= vol->usable_leb_size)
481 err = get_exclusive(desc);
485 err = ubi_start_leb_change(ubi, vol, &req);
487 revoke_exclusive(desc, UBI_READWRITE);
491 /* Logical eraseblock erasure command */
496 err = get_user(lnum, (__user int32_t *)argp);
502 if (desc->mode == UBI_READONLY ||
503 vol->vol_type == UBI_STATIC_VOLUME) {
508 if (lnum < 0 || lnum >= vol->reserved_pebs) {
513 dbg_gen("erase LEB %d:%d", vol->vol_id, lnum);
514 err = ubi_eba_unmap_leb(ubi, vol, lnum);
518 err = ubi_wl_flush(ubi, UBI_ALL, UBI_ALL);
522 /* Logical eraseblock map command */
525 struct ubi_map_req req;
527 err = copy_from_user(&req, argp, sizeof(struct ubi_map_req));
532 err = ubi_leb_map(desc, req.lnum);
536 /* Logical eraseblock un-map command */
541 err = get_user(lnum, (__user int32_t *)argp);
546 err = ubi_leb_unmap(desc, lnum);
550 /* Check if logical eraseblock is mapped command */
555 err = get_user(lnum, (__user int32_t *)argp);
560 err = ubi_is_mapped(desc, lnum);
564 /* Set volume property command */
565 case UBI_IOCSETVOLPROP:
567 struct ubi_set_vol_prop_req req;
569 err = copy_from_user(&req, argp,
570 sizeof(struct ubi_set_vol_prop_req));
575 switch (req.property) {
576 case UBI_VOL_PROP_DIRECT_WRITE:
577 mutex_lock(&ubi->device_mutex);
578 desc->vol->direct_writes = !!req.value;
579 mutex_unlock(&ubi->device_mutex);
596 * verify_mkvol_req - verify volume creation request.
597 * @ubi: UBI device description object
598 * @req: the request to check
600 * This function zero if the request is correct, and %-EINVAL if not.
602 static int verify_mkvol_req(const struct ubi_device *ubi,
603 const struct ubi_mkvol_req *req)
605 int n, err = -EINVAL;
607 if (req->bytes < 0 || req->alignment < 0 || req->vol_type < 0 ||
611 if ((req->vol_id < 0 || req->vol_id >= ubi->vtbl_slots) &&
612 req->vol_id != UBI_VOL_NUM_AUTO)
615 if (req->alignment == 0)
621 if (req->vol_type != UBI_DYNAMIC_VOLUME &&
622 req->vol_type != UBI_STATIC_VOLUME)
625 if (req->alignment > ubi->leb_size)
628 n = req->alignment & (ubi->min_io_size - 1);
629 if (req->alignment != 1 && n)
632 if (!req->name[0] || !req->name_len)
635 if (req->name_len > UBI_VOL_NAME_MAX) {
640 n = strnlen(req->name, req->name_len + 1);
641 if (n != req->name_len)
647 ubi_err("bad volume creation request");
648 ubi_dump_mkvol_req(req);
653 * verify_rsvol_req - verify volume re-size request.
654 * @ubi: UBI device description object
655 * @req: the request to check
657 * This function returns zero if the request is correct, and %-EINVAL if not.
659 static int verify_rsvol_req(const struct ubi_device *ubi,
660 const struct ubi_rsvol_req *req)
665 if (req->vol_id < 0 || req->vol_id >= ubi->vtbl_slots)
672 * rename_volumes - rename UBI volumes.
673 * @ubi: UBI device description object
674 * @req: volumes re-name request
676 * This is a helper function for the volume re-name IOCTL which validates the
677 * the request, opens the volume and calls corresponding volumes management
678 * function. Returns zero in case of success and a negative error code in case
681 static int rename_volumes(struct ubi_device *ubi,
682 struct ubi_rnvol_req *req)
685 struct list_head rename_list;
686 struct ubi_rename_entry *re, *re1;
688 if (req->count < 0 || req->count > UBI_MAX_RNVOL)
694 /* Validate volume IDs and names in the request */
695 for (i = 0; i < req->count; i++) {
696 if (req->ents[i].vol_id < 0 ||
697 req->ents[i].vol_id >= ubi->vtbl_slots)
699 if (req->ents[i].name_len < 0)
701 if (req->ents[i].name_len > UBI_VOL_NAME_MAX)
702 return -ENAMETOOLONG;
703 req->ents[i].name[req->ents[i].name_len] = '\0';
704 n = strlen(req->ents[i].name);
705 if (n != req->ents[i].name_len)
709 /* Make sure volume IDs and names are unique */
710 for (i = 0; i < req->count - 1; i++) {
711 for (n = i + 1; n < req->count; n++) {
712 if (req->ents[i].vol_id == req->ents[n].vol_id) {
713 ubi_err("duplicated volume id %d",
714 req->ents[i].vol_id);
717 if (!strcmp(req->ents[i].name, req->ents[n].name)) {
718 ubi_err("duplicated volume name \"%s\"",
725 /* Create the re-name list */
726 INIT_LIST_HEAD(&rename_list);
727 for (i = 0; i < req->count; i++) {
728 int vol_id = req->ents[i].vol_id;
729 int name_len = req->ents[i].name_len;
730 const char *name = req->ents[i].name;
732 re = kzalloc(sizeof(struct ubi_rename_entry), GFP_KERNEL);
738 re->desc = ubi_open_volume(ubi->ubi_num, vol_id, UBI_EXCLUSIVE);
739 if (IS_ERR(re->desc)) {
740 err = PTR_ERR(re->desc);
741 ubi_err("cannot open volume %d, error %d", vol_id, err);
746 /* Skip this re-naming if the name does not really change */
747 if (re->desc->vol->name_len == name_len &&
748 !memcmp(re->desc->vol->name, name, name_len)) {
749 ubi_close_volume(re->desc);
754 re->new_name_len = name_len;
755 memcpy(re->new_name, name, name_len);
756 list_add_tail(&re->list, &rename_list);
757 dbg_gen("will rename volume %d from \"%s\" to \"%s\"",
758 vol_id, re->desc->vol->name, name);
761 if (list_empty(&rename_list))
764 /* Find out the volumes which have to be removed */
765 list_for_each_entry(re, &rename_list, list) {
766 struct ubi_volume_desc *desc;
767 int no_remove_needed = 0;
770 * Volume @re->vol_id is going to be re-named to
771 * @re->new_name, while its current name is @name. If a volume
772 * with name @re->new_name currently exists, it has to be
773 * removed, unless it is also re-named in the request (@req).
775 list_for_each_entry(re1, &rename_list, list) {
776 if (re->new_name_len == re1->desc->vol->name_len &&
777 !memcmp(re->new_name, re1->desc->vol->name,
778 re1->desc->vol->name_len)) {
779 no_remove_needed = 1;
784 if (no_remove_needed)
788 * It seems we need to remove volume with name @re->new_name,
791 desc = ubi_open_volume_nm(ubi->ubi_num, re->new_name,
796 /* Re-naming into a non-existing volume name */
799 /* The volume exists but busy, or an error occurred */
800 ubi_err("cannot open volume \"%s\", error %d",
805 re1 = kzalloc(sizeof(struct ubi_rename_entry), GFP_KERNEL);
808 ubi_close_volume(desc);
814 list_add(&re1->list, &rename_list);
815 dbg_gen("will remove volume %d, name \"%s\"",
816 re1->desc->vol->vol_id, re1->desc->vol->name);
819 mutex_lock(&ubi->device_mutex);
820 err = ubi_rename_volumes(ubi, &rename_list);
821 mutex_unlock(&ubi->device_mutex);
824 list_for_each_entry_safe(re, re1, &rename_list, list) {
825 ubi_close_volume(re->desc);
832 static long ubi_cdev_ioctl(struct file *file, unsigned int cmd,
836 struct ubi_device *ubi;
837 struct ubi_volume_desc *desc;
838 void __user *argp = (void __user *)arg;
840 if (!capable(CAP_SYS_RESOURCE))
843 ubi = ubi_get_by_major(imajor(file->f_mapping->host));
848 /* Create volume command */
851 struct ubi_mkvol_req req;
853 dbg_gen("create volume");
854 err = copy_from_user(&req, argp, sizeof(struct ubi_mkvol_req));
860 err = verify_mkvol_req(ubi, &req);
864 mutex_lock(&ubi->device_mutex);
865 err = ubi_create_volume(ubi, &req);
866 mutex_unlock(&ubi->device_mutex);
870 err = put_user(req.vol_id, (__user int32_t *)argp);
877 /* Remove volume command */
882 dbg_gen("remove volume");
883 err = get_user(vol_id, (__user int32_t *)argp);
889 desc = ubi_open_volume(ubi->ubi_num, vol_id, UBI_EXCLUSIVE);
895 mutex_lock(&ubi->device_mutex);
896 err = ubi_remove_volume(desc, 0);
897 mutex_unlock(&ubi->device_mutex);
900 * The volume is deleted (unless an error occurred), and the
901 * 'struct ubi_volume' object will be freed when
902 * 'ubi_close_volume()' will call 'put_device()'.
904 ubi_close_volume(desc);
908 /* Re-size volume command */
912 struct ubi_rsvol_req req;
914 dbg_gen("re-size volume");
915 err = copy_from_user(&req, argp, sizeof(struct ubi_rsvol_req));
921 err = verify_rsvol_req(ubi, &req);
925 desc = ubi_open_volume(ubi->ubi_num, req.vol_id, UBI_EXCLUSIVE);
931 pebs = div_u64(req.bytes + desc->vol->usable_leb_size - 1,
932 desc->vol->usable_leb_size);
934 mutex_lock(&ubi->device_mutex);
935 err = ubi_resize_volume(desc, pebs);
936 mutex_unlock(&ubi->device_mutex);
937 ubi_close_volume(desc);
941 /* Re-name volumes command */
944 struct ubi_rnvol_req *req;
946 dbg_gen("re-name volumes");
947 req = kmalloc(sizeof(struct ubi_rnvol_req), GFP_KERNEL);
953 err = copy_from_user(req, argp, sizeof(struct ubi_rnvol_req));
960 err = rename_volumes(ubi, req);
974 static long ctrl_cdev_ioctl(struct file *file, unsigned int cmd,
978 void __user *argp = (void __user *)arg;
980 if (!capable(CAP_SYS_RESOURCE))
984 /* Attach an MTD device command */
987 struct ubi_attach_req req;
988 struct mtd_info *mtd;
990 dbg_gen("attach MTD device");
991 err = copy_from_user(&req, argp, sizeof(struct ubi_attach_req));
997 if (req.mtd_num < 0 ||
998 (req.ubi_num < 0 && req.ubi_num != UBI_DEV_NUM_AUTO)) {
1003 mtd = get_mtd_device(NULL, req.mtd_num);
1010 * Note, further request verification is done by
1011 * 'ubi_attach_mtd_dev()'.
1013 mutex_lock(&ubi_devices_mutex);
1014 err = ubi_attach_mtd_dev(mtd, req.ubi_num, req.vid_hdr_offset,
1015 req.max_beb_per1024);
1016 mutex_unlock(&ubi_devices_mutex);
1018 put_mtd_device(mtd);
1020 /* @err contains UBI device number */
1021 err = put_user(err, (__user int32_t *)argp);
1026 /* Detach an MTD device command */
1031 dbg_gen("detach MTD device");
1032 err = get_user(ubi_num, (__user int32_t *)argp);
1038 mutex_lock(&ubi_devices_mutex);
1039 err = ubi_detach_mtd_dev(ubi_num, 0);
1040 mutex_unlock(&ubi_devices_mutex);
1052 #ifdef CONFIG_COMPAT
1053 static long vol_cdev_compat_ioctl(struct file *file, unsigned int cmd,
1056 unsigned long translated_arg = (unsigned long)compat_ptr(arg);
1058 return vol_cdev_ioctl(file, cmd, translated_arg);
1061 static long ubi_cdev_compat_ioctl(struct file *file, unsigned int cmd,
1064 unsigned long translated_arg = (unsigned long)compat_ptr(arg);
1066 return ubi_cdev_ioctl(file, cmd, translated_arg);
1069 static long ctrl_cdev_compat_ioctl(struct file *file, unsigned int cmd,
1072 unsigned long translated_arg = (unsigned long)compat_ptr(arg);
1074 return ctrl_cdev_ioctl(file, cmd, translated_arg);
1077 #define vol_cdev_compat_ioctl NULL
1078 #define ubi_cdev_compat_ioctl NULL
1079 #define ctrl_cdev_compat_ioctl NULL
1082 /* UBI volume character device operations */
1083 const struct file_operations ubi_vol_cdev_operations = {
1084 .owner = THIS_MODULE,
1085 .open = vol_cdev_open,
1086 .release = vol_cdev_release,
1087 .llseek = vol_cdev_llseek,
1088 .read = vol_cdev_read,
1089 .write = vol_cdev_write,
1090 .fsync = vol_cdev_fsync,
1091 .unlocked_ioctl = vol_cdev_ioctl,
1092 .compat_ioctl = vol_cdev_compat_ioctl,
1095 /* UBI character device operations */
1096 const struct file_operations ubi_cdev_operations = {
1097 .owner = THIS_MODULE,
1098 .llseek = no_llseek,
1099 .unlocked_ioctl = ubi_cdev_ioctl,
1100 .compat_ioctl = ubi_cdev_compat_ioctl,
1103 /* UBI control character device operations */
1104 const struct file_operations ubi_ctrl_cdev_operations = {
1105 .owner = THIS_MODULE,
1106 .unlocked_ioctl = ctrl_cdev_ioctl,
1107 .compat_ioctl = ctrl_cdev_compat_ioctl,
1108 .llseek = no_llseek,