blob: 6aa3fb4a0292aa853d816dd86a125a2a26355bee [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 Norris92394b5c2011-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)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700158 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;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700192 size_t retlen=0;
193 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 }
317 ret = mtd->write_user_prot_reg(mtd, *ppos, len, &retlen, kbuf);
318 break;
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200319
Brian Norrisbeb133f2011-08-30 18:45:41 -0700320 case MTD_FILE_MODE_RAW:
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200321 {
322 struct mtd_oob_ops ops;
323
Brian Norris0612b9d2011-08-30 18:45:40 -0700324 ops.mode = MTD_OPS_RAW;
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200325 ops.datbuf = kbuf;
326 ops.oobbuf = NULL;
Peter Wippichbf514082011-06-06 15:50:58 +0200327 ops.ooboffs = 0;
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200328 ops.len = len;
329
Artem Bityutskiya2cc5ba2011-12-23 18:29:55 +0200330 ret = mtd_write_oob(mtd, *ppos, &ops);
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200331 retlen = ops.retlen;
332 break;
333 }
334
Nicolas Pitre31f42332005-02-08 17:45:55 +0000335 default:
Artem Bityutskiyeda95cb2011-12-23 17:35:41 +0200336 ret = mtd_write(mtd, *ppos, len, &retlen, kbuf);
Nicolas Pitre31f42332005-02-08 17:45:55 +0000337 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700338 if (!ret) {
339 *ppos += retlen;
340 total_retlen += retlen;
341 count -= retlen;
342 buf += retlen;
343 }
344 else {
345 kfree(kbuf);
346 return ret;
347 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700348 }
349
Thago Galesib802c072006-04-17 17:38:15 +0100350 kfree(kbuf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700351 return total_retlen;
Artem Bityutskiy969e57a2011-12-23 17:27:46 +0200352} /* mtdchar_write */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700353
354/*======================================================================
355
356 IOCTL calls for getting device parameters.
357
358======================================================================*/
359static void mtdchar_erase_callback (struct erase_info *instr)
360{
361 wake_up((wait_queue_head_t *)instr->priv);
362}
363
David Brownell34a82442008-07-30 12:35:05 -0700364#ifdef CONFIG_HAVE_MTD_OTP
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200365static int otp_select_filemode(struct mtd_file_info *mfi, int mode)
366{
367 struct mtd_info *mtd = mfi->mtd;
368 int ret = 0;
369
370 switch (mode) {
371 case MTD_OTP_FACTORY:
372 if (!mtd->read_fact_prot_reg)
373 ret = -EOPNOTSUPP;
374 else
Brian Norrisbeb133f2011-08-30 18:45:41 -0700375 mfi->mode = MTD_FILE_MODE_OTP_FACTORY;
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200376 break;
377 case MTD_OTP_USER:
378 if (!mtd->read_fact_prot_reg)
379 ret = -EOPNOTSUPP;
380 else
Brian Norrisbeb133f2011-08-30 18:45:41 -0700381 mfi->mode = MTD_FILE_MODE_OTP_USER;
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200382 break;
383 default:
384 ret = -EINVAL;
385 case MTD_OTP_OFF:
386 break;
387 }
388 return ret;
389}
390#else
391# define otp_select_filemode(f,m) -EOPNOTSUPP
392#endif
393
Artem Bityutskiy969e57a2011-12-23 17:27:46 +0200394static int mtdchar_writeoob(struct file *file, struct mtd_info *mtd,
Kevin Cernekee97718542009-04-08 22:53:13 -0700395 uint64_t start, uint32_t length, void __user *ptr,
396 uint32_t __user *retp)
397{
Brian Norris9ce244b2011-08-30 18:45:37 -0700398 struct mtd_file_info *mfi = file->private_data;
Kevin Cernekee97718542009-04-08 22:53:13 -0700399 struct mtd_oob_ops ops;
400 uint32_t retlen;
401 int ret = 0;
402
403 if (!(file->f_mode & FMODE_WRITE))
404 return -EPERM;
405
406 if (length > 4096)
407 return -EINVAL;
408
409 if (!mtd->write_oob)
410 ret = -EOPNOTSUPP;
411 else
Roel Kluin00404762010-01-29 10:35:04 +0100412 ret = access_ok(VERIFY_READ, ptr, length) ? 0 : -EFAULT;
Kevin Cernekee97718542009-04-08 22:53:13 -0700413
414 if (ret)
415 return ret;
416
417 ops.ooblen = length;
Brian Norris305b93f2011-08-23 17:17:32 -0700418 ops.ooboffs = start & (mtd->writesize - 1);
Kevin Cernekee97718542009-04-08 22:53:13 -0700419 ops.datbuf = NULL;
Brian Norrisbeb133f2011-08-30 18:45:41 -0700420 ops.mode = (mfi->mode == MTD_FILE_MODE_RAW) ? MTD_OPS_RAW :
Brian Norris0612b9d2011-08-30 18:45:40 -0700421 MTD_OPS_PLACE_OOB;
Kevin Cernekee97718542009-04-08 22:53:13 -0700422
423 if (ops.ooboffs && ops.ooblen > (mtd->oobsize - ops.ooboffs))
424 return -EINVAL;
425
Julia Lawalldf1f1d12010-05-22 10:22:49 +0200426 ops.oobbuf = memdup_user(ptr, length);
427 if (IS_ERR(ops.oobbuf))
428 return PTR_ERR(ops.oobbuf);
Kevin Cernekee97718542009-04-08 22:53:13 -0700429
Brian Norris305b93f2011-08-23 17:17:32 -0700430 start &= ~((uint64_t)mtd->writesize - 1);
Artem Bityutskiya2cc5ba2011-12-23 18:29:55 +0200431 ret = mtd_write_oob(mtd, start, &ops);
Kevin Cernekee97718542009-04-08 22:53:13 -0700432
433 if (ops.oobretlen > 0xFFFFFFFFU)
434 ret = -EOVERFLOW;
435 retlen = ops.oobretlen;
436 if (copy_to_user(retp, &retlen, sizeof(length)))
437 ret = -EFAULT;
438
439 kfree(ops.oobbuf);
440 return ret;
441}
442
Artem Bityutskiy969e57a2011-12-23 17:27:46 +0200443static int mtdchar_readoob(struct file *file, struct mtd_info *mtd,
Brian Norrisc46f6482011-08-30 18:45:38 -0700444 uint64_t start, uint32_t length, void __user *ptr,
445 uint32_t __user *retp)
Kevin Cernekee97718542009-04-08 22:53:13 -0700446{
Brian Norrisc46f6482011-08-30 18:45:38 -0700447 struct mtd_file_info *mfi = file->private_data;
Kevin Cernekee97718542009-04-08 22:53:13 -0700448 struct mtd_oob_ops ops;
449 int ret = 0;
450
451 if (length > 4096)
452 return -EINVAL;
453
454 if (!mtd->read_oob)
455 ret = -EOPNOTSUPP;
456 else
457 ret = access_ok(VERIFY_WRITE, ptr,
458 length) ? 0 : -EFAULT;
459 if (ret)
460 return ret;
461
462 ops.ooblen = length;
Brian Norris305b93f2011-08-23 17:17:32 -0700463 ops.ooboffs = start & (mtd->writesize - 1);
Kevin Cernekee97718542009-04-08 22:53:13 -0700464 ops.datbuf = NULL;
Brian Norrisbeb133f2011-08-30 18:45:41 -0700465 ops.mode = (mfi->mode == MTD_FILE_MODE_RAW) ? MTD_OPS_RAW :
Brian Norris0612b9d2011-08-30 18:45:40 -0700466 MTD_OPS_PLACE_OOB;
Kevin Cernekee97718542009-04-08 22:53:13 -0700467
468 if (ops.ooboffs && ops.ooblen > (mtd->oobsize - ops.ooboffs))
469 return -EINVAL;
470
471 ops.oobbuf = kmalloc(length, GFP_KERNEL);
472 if (!ops.oobbuf)
473 return -ENOMEM;
474
Brian Norris305b93f2011-08-23 17:17:32 -0700475 start &= ~((uint64_t)mtd->writesize - 1);
Artem Bityutskiyfd2819b2011-12-23 18:27:05 +0200476 ret = mtd_read_oob(mtd, start, &ops);
Kevin Cernekee97718542009-04-08 22:53:13 -0700477
478 if (put_user(ops.oobretlen, retp))
479 ret = -EFAULT;
480 else if (ops.oobretlen && copy_to_user(ptr, ops.oobbuf,
481 ops.oobretlen))
482 ret = -EFAULT;
483
484 kfree(ops.oobbuf);
Brian Norris041e4572011-06-23 16:45:24 -0700485
486 /*
487 * NAND returns -EBADMSG on ECC errors, but it returns the OOB
488 * data. For our userspace tools it is important to dump areas
489 * with ECC errors!
490 * For kernel internal usage it also might return -EUCLEAN
491 * to signal the caller that a bitflip has occured and has
492 * been corrected by the ECC algorithm.
493 *
Brian Norrisc478d7e2011-06-28 16:29:00 -0700494 * Note: currently the standard NAND function, nand_read_oob_std,
495 * does not calculate ECC for the OOB area, so do not rely on
496 * this behavior unless you have replaced it with your own.
Brian Norris041e4572011-06-23 16:45:24 -0700497 */
Brian Norrisd57f40542011-09-20 18:34:25 -0700498 if (mtd_is_bitflip_or_eccerr(ret))
Brian Norris041e4572011-06-23 16:45:24 -0700499 return 0;
500
Kevin Cernekee97718542009-04-08 22:53:13 -0700501 return ret;
502}
503
Brian Norriscc26c3c2010-08-24 18:12:00 -0700504/*
505 * Copies (and truncates, if necessary) data from the larger struct,
506 * nand_ecclayout, to the smaller, deprecated layout struct,
Brian Norris92394b5c2011-07-20 09:53:42 -0700507 * nand_ecclayout_user. This is necessary only to support the deprecated
Brian Norriscc26c3c2010-08-24 18:12:00 -0700508 * API ioctl ECCGETLAYOUT while allowing all new functionality to use
509 * nand_ecclayout flexibly (i.e. the struct may change size in new
510 * releases without requiring major rewrites).
511 */
512static int shrink_ecclayout(const struct nand_ecclayout *from,
513 struct nand_ecclayout_user *to)
514{
515 int i;
516
517 if (!from || !to)
518 return -EINVAL;
519
520 memset(to, 0, sizeof(*to));
521
Brian Norris0ceacf32010-09-19 23:57:12 -0700522 to->eccbytes = min((int)from->eccbytes, MTD_MAX_ECCPOS_ENTRIES);
Brian Norriscc26c3c2010-08-24 18:12:00 -0700523 for (i = 0; i < to->eccbytes; i++)
524 to->eccpos[i] = from->eccpos[i];
525
526 for (i = 0; i < MTD_MAX_OOBFREE_ENTRIES; i++) {
527 if (from->oobfree[i].length == 0 &&
528 from->oobfree[i].offset == 0)
529 break;
530 to->oobavail += from->oobfree[i].length;
531 to->oobfree[i] = from->oobfree[i];
532 }
533
534 return 0;
535}
536
Artem Bityutskiy969e57a2011-12-23 17:27:46 +0200537static int mtdchar_blkpg_ioctl(struct mtd_info *mtd,
Roman Tereshonkovd0f79592010-09-17 13:31:42 +0300538 struct blkpg_ioctl_arg __user *arg)
539{
540 struct blkpg_ioctl_arg a;
541 struct blkpg_partition p;
542
543 if (!capable(CAP_SYS_ADMIN))
544 return -EPERM;
545
Roman Tereshonkovd0f79592010-09-17 13:31:42 +0300546 if (copy_from_user(&a, arg, sizeof(struct blkpg_ioctl_arg)))
547 return -EFAULT;
548
549 if (copy_from_user(&p, a.data, sizeof(struct blkpg_partition)))
550 return -EFAULT;
551
552 switch (a.op) {
553 case BLKPG_ADD_PARTITION:
554
Roman Tereshonkova7e93dc2010-11-23 14:17:17 +0200555 /* Only master mtd device must be used to add partitions */
556 if (mtd_is_partition(mtd))
557 return -EINVAL;
558
Roman Tereshonkovd0f79592010-09-17 13:31:42 +0300559 return mtd_add_partition(mtd, p.devname, p.start, p.length);
560
561 case BLKPG_DEL_PARTITION:
562
563 if (p.pno < 0)
564 return -EINVAL;
565
566 return mtd_del_partition(mtd, p.pno);
567
568 default:
569 return -EINVAL;
570 }
571}
Roman Tereshonkovd0f79592010-09-17 13:31:42 +0300572
Artem Bityutskiy969e57a2011-12-23 17:27:46 +0200573static int mtdchar_write_ioctl(struct mtd_info *mtd,
Brian Norrise99d8b02011-09-09 09:59:03 -0700574 struct mtd_write_req __user *argp)
575{
576 struct mtd_write_req req;
577 struct mtd_oob_ops ops;
578 void __user *usr_data, *usr_oob;
579 int ret;
580
581 if (copy_from_user(&req, argp, sizeof(req)) ||
582 !access_ok(VERIFY_READ, req.usr_data, req.len) ||
583 !access_ok(VERIFY_READ, req.usr_oob, req.ooblen))
584 return -EFAULT;
585 if (!mtd->write_oob)
586 return -EOPNOTSUPP;
587
588 ops.mode = req.mode;
589 ops.len = (size_t)req.len;
590 ops.ooblen = (size_t)req.ooblen;
591 ops.ooboffs = 0;
592
593 usr_data = (void __user *)(uintptr_t)req.usr_data;
594 usr_oob = (void __user *)(uintptr_t)req.usr_oob;
595
596 if (req.usr_data) {
597 ops.datbuf = memdup_user(usr_data, ops.len);
598 if (IS_ERR(ops.datbuf))
599 return PTR_ERR(ops.datbuf);
600 } else {
601 ops.datbuf = NULL;
602 }
603
604 if (req.usr_oob) {
605 ops.oobbuf = memdup_user(usr_oob, ops.ooblen);
606 if (IS_ERR(ops.oobbuf)) {
607 kfree(ops.datbuf);
608 return PTR_ERR(ops.oobbuf);
609 }
610 } else {
611 ops.oobbuf = NULL;
612 }
613
Artem Bityutskiya2cc5ba2011-12-23 18:29:55 +0200614 ret = mtd_write_oob(mtd, (loff_t)req.start, &ops);
Brian Norrise99d8b02011-09-09 09:59:03 -0700615
616 kfree(ops.datbuf);
617 kfree(ops.oobbuf);
618
619 return ret;
620}
621
Artem Bityutskiy969e57a2011-12-23 17:27:46 +0200622static int mtdchar_ioctl(struct file *file, u_int cmd, u_long arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700623{
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200624 struct mtd_file_info *mfi = file->private_data;
625 struct mtd_info *mtd = mfi->mtd;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700626 void __user *argp = (void __user *)arg;
627 int ret = 0;
628 u_long size;
Joern Engel73c619e2006-05-30 14:25:35 +0200629 struct mtd_info_user info;
Thomas Gleixner97894cd2005-11-07 11:15:26 +0000630
Brian Norris289c0522011-07-19 10:06:09 -0700631 pr_debug("MTD_ioctl\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700632
633 size = (cmd & IOCSIZE_MASK) >> IOCSIZE_SHIFT;
634 if (cmd & IOC_IN) {
635 if (!access_ok(VERIFY_READ, argp, size))
636 return -EFAULT;
637 }
638 if (cmd & IOC_OUT) {
639 if (!access_ok(VERIFY_WRITE, argp, size))
640 return -EFAULT;
641 }
Thomas Gleixner97894cd2005-11-07 11:15:26 +0000642
Linus Torvalds1da177e2005-04-16 15:20:36 -0700643 switch (cmd) {
644 case MEMGETREGIONCOUNT:
645 if (copy_to_user(argp, &(mtd->numeraseregions), sizeof(int)))
646 return -EFAULT;
647 break;
648
649 case MEMGETREGIONINFO:
650 {
Zev Weissb67c5f82008-09-01 05:02:12 -0700651 uint32_t ur_idx;
652 struct mtd_erase_region_info *kr;
H Hartley Sweetenbcc98a42010-01-15 11:25:38 -0700653 struct region_info_user __user *ur = argp;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700654
Zev Weissb67c5f82008-09-01 05:02:12 -0700655 if (get_user(ur_idx, &(ur->regionindex)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700656 return -EFAULT;
657
Dan Carpenter5e59be12010-09-08 21:39:56 +0200658 if (ur_idx >= mtd->numeraseregions)
659 return -EINVAL;
660
Zev Weissb67c5f82008-09-01 05:02:12 -0700661 kr = &(mtd->eraseregions[ur_idx]);
662
663 if (put_user(kr->offset, &(ur->offset))
664 || put_user(kr->erasesize, &(ur->erasesize))
665 || put_user(kr->numblocks, &(ur->numblocks)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700666 return -EFAULT;
Zev Weissb67c5f82008-09-01 05:02:12 -0700667
Linus Torvalds1da177e2005-04-16 15:20:36 -0700668 break;
669 }
670
671 case MEMGETINFO:
Vasiliy Kulikova0c5a392010-11-06 17:41:24 +0300672 memset(&info, 0, sizeof(info));
Joern Engel73c619e2006-05-30 14:25:35 +0200673 info.type = mtd->type;
674 info.flags = mtd->flags;
675 info.size = mtd->size;
676 info.erasesize = mtd->erasesize;
677 info.writesize = mtd->writesize;
678 info.oobsize = mtd->oobsize;
Brian Norris19fb4342011-08-30 18:45:46 -0700679 /* The below field is obsolete */
680 info.padding = 0;
Joern Engel73c619e2006-05-30 14:25:35 +0200681 if (copy_to_user(argp, &info, sizeof(struct mtd_info_user)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700682 return -EFAULT;
683 break;
684
685 case MEMERASE:
Kevin Cernekee0dc54e92009-04-08 22:52:28 -0700686 case MEMERASE64:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700687 {
688 struct erase_info *erase;
689
Al Viroaeb5d722008-09-02 15:28:45 -0400690 if(!(file->f_mode & FMODE_WRITE))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700691 return -EPERM;
692
Burman Yan95b93a02006-11-15 21:10:29 +0200693 erase=kzalloc(sizeof(struct erase_info),GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700694 if (!erase)
695 ret = -ENOMEM;
696 else {
697 wait_queue_head_t waitq;
698 DECLARE_WAITQUEUE(wait, current);
699
700 init_waitqueue_head(&waitq);
701
Kevin Cernekee0dc54e92009-04-08 22:52:28 -0700702 if (cmd == MEMERASE64) {
703 struct erase_info_user64 einfo64;
704
705 if (copy_from_user(&einfo64, argp,
706 sizeof(struct erase_info_user64))) {
707 kfree(erase);
708 return -EFAULT;
709 }
710 erase->addr = einfo64.start;
711 erase->len = einfo64.length;
712 } else {
713 struct erase_info_user einfo32;
714
715 if (copy_from_user(&einfo32, argp,
716 sizeof(struct erase_info_user))) {
717 kfree(erase);
718 return -EFAULT;
719 }
720 erase->addr = einfo32.start;
721 erase->len = einfo32.length;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700722 }
723 erase->mtd = mtd;
724 erase->callback = mtdchar_erase_callback;
725 erase->priv = (unsigned long)&waitq;
Thomas Gleixner97894cd2005-11-07 11:15:26 +0000726
Linus Torvalds1da177e2005-04-16 15:20:36 -0700727 /*
728 FIXME: Allow INTERRUPTIBLE. Which means
729 not having the wait_queue head on the stack.
Thomas Gleixner97894cd2005-11-07 11:15:26 +0000730
Linus Torvalds1da177e2005-04-16 15:20:36 -0700731 If the wq_head is on the stack, and we
732 leave because we got interrupted, then the
733 wq_head is no longer there when the
734 callback routine tries to wake us up.
735 */
Artem Bityutskiy7e1f0dc2011-12-23 15:25:39 +0200736 ret = mtd_erase(mtd, erase);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700737 if (!ret) {
738 set_current_state(TASK_UNINTERRUPTIBLE);
739 add_wait_queue(&waitq, &wait);
740 if (erase->state != MTD_ERASE_DONE &&
741 erase->state != MTD_ERASE_FAILED)
742 schedule();
743 remove_wait_queue(&waitq, &wait);
744 set_current_state(TASK_RUNNING);
745
746 ret = (erase->state == MTD_ERASE_FAILED)?-EIO:0;
747 }
748 kfree(erase);
749 }
750 break;
751 }
752
753 case MEMWRITEOOB:
754 {
755 struct mtd_oob_buf buf;
Kevin Cernekee97718542009-04-08 22:53:13 -0700756 struct mtd_oob_buf __user *buf_user = argp;
Thomas Gleixner97894cd2005-11-07 11:15:26 +0000757
Kevin Cernekee97718542009-04-08 22:53:13 -0700758 /* NOTE: writes return length to buf_user->length */
759 if (copy_from_user(&buf, argp, sizeof(buf)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700760 ret = -EFAULT;
Kevin Cernekee97718542009-04-08 22:53:13 -0700761 else
Artem Bityutskiy969e57a2011-12-23 17:27:46 +0200762 ret = mtdchar_writeoob(file, mtd, buf.start, buf.length,
Kevin Cernekee97718542009-04-08 22:53:13 -0700763 buf.ptr, &buf_user->length);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700764 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700765 }
766
767 case MEMREADOOB:
768 {
769 struct mtd_oob_buf buf;
Kevin Cernekee97718542009-04-08 22:53:13 -0700770 struct mtd_oob_buf __user *buf_user = argp;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700771
Kevin Cernekee97718542009-04-08 22:53:13 -0700772 /* NOTE: writes return length to buf_user->start */
773 if (copy_from_user(&buf, argp, sizeof(buf)))
774 ret = -EFAULT;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700775 else
Artem Bityutskiy969e57a2011-12-23 17:27:46 +0200776 ret = mtdchar_readoob(file, mtd, buf.start, buf.length,
Kevin Cernekee97718542009-04-08 22:53:13 -0700777 buf.ptr, &buf_user->start);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700778 break;
779 }
780
Kevin Cernekeeaea7cea2009-04-08 22:53:49 -0700781 case MEMWRITEOOB64:
782 {
783 struct mtd_oob_buf64 buf;
784 struct mtd_oob_buf64 __user *buf_user = argp;
785
786 if (copy_from_user(&buf, argp, sizeof(buf)))
787 ret = -EFAULT;
788 else
Artem Bityutskiy969e57a2011-12-23 17:27:46 +0200789 ret = mtdchar_writeoob(file, mtd, buf.start, buf.length,
Kevin Cernekeeaea7cea2009-04-08 22:53:49 -0700790 (void __user *)(uintptr_t)buf.usr_ptr,
791 &buf_user->length);
792 break;
793 }
794
795 case MEMREADOOB64:
796 {
797 struct mtd_oob_buf64 buf;
798 struct mtd_oob_buf64 __user *buf_user = argp;
799
800 if (copy_from_user(&buf, argp, sizeof(buf)))
801 ret = -EFAULT;
802 else
Artem Bityutskiy969e57a2011-12-23 17:27:46 +0200803 ret = mtdchar_readoob(file, mtd, buf.start, buf.length,
Kevin Cernekeeaea7cea2009-04-08 22:53:49 -0700804 (void __user *)(uintptr_t)buf.usr_ptr,
805 &buf_user->length);
806 break;
807 }
808
Brian Norrise99d8b02011-09-09 09:59:03 -0700809 case MEMWRITE:
810 {
Artem Bityutskiy969e57a2011-12-23 17:27:46 +0200811 ret = mtdchar_write_ioctl(mtd,
Brian Norrise99d8b02011-09-09 09:59:03 -0700812 (struct mtd_write_req __user *)arg);
813 break;
814 }
815
Linus Torvalds1da177e2005-04-16 15:20:36 -0700816 case MEMLOCK:
817 {
Harvey Harrison175428b2008-07-03 23:40:14 -0700818 struct erase_info_user einfo;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700819
Harvey Harrison175428b2008-07-03 23:40:14 -0700820 if (copy_from_user(&einfo, argp, sizeof(einfo)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700821 return -EFAULT;
822
823 if (!mtd->lock)
824 ret = -EOPNOTSUPP;
825 else
Harvey Harrison175428b2008-07-03 23:40:14 -0700826 ret = mtd->lock(mtd, einfo.start, einfo.length);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700827 break;
828 }
829
830 case MEMUNLOCK:
831 {
Harvey Harrison175428b2008-07-03 23:40:14 -0700832 struct erase_info_user einfo;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700833
Harvey Harrison175428b2008-07-03 23:40:14 -0700834 if (copy_from_user(&einfo, argp, sizeof(einfo)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700835 return -EFAULT;
836
837 if (!mtd->unlock)
838 ret = -EOPNOTSUPP;
839 else
Harvey Harrison175428b2008-07-03 23:40:14 -0700840 ret = mtd->unlock(mtd, einfo.start, einfo.length);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700841 break;
842 }
843
Richard Cochran99384242010-06-14 18:10:33 +0200844 case MEMISLOCKED:
845 {
846 struct erase_info_user einfo;
847
848 if (copy_from_user(&einfo, argp, sizeof(einfo)))
849 return -EFAULT;
850
851 if (!mtd->is_locked)
852 ret = -EOPNOTSUPP;
853 else
854 ret = mtd->is_locked(mtd, einfo.start, einfo.length);
855 break;
856 }
857
Thomas Gleixner5bd34c02006-05-27 22:16:10 +0200858 /* Legacy interface */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700859 case MEMGETOOBSEL:
860 {
Thomas Gleixner5bd34c02006-05-27 22:16:10 +0200861 struct nand_oobinfo oi;
862
863 if (!mtd->ecclayout)
864 return -EOPNOTSUPP;
865 if (mtd->ecclayout->eccbytes > ARRAY_SIZE(oi.eccpos))
866 return -EINVAL;
867
868 oi.useecc = MTD_NANDECC_AUTOPLACE;
869 memcpy(&oi.eccpos, mtd->ecclayout->eccpos, sizeof(oi.eccpos));
870 memcpy(&oi.oobfree, mtd->ecclayout->oobfree,
871 sizeof(oi.oobfree));
Ricard Wanderlöfd25ade72006-10-17 17:27:11 +0200872 oi.eccbytes = mtd->ecclayout->eccbytes;
Thomas Gleixner5bd34c02006-05-27 22:16:10 +0200873
874 if (copy_to_user(argp, &oi, sizeof(struct nand_oobinfo)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700875 return -EFAULT;
876 break;
877 }
878
879 case MEMGETBADBLOCK:
880 {
881 loff_t offs;
Thomas Gleixner97894cd2005-11-07 11:15:26 +0000882
Linus Torvalds1da177e2005-04-16 15:20:36 -0700883 if (copy_from_user(&offs, argp, sizeof(loff_t)))
884 return -EFAULT;
885 if (!mtd->block_isbad)
886 ret = -EOPNOTSUPP;
887 else
888 return mtd->block_isbad(mtd, offs);
889 break;
890 }
891
892 case MEMSETBADBLOCK:
893 {
894 loff_t offs;
895
896 if (copy_from_user(&offs, argp, sizeof(loff_t)))
897 return -EFAULT;
898 if (!mtd->block_markbad)
899 ret = -EOPNOTSUPP;
900 else
901 return mtd->block_markbad(mtd, offs);
902 break;
903 }
904
David Brownell34a82442008-07-30 12:35:05 -0700905#ifdef CONFIG_HAVE_MTD_OTP
Nicolas Pitre31f42332005-02-08 17:45:55 +0000906 case OTPSELECT:
907 {
908 int mode;
909 if (copy_from_user(&mode, argp, sizeof(int)))
910 return -EFAULT;
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200911
Brian Norrisbeb133f2011-08-30 18:45:41 -0700912 mfi->mode = MTD_FILE_MODE_NORMAL;
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200913
914 ret = otp_select_filemode(mfi, mode);
915
Nicolas Pitre81dba482005-04-01 16:36:15 +0100916 file->f_pos = 0;
Nicolas Pitre31f42332005-02-08 17:45:55 +0000917 break;
918 }
919
920 case OTPGETREGIONCOUNT:
921 case OTPGETREGIONINFO:
922 {
923 struct otp_info *buf = kmalloc(4096, GFP_KERNEL);
924 if (!buf)
925 return -ENOMEM;
926 ret = -EOPNOTSUPP;
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200927 switch (mfi->mode) {
Brian Norrisbeb133f2011-08-30 18:45:41 -0700928 case MTD_FILE_MODE_OTP_FACTORY:
Nicolas Pitre31f42332005-02-08 17:45:55 +0000929 if (mtd->get_fact_prot_info)
Artem Bityutskiya750b5c2011-12-23 18:33:28 +0200930 ret = mtd_get_fact_prot_info(mtd, buf, 4096);
Nicolas Pitre31f42332005-02-08 17:45:55 +0000931 break;
Brian Norrisbeb133f2011-08-30 18:45:41 -0700932 case MTD_FILE_MODE_OTP_USER:
Nicolas Pitre31f42332005-02-08 17:45:55 +0000933 if (mtd->get_user_prot_info)
Artem Bityutskiy855e5d82011-12-23 18:45:11 +0200934 ret = mtd_get_user_prot_info(mtd, buf, 4096);
Nicolas Pitre31f42332005-02-08 17:45:55 +0000935 break;
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200936 default:
937 break;
Nicolas Pitre31f42332005-02-08 17:45:55 +0000938 }
939 if (ret >= 0) {
940 if (cmd == OTPGETREGIONCOUNT) {
941 int nbr = ret / sizeof(struct otp_info);
942 ret = copy_to_user(argp, &nbr, sizeof(int));
943 } else
944 ret = copy_to_user(argp, buf, ret);
945 if (ret)
946 ret = -EFAULT;
947 }
948 kfree(buf);
949 break;
950 }
951
952 case OTPLOCK:
953 {
Harvey Harrison175428b2008-07-03 23:40:14 -0700954 struct otp_info oinfo;
Nicolas Pitre31f42332005-02-08 17:45:55 +0000955
Brian Norrisbeb133f2011-08-30 18:45:41 -0700956 if (mfi->mode != MTD_FILE_MODE_OTP_USER)
Nicolas Pitre31f42332005-02-08 17:45:55 +0000957 return -EINVAL;
Harvey Harrison175428b2008-07-03 23:40:14 -0700958 if (copy_from_user(&oinfo, argp, sizeof(oinfo)))
Nicolas Pitre31f42332005-02-08 17:45:55 +0000959 return -EFAULT;
960 if (!mtd->lock_user_prot_reg)
961 return -EOPNOTSUPP;
Harvey Harrison175428b2008-07-03 23:40:14 -0700962 ret = mtd->lock_user_prot_reg(mtd, oinfo.start, oinfo.length);
Nicolas Pitre31f42332005-02-08 17:45:55 +0000963 break;
964 }
965#endif
966
Brian Norris7854d3f2011-06-23 14:12:08 -0700967 /* This ioctl is being deprecated - it truncates the ECC layout */
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200968 case ECCGETLAYOUT:
969 {
Brian Norriscc26c3c2010-08-24 18:12:00 -0700970 struct nand_ecclayout_user *usrlay;
971
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200972 if (!mtd->ecclayout)
973 return -EOPNOTSUPP;
974
Brian Norriscc26c3c2010-08-24 18:12:00 -0700975 usrlay = kmalloc(sizeof(*usrlay), GFP_KERNEL);
976 if (!usrlay)
977 return -ENOMEM;
978
979 shrink_ecclayout(mtd->ecclayout, usrlay);
980
981 if (copy_to_user(argp, usrlay, sizeof(*usrlay)))
982 ret = -EFAULT;
983 kfree(usrlay);
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200984 break;
985 }
986
987 case ECCGETSTATS:
988 {
989 if (copy_to_user(argp, &mtd->ecc_stats,
990 sizeof(struct mtd_ecc_stats)))
991 return -EFAULT;
992 break;
993 }
994
995 case MTDFILEMODE:
996 {
997 mfi->mode = 0;
998
999 switch(arg) {
Brian Norrisbeb133f2011-08-30 18:45:41 -07001000 case MTD_FILE_MODE_OTP_FACTORY:
1001 case MTD_FILE_MODE_OTP_USER:
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +02001002 ret = otp_select_filemode(mfi, arg);
1003 break;
1004
Brian Norrisbeb133f2011-08-30 18:45:41 -07001005 case MTD_FILE_MODE_RAW:
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +02001006 if (!mtd->read_oob || !mtd->write_oob)
1007 return -EOPNOTSUPP;
1008 mfi->mode = arg;
1009
Brian Norrisbeb133f2011-08-30 18:45:41 -07001010 case MTD_FILE_MODE_NORMAL:
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +02001011 break;
1012 default:
1013 ret = -EINVAL;
1014 }
1015 file->f_pos = 0;
1016 break;
1017 }
1018
Roman Tereshonkovd0f79592010-09-17 13:31:42 +03001019 case BLKPG:
1020 {
Artem Bityutskiy969e57a2011-12-23 17:27:46 +02001021 ret = mtdchar_blkpg_ioctl(mtd,
Roman Tereshonkovd0f79592010-09-17 13:31:42 +03001022 (struct blkpg_ioctl_arg __user *)arg);
1023 break;
1024 }
1025
1026 case BLKRRPART:
1027 {
1028 /* No reread partition feature. Just return ok */
1029 ret = 0;
1030 break;
1031 }
Roman Tereshonkovd0f79592010-09-17 13:31:42 +03001032
Linus Torvalds1da177e2005-04-16 15:20:36 -07001033 default:
1034 ret = -ENOTTY;
1035 }
1036
1037 return ret;
1038} /* memory_ioctl */
1039
Artem Bityutskiy969e57a2011-12-23 17:27:46 +02001040static long mtdchar_unlocked_ioctl(struct file *file, u_int cmd, u_long arg)
Arnd Bergmann55929332010-04-27 00:24:05 +02001041{
1042 int ret;
1043
Arnd Bergmann5aa82942010-06-02 14:28:52 +02001044 mutex_lock(&mtd_mutex);
Artem Bityutskiy969e57a2011-12-23 17:27:46 +02001045 ret = mtdchar_ioctl(file, cmd, arg);
Arnd Bergmann5aa82942010-06-02 14:28:52 +02001046 mutex_unlock(&mtd_mutex);
Arnd Bergmann55929332010-04-27 00:24:05 +02001047
1048 return ret;
1049}
1050
Kevin Cernekee97718542009-04-08 22:53:13 -07001051#ifdef CONFIG_COMPAT
1052
1053struct mtd_oob_buf32 {
1054 u_int32_t start;
1055 u_int32_t length;
1056 compat_caddr_t ptr; /* unsigned char* */
1057};
1058
1059#define MEMWRITEOOB32 _IOWR('M', 3, struct mtd_oob_buf32)
1060#define MEMREADOOB32 _IOWR('M', 4, struct mtd_oob_buf32)
1061
Artem Bityutskiy969e57a2011-12-23 17:27:46 +02001062static long mtdchar_compat_ioctl(struct file *file, unsigned int cmd,
Kevin Cernekee97718542009-04-08 22:53:13 -07001063 unsigned long arg)
1064{
1065 struct mtd_file_info *mfi = file->private_data;
1066 struct mtd_info *mtd = mfi->mtd;
David Woodhouse0b6585c2009-05-29 16:09:08 +01001067 void __user *argp = compat_ptr(arg);
Kevin Cernekee97718542009-04-08 22:53:13 -07001068 int ret = 0;
1069
Arnd Bergmann5aa82942010-06-02 14:28:52 +02001070 mutex_lock(&mtd_mutex);
Kevin Cernekee97718542009-04-08 22:53:13 -07001071
1072 switch (cmd) {
1073 case MEMWRITEOOB32:
1074 {
1075 struct mtd_oob_buf32 buf;
1076 struct mtd_oob_buf32 __user *buf_user = argp;
1077
1078 if (copy_from_user(&buf, argp, sizeof(buf)))
1079 ret = -EFAULT;
1080 else
Artem Bityutskiy969e57a2011-12-23 17:27:46 +02001081 ret = mtdchar_writeoob(file, mtd, buf.start,
Kevin Cernekee97718542009-04-08 22:53:13 -07001082 buf.length, compat_ptr(buf.ptr),
1083 &buf_user->length);
1084 break;
1085 }
1086
1087 case MEMREADOOB32:
1088 {
1089 struct mtd_oob_buf32 buf;
1090 struct mtd_oob_buf32 __user *buf_user = argp;
1091
1092 /* NOTE: writes return length to buf->start */
1093 if (copy_from_user(&buf, argp, sizeof(buf)))
1094 ret = -EFAULT;
1095 else
Artem Bityutskiy969e57a2011-12-23 17:27:46 +02001096 ret = mtdchar_readoob(file, mtd, buf.start,
Kevin Cernekee97718542009-04-08 22:53:13 -07001097 buf.length, compat_ptr(buf.ptr),
1098 &buf_user->start);
1099 break;
1100 }
1101 default:
Artem Bityutskiy969e57a2011-12-23 17:27:46 +02001102 ret = mtdchar_ioctl(file, cmd, (unsigned long)argp);
Kevin Cernekee97718542009-04-08 22:53:13 -07001103 }
1104
Arnd Bergmann5aa82942010-06-02 14:28:52 +02001105 mutex_unlock(&mtd_mutex);
Kevin Cernekee97718542009-04-08 22:53:13 -07001106
1107 return ret;
1108}
1109
1110#endif /* CONFIG_COMPAT */
1111
David Howells402d3262009-02-12 10:40:00 +00001112/*
1113 * try to determine where a shared mapping can be made
1114 * - only supported for NOMMU at the moment (MMU can't doesn't copy private
1115 * mappings)
1116 */
1117#ifndef CONFIG_MMU
Artem Bityutskiy969e57a2011-12-23 17:27:46 +02001118static unsigned long mtdchar_get_unmapped_area(struct file *file,
David Howells402d3262009-02-12 10:40:00 +00001119 unsigned long addr,
1120 unsigned long len,
1121 unsigned long pgoff,
1122 unsigned long flags)
1123{
1124 struct mtd_file_info *mfi = file->private_data;
1125 struct mtd_info *mtd = mfi->mtd;
1126
1127 if (mtd->get_unmapped_area) {
1128 unsigned long offset;
1129
1130 if (addr != 0)
1131 return (unsigned long) -EINVAL;
1132
1133 if (len > mtd->size || pgoff >= (mtd->size >> PAGE_SHIFT))
1134 return (unsigned long) -EINVAL;
1135
1136 offset = pgoff << PAGE_SHIFT;
1137 if (offset > mtd->size - len)
1138 return (unsigned long) -EINVAL;
1139
Artem Bityutskiy04c601b2011-12-23 17:10:15 +02001140 return mtd_get_unmapped_area(mtd, len, offset, flags);
David Howells402d3262009-02-12 10:40:00 +00001141 }
1142
1143 /* can't map directly */
1144 return (unsigned long) -ENOSYS;
1145}
1146#endif
1147
1148/*
1149 * set up a mapping for shared memory segments
1150 */
Artem Bityutskiy969e57a2011-12-23 17:27:46 +02001151static int mtdchar_mmap(struct file *file, struct vm_area_struct *vma)
David Howells402d3262009-02-12 10:40:00 +00001152{
1153#ifdef CONFIG_MMU
1154 struct mtd_file_info *mfi = file->private_data;
1155 struct mtd_info *mtd = mfi->mtd;
Anatolij Gustschindd02b672010-06-15 09:30:15 +02001156 struct map_info *map = mtd->priv;
1157 unsigned long start;
1158 unsigned long off;
1159 u32 len;
David Howells402d3262009-02-12 10:40:00 +00001160
Anatolij Gustschindd02b672010-06-15 09:30:15 +02001161 if (mtd->type == MTD_RAM || mtd->type == MTD_ROM) {
1162 off = vma->vm_pgoff << PAGE_SHIFT;
1163 start = map->phys;
1164 len = PAGE_ALIGN((start & ~PAGE_MASK) + map->size);
1165 start &= PAGE_MASK;
1166 if ((vma->vm_end - vma->vm_start + off) > len)
1167 return -EINVAL;
1168
1169 off += start;
1170 vma->vm_pgoff = off >> PAGE_SHIFT;
1171 vma->vm_flags |= VM_IO | VM_RESERVED;
1172
1173#ifdef pgprot_noncached
1174 if (file->f_flags & O_DSYNC || off >= __pa(high_memory))
1175 vma->vm_page_prot = pgprot_noncached(vma->vm_page_prot);
1176#endif
1177 if (io_remap_pfn_range(vma, vma->vm_start, off >> PAGE_SHIFT,
1178 vma->vm_end - vma->vm_start,
1179 vma->vm_page_prot))
1180 return -EAGAIN;
1181
David Howells402d3262009-02-12 10:40:00 +00001182 return 0;
Anatolij Gustschindd02b672010-06-15 09:30:15 +02001183 }
David Howells402d3262009-02-12 10:40:00 +00001184 return -ENOSYS;
1185#else
1186 return vma->vm_flags & VM_SHARED ? 0 : -ENOSYS;
1187#endif
1188}
1189
Arjan van de Vend54b1fd2007-02-12 00:55:34 -08001190static const struct file_operations mtd_fops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001191 .owner = THIS_MODULE,
Artem Bityutskiy969e57a2011-12-23 17:27:46 +02001192 .llseek = mtdchar_lseek,
1193 .read = mtdchar_read,
1194 .write = mtdchar_write,
1195 .unlocked_ioctl = mtdchar_unlocked_ioctl,
Kevin Cernekee97718542009-04-08 22:53:13 -07001196#ifdef CONFIG_COMPAT
Artem Bityutskiy969e57a2011-12-23 17:27:46 +02001197 .compat_ioctl = mtdchar_compat_ioctl,
Kevin Cernekee97718542009-04-08 22:53:13 -07001198#endif
Artem Bityutskiy969e57a2011-12-23 17:27:46 +02001199 .open = mtdchar_open,
1200 .release = mtdchar_close,
1201 .mmap = mtdchar_mmap,
David Howells402d3262009-02-12 10:40:00 +00001202#ifndef CONFIG_MMU
Artem Bityutskiy969e57a2011-12-23 17:27:46 +02001203 .get_unmapped_area = mtdchar_get_unmapped_area,
David Howells402d3262009-02-12 10:40:00 +00001204#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07001205};
1206
Al Viro51139ad2010-07-25 23:47:46 +04001207static struct dentry *mtd_inodefs_mount(struct file_system_type *fs_type,
1208 int flags, const char *dev_name, void *data)
Kirill A. Shutemovcd874232010-05-17 16:55:47 +03001209{
Al Viroc74a1cb2011-01-12 16:59:34 -05001210 return mount_pseudo(fs_type, "mtd_inode:", NULL, NULL, MTD_INODE_FS_MAGIC);
Kirill A. Shutemovcd874232010-05-17 16:55:47 +03001211}
1212
1213static struct file_system_type mtd_inodefs_type = {
1214 .name = "mtd_inodefs",
Al Viro51139ad2010-07-25 23:47:46 +04001215 .mount = mtd_inodefs_mount,
Kirill A. Shutemovcd874232010-05-17 16:55:47 +03001216 .kill_sb = kill_anon_super,
1217};
1218
1219static void mtdchar_notify_add(struct mtd_info *mtd)
1220{
1221}
1222
1223static void mtdchar_notify_remove(struct mtd_info *mtd)
1224{
1225 struct inode *mtd_ino = ilookup(mtd_inode_mnt->mnt_sb, mtd->index);
1226
1227 if (mtd_ino) {
1228 /* Destroy the inode if it exists */
Miklos Szeredi6d6b77f2011-10-28 14:13:28 +02001229 clear_nlink(mtd_ino);
Kirill A. Shutemovcd874232010-05-17 16:55:47 +03001230 iput(mtd_ino);
1231 }
1232}
1233
1234static struct mtd_notifier mtdchar_notifier = {
1235 .add = mtdchar_notify_add,
1236 .remove = mtdchar_notify_remove,
1237};
1238
Linus Torvalds1da177e2005-04-16 15:20:36 -07001239static int __init init_mtdchar(void)
1240{
Kirill A. Shutemovcd874232010-05-17 16:55:47 +03001241 int ret;
David Brownell1f24b5a2009-03-26 00:42:41 -07001242
Kirill A. Shutemovcd874232010-05-17 16:55:47 +03001243 ret = __register_chrdev(MTD_CHAR_MAJOR, 0, 1 << MINORBITS,
Ben Hutchingsdad0db32010-01-29 21:00:04 +00001244 "mtd", &mtd_fops);
Kirill A. Shutemovcd874232010-05-17 16:55:47 +03001245 if (ret < 0) {
1246 pr_notice("Can't allocate major number %d for "
1247 "Memory Technology Devices.\n", MTD_CHAR_MAJOR);
1248 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001249 }
1250
Kirill A. Shutemovcd874232010-05-17 16:55:47 +03001251 ret = register_filesystem(&mtd_inodefs_type);
1252 if (ret) {
1253 pr_notice("Can't register mtd_inodefs filesystem: %d\n", ret);
1254 goto err_unregister_chdev;
1255 }
1256
1257 mtd_inode_mnt = kern_mount(&mtd_inodefs_type);
1258 if (IS_ERR(mtd_inode_mnt)) {
1259 ret = PTR_ERR(mtd_inode_mnt);
1260 pr_notice("Error mounting mtd_inodefs filesystem: %d\n", ret);
1261 goto err_unregister_filesystem;
1262 }
1263 register_mtd_user(&mtdchar_notifier);
1264
1265 return ret;
1266
1267err_unregister_filesystem:
1268 unregister_filesystem(&mtd_inodefs_type);
1269err_unregister_chdev:
1270 __unregister_chrdev(MTD_CHAR_MAJOR, 0, 1 << MINORBITS, "mtd");
1271 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001272}
1273
1274static void __exit cleanup_mtdchar(void)
1275{
Kirill A. Shutemovcd874232010-05-17 16:55:47 +03001276 unregister_mtd_user(&mtdchar_notifier);
Tim Chen423e0ab2011-07-19 09:32:38 -07001277 kern_unmount(mtd_inode_mnt);
Kirill A. Shutemovcd874232010-05-17 16:55:47 +03001278 unregister_filesystem(&mtd_inodefs_type);
Ben Hutchingsdad0db32010-01-29 21:00:04 +00001279 __unregister_chrdev(MTD_CHAR_MAJOR, 0, 1 << MINORBITS, "mtd");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001280}
1281
1282module_init(init_mtdchar);
1283module_exit(cleanup_mtdchar);
1284
David Brownell1f24b5a2009-03-26 00:42:41 -07001285MODULE_ALIAS_CHARDEV_MAJOR(MTD_CHAR_MAJOR);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001286
1287MODULE_LICENSE("GPL");
1288MODULE_AUTHOR("David Woodhouse <dwmw2@infradead.org>");
1289MODULE_DESCRIPTION("Direct character-device access to MTD devices");
Scott James Remnant90160e12009-03-02 18:42:39 +00001290MODULE_ALIAS_CHARDEV_MAJOR(MTD_CHAR_MAJOR);