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 <mtd/ubi-user.h>
43 #include <asm/uaccess.h>
44 #include <asm/div64.h>
48 * get_exclusive - get exclusive access to an UBI volume.
49 * @desc: volume descriptor
51 * This function changes UBI volume open mode to "exclusive". Returns previous
52 * mode value (positive integer) in case of success and a negative error code
55 static int get_exclusive(struct ubi_volume_desc
*desc
)
58 struct ubi_volume
*vol
= desc
->vol
;
60 spin_lock(&vol
->ubi
->volumes_lock
);
61 users
= vol
->readers
+ vol
->writers
+ vol
->exclusive
;
62 ubi_assert(users
> 0);
64 dbg_err("%d users for volume %d", users
, vol
->vol_id
);
67 vol
->readers
= vol
->writers
= 0;
70 desc
->mode
= UBI_EXCLUSIVE
;
72 spin_unlock(&vol
->ubi
->volumes_lock
);
78 * revoke_exclusive - revoke exclusive mode.
79 * @desc: volume descriptor
80 * @mode: new mode to switch to
82 static void revoke_exclusive(struct ubi_volume_desc
*desc
, int mode
)
84 struct ubi_volume
*vol
= desc
->vol
;
86 spin_lock(&vol
->ubi
->volumes_lock
);
87 ubi_assert(vol
->readers
== 0 && vol
->writers
== 0);
88 ubi_assert(vol
->exclusive
== 1 && desc
->mode
== UBI_EXCLUSIVE
);
90 if (mode
== UBI_READONLY
)
92 else if (mode
== UBI_READWRITE
)
96 spin_unlock(&vol
->ubi
->volumes_lock
);
101 static int vol_cdev_open(struct inode
*inode
, struct file
*file
)
103 struct ubi_volume_desc
*desc
;
104 int vol_id
= iminor(inode
) - 1, mode
, ubi_num
;
106 ubi_num
= ubi_major2num(imajor(inode
));
110 if (file
->f_mode
& FMODE_WRITE
)
111 mode
= UBI_READWRITE
;
115 dbg_msg("open volume %d, mode %d", vol_id
, mode
);
117 desc
= ubi_open_volume(ubi_num
, vol_id
, mode
);
119 return PTR_ERR(desc
);
121 file
->private_data
= desc
;
125 static int vol_cdev_release(struct inode
*inode
, struct file
*file
)
127 struct ubi_volume_desc
*desc
= file
->private_data
;
128 struct ubi_volume
*vol
= desc
->vol
;
130 dbg_msg("release volume %d, mode %d", vol
->vol_id
, desc
->mode
);
133 ubi_warn("update of volume %d not finished, volume is damaged",
135 ubi_assert(!vol
->changing_leb
);
138 } else if (vol
->changing_leb
) {
139 dbg_msg("only %lld of %lld bytes received for atomic LEB change"
140 " for volume %d:%d, cancel", vol
->upd_received
,
141 vol
->upd_bytes
, vol
->ubi
->ubi_num
, vol
->vol_id
);
142 vol
->changing_leb
= 0;
146 ubi_close_volume(desc
);
150 static loff_t
vol_cdev_llseek(struct file
*file
, loff_t offset
, int origin
)
152 struct ubi_volume_desc
*desc
= file
->private_data
;
153 struct ubi_volume
*vol
= desc
->vol
;
157 /* Update is in progress, seeking is prohibited */
163 case 0: /* SEEK_SET */
166 case 1: /* SEEK_CUR */
167 new_offset
= file
->f_pos
+ offset
;
169 case 2: /* SEEK_END */
170 new_offset
= vol
->used_bytes
+ offset
;
176 if (new_offset
< 0 || new_offset
> vol
->used_bytes
) {
177 dbg_err("bad seek %lld", new_offset
);
181 dbg_msg("seek volume %d, offset %lld, origin %d, new offset %lld",
182 vol
->vol_id
, offset
, origin
, new_offset
);
184 file
->f_pos
= new_offset
;
188 static ssize_t
vol_cdev_read(struct file
*file
, __user
char *buf
, size_t count
,
191 struct ubi_volume_desc
*desc
= file
->private_data
;
192 struct ubi_volume
*vol
= desc
->vol
;
193 struct ubi_device
*ubi
= vol
->ubi
;
194 int err
, lnum
, off
, len
, tbuf_size
;
195 size_t count_save
= count
;
199 dbg_msg("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_msg("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
;
229 off
= do_div(tmp
, vol
->usable_leb_size
);
235 if (off
+ len
>= vol
->usable_leb_size
)
236 len
= vol
->usable_leb_size
- off
;
238 err
= ubi_eba_read_leb(ubi
, vol
, lnum
, tbuf
, off
, len
, 0);
243 if (off
== vol
->usable_leb_size
) {
245 off
-= vol
->usable_leb_size
;
251 err
= copy_to_user(buf
, tbuf
, len
);
258 len
= count
> tbuf_size
? tbuf_size
: count
;
262 return err
? err
: count_save
- count
;
265 #ifdef CONFIG_MTD_UBI_DEBUG_USERSPACE_IO
268 * This function allows to directly write to dynamic UBI volumes, without
269 * issuing the volume update operation. Available only as a debugging feature.
270 * Very useful for testing UBI.
272 static ssize_t
vol_cdev_direct_write(struct file
*file
, const char __user
*buf
,
273 size_t count
, loff_t
*offp
)
275 struct ubi_volume_desc
*desc
= file
->private_data
;
276 struct ubi_volume
*vol
= desc
->vol
;
277 struct ubi_device
*ubi
= vol
->ubi
;
278 int lnum
, off
, len
, tbuf_size
, err
= 0;
279 size_t count_save
= count
;
283 dbg_msg("requested: write %zd bytes to offset %lld of volume %u",
284 count
, *offp
, vol
->vol_id
);
286 if (vol
->vol_type
== UBI_STATIC_VOLUME
)
290 off
= do_div(tmp
, vol
->usable_leb_size
);
293 if (off
% ubi
->min_io_size
) {
294 dbg_err("unaligned position");
298 if (*offp
+ count
> vol
->used_bytes
)
299 count_save
= count
= vol
->used_bytes
- *offp
;
301 /* We can write only in fractions of the minimum I/O unit */
302 if (count
% ubi
->min_io_size
) {
303 dbg_err("unaligned write length");
307 tbuf_size
= vol
->usable_leb_size
;
308 if (count
< tbuf_size
)
309 tbuf_size
= ALIGN(count
, ubi
->min_io_size
);
310 tbuf
= vmalloc(tbuf_size
);
314 len
= count
> tbuf_size
? tbuf_size
: count
;
319 if (off
+ len
>= vol
->usable_leb_size
)
320 len
= vol
->usable_leb_size
- off
;
322 err
= copy_from_user(tbuf
, buf
, len
);
328 err
= ubi_eba_write_leb(ubi
, vol
, lnum
, tbuf
, off
, len
,
334 if (off
== vol
->usable_leb_size
) {
336 off
-= vol
->usable_leb_size
;
342 len
= count
> tbuf_size
? tbuf_size
: count
;
346 return err
? err
: count_save
- count
;
350 #define vol_cdev_direct_write(file, buf, count, offp) -EPERM
351 #endif /* CONFIG_MTD_UBI_DEBUG_USERSPACE_IO */
353 static ssize_t
vol_cdev_write(struct file
*file
, const char __user
*buf
,
354 size_t count
, loff_t
*offp
)
357 struct ubi_volume_desc
*desc
= file
->private_data
;
358 struct ubi_volume
*vol
= desc
->vol
;
359 struct ubi_device
*ubi
= vol
->ubi
;
361 if (!vol
->updating
&& !vol
->changing_leb
)
362 return vol_cdev_direct_write(file
, buf
, count
, offp
);
365 err
= ubi_more_update_data(ubi
, vol
, buf
, count
);
367 err
= ubi_more_leb_change_data(ubi
, vol
, buf
, count
);
370 ubi_err("cannot accept more %zd bytes of data, error %d",
377 * The operation is finished, @err contains number of actually
382 if (vol
->changing_leb
) {
383 revoke_exclusive(desc
, UBI_READWRITE
);
387 err
= ubi_check_volume(ubi
, vol
->vol_id
);
392 ubi_warn("volume %d on UBI device %d is corrupted",
393 vol
->vol_id
, ubi
->ubi_num
);
397 ubi_gluebi_updated(vol
);
398 revoke_exclusive(desc
, UBI_READWRITE
);
404 static int vol_cdev_ioctl(struct inode
*inode
, struct file
*file
,
405 unsigned int cmd
, unsigned long arg
)
408 struct ubi_volume_desc
*desc
= file
->private_data
;
409 struct ubi_volume
*vol
= desc
->vol
;
410 struct ubi_device
*ubi
= vol
->ubi
;
411 void __user
*argp
= (void __user
*)arg
;
414 /* Volume update command */
417 int64_t bytes
, rsvd_bytes
;
419 if (!capable(CAP_SYS_RESOURCE
)) {
424 err
= copy_from_user(&bytes
, argp
, sizeof(int64_t));
430 if (desc
->mode
== UBI_READONLY
) {
435 rsvd_bytes
= vol
->reserved_pebs
* (ubi
->leb_size
-vol
->data_pad
);
436 if (bytes
< 0 || bytes
> rsvd_bytes
) {
441 err
= get_exclusive(desc
);
445 err
= ubi_start_update(ubi
, vol
, bytes
);
447 revoke_exclusive(desc
, UBI_READWRITE
);
451 /* Atomic logical eraseblock change command */
454 struct ubi_leb_change_req req
;
456 err
= copy_from_user(&req
, argp
,
457 sizeof(struct ubi_leb_change_req
));
463 if (desc
->mode
== UBI_READONLY
||
464 vol
->vol_type
== UBI_STATIC_VOLUME
) {
469 /* Validate the request */
471 if (req
.lnum
< 0 || req
.lnum
>= vol
->reserved_pebs
||
472 req
.bytes
< 0 || req
.lnum
>= vol
->usable_leb_size
)
474 if (req
.dtype
!= UBI_LONGTERM
&& req
.dtype
!= UBI_SHORTTERM
&&
475 req
.dtype
!= UBI_UNKNOWN
)
478 err
= get_exclusive(desc
);
482 err
= ubi_start_leb_change(ubi
, vol
, &req
);
484 revoke_exclusive(desc
, UBI_READWRITE
);
488 #ifdef CONFIG_MTD_UBI_DEBUG_USERSPACE_IO
489 /* Logical eraseblock erasure command */
494 err
= get_user(lnum
, (__user
int32_t *)argp
);
500 if (desc
->mode
== UBI_READONLY
||
501 vol
->vol_type
== UBI_STATIC_VOLUME
) {
506 if (lnum
< 0 || lnum
>= vol
->reserved_pebs
) {
511 dbg_msg("erase LEB %d:%d", vol
->vol_id
, lnum
);
512 err
= ubi_eba_unmap_leb(ubi
, vol
, lnum
);
516 err
= ubi_wl_flush(ubi
);
530 * verify_mkvol_req - verify volume creation request.
531 * @ubi: UBI device description object
532 * @req: the request to check
534 * This function zero if the request is correct, and %-EINVAL if not.
536 static int verify_mkvol_req(const struct ubi_device
*ubi
,
537 const struct ubi_mkvol_req
*req
)
539 int n
, err
= -EINVAL
;
541 if (req
->bytes
< 0 || req
->alignment
< 0 || req
->vol_type
< 0 ||
545 if ((req
->vol_id
< 0 || req
->vol_id
>= ubi
->vtbl_slots
) &&
546 req
->vol_id
!= UBI_VOL_NUM_AUTO
)
549 if (req
->alignment
== 0)
555 if (req
->vol_type
!= UBI_DYNAMIC_VOLUME
&&
556 req
->vol_type
!= UBI_STATIC_VOLUME
)
559 if (req
->alignment
> ubi
->leb_size
)
562 n
= req
->alignment
% ubi
->min_io_size
;
563 if (req
->alignment
!= 1 && n
)
566 if (req
->name_len
> UBI_VOL_NAME_MAX
) {
574 dbg_err("bad volume creation request");
575 ubi_dbg_dump_mkvol_req(req
);
580 * verify_rsvol_req - verify volume re-size request.
581 * @ubi: UBI device description object
582 * @req: the request to check
584 * This function returns zero if the request is correct, and %-EINVAL if not.
586 static int verify_rsvol_req(const struct ubi_device
*ubi
,
587 const struct ubi_rsvol_req
*req
)
592 if (req
->vol_id
< 0 || req
->vol_id
>= ubi
->vtbl_slots
)
598 static int ubi_cdev_ioctl(struct inode
*inode
, struct file
*file
,
599 unsigned int cmd
, unsigned long arg
)
602 struct ubi_device
*ubi
;
603 struct ubi_volume_desc
*desc
;
604 void __user
*argp
= (void __user
*)arg
;
606 if (!capable(CAP_SYS_RESOURCE
))
609 ubi
= ubi_get_by_major(imajor(inode
));
614 /* Create volume command */
617 struct ubi_mkvol_req req
;
619 dbg_msg("create volume");
620 err
= copy_from_user(&req
, argp
, sizeof(struct ubi_mkvol_req
));
626 err
= verify_mkvol_req(ubi
, &req
);
630 req
.name
[req
.name_len
] = '\0';
632 mutex_lock(&ubi
->volumes_mutex
);
633 err
= ubi_create_volume(ubi
, &req
);
634 mutex_unlock(&ubi
->volumes_mutex
);
638 err
= put_user(req
.vol_id
, (__user
int32_t *)argp
);
645 /* Remove volume command */
650 dbg_msg("remove volume");
651 err
= get_user(vol_id
, (__user
int32_t *)argp
);
657 desc
= ubi_open_volume(ubi
->ubi_num
, vol_id
, UBI_EXCLUSIVE
);
663 mutex_lock(&ubi
->volumes_mutex
);
664 err
= ubi_remove_volume(desc
);
665 mutex_unlock(&ubi
->volumes_mutex
);
668 * The volume is deleted (unless an error occurred), and the
669 * 'struct ubi_volume' object will be freed when
670 * 'ubi_close_volume()' will call 'put_device()'.
672 ubi_close_volume(desc
);
676 /* Re-size volume command */
681 struct ubi_rsvol_req req
;
683 dbg_msg("re-size volume");
684 err
= copy_from_user(&req
, argp
, sizeof(struct ubi_rsvol_req
));
690 err
= verify_rsvol_req(ubi
, &req
);
694 desc
= ubi_open_volume(ubi
->ubi_num
, req
.vol_id
, UBI_EXCLUSIVE
);
701 pebs
= !!do_div(tmp
, desc
->vol
->usable_leb_size
);
704 mutex_lock(&ubi
->volumes_mutex
);
705 err
= ubi_resize_volume(desc
, pebs
);
706 mutex_unlock(&ubi
->volumes_mutex
);
707 ubi_close_volume(desc
);
720 static int ctrl_cdev_ioctl(struct inode
*inode
, struct file
*file
,
721 unsigned int cmd
, unsigned long arg
)
724 void __user
*argp
= (void __user
*)arg
;
726 if (!capable(CAP_SYS_RESOURCE
))
730 /* Attach an MTD device command */
733 struct ubi_attach_req req
;
734 struct mtd_info
*mtd
;
736 dbg_msg("attach MTD device");
737 err
= copy_from_user(&req
, argp
, sizeof(struct ubi_attach_req
));
743 if (req
.mtd_num
< 0 ||
744 (req
.ubi_num
< 0 && req
.ubi_num
!= UBI_DEV_NUM_AUTO
)) {
749 mtd
= get_mtd_device(NULL
, req
.mtd_num
);
756 * Note, further request verification is done by
757 * 'ubi_attach_mtd_dev()'.
759 mutex_lock(&ubi_devices_mutex
);
760 err
= ubi_attach_mtd_dev(mtd
, req
.ubi_num
, req
.vid_hdr_offset
);
761 mutex_unlock(&ubi_devices_mutex
);
765 /* @err contains UBI device number */
766 err
= put_user(err
, (__user
int32_t *)argp
);
771 /* Detach an MTD device command */
776 dbg_msg("dettach MTD device");
777 err
= get_user(ubi_num
, (__user
int32_t *)argp
);
783 mutex_lock(&ubi_devices_mutex
);
784 err
= ubi_detach_mtd_dev(ubi_num
, 0);
785 mutex_unlock(&ubi_devices_mutex
);
797 /* UBI control character device operations */
798 struct file_operations ubi_ctrl_cdev_operations
= {
799 .ioctl
= ctrl_cdev_ioctl
,
800 .owner
= THIS_MODULE
,
803 /* UBI character device operations */
804 struct file_operations ubi_cdev_operations
= {
805 .owner
= THIS_MODULE
,
806 .ioctl
= ubi_cdev_ioctl
,
810 /* UBI volume character device operations */
811 struct file_operations ubi_vol_cdev_operations
= {
812 .owner
= THIS_MODULE
,
813 .open
= vol_cdev_open
,
814 .release
= vol_cdev_release
,
815 .llseek
= vol_cdev_llseek
,
816 .read
= vol_cdev_read
,
817 .write
= vol_cdev_write
,
818 .ioctl
= vol_cdev_ioctl
,