blob: e7dc732ddabc6588226211b8fc23e2799e37d628 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
David Woodhousea1452a32010-08-08 20:58:20 +01002 * Copyright © 1999-2010 David Woodhouse <dwmw2@infradead.org>
3 *
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation; either version 2 of the License, or
7 * (at your option) any later version.
8 *
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
13 *
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software
16 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Linus Torvalds1da177e2005-04-16 15:20:36 -070017 *
18 */
19
Thomas Gleixner15fdc522005-11-07 00:14:42 +010020#include <linux/device.h>
21#include <linux/fs.h>
Andrew Morton0c1eafd2007-08-10 13:01:06 -070022#include <linux/mm.h>
Artem Bityutskiy9c740342006-10-11 14:52:47 +030023#include <linux/err.h>
Thomas Gleixner15fdc522005-11-07 00:14:42 +010024#include <linux/init.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070025#include <linux/kernel.h>
26#include <linux/module.h>
Thomas Gleixner15fdc522005-11-07 00:14:42 +010027#include <linux/slab.h>
28#include <linux/sched.h>
Arnd Bergmann5aa82942010-06-02 14:28:52 +020029#include <linux/mutex.h>
David Howells402d3262009-02-12 10:40:00 +000030#include <linux/backing-dev.h>
Kevin Cernekee97718542009-04-08 22:53:13 -070031#include <linux/compat.h>
Kirill A. Shutemovcd874232010-05-17 16:55:47 +030032#include <linux/mount.h>
Roman Tereshonkovd0f79592010-09-17 13:31:42 +030033#include <linux/blkpg.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070034#include <linux/mtd/mtd.h>
Roman Tereshonkovd0f79592010-09-17 13:31:42 +030035#include <linux/mtd/partitions.h>
Anatolij Gustschindd02b672010-06-15 09:30:15 +020036#include <linux/mtd/map.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070037
Thomas Gleixner15fdc522005-11-07 00:14:42 +010038#include <asm/uaccess.h>
Todd Poynor9bc7b382005-06-30 01:23:27 +010039
Kirill A. Shutemovcd874232010-05-17 16:55:47 +030040#define MTD_INODE_FS_MAGIC 0x11307854
Arnd Bergmann5aa82942010-06-02 14:28:52 +020041static DEFINE_MUTEX(mtd_mutex);
Kirill A. Shutemovcd874232010-05-17 16:55:47 +030042static struct vfsmount *mtd_inode_mnt __read_mostly;
Linus Torvalds1da177e2005-04-16 15:20:36 -070043
Nicolas Pitre045e9a52005-02-08 19:12:53 +000044/*
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +020045 * Data structure to hold the pointer to the mtd device as well
Brian Norris92394b52011-07-20 09:53:42 -070046 * as mode information of various use cases.
Nicolas Pitre045e9a52005-02-08 19:12:53 +000047 */
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +020048struct mtd_file_info {
49 struct mtd_info *mtd;
Kirill A. Shutemovcd874232010-05-17 16:55:47 +030050 struct inode *ino;
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +020051 enum mtd_file_modes mode;
52};
Nicolas Pitre31f42332005-02-08 17:45:55 +000053
Linus Torvalds1da177e2005-04-16 15:20:36 -070054static loff_t mtd_lseek (struct file *file, loff_t offset, int orig)
55{
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
80static int mtd_open(struct inode *inode, struct file *file)
81{
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;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700145} /* mtd_open */
146
147/*====================================================================*/
148
149static int mtd_close(struct inode *inode, struct file *file)
150{
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;
167} /* mtd_close */
168
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
187static ssize_t mtd_read(struct file *file, char __user *buf, size_t count,loff_t *ppos)
188{
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200189 struct mtd_file_info *mfi = file->private_data;
190 struct mtd_info *mtd = mfi->mtd;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700191 size_t retlen=0;
192 size_t total_retlen=0;
193 int ret=0;
194 int len;
Grant Erickson3e45cf52011-04-08 08:51:33 -0700195 size_t size = count;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700196 char *kbuf;
Thomas Gleixner97894cd2005-11-07 11:15:26 +0000197
Brian Norris289c0522011-07-19 10:06:09 -0700198 pr_debug("MTD_read\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700199
200 if (*ppos + count > mtd->size)
201 count = mtd->size - *ppos;
202
203 if (!count)
204 return 0;
Thomas Gleixner97894cd2005-11-07 11:15:26 +0000205
Grant Erickson3e45cf52011-04-08 08:51:33 -0700206 kbuf = mtd_kmalloc_up_to(mtd, &size);
Thago Galesib802c072006-04-17 17:38:15 +0100207 if (!kbuf)
208 return -ENOMEM;
209
Linus Torvalds1da177e2005-04-16 15:20:36 -0700210 while (count) {
Grant Erickson3e45cf52011-04-08 08:51:33 -0700211 len = min_t(size_t, count, size);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700212
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200213 switch (mfi->mode) {
Brian Norrisbeb133f2011-08-30 18:45:41 -0700214 case MTD_FILE_MODE_OTP_FACTORY:
Nicolas Pitre31f42332005-02-08 17:45:55 +0000215 ret = mtd->read_fact_prot_reg(mtd, *ppos, len, &retlen, kbuf);
216 break;
Brian Norrisbeb133f2011-08-30 18:45:41 -0700217 case MTD_FILE_MODE_OTP_USER:
Nicolas Pitre31f42332005-02-08 17:45:55 +0000218 ret = mtd->read_user_prot_reg(mtd, *ppos, len, &retlen, kbuf);
219 break;
Brian Norrisbeb133f2011-08-30 18:45:41 -0700220 case MTD_FILE_MODE_RAW:
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200221 {
222 struct mtd_oob_ops ops;
223
Brian Norris0612b9d2011-08-30 18:45:40 -0700224 ops.mode = MTD_OPS_RAW;
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200225 ops.datbuf = kbuf;
226 ops.oobbuf = NULL;
227 ops.len = len;
228
229 ret = mtd->read_oob(mtd, *ppos, &ops);
230 retlen = ops.retlen;
231 break;
232 }
Nicolas Pitre31f42332005-02-08 17:45:55 +0000233 default:
Thomas Gleixnerf4a43cf2006-05-28 11:01:53 +0200234 ret = mtd->read(mtd, *ppos, len, &retlen, kbuf);
Nicolas Pitre31f42332005-02-08 17:45:55 +0000235 }
Brian Norris7854d3f2011-06-23 14:12:08 -0700236 /* Nand returns -EBADMSG on ECC errors, but it returns
Linus Torvalds1da177e2005-04-16 15:20:36 -0700237 * the data. For our userspace tools it is important
Brian Norris7854d3f2011-06-23 14:12:08 -0700238 * to dump areas with ECC errors!
Thomas Gleixner9a1fcdf2006-05-29 14:56:39 +0200239 * For kernel internal usage it also might return -EUCLEAN
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300240 * to signal the caller that a bitflip has occurred and has
Thomas Gleixner9a1fcdf2006-05-29 14:56:39 +0200241 * been corrected by the ECC algorithm.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700242 * Userspace software which accesses NAND this way
243 * must be aware of the fact that it deals with NAND
244 */
Brian Norrisd57f40542011-09-20 18:34:25 -0700245 if (!ret || mtd_is_bitflip_or_eccerr(ret)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700246 *ppos += retlen;
247 if (copy_to_user(buf, kbuf, retlen)) {
Thomas Gleixnerf4a43cf2006-05-28 11:01:53 +0200248 kfree(kbuf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700249 return -EFAULT;
250 }
251 else
252 total_retlen += retlen;
253
254 count -= retlen;
255 buf += retlen;
Nicolas Pitre31f42332005-02-08 17:45:55 +0000256 if (retlen == 0)
257 count = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700258 }
259 else {
260 kfree(kbuf);
261 return ret;
262 }
Thomas Gleixner97894cd2005-11-07 11:15:26 +0000263
Linus Torvalds1da177e2005-04-16 15:20:36 -0700264 }
265
Thago Galesib802c072006-04-17 17:38:15 +0100266 kfree(kbuf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700267 return total_retlen;
268} /* mtd_read */
269
270static ssize_t mtd_write(struct file *file, const char __user *buf, size_t count,loff_t *ppos)
271{
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200272 struct mtd_file_info *mfi = file->private_data;
273 struct mtd_info *mtd = mfi->mtd;
Grant Erickson3e45cf52011-04-08 08:51:33 -0700274 size_t size = count;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700275 char *kbuf;
276 size_t retlen;
277 size_t total_retlen=0;
278 int ret=0;
279 int len;
280
Brian Norris289c0522011-07-19 10:06:09 -0700281 pr_debug("MTD_write\n");
Thomas Gleixner97894cd2005-11-07 11:15:26 +0000282
Linus Torvalds1da177e2005-04-16 15:20:36 -0700283 if (*ppos == mtd->size)
284 return -ENOSPC;
Thomas Gleixner97894cd2005-11-07 11:15:26 +0000285
Linus Torvalds1da177e2005-04-16 15:20:36 -0700286 if (*ppos + count > mtd->size)
287 count = mtd->size - *ppos;
288
289 if (!count)
290 return 0;
291
Grant Erickson3e45cf52011-04-08 08:51:33 -0700292 kbuf = mtd_kmalloc_up_to(mtd, &size);
Thago Galesib802c072006-04-17 17:38:15 +0100293 if (!kbuf)
294 return -ENOMEM;
295
Linus Torvalds1da177e2005-04-16 15:20:36 -0700296 while (count) {
Grant Erickson3e45cf52011-04-08 08:51:33 -0700297 len = min_t(size_t, count, size);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700298
Linus Torvalds1da177e2005-04-16 15:20:36 -0700299 if (copy_from_user(kbuf, buf, len)) {
300 kfree(kbuf);
301 return -EFAULT;
302 }
Thomas Gleixner97894cd2005-11-07 11:15:26 +0000303
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200304 switch (mfi->mode) {
Brian Norrisbeb133f2011-08-30 18:45:41 -0700305 case MTD_FILE_MODE_OTP_FACTORY:
Nicolas Pitre31f42332005-02-08 17:45:55 +0000306 ret = -EROFS;
307 break;
Brian Norrisbeb133f2011-08-30 18:45:41 -0700308 case MTD_FILE_MODE_OTP_USER:
Nicolas Pitre31f42332005-02-08 17:45:55 +0000309 if (!mtd->write_user_prot_reg) {
310 ret = -EOPNOTSUPP;
311 break;
312 }
313 ret = mtd->write_user_prot_reg(mtd, *ppos, len, &retlen, kbuf);
314 break;
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200315
Brian Norrisbeb133f2011-08-30 18:45:41 -0700316 case MTD_FILE_MODE_RAW:
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200317 {
318 struct mtd_oob_ops ops;
319
Brian Norris0612b9d2011-08-30 18:45:40 -0700320 ops.mode = MTD_OPS_RAW;
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200321 ops.datbuf = kbuf;
322 ops.oobbuf = NULL;
Peter Wippichbf514082011-06-06 15:50:58 +0200323 ops.ooboffs = 0;
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200324 ops.len = len;
325
326 ret = mtd->write_oob(mtd, *ppos, &ops);
327 retlen = ops.retlen;
328 break;
329 }
330
Nicolas Pitre31f42332005-02-08 17:45:55 +0000331 default:
332 ret = (*(mtd->write))(mtd, *ppos, len, &retlen, kbuf);
333 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700334 if (!ret) {
335 *ppos += retlen;
336 total_retlen += retlen;
337 count -= retlen;
338 buf += retlen;
339 }
340 else {
341 kfree(kbuf);
342 return ret;
343 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700344 }
345
Thago Galesib802c072006-04-17 17:38:15 +0100346 kfree(kbuf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700347 return total_retlen;
348} /* mtd_write */
349
350/*======================================================================
351
352 IOCTL calls for getting device parameters.
353
354======================================================================*/
355static void mtdchar_erase_callback (struct erase_info *instr)
356{
357 wake_up((wait_queue_head_t *)instr->priv);
358}
359
David Brownell34a82442008-07-30 12:35:05 -0700360#ifdef CONFIG_HAVE_MTD_OTP
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200361static int otp_select_filemode(struct mtd_file_info *mfi, int mode)
362{
363 struct mtd_info *mtd = mfi->mtd;
364 int ret = 0;
365
366 switch (mode) {
367 case MTD_OTP_FACTORY:
368 if (!mtd->read_fact_prot_reg)
369 ret = -EOPNOTSUPP;
370 else
Brian Norrisbeb133f2011-08-30 18:45:41 -0700371 mfi->mode = MTD_FILE_MODE_OTP_FACTORY;
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200372 break;
373 case MTD_OTP_USER:
374 if (!mtd->read_fact_prot_reg)
375 ret = -EOPNOTSUPP;
376 else
Brian Norrisbeb133f2011-08-30 18:45:41 -0700377 mfi->mode = MTD_FILE_MODE_OTP_USER;
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200378 break;
379 default:
380 ret = -EINVAL;
381 case MTD_OTP_OFF:
382 break;
383 }
384 return ret;
385}
386#else
387# define otp_select_filemode(f,m) -EOPNOTSUPP
388#endif
389
Kevin Cernekee97718542009-04-08 22:53:13 -0700390static int mtd_do_writeoob(struct file *file, struct mtd_info *mtd,
391 uint64_t start, uint32_t length, void __user *ptr,
392 uint32_t __user *retp)
393{
Brian Norris9ce244b2011-08-30 18:45:37 -0700394 struct mtd_file_info *mfi = file->private_data;
Kevin Cernekee97718542009-04-08 22:53:13 -0700395 struct mtd_oob_ops ops;
396 uint32_t retlen;
397 int ret = 0;
398
399 if (!(file->f_mode & FMODE_WRITE))
400 return -EPERM;
401
402 if (length > 4096)
403 return -EINVAL;
404
405 if (!mtd->write_oob)
406 ret = -EOPNOTSUPP;
407 else
Roel Kluin00404762010-01-29 10:35:04 +0100408 ret = access_ok(VERIFY_READ, ptr, length) ? 0 : -EFAULT;
Kevin Cernekee97718542009-04-08 22:53:13 -0700409
410 if (ret)
411 return ret;
412
413 ops.ooblen = length;
Brian Norris305b93f2011-08-23 17:17:32 -0700414 ops.ooboffs = start & (mtd->writesize - 1);
Kevin Cernekee97718542009-04-08 22:53:13 -0700415 ops.datbuf = NULL;
Brian Norrisbeb133f2011-08-30 18:45:41 -0700416 ops.mode = (mfi->mode == MTD_FILE_MODE_RAW) ? MTD_OPS_RAW :
Brian Norris0612b9d2011-08-30 18:45:40 -0700417 MTD_OPS_PLACE_OOB;
Kevin Cernekee97718542009-04-08 22:53:13 -0700418
419 if (ops.ooboffs && ops.ooblen > (mtd->oobsize - ops.ooboffs))
420 return -EINVAL;
421
Julia Lawalldf1f1d12010-05-22 10:22:49 +0200422 ops.oobbuf = memdup_user(ptr, length);
423 if (IS_ERR(ops.oobbuf))
424 return PTR_ERR(ops.oobbuf);
Kevin Cernekee97718542009-04-08 22:53:13 -0700425
Brian Norris305b93f2011-08-23 17:17:32 -0700426 start &= ~((uint64_t)mtd->writesize - 1);
Kevin Cernekee97718542009-04-08 22:53:13 -0700427 ret = mtd->write_oob(mtd, start, &ops);
428
429 if (ops.oobretlen > 0xFFFFFFFFU)
430 ret = -EOVERFLOW;
431 retlen = ops.oobretlen;
432 if (copy_to_user(retp, &retlen, sizeof(length)))
433 ret = -EFAULT;
434
435 kfree(ops.oobbuf);
436 return ret;
437}
438
Brian Norrisc46f6482011-08-30 18:45:38 -0700439static int mtd_do_readoob(struct file *file, struct mtd_info *mtd,
440 uint64_t start, uint32_t length, void __user *ptr,
441 uint32_t __user *retp)
Kevin Cernekee97718542009-04-08 22:53:13 -0700442{
Brian Norrisc46f6482011-08-30 18:45:38 -0700443 struct mtd_file_info *mfi = file->private_data;
Kevin Cernekee97718542009-04-08 22:53:13 -0700444 struct mtd_oob_ops ops;
445 int ret = 0;
446
447 if (length > 4096)
448 return -EINVAL;
449
450 if (!mtd->read_oob)
451 ret = -EOPNOTSUPP;
452 else
453 ret = access_ok(VERIFY_WRITE, ptr,
454 length) ? 0 : -EFAULT;
455 if (ret)
456 return ret;
457
458 ops.ooblen = length;
Brian Norris305b93f2011-08-23 17:17:32 -0700459 ops.ooboffs = start & (mtd->writesize - 1);
Kevin Cernekee97718542009-04-08 22:53:13 -0700460 ops.datbuf = NULL;
Brian Norrisbeb133f2011-08-30 18:45:41 -0700461 ops.mode = (mfi->mode == MTD_FILE_MODE_RAW) ? MTD_OPS_RAW :
Brian Norris0612b9d2011-08-30 18:45:40 -0700462 MTD_OPS_PLACE_OOB;
Kevin Cernekee97718542009-04-08 22:53:13 -0700463
464 if (ops.ooboffs && ops.ooblen > (mtd->oobsize - ops.ooboffs))
465 return -EINVAL;
466
467 ops.oobbuf = kmalloc(length, GFP_KERNEL);
468 if (!ops.oobbuf)
469 return -ENOMEM;
470
Brian Norris305b93f2011-08-23 17:17:32 -0700471 start &= ~((uint64_t)mtd->writesize - 1);
Kevin Cernekee97718542009-04-08 22:53:13 -0700472 ret = mtd->read_oob(mtd, start, &ops);
473
474 if (put_user(ops.oobretlen, retp))
475 ret = -EFAULT;
476 else if (ops.oobretlen && copy_to_user(ptr, ops.oobbuf,
477 ops.oobretlen))
478 ret = -EFAULT;
479
480 kfree(ops.oobbuf);
Brian Norris041e4572011-06-23 16:45:24 -0700481
482 /*
483 * NAND returns -EBADMSG on ECC errors, but it returns the OOB
484 * data. For our userspace tools it is important to dump areas
485 * with ECC errors!
486 * For kernel internal usage it also might return -EUCLEAN
487 * to signal the caller that a bitflip has occured and has
488 * been corrected by the ECC algorithm.
489 *
Brian Norrisc478d7e2011-06-28 16:29:00 -0700490 * Note: currently the standard NAND function, nand_read_oob_std,
491 * does not calculate ECC for the OOB area, so do not rely on
492 * this behavior unless you have replaced it with your own.
Brian Norris041e4572011-06-23 16:45:24 -0700493 */
Brian Norrisd57f40542011-09-20 18:34:25 -0700494 if (mtd_is_bitflip_or_eccerr(ret))
Brian Norris041e4572011-06-23 16:45:24 -0700495 return 0;
496
Kevin Cernekee97718542009-04-08 22:53:13 -0700497 return ret;
498}
499
Brian Norriscc26c3c2010-08-24 18:12:00 -0700500/*
501 * Copies (and truncates, if necessary) data from the larger struct,
502 * nand_ecclayout, to the smaller, deprecated layout struct,
Brian Norris92394b52011-07-20 09:53:42 -0700503 * nand_ecclayout_user. This is necessary only to support the deprecated
Brian Norriscc26c3c2010-08-24 18:12:00 -0700504 * API ioctl ECCGETLAYOUT while allowing all new functionality to use
505 * nand_ecclayout flexibly (i.e. the struct may change size in new
506 * releases without requiring major rewrites).
507 */
508static int shrink_ecclayout(const struct nand_ecclayout *from,
509 struct nand_ecclayout_user *to)
510{
511 int i;
512
513 if (!from || !to)
514 return -EINVAL;
515
516 memset(to, 0, sizeof(*to));
517
Brian Norris0ceacf32010-09-19 23:57:12 -0700518 to->eccbytes = min((int)from->eccbytes, MTD_MAX_ECCPOS_ENTRIES);
Brian Norriscc26c3c2010-08-24 18:12:00 -0700519 for (i = 0; i < to->eccbytes; i++)
520 to->eccpos[i] = from->eccpos[i];
521
522 for (i = 0; i < MTD_MAX_OOBFREE_ENTRIES; i++) {
523 if (from->oobfree[i].length == 0 &&
524 from->oobfree[i].offset == 0)
525 break;
526 to->oobavail += from->oobfree[i].length;
527 to->oobfree[i] = from->oobfree[i];
528 }
529
530 return 0;
531}
532
Roman Tereshonkovd0f79592010-09-17 13:31:42 +0300533static int mtd_blkpg_ioctl(struct mtd_info *mtd,
534 struct blkpg_ioctl_arg __user *arg)
535{
536 struct blkpg_ioctl_arg a;
537 struct blkpg_partition p;
538
539 if (!capable(CAP_SYS_ADMIN))
540 return -EPERM;
541
Roman Tereshonkovd0f79592010-09-17 13:31:42 +0300542 if (copy_from_user(&a, arg, sizeof(struct blkpg_ioctl_arg)))
543 return -EFAULT;
544
545 if (copy_from_user(&p, a.data, sizeof(struct blkpg_partition)))
546 return -EFAULT;
547
548 switch (a.op) {
549 case BLKPG_ADD_PARTITION:
550
Roman Tereshonkova7e93dc2010-11-23 14:17:17 +0200551 /* Only master mtd device must be used to add partitions */
552 if (mtd_is_partition(mtd))
553 return -EINVAL;
554
Roman Tereshonkovd0f79592010-09-17 13:31:42 +0300555 return mtd_add_partition(mtd, p.devname, p.start, p.length);
556
557 case BLKPG_DEL_PARTITION:
558
559 if (p.pno < 0)
560 return -EINVAL;
561
562 return mtd_del_partition(mtd, p.pno);
563
564 default:
565 return -EINVAL;
566 }
567}
Roman Tereshonkovd0f79592010-09-17 13:31:42 +0300568
Brian Norrise99d8b02011-09-09 09:59:03 -0700569static int mtd_write_ioctl(struct mtd_info *mtd,
570 struct mtd_write_req __user *argp)
571{
572 struct mtd_write_req req;
573 struct mtd_oob_ops ops;
574 void __user *usr_data, *usr_oob;
575 int ret;
576
577 if (copy_from_user(&req, argp, sizeof(req)) ||
578 !access_ok(VERIFY_READ, req.usr_data, req.len) ||
579 !access_ok(VERIFY_READ, req.usr_oob, req.ooblen))
580 return -EFAULT;
581 if (!mtd->write_oob)
582 return -EOPNOTSUPP;
583
584 ops.mode = req.mode;
585 ops.len = (size_t)req.len;
586 ops.ooblen = (size_t)req.ooblen;
587 ops.ooboffs = 0;
588
589 usr_data = (void __user *)(uintptr_t)req.usr_data;
590 usr_oob = (void __user *)(uintptr_t)req.usr_oob;
591
592 if (req.usr_data) {
593 ops.datbuf = memdup_user(usr_data, ops.len);
594 if (IS_ERR(ops.datbuf))
595 return PTR_ERR(ops.datbuf);
596 } else {
597 ops.datbuf = NULL;
598 }
599
600 if (req.usr_oob) {
601 ops.oobbuf = memdup_user(usr_oob, ops.ooblen);
602 if (IS_ERR(ops.oobbuf)) {
603 kfree(ops.datbuf);
604 return PTR_ERR(ops.oobbuf);
605 }
606 } else {
607 ops.oobbuf = NULL;
608 }
609
610 ret = mtd->write_oob(mtd, (loff_t)req.start, &ops);
611
612 kfree(ops.datbuf);
613 kfree(ops.oobbuf);
614
615 return ret;
616}
617
Arnd Bergmann55929332010-04-27 00:24:05 +0200618static int mtd_ioctl(struct file *file, u_int cmd, u_long arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700619{
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200620 struct mtd_file_info *mfi = file->private_data;
621 struct mtd_info *mtd = mfi->mtd;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700622 void __user *argp = (void __user *)arg;
623 int ret = 0;
624 u_long size;
Joern Engel73c619e2006-05-30 14:25:35 +0200625 struct mtd_info_user info;
Thomas Gleixner97894cd2005-11-07 11:15:26 +0000626
Brian Norris289c0522011-07-19 10:06:09 -0700627 pr_debug("MTD_ioctl\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700628
629 size = (cmd & IOCSIZE_MASK) >> IOCSIZE_SHIFT;
630 if (cmd & IOC_IN) {
631 if (!access_ok(VERIFY_READ, argp, size))
632 return -EFAULT;
633 }
634 if (cmd & IOC_OUT) {
635 if (!access_ok(VERIFY_WRITE, argp, size))
636 return -EFAULT;
637 }
Thomas Gleixner97894cd2005-11-07 11:15:26 +0000638
Linus Torvalds1da177e2005-04-16 15:20:36 -0700639 switch (cmd) {
640 case MEMGETREGIONCOUNT:
641 if (copy_to_user(argp, &(mtd->numeraseregions), sizeof(int)))
642 return -EFAULT;
643 break;
644
645 case MEMGETREGIONINFO:
646 {
Zev Weissb67c5f82008-09-01 05:02:12 -0700647 uint32_t ur_idx;
648 struct mtd_erase_region_info *kr;
H Hartley Sweetenbcc98a42010-01-15 11:25:38 -0700649 struct region_info_user __user *ur = argp;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700650
Zev Weissb67c5f82008-09-01 05:02:12 -0700651 if (get_user(ur_idx, &(ur->regionindex)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700652 return -EFAULT;
653
Dan Carpenter5e59be12010-09-08 21:39:56 +0200654 if (ur_idx >= mtd->numeraseregions)
655 return -EINVAL;
656
Zev Weissb67c5f82008-09-01 05:02:12 -0700657 kr = &(mtd->eraseregions[ur_idx]);
658
659 if (put_user(kr->offset, &(ur->offset))
660 || put_user(kr->erasesize, &(ur->erasesize))
661 || put_user(kr->numblocks, &(ur->numblocks)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700662 return -EFAULT;
Zev Weissb67c5f82008-09-01 05:02:12 -0700663
Linus Torvalds1da177e2005-04-16 15:20:36 -0700664 break;
665 }
666
667 case MEMGETINFO:
Vasiliy Kulikova0c5a392010-11-06 17:41:24 +0300668 memset(&info, 0, sizeof(info));
Joern Engel73c619e2006-05-30 14:25:35 +0200669 info.type = mtd->type;
670 info.flags = mtd->flags;
671 info.size = mtd->size;
672 info.erasesize = mtd->erasesize;
673 info.writesize = mtd->writesize;
674 info.oobsize = mtd->oobsize;
Brian Norris19fb4342011-08-30 18:45:46 -0700675 /* The below field is obsolete */
676 info.padding = 0;
Joern Engel73c619e2006-05-30 14:25:35 +0200677 if (copy_to_user(argp, &info, sizeof(struct mtd_info_user)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700678 return -EFAULT;
679 break;
680
681 case MEMERASE:
Kevin Cernekee0dc54e92009-04-08 22:52:28 -0700682 case MEMERASE64:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700683 {
684 struct erase_info *erase;
685
Al Viroaeb5d722008-09-02 15:28:45 -0400686 if(!(file->f_mode & FMODE_WRITE))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700687 return -EPERM;
688
Burman Yan95b93a02006-11-15 21:10:29 +0200689 erase=kzalloc(sizeof(struct erase_info),GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700690 if (!erase)
691 ret = -ENOMEM;
692 else {
693 wait_queue_head_t waitq;
694 DECLARE_WAITQUEUE(wait, current);
695
696 init_waitqueue_head(&waitq);
697
Kevin Cernekee0dc54e92009-04-08 22:52:28 -0700698 if (cmd == MEMERASE64) {
699 struct erase_info_user64 einfo64;
700
701 if (copy_from_user(&einfo64, argp,
702 sizeof(struct erase_info_user64))) {
703 kfree(erase);
704 return -EFAULT;
705 }
706 erase->addr = einfo64.start;
707 erase->len = einfo64.length;
708 } else {
709 struct erase_info_user einfo32;
710
711 if (copy_from_user(&einfo32, argp,
712 sizeof(struct erase_info_user))) {
713 kfree(erase);
714 return -EFAULT;
715 }
716 erase->addr = einfo32.start;
717 erase->len = einfo32.length;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700718 }
719 erase->mtd = mtd;
720 erase->callback = mtdchar_erase_callback;
721 erase->priv = (unsigned long)&waitq;
Thomas Gleixner97894cd2005-11-07 11:15:26 +0000722
Linus Torvalds1da177e2005-04-16 15:20:36 -0700723 /*
724 FIXME: Allow INTERRUPTIBLE. Which means
725 not having the wait_queue head on the stack.
Thomas Gleixner97894cd2005-11-07 11:15:26 +0000726
Linus Torvalds1da177e2005-04-16 15:20:36 -0700727 If the wq_head is on the stack, and we
728 leave because we got interrupted, then the
729 wq_head is no longer there when the
730 callback routine tries to wake us up.
731 */
732 ret = mtd->erase(mtd, erase);
733 if (!ret) {
734 set_current_state(TASK_UNINTERRUPTIBLE);
735 add_wait_queue(&waitq, &wait);
736 if (erase->state != MTD_ERASE_DONE &&
737 erase->state != MTD_ERASE_FAILED)
738 schedule();
739 remove_wait_queue(&waitq, &wait);
740 set_current_state(TASK_RUNNING);
741
742 ret = (erase->state == MTD_ERASE_FAILED)?-EIO:0;
743 }
744 kfree(erase);
745 }
746 break;
747 }
748
749 case MEMWRITEOOB:
750 {
751 struct mtd_oob_buf buf;
Kevin Cernekee97718542009-04-08 22:53:13 -0700752 struct mtd_oob_buf __user *buf_user = argp;
Thomas Gleixner97894cd2005-11-07 11:15:26 +0000753
Kevin Cernekee97718542009-04-08 22:53:13 -0700754 /* NOTE: writes return length to buf_user->length */
755 if (copy_from_user(&buf, argp, sizeof(buf)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700756 ret = -EFAULT;
Kevin Cernekee97718542009-04-08 22:53:13 -0700757 else
758 ret = mtd_do_writeoob(file, mtd, buf.start, buf.length,
759 buf.ptr, &buf_user->length);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700760 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700761 }
762
763 case MEMREADOOB:
764 {
765 struct mtd_oob_buf buf;
Kevin Cernekee97718542009-04-08 22:53:13 -0700766 struct mtd_oob_buf __user *buf_user = argp;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700767
Kevin Cernekee97718542009-04-08 22:53:13 -0700768 /* NOTE: writes return length to buf_user->start */
769 if (copy_from_user(&buf, argp, sizeof(buf)))
770 ret = -EFAULT;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700771 else
Brian Norrisc46f6482011-08-30 18:45:38 -0700772 ret = mtd_do_readoob(file, mtd, buf.start, buf.length,
Kevin Cernekee97718542009-04-08 22:53:13 -0700773 buf.ptr, &buf_user->start);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700774 break;
775 }
776
Kevin Cernekeeaea7cea2009-04-08 22:53:49 -0700777 case MEMWRITEOOB64:
778 {
779 struct mtd_oob_buf64 buf;
780 struct mtd_oob_buf64 __user *buf_user = argp;
781
782 if (copy_from_user(&buf, argp, sizeof(buf)))
783 ret = -EFAULT;
784 else
785 ret = mtd_do_writeoob(file, mtd, buf.start, buf.length,
786 (void __user *)(uintptr_t)buf.usr_ptr,
787 &buf_user->length);
788 break;
789 }
790
791 case MEMREADOOB64:
792 {
793 struct mtd_oob_buf64 buf;
794 struct mtd_oob_buf64 __user *buf_user = argp;
795
796 if (copy_from_user(&buf, argp, sizeof(buf)))
797 ret = -EFAULT;
798 else
Brian Norrisc46f6482011-08-30 18:45:38 -0700799 ret = mtd_do_readoob(file, mtd, buf.start, buf.length,
Kevin Cernekeeaea7cea2009-04-08 22:53:49 -0700800 (void __user *)(uintptr_t)buf.usr_ptr,
801 &buf_user->length);
802 break;
803 }
804
Brian Norrise99d8b02011-09-09 09:59:03 -0700805 case MEMWRITE:
806 {
807 ret = mtd_write_ioctl(mtd,
808 (struct mtd_write_req __user *)arg);
809 break;
810 }
811
Linus Torvalds1da177e2005-04-16 15:20:36 -0700812 case MEMLOCK:
813 {
Harvey Harrison175428b2008-07-03 23:40:14 -0700814 struct erase_info_user einfo;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700815
Harvey Harrison175428b2008-07-03 23:40:14 -0700816 if (copy_from_user(&einfo, argp, sizeof(einfo)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700817 return -EFAULT;
818
819 if (!mtd->lock)
820 ret = -EOPNOTSUPP;
821 else
Harvey Harrison175428b2008-07-03 23:40:14 -0700822 ret = mtd->lock(mtd, einfo.start, einfo.length);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700823 break;
824 }
825
826 case MEMUNLOCK:
827 {
Harvey Harrison175428b2008-07-03 23:40:14 -0700828 struct erase_info_user einfo;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700829
Harvey Harrison175428b2008-07-03 23:40:14 -0700830 if (copy_from_user(&einfo, argp, sizeof(einfo)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700831 return -EFAULT;
832
833 if (!mtd->unlock)
834 ret = -EOPNOTSUPP;
835 else
Harvey Harrison175428b2008-07-03 23:40:14 -0700836 ret = mtd->unlock(mtd, einfo.start, einfo.length);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700837 break;
838 }
839
Richard Cochran99384242010-06-14 18:10:33 +0200840 case MEMISLOCKED:
841 {
842 struct erase_info_user einfo;
843
844 if (copy_from_user(&einfo, argp, sizeof(einfo)))
845 return -EFAULT;
846
847 if (!mtd->is_locked)
848 ret = -EOPNOTSUPP;
849 else
850 ret = mtd->is_locked(mtd, einfo.start, einfo.length);
851 break;
852 }
853
Thomas Gleixner5bd34c02006-05-27 22:16:10 +0200854 /* Legacy interface */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700855 case MEMGETOOBSEL:
856 {
Thomas Gleixner5bd34c02006-05-27 22:16:10 +0200857 struct nand_oobinfo oi;
858
859 if (!mtd->ecclayout)
860 return -EOPNOTSUPP;
861 if (mtd->ecclayout->eccbytes > ARRAY_SIZE(oi.eccpos))
862 return -EINVAL;
863
864 oi.useecc = MTD_NANDECC_AUTOPLACE;
865 memcpy(&oi.eccpos, mtd->ecclayout->eccpos, sizeof(oi.eccpos));
866 memcpy(&oi.oobfree, mtd->ecclayout->oobfree,
867 sizeof(oi.oobfree));
Ricard Wanderlöfd25ade72006-10-17 17:27:11 +0200868 oi.eccbytes = mtd->ecclayout->eccbytes;
Thomas Gleixner5bd34c02006-05-27 22:16:10 +0200869
870 if (copy_to_user(argp, &oi, sizeof(struct nand_oobinfo)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700871 return -EFAULT;
872 break;
873 }
874
875 case MEMGETBADBLOCK:
876 {
877 loff_t offs;
Thomas Gleixner97894cd2005-11-07 11:15:26 +0000878
Linus Torvalds1da177e2005-04-16 15:20:36 -0700879 if (copy_from_user(&offs, argp, sizeof(loff_t)))
880 return -EFAULT;
881 if (!mtd->block_isbad)
882 ret = -EOPNOTSUPP;
883 else
884 return mtd->block_isbad(mtd, offs);
885 break;
886 }
887
888 case MEMSETBADBLOCK:
889 {
890 loff_t offs;
891
892 if (copy_from_user(&offs, argp, sizeof(loff_t)))
893 return -EFAULT;
894 if (!mtd->block_markbad)
895 ret = -EOPNOTSUPP;
896 else
897 return mtd->block_markbad(mtd, offs);
898 break;
899 }
900
David Brownell34a82442008-07-30 12:35:05 -0700901#ifdef CONFIG_HAVE_MTD_OTP
Nicolas Pitre31f42332005-02-08 17:45:55 +0000902 case OTPSELECT:
903 {
904 int mode;
905 if (copy_from_user(&mode, argp, sizeof(int)))
906 return -EFAULT;
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200907
Brian Norrisbeb133f2011-08-30 18:45:41 -0700908 mfi->mode = MTD_FILE_MODE_NORMAL;
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200909
910 ret = otp_select_filemode(mfi, mode);
911
Nicolas Pitre81dba482005-04-01 16:36:15 +0100912 file->f_pos = 0;
Nicolas Pitre31f42332005-02-08 17:45:55 +0000913 break;
914 }
915
916 case OTPGETREGIONCOUNT:
917 case OTPGETREGIONINFO:
918 {
919 struct otp_info *buf = kmalloc(4096, GFP_KERNEL);
920 if (!buf)
921 return -ENOMEM;
922 ret = -EOPNOTSUPP;
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200923 switch (mfi->mode) {
Brian Norrisbeb133f2011-08-30 18:45:41 -0700924 case MTD_FILE_MODE_OTP_FACTORY:
Nicolas Pitre31f42332005-02-08 17:45:55 +0000925 if (mtd->get_fact_prot_info)
926 ret = mtd->get_fact_prot_info(mtd, buf, 4096);
927 break;
Brian Norrisbeb133f2011-08-30 18:45:41 -0700928 case MTD_FILE_MODE_OTP_USER:
Nicolas Pitre31f42332005-02-08 17:45:55 +0000929 if (mtd->get_user_prot_info)
930 ret = mtd->get_user_prot_info(mtd, buf, 4096);
931 break;
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200932 default:
933 break;
Nicolas Pitre31f42332005-02-08 17:45:55 +0000934 }
935 if (ret >= 0) {
936 if (cmd == OTPGETREGIONCOUNT) {
937 int nbr = ret / sizeof(struct otp_info);
938 ret = copy_to_user(argp, &nbr, sizeof(int));
939 } else
940 ret = copy_to_user(argp, buf, ret);
941 if (ret)
942 ret = -EFAULT;
943 }
944 kfree(buf);
945 break;
946 }
947
948 case OTPLOCK:
949 {
Harvey Harrison175428b2008-07-03 23:40:14 -0700950 struct otp_info oinfo;
Nicolas Pitre31f42332005-02-08 17:45:55 +0000951
Brian Norrisbeb133f2011-08-30 18:45:41 -0700952 if (mfi->mode != MTD_FILE_MODE_OTP_USER)
Nicolas Pitre31f42332005-02-08 17:45:55 +0000953 return -EINVAL;
Harvey Harrison175428b2008-07-03 23:40:14 -0700954 if (copy_from_user(&oinfo, argp, sizeof(oinfo)))
Nicolas Pitre31f42332005-02-08 17:45:55 +0000955 return -EFAULT;
956 if (!mtd->lock_user_prot_reg)
957 return -EOPNOTSUPP;
Harvey Harrison175428b2008-07-03 23:40:14 -0700958 ret = mtd->lock_user_prot_reg(mtd, oinfo.start, oinfo.length);
Nicolas Pitre31f42332005-02-08 17:45:55 +0000959 break;
960 }
961#endif
962
Brian Norris7854d3f2011-06-23 14:12:08 -0700963 /* This ioctl is being deprecated - it truncates the ECC layout */
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200964 case ECCGETLAYOUT:
965 {
Brian Norriscc26c3c2010-08-24 18:12:00 -0700966 struct nand_ecclayout_user *usrlay;
967
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200968 if (!mtd->ecclayout)
969 return -EOPNOTSUPP;
970
Brian Norriscc26c3c2010-08-24 18:12:00 -0700971 usrlay = kmalloc(sizeof(*usrlay), GFP_KERNEL);
972 if (!usrlay)
973 return -ENOMEM;
974
975 shrink_ecclayout(mtd->ecclayout, usrlay);
976
977 if (copy_to_user(argp, usrlay, sizeof(*usrlay)))
978 ret = -EFAULT;
979 kfree(usrlay);
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200980 break;
981 }
982
983 case ECCGETSTATS:
984 {
985 if (copy_to_user(argp, &mtd->ecc_stats,
986 sizeof(struct mtd_ecc_stats)))
987 return -EFAULT;
988 break;
989 }
990
991 case MTDFILEMODE:
992 {
993 mfi->mode = 0;
994
995 switch(arg) {
Brian Norrisbeb133f2011-08-30 18:45:41 -0700996 case MTD_FILE_MODE_OTP_FACTORY:
997 case MTD_FILE_MODE_OTP_USER:
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200998 ret = otp_select_filemode(mfi, arg);
999 break;
1000
Brian Norrisbeb133f2011-08-30 18:45:41 -07001001 case MTD_FILE_MODE_RAW:
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +02001002 if (!mtd->read_oob || !mtd->write_oob)
1003 return -EOPNOTSUPP;
1004 mfi->mode = arg;
1005
Brian Norrisbeb133f2011-08-30 18:45:41 -07001006 case MTD_FILE_MODE_NORMAL:
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +02001007 break;
1008 default:
1009 ret = -EINVAL;
1010 }
1011 file->f_pos = 0;
1012 break;
1013 }
1014
Roman Tereshonkovd0f79592010-09-17 13:31:42 +03001015 case BLKPG:
1016 {
1017 ret = mtd_blkpg_ioctl(mtd,
1018 (struct blkpg_ioctl_arg __user *)arg);
1019 break;
1020 }
1021
1022 case BLKRRPART:
1023 {
1024 /* No reread partition feature. Just return ok */
1025 ret = 0;
1026 break;
1027 }
Roman Tereshonkovd0f79592010-09-17 13:31:42 +03001028
Linus Torvalds1da177e2005-04-16 15:20:36 -07001029 default:
1030 ret = -ENOTTY;
1031 }
1032
1033 return ret;
1034} /* memory_ioctl */
1035
Arnd Bergmann55929332010-04-27 00:24:05 +02001036static long mtd_unlocked_ioctl(struct file *file, u_int cmd, u_long arg)
1037{
1038 int ret;
1039
Arnd Bergmann5aa82942010-06-02 14:28:52 +02001040 mutex_lock(&mtd_mutex);
Arnd Bergmann55929332010-04-27 00:24:05 +02001041 ret = mtd_ioctl(file, cmd, arg);
Arnd Bergmann5aa82942010-06-02 14:28:52 +02001042 mutex_unlock(&mtd_mutex);
Arnd Bergmann55929332010-04-27 00:24:05 +02001043
1044 return ret;
1045}
1046
Kevin Cernekee97718542009-04-08 22:53:13 -07001047#ifdef CONFIG_COMPAT
1048
1049struct mtd_oob_buf32 {
1050 u_int32_t start;
1051 u_int32_t length;
1052 compat_caddr_t ptr; /* unsigned char* */
1053};
1054
1055#define MEMWRITEOOB32 _IOWR('M', 3, struct mtd_oob_buf32)
1056#define MEMREADOOB32 _IOWR('M', 4, struct mtd_oob_buf32)
1057
1058static long mtd_compat_ioctl(struct file *file, unsigned int cmd,
1059 unsigned long arg)
1060{
1061 struct mtd_file_info *mfi = file->private_data;
1062 struct mtd_info *mtd = mfi->mtd;
David Woodhouse0b6585c2009-05-29 16:09:08 +01001063 void __user *argp = compat_ptr(arg);
Kevin Cernekee97718542009-04-08 22:53:13 -07001064 int ret = 0;
1065
Arnd Bergmann5aa82942010-06-02 14:28:52 +02001066 mutex_lock(&mtd_mutex);
Kevin Cernekee97718542009-04-08 22:53:13 -07001067
1068 switch (cmd) {
1069 case MEMWRITEOOB32:
1070 {
1071 struct mtd_oob_buf32 buf;
1072 struct mtd_oob_buf32 __user *buf_user = argp;
1073
1074 if (copy_from_user(&buf, argp, sizeof(buf)))
1075 ret = -EFAULT;
1076 else
1077 ret = mtd_do_writeoob(file, mtd, buf.start,
1078 buf.length, compat_ptr(buf.ptr),
1079 &buf_user->length);
1080 break;
1081 }
1082
1083 case MEMREADOOB32:
1084 {
1085 struct mtd_oob_buf32 buf;
1086 struct mtd_oob_buf32 __user *buf_user = argp;
1087
1088 /* NOTE: writes return length to buf->start */
1089 if (copy_from_user(&buf, argp, sizeof(buf)))
1090 ret = -EFAULT;
1091 else
Brian Norrisc46f6482011-08-30 18:45:38 -07001092 ret = mtd_do_readoob(file, mtd, buf.start,
Kevin Cernekee97718542009-04-08 22:53:13 -07001093 buf.length, compat_ptr(buf.ptr),
1094 &buf_user->start);
1095 break;
1096 }
1097 default:
Arnd Bergmann55929332010-04-27 00:24:05 +02001098 ret = mtd_ioctl(file, cmd, (unsigned long)argp);
Kevin Cernekee97718542009-04-08 22:53:13 -07001099 }
1100
Arnd Bergmann5aa82942010-06-02 14:28:52 +02001101 mutex_unlock(&mtd_mutex);
Kevin Cernekee97718542009-04-08 22:53:13 -07001102
1103 return ret;
1104}
1105
1106#endif /* CONFIG_COMPAT */
1107
David Howells402d3262009-02-12 10:40:00 +00001108/*
1109 * try to determine where a shared mapping can be made
1110 * - only supported for NOMMU at the moment (MMU can't doesn't copy private
1111 * mappings)
1112 */
1113#ifndef CONFIG_MMU
1114static unsigned long mtd_get_unmapped_area(struct file *file,
1115 unsigned long addr,
1116 unsigned long len,
1117 unsigned long pgoff,
1118 unsigned long flags)
1119{
1120 struct mtd_file_info *mfi = file->private_data;
1121 struct mtd_info *mtd = mfi->mtd;
1122
1123 if (mtd->get_unmapped_area) {
1124 unsigned long offset;
1125
1126 if (addr != 0)
1127 return (unsigned long) -EINVAL;
1128
1129 if (len > mtd->size || pgoff >= (mtd->size >> PAGE_SHIFT))
1130 return (unsigned long) -EINVAL;
1131
1132 offset = pgoff << PAGE_SHIFT;
1133 if (offset > mtd->size - len)
1134 return (unsigned long) -EINVAL;
1135
1136 return mtd->get_unmapped_area(mtd, len, offset, flags);
1137 }
1138
1139 /* can't map directly */
1140 return (unsigned long) -ENOSYS;
1141}
1142#endif
1143
1144/*
1145 * set up a mapping for shared memory segments
1146 */
1147static int mtd_mmap(struct file *file, struct vm_area_struct *vma)
1148{
1149#ifdef CONFIG_MMU
1150 struct mtd_file_info *mfi = file->private_data;
1151 struct mtd_info *mtd = mfi->mtd;
Anatolij Gustschindd02b672010-06-15 09:30:15 +02001152 struct map_info *map = mtd->priv;
1153 unsigned long start;
1154 unsigned long off;
1155 u32 len;
David Howells402d3262009-02-12 10:40:00 +00001156
Anatolij Gustschindd02b672010-06-15 09:30:15 +02001157 if (mtd->type == MTD_RAM || mtd->type == MTD_ROM) {
1158 off = vma->vm_pgoff << PAGE_SHIFT;
1159 start = map->phys;
1160 len = PAGE_ALIGN((start & ~PAGE_MASK) + map->size);
1161 start &= PAGE_MASK;
1162 if ((vma->vm_end - vma->vm_start + off) > len)
1163 return -EINVAL;
1164
1165 off += start;
1166 vma->vm_pgoff = off >> PAGE_SHIFT;
1167 vma->vm_flags |= VM_IO | VM_RESERVED;
1168
1169#ifdef pgprot_noncached
1170 if (file->f_flags & O_DSYNC || off >= __pa(high_memory))
1171 vma->vm_page_prot = pgprot_noncached(vma->vm_page_prot);
1172#endif
1173 if (io_remap_pfn_range(vma, vma->vm_start, off >> PAGE_SHIFT,
1174 vma->vm_end - vma->vm_start,
1175 vma->vm_page_prot))
1176 return -EAGAIN;
1177
David Howells402d3262009-02-12 10:40:00 +00001178 return 0;
Anatolij Gustschindd02b672010-06-15 09:30:15 +02001179 }
David Howells402d3262009-02-12 10:40:00 +00001180 return -ENOSYS;
1181#else
1182 return vma->vm_flags & VM_SHARED ? 0 : -ENOSYS;
1183#endif
1184}
1185
Arjan van de Vend54b1fd2007-02-12 00:55:34 -08001186static const struct file_operations mtd_fops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001187 .owner = THIS_MODULE,
1188 .llseek = mtd_lseek,
1189 .read = mtd_read,
1190 .write = mtd_write,
Arnd Bergmann55929332010-04-27 00:24:05 +02001191 .unlocked_ioctl = mtd_unlocked_ioctl,
Kevin Cernekee97718542009-04-08 22:53:13 -07001192#ifdef CONFIG_COMPAT
1193 .compat_ioctl = mtd_compat_ioctl,
1194#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07001195 .open = mtd_open,
1196 .release = mtd_close,
David Howells402d3262009-02-12 10:40:00 +00001197 .mmap = mtd_mmap,
1198#ifndef CONFIG_MMU
1199 .get_unmapped_area = mtd_get_unmapped_area,
1200#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07001201};
1202
Al Viro51139ad2010-07-25 23:47:46 +04001203static struct dentry *mtd_inodefs_mount(struct file_system_type *fs_type,
1204 int flags, const char *dev_name, void *data)
Kirill A. Shutemovcd874232010-05-17 16:55:47 +03001205{
Al Viroc74a1cb2011-01-12 16:59:34 -05001206 return mount_pseudo(fs_type, "mtd_inode:", NULL, NULL, MTD_INODE_FS_MAGIC);
Kirill A. Shutemovcd874232010-05-17 16:55:47 +03001207}
1208
1209static struct file_system_type mtd_inodefs_type = {
1210 .name = "mtd_inodefs",
Al Viro51139ad2010-07-25 23:47:46 +04001211 .mount = mtd_inodefs_mount,
Kirill A. Shutemovcd874232010-05-17 16:55:47 +03001212 .kill_sb = kill_anon_super,
1213};
1214
1215static void mtdchar_notify_add(struct mtd_info *mtd)
1216{
1217}
1218
1219static void mtdchar_notify_remove(struct mtd_info *mtd)
1220{
1221 struct inode *mtd_ino = ilookup(mtd_inode_mnt->mnt_sb, mtd->index);
1222
1223 if (mtd_ino) {
1224 /* Destroy the inode if it exists */
Miklos Szeredi6d6b77f2011-10-28 14:13:28 +02001225 clear_nlink(mtd_ino);
Kirill A. Shutemovcd874232010-05-17 16:55:47 +03001226 iput(mtd_ino);
1227 }
1228}
1229
1230static struct mtd_notifier mtdchar_notifier = {
1231 .add = mtdchar_notify_add,
1232 .remove = mtdchar_notify_remove,
1233};
1234
Linus Torvalds1da177e2005-04-16 15:20:36 -07001235static int __init init_mtdchar(void)
1236{
Kirill A. Shutemovcd874232010-05-17 16:55:47 +03001237 int ret;
David Brownell1f24b5a2009-03-26 00:42:41 -07001238
Kirill A. Shutemovcd874232010-05-17 16:55:47 +03001239 ret = __register_chrdev(MTD_CHAR_MAJOR, 0, 1 << MINORBITS,
Ben Hutchingsdad0db32010-01-29 21:00:04 +00001240 "mtd", &mtd_fops);
Kirill A. Shutemovcd874232010-05-17 16:55:47 +03001241 if (ret < 0) {
1242 pr_notice("Can't allocate major number %d for "
1243 "Memory Technology Devices.\n", MTD_CHAR_MAJOR);
1244 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001245 }
1246
Kirill A. Shutemovcd874232010-05-17 16:55:47 +03001247 ret = register_filesystem(&mtd_inodefs_type);
1248 if (ret) {
1249 pr_notice("Can't register mtd_inodefs filesystem: %d\n", ret);
1250 goto err_unregister_chdev;
1251 }
1252
1253 mtd_inode_mnt = kern_mount(&mtd_inodefs_type);
1254 if (IS_ERR(mtd_inode_mnt)) {
1255 ret = PTR_ERR(mtd_inode_mnt);
1256 pr_notice("Error mounting mtd_inodefs filesystem: %d\n", ret);
1257 goto err_unregister_filesystem;
1258 }
1259 register_mtd_user(&mtdchar_notifier);
1260
1261 return ret;
1262
1263err_unregister_filesystem:
1264 unregister_filesystem(&mtd_inodefs_type);
1265err_unregister_chdev:
1266 __unregister_chrdev(MTD_CHAR_MAJOR, 0, 1 << MINORBITS, "mtd");
1267 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001268}
1269
1270static void __exit cleanup_mtdchar(void)
1271{
Kirill A. Shutemovcd874232010-05-17 16:55:47 +03001272 unregister_mtd_user(&mtdchar_notifier);
Tim Chen423e0ab2011-07-19 09:32:38 -07001273 kern_unmount(mtd_inode_mnt);
Kirill A. Shutemovcd874232010-05-17 16:55:47 +03001274 unregister_filesystem(&mtd_inodefs_type);
Ben Hutchingsdad0db32010-01-29 21:00:04 +00001275 __unregister_chrdev(MTD_CHAR_MAJOR, 0, 1 << MINORBITS, "mtd");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001276}
1277
1278module_init(init_mtdchar);
1279module_exit(cleanup_mtdchar);
1280
David Brownell1f24b5a2009-03-26 00:42:41 -07001281MODULE_ALIAS_CHARDEV_MAJOR(MTD_CHAR_MAJOR);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001282
1283MODULE_LICENSE("GPL");
1284MODULE_AUTHOR("David Woodhouse <dwmw2@infradead.org>");
1285MODULE_DESCRIPTION("Direct character-device access to MTD devices");
Scott James Remnant90160e12009-03-02 18:42:39 +00001286MODULE_ALIAS_CHARDEV_MAJOR(MTD_CHAR_MAJOR);