blob: c501eec17b387adf38f060cbc3bfa6c77840d979 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
David Woodhousea1452a32010-08-08 20:58:20 +01002 * Copyright © 1999-2010 David Woodhouse <dwmw2@infradead.org>
3 *
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.
8 *
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 the
12 * GNU General Public License for more details.
13 *
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., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Linus Torvalds1da177e2005-04-16 15:20:36 -070017 *
18 */
19
Thomas Gleixner15fdc522005-11-07 00:14:42 +010020#include <linux/device.h>
21#include <linux/fs.h>
Andrew Morton0c1eafd2007-08-10 13:01:06 -070022#include <linux/mm.h>
Artem Bityutskiy9c740342006-10-11 14:52:47 +030023#include <linux/err.h>
Thomas Gleixner15fdc522005-11-07 00:14:42 +010024#include <linux/init.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070025#include <linux/kernel.h>
26#include <linux/module.h>
Thomas Gleixner15fdc522005-11-07 00:14:42 +010027#include <linux/slab.h>
28#include <linux/sched.h>
Arnd Bergmann5aa82942010-06-02 14:28:52 +020029#include <linux/mutex.h>
David Howells402d3262009-02-12 10:40:00 +000030#include <linux/backing-dev.h>
Kevin Cernekee97718542009-04-08 22:53:13 -070031#include <linux/compat.h>
Kirill A. Shutemovcd874232010-05-17 16:55:47 +030032#include <linux/mount.h>
Roman Tereshonkovd0f79592010-09-17 13:31:42 +030033#include <linux/blkpg.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070034#include <linux/mtd/mtd.h>
Roman Tereshonkovd0f79592010-09-17 13:31:42 +030035#include <linux/mtd/partitions.h>
Anatolij Gustschindd02b672010-06-15 09:30:15 +020036#include <linux/mtd/map.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070037
Thomas Gleixner15fdc522005-11-07 00:14:42 +010038#include <asm/uaccess.h>
Todd Poynor9bc7b382005-06-30 01:23:27 +010039
Kirill A. Shutemovcd874232010-05-17 16:55:47 +030040#define MTD_INODE_FS_MAGIC 0x11307854
Arnd Bergmann5aa82942010-06-02 14:28:52 +020041static DEFINE_MUTEX(mtd_mutex);
Kirill A. Shutemovcd874232010-05-17 16:55:47 +030042static struct vfsmount *mtd_inode_mnt __read_mostly;
Linus Torvalds1da177e2005-04-16 15:20:36 -070043
Nicolas Pitre045e9a52005-02-08 19:12:53 +000044/*
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +020045 * Data structure to hold the pointer to the mtd device as well
Brian Norris92394b52011-07-20 09:53:42 -070046 * as mode information of various use cases.
Nicolas Pitre045e9a52005-02-08 19:12:53 +000047 */
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +020048struct mtd_file_info {
49 struct mtd_info *mtd;
Kirill A. Shutemovcd874232010-05-17 16:55:47 +030050 struct inode *ino;
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +020051 enum mtd_file_modes mode;
52};
Nicolas Pitre31f42332005-02-08 17:45:55 +000053
Artem Bityutskiy969e57a2011-12-23 17:27:46 +020054static loff_t mtdchar_lseek(struct file *file, loff_t offset, int orig)
Linus Torvalds1da177e2005-04-16 15:20:36 -070055{
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +020056 struct mtd_file_info *mfi = file->private_data;
57 struct mtd_info *mtd = mfi->mtd;
Linus Torvalds1da177e2005-04-16 15:20:36 -070058
59 switch (orig) {
Josef 'Jeff' Sipekea598302006-09-16 21:09:29 -040060 case SEEK_SET:
Linus Torvalds1da177e2005-04-16 15:20:36 -070061 break;
Josef 'Jeff' Sipekea598302006-09-16 21:09:29 -040062 case SEEK_CUR:
Todd Poynor8b491d72005-08-04 02:05:51 +010063 offset += file->f_pos;
Linus Torvalds1da177e2005-04-16 15:20:36 -070064 break;
Josef 'Jeff' Sipekea598302006-09-16 21:09:29 -040065 case SEEK_END:
Todd Poynor8b491d72005-08-04 02:05:51 +010066 offset += mtd->size;
Linus Torvalds1da177e2005-04-16 15:20:36 -070067 break;
68 default:
69 return -EINVAL;
70 }
71
Herbert Valerio Riedel1887f512006-06-24 00:03:36 +020072 if (offset >= 0 && offset <= mtd->size)
Todd Poynor8b491d72005-08-04 02:05:51 +010073 return file->f_pos = offset;
Linus Torvalds1da177e2005-04-16 15:20:36 -070074
Todd Poynor8b491d72005-08-04 02:05:51 +010075 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -070076}
77
78
79
Artem Bityutskiy969e57a2011-12-23 17:27:46 +020080static int mtdchar_open(struct inode *inode, struct file *file)
Linus Torvalds1da177e2005-04-16 15:20:36 -070081{
82 int minor = iminor(inode);
83 int devnum = minor >> 1;
Jonathan Corbet60712392008-05-15 10:10:37 -060084 int ret = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -070085 struct mtd_info *mtd;
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +020086 struct mtd_file_info *mfi;
Kirill A. Shutemovcd874232010-05-17 16:55:47 +030087 struct inode *mtd_ino;
Linus Torvalds1da177e2005-04-16 15:20:36 -070088
Brian Norris289c0522011-07-19 10:06:09 -070089 pr_debug("MTD_open\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -070090
Linus Torvalds1da177e2005-04-16 15:20:36 -070091 /* You can't open the RO devices RW */
Al Viroaeb5d722008-09-02 15:28:45 -040092 if ((file->f_mode & FMODE_WRITE) && (minor & 1))
Linus Torvalds1da177e2005-04-16 15:20:36 -070093 return -EACCES;
94
Arnd Bergmann5aa82942010-06-02 14:28:52 +020095 mutex_lock(&mtd_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -070096 mtd = get_mtd_device(NULL, devnum);
Thomas Gleixner97894cd2005-11-07 11:15:26 +000097
Jonathan Corbet60712392008-05-15 10:10:37 -060098 if (IS_ERR(mtd)) {
99 ret = PTR_ERR(mtd);
100 goto out;
101 }
Thomas Gleixner97894cd2005-11-07 11:15:26 +0000102
David Howells402d3262009-02-12 10:40:00 +0000103 if (mtd->type == MTD_ABSENT) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700104 put_mtd_device(mtd);
Jonathan Corbet60712392008-05-15 10:10:37 -0600105 ret = -ENODEV;
106 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700107 }
108
Kirill A. Shutemovcd874232010-05-17 16:55:47 +0300109 mtd_ino = iget_locked(mtd_inode_mnt->mnt_sb, devnum);
110 if (!mtd_ino) {
111 put_mtd_device(mtd);
112 ret = -ENOMEM;
113 goto out;
114 }
115 if (mtd_ino->i_state & I_NEW) {
116 mtd_ino->i_private = mtd;
117 mtd_ino->i_mode = S_IFCHR;
118 mtd_ino->i_data.backing_dev_info = mtd->backing_dev_info;
119 unlock_new_inode(mtd_ino);
120 }
121 file->f_mapping = mtd_ino->i_mapping;
David Howells402d3262009-02-12 10:40:00 +0000122
Linus Torvalds1da177e2005-04-16 15:20:36 -0700123 /* You can't open it RW if it's not a writeable device */
Al Viroaeb5d722008-09-02 15:28:45 -0400124 if ((file->f_mode & FMODE_WRITE) && !(mtd->flags & MTD_WRITEABLE)) {
Kirill A. Shutemovcd874232010-05-17 16:55:47 +0300125 iput(mtd_ino);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700126 put_mtd_device(mtd);
Jonathan Corbet60712392008-05-15 10:10:37 -0600127 ret = -EACCES;
128 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700129 }
Thomas Gleixner97894cd2005-11-07 11:15:26 +0000130
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200131 mfi = kzalloc(sizeof(*mfi), GFP_KERNEL);
132 if (!mfi) {
Kirill A. Shutemovcd874232010-05-17 16:55:47 +0300133 iput(mtd_ino);
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200134 put_mtd_device(mtd);
Jonathan Corbet60712392008-05-15 10:10:37 -0600135 ret = -ENOMEM;
136 goto out;
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200137 }
Kirill A. Shutemovcd874232010-05-17 16:55:47 +0300138 mfi->ino = mtd_ino;
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200139 mfi->mtd = mtd;
140 file->private_data = mfi;
141
Jonathan Corbet60712392008-05-15 10:10:37 -0600142out:
Arnd Bergmann5aa82942010-06-02 14:28:52 +0200143 mutex_unlock(&mtd_mutex);
Jonathan Corbet60712392008-05-15 10:10:37 -0600144 return ret;
Artem Bityutskiy969e57a2011-12-23 17:27:46 +0200145} /* mtdchar_open */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700146
147/*====================================================================*/
148
Artem Bityutskiy969e57a2011-12-23 17:27:46 +0200149static int mtdchar_close(struct inode *inode, struct file *file)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700150{
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200151 struct mtd_file_info *mfi = file->private_data;
152 struct mtd_info *mtd = mfi->mtd;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700153
Brian Norris289c0522011-07-19 10:06:09 -0700154 pr_debug("MTD_close\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700155
Joakim Tjernlund7eafaed2007-06-27 00:56:40 +0200156 /* Only sync if opened RW */
Al Viroaeb5d722008-09-02 15:28:45 -0400157 if ((file->f_mode & FMODE_WRITE) && mtd->sync)
Artem Bityutskiy85f2f2a2011-12-23 19:03:12 +0200158 mtd_sync(mtd);
Thomas Gleixner97894cd2005-11-07 11:15:26 +0000159
Kirill A. Shutemovcd874232010-05-17 16:55:47 +0300160 iput(mfi->ino);
161
Linus Torvalds1da177e2005-04-16 15:20:36 -0700162 put_mtd_device(mtd);
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200163 file->private_data = NULL;
164 kfree(mfi);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700165
166 return 0;
Artem Bityutskiy969e57a2011-12-23 17:27:46 +0200167} /* mtdchar_close */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700168
Grant Erickson3e45cf52011-04-08 08:51:33 -0700169/* Back in June 2001, dwmw2 wrote:
170 *
171 * FIXME: This _really_ needs to die. In 2.5, we should lock the
172 * userspace buffer down and use it directly with readv/writev.
173 *
174 * The implementation below, using mtd_kmalloc_up_to, mitigates
175 * allocation failures when the system is under low-memory situations
176 * or if memory is highly fragmented at the cost of reducing the
177 * performance of the requested transfer due to a smaller buffer size.
178 *
179 * A more complex but more memory-efficient implementation based on
180 * get_user_pages and iovecs to cover extents of those pages is a
181 * longer-term goal, as intimated by dwmw2 above. However, for the
182 * write case, this requires yet more complex head and tail transfer
183 * handling when those head and tail offsets and sizes are such that
184 * alignment requirements are not met in the NAND subdriver.
185 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700186
Artem Bityutskiy969e57a2011-12-23 17:27:46 +0200187static ssize_t mtdchar_read(struct file *file, char __user *buf, size_t count,
188 loff_t *ppos)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700189{
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200190 struct mtd_file_info *mfi = file->private_data;
191 struct mtd_info *mtd = mfi->mtd;
Artem Bityutskiy30fa9842011-12-29 15:16:28 +0200192 size_t retlen;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700193 size_t total_retlen=0;
194 int ret=0;
195 int len;
Grant Erickson3e45cf52011-04-08 08:51:33 -0700196 size_t size = count;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700197 char *kbuf;
Thomas Gleixner97894cd2005-11-07 11:15:26 +0000198
Brian Norris289c0522011-07-19 10:06:09 -0700199 pr_debug("MTD_read\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700200
201 if (*ppos + count > mtd->size)
202 count = mtd->size - *ppos;
203
204 if (!count)
205 return 0;
Thomas Gleixner97894cd2005-11-07 11:15:26 +0000206
Grant Erickson3e45cf52011-04-08 08:51:33 -0700207 kbuf = mtd_kmalloc_up_to(mtd, &size);
Thago Galesib802c072006-04-17 17:38:15 +0100208 if (!kbuf)
209 return -ENOMEM;
210
Linus Torvalds1da177e2005-04-16 15:20:36 -0700211 while (count) {
Grant Erickson3e45cf52011-04-08 08:51:33 -0700212 len = min_t(size_t, count, size);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700213
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200214 switch (mfi->mode) {
Brian Norrisbeb133f2011-08-30 18:45:41 -0700215 case MTD_FILE_MODE_OTP_FACTORY:
Artem Bityutskiyd264f722011-12-23 18:40:06 +0200216 ret = mtd_read_fact_prot_reg(mtd, *ppos, len,
217 &retlen, kbuf);
Nicolas Pitre31f42332005-02-08 17:45:55 +0000218 break;
Brian Norrisbeb133f2011-08-30 18:45:41 -0700219 case MTD_FILE_MODE_OTP_USER:
Artem Bityutskiy4ea1cab2011-12-23 18:47:59 +0200220 ret = mtd_read_user_prot_reg(mtd, *ppos, len,
221 &retlen, kbuf);
Nicolas Pitre31f42332005-02-08 17:45:55 +0000222 break;
Brian Norrisbeb133f2011-08-30 18:45:41 -0700223 case MTD_FILE_MODE_RAW:
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200224 {
225 struct mtd_oob_ops ops;
226
Brian Norris0612b9d2011-08-30 18:45:40 -0700227 ops.mode = MTD_OPS_RAW;
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200228 ops.datbuf = kbuf;
229 ops.oobbuf = NULL;
230 ops.len = len;
231
Artem Bityutskiyfd2819b2011-12-23 18:27:05 +0200232 ret = mtd_read_oob(mtd, *ppos, &ops);
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200233 retlen = ops.retlen;
234 break;
235 }
Nicolas Pitre31f42332005-02-08 17:45:55 +0000236 default:
Artem Bityutskiy329ad392011-12-23 17:30:16 +0200237 ret = mtd_read(mtd, *ppos, len, &retlen, kbuf);
Nicolas Pitre31f42332005-02-08 17:45:55 +0000238 }
Brian Norris7854d3f2011-06-23 14:12:08 -0700239 /* Nand returns -EBADMSG on ECC errors, but it returns
Linus Torvalds1da177e2005-04-16 15:20:36 -0700240 * the data. For our userspace tools it is important
Brian Norris7854d3f2011-06-23 14:12:08 -0700241 * to dump areas with ECC errors!
Thomas Gleixner9a1fcdf2006-05-29 14:56:39 +0200242 * For kernel internal usage it also might return -EUCLEAN
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300243 * to signal the caller that a bitflip has occurred and has
Thomas Gleixner9a1fcdf2006-05-29 14:56:39 +0200244 * been corrected by the ECC algorithm.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700245 * Userspace software which accesses NAND this way
246 * must be aware of the fact that it deals with NAND
247 */
Brian Norrisd57f40542011-09-20 18:34:25 -0700248 if (!ret || mtd_is_bitflip_or_eccerr(ret)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700249 *ppos += retlen;
250 if (copy_to_user(buf, kbuf, retlen)) {
Thomas Gleixnerf4a43cf2006-05-28 11:01:53 +0200251 kfree(kbuf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700252 return -EFAULT;
253 }
254 else
255 total_retlen += retlen;
256
257 count -= retlen;
258 buf += retlen;
Nicolas Pitre31f42332005-02-08 17:45:55 +0000259 if (retlen == 0)
260 count = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700261 }
262 else {
263 kfree(kbuf);
264 return ret;
265 }
Thomas Gleixner97894cd2005-11-07 11:15:26 +0000266
Linus Torvalds1da177e2005-04-16 15:20:36 -0700267 }
268
Thago Galesib802c072006-04-17 17:38:15 +0100269 kfree(kbuf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700270 return total_retlen;
Artem Bityutskiy969e57a2011-12-23 17:27:46 +0200271} /* mtdchar_read */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700272
Artem Bityutskiy969e57a2011-12-23 17:27:46 +0200273static ssize_t mtdchar_write(struct file *file, const char __user *buf, size_t count,
274 loff_t *ppos)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700275{
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200276 struct mtd_file_info *mfi = file->private_data;
277 struct mtd_info *mtd = mfi->mtd;
Grant Erickson3e45cf52011-04-08 08:51:33 -0700278 size_t size = count;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700279 char *kbuf;
280 size_t retlen;
281 size_t total_retlen=0;
282 int ret=0;
283 int len;
284
Brian Norris289c0522011-07-19 10:06:09 -0700285 pr_debug("MTD_write\n");
Thomas Gleixner97894cd2005-11-07 11:15:26 +0000286
Linus Torvalds1da177e2005-04-16 15:20:36 -0700287 if (*ppos == mtd->size)
288 return -ENOSPC;
Thomas Gleixner97894cd2005-11-07 11:15:26 +0000289
Linus Torvalds1da177e2005-04-16 15:20:36 -0700290 if (*ppos + count > mtd->size)
291 count = mtd->size - *ppos;
292
293 if (!count)
294 return 0;
295
Grant Erickson3e45cf52011-04-08 08:51:33 -0700296 kbuf = mtd_kmalloc_up_to(mtd, &size);
Thago Galesib802c072006-04-17 17:38:15 +0100297 if (!kbuf)
298 return -ENOMEM;
299
Linus Torvalds1da177e2005-04-16 15:20:36 -0700300 while (count) {
Grant Erickson3e45cf52011-04-08 08:51:33 -0700301 len = min_t(size_t, count, size);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700302
Linus Torvalds1da177e2005-04-16 15:20:36 -0700303 if (copy_from_user(kbuf, buf, len)) {
304 kfree(kbuf);
305 return -EFAULT;
306 }
Thomas Gleixner97894cd2005-11-07 11:15:26 +0000307
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200308 switch (mfi->mode) {
Brian Norrisbeb133f2011-08-30 18:45:41 -0700309 case MTD_FILE_MODE_OTP_FACTORY:
Nicolas Pitre31f42332005-02-08 17:45:55 +0000310 ret = -EROFS;
311 break;
Brian Norrisbeb133f2011-08-30 18:45:41 -0700312 case MTD_FILE_MODE_OTP_USER:
Nicolas Pitre31f42332005-02-08 17:45:55 +0000313 if (!mtd->write_user_prot_reg) {
314 ret = -EOPNOTSUPP;
315 break;
316 }
Artem Bityutskiy482b43a2011-12-23 18:50:04 +0200317 ret = mtd_write_user_prot_reg(mtd, *ppos, len,
318 &retlen, kbuf);
Nicolas Pitre31f42332005-02-08 17:45:55 +0000319 break;
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200320
Brian Norrisbeb133f2011-08-30 18:45:41 -0700321 case MTD_FILE_MODE_RAW:
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200322 {
323 struct mtd_oob_ops ops;
324
Brian Norris0612b9d2011-08-30 18:45:40 -0700325 ops.mode = MTD_OPS_RAW;
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200326 ops.datbuf = kbuf;
327 ops.oobbuf = NULL;
Peter Wippichbf514082011-06-06 15:50:58 +0200328 ops.ooboffs = 0;
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200329 ops.len = len;
330
Artem Bityutskiya2cc5ba2011-12-23 18:29:55 +0200331 ret = mtd_write_oob(mtd, *ppos, &ops);
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200332 retlen = ops.retlen;
333 break;
334 }
335
Nicolas Pitre31f42332005-02-08 17:45:55 +0000336 default:
Artem Bityutskiyeda95cb2011-12-23 17:35:41 +0200337 ret = mtd_write(mtd, *ppos, len, &retlen, kbuf);
Nicolas Pitre31f42332005-02-08 17:45:55 +0000338 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700339 if (!ret) {
340 *ppos += retlen;
341 total_retlen += retlen;
342 count -= retlen;
343 buf += retlen;
344 }
345 else {
346 kfree(kbuf);
347 return ret;
348 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700349 }
350
Thago Galesib802c072006-04-17 17:38:15 +0100351 kfree(kbuf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700352 return total_retlen;
Artem Bityutskiy969e57a2011-12-23 17:27:46 +0200353} /* mtdchar_write */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700354
355/*======================================================================
356
357 IOCTL calls for getting device parameters.
358
359======================================================================*/
360static void mtdchar_erase_callback (struct erase_info *instr)
361{
362 wake_up((wait_queue_head_t *)instr->priv);
363}
364
David Brownell34a82442008-07-30 12:35:05 -0700365#ifdef CONFIG_HAVE_MTD_OTP
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200366static int otp_select_filemode(struct mtd_file_info *mfi, int mode)
367{
368 struct mtd_info *mtd = mfi->mtd;
369 int ret = 0;
370
371 switch (mode) {
372 case MTD_OTP_FACTORY:
373 if (!mtd->read_fact_prot_reg)
374 ret = -EOPNOTSUPP;
375 else
Brian Norrisbeb133f2011-08-30 18:45:41 -0700376 mfi->mode = MTD_FILE_MODE_OTP_FACTORY;
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200377 break;
378 case MTD_OTP_USER:
379 if (!mtd->read_fact_prot_reg)
380 ret = -EOPNOTSUPP;
381 else
Brian Norrisbeb133f2011-08-30 18:45:41 -0700382 mfi->mode = MTD_FILE_MODE_OTP_USER;
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200383 break;
384 default:
385 ret = -EINVAL;
386 case MTD_OTP_OFF:
387 break;
388 }
389 return ret;
390}
391#else
392# define otp_select_filemode(f,m) -EOPNOTSUPP
393#endif
394
Artem Bityutskiy969e57a2011-12-23 17:27:46 +0200395static int mtdchar_writeoob(struct file *file, struct mtd_info *mtd,
Kevin Cernekee97718542009-04-08 22:53:13 -0700396 uint64_t start, uint32_t length, void __user *ptr,
397 uint32_t __user *retp)
398{
Brian Norris9ce244b2011-08-30 18:45:37 -0700399 struct mtd_file_info *mfi = file->private_data;
Kevin Cernekee97718542009-04-08 22:53:13 -0700400 struct mtd_oob_ops ops;
401 uint32_t retlen;
402 int ret = 0;
403
404 if (!(file->f_mode & FMODE_WRITE))
405 return -EPERM;
406
407 if (length > 4096)
408 return -EINVAL;
409
410 if (!mtd->write_oob)
411 ret = -EOPNOTSUPP;
412 else
Roel Kluin00404762010-01-29 10:35:04 +0100413 ret = access_ok(VERIFY_READ, ptr, length) ? 0 : -EFAULT;
Kevin Cernekee97718542009-04-08 22:53:13 -0700414
415 if (ret)
416 return ret;
417
418 ops.ooblen = length;
Brian Norris305b93f2011-08-23 17:17:32 -0700419 ops.ooboffs = start & (mtd->writesize - 1);
Kevin Cernekee97718542009-04-08 22:53:13 -0700420 ops.datbuf = NULL;
Brian Norrisbeb133f2011-08-30 18:45:41 -0700421 ops.mode = (mfi->mode == MTD_FILE_MODE_RAW) ? MTD_OPS_RAW :
Brian Norris0612b9d2011-08-30 18:45:40 -0700422 MTD_OPS_PLACE_OOB;
Kevin Cernekee97718542009-04-08 22:53:13 -0700423
424 if (ops.ooboffs && ops.ooblen > (mtd->oobsize - ops.ooboffs))
425 return -EINVAL;
426
Julia Lawalldf1f1d12010-05-22 10:22:49 +0200427 ops.oobbuf = memdup_user(ptr, length);
428 if (IS_ERR(ops.oobbuf))
429 return PTR_ERR(ops.oobbuf);
Kevin Cernekee97718542009-04-08 22:53:13 -0700430
Brian Norris305b93f2011-08-23 17:17:32 -0700431 start &= ~((uint64_t)mtd->writesize - 1);
Artem Bityutskiya2cc5ba2011-12-23 18:29:55 +0200432 ret = mtd_write_oob(mtd, start, &ops);
Kevin Cernekee97718542009-04-08 22:53:13 -0700433
434 if (ops.oobretlen > 0xFFFFFFFFU)
435 ret = -EOVERFLOW;
436 retlen = ops.oobretlen;
437 if (copy_to_user(retp, &retlen, sizeof(length)))
438 ret = -EFAULT;
439
440 kfree(ops.oobbuf);
441 return ret;
442}
443
Artem Bityutskiy969e57a2011-12-23 17:27:46 +0200444static int mtdchar_readoob(struct file *file, struct mtd_info *mtd,
Brian Norrisc46f6482011-08-30 18:45:38 -0700445 uint64_t start, uint32_t length, void __user *ptr,
446 uint32_t __user *retp)
Kevin Cernekee97718542009-04-08 22:53:13 -0700447{
Brian Norrisc46f6482011-08-30 18:45:38 -0700448 struct mtd_file_info *mfi = file->private_data;
Kevin Cernekee97718542009-04-08 22:53:13 -0700449 struct mtd_oob_ops ops;
450 int ret = 0;
451
452 if (length > 4096)
453 return -EINVAL;
454
455 if (!mtd->read_oob)
456 ret = -EOPNOTSUPP;
457 else
458 ret = access_ok(VERIFY_WRITE, ptr,
459 length) ? 0 : -EFAULT;
460 if (ret)
461 return ret;
462
463 ops.ooblen = length;
Brian Norris305b93f2011-08-23 17:17:32 -0700464 ops.ooboffs = start & (mtd->writesize - 1);
Kevin Cernekee97718542009-04-08 22:53:13 -0700465 ops.datbuf = NULL;
Brian Norrisbeb133f2011-08-30 18:45:41 -0700466 ops.mode = (mfi->mode == MTD_FILE_MODE_RAW) ? MTD_OPS_RAW :
Brian Norris0612b9d2011-08-30 18:45:40 -0700467 MTD_OPS_PLACE_OOB;
Kevin Cernekee97718542009-04-08 22:53:13 -0700468
469 if (ops.ooboffs && ops.ooblen > (mtd->oobsize - ops.ooboffs))
470 return -EINVAL;
471
472 ops.oobbuf = kmalloc(length, GFP_KERNEL);
473 if (!ops.oobbuf)
474 return -ENOMEM;
475
Brian Norris305b93f2011-08-23 17:17:32 -0700476 start &= ~((uint64_t)mtd->writesize - 1);
Artem Bityutskiyfd2819b2011-12-23 18:27:05 +0200477 ret = mtd_read_oob(mtd, start, &ops);
Kevin Cernekee97718542009-04-08 22:53:13 -0700478
479 if (put_user(ops.oobretlen, retp))
480 ret = -EFAULT;
481 else if (ops.oobretlen && copy_to_user(ptr, ops.oobbuf,
482 ops.oobretlen))
483 ret = -EFAULT;
484
485 kfree(ops.oobbuf);
Brian Norris041e4572011-06-23 16:45:24 -0700486
487 /*
488 * NAND returns -EBADMSG on ECC errors, but it returns the OOB
489 * data. For our userspace tools it is important to dump areas
490 * with ECC errors!
491 * For kernel internal usage it also might return -EUCLEAN
492 * to signal the caller that a bitflip has occured and has
493 * been corrected by the ECC algorithm.
494 *
Brian Norrisc478d7e2011-06-28 16:29:00 -0700495 * Note: currently the standard NAND function, nand_read_oob_std,
496 * does not calculate ECC for the OOB area, so do not rely on
497 * this behavior unless you have replaced it with your own.
Brian Norris041e4572011-06-23 16:45:24 -0700498 */
Brian Norrisd57f40542011-09-20 18:34:25 -0700499 if (mtd_is_bitflip_or_eccerr(ret))
Brian Norris041e4572011-06-23 16:45:24 -0700500 return 0;
501
Kevin Cernekee97718542009-04-08 22:53:13 -0700502 return ret;
503}
504
Brian Norriscc26c3c2010-08-24 18:12:00 -0700505/*
506 * Copies (and truncates, if necessary) data from the larger struct,
507 * nand_ecclayout, to the smaller, deprecated layout struct,
Brian Norris92394b52011-07-20 09:53:42 -0700508 * nand_ecclayout_user. This is necessary only to support the deprecated
Brian Norriscc26c3c2010-08-24 18:12:00 -0700509 * API ioctl ECCGETLAYOUT while allowing all new functionality to use
510 * nand_ecclayout flexibly (i.e. the struct may change size in new
511 * releases without requiring major rewrites).
512 */
513static int shrink_ecclayout(const struct nand_ecclayout *from,
514 struct nand_ecclayout_user *to)
515{
516 int i;
517
518 if (!from || !to)
519 return -EINVAL;
520
521 memset(to, 0, sizeof(*to));
522
Brian Norris0ceacf32010-09-19 23:57:12 -0700523 to->eccbytes = min((int)from->eccbytes, MTD_MAX_ECCPOS_ENTRIES);
Brian Norriscc26c3c2010-08-24 18:12:00 -0700524 for (i = 0; i < to->eccbytes; i++)
525 to->eccpos[i] = from->eccpos[i];
526
527 for (i = 0; i < MTD_MAX_OOBFREE_ENTRIES; i++) {
528 if (from->oobfree[i].length == 0 &&
529 from->oobfree[i].offset == 0)
530 break;
531 to->oobavail += from->oobfree[i].length;
532 to->oobfree[i] = from->oobfree[i];
533 }
534
535 return 0;
536}
537
Artem Bityutskiy969e57a2011-12-23 17:27:46 +0200538static int mtdchar_blkpg_ioctl(struct mtd_info *mtd,
Roman Tereshonkovd0f79592010-09-17 13:31:42 +0300539 struct blkpg_ioctl_arg __user *arg)
540{
541 struct blkpg_ioctl_arg a;
542 struct blkpg_partition p;
543
544 if (!capable(CAP_SYS_ADMIN))
545 return -EPERM;
546
Roman Tereshonkovd0f79592010-09-17 13:31:42 +0300547 if (copy_from_user(&a, arg, sizeof(struct blkpg_ioctl_arg)))
548 return -EFAULT;
549
550 if (copy_from_user(&p, a.data, sizeof(struct blkpg_partition)))
551 return -EFAULT;
552
553 switch (a.op) {
554 case BLKPG_ADD_PARTITION:
555
Roman Tereshonkova7e93dc2010-11-23 14:17:17 +0200556 /* Only master mtd device must be used to add partitions */
557 if (mtd_is_partition(mtd))
558 return -EINVAL;
559
Roman Tereshonkovd0f79592010-09-17 13:31:42 +0300560 return mtd_add_partition(mtd, p.devname, p.start, p.length);
561
562 case BLKPG_DEL_PARTITION:
563
564 if (p.pno < 0)
565 return -EINVAL;
566
567 return mtd_del_partition(mtd, p.pno);
568
569 default:
570 return -EINVAL;
571 }
572}
Roman Tereshonkovd0f79592010-09-17 13:31:42 +0300573
Artem Bityutskiy969e57a2011-12-23 17:27:46 +0200574static int mtdchar_write_ioctl(struct mtd_info *mtd,
Brian Norrise99d8b02011-09-09 09:59:03 -0700575 struct mtd_write_req __user *argp)
576{
577 struct mtd_write_req req;
578 struct mtd_oob_ops ops;
579 void __user *usr_data, *usr_oob;
580 int ret;
581
582 if (copy_from_user(&req, argp, sizeof(req)) ||
583 !access_ok(VERIFY_READ, req.usr_data, req.len) ||
584 !access_ok(VERIFY_READ, req.usr_oob, req.ooblen))
585 return -EFAULT;
586 if (!mtd->write_oob)
587 return -EOPNOTSUPP;
588
589 ops.mode = req.mode;
590 ops.len = (size_t)req.len;
591 ops.ooblen = (size_t)req.ooblen;
592 ops.ooboffs = 0;
593
594 usr_data = (void __user *)(uintptr_t)req.usr_data;
595 usr_oob = (void __user *)(uintptr_t)req.usr_oob;
596
597 if (req.usr_data) {
598 ops.datbuf = memdup_user(usr_data, ops.len);
599 if (IS_ERR(ops.datbuf))
600 return PTR_ERR(ops.datbuf);
601 } else {
602 ops.datbuf = NULL;
603 }
604
605 if (req.usr_oob) {
606 ops.oobbuf = memdup_user(usr_oob, ops.ooblen);
607 if (IS_ERR(ops.oobbuf)) {
608 kfree(ops.datbuf);
609 return PTR_ERR(ops.oobbuf);
610 }
611 } else {
612 ops.oobbuf = NULL;
613 }
614
Artem Bityutskiya2cc5ba2011-12-23 18:29:55 +0200615 ret = mtd_write_oob(mtd, (loff_t)req.start, &ops);
Brian Norrise99d8b02011-09-09 09:59:03 -0700616
617 kfree(ops.datbuf);
618 kfree(ops.oobbuf);
619
620 return ret;
621}
622
Artem Bityutskiy969e57a2011-12-23 17:27:46 +0200623static int mtdchar_ioctl(struct file *file, u_int cmd, u_long arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700624{
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200625 struct mtd_file_info *mfi = file->private_data;
626 struct mtd_info *mtd = mfi->mtd;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700627 void __user *argp = (void __user *)arg;
628 int ret = 0;
629 u_long size;
Joern Engel73c619e2006-05-30 14:25:35 +0200630 struct mtd_info_user info;
Thomas Gleixner97894cd2005-11-07 11:15:26 +0000631
Brian Norris289c0522011-07-19 10:06:09 -0700632 pr_debug("MTD_ioctl\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700633
634 size = (cmd & IOCSIZE_MASK) >> IOCSIZE_SHIFT;
635 if (cmd & IOC_IN) {
636 if (!access_ok(VERIFY_READ, argp, size))
637 return -EFAULT;
638 }
639 if (cmd & IOC_OUT) {
640 if (!access_ok(VERIFY_WRITE, argp, size))
641 return -EFAULT;
642 }
Thomas Gleixner97894cd2005-11-07 11:15:26 +0000643
Linus Torvalds1da177e2005-04-16 15:20:36 -0700644 switch (cmd) {
645 case MEMGETREGIONCOUNT:
646 if (copy_to_user(argp, &(mtd->numeraseregions), sizeof(int)))
647 return -EFAULT;
648 break;
649
650 case MEMGETREGIONINFO:
651 {
Zev Weissb67c5f82008-09-01 05:02:12 -0700652 uint32_t ur_idx;
653 struct mtd_erase_region_info *kr;
H Hartley Sweetenbcc98a42010-01-15 11:25:38 -0700654 struct region_info_user __user *ur = argp;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700655
Zev Weissb67c5f82008-09-01 05:02:12 -0700656 if (get_user(ur_idx, &(ur->regionindex)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700657 return -EFAULT;
658
Dan Carpenter5e59be12010-09-08 21:39:56 +0200659 if (ur_idx >= mtd->numeraseregions)
660 return -EINVAL;
661
Zev Weissb67c5f82008-09-01 05:02:12 -0700662 kr = &(mtd->eraseregions[ur_idx]);
663
664 if (put_user(kr->offset, &(ur->offset))
665 || put_user(kr->erasesize, &(ur->erasesize))
666 || put_user(kr->numblocks, &(ur->numblocks)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700667 return -EFAULT;
Zev Weissb67c5f82008-09-01 05:02:12 -0700668
Linus Torvalds1da177e2005-04-16 15:20:36 -0700669 break;
670 }
671
672 case MEMGETINFO:
Vasiliy Kulikova0c5a392010-11-06 17:41:24 +0300673 memset(&info, 0, sizeof(info));
Joern Engel73c619e2006-05-30 14:25:35 +0200674 info.type = mtd->type;
675 info.flags = mtd->flags;
676 info.size = mtd->size;
677 info.erasesize = mtd->erasesize;
678 info.writesize = mtd->writesize;
679 info.oobsize = mtd->oobsize;
Brian Norris19fb4342011-08-30 18:45:46 -0700680 /* The below field is obsolete */
681 info.padding = 0;
Joern Engel73c619e2006-05-30 14:25:35 +0200682 if (copy_to_user(argp, &info, sizeof(struct mtd_info_user)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700683 return -EFAULT;
684 break;
685
686 case MEMERASE:
Kevin Cernekee0dc54e92009-04-08 22:52:28 -0700687 case MEMERASE64:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700688 {
689 struct erase_info *erase;
690
Al Viroaeb5d722008-09-02 15:28:45 -0400691 if(!(file->f_mode & FMODE_WRITE))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700692 return -EPERM;
693
Burman Yan95b93a02006-11-15 21:10:29 +0200694 erase=kzalloc(sizeof(struct erase_info),GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700695 if (!erase)
696 ret = -ENOMEM;
697 else {
698 wait_queue_head_t waitq;
699 DECLARE_WAITQUEUE(wait, current);
700
701 init_waitqueue_head(&waitq);
702
Kevin Cernekee0dc54e92009-04-08 22:52:28 -0700703 if (cmd == MEMERASE64) {
704 struct erase_info_user64 einfo64;
705
706 if (copy_from_user(&einfo64, argp,
707 sizeof(struct erase_info_user64))) {
708 kfree(erase);
709 return -EFAULT;
710 }
711 erase->addr = einfo64.start;
712 erase->len = einfo64.length;
713 } else {
714 struct erase_info_user einfo32;
715
716 if (copy_from_user(&einfo32, argp,
717 sizeof(struct erase_info_user))) {
718 kfree(erase);
719 return -EFAULT;
720 }
721 erase->addr = einfo32.start;
722 erase->len = einfo32.length;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700723 }
724 erase->mtd = mtd;
725 erase->callback = mtdchar_erase_callback;
726 erase->priv = (unsigned long)&waitq;
Thomas Gleixner97894cd2005-11-07 11:15:26 +0000727
Linus Torvalds1da177e2005-04-16 15:20:36 -0700728 /*
729 FIXME: Allow INTERRUPTIBLE. Which means
730 not having the wait_queue head on the stack.
Thomas Gleixner97894cd2005-11-07 11:15:26 +0000731
Linus Torvalds1da177e2005-04-16 15:20:36 -0700732 If the wq_head is on the stack, and we
733 leave because we got interrupted, then the
734 wq_head is no longer there when the
735 callback routine tries to wake us up.
736 */
Artem Bityutskiy7e1f0dc2011-12-23 15:25:39 +0200737 ret = mtd_erase(mtd, erase);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700738 if (!ret) {
739 set_current_state(TASK_UNINTERRUPTIBLE);
740 add_wait_queue(&waitq, &wait);
741 if (erase->state != MTD_ERASE_DONE &&
742 erase->state != MTD_ERASE_FAILED)
743 schedule();
744 remove_wait_queue(&waitq, &wait);
745 set_current_state(TASK_RUNNING);
746
747 ret = (erase->state == MTD_ERASE_FAILED)?-EIO:0;
748 }
749 kfree(erase);
750 }
751 break;
752 }
753
754 case MEMWRITEOOB:
755 {
756 struct mtd_oob_buf buf;
Kevin Cernekee97718542009-04-08 22:53:13 -0700757 struct mtd_oob_buf __user *buf_user = argp;
Thomas Gleixner97894cd2005-11-07 11:15:26 +0000758
Kevin Cernekee97718542009-04-08 22:53:13 -0700759 /* NOTE: writes return length to buf_user->length */
760 if (copy_from_user(&buf, argp, sizeof(buf)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700761 ret = -EFAULT;
Kevin Cernekee97718542009-04-08 22:53:13 -0700762 else
Artem Bityutskiy969e57a2011-12-23 17:27:46 +0200763 ret = mtdchar_writeoob(file, mtd, buf.start, buf.length,
Kevin Cernekee97718542009-04-08 22:53:13 -0700764 buf.ptr, &buf_user->length);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700765 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700766 }
767
768 case MEMREADOOB:
769 {
770 struct mtd_oob_buf buf;
Kevin Cernekee97718542009-04-08 22:53:13 -0700771 struct mtd_oob_buf __user *buf_user = argp;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700772
Kevin Cernekee97718542009-04-08 22:53:13 -0700773 /* NOTE: writes return length to buf_user->start */
774 if (copy_from_user(&buf, argp, sizeof(buf)))
775 ret = -EFAULT;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700776 else
Artem Bityutskiy969e57a2011-12-23 17:27:46 +0200777 ret = mtdchar_readoob(file, mtd, buf.start, buf.length,
Kevin Cernekee97718542009-04-08 22:53:13 -0700778 buf.ptr, &buf_user->start);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700779 break;
780 }
781
Kevin Cernekeeaea7cea2009-04-08 22:53:49 -0700782 case MEMWRITEOOB64:
783 {
784 struct mtd_oob_buf64 buf;
785 struct mtd_oob_buf64 __user *buf_user = argp;
786
787 if (copy_from_user(&buf, argp, sizeof(buf)))
788 ret = -EFAULT;
789 else
Artem Bityutskiy969e57a2011-12-23 17:27:46 +0200790 ret = mtdchar_writeoob(file, mtd, buf.start, buf.length,
Kevin Cernekeeaea7cea2009-04-08 22:53:49 -0700791 (void __user *)(uintptr_t)buf.usr_ptr,
792 &buf_user->length);
793 break;
794 }
795
796 case MEMREADOOB64:
797 {
798 struct mtd_oob_buf64 buf;
799 struct mtd_oob_buf64 __user *buf_user = argp;
800
801 if (copy_from_user(&buf, argp, sizeof(buf)))
802 ret = -EFAULT;
803 else
Artem Bityutskiy969e57a2011-12-23 17:27:46 +0200804 ret = mtdchar_readoob(file, mtd, buf.start, buf.length,
Kevin Cernekeeaea7cea2009-04-08 22:53:49 -0700805 (void __user *)(uintptr_t)buf.usr_ptr,
806 &buf_user->length);
807 break;
808 }
809
Brian Norrise99d8b02011-09-09 09:59:03 -0700810 case MEMWRITE:
811 {
Artem Bityutskiy969e57a2011-12-23 17:27:46 +0200812 ret = mtdchar_write_ioctl(mtd,
Brian Norrise99d8b02011-09-09 09:59:03 -0700813 (struct mtd_write_req __user *)arg);
814 break;
815 }
816
Linus Torvalds1da177e2005-04-16 15:20:36 -0700817 case MEMLOCK:
818 {
Harvey Harrison175428b2008-07-03 23:40:14 -0700819 struct erase_info_user einfo;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700820
Harvey Harrison175428b2008-07-03 23:40:14 -0700821 if (copy_from_user(&einfo, argp, sizeof(einfo)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700822 return -EFAULT;
823
824 if (!mtd->lock)
825 ret = -EOPNOTSUPP;
826 else
Artem Bityutskiy7799f9a2011-12-23 19:15:39 +0200827 ret = mtd_lock(mtd, einfo.start, einfo.length);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700828 break;
829 }
830
831 case MEMUNLOCK:
832 {
Harvey Harrison175428b2008-07-03 23:40:14 -0700833 struct erase_info_user einfo;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700834
Harvey Harrison175428b2008-07-03 23:40:14 -0700835 if (copy_from_user(&einfo, argp, sizeof(einfo)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700836 return -EFAULT;
837
838 if (!mtd->unlock)
839 ret = -EOPNOTSUPP;
840 else
Artem Bityutskiyb66005c2011-12-23 19:18:22 +0200841 ret = mtd_unlock(mtd, einfo.start, einfo.length);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700842 break;
843 }
844
Richard Cochran99384242010-06-14 18:10:33 +0200845 case MEMISLOCKED:
846 {
847 struct erase_info_user einfo;
848
849 if (copy_from_user(&einfo, argp, sizeof(einfo)))
850 return -EFAULT;
851
852 if (!mtd->is_locked)
853 ret = -EOPNOTSUPP;
854 else
Artem Bityutskiye95e9782011-12-23 19:21:16 +0200855 ret = mtd_is_locked(mtd, einfo.start, einfo.length);
Richard Cochran99384242010-06-14 18:10:33 +0200856 break;
857 }
858
Thomas Gleixner5bd34c02006-05-27 22:16:10 +0200859 /* Legacy interface */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700860 case MEMGETOOBSEL:
861 {
Thomas Gleixner5bd34c02006-05-27 22:16:10 +0200862 struct nand_oobinfo oi;
863
864 if (!mtd->ecclayout)
865 return -EOPNOTSUPP;
866 if (mtd->ecclayout->eccbytes > ARRAY_SIZE(oi.eccpos))
867 return -EINVAL;
868
869 oi.useecc = MTD_NANDECC_AUTOPLACE;
870 memcpy(&oi.eccpos, mtd->ecclayout->eccpos, sizeof(oi.eccpos));
871 memcpy(&oi.oobfree, mtd->ecclayout->oobfree,
872 sizeof(oi.oobfree));
Ricard Wanderlöfd25ade72006-10-17 17:27:11 +0200873 oi.eccbytes = mtd->ecclayout->eccbytes;
Thomas Gleixner5bd34c02006-05-27 22:16:10 +0200874
875 if (copy_to_user(argp, &oi, sizeof(struct nand_oobinfo)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700876 return -EFAULT;
877 break;
878 }
879
880 case MEMGETBADBLOCK:
881 {
882 loff_t offs;
Thomas Gleixner97894cd2005-11-07 11:15:26 +0000883
Linus Torvalds1da177e2005-04-16 15:20:36 -0700884 if (copy_from_user(&offs, argp, sizeof(loff_t)))
885 return -EFAULT;
886 if (!mtd->block_isbad)
887 ret = -EOPNOTSUPP;
888 else
Artem Bityutskiy7086c192011-12-23 19:35:30 +0200889 return mtd_block_isbad(mtd, offs);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700890 break;
891 }
892
893 case MEMSETBADBLOCK:
894 {
895 loff_t offs;
896
897 if (copy_from_user(&offs, argp, sizeof(loff_t)))
898 return -EFAULT;
899 if (!mtd->block_markbad)
900 ret = -EOPNOTSUPP;
901 else
Artem Bityutskiy5942ddb2011-12-23 19:37:38 +0200902 return mtd_block_markbad(mtd, offs);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700903 break;
904 }
905
David Brownell34a82442008-07-30 12:35:05 -0700906#ifdef CONFIG_HAVE_MTD_OTP
Nicolas Pitre31f42332005-02-08 17:45:55 +0000907 case OTPSELECT:
908 {
909 int mode;
910 if (copy_from_user(&mode, argp, sizeof(int)))
911 return -EFAULT;
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200912
Brian Norrisbeb133f2011-08-30 18:45:41 -0700913 mfi->mode = MTD_FILE_MODE_NORMAL;
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200914
915 ret = otp_select_filemode(mfi, mode);
916
Nicolas Pitre81dba482005-04-01 16:36:15 +0100917 file->f_pos = 0;
Nicolas Pitre31f42332005-02-08 17:45:55 +0000918 break;
919 }
920
921 case OTPGETREGIONCOUNT:
922 case OTPGETREGIONINFO:
923 {
924 struct otp_info *buf = kmalloc(4096, GFP_KERNEL);
925 if (!buf)
926 return -ENOMEM;
927 ret = -EOPNOTSUPP;
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200928 switch (mfi->mode) {
Brian Norrisbeb133f2011-08-30 18:45:41 -0700929 case MTD_FILE_MODE_OTP_FACTORY:
Nicolas Pitre31f42332005-02-08 17:45:55 +0000930 if (mtd->get_fact_prot_info)
Artem Bityutskiya750b5c2011-12-23 18:33:28 +0200931 ret = mtd_get_fact_prot_info(mtd, buf, 4096);
Nicolas Pitre31f42332005-02-08 17:45:55 +0000932 break;
Brian Norrisbeb133f2011-08-30 18:45:41 -0700933 case MTD_FILE_MODE_OTP_USER:
Nicolas Pitre31f42332005-02-08 17:45:55 +0000934 if (mtd->get_user_prot_info)
Artem Bityutskiy855e5d82011-12-23 18:45:11 +0200935 ret = mtd_get_user_prot_info(mtd, buf, 4096);
Nicolas Pitre31f42332005-02-08 17:45:55 +0000936 break;
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200937 default:
938 break;
Nicolas Pitre31f42332005-02-08 17:45:55 +0000939 }
940 if (ret >= 0) {
941 if (cmd == OTPGETREGIONCOUNT) {
942 int nbr = ret / sizeof(struct otp_info);
943 ret = copy_to_user(argp, &nbr, sizeof(int));
944 } else
945 ret = copy_to_user(argp, buf, ret);
946 if (ret)
947 ret = -EFAULT;
948 }
949 kfree(buf);
950 break;
951 }
952
953 case OTPLOCK:
954 {
Harvey Harrison175428b2008-07-03 23:40:14 -0700955 struct otp_info oinfo;
Nicolas Pitre31f42332005-02-08 17:45:55 +0000956
Brian Norrisbeb133f2011-08-30 18:45:41 -0700957 if (mfi->mode != MTD_FILE_MODE_OTP_USER)
Nicolas Pitre31f42332005-02-08 17:45:55 +0000958 return -EINVAL;
Harvey Harrison175428b2008-07-03 23:40:14 -0700959 if (copy_from_user(&oinfo, argp, sizeof(oinfo)))
Nicolas Pitre31f42332005-02-08 17:45:55 +0000960 return -EFAULT;
961 if (!mtd->lock_user_prot_reg)
962 return -EOPNOTSUPP;
Artem Bityutskiy4403dbf2011-12-23 18:55:49 +0200963 ret = mtd_lock_user_prot_reg(mtd, oinfo.start, oinfo.length);
Nicolas Pitre31f42332005-02-08 17:45:55 +0000964 break;
965 }
966#endif
967
Brian Norris7854d3f2011-06-23 14:12:08 -0700968 /* This ioctl is being deprecated - it truncates the ECC layout */
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200969 case ECCGETLAYOUT:
970 {
Brian Norriscc26c3c2010-08-24 18:12:00 -0700971 struct nand_ecclayout_user *usrlay;
972
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200973 if (!mtd->ecclayout)
974 return -EOPNOTSUPP;
975
Brian Norriscc26c3c2010-08-24 18:12:00 -0700976 usrlay = kmalloc(sizeof(*usrlay), GFP_KERNEL);
977 if (!usrlay)
978 return -ENOMEM;
979
980 shrink_ecclayout(mtd->ecclayout, usrlay);
981
982 if (copy_to_user(argp, usrlay, sizeof(*usrlay)))
983 ret = -EFAULT;
984 kfree(usrlay);
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200985 break;
986 }
987
988 case ECCGETSTATS:
989 {
990 if (copy_to_user(argp, &mtd->ecc_stats,
991 sizeof(struct mtd_ecc_stats)))
992 return -EFAULT;
993 break;
994 }
995
996 case MTDFILEMODE:
997 {
998 mfi->mode = 0;
999
1000 switch(arg) {
Brian Norrisbeb133f2011-08-30 18:45:41 -07001001 case MTD_FILE_MODE_OTP_FACTORY:
1002 case MTD_FILE_MODE_OTP_USER:
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +02001003 ret = otp_select_filemode(mfi, arg);
1004 break;
1005
Brian Norrisbeb133f2011-08-30 18:45:41 -07001006 case MTD_FILE_MODE_RAW:
Artem Bityutskiyfc002e32011-12-28 18:35:07 +02001007 if (!mtd_has_oob(mtd))
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +02001008 return -EOPNOTSUPP;
1009 mfi->mode = arg;
1010
Brian Norrisbeb133f2011-08-30 18:45:41 -07001011 case MTD_FILE_MODE_NORMAL:
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +02001012 break;
1013 default:
1014 ret = -EINVAL;
1015 }
1016 file->f_pos = 0;
1017 break;
1018 }
1019
Roman Tereshonkovd0f79592010-09-17 13:31:42 +03001020 case BLKPG:
1021 {
Artem Bityutskiy969e57a2011-12-23 17:27:46 +02001022 ret = mtdchar_blkpg_ioctl(mtd,
Roman Tereshonkovd0f79592010-09-17 13:31:42 +03001023 (struct blkpg_ioctl_arg __user *)arg);
1024 break;
1025 }
1026
1027 case BLKRRPART:
1028 {
1029 /* No reread partition feature. Just return ok */
1030 ret = 0;
1031 break;
1032 }
Roman Tereshonkovd0f79592010-09-17 13:31:42 +03001033
Linus Torvalds1da177e2005-04-16 15:20:36 -07001034 default:
1035 ret = -ENOTTY;
1036 }
1037
1038 return ret;
1039} /* memory_ioctl */
1040
Artem Bityutskiy969e57a2011-12-23 17:27:46 +02001041static long mtdchar_unlocked_ioctl(struct file *file, u_int cmd, u_long arg)
Arnd Bergmann55929332010-04-27 00:24:05 +02001042{
1043 int ret;
1044
Arnd Bergmann5aa82942010-06-02 14:28:52 +02001045 mutex_lock(&mtd_mutex);
Artem Bityutskiy969e57a2011-12-23 17:27:46 +02001046 ret = mtdchar_ioctl(file, cmd, arg);
Arnd Bergmann5aa82942010-06-02 14:28:52 +02001047 mutex_unlock(&mtd_mutex);
Arnd Bergmann55929332010-04-27 00:24:05 +02001048
1049 return ret;
1050}
1051
Kevin Cernekee97718542009-04-08 22:53:13 -07001052#ifdef CONFIG_COMPAT
1053
1054struct mtd_oob_buf32 {
1055 u_int32_t start;
1056 u_int32_t length;
1057 compat_caddr_t ptr; /* unsigned char* */
1058};
1059
1060#define MEMWRITEOOB32 _IOWR('M', 3, struct mtd_oob_buf32)
1061#define MEMREADOOB32 _IOWR('M', 4, struct mtd_oob_buf32)
1062
Artem Bityutskiy969e57a2011-12-23 17:27:46 +02001063static long mtdchar_compat_ioctl(struct file *file, unsigned int cmd,
Kevin Cernekee97718542009-04-08 22:53:13 -07001064 unsigned long arg)
1065{
1066 struct mtd_file_info *mfi = file->private_data;
1067 struct mtd_info *mtd = mfi->mtd;
David Woodhouse0b6585c2009-05-29 16:09:08 +01001068 void __user *argp = compat_ptr(arg);
Kevin Cernekee97718542009-04-08 22:53:13 -07001069 int ret = 0;
1070
Arnd Bergmann5aa82942010-06-02 14:28:52 +02001071 mutex_lock(&mtd_mutex);
Kevin Cernekee97718542009-04-08 22:53:13 -07001072
1073 switch (cmd) {
1074 case MEMWRITEOOB32:
1075 {
1076 struct mtd_oob_buf32 buf;
1077 struct mtd_oob_buf32 __user *buf_user = argp;
1078
1079 if (copy_from_user(&buf, argp, sizeof(buf)))
1080 ret = -EFAULT;
1081 else
Artem Bityutskiy969e57a2011-12-23 17:27:46 +02001082 ret = mtdchar_writeoob(file, mtd, buf.start,
Kevin Cernekee97718542009-04-08 22:53:13 -07001083 buf.length, compat_ptr(buf.ptr),
1084 &buf_user->length);
1085 break;
1086 }
1087
1088 case MEMREADOOB32:
1089 {
1090 struct mtd_oob_buf32 buf;
1091 struct mtd_oob_buf32 __user *buf_user = argp;
1092
1093 /* NOTE: writes return length to buf->start */
1094 if (copy_from_user(&buf, argp, sizeof(buf)))
1095 ret = -EFAULT;
1096 else
Artem Bityutskiy969e57a2011-12-23 17:27:46 +02001097 ret = mtdchar_readoob(file, mtd, buf.start,
Kevin Cernekee97718542009-04-08 22:53:13 -07001098 buf.length, compat_ptr(buf.ptr),
1099 &buf_user->start);
1100 break;
1101 }
1102 default:
Artem Bityutskiy969e57a2011-12-23 17:27:46 +02001103 ret = mtdchar_ioctl(file, cmd, (unsigned long)argp);
Kevin Cernekee97718542009-04-08 22:53:13 -07001104 }
1105
Arnd Bergmann5aa82942010-06-02 14:28:52 +02001106 mutex_unlock(&mtd_mutex);
Kevin Cernekee97718542009-04-08 22:53:13 -07001107
1108 return ret;
1109}
1110
1111#endif /* CONFIG_COMPAT */
1112
David Howells402d3262009-02-12 10:40:00 +00001113/*
1114 * try to determine where a shared mapping can be made
1115 * - only supported for NOMMU at the moment (MMU can't doesn't copy private
1116 * mappings)
1117 */
1118#ifndef CONFIG_MMU
Artem Bityutskiy969e57a2011-12-23 17:27:46 +02001119static unsigned long mtdchar_get_unmapped_area(struct file *file,
David Howells402d3262009-02-12 10:40:00 +00001120 unsigned long addr,
1121 unsigned long len,
1122 unsigned long pgoff,
1123 unsigned long flags)
1124{
1125 struct mtd_file_info *mfi = file->private_data;
1126 struct mtd_info *mtd = mfi->mtd;
1127
1128 if (mtd->get_unmapped_area) {
1129 unsigned long offset;
1130
1131 if (addr != 0)
1132 return (unsigned long) -EINVAL;
1133
1134 if (len > mtd->size || pgoff >= (mtd->size >> PAGE_SHIFT))
1135 return (unsigned long) -EINVAL;
1136
1137 offset = pgoff << PAGE_SHIFT;
1138 if (offset > mtd->size - len)
1139 return (unsigned long) -EINVAL;
1140
Artem Bityutskiy04c601b2011-12-23 17:10:15 +02001141 return mtd_get_unmapped_area(mtd, len, offset, flags);
David Howells402d3262009-02-12 10:40:00 +00001142 }
1143
1144 /* can't map directly */
1145 return (unsigned long) -ENOSYS;
1146}
1147#endif
1148
1149/*
1150 * set up a mapping for shared memory segments
1151 */
Artem Bityutskiy969e57a2011-12-23 17:27:46 +02001152static int mtdchar_mmap(struct file *file, struct vm_area_struct *vma)
David Howells402d3262009-02-12 10:40:00 +00001153{
1154#ifdef CONFIG_MMU
1155 struct mtd_file_info *mfi = file->private_data;
1156 struct mtd_info *mtd = mfi->mtd;
Anatolij Gustschindd02b672010-06-15 09:30:15 +02001157 struct map_info *map = mtd->priv;
1158 unsigned long start;
1159 unsigned long off;
1160 u32 len;
David Howells402d3262009-02-12 10:40:00 +00001161
Anatolij Gustschindd02b672010-06-15 09:30:15 +02001162 if (mtd->type == MTD_RAM || mtd->type == MTD_ROM) {
1163 off = vma->vm_pgoff << PAGE_SHIFT;
1164 start = map->phys;
1165 len = PAGE_ALIGN((start & ~PAGE_MASK) + map->size);
1166 start &= PAGE_MASK;
1167 if ((vma->vm_end - vma->vm_start + off) > len)
1168 return -EINVAL;
1169
1170 off += start;
1171 vma->vm_pgoff = off >> PAGE_SHIFT;
1172 vma->vm_flags |= VM_IO | VM_RESERVED;
1173
1174#ifdef pgprot_noncached
1175 if (file->f_flags & O_DSYNC || off >= __pa(high_memory))
1176 vma->vm_page_prot = pgprot_noncached(vma->vm_page_prot);
1177#endif
1178 if (io_remap_pfn_range(vma, vma->vm_start, off >> PAGE_SHIFT,
1179 vma->vm_end - vma->vm_start,
1180 vma->vm_page_prot))
1181 return -EAGAIN;
1182
David Howells402d3262009-02-12 10:40:00 +00001183 return 0;
Anatolij Gustschindd02b672010-06-15 09:30:15 +02001184 }
David Howells402d3262009-02-12 10:40:00 +00001185 return -ENOSYS;
1186#else
1187 return vma->vm_flags & VM_SHARED ? 0 : -ENOSYS;
1188#endif
1189}
1190
Arjan van de Vend54b1fd2007-02-12 00:55:34 -08001191static const struct file_operations mtd_fops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001192 .owner = THIS_MODULE,
Artem Bityutskiy969e57a2011-12-23 17:27:46 +02001193 .llseek = mtdchar_lseek,
1194 .read = mtdchar_read,
1195 .write = mtdchar_write,
1196 .unlocked_ioctl = mtdchar_unlocked_ioctl,
Kevin Cernekee97718542009-04-08 22:53:13 -07001197#ifdef CONFIG_COMPAT
Artem Bityutskiy969e57a2011-12-23 17:27:46 +02001198 .compat_ioctl = mtdchar_compat_ioctl,
Kevin Cernekee97718542009-04-08 22:53:13 -07001199#endif
Artem Bityutskiy969e57a2011-12-23 17:27:46 +02001200 .open = mtdchar_open,
1201 .release = mtdchar_close,
1202 .mmap = mtdchar_mmap,
David Howells402d3262009-02-12 10:40:00 +00001203#ifndef CONFIG_MMU
Artem Bityutskiy969e57a2011-12-23 17:27:46 +02001204 .get_unmapped_area = mtdchar_get_unmapped_area,
David Howells402d3262009-02-12 10:40:00 +00001205#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07001206};
1207
Al Viro51139ad2010-07-25 23:47:46 +04001208static struct dentry *mtd_inodefs_mount(struct file_system_type *fs_type,
1209 int flags, const char *dev_name, void *data)
Kirill A. Shutemovcd874232010-05-17 16:55:47 +03001210{
Al Viroc74a1cb2011-01-12 16:59:34 -05001211 return mount_pseudo(fs_type, "mtd_inode:", NULL, NULL, MTD_INODE_FS_MAGIC);
Kirill A. Shutemovcd874232010-05-17 16:55:47 +03001212}
1213
1214static struct file_system_type mtd_inodefs_type = {
1215 .name = "mtd_inodefs",
Al Viro51139ad2010-07-25 23:47:46 +04001216 .mount = mtd_inodefs_mount,
Kirill A. Shutemovcd874232010-05-17 16:55:47 +03001217 .kill_sb = kill_anon_super,
1218};
1219
1220static void mtdchar_notify_add(struct mtd_info *mtd)
1221{
1222}
1223
1224static void mtdchar_notify_remove(struct mtd_info *mtd)
1225{
1226 struct inode *mtd_ino = ilookup(mtd_inode_mnt->mnt_sb, mtd->index);
1227
1228 if (mtd_ino) {
1229 /* Destroy the inode if it exists */
Miklos Szeredi6d6b77f2011-10-28 14:13:28 +02001230 clear_nlink(mtd_ino);
Kirill A. Shutemovcd874232010-05-17 16:55:47 +03001231 iput(mtd_ino);
1232 }
1233}
1234
1235static struct mtd_notifier mtdchar_notifier = {
1236 .add = mtdchar_notify_add,
1237 .remove = mtdchar_notify_remove,
1238};
1239
Linus Torvalds1da177e2005-04-16 15:20:36 -07001240static int __init init_mtdchar(void)
1241{
Kirill A. Shutemovcd874232010-05-17 16:55:47 +03001242 int ret;
David Brownell1f24b5a2009-03-26 00:42:41 -07001243
Kirill A. Shutemovcd874232010-05-17 16:55:47 +03001244 ret = __register_chrdev(MTD_CHAR_MAJOR, 0, 1 << MINORBITS,
Ben Hutchingsdad0db32010-01-29 21:00:04 +00001245 "mtd", &mtd_fops);
Kirill A. Shutemovcd874232010-05-17 16:55:47 +03001246 if (ret < 0) {
1247 pr_notice("Can't allocate major number %d for "
1248 "Memory Technology Devices.\n", MTD_CHAR_MAJOR);
1249 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001250 }
1251
Kirill A. Shutemovcd874232010-05-17 16:55:47 +03001252 ret = register_filesystem(&mtd_inodefs_type);
1253 if (ret) {
1254 pr_notice("Can't register mtd_inodefs filesystem: %d\n", ret);
1255 goto err_unregister_chdev;
1256 }
1257
1258 mtd_inode_mnt = kern_mount(&mtd_inodefs_type);
1259 if (IS_ERR(mtd_inode_mnt)) {
1260 ret = PTR_ERR(mtd_inode_mnt);
1261 pr_notice("Error mounting mtd_inodefs filesystem: %d\n", ret);
1262 goto err_unregister_filesystem;
1263 }
1264 register_mtd_user(&mtdchar_notifier);
1265
1266 return ret;
1267
1268err_unregister_filesystem:
1269 unregister_filesystem(&mtd_inodefs_type);
1270err_unregister_chdev:
1271 __unregister_chrdev(MTD_CHAR_MAJOR, 0, 1 << MINORBITS, "mtd");
1272 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001273}
1274
1275static void __exit cleanup_mtdchar(void)
1276{
Kirill A. Shutemovcd874232010-05-17 16:55:47 +03001277 unregister_mtd_user(&mtdchar_notifier);
Tim Chen423e0ab2011-07-19 09:32:38 -07001278 kern_unmount(mtd_inode_mnt);
Kirill A. Shutemovcd874232010-05-17 16:55:47 +03001279 unregister_filesystem(&mtd_inodefs_type);
Ben Hutchingsdad0db32010-01-29 21:00:04 +00001280 __unregister_chrdev(MTD_CHAR_MAJOR, 0, 1 << MINORBITS, "mtd");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001281}
1282
1283module_init(init_mtdchar);
1284module_exit(cleanup_mtdchar);
1285
David Brownell1f24b5a2009-03-26 00:42:41 -07001286MODULE_ALIAS_CHARDEV_MAJOR(MTD_CHAR_MAJOR);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001287
1288MODULE_LICENSE("GPL");
1289MODULE_AUTHOR("David Woodhouse <dwmw2@infradead.org>");
1290MODULE_DESCRIPTION("Direct character-device access to MTD devices");
Scott James Remnant90160e12009-03-02 18:42:39 +00001291MODULE_ALIAS_CHARDEV_MAJOR(MTD_CHAR_MAJOR);