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/ioctl.h>
41 #include <linux/capability.h>
42 #include <linux/uaccess.h>
43 #include <linux/compat.h>
44 #include <linux/math64.h>
45 #include <mtd/ubi-user.h>
49 * get_exclusive - get exclusive access to an UBI volume.
50 * @desc: volume descriptor
52 * This function changes UBI volume open mode to "exclusive". Returns previous
53 * mode value (positive integer) in case of success and a negative error code
56 static int get_exclusive(struct ubi_volume_desc *desc)
59 struct ubi_volume *vol = desc->vol;
61 spin_lock(&vol->ubi->volumes_lock);
62 users = vol->readers + vol->writers + vol->exclusive;
63 ubi_assert(users > 0);
65 dbg_err("%d users for volume %d", users, vol->vol_id);
68 vol->readers = vol->writers = 0;
71 desc->mode = UBI_EXCLUSIVE;
73 spin_unlock(&vol->ubi->volumes_lock);
79 * revoke_exclusive - revoke exclusive mode.
80 * @desc: volume descriptor
81 * @mode: new mode to switch to
83 static void revoke_exclusive(struct ubi_volume_desc *desc, int mode)
85 struct ubi_volume *vol = desc->vol;
87 spin_lock(&vol->ubi->volumes_lock);
88 ubi_assert(vol->readers == 0 && vol->writers == 0);
89 ubi_assert(vol->exclusive == 1 && desc->mode == UBI_EXCLUSIVE);
91 if (mode == UBI_READONLY)
93 else if (mode == UBI_READWRITE)
97 spin_unlock(&vol->ubi->volumes_lock);
102 static int vol_cdev_open(struct inode *inode, struct file *file)
104 struct ubi_volume_desc *desc;
105 int vol_id = iminor(inode) - 1, mode, ubi_num;
107 ubi_num = ubi_major2num(imajor(inode));
111 if (file->f_mode & FMODE_WRITE)
112 mode = UBI_READWRITE;
116 dbg_gen("open volume %d, mode %d", vol_id, mode);
118 desc = ubi_open_volume(ubi_num, vol_id, mode);
120 return PTR_ERR(desc);
122 file->private_data = desc;
126 static int vol_cdev_release(struct inode *inode, struct file *file)
128 struct ubi_volume_desc *desc = file->private_data;
129 struct ubi_volume *vol = desc->vol;
131 dbg_gen("release volume %d, mode %d", vol->vol_id, desc->mode);
134 ubi_warn("update of volume %d not finished, volume is damaged",
136 ubi_assert(!vol->changing_leb);
139 } else if (vol->changing_leb) {
140 dbg_gen("only %lld of %lld bytes received for atomic LEB change"
141 " for volume %d:%d, cancel", vol->upd_received,
142 vol->upd_bytes, vol->ubi->ubi_num, vol->vol_id);
143 vol->changing_leb = 0;
147 ubi_close_volume(desc);
151 static loff_t vol_cdev_llseek(struct file *file, loff_t offset, int origin)
153 struct ubi_volume_desc *desc = file->private_data;
154 struct ubi_volume *vol = desc->vol;
158 /* Update is in progress, seeking is prohibited */
164 case 0: /* SEEK_SET */
167 case 1: /* SEEK_CUR */
168 new_offset = file->f_pos + offset;
170 case 2: /* SEEK_END */
171 new_offset = vol->used_bytes + offset;
177 if (new_offset < 0 || new_offset > vol->used_bytes) {
178 dbg_err("bad seek %lld", new_offset);
182 dbg_gen("seek volume %d, offset %lld, origin %d, new offset %lld",
183 vol->vol_id, offset, origin, new_offset);
185 file->f_pos = new_offset;
189 static ssize_t vol_cdev_read(struct file *file, __user char *buf, size_t count,
192 struct ubi_volume_desc *desc = file->private_data;
193 struct ubi_volume *vol = desc->vol;
194 struct ubi_device *ubi = vol->ubi;
195 int err, lnum, off, len, tbuf_size;
196 size_t count_save = count;
199 dbg_gen("read %zd bytes from offset %lld of volume %d",
200 count, *offp, vol->vol_id);
206 if (vol->upd_marker) {
207 dbg_err("damaged volume, update marker is set");
210 if (*offp == vol->used_bytes || count == 0)
214 dbg_gen("read from corrupted volume %d", vol->vol_id);
216 if (*offp + count > vol->used_bytes)
217 count_save = count = vol->used_bytes - *offp;
219 tbuf_size = vol->usable_leb_size;
220 if (count < tbuf_size)
221 tbuf_size = ALIGN(count, ubi->min_io_size);
222 tbuf = vmalloc(tbuf_size);
226 len = count > tbuf_size ? tbuf_size : count;
227 lnum = div_u64_rem(*offp, vol->usable_leb_size, &off);
232 if (off + len >= vol->usable_leb_size)
233 len = vol->usable_leb_size - off;
235 err = ubi_eba_read_leb(ubi, vol, lnum, tbuf, off, len, 0);
240 if (off == vol->usable_leb_size) {
242 off -= vol->usable_leb_size;
248 err = copy_to_user(buf, tbuf, len);
255 len = count > tbuf_size ? tbuf_size : count;
259 return err ? err : count_save - count;
263 * This function allows to directly write to dynamic UBI volumes, without
264 * issuing the volume update operation.
266 static ssize_t vol_cdev_direct_write(struct file *file, const char __user *buf,
267 size_t count, loff_t *offp)
269 struct ubi_volume_desc *desc = file->private_data;
270 struct ubi_volume *vol = desc->vol;
271 struct ubi_device *ubi = vol->ubi;
272 int lnum, off, len, tbuf_size, err = 0;
273 size_t count_save = count;
276 if (!vol->direct_writes)
279 dbg_gen("requested: write %zd bytes to offset %lld of volume %u",
280 count, *offp, vol->vol_id);
282 if (vol->vol_type == UBI_STATIC_VOLUME)
285 lnum = div_u64_rem(*offp, vol->usable_leb_size, &off);
286 if (off & (ubi->min_io_size - 1)) {
287 dbg_err("unaligned position");
291 if (*offp + count > vol->used_bytes)
292 count_save = count = vol->used_bytes - *offp;
294 /* We can write only in fractions of the minimum I/O unit */
295 if (count & (ubi->min_io_size - 1)) {
296 dbg_err("unaligned write length");
300 tbuf_size = vol->usable_leb_size;
301 if (count < tbuf_size)
302 tbuf_size = ALIGN(count, ubi->min_io_size);
303 tbuf = vmalloc(tbuf_size);
307 len = count > tbuf_size ? tbuf_size : count;
312 if (off + len >= vol->usable_leb_size)
313 len = vol->usable_leb_size - off;
315 err = copy_from_user(tbuf, buf, len);
321 err = ubi_eba_write_leb(ubi, vol, lnum, tbuf, off, len,
327 if (off == vol->usable_leb_size) {
329 off -= vol->usable_leb_size;
335 len = count > tbuf_size ? tbuf_size : count;
339 return err ? err : count_save - count;
342 static ssize_t vol_cdev_write(struct file *file, const char __user *buf,
343 size_t count, loff_t *offp)
346 struct ubi_volume_desc *desc = file->private_data;
347 struct ubi_volume *vol = desc->vol;
348 struct ubi_device *ubi = vol->ubi;
350 if (!vol->updating && !vol->changing_leb)
351 return vol_cdev_direct_write(file, buf, count, offp);
354 err = ubi_more_update_data(ubi, vol, buf, count);
356 err = ubi_more_leb_change_data(ubi, vol, buf, count);
359 ubi_err("cannot accept more %zd bytes of data, error %d",
366 * The operation is finished, @err contains number of actually
371 if (vol->changing_leb) {
372 revoke_exclusive(desc, UBI_READWRITE);
376 err = ubi_check_volume(ubi, vol->vol_id);
381 ubi_warn("volume %d on UBI device %d is corrupted",
382 vol->vol_id, ubi->ubi_num);
386 ubi_gluebi_updated(vol);
387 revoke_exclusive(desc, UBI_READWRITE);
393 static long vol_cdev_ioctl(struct file *file, unsigned int cmd,
397 struct ubi_volume_desc *desc = file->private_data;
398 struct ubi_volume *vol = desc->vol;
399 struct ubi_device *ubi = vol->ubi;
400 void __user *argp = (void __user *)arg;
403 /* Volume update command */
406 int64_t bytes, rsvd_bytes;
408 if (!capable(CAP_SYS_RESOURCE)) {
413 err = copy_from_user(&bytes, argp, sizeof(int64_t));
419 if (desc->mode == UBI_READONLY) {
424 rsvd_bytes = (long long)vol->reserved_pebs *
425 ubi->leb_size-vol->data_pad;
426 if (bytes < 0 || bytes > rsvd_bytes) {
431 err = get_exclusive(desc);
435 err = ubi_start_update(ubi, vol, bytes);
437 revoke_exclusive(desc, UBI_READWRITE);
441 /* Atomic logical eraseblock change command */
444 struct ubi_leb_change_req req;
446 err = copy_from_user(&req, argp,
447 sizeof(struct ubi_leb_change_req));
453 if (desc->mode == UBI_READONLY ||
454 vol->vol_type == UBI_STATIC_VOLUME) {
459 /* Validate the request */
461 if (req.lnum < 0 || req.lnum >= vol->reserved_pebs ||
462 req.bytes < 0 || req.lnum >= vol->usable_leb_size)
464 if (req.dtype != UBI_LONGTERM && req.dtype != UBI_SHORTTERM &&
465 req.dtype != UBI_UNKNOWN)
468 err = get_exclusive(desc);
472 err = ubi_start_leb_change(ubi, vol, &req);
474 revoke_exclusive(desc, UBI_READWRITE);
478 /* Logical eraseblock erasure command */
483 err = get_user(lnum, (__user int32_t *)argp);
489 if (desc->mode == UBI_READONLY ||
490 vol->vol_type == UBI_STATIC_VOLUME) {
495 if (lnum < 0 || lnum >= vol->reserved_pebs) {
500 dbg_gen("erase LEB %d:%d", vol->vol_id, lnum);
501 err = ubi_eba_unmap_leb(ubi, vol, lnum);
505 err = ubi_wl_flush(ubi);
509 /* Logical eraseblock map command */
512 struct ubi_map_req req;
514 err = copy_from_user(&req, argp, sizeof(struct ubi_map_req));
519 err = ubi_leb_map(desc, req.lnum, req.dtype);
523 /* Logical eraseblock un-map command */
528 err = get_user(lnum, (__user int32_t *)argp);
533 err = ubi_leb_unmap(desc, lnum);
537 /* Check if logical eraseblock is mapped command */
542 err = get_user(lnum, (__user int32_t *)argp);
547 err = ubi_is_mapped(desc, lnum);
551 /* Set volume property command*/
554 struct ubi_set_prop_req req;
556 err = copy_from_user(&req, argp,
557 sizeof(struct ubi_set_prop_req));
562 switch (req.property) {
563 case UBI_PROP_DIRECT_WRITE:
564 mutex_lock(&ubi->volumes_mutex);
565 desc->vol->direct_writes = !!req.value;
566 mutex_unlock(&ubi->volumes_mutex);
583 * verify_mkvol_req - verify volume creation request.
584 * @ubi: UBI device description object
585 * @req: the request to check
587 * This function zero if the request is correct, and %-EINVAL if not.
589 static int verify_mkvol_req(const struct ubi_device *ubi,
590 const struct ubi_mkvol_req *req)
592 int n, err = -EINVAL;
594 if (req->bytes < 0 || req->alignment < 0 || req->vol_type < 0 ||
598 if ((req->vol_id < 0 || req->vol_id >= ubi->vtbl_slots) &&
599 req->vol_id != UBI_VOL_NUM_AUTO)
602 if (req->alignment == 0)
608 if (req->vol_type != UBI_DYNAMIC_VOLUME &&
609 req->vol_type != UBI_STATIC_VOLUME)
612 if (req->alignment > ubi->leb_size)
615 n = req->alignment & (ubi->min_io_size - 1);
616 if (req->alignment != 1 && n)
619 if (req->name_len > UBI_VOL_NAME_MAX) {
624 n = strnlen(req->name, req->name_len + 1);
625 if (n != req->name_len)
631 dbg_err("bad volume creation request");
632 ubi_dbg_dump_mkvol_req(req);
637 * verify_rsvol_req - verify volume re-size request.
638 * @ubi: UBI device description object
639 * @req: the request to check
641 * This function returns zero if the request is correct, and %-EINVAL if not.
643 static int verify_rsvol_req(const struct ubi_device *ubi,
644 const struct ubi_rsvol_req *req)
649 if (req->vol_id < 0 || req->vol_id >= ubi->vtbl_slots)
656 * rename_volumes - rename UBI volumes.
657 * @ubi: UBI device description object
658 * @req: volumes re-name request
660 * This is a helper function for the volume re-name IOCTL which validates the
661 * the request, opens the volume and calls corresponding volumes management
662 * function. Returns zero in case of success and a negative error code in case
665 static int rename_volumes(struct ubi_device *ubi,
666 struct ubi_rnvol_req *req)
669 struct list_head rename_list;
670 struct ubi_rename_entry *re, *re1;
672 if (req->count < 0 || req->count > UBI_MAX_RNVOL)
678 /* Validate volume IDs and names in the request */
679 for (i = 0; i < req->count; i++) {
680 if (req->ents[i].vol_id < 0 ||
681 req->ents[i].vol_id >= ubi->vtbl_slots)
683 if (req->ents[i].name_len < 0)
685 if (req->ents[i].name_len > UBI_VOL_NAME_MAX)
686 return -ENAMETOOLONG;
687 req->ents[i].name[req->ents[i].name_len] = '\0';
688 n = strlen(req->ents[i].name);
689 if (n != req->ents[i].name_len)
693 /* Make sure volume IDs and names are unique */
694 for (i = 0; i < req->count - 1; i++) {
695 for (n = i + 1; n < req->count; n++) {
696 if (req->ents[i].vol_id == req->ents[n].vol_id) {
697 dbg_err("duplicated volume id %d",
698 req->ents[i].vol_id);
701 if (!strcmp(req->ents[i].name, req->ents[n].name)) {
702 dbg_err("duplicated volume name \"%s\"",
709 /* Create the re-name list */
710 INIT_LIST_HEAD(&rename_list);
711 for (i = 0; i < req->count; i++) {
712 int vol_id = req->ents[i].vol_id;
713 int name_len = req->ents[i].name_len;
714 const char *name = req->ents[i].name;
716 re = kzalloc(sizeof(struct ubi_rename_entry), GFP_KERNEL);
722 re->desc = ubi_open_volume(ubi->ubi_num, vol_id, UBI_EXCLUSIVE);
723 if (IS_ERR(re->desc)) {
724 err = PTR_ERR(re->desc);
725 dbg_err("cannot open volume %d, error %d", vol_id, err);
730 /* Skip this re-naming if the name does not really change */
731 if (re->desc->vol->name_len == name_len &&
732 !memcmp(re->desc->vol->name, name, name_len)) {
733 ubi_close_volume(re->desc);
738 re->new_name_len = name_len;
739 memcpy(re->new_name, name, name_len);
740 list_add_tail(&re->list, &rename_list);
741 dbg_msg("will rename volume %d from \"%s\" to \"%s\"",
742 vol_id, re->desc->vol->name, name);
745 if (list_empty(&rename_list))
748 /* Find out the volumes which have to be removed */
749 list_for_each_entry(re, &rename_list, list) {
750 struct ubi_volume_desc *desc;
751 int no_remove_needed = 0;
754 * Volume @re->vol_id is going to be re-named to
755 * @re->new_name, while its current name is @name. If a volume
756 * with name @re->new_name currently exists, it has to be
757 * removed, unless it is also re-named in the request (@req).
759 list_for_each_entry(re1, &rename_list, list) {
760 if (re->new_name_len == re1->desc->vol->name_len &&
761 !memcmp(re->new_name, re1->desc->vol->name,
762 re1->desc->vol->name_len)) {
763 no_remove_needed = 1;
768 if (no_remove_needed)
772 * It seems we need to remove volume with name @re->new_name,
775 desc = ubi_open_volume_nm(ubi->ubi_num, re->new_name,
780 /* Re-naming into a non-existing volume name */
783 /* The volume exists but busy, or an error occurred */
784 dbg_err("cannot open volume \"%s\", error %d",
789 re = kzalloc(sizeof(struct ubi_rename_entry), GFP_KERNEL);
792 ubi_close_volume(desc);
798 list_add(&re->list, &rename_list);
799 dbg_msg("will remove volume %d, name \"%s\"",
800 re->desc->vol->vol_id, re->desc->vol->name);
803 mutex_lock(&ubi->volumes_mutex);
804 err = ubi_rename_volumes(ubi, &rename_list);
805 mutex_unlock(&ubi->volumes_mutex);
808 list_for_each_entry_safe(re, re1, &rename_list, list) {
809 ubi_close_volume(re->desc);
816 static long ubi_cdev_ioctl(struct file *file, unsigned int cmd,
820 struct ubi_device *ubi;
821 struct ubi_volume_desc *desc;
822 void __user *argp = (void __user *)arg;
824 if (!capable(CAP_SYS_RESOURCE))
827 ubi = ubi_get_by_major(imajor(file->f_mapping->host));
832 /* Create volume command */
835 struct ubi_mkvol_req req;
837 dbg_gen("create volume");
838 err = copy_from_user(&req, argp, sizeof(struct ubi_mkvol_req));
844 req.name[req.name_len] = '\0';
845 err = verify_mkvol_req(ubi, &req);
849 mutex_lock(&ubi->volumes_mutex);
850 err = ubi_create_volume(ubi, &req);
851 mutex_unlock(&ubi->volumes_mutex);
855 err = put_user(req.vol_id, (__user int32_t *)argp);
862 /* Remove volume command */
867 dbg_gen("remove volume");
868 err = get_user(vol_id, (__user int32_t *)argp);
874 desc = ubi_open_volume(ubi->ubi_num, vol_id, UBI_EXCLUSIVE);
880 mutex_lock(&ubi->volumes_mutex);
881 err = ubi_remove_volume(desc, 0);
882 mutex_unlock(&ubi->volumes_mutex);
885 * The volume is deleted (unless an error occurred), and the
886 * 'struct ubi_volume' object will be freed when
887 * 'ubi_close_volume()' will call 'put_device()'.
889 ubi_close_volume(desc);
893 /* Re-size volume command */
897 struct ubi_rsvol_req req;
899 dbg_gen("re-size volume");
900 err = copy_from_user(&req, argp, sizeof(struct ubi_rsvol_req));
906 err = verify_rsvol_req(ubi, &req);
910 desc = ubi_open_volume(ubi->ubi_num, req.vol_id, UBI_EXCLUSIVE);
916 pebs = div_u64(req.bytes + desc->vol->usable_leb_size - 1,
917 desc->vol->usable_leb_size);
919 mutex_lock(&ubi->volumes_mutex);
920 err = ubi_resize_volume(desc, pebs);
921 mutex_unlock(&ubi->volumes_mutex);
922 ubi_close_volume(desc);
926 /* Re-name volumes command */
929 struct ubi_rnvol_req *req;
931 dbg_msg("re-name volumes");
932 req = kmalloc(sizeof(struct ubi_rnvol_req), GFP_KERNEL);
938 err = copy_from_user(req, argp, sizeof(struct ubi_rnvol_req));
945 mutex_lock(&ubi->mult_mutex);
946 err = rename_volumes(ubi, req);
947 mutex_unlock(&ubi->mult_mutex);
961 static long ctrl_cdev_ioctl(struct file *file, unsigned int cmd,
965 void __user *argp = (void __user *)arg;
967 if (!capable(CAP_SYS_RESOURCE))
971 /* Attach an MTD device command */
974 struct ubi_attach_req req;
975 struct mtd_info *mtd;
977 dbg_gen("attach MTD device");
978 err = copy_from_user(&req, argp, sizeof(struct ubi_attach_req));
984 if (req.mtd_num < 0 ||
985 (req.ubi_num < 0 && req.ubi_num != UBI_DEV_NUM_AUTO)) {
990 mtd = get_mtd_device(NULL, req.mtd_num);
997 * Note, further request verification is done by
998 * 'ubi_attach_mtd_dev()'.
1000 mutex_lock(&ubi_devices_mutex);
1001 err = ubi_attach_mtd_dev(mtd, req.ubi_num, req.vid_hdr_offset);
1002 mutex_unlock(&ubi_devices_mutex);
1004 put_mtd_device(mtd);
1006 /* @err contains UBI device number */
1007 err = put_user(err, (__user int32_t *)argp);
1012 /* Detach an MTD device command */
1017 dbg_gen("dettach MTD device");
1018 err = get_user(ubi_num, (__user int32_t *)argp);
1024 mutex_lock(&ubi_devices_mutex);
1025 err = ubi_detach_mtd_dev(ubi_num, 0);
1026 mutex_unlock(&ubi_devices_mutex);
1038 #ifdef CONFIG_COMPAT
1039 static long vol_cdev_compat_ioctl(struct file *file, unsigned int cmd,
1042 unsigned long translated_arg = (unsigned long)compat_ptr(arg);
1044 return vol_cdev_ioctl(file, cmd, translated_arg);
1047 static long ubi_cdev_compat_ioctl(struct file *file, unsigned int cmd,
1050 unsigned long translated_arg = (unsigned long)compat_ptr(arg);
1052 return ubi_cdev_ioctl(file, cmd, translated_arg);
1055 static long ctrl_cdev_compat_ioctl(struct file *file, unsigned int cmd,
1058 unsigned long translated_arg = (unsigned long)compat_ptr(arg);
1060 return ctrl_cdev_ioctl(file, cmd, translated_arg);
1063 #define vol_cdev_compat_ioctl NULL
1064 #define ubi_cdev_compat_ioctl NULL
1065 #define ctrl_cdev_compat_ioctl NULL
1068 /* UBI volume character device operations */
1069 const struct file_operations ubi_vol_cdev_operations = {
1070 .owner = THIS_MODULE,
1071 .open = vol_cdev_open,
1072 .release = vol_cdev_release,
1073 .llseek = vol_cdev_llseek,
1074 .read = vol_cdev_read,
1075 .write = vol_cdev_write,
1076 .unlocked_ioctl = vol_cdev_ioctl,
1077 .compat_ioctl = vol_cdev_compat_ioctl,
1080 /* UBI character device operations */
1081 const struct file_operations ubi_cdev_operations = {
1082 .owner = THIS_MODULE,
1083 .llseek = no_llseek,
1084 .unlocked_ioctl = ubi_cdev_ioctl,
1085 .compat_ioctl = ubi_cdev_compat_ioctl,
1088 /* UBI control character device operations */
1089 const struct file_operations ubi_ctrl_cdev_operations = {
1090 .owner = THIS_MODULE,
1091 .unlocked_ioctl = ctrl_cdev_ioctl,
1092 .compat_ioctl = ctrl_cdev_compat_ioctl,