blob: e74f570a7b932941231f691dcbc3fa6543223e6a [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:
Nicolas Pitre31f42332005-02-08 17:45:55 +0000216 ret = mtd->read_fact_prot_reg(mtd, *ppos, len, &retlen, kbuf);
217 break;
Brian Norrisbeb133f2011-08-30 18:45:41 -0700218 case MTD_FILE_MODE_OTP_USER:
Nicolas Pitre31f42332005-02-08 17:45:55 +0000219 ret = mtd->read_user_prot_reg(mtd, *ppos, len, &retlen, kbuf);
220 break;
Brian Norrisbeb133f2011-08-30 18:45:41 -0700221 case MTD_FILE_MODE_RAW:
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200222 {
223 struct mtd_oob_ops ops;
224
Brian Norris0612b9d2011-08-30 18:45:40 -0700225 ops.mode = MTD_OPS_RAW;
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200226 ops.datbuf = kbuf;
227 ops.oobbuf = NULL;
228 ops.len = len;
229
Artem Bityutskiyfd2819b2011-12-23 18:27:05 +0200230 ret = mtd_read_oob(mtd, *ppos, &ops);
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200231 retlen = ops.retlen;
232 break;
233 }
Nicolas Pitre31f42332005-02-08 17:45:55 +0000234 default:
Artem Bityutskiy329ad392011-12-23 17:30:16 +0200235 ret = mtd_read(mtd, *ppos, len, &retlen, kbuf);
Nicolas Pitre31f42332005-02-08 17:45:55 +0000236 }
Brian Norris7854d3f2011-06-23 14:12:08 -0700237 /* Nand returns -EBADMSG on ECC errors, but it returns
Linus Torvalds1da177e2005-04-16 15:20:36 -0700238 * the data. For our userspace tools it is important
Brian Norris7854d3f2011-06-23 14:12:08 -0700239 * to dump areas with ECC errors!
Thomas Gleixner9a1fcdf2006-05-29 14:56:39 +0200240 * For kernel internal usage it also might return -EUCLEAN
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300241 * to signal the caller that a bitflip has occurred and has
Thomas Gleixner9a1fcdf2006-05-29 14:56:39 +0200242 * been corrected by the ECC algorithm.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700243 * Userspace software which accesses NAND this way
244 * must be aware of the fact that it deals with NAND
245 */
Brian Norrisd57f40542011-09-20 18:34:25 -0700246 if (!ret || mtd_is_bitflip_or_eccerr(ret)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700247 *ppos += retlen;
248 if (copy_to_user(buf, kbuf, retlen)) {
Thomas Gleixnerf4a43cf2006-05-28 11:01:53 +0200249 kfree(kbuf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700250 return -EFAULT;
251 }
252 else
253 total_retlen += retlen;
254
255 count -= retlen;
256 buf += retlen;
Nicolas Pitre31f42332005-02-08 17:45:55 +0000257 if (retlen == 0)
258 count = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700259 }
260 else {
261 kfree(kbuf);
262 return ret;
263 }
Thomas Gleixner97894cd2005-11-07 11:15:26 +0000264
Linus Torvalds1da177e2005-04-16 15:20:36 -0700265 }
266
Thago Galesib802c072006-04-17 17:38:15 +0100267 kfree(kbuf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700268 return total_retlen;
Artem Bityutskiy969e57a2011-12-23 17:27:46 +0200269} /* mtdchar_read */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700270
Artem Bityutskiy969e57a2011-12-23 17:27:46 +0200271static ssize_t mtdchar_write(struct file *file, const char __user *buf, size_t count,
272 loff_t *ppos)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700273{
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200274 struct mtd_file_info *mfi = file->private_data;
275 struct mtd_info *mtd = mfi->mtd;
Grant Erickson3e45cf52011-04-08 08:51:33 -0700276 size_t size = count;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700277 char *kbuf;
278 size_t retlen;
279 size_t total_retlen=0;
280 int ret=0;
281 int len;
282
Brian Norris289c0522011-07-19 10:06:09 -0700283 pr_debug("MTD_write\n");
Thomas Gleixner97894cd2005-11-07 11:15:26 +0000284
Linus Torvalds1da177e2005-04-16 15:20:36 -0700285 if (*ppos == mtd->size)
286 return -ENOSPC;
Thomas Gleixner97894cd2005-11-07 11:15:26 +0000287
Linus Torvalds1da177e2005-04-16 15:20:36 -0700288 if (*ppos + count > mtd->size)
289 count = mtd->size - *ppos;
290
291 if (!count)
292 return 0;
293
Grant Erickson3e45cf52011-04-08 08:51:33 -0700294 kbuf = mtd_kmalloc_up_to(mtd, &size);
Thago Galesib802c072006-04-17 17:38:15 +0100295 if (!kbuf)
296 return -ENOMEM;
297
Linus Torvalds1da177e2005-04-16 15:20:36 -0700298 while (count) {
Grant Erickson3e45cf52011-04-08 08:51:33 -0700299 len = min_t(size_t, count, size);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700300
Linus Torvalds1da177e2005-04-16 15:20:36 -0700301 if (copy_from_user(kbuf, buf, len)) {
302 kfree(kbuf);
303 return -EFAULT;
304 }
Thomas Gleixner97894cd2005-11-07 11:15:26 +0000305
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200306 switch (mfi->mode) {
Brian Norrisbeb133f2011-08-30 18:45:41 -0700307 case MTD_FILE_MODE_OTP_FACTORY:
Nicolas Pitre31f42332005-02-08 17:45:55 +0000308 ret = -EROFS;
309 break;
Brian Norrisbeb133f2011-08-30 18:45:41 -0700310 case MTD_FILE_MODE_OTP_USER:
Nicolas Pitre31f42332005-02-08 17:45:55 +0000311 if (!mtd->write_user_prot_reg) {
312 ret = -EOPNOTSUPP;
313 break;
314 }
315 ret = mtd->write_user_prot_reg(mtd, *ppos, len, &retlen, kbuf);
316 break;
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200317
Brian Norrisbeb133f2011-08-30 18:45:41 -0700318 case MTD_FILE_MODE_RAW:
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200319 {
320 struct mtd_oob_ops ops;
321
Brian Norris0612b9d2011-08-30 18:45:40 -0700322 ops.mode = MTD_OPS_RAW;
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200323 ops.datbuf = kbuf;
324 ops.oobbuf = NULL;
Peter Wippichbf514082011-06-06 15:50:58 +0200325 ops.ooboffs = 0;
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200326 ops.len = len;
327
328 ret = mtd->write_oob(mtd, *ppos, &ops);
329 retlen = ops.retlen;
330 break;
331 }
332
Nicolas Pitre31f42332005-02-08 17:45:55 +0000333 default:
Artem Bityutskiyeda95cb2011-12-23 17:35:41 +0200334 ret = mtd_write(mtd, *ppos, len, &retlen, kbuf);
Nicolas Pitre31f42332005-02-08 17:45:55 +0000335 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700336 if (!ret) {
337 *ppos += retlen;
338 total_retlen += retlen;
339 count -= retlen;
340 buf += retlen;
341 }
342 else {
343 kfree(kbuf);
344 return ret;
345 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700346 }
347
Thago Galesib802c072006-04-17 17:38:15 +0100348 kfree(kbuf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700349 return total_retlen;
Artem Bityutskiy969e57a2011-12-23 17:27:46 +0200350} /* mtdchar_write */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700351
352/*======================================================================
353
354 IOCTL calls for getting device parameters.
355
356======================================================================*/
357static void mtdchar_erase_callback (struct erase_info *instr)
358{
359 wake_up((wait_queue_head_t *)instr->priv);
360}
361
David Brownell34a82442008-07-30 12:35:05 -0700362#ifdef CONFIG_HAVE_MTD_OTP
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200363static int otp_select_filemode(struct mtd_file_info *mfi, int mode)
364{
365 struct mtd_info *mtd = mfi->mtd;
366 int ret = 0;
367
368 switch (mode) {
369 case MTD_OTP_FACTORY:
370 if (!mtd->read_fact_prot_reg)
371 ret = -EOPNOTSUPP;
372 else
Brian Norrisbeb133f2011-08-30 18:45:41 -0700373 mfi->mode = MTD_FILE_MODE_OTP_FACTORY;
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200374 break;
375 case MTD_OTP_USER:
376 if (!mtd->read_fact_prot_reg)
377 ret = -EOPNOTSUPP;
378 else
Brian Norrisbeb133f2011-08-30 18:45:41 -0700379 mfi->mode = MTD_FILE_MODE_OTP_USER;
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200380 break;
381 default:
382 ret = -EINVAL;
383 case MTD_OTP_OFF:
384 break;
385 }
386 return ret;
387}
388#else
389# define otp_select_filemode(f,m) -EOPNOTSUPP
390#endif
391
Artem Bityutskiy969e57a2011-12-23 17:27:46 +0200392static int mtdchar_writeoob(struct file *file, struct mtd_info *mtd,
Kevin Cernekee97718542009-04-08 22:53:13 -0700393 uint64_t start, uint32_t length, void __user *ptr,
394 uint32_t __user *retp)
395{
Brian Norris9ce244b2011-08-30 18:45:37 -0700396 struct mtd_file_info *mfi = file->private_data;
Kevin Cernekee97718542009-04-08 22:53:13 -0700397 struct mtd_oob_ops ops;
398 uint32_t retlen;
399 int ret = 0;
400
401 if (!(file->f_mode & FMODE_WRITE))
402 return -EPERM;
403
404 if (length > 4096)
405 return -EINVAL;
406
407 if (!mtd->write_oob)
408 ret = -EOPNOTSUPP;
409 else
Roel Kluin00404762010-01-29 10:35:04 +0100410 ret = access_ok(VERIFY_READ, ptr, length) ? 0 : -EFAULT;
Kevin Cernekee97718542009-04-08 22:53:13 -0700411
412 if (ret)
413 return ret;
414
415 ops.ooblen = length;
Brian Norris305b93f2011-08-23 17:17:32 -0700416 ops.ooboffs = start & (mtd->writesize - 1);
Kevin Cernekee97718542009-04-08 22:53:13 -0700417 ops.datbuf = NULL;
Brian Norrisbeb133f2011-08-30 18:45:41 -0700418 ops.mode = (mfi->mode == MTD_FILE_MODE_RAW) ? MTD_OPS_RAW :
Brian Norris0612b9d2011-08-30 18:45:40 -0700419 MTD_OPS_PLACE_OOB;
Kevin Cernekee97718542009-04-08 22:53:13 -0700420
421 if (ops.ooboffs && ops.ooblen > (mtd->oobsize - ops.ooboffs))
422 return -EINVAL;
423
Julia Lawalldf1f1d12010-05-22 10:22:49 +0200424 ops.oobbuf = memdup_user(ptr, length);
425 if (IS_ERR(ops.oobbuf))
426 return PTR_ERR(ops.oobbuf);
Kevin Cernekee97718542009-04-08 22:53:13 -0700427
Brian Norris305b93f2011-08-23 17:17:32 -0700428 start &= ~((uint64_t)mtd->writesize - 1);
Kevin Cernekee97718542009-04-08 22:53:13 -0700429 ret = mtd->write_oob(mtd, start, &ops);
430
431 if (ops.oobretlen > 0xFFFFFFFFU)
432 ret = -EOVERFLOW;
433 retlen = ops.oobretlen;
434 if (copy_to_user(retp, &retlen, sizeof(length)))
435 ret = -EFAULT;
436
437 kfree(ops.oobbuf);
438 return ret;
439}
440
Artem Bityutskiy969e57a2011-12-23 17:27:46 +0200441static int mtdchar_readoob(struct file *file, struct mtd_info *mtd,
Brian Norrisc46f6482011-08-30 18:45:38 -0700442 uint64_t start, uint32_t length, void __user *ptr,
443 uint32_t __user *retp)
Kevin Cernekee97718542009-04-08 22:53:13 -0700444{
Brian Norrisc46f6482011-08-30 18:45:38 -0700445 struct mtd_file_info *mfi = file->private_data;
Kevin Cernekee97718542009-04-08 22:53:13 -0700446 struct mtd_oob_ops ops;
447 int ret = 0;
448
449 if (length > 4096)
450 return -EINVAL;
451
452 if (!mtd->read_oob)
453 ret = -EOPNOTSUPP;
454 else
455 ret = access_ok(VERIFY_WRITE, ptr,
456 length) ? 0 : -EFAULT;
457 if (ret)
458 return ret;
459
460 ops.ooblen = length;
Brian Norris305b93f2011-08-23 17:17:32 -0700461 ops.ooboffs = start & (mtd->writesize - 1);
Kevin Cernekee97718542009-04-08 22:53:13 -0700462 ops.datbuf = NULL;
Brian Norrisbeb133f2011-08-30 18:45:41 -0700463 ops.mode = (mfi->mode == MTD_FILE_MODE_RAW) ? MTD_OPS_RAW :
Brian Norris0612b9d2011-08-30 18:45:40 -0700464 MTD_OPS_PLACE_OOB;
Kevin Cernekee97718542009-04-08 22:53:13 -0700465
466 if (ops.ooboffs && ops.ooblen > (mtd->oobsize - ops.ooboffs))
467 return -EINVAL;
468
469 ops.oobbuf = kmalloc(length, GFP_KERNEL);
470 if (!ops.oobbuf)
471 return -ENOMEM;
472
Brian Norris305b93f2011-08-23 17:17:32 -0700473 start &= ~((uint64_t)mtd->writesize - 1);
Artem Bityutskiyfd2819b2011-12-23 18:27:05 +0200474 ret = mtd_read_oob(mtd, start, &ops);
Kevin Cernekee97718542009-04-08 22:53:13 -0700475
476 if (put_user(ops.oobretlen, retp))
477 ret = -EFAULT;
478 else if (ops.oobretlen && copy_to_user(ptr, ops.oobbuf,
479 ops.oobretlen))
480 ret = -EFAULT;
481
482 kfree(ops.oobbuf);
Brian Norris041e4572011-06-23 16:45:24 -0700483
484 /*
485 * NAND returns -EBADMSG on ECC errors, but it returns the OOB
486 * data. For our userspace tools it is important to dump areas
487 * with ECC errors!
488 * For kernel internal usage it also might return -EUCLEAN
489 * to signal the caller that a bitflip has occured and has
490 * been corrected by the ECC algorithm.
491 *
Brian Norrisc478d7e2011-06-28 16:29:00 -0700492 * Note: currently the standard NAND function, nand_read_oob_std,
493 * does not calculate ECC for the OOB area, so do not rely on
494 * this behavior unless you have replaced it with your own.
Brian Norris041e4572011-06-23 16:45:24 -0700495 */
Brian Norrisd57f40542011-09-20 18:34:25 -0700496 if (mtd_is_bitflip_or_eccerr(ret))
Brian Norris041e4572011-06-23 16:45:24 -0700497 return 0;
498
Kevin Cernekee97718542009-04-08 22:53:13 -0700499 return ret;
500}
501
Brian Norriscc26c3c2010-08-24 18:12:00 -0700502/*
503 * Copies (and truncates, if necessary) data from the larger struct,
504 * nand_ecclayout, to the smaller, deprecated layout struct,
Brian Norris92394b5c2011-07-20 09:53:42 -0700505 * nand_ecclayout_user. This is necessary only to support the deprecated
Brian Norriscc26c3c2010-08-24 18:12:00 -0700506 * API ioctl ECCGETLAYOUT while allowing all new functionality to use
507 * nand_ecclayout flexibly (i.e. the struct may change size in new
508 * releases without requiring major rewrites).
509 */
510static int shrink_ecclayout(const struct nand_ecclayout *from,
511 struct nand_ecclayout_user *to)
512{
513 int i;
514
515 if (!from || !to)
516 return -EINVAL;
517
518 memset(to, 0, sizeof(*to));
519
Brian Norris0ceacf32010-09-19 23:57:12 -0700520 to->eccbytes = min((int)from->eccbytes, MTD_MAX_ECCPOS_ENTRIES);
Brian Norriscc26c3c2010-08-24 18:12:00 -0700521 for (i = 0; i < to->eccbytes; i++)
522 to->eccpos[i] = from->eccpos[i];
523
524 for (i = 0; i < MTD_MAX_OOBFREE_ENTRIES; i++) {
525 if (from->oobfree[i].length == 0 &&
526 from->oobfree[i].offset == 0)
527 break;
528 to->oobavail += from->oobfree[i].length;
529 to->oobfree[i] = from->oobfree[i];
530 }
531
532 return 0;
533}
534
Artem Bityutskiy969e57a2011-12-23 17:27:46 +0200535static int mtdchar_blkpg_ioctl(struct mtd_info *mtd,
Roman Tereshonkovd0f79592010-09-17 13:31:42 +0300536 struct blkpg_ioctl_arg __user *arg)
537{
538 struct blkpg_ioctl_arg a;
539 struct blkpg_partition p;
540
541 if (!capable(CAP_SYS_ADMIN))
542 return -EPERM;
543
Roman Tereshonkovd0f79592010-09-17 13:31:42 +0300544 if (copy_from_user(&a, arg, sizeof(struct blkpg_ioctl_arg)))
545 return -EFAULT;
546
547 if (copy_from_user(&p, a.data, sizeof(struct blkpg_partition)))
548 return -EFAULT;
549
550 switch (a.op) {
551 case BLKPG_ADD_PARTITION:
552
Roman Tereshonkova7e93dc2010-11-23 14:17:17 +0200553 /* Only master mtd device must be used to add partitions */
554 if (mtd_is_partition(mtd))
555 return -EINVAL;
556
Roman Tereshonkovd0f79592010-09-17 13:31:42 +0300557 return mtd_add_partition(mtd, p.devname, p.start, p.length);
558
559 case BLKPG_DEL_PARTITION:
560
561 if (p.pno < 0)
562 return -EINVAL;
563
564 return mtd_del_partition(mtd, p.pno);
565
566 default:
567 return -EINVAL;
568 }
569}
Roman Tereshonkovd0f79592010-09-17 13:31:42 +0300570
Artem Bityutskiy969e57a2011-12-23 17:27:46 +0200571static int mtdchar_write_ioctl(struct mtd_info *mtd,
Brian Norrise99d8b02011-09-09 09:59:03 -0700572 struct mtd_write_req __user *argp)
573{
574 struct mtd_write_req req;
575 struct mtd_oob_ops ops;
576 void __user *usr_data, *usr_oob;
577 int ret;
578
579 if (copy_from_user(&req, argp, sizeof(req)) ||
580 !access_ok(VERIFY_READ, req.usr_data, req.len) ||
581 !access_ok(VERIFY_READ, req.usr_oob, req.ooblen))
582 return -EFAULT;
583 if (!mtd->write_oob)
584 return -EOPNOTSUPP;
585
586 ops.mode = req.mode;
587 ops.len = (size_t)req.len;
588 ops.ooblen = (size_t)req.ooblen;
589 ops.ooboffs = 0;
590
591 usr_data = (void __user *)(uintptr_t)req.usr_data;
592 usr_oob = (void __user *)(uintptr_t)req.usr_oob;
593
594 if (req.usr_data) {
595 ops.datbuf = memdup_user(usr_data, ops.len);
596 if (IS_ERR(ops.datbuf))
597 return PTR_ERR(ops.datbuf);
598 } else {
599 ops.datbuf = NULL;
600 }
601
602 if (req.usr_oob) {
603 ops.oobbuf = memdup_user(usr_oob, ops.ooblen);
604 if (IS_ERR(ops.oobbuf)) {
605 kfree(ops.datbuf);
606 return PTR_ERR(ops.oobbuf);
607 }
608 } else {
609 ops.oobbuf = NULL;
610 }
611
612 ret = mtd->write_oob(mtd, (loff_t)req.start, &ops);
613
614 kfree(ops.datbuf);
615 kfree(ops.oobbuf);
616
617 return ret;
618}
619
Artem Bityutskiy969e57a2011-12-23 17:27:46 +0200620static int mtdchar_ioctl(struct file *file, u_int cmd, u_long arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700621{
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200622 struct mtd_file_info *mfi = file->private_data;
623 struct mtd_info *mtd = mfi->mtd;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700624 void __user *argp = (void __user *)arg;
625 int ret = 0;
626 u_long size;
Joern Engel73c619e2006-05-30 14:25:35 +0200627 struct mtd_info_user info;
Thomas Gleixner97894cd2005-11-07 11:15:26 +0000628
Brian Norris289c0522011-07-19 10:06:09 -0700629 pr_debug("MTD_ioctl\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700630
631 size = (cmd & IOCSIZE_MASK) >> IOCSIZE_SHIFT;
632 if (cmd & IOC_IN) {
633 if (!access_ok(VERIFY_READ, argp, size))
634 return -EFAULT;
635 }
636 if (cmd & IOC_OUT) {
637 if (!access_ok(VERIFY_WRITE, argp, size))
638 return -EFAULT;
639 }
Thomas Gleixner97894cd2005-11-07 11:15:26 +0000640
Linus Torvalds1da177e2005-04-16 15:20:36 -0700641 switch (cmd) {
642 case MEMGETREGIONCOUNT:
643 if (copy_to_user(argp, &(mtd->numeraseregions), sizeof(int)))
644 return -EFAULT;
645 break;
646
647 case MEMGETREGIONINFO:
648 {
Zev Weissb67c5f82008-09-01 05:02:12 -0700649 uint32_t ur_idx;
650 struct mtd_erase_region_info *kr;
H Hartley Sweetenbcc98a42010-01-15 11:25:38 -0700651 struct region_info_user __user *ur = argp;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700652
Zev Weissb67c5f82008-09-01 05:02:12 -0700653 if (get_user(ur_idx, &(ur->regionindex)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700654 return -EFAULT;
655
Dan Carpenter5e59be12010-09-08 21:39:56 +0200656 if (ur_idx >= mtd->numeraseregions)
657 return -EINVAL;
658
Zev Weissb67c5f82008-09-01 05:02:12 -0700659 kr = &(mtd->eraseregions[ur_idx]);
660
661 if (put_user(kr->offset, &(ur->offset))
662 || put_user(kr->erasesize, &(ur->erasesize))
663 || put_user(kr->numblocks, &(ur->numblocks)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700664 return -EFAULT;
Zev Weissb67c5f82008-09-01 05:02:12 -0700665
Linus Torvalds1da177e2005-04-16 15:20:36 -0700666 break;
667 }
668
669 case MEMGETINFO:
Vasiliy Kulikova0c5a392010-11-06 17:41:24 +0300670 memset(&info, 0, sizeof(info));
Joern Engel73c619e2006-05-30 14:25:35 +0200671 info.type = mtd->type;
672 info.flags = mtd->flags;
673 info.size = mtd->size;
674 info.erasesize = mtd->erasesize;
675 info.writesize = mtd->writesize;
676 info.oobsize = mtd->oobsize;
Brian Norris19fb4342011-08-30 18:45:46 -0700677 /* The below field is obsolete */
678 info.padding = 0;
Joern Engel73c619e2006-05-30 14:25:35 +0200679 if (copy_to_user(argp, &info, sizeof(struct mtd_info_user)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700680 return -EFAULT;
681 break;
682
683 case MEMERASE:
Kevin Cernekee0dc54e92009-04-08 22:52:28 -0700684 case MEMERASE64:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700685 {
686 struct erase_info *erase;
687
Al Viroaeb5d722008-09-02 15:28:45 -0400688 if(!(file->f_mode & FMODE_WRITE))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700689 return -EPERM;
690
Burman Yan95b93a02006-11-15 21:10:29 +0200691 erase=kzalloc(sizeof(struct erase_info),GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700692 if (!erase)
693 ret = -ENOMEM;
694 else {
695 wait_queue_head_t waitq;
696 DECLARE_WAITQUEUE(wait, current);
697
698 init_waitqueue_head(&waitq);
699
Kevin Cernekee0dc54e92009-04-08 22:52:28 -0700700 if (cmd == MEMERASE64) {
701 struct erase_info_user64 einfo64;
702
703 if (copy_from_user(&einfo64, argp,
704 sizeof(struct erase_info_user64))) {
705 kfree(erase);
706 return -EFAULT;
707 }
708 erase->addr = einfo64.start;
709 erase->len = einfo64.length;
710 } else {
711 struct erase_info_user einfo32;
712
713 if (copy_from_user(&einfo32, argp,
714 sizeof(struct erase_info_user))) {
715 kfree(erase);
716 return -EFAULT;
717 }
718 erase->addr = einfo32.start;
719 erase->len = einfo32.length;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700720 }
721 erase->mtd = mtd;
722 erase->callback = mtdchar_erase_callback;
723 erase->priv = (unsigned long)&waitq;
Thomas Gleixner97894cd2005-11-07 11:15:26 +0000724
Linus Torvalds1da177e2005-04-16 15:20:36 -0700725 /*
726 FIXME: Allow INTERRUPTIBLE. Which means
727 not having the wait_queue head on the stack.
Thomas Gleixner97894cd2005-11-07 11:15:26 +0000728
Linus Torvalds1da177e2005-04-16 15:20:36 -0700729 If the wq_head is on the stack, and we
730 leave because we got interrupted, then the
731 wq_head is no longer there when the
732 callback routine tries to wake us up.
733 */
Artem Bityutskiy7e1f0dc2011-12-23 15:25:39 +0200734 ret = mtd_erase(mtd, erase);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700735 if (!ret) {
736 set_current_state(TASK_UNINTERRUPTIBLE);
737 add_wait_queue(&waitq, &wait);
738 if (erase->state != MTD_ERASE_DONE &&
739 erase->state != MTD_ERASE_FAILED)
740 schedule();
741 remove_wait_queue(&waitq, &wait);
742 set_current_state(TASK_RUNNING);
743
744 ret = (erase->state == MTD_ERASE_FAILED)?-EIO:0;
745 }
746 kfree(erase);
747 }
748 break;
749 }
750
751 case MEMWRITEOOB:
752 {
753 struct mtd_oob_buf buf;
Kevin Cernekee97718542009-04-08 22:53:13 -0700754 struct mtd_oob_buf __user *buf_user = argp;
Thomas Gleixner97894cd2005-11-07 11:15:26 +0000755
Kevin Cernekee97718542009-04-08 22:53:13 -0700756 /* NOTE: writes return length to buf_user->length */
757 if (copy_from_user(&buf, argp, sizeof(buf)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700758 ret = -EFAULT;
Kevin Cernekee97718542009-04-08 22:53:13 -0700759 else
Artem Bityutskiy969e57a2011-12-23 17:27:46 +0200760 ret = mtdchar_writeoob(file, mtd, buf.start, buf.length,
Kevin Cernekee97718542009-04-08 22:53:13 -0700761 buf.ptr, &buf_user->length);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700762 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700763 }
764
765 case MEMREADOOB:
766 {
767 struct mtd_oob_buf buf;
Kevin Cernekee97718542009-04-08 22:53:13 -0700768 struct mtd_oob_buf __user *buf_user = argp;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700769
Kevin Cernekee97718542009-04-08 22:53:13 -0700770 /* NOTE: writes return length to buf_user->start */
771 if (copy_from_user(&buf, argp, sizeof(buf)))
772 ret = -EFAULT;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700773 else
Artem Bityutskiy969e57a2011-12-23 17:27:46 +0200774 ret = mtdchar_readoob(file, mtd, buf.start, buf.length,
Kevin Cernekee97718542009-04-08 22:53:13 -0700775 buf.ptr, &buf_user->start);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700776 break;
777 }
778
Kevin Cernekeeaea7cea2009-04-08 22:53:49 -0700779 case MEMWRITEOOB64:
780 {
781 struct mtd_oob_buf64 buf;
782 struct mtd_oob_buf64 __user *buf_user = argp;
783
784 if (copy_from_user(&buf, argp, sizeof(buf)))
785 ret = -EFAULT;
786 else
Artem Bityutskiy969e57a2011-12-23 17:27:46 +0200787 ret = mtdchar_writeoob(file, mtd, buf.start, buf.length,
Kevin Cernekeeaea7cea2009-04-08 22:53:49 -0700788 (void __user *)(uintptr_t)buf.usr_ptr,
789 &buf_user->length);
790 break;
791 }
792
793 case MEMREADOOB64:
794 {
795 struct mtd_oob_buf64 buf;
796 struct mtd_oob_buf64 __user *buf_user = argp;
797
798 if (copy_from_user(&buf, argp, sizeof(buf)))
799 ret = -EFAULT;
800 else
Artem Bityutskiy969e57a2011-12-23 17:27:46 +0200801 ret = mtdchar_readoob(file, mtd, buf.start, buf.length,
Kevin Cernekeeaea7cea2009-04-08 22:53:49 -0700802 (void __user *)(uintptr_t)buf.usr_ptr,
803 &buf_user->length);
804 break;
805 }
806
Brian Norrise99d8b02011-09-09 09:59:03 -0700807 case MEMWRITE:
808 {
Artem Bityutskiy969e57a2011-12-23 17:27:46 +0200809 ret = mtdchar_write_ioctl(mtd,
Brian Norrise99d8b02011-09-09 09:59:03 -0700810 (struct mtd_write_req __user *)arg);
811 break;
812 }
813
Linus Torvalds1da177e2005-04-16 15:20:36 -0700814 case MEMLOCK:
815 {
Harvey Harrison175428b2008-07-03 23:40:14 -0700816 struct erase_info_user einfo;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700817
Harvey Harrison175428b2008-07-03 23:40:14 -0700818 if (copy_from_user(&einfo, argp, sizeof(einfo)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700819 return -EFAULT;
820
821 if (!mtd->lock)
822 ret = -EOPNOTSUPP;
823 else
Harvey Harrison175428b2008-07-03 23:40:14 -0700824 ret = mtd->lock(mtd, einfo.start, einfo.length);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700825 break;
826 }
827
828 case MEMUNLOCK:
829 {
Harvey Harrison175428b2008-07-03 23:40:14 -0700830 struct erase_info_user einfo;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700831
Harvey Harrison175428b2008-07-03 23:40:14 -0700832 if (copy_from_user(&einfo, argp, sizeof(einfo)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700833 return -EFAULT;
834
835 if (!mtd->unlock)
836 ret = -EOPNOTSUPP;
837 else
Harvey Harrison175428b2008-07-03 23:40:14 -0700838 ret = mtd->unlock(mtd, einfo.start, einfo.length);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700839 break;
840 }
841
Richard Cochran99384242010-06-14 18:10:33 +0200842 case MEMISLOCKED:
843 {
844 struct erase_info_user einfo;
845
846 if (copy_from_user(&einfo, argp, sizeof(einfo)))
847 return -EFAULT;
848
849 if (!mtd->is_locked)
850 ret = -EOPNOTSUPP;
851 else
852 ret = mtd->is_locked(mtd, einfo.start, einfo.length);
853 break;
854 }
855
Thomas Gleixner5bd34c02006-05-27 22:16:10 +0200856 /* Legacy interface */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700857 case MEMGETOOBSEL:
858 {
Thomas Gleixner5bd34c02006-05-27 22:16:10 +0200859 struct nand_oobinfo oi;
860
861 if (!mtd->ecclayout)
862 return -EOPNOTSUPP;
863 if (mtd->ecclayout->eccbytes > ARRAY_SIZE(oi.eccpos))
864 return -EINVAL;
865
866 oi.useecc = MTD_NANDECC_AUTOPLACE;
867 memcpy(&oi.eccpos, mtd->ecclayout->eccpos, sizeof(oi.eccpos));
868 memcpy(&oi.oobfree, mtd->ecclayout->oobfree,
869 sizeof(oi.oobfree));
Ricard Wanderlöfd25ade72006-10-17 17:27:11 +0200870 oi.eccbytes = mtd->ecclayout->eccbytes;
Thomas Gleixner5bd34c02006-05-27 22:16:10 +0200871
872 if (copy_to_user(argp, &oi, sizeof(struct nand_oobinfo)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700873 return -EFAULT;
874 break;
875 }
876
877 case MEMGETBADBLOCK:
878 {
879 loff_t offs;
Thomas Gleixner97894cd2005-11-07 11:15:26 +0000880
Linus Torvalds1da177e2005-04-16 15:20:36 -0700881 if (copy_from_user(&offs, argp, sizeof(loff_t)))
882 return -EFAULT;
883 if (!mtd->block_isbad)
884 ret = -EOPNOTSUPP;
885 else
886 return mtd->block_isbad(mtd, offs);
887 break;
888 }
889
890 case MEMSETBADBLOCK:
891 {
892 loff_t offs;
893
894 if (copy_from_user(&offs, argp, sizeof(loff_t)))
895 return -EFAULT;
896 if (!mtd->block_markbad)
897 ret = -EOPNOTSUPP;
898 else
899 return mtd->block_markbad(mtd, offs);
900 break;
901 }
902
David Brownell34a82442008-07-30 12:35:05 -0700903#ifdef CONFIG_HAVE_MTD_OTP
Nicolas Pitre31f42332005-02-08 17:45:55 +0000904 case OTPSELECT:
905 {
906 int mode;
907 if (copy_from_user(&mode, argp, sizeof(int)))
908 return -EFAULT;
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200909
Brian Norrisbeb133f2011-08-30 18:45:41 -0700910 mfi->mode = MTD_FILE_MODE_NORMAL;
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200911
912 ret = otp_select_filemode(mfi, mode);
913
Nicolas Pitre81dba482005-04-01 16:36:15 +0100914 file->f_pos = 0;
Nicolas Pitre31f42332005-02-08 17:45:55 +0000915 break;
916 }
917
918 case OTPGETREGIONCOUNT:
919 case OTPGETREGIONINFO:
920 {
921 struct otp_info *buf = kmalloc(4096, GFP_KERNEL);
922 if (!buf)
923 return -ENOMEM;
924 ret = -EOPNOTSUPP;
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200925 switch (mfi->mode) {
Brian Norrisbeb133f2011-08-30 18:45:41 -0700926 case MTD_FILE_MODE_OTP_FACTORY:
Nicolas Pitre31f42332005-02-08 17:45:55 +0000927 if (mtd->get_fact_prot_info)
928 ret = mtd->get_fact_prot_info(mtd, buf, 4096);
929 break;
Brian Norrisbeb133f2011-08-30 18:45:41 -0700930 case MTD_FILE_MODE_OTP_USER:
Nicolas Pitre31f42332005-02-08 17:45:55 +0000931 if (mtd->get_user_prot_info)
932 ret = mtd->get_user_prot_info(mtd, buf, 4096);
933 break;
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200934 default:
935 break;
Nicolas Pitre31f42332005-02-08 17:45:55 +0000936 }
937 if (ret >= 0) {
938 if (cmd == OTPGETREGIONCOUNT) {
939 int nbr = ret / sizeof(struct otp_info);
940 ret = copy_to_user(argp, &nbr, sizeof(int));
941 } else
942 ret = copy_to_user(argp, buf, ret);
943 if (ret)
944 ret = -EFAULT;
945 }
946 kfree(buf);
947 break;
948 }
949
950 case OTPLOCK:
951 {
Harvey Harrison175428b2008-07-03 23:40:14 -0700952 struct otp_info oinfo;
Nicolas Pitre31f42332005-02-08 17:45:55 +0000953
Brian Norrisbeb133f2011-08-30 18:45:41 -0700954 if (mfi->mode != MTD_FILE_MODE_OTP_USER)
Nicolas Pitre31f42332005-02-08 17:45:55 +0000955 return -EINVAL;
Harvey Harrison175428b2008-07-03 23:40:14 -0700956 if (copy_from_user(&oinfo, argp, sizeof(oinfo)))
Nicolas Pitre31f42332005-02-08 17:45:55 +0000957 return -EFAULT;
958 if (!mtd->lock_user_prot_reg)
959 return -EOPNOTSUPP;
Harvey Harrison175428b2008-07-03 23:40:14 -0700960 ret = mtd->lock_user_prot_reg(mtd, oinfo.start, oinfo.length);
Nicolas Pitre31f42332005-02-08 17:45:55 +0000961 break;
962 }
963#endif
964
Brian Norris7854d3f2011-06-23 14:12:08 -0700965 /* This ioctl is being deprecated - it truncates the ECC layout */
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200966 case ECCGETLAYOUT:
967 {
Brian Norriscc26c3c2010-08-24 18:12:00 -0700968 struct nand_ecclayout_user *usrlay;
969
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200970 if (!mtd->ecclayout)
971 return -EOPNOTSUPP;
972
Brian Norriscc26c3c2010-08-24 18:12:00 -0700973 usrlay = kmalloc(sizeof(*usrlay), GFP_KERNEL);
974 if (!usrlay)
975 return -ENOMEM;
976
977 shrink_ecclayout(mtd->ecclayout, usrlay);
978
979 if (copy_to_user(argp, usrlay, sizeof(*usrlay)))
980 ret = -EFAULT;
981 kfree(usrlay);
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200982 break;
983 }
984
985 case ECCGETSTATS:
986 {
987 if (copy_to_user(argp, &mtd->ecc_stats,
988 sizeof(struct mtd_ecc_stats)))
989 return -EFAULT;
990 break;
991 }
992
993 case MTDFILEMODE:
994 {
995 mfi->mode = 0;
996
997 switch(arg) {
Brian Norrisbeb133f2011-08-30 18:45:41 -0700998 case MTD_FILE_MODE_OTP_FACTORY:
999 case MTD_FILE_MODE_OTP_USER:
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +02001000 ret = otp_select_filemode(mfi, arg);
1001 break;
1002
Brian Norrisbeb133f2011-08-30 18:45:41 -07001003 case MTD_FILE_MODE_RAW:
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +02001004 if (!mtd->read_oob || !mtd->write_oob)
1005 return -EOPNOTSUPP;
1006 mfi->mode = arg;
1007
Brian Norrisbeb133f2011-08-30 18:45:41 -07001008 case MTD_FILE_MODE_NORMAL:
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +02001009 break;
1010 default:
1011 ret = -EINVAL;
1012 }
1013 file->f_pos = 0;
1014 break;
1015 }
1016
Roman Tereshonkovd0f79592010-09-17 13:31:42 +03001017 case BLKPG:
1018 {
Artem Bityutskiy969e57a2011-12-23 17:27:46 +02001019 ret = mtdchar_blkpg_ioctl(mtd,
Roman Tereshonkovd0f79592010-09-17 13:31:42 +03001020 (struct blkpg_ioctl_arg __user *)arg);
1021 break;
1022 }
1023
1024 case BLKRRPART:
1025 {
1026 /* No reread partition feature. Just return ok */
1027 ret = 0;
1028 break;
1029 }
Roman Tereshonkovd0f79592010-09-17 13:31:42 +03001030
Linus Torvalds1da177e2005-04-16 15:20:36 -07001031 default:
1032 ret = -ENOTTY;
1033 }
1034
1035 return ret;
1036} /* memory_ioctl */
1037
Artem Bityutskiy969e57a2011-12-23 17:27:46 +02001038static long mtdchar_unlocked_ioctl(struct file *file, u_int cmd, u_long arg)
Arnd Bergmann55929332010-04-27 00:24:05 +02001039{
1040 int ret;
1041
Arnd Bergmann5aa82942010-06-02 14:28:52 +02001042 mutex_lock(&mtd_mutex);
Artem Bityutskiy969e57a2011-12-23 17:27:46 +02001043 ret = mtdchar_ioctl(file, cmd, arg);
Arnd Bergmann5aa82942010-06-02 14:28:52 +02001044 mutex_unlock(&mtd_mutex);
Arnd Bergmann55929332010-04-27 00:24:05 +02001045
1046 return ret;
1047}
1048
Kevin Cernekee97718542009-04-08 22:53:13 -07001049#ifdef CONFIG_COMPAT
1050
1051struct mtd_oob_buf32 {
1052 u_int32_t start;
1053 u_int32_t length;
1054 compat_caddr_t ptr; /* unsigned char* */
1055};
1056
1057#define MEMWRITEOOB32 _IOWR('M', 3, struct mtd_oob_buf32)
1058#define MEMREADOOB32 _IOWR('M', 4, struct mtd_oob_buf32)
1059
Artem Bityutskiy969e57a2011-12-23 17:27:46 +02001060static long mtdchar_compat_ioctl(struct file *file, unsigned int cmd,
Kevin Cernekee97718542009-04-08 22:53:13 -07001061 unsigned long arg)
1062{
1063 struct mtd_file_info *mfi = file->private_data;
1064 struct mtd_info *mtd = mfi->mtd;
David Woodhouse0b6585c2009-05-29 16:09:08 +01001065 void __user *argp = compat_ptr(arg);
Kevin Cernekee97718542009-04-08 22:53:13 -07001066 int ret = 0;
1067
Arnd Bergmann5aa82942010-06-02 14:28:52 +02001068 mutex_lock(&mtd_mutex);
Kevin Cernekee97718542009-04-08 22:53:13 -07001069
1070 switch (cmd) {
1071 case MEMWRITEOOB32:
1072 {
1073 struct mtd_oob_buf32 buf;
1074 struct mtd_oob_buf32 __user *buf_user = argp;
1075
1076 if (copy_from_user(&buf, argp, sizeof(buf)))
1077 ret = -EFAULT;
1078 else
Artem Bityutskiy969e57a2011-12-23 17:27:46 +02001079 ret = mtdchar_writeoob(file, mtd, buf.start,
Kevin Cernekee97718542009-04-08 22:53:13 -07001080 buf.length, compat_ptr(buf.ptr),
1081 &buf_user->length);
1082 break;
1083 }
1084
1085 case MEMREADOOB32:
1086 {
1087 struct mtd_oob_buf32 buf;
1088 struct mtd_oob_buf32 __user *buf_user = argp;
1089
1090 /* NOTE: writes return length to buf->start */
1091 if (copy_from_user(&buf, argp, sizeof(buf)))
1092 ret = -EFAULT;
1093 else
Artem Bityutskiy969e57a2011-12-23 17:27:46 +02001094 ret = mtdchar_readoob(file, mtd, buf.start,
Kevin Cernekee97718542009-04-08 22:53:13 -07001095 buf.length, compat_ptr(buf.ptr),
1096 &buf_user->start);
1097 break;
1098 }
1099 default:
Artem Bityutskiy969e57a2011-12-23 17:27:46 +02001100 ret = mtdchar_ioctl(file, cmd, (unsigned long)argp);
Kevin Cernekee97718542009-04-08 22:53:13 -07001101 }
1102
Arnd Bergmann5aa82942010-06-02 14:28:52 +02001103 mutex_unlock(&mtd_mutex);
Kevin Cernekee97718542009-04-08 22:53:13 -07001104
1105 return ret;
1106}
1107
1108#endif /* CONFIG_COMPAT */
1109
David Howells402d3262009-02-12 10:40:00 +00001110/*
1111 * try to determine where a shared mapping can be made
1112 * - only supported for NOMMU at the moment (MMU can't doesn't copy private
1113 * mappings)
1114 */
1115#ifndef CONFIG_MMU
Artem Bityutskiy969e57a2011-12-23 17:27:46 +02001116static unsigned long mtdchar_get_unmapped_area(struct file *file,
David Howells402d3262009-02-12 10:40:00 +00001117 unsigned long addr,
1118 unsigned long len,
1119 unsigned long pgoff,
1120 unsigned long flags)
1121{
1122 struct mtd_file_info *mfi = file->private_data;
1123 struct mtd_info *mtd = mfi->mtd;
1124
1125 if (mtd->get_unmapped_area) {
1126 unsigned long offset;
1127
1128 if (addr != 0)
1129 return (unsigned long) -EINVAL;
1130
1131 if (len > mtd->size || pgoff >= (mtd->size >> PAGE_SHIFT))
1132 return (unsigned long) -EINVAL;
1133
1134 offset = pgoff << PAGE_SHIFT;
1135 if (offset > mtd->size - len)
1136 return (unsigned long) -EINVAL;
1137
Artem Bityutskiy04c601b2011-12-23 17:10:15 +02001138 return mtd_get_unmapped_area(mtd, len, offset, flags);
David Howells402d3262009-02-12 10:40:00 +00001139 }
1140
1141 /* can't map directly */
1142 return (unsigned long) -ENOSYS;
1143}
1144#endif
1145
1146/*
1147 * set up a mapping for shared memory segments
1148 */
Artem Bityutskiy969e57a2011-12-23 17:27:46 +02001149static int mtdchar_mmap(struct file *file, struct vm_area_struct *vma)
David Howells402d3262009-02-12 10:40:00 +00001150{
1151#ifdef CONFIG_MMU
1152 struct mtd_file_info *mfi = file->private_data;
1153 struct mtd_info *mtd = mfi->mtd;
Anatolij Gustschindd02b672010-06-15 09:30:15 +02001154 struct map_info *map = mtd->priv;
1155 unsigned long start;
1156 unsigned long off;
1157 u32 len;
David Howells402d3262009-02-12 10:40:00 +00001158
Anatolij Gustschindd02b672010-06-15 09:30:15 +02001159 if (mtd->type == MTD_RAM || mtd->type == MTD_ROM) {
1160 off = vma->vm_pgoff << PAGE_SHIFT;
1161 start = map->phys;
1162 len = PAGE_ALIGN((start & ~PAGE_MASK) + map->size);
1163 start &= PAGE_MASK;
1164 if ((vma->vm_end - vma->vm_start + off) > len)
1165 return -EINVAL;
1166
1167 off += start;
1168 vma->vm_pgoff = off >> PAGE_SHIFT;
1169 vma->vm_flags |= VM_IO | VM_RESERVED;
1170
1171#ifdef pgprot_noncached
1172 if (file->f_flags & O_DSYNC || off >= __pa(high_memory))
1173 vma->vm_page_prot = pgprot_noncached(vma->vm_page_prot);
1174#endif
1175 if (io_remap_pfn_range(vma, vma->vm_start, off >> PAGE_SHIFT,
1176 vma->vm_end - vma->vm_start,
1177 vma->vm_page_prot))
1178 return -EAGAIN;
1179
David Howells402d3262009-02-12 10:40:00 +00001180 return 0;
Anatolij Gustschindd02b672010-06-15 09:30:15 +02001181 }
David Howells402d3262009-02-12 10:40:00 +00001182 return -ENOSYS;
1183#else
1184 return vma->vm_flags & VM_SHARED ? 0 : -ENOSYS;
1185#endif
1186}
1187
Arjan van de Vend54b1fd2007-02-12 00:55:34 -08001188static const struct file_operations mtd_fops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001189 .owner = THIS_MODULE,
Artem Bityutskiy969e57a2011-12-23 17:27:46 +02001190 .llseek = mtdchar_lseek,
1191 .read = mtdchar_read,
1192 .write = mtdchar_write,
1193 .unlocked_ioctl = mtdchar_unlocked_ioctl,
Kevin Cernekee97718542009-04-08 22:53:13 -07001194#ifdef CONFIG_COMPAT
Artem Bityutskiy969e57a2011-12-23 17:27:46 +02001195 .compat_ioctl = mtdchar_compat_ioctl,
Kevin Cernekee97718542009-04-08 22:53:13 -07001196#endif
Artem Bityutskiy969e57a2011-12-23 17:27:46 +02001197 .open = mtdchar_open,
1198 .release = mtdchar_close,
1199 .mmap = mtdchar_mmap,
David Howells402d3262009-02-12 10:40:00 +00001200#ifndef CONFIG_MMU
Artem Bityutskiy969e57a2011-12-23 17:27:46 +02001201 .get_unmapped_area = mtdchar_get_unmapped_area,
David Howells402d3262009-02-12 10:40:00 +00001202#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07001203};
1204
Al Viro51139ad2010-07-25 23:47:46 +04001205static struct dentry *mtd_inodefs_mount(struct file_system_type *fs_type,
1206 int flags, const char *dev_name, void *data)
Kirill A. Shutemovcd874232010-05-17 16:55:47 +03001207{
Al Viroc74a1cb2011-01-12 16:59:34 -05001208 return mount_pseudo(fs_type, "mtd_inode:", NULL, NULL, MTD_INODE_FS_MAGIC);
Kirill A. Shutemovcd874232010-05-17 16:55:47 +03001209}
1210
1211static struct file_system_type mtd_inodefs_type = {
1212 .name = "mtd_inodefs",
Al Viro51139ad2010-07-25 23:47:46 +04001213 .mount = mtd_inodefs_mount,
Kirill A. Shutemovcd874232010-05-17 16:55:47 +03001214 .kill_sb = kill_anon_super,
1215};
1216
1217static void mtdchar_notify_add(struct mtd_info *mtd)
1218{
1219}
1220
1221static void mtdchar_notify_remove(struct mtd_info *mtd)
1222{
1223 struct inode *mtd_ino = ilookup(mtd_inode_mnt->mnt_sb, mtd->index);
1224
1225 if (mtd_ino) {
1226 /* Destroy the inode if it exists */
Miklos Szeredi6d6b77f2011-10-28 14:13:28 +02001227 clear_nlink(mtd_ino);
Kirill A. Shutemovcd874232010-05-17 16:55:47 +03001228 iput(mtd_ino);
1229 }
1230}
1231
1232static struct mtd_notifier mtdchar_notifier = {
1233 .add = mtdchar_notify_add,
1234 .remove = mtdchar_notify_remove,
1235};
1236
Linus Torvalds1da177e2005-04-16 15:20:36 -07001237static int __init init_mtdchar(void)
1238{
Kirill A. Shutemovcd874232010-05-17 16:55:47 +03001239 int ret;
David Brownell1f24b5a2009-03-26 00:42:41 -07001240
Kirill A. Shutemovcd874232010-05-17 16:55:47 +03001241 ret = __register_chrdev(MTD_CHAR_MAJOR, 0, 1 << MINORBITS,
Ben Hutchingsdad0db32010-01-29 21:00:04 +00001242 "mtd", &mtd_fops);
Kirill A. Shutemovcd874232010-05-17 16:55:47 +03001243 if (ret < 0) {
1244 pr_notice("Can't allocate major number %d for "
1245 "Memory Technology Devices.\n", MTD_CHAR_MAJOR);
1246 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001247 }
1248
Kirill A. Shutemovcd874232010-05-17 16:55:47 +03001249 ret = register_filesystem(&mtd_inodefs_type);
1250 if (ret) {
1251 pr_notice("Can't register mtd_inodefs filesystem: %d\n", ret);
1252 goto err_unregister_chdev;
1253 }
1254
1255 mtd_inode_mnt = kern_mount(&mtd_inodefs_type);
1256 if (IS_ERR(mtd_inode_mnt)) {
1257 ret = PTR_ERR(mtd_inode_mnt);
1258 pr_notice("Error mounting mtd_inodefs filesystem: %d\n", ret);
1259 goto err_unregister_filesystem;
1260 }
1261 register_mtd_user(&mtdchar_notifier);
1262
1263 return ret;
1264
1265err_unregister_filesystem:
1266 unregister_filesystem(&mtd_inodefs_type);
1267err_unregister_chdev:
1268 __unregister_chrdev(MTD_CHAR_MAJOR, 0, 1 << MINORBITS, "mtd");
1269 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001270}
1271
1272static void __exit cleanup_mtdchar(void)
1273{
Kirill A. Shutemovcd874232010-05-17 16:55:47 +03001274 unregister_mtd_user(&mtdchar_notifier);
Tim Chen423e0ab2011-07-19 09:32:38 -07001275 kern_unmount(mtd_inode_mnt);
Kirill A. Shutemovcd874232010-05-17 16:55:47 +03001276 unregister_filesystem(&mtd_inodefs_type);
Ben Hutchingsdad0db32010-01-29 21:00:04 +00001277 __unregister_chrdev(MTD_CHAR_MAJOR, 0, 1 << MINORBITS, "mtd");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001278}
1279
1280module_init(init_mtdchar);
1281module_exit(cleanup_mtdchar);
1282
David Brownell1f24b5a2009-03-26 00:42:41 -07001283MODULE_ALIAS_CHARDEV_MAJOR(MTD_CHAR_MAJOR);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001284
1285MODULE_LICENSE("GPL");
1286MODULE_AUTHOR("David Woodhouse <dwmw2@infradead.org>");
1287MODULE_DESCRIPTION("Direct character-device access to MTD devices");
Scott James Remnant90160e12009-03-02 18:42:39 +00001288MODULE_ALIAS_CHARDEV_MAJOR(MTD_CHAR_MAJOR);