blob: cd67c85cc87de460b63c2f912f515aca1dc3e14e [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>
Muthu Kumarb502bd12012-03-23 15:01:50 -070034#include <linux/magic.h>
Ezequiel Garciaf83c3832013-10-13 18:05:23 -030035#include <linux/major.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070036#include <linux/mtd/mtd.h>
Roman Tereshonkovd0f79592010-09-17 13:31:42 +030037#include <linux/mtd/partitions.h>
Anatolij Gustschindd02b672010-06-15 09:30:15 +020038#include <linux/mtd/map.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070039
Linus Torvalds7c0f6ba2016-12-24 11:46:01 -080040#include <linux/uaccess.h>
Todd Poynor9bc7b382005-06-30 01:23:27 +010041
Artem Bityutskiy660685d2013-03-14 13:27:40 +020042#include "mtdcore.h"
43
Arnd Bergmann5aa82942010-06-02 14:28:52 +020044static DEFINE_MUTEX(mtd_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -070045
Nicolas Pitre045e9a52005-02-08 19:12:53 +000046/*
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +020047 * Data structure to hold the pointer to the mtd device as well
Brian Norris92394b5c2011-07-20 09:53:42 -070048 * as mode information of various use cases.
Nicolas Pitre045e9a52005-02-08 19:12:53 +000049 */
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +020050struct mtd_file_info {
51 struct mtd_info *mtd;
52 enum mtd_file_modes mode;
53};
Nicolas Pitre31f42332005-02-08 17:45:55 +000054
Artem Bityutskiy969e57a2011-12-23 17:27:46 +020055static loff_t mtdchar_lseek(struct file *file, loff_t offset, int orig)
Linus Torvalds1da177e2005-04-16 15:20:36 -070056{
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +020057 struct mtd_file_info *mfi = file->private_data;
Al Virob9599572013-06-16 20:27:42 +040058 return fixed_size_llseek(file, offset, orig, mfi->mtd->size);
Linus Torvalds1da177e2005-04-16 15:20:36 -070059}
60
Artem Bityutskiy969e57a2011-12-23 17:27:46 +020061static int mtdchar_open(struct inode *inode, struct file *file)
Linus Torvalds1da177e2005-04-16 15:20:36 -070062{
63 int minor = iminor(inode);
64 int devnum = minor >> 1;
Jonathan Corbet60712392008-05-15 10:10:37 -060065 int ret = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -070066 struct mtd_info *mtd;
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +020067 struct mtd_file_info *mfi;
Linus Torvalds1da177e2005-04-16 15:20:36 -070068
Brian Norris289c0522011-07-19 10:06:09 -070069 pr_debug("MTD_open\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -070070
Linus Torvalds1da177e2005-04-16 15:20:36 -070071 /* You can't open the RO devices RW */
Al Viroaeb5d722008-09-02 15:28:45 -040072 if ((file->f_mode & FMODE_WRITE) && (minor & 1))
Linus Torvalds1da177e2005-04-16 15:20:36 -070073 return -EACCES;
74
Arnd Bergmann5aa82942010-06-02 14:28:52 +020075 mutex_lock(&mtd_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -070076 mtd = get_mtd_device(NULL, devnum);
Thomas Gleixner97894cd2005-11-07 11:15:26 +000077
Jonathan Corbet60712392008-05-15 10:10:37 -060078 if (IS_ERR(mtd)) {
79 ret = PTR_ERR(mtd);
80 goto out;
81 }
Thomas Gleixner97894cd2005-11-07 11:15:26 +000082
David Howells402d3262009-02-12 10:40:00 +000083 if (mtd->type == MTD_ABSENT) {
Jonathan Corbet60712392008-05-15 10:10:37 -060084 ret = -ENODEV;
Al Viroc65390f2012-04-09 01:36:28 -040085 goto out1;
Linus Torvalds1da177e2005-04-16 15:20:36 -070086 }
87
Linus Torvalds1da177e2005-04-16 15:20:36 -070088 /* You can't open it RW if it's not a writeable device */
Al Viroaeb5d722008-09-02 15:28:45 -040089 if ((file->f_mode & FMODE_WRITE) && !(mtd->flags & MTD_WRITEABLE)) {
Jonathan Corbet60712392008-05-15 10:10:37 -060090 ret = -EACCES;
Christoph Hellwigb4caecd2015-01-14 10:42:32 +010091 goto out1;
Linus Torvalds1da177e2005-04-16 15:20:36 -070092 }
Thomas Gleixner97894cd2005-11-07 11:15:26 +000093
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +020094 mfi = kzalloc(sizeof(*mfi), GFP_KERNEL);
95 if (!mfi) {
Jonathan Corbet60712392008-05-15 10:10:37 -060096 ret = -ENOMEM;
Christoph Hellwigb4caecd2015-01-14 10:42:32 +010097 goto out1;
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +020098 }
99 mfi->mtd = mtd;
100 file->private_data = mfi;
Al Viroc65390f2012-04-09 01:36:28 -0400101 mutex_unlock(&mtd_mutex);
102 return 0;
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200103
Al Viroc65390f2012-04-09 01:36:28 -0400104out1:
105 put_mtd_device(mtd);
Jonathan Corbet60712392008-05-15 10:10:37 -0600106out:
Arnd Bergmann5aa82942010-06-02 14:28:52 +0200107 mutex_unlock(&mtd_mutex);
Jonathan Corbet60712392008-05-15 10:10:37 -0600108 return ret;
Artem Bityutskiy969e57a2011-12-23 17:27:46 +0200109} /* mtdchar_open */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700110
111/*====================================================================*/
112
Artem Bityutskiy969e57a2011-12-23 17:27:46 +0200113static int mtdchar_close(struct inode *inode, struct file *file)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700114{
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200115 struct mtd_file_info *mfi = file->private_data;
116 struct mtd_info *mtd = mfi->mtd;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700117
Brian Norris289c0522011-07-19 10:06:09 -0700118 pr_debug("MTD_close\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700119
Joakim Tjernlund7eafaed2007-06-27 00:56:40 +0200120 /* Only sync if opened RW */
Artem Bityutskiy327cf292011-12-30 16:35:35 +0200121 if ((file->f_mode & FMODE_WRITE))
Artem Bityutskiy85f2f2a2011-12-23 19:03:12 +0200122 mtd_sync(mtd);
Thomas Gleixner97894cd2005-11-07 11:15:26 +0000123
Linus Torvalds1da177e2005-04-16 15:20:36 -0700124 put_mtd_device(mtd);
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200125 file->private_data = NULL;
126 kfree(mfi);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700127
128 return 0;
Artem Bityutskiy969e57a2011-12-23 17:27:46 +0200129} /* mtdchar_close */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700130
Grant Erickson3e45cf52011-04-08 08:51:33 -0700131/* Back in June 2001, dwmw2 wrote:
132 *
133 * FIXME: This _really_ needs to die. In 2.5, we should lock the
134 * userspace buffer down and use it directly with readv/writev.
135 *
136 * The implementation below, using mtd_kmalloc_up_to, mitigates
137 * allocation failures when the system is under low-memory situations
138 * or if memory is highly fragmented at the cost of reducing the
139 * performance of the requested transfer due to a smaller buffer size.
140 *
141 * A more complex but more memory-efficient implementation based on
142 * get_user_pages and iovecs to cover extents of those pages is a
143 * longer-term goal, as intimated by dwmw2 above. However, for the
144 * write case, this requires yet more complex head and tail transfer
145 * handling when those head and tail offsets and sizes are such that
146 * alignment requirements are not met in the NAND subdriver.
147 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700148
Artem Bityutskiy969e57a2011-12-23 17:27:46 +0200149static ssize_t mtdchar_read(struct file *file, char __user *buf, size_t count,
150 loff_t *ppos)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700151{
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200152 struct mtd_file_info *mfi = file->private_data;
153 struct mtd_info *mtd = mfi->mtd;
Artem Bityutskiy30fa9842011-12-29 15:16:28 +0200154 size_t retlen;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700155 size_t total_retlen=0;
156 int ret=0;
157 int len;
Grant Erickson3e45cf52011-04-08 08:51:33 -0700158 size_t size = count;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700159 char *kbuf;
Thomas Gleixner97894cd2005-11-07 11:15:26 +0000160
Brian Norris289c0522011-07-19 10:06:09 -0700161 pr_debug("MTD_read\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700162
163 if (*ppos + count > mtd->size)
164 count = mtd->size - *ppos;
165
166 if (!count)
167 return 0;
Thomas Gleixner97894cd2005-11-07 11:15:26 +0000168
Grant Erickson3e45cf52011-04-08 08:51:33 -0700169 kbuf = mtd_kmalloc_up_to(mtd, &size);
Thago Galesib802c072006-04-17 17:38:15 +0100170 if (!kbuf)
171 return -ENOMEM;
172
Linus Torvalds1da177e2005-04-16 15:20:36 -0700173 while (count) {
Grant Erickson3e45cf52011-04-08 08:51:33 -0700174 len = min_t(size_t, count, size);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700175
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200176 switch (mfi->mode) {
Brian Norrisbeb133f2011-08-30 18:45:41 -0700177 case MTD_FILE_MODE_OTP_FACTORY:
Artem Bityutskiyd264f722011-12-23 18:40:06 +0200178 ret = mtd_read_fact_prot_reg(mtd, *ppos, len,
179 &retlen, kbuf);
Nicolas Pitre31f42332005-02-08 17:45:55 +0000180 break;
Brian Norrisbeb133f2011-08-30 18:45:41 -0700181 case MTD_FILE_MODE_OTP_USER:
Artem Bityutskiy4ea1cab2011-12-23 18:47:59 +0200182 ret = mtd_read_user_prot_reg(mtd, *ppos, len,
183 &retlen, kbuf);
Nicolas Pitre31f42332005-02-08 17:45:55 +0000184 break;
Brian Norrisbeb133f2011-08-30 18:45:41 -0700185 case MTD_FILE_MODE_RAW:
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200186 {
187 struct mtd_oob_ops ops;
188
Brian Norris0612b9d2011-08-30 18:45:40 -0700189 ops.mode = MTD_OPS_RAW;
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200190 ops.datbuf = kbuf;
191 ops.oobbuf = NULL;
192 ops.len = len;
193
Artem Bityutskiyfd2819b2011-12-23 18:27:05 +0200194 ret = mtd_read_oob(mtd, *ppos, &ops);
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200195 retlen = ops.retlen;
196 break;
197 }
Nicolas Pitre31f42332005-02-08 17:45:55 +0000198 default:
Artem Bityutskiy329ad392011-12-23 17:30:16 +0200199 ret = mtd_read(mtd, *ppos, len, &retlen, kbuf);
Nicolas Pitre31f42332005-02-08 17:45:55 +0000200 }
Brian Norris7854d3f2011-06-23 14:12:08 -0700201 /* Nand returns -EBADMSG on ECC errors, but it returns
Linus Torvalds1da177e2005-04-16 15:20:36 -0700202 * the data. For our userspace tools it is important
Brian Norris7854d3f2011-06-23 14:12:08 -0700203 * to dump areas with ECC errors!
Thomas Gleixner9a1fcdf2006-05-29 14:56:39 +0200204 * For kernel internal usage it also might return -EUCLEAN
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300205 * to signal the caller that a bitflip has occurred and has
Thomas Gleixner9a1fcdf2006-05-29 14:56:39 +0200206 * been corrected by the ECC algorithm.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700207 * Userspace software which accesses NAND this way
208 * must be aware of the fact that it deals with NAND
209 */
Brian Norrisd57f40542011-09-20 18:34:25 -0700210 if (!ret || mtd_is_bitflip_or_eccerr(ret)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700211 *ppos += retlen;
212 if (copy_to_user(buf, kbuf, retlen)) {
Thomas Gleixnerf4a43cf2006-05-28 11:01:53 +0200213 kfree(kbuf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700214 return -EFAULT;
215 }
216 else
217 total_retlen += retlen;
218
219 count -= retlen;
220 buf += retlen;
Nicolas Pitre31f42332005-02-08 17:45:55 +0000221 if (retlen == 0)
222 count = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700223 }
224 else {
225 kfree(kbuf);
226 return ret;
227 }
Thomas Gleixner97894cd2005-11-07 11:15:26 +0000228
Linus Torvalds1da177e2005-04-16 15:20:36 -0700229 }
230
Thago Galesib802c072006-04-17 17:38:15 +0100231 kfree(kbuf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700232 return total_retlen;
Artem Bityutskiy969e57a2011-12-23 17:27:46 +0200233} /* mtdchar_read */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700234
Artem Bityutskiy969e57a2011-12-23 17:27:46 +0200235static ssize_t mtdchar_write(struct file *file, const char __user *buf, size_t count,
236 loff_t *ppos)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700237{
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200238 struct mtd_file_info *mfi = file->private_data;
239 struct mtd_info *mtd = mfi->mtd;
Grant Erickson3e45cf52011-04-08 08:51:33 -0700240 size_t size = count;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700241 char *kbuf;
242 size_t retlen;
243 size_t total_retlen=0;
244 int ret=0;
245 int len;
246
Brian Norris289c0522011-07-19 10:06:09 -0700247 pr_debug("MTD_write\n");
Thomas Gleixner97894cd2005-11-07 11:15:26 +0000248
Linus Torvalds1da177e2005-04-16 15:20:36 -0700249 if (*ppos == mtd->size)
250 return -ENOSPC;
Thomas Gleixner97894cd2005-11-07 11:15:26 +0000251
Linus Torvalds1da177e2005-04-16 15:20:36 -0700252 if (*ppos + count > mtd->size)
253 count = mtd->size - *ppos;
254
255 if (!count)
256 return 0;
257
Grant Erickson3e45cf52011-04-08 08:51:33 -0700258 kbuf = mtd_kmalloc_up_to(mtd, &size);
Thago Galesib802c072006-04-17 17:38:15 +0100259 if (!kbuf)
260 return -ENOMEM;
261
Linus Torvalds1da177e2005-04-16 15:20:36 -0700262 while (count) {
Grant Erickson3e45cf52011-04-08 08:51:33 -0700263 len = min_t(size_t, count, size);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700264
Linus Torvalds1da177e2005-04-16 15:20:36 -0700265 if (copy_from_user(kbuf, buf, len)) {
266 kfree(kbuf);
267 return -EFAULT;
268 }
Thomas Gleixner97894cd2005-11-07 11:15:26 +0000269
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200270 switch (mfi->mode) {
Brian Norrisbeb133f2011-08-30 18:45:41 -0700271 case MTD_FILE_MODE_OTP_FACTORY:
Nicolas Pitre31f42332005-02-08 17:45:55 +0000272 ret = -EROFS;
273 break;
Brian Norrisbeb133f2011-08-30 18:45:41 -0700274 case MTD_FILE_MODE_OTP_USER:
Artem Bityutskiy482b43a2011-12-23 18:50:04 +0200275 ret = mtd_write_user_prot_reg(mtd, *ppos, len,
276 &retlen, kbuf);
Nicolas Pitre31f42332005-02-08 17:45:55 +0000277 break;
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200278
Brian Norrisbeb133f2011-08-30 18:45:41 -0700279 case MTD_FILE_MODE_RAW:
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200280 {
281 struct mtd_oob_ops ops;
282
Brian Norris0612b9d2011-08-30 18:45:40 -0700283 ops.mode = MTD_OPS_RAW;
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200284 ops.datbuf = kbuf;
285 ops.oobbuf = NULL;
Peter Wippichbf514082011-06-06 15:50:58 +0200286 ops.ooboffs = 0;
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200287 ops.len = len;
288
Artem Bityutskiya2cc5ba2011-12-23 18:29:55 +0200289 ret = mtd_write_oob(mtd, *ppos, &ops);
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200290 retlen = ops.retlen;
291 break;
292 }
293
Nicolas Pitre31f42332005-02-08 17:45:55 +0000294 default:
Artem Bityutskiyeda95cb2011-12-23 17:35:41 +0200295 ret = mtd_write(mtd, *ppos, len, &retlen, kbuf);
Nicolas Pitre31f42332005-02-08 17:45:55 +0000296 }
Christian Riesch9a78bc82014-03-06 12:42:37 +0100297
298 /*
299 * Return -ENOSPC only if no data could be written at all.
300 * Otherwise just return the number of bytes that actually
301 * have been written.
302 */
303 if ((ret == -ENOSPC) && (total_retlen))
304 break;
305
Linus Torvalds1da177e2005-04-16 15:20:36 -0700306 if (!ret) {
307 *ppos += retlen;
308 total_retlen += retlen;
309 count -= retlen;
310 buf += retlen;
311 }
312 else {
313 kfree(kbuf);
314 return ret;
315 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700316 }
317
Thago Galesib802c072006-04-17 17:38:15 +0100318 kfree(kbuf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700319 return total_retlen;
Artem Bityutskiy969e57a2011-12-23 17:27:46 +0200320} /* mtdchar_write */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700321
322/*======================================================================
323
324 IOCTL calls for getting device parameters.
325
326======================================================================*/
Linus Torvalds1da177e2005-04-16 15:20:36 -0700327
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200328static int otp_select_filemode(struct mtd_file_info *mfi, int mode)
329{
330 struct mtd_info *mtd = mfi->mtd;
Artem Bityutskiyb6de3d62011-12-29 10:06:32 +0200331 size_t retlen;
Artem Bityutskiyb6de3d62011-12-29 10:06:32 +0200332
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200333 switch (mode) {
334 case MTD_OTP_FACTORY:
Uwe Kleine-König5dc63fa2013-03-04 17:35:24 +0100335 if (mtd_read_fact_prot_reg(mtd, -1, 0, &retlen, NULL) ==
336 -EOPNOTSUPP)
337 return -EOPNOTSUPP;
338
Artem Bityutskiyb6de3d62011-12-29 10:06:32 +0200339 mfi->mode = MTD_FILE_MODE_OTP_FACTORY;
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200340 break;
341 case MTD_OTP_USER:
Uwe Kleine-König5dc63fa2013-03-04 17:35:24 +0100342 if (mtd_read_user_prot_reg(mtd, -1, 0, &retlen, NULL) ==
343 -EOPNOTSUPP)
344 return -EOPNOTSUPP;
345
Artem Bityutskiyb6de3d62011-12-29 10:06:32 +0200346 mfi->mode = MTD_FILE_MODE_OTP_USER;
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200347 break;
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200348 case MTD_OTP_OFF:
Uwe Kleine-König5dc63fa2013-03-04 17:35:24 +0100349 mfi->mode = MTD_FILE_MODE_NORMAL;
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200350 break;
Uwe Kleine-König5dc63fa2013-03-04 17:35:24 +0100351 default:
352 return -EINVAL;
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200353 }
Uwe Kleine-König5dc63fa2013-03-04 17:35:24 +0100354
355 return 0;
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200356}
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200357
Artem Bityutskiy969e57a2011-12-23 17:27:46 +0200358static int mtdchar_writeoob(struct file *file, struct mtd_info *mtd,
Kevin Cernekee97718542009-04-08 22:53:13 -0700359 uint64_t start, uint32_t length, void __user *ptr,
360 uint32_t __user *retp)
361{
Brian Norris9ce244b2011-08-30 18:45:37 -0700362 struct mtd_file_info *mfi = file->private_data;
Kevin Cernekee97718542009-04-08 22:53:13 -0700363 struct mtd_oob_ops ops;
364 uint32_t retlen;
365 int ret = 0;
366
367 if (!(file->f_mode & FMODE_WRITE))
368 return -EPERM;
369
370 if (length > 4096)
371 return -EINVAL;
372
Artem Bityutskiy3c3c10b2012-01-30 14:58:32 +0200373 if (!mtd->_write_oob)
Al Viro0db188f2017-09-29 13:55:19 -0400374 return -EOPNOTSUPP;
Kevin Cernekee97718542009-04-08 22:53:13 -0700375
376 ops.ooblen = length;
Brian Norris305b93f2011-08-23 17:17:32 -0700377 ops.ooboffs = start & (mtd->writesize - 1);
Kevin Cernekee97718542009-04-08 22:53:13 -0700378 ops.datbuf = NULL;
Brian Norrisbeb133f2011-08-30 18:45:41 -0700379 ops.mode = (mfi->mode == MTD_FILE_MODE_RAW) ? MTD_OPS_RAW :
Brian Norris0612b9d2011-08-30 18:45:40 -0700380 MTD_OPS_PLACE_OOB;
Kevin Cernekee97718542009-04-08 22:53:13 -0700381
382 if (ops.ooboffs && ops.ooblen > (mtd->oobsize - ops.ooboffs))
383 return -EINVAL;
384
Julia Lawalldf1f1d12010-05-22 10:22:49 +0200385 ops.oobbuf = memdup_user(ptr, length);
386 if (IS_ERR(ops.oobbuf))
387 return PTR_ERR(ops.oobbuf);
Kevin Cernekee97718542009-04-08 22:53:13 -0700388
Brian Norris305b93f2011-08-23 17:17:32 -0700389 start &= ~((uint64_t)mtd->writesize - 1);
Artem Bityutskiya2cc5ba2011-12-23 18:29:55 +0200390 ret = mtd_write_oob(mtd, start, &ops);
Kevin Cernekee97718542009-04-08 22:53:13 -0700391
392 if (ops.oobretlen > 0xFFFFFFFFU)
393 ret = -EOVERFLOW;
394 retlen = ops.oobretlen;
395 if (copy_to_user(retp, &retlen, sizeof(length)))
396 ret = -EFAULT;
397
398 kfree(ops.oobbuf);
399 return ret;
400}
401
Artem Bityutskiy969e57a2011-12-23 17:27:46 +0200402static int mtdchar_readoob(struct file *file, struct mtd_info *mtd,
Brian Norrisc46f6482011-08-30 18:45:38 -0700403 uint64_t start, uint32_t length, void __user *ptr,
404 uint32_t __user *retp)
Kevin Cernekee97718542009-04-08 22:53:13 -0700405{
Brian Norrisc46f6482011-08-30 18:45:38 -0700406 struct mtd_file_info *mfi = file->private_data;
Kevin Cernekee97718542009-04-08 22:53:13 -0700407 struct mtd_oob_ops ops;
408 int ret = 0;
409
410 if (length > 4096)
411 return -EINVAL;
412
Kevin Cernekee97718542009-04-08 22:53:13 -0700413 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
422 ops.oobbuf = kmalloc(length, GFP_KERNEL);
423 if (!ops.oobbuf)
424 return -ENOMEM;
425
Brian Norris305b93f2011-08-23 17:17:32 -0700426 start &= ~((uint64_t)mtd->writesize - 1);
Artem Bityutskiyfd2819b2011-12-23 18:27:05 +0200427 ret = mtd_read_oob(mtd, start, &ops);
Kevin Cernekee97718542009-04-08 22:53:13 -0700428
429 if (put_user(ops.oobretlen, retp))
430 ret = -EFAULT;
431 else if (ops.oobretlen && copy_to_user(ptr, ops.oobbuf,
432 ops.oobretlen))
433 ret = -EFAULT;
434
435 kfree(ops.oobbuf);
Brian Norris041e4572011-06-23 16:45:24 -0700436
437 /*
438 * NAND returns -EBADMSG on ECC errors, but it returns the OOB
439 * data. For our userspace tools it is important to dump areas
440 * with ECC errors!
441 * For kernel internal usage it also might return -EUCLEAN
Nobuhiro Iwamatsu5d708ec2017-01-27 10:36:38 +0900442 * to signal the caller that a bitflip has occurred and has
Brian Norris041e4572011-06-23 16:45:24 -0700443 * been corrected by the ECC algorithm.
444 *
Brian Norrisc478d7e2011-06-28 16:29:00 -0700445 * Note: currently the standard NAND function, nand_read_oob_std,
446 * does not calculate ECC for the OOB area, so do not rely on
447 * this behavior unless you have replaced it with your own.
Brian Norris041e4572011-06-23 16:45:24 -0700448 */
Brian Norrisd57f40542011-09-20 18:34:25 -0700449 if (mtd_is_bitflip_or_eccerr(ret))
Brian Norris041e4572011-06-23 16:45:24 -0700450 return 0;
451
Kevin Cernekee97718542009-04-08 22:53:13 -0700452 return ret;
453}
454
Brian Norriscc26c3c2010-08-24 18:12:00 -0700455/*
Boris Brezillonaab616e2016-02-04 10:16:18 +0100456 * Copies (and truncates, if necessary) OOB layout information to the
457 * deprecated layout struct, nand_ecclayout_user. This is necessary only to
458 * support the deprecated API ioctl ECCGETLAYOUT while allowing all new
459 * functionality to use mtd_ooblayout_ops flexibly (i.e. mtd_ooblayout_ops
460 * can describe any kind of OOB layout with almost zero overhead from a
461 * memory usage point of view).
Brian Norriscc26c3c2010-08-24 18:12:00 -0700462 */
Boris Brezillonc2b78452016-02-03 20:10:30 +0100463static int shrink_ecclayout(struct mtd_info *mtd,
464 struct nand_ecclayout_user *to)
Brian Norriscc26c3c2010-08-24 18:12:00 -0700465{
Boris Brezillonc2b78452016-02-03 20:10:30 +0100466 struct mtd_oob_region oobregion;
467 int i, section = 0, ret;
Brian Norriscc26c3c2010-08-24 18:12:00 -0700468
Boris Brezillonc2b78452016-02-03 20:10:30 +0100469 if (!mtd || !to)
Brian Norriscc26c3c2010-08-24 18:12:00 -0700470 return -EINVAL;
471
472 memset(to, 0, sizeof(*to));
473
Boris Brezillonc2b78452016-02-03 20:10:30 +0100474 to->eccbytes = 0;
475 for (i = 0; i < MTD_MAX_ECCPOS_ENTRIES;) {
476 u32 eccpos;
477
OuYang ZhiZhong6de56492018-03-11 15:59:07 +0800478 ret = mtd_ooblayout_ecc(mtd, section++, &oobregion);
Boris Brezillonc2b78452016-02-03 20:10:30 +0100479 if (ret < 0) {
480 if (ret != -ERANGE)
481 return ret;
482
483 break;
484 }
485
486 eccpos = oobregion.offset;
487 for (; i < MTD_MAX_ECCPOS_ENTRIES &&
488 eccpos < oobregion.offset + oobregion.length; i++) {
489 to->eccpos[i] = eccpos++;
490 to->eccbytes++;
491 }
492 }
Brian Norriscc26c3c2010-08-24 18:12:00 -0700493
494 for (i = 0; i < MTD_MAX_OOBFREE_ENTRIES; i++) {
Boris Brezillonc2b78452016-02-03 20:10:30 +0100495 ret = mtd_ooblayout_free(mtd, i, &oobregion);
496 if (ret < 0) {
497 if (ret != -ERANGE)
498 return ret;
499
Brian Norriscc26c3c2010-08-24 18:12:00 -0700500 break;
Boris Brezillonc2b78452016-02-03 20:10:30 +0100501 }
502
503 to->oobfree[i].offset = oobregion.offset;
504 to->oobfree[i].length = oobregion.length;
505 to->oobavail += to->oobfree[i].length;
Brian Norriscc26c3c2010-08-24 18:12:00 -0700506 }
507
508 return 0;
509}
510
Boris Brezillonc2b78452016-02-03 20:10:30 +0100511static int get_oobinfo(struct mtd_info *mtd, struct nand_oobinfo *to)
512{
513 struct mtd_oob_region oobregion;
514 int i, section = 0, ret;
515
516 if (!mtd || !to)
517 return -EINVAL;
518
519 memset(to, 0, sizeof(*to));
520
521 to->eccbytes = 0;
522 for (i = 0; i < ARRAY_SIZE(to->eccpos);) {
523 u32 eccpos;
524
OuYang ZhiZhong6de56492018-03-11 15:59:07 +0800525 ret = mtd_ooblayout_ecc(mtd, section++, &oobregion);
Boris Brezillonc2b78452016-02-03 20:10:30 +0100526 if (ret < 0) {
527 if (ret != -ERANGE)
528 return ret;
529
530 break;
531 }
532
533 if (oobregion.length + i > ARRAY_SIZE(to->eccpos))
534 return -EINVAL;
535
536 eccpos = oobregion.offset;
537 for (; eccpos < oobregion.offset + oobregion.length; i++) {
538 to->eccpos[i] = eccpos++;
539 to->eccbytes++;
540 }
541 }
542
543 for (i = 0; i < 8; i++) {
544 ret = mtd_ooblayout_free(mtd, i, &oobregion);
545 if (ret < 0) {
546 if (ret != -ERANGE)
547 return ret;
548
549 break;
550 }
551
552 to->oobfree[i][0] = oobregion.offset;
553 to->oobfree[i][1] = oobregion.length;
554 }
555
556 to->useecc = MTD_NANDECC_AUTOPLACE;
557
558 return 0;
559}
560
Artem Bityutskiy969e57a2011-12-23 17:27:46 +0200561static int mtdchar_blkpg_ioctl(struct mtd_info *mtd,
Brian Norris53bb7242015-09-21 13:26:59 -0700562 struct blkpg_ioctl_arg *arg)
Roman Tereshonkovd0f79592010-09-17 13:31:42 +0300563{
Roman Tereshonkovd0f79592010-09-17 13:31:42 +0300564 struct blkpg_partition p;
565
566 if (!capable(CAP_SYS_ADMIN))
567 return -EPERM;
568
Brian Norris53bb7242015-09-21 13:26:59 -0700569 if (copy_from_user(&p, arg->data, sizeof(p)))
Roman Tereshonkovd0f79592010-09-17 13:31:42 +0300570 return -EFAULT;
571
Brian Norris53bb7242015-09-21 13:26:59 -0700572 switch (arg->op) {
Roman Tereshonkovd0f79592010-09-17 13:31:42 +0300573 case BLKPG_ADD_PARTITION:
574
Roman Tereshonkova7e93dc2010-11-23 14:17:17 +0200575 /* Only master mtd device must be used to add partitions */
576 if (mtd_is_partition(mtd))
577 return -EINVAL;
578
Brian Norris1cc8d842014-07-21 19:08:13 -0700579 /* Sanitize user input */
580 p.devname[BLKPG_DEVNAMELTH - 1] = '\0';
581
Roman Tereshonkovd0f79592010-09-17 13:31:42 +0300582 return mtd_add_partition(mtd, p.devname, p.start, p.length);
583
584 case BLKPG_DEL_PARTITION:
585
586 if (p.pno < 0)
587 return -EINVAL;
588
589 return mtd_del_partition(mtd, p.pno);
590
591 default:
592 return -EINVAL;
593 }
594}
Roman Tereshonkovd0f79592010-09-17 13:31:42 +0300595
Artem Bityutskiy969e57a2011-12-23 17:27:46 +0200596static int mtdchar_write_ioctl(struct mtd_info *mtd,
Brian Norrise99d8b02011-09-09 09:59:03 -0700597 struct mtd_write_req __user *argp)
598{
599 struct mtd_write_req req;
600 struct mtd_oob_ops ops;
Geert Uytterhoevenf62cde42014-05-01 20:40:54 +0200601 const void __user *usr_data, *usr_oob;
Brian Norrise99d8b02011-09-09 09:59:03 -0700602 int ret;
603
Geert Uytterhoevenf62cde42014-05-01 20:40:54 +0200604 if (copy_from_user(&req, argp, sizeof(req)))
Brian Norrise99d8b02011-09-09 09:59:03 -0700605 return -EFAULT;
Geert Uytterhoevenf62cde42014-05-01 20:40:54 +0200606
607 usr_data = (const void __user *)(uintptr_t)req.usr_data;
608 usr_oob = (const void __user *)(uintptr_t)req.usr_oob;
Geert Uytterhoevenf62cde42014-05-01 20:40:54 +0200609
Artem Bityutskiy3c3c10b2012-01-30 14:58:32 +0200610 if (!mtd->_write_oob)
Brian Norrise99d8b02011-09-09 09:59:03 -0700611 return -EOPNOTSUPP;
612
613 ops.mode = req.mode;
614 ops.len = (size_t)req.len;
615 ops.ooblen = (size_t)req.ooblen;
616 ops.ooboffs = 0;
617
Geert Uytterhoevenf62cde42014-05-01 20:40:54 +0200618 if (usr_data) {
Brian Norrise99d8b02011-09-09 09:59:03 -0700619 ops.datbuf = memdup_user(usr_data, ops.len);
620 if (IS_ERR(ops.datbuf))
621 return PTR_ERR(ops.datbuf);
622 } else {
623 ops.datbuf = NULL;
624 }
625
Geert Uytterhoevenf62cde42014-05-01 20:40:54 +0200626 if (usr_oob) {
Brian Norrise99d8b02011-09-09 09:59:03 -0700627 ops.oobbuf = memdup_user(usr_oob, ops.ooblen);
628 if (IS_ERR(ops.oobbuf)) {
629 kfree(ops.datbuf);
630 return PTR_ERR(ops.oobbuf);
631 }
632 } else {
633 ops.oobbuf = NULL;
634 }
635
Artem Bityutskiya2cc5ba2011-12-23 18:29:55 +0200636 ret = mtd_write_oob(mtd, (loff_t)req.start, &ops);
Brian Norrise99d8b02011-09-09 09:59:03 -0700637
638 kfree(ops.datbuf);
639 kfree(ops.oobbuf);
640
641 return ret;
642}
643
Artem Bityutskiy969e57a2011-12-23 17:27:46 +0200644static int mtdchar_ioctl(struct file *file, u_int cmd, u_long arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700645{
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200646 struct mtd_file_info *mfi = file->private_data;
647 struct mtd_info *mtd = mfi->mtd;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700648 void __user *argp = (void __user *)arg;
649 int ret = 0;
Joern Engel73c619e2006-05-30 14:25:35 +0200650 struct mtd_info_user info;
Thomas Gleixner97894cd2005-11-07 11:15:26 +0000651
Brian Norris289c0522011-07-19 10:06:09 -0700652 pr_debug("MTD_ioctl\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700653
Linus Torvalds1da177e2005-04-16 15:20:36 -0700654 switch (cmd) {
655 case MEMGETREGIONCOUNT:
656 if (copy_to_user(argp, &(mtd->numeraseregions), sizeof(int)))
657 return -EFAULT;
658 break;
659
660 case MEMGETREGIONINFO:
661 {
Zev Weissb67c5f82008-09-01 05:02:12 -0700662 uint32_t ur_idx;
663 struct mtd_erase_region_info *kr;
H Hartley Sweetenbcc98a42010-01-15 11:25:38 -0700664 struct region_info_user __user *ur = argp;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700665
Zev Weissb67c5f82008-09-01 05:02:12 -0700666 if (get_user(ur_idx, &(ur->regionindex)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700667 return -EFAULT;
668
Dan Carpenter5e59be12010-09-08 21:39:56 +0200669 if (ur_idx >= mtd->numeraseregions)
670 return -EINVAL;
671
Zev Weissb67c5f82008-09-01 05:02:12 -0700672 kr = &(mtd->eraseregions[ur_idx]);
673
674 if (put_user(kr->offset, &(ur->offset))
675 || put_user(kr->erasesize, &(ur->erasesize))
676 || put_user(kr->numblocks, &(ur->numblocks)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700677 return -EFAULT;
Zev Weissb67c5f82008-09-01 05:02:12 -0700678
Linus Torvalds1da177e2005-04-16 15:20:36 -0700679 break;
680 }
681
682 case MEMGETINFO:
Vasiliy Kulikova0c5a392010-11-06 17:41:24 +0300683 memset(&info, 0, sizeof(info));
Joern Engel73c619e2006-05-30 14:25:35 +0200684 info.type = mtd->type;
685 info.flags = mtd->flags;
686 info.size = mtd->size;
687 info.erasesize = mtd->erasesize;
688 info.writesize = mtd->writesize;
689 info.oobsize = mtd->oobsize;
Brian Norris19fb4342011-08-30 18:45:46 -0700690 /* The below field is obsolete */
691 info.padding = 0;
Joern Engel73c619e2006-05-30 14:25:35 +0200692 if (copy_to_user(argp, &info, sizeof(struct mtd_info_user)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700693 return -EFAULT;
694 break;
695
696 case MEMERASE:
Kevin Cernekee0dc54e92009-04-08 22:52:28 -0700697 case MEMERASE64:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700698 {
699 struct erase_info *erase;
700
Al Viroaeb5d722008-09-02 15:28:45 -0400701 if(!(file->f_mode & FMODE_WRITE))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700702 return -EPERM;
703
Burman Yan95b93a02006-11-15 21:10:29 +0200704 erase=kzalloc(sizeof(struct erase_info),GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700705 if (!erase)
706 ret = -ENOMEM;
707 else {
Kevin Cernekee0dc54e92009-04-08 22:52:28 -0700708 if (cmd == MEMERASE64) {
709 struct erase_info_user64 einfo64;
710
711 if (copy_from_user(&einfo64, argp,
712 sizeof(struct erase_info_user64))) {
713 kfree(erase);
714 return -EFAULT;
715 }
716 erase->addr = einfo64.start;
717 erase->len = einfo64.length;
718 } else {
719 struct erase_info_user einfo32;
720
721 if (copy_from_user(&einfo32, argp,
722 sizeof(struct erase_info_user))) {
723 kfree(erase);
724 return -EFAULT;
725 }
726 erase->addr = einfo32.start;
727 erase->len = einfo32.length;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700728 }
Thomas Gleixner97894cd2005-11-07 11:15:26 +0000729
Artem Bityutskiy7e1f0dc2011-12-23 15:25:39 +0200730 ret = mtd_erase(mtd, erase);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700731 kfree(erase);
732 }
733 break;
734 }
735
736 case MEMWRITEOOB:
737 {
738 struct mtd_oob_buf buf;
Kevin Cernekee97718542009-04-08 22:53:13 -0700739 struct mtd_oob_buf __user *buf_user = argp;
Thomas Gleixner97894cd2005-11-07 11:15:26 +0000740
Kevin Cernekee97718542009-04-08 22:53:13 -0700741 /* NOTE: writes return length to buf_user->length */
742 if (copy_from_user(&buf, argp, sizeof(buf)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700743 ret = -EFAULT;
Kevin Cernekee97718542009-04-08 22:53:13 -0700744 else
Artem Bityutskiy969e57a2011-12-23 17:27:46 +0200745 ret = mtdchar_writeoob(file, mtd, buf.start, buf.length,
Kevin Cernekee97718542009-04-08 22:53:13 -0700746 buf.ptr, &buf_user->length);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700747 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700748 }
749
750 case MEMREADOOB:
751 {
752 struct mtd_oob_buf buf;
Kevin Cernekee97718542009-04-08 22:53:13 -0700753 struct mtd_oob_buf __user *buf_user = argp;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700754
Kevin Cernekee97718542009-04-08 22:53:13 -0700755 /* NOTE: writes return length to buf_user->start */
756 if (copy_from_user(&buf, argp, sizeof(buf)))
757 ret = -EFAULT;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700758 else
Artem Bityutskiy969e57a2011-12-23 17:27:46 +0200759 ret = mtdchar_readoob(file, mtd, buf.start, buf.length,
Kevin Cernekee97718542009-04-08 22:53:13 -0700760 buf.ptr, &buf_user->start);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700761 break;
762 }
763
Kevin Cernekeeaea7cea2009-04-08 22:53:49 -0700764 case MEMWRITEOOB64:
765 {
766 struct mtd_oob_buf64 buf;
767 struct mtd_oob_buf64 __user *buf_user = argp;
768
769 if (copy_from_user(&buf, argp, sizeof(buf)))
770 ret = -EFAULT;
771 else
Artem Bityutskiy969e57a2011-12-23 17:27:46 +0200772 ret = mtdchar_writeoob(file, mtd, buf.start, buf.length,
Kevin Cernekeeaea7cea2009-04-08 22:53:49 -0700773 (void __user *)(uintptr_t)buf.usr_ptr,
774 &buf_user->length);
775 break;
776 }
777
778 case MEMREADOOB64:
779 {
780 struct mtd_oob_buf64 buf;
781 struct mtd_oob_buf64 __user *buf_user = argp;
782
783 if (copy_from_user(&buf, argp, sizeof(buf)))
784 ret = -EFAULT;
785 else
Artem Bityutskiy969e57a2011-12-23 17:27:46 +0200786 ret = mtdchar_readoob(file, mtd, buf.start, buf.length,
Kevin Cernekeeaea7cea2009-04-08 22:53:49 -0700787 (void __user *)(uintptr_t)buf.usr_ptr,
788 &buf_user->length);
789 break;
790 }
791
Brian Norrise99d8b02011-09-09 09:59:03 -0700792 case MEMWRITE:
793 {
Artem Bityutskiy969e57a2011-12-23 17:27:46 +0200794 ret = mtdchar_write_ioctl(mtd,
Brian Norrise99d8b02011-09-09 09:59:03 -0700795 (struct mtd_write_req __user *)arg);
796 break;
797 }
798
Linus Torvalds1da177e2005-04-16 15:20:36 -0700799 case MEMLOCK:
800 {
Harvey Harrison175428b2008-07-03 23:40:14 -0700801 struct erase_info_user einfo;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700802
Harvey Harrison175428b2008-07-03 23:40:14 -0700803 if (copy_from_user(&einfo, argp, sizeof(einfo)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700804 return -EFAULT;
805
Artem Bityutskiy38134562011-12-30 17:00:35 +0200806 ret = mtd_lock(mtd, einfo.start, einfo.length);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700807 break;
808 }
809
810 case MEMUNLOCK:
811 {
Harvey Harrison175428b2008-07-03 23:40:14 -0700812 struct erase_info_user einfo;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700813
Harvey Harrison175428b2008-07-03 23:40:14 -0700814 if (copy_from_user(&einfo, argp, sizeof(einfo)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700815 return -EFAULT;
816
Artem Bityutskiy38134562011-12-30 17:00:35 +0200817 ret = mtd_unlock(mtd, einfo.start, einfo.length);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700818 break;
819 }
820
Richard Cochran99384242010-06-14 18:10:33 +0200821 case MEMISLOCKED:
822 {
823 struct erase_info_user einfo;
824
825 if (copy_from_user(&einfo, argp, sizeof(einfo)))
826 return -EFAULT;
827
Artem Bityutskiy38134562011-12-30 17:00:35 +0200828 ret = mtd_is_locked(mtd, einfo.start, einfo.length);
Richard Cochran99384242010-06-14 18:10:33 +0200829 break;
830 }
831
Thomas Gleixner5bd34c02006-05-27 22:16:10 +0200832 /* Legacy interface */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700833 case MEMGETOOBSEL:
834 {
Thomas Gleixner5bd34c02006-05-27 22:16:10 +0200835 struct nand_oobinfo oi;
836
Boris Brezillonadbbc3b2016-02-03 19:01:31 +0100837 if (!mtd->ooblayout)
Thomas Gleixner5bd34c02006-05-27 22:16:10 +0200838 return -EOPNOTSUPP;
Thomas Gleixner5bd34c02006-05-27 22:16:10 +0200839
Boris Brezillonc2b78452016-02-03 20:10:30 +0100840 ret = get_oobinfo(mtd, &oi);
841 if (ret)
842 return ret;
Thomas Gleixner5bd34c02006-05-27 22:16:10 +0200843
844 if (copy_to_user(argp, &oi, sizeof(struct nand_oobinfo)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700845 return -EFAULT;
846 break;
847 }
848
849 case MEMGETBADBLOCK:
850 {
851 loff_t offs;
Thomas Gleixner97894cd2005-11-07 11:15:26 +0000852
Linus Torvalds1da177e2005-04-16 15:20:36 -0700853 if (copy_from_user(&offs, argp, sizeof(loff_t)))
854 return -EFAULT;
Artem Bityutskiy8f461a72012-01-02 13:48:54 +0200855 return mtd_block_isbad(mtd, offs);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700856 break;
857 }
858
859 case MEMSETBADBLOCK:
860 {
861 loff_t offs;
862
863 if (copy_from_user(&offs, argp, sizeof(loff_t)))
864 return -EFAULT;
Artem Bityutskiy800ffd32012-01-02 13:59:12 +0200865 return mtd_block_markbad(mtd, offs);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700866 break;
867 }
868
Nicolas Pitre31f42332005-02-08 17:45:55 +0000869 case OTPSELECT:
870 {
871 int mode;
872 if (copy_from_user(&mode, argp, sizeof(int)))
873 return -EFAULT;
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200874
Brian Norrisbeb133f2011-08-30 18:45:41 -0700875 mfi->mode = MTD_FILE_MODE_NORMAL;
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200876
877 ret = otp_select_filemode(mfi, mode);
878
Nicolas Pitre81dba482005-04-01 16:36:15 +0100879 file->f_pos = 0;
Nicolas Pitre31f42332005-02-08 17:45:55 +0000880 break;
881 }
882
883 case OTPGETREGIONCOUNT:
884 case OTPGETREGIONINFO:
885 {
886 struct otp_info *buf = kmalloc(4096, GFP_KERNEL);
Christian Riesch4b78fc42014-01-28 09:29:44 +0100887 size_t retlen;
Nicolas Pitre31f42332005-02-08 17:45:55 +0000888 if (!buf)
889 return -ENOMEM;
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200890 switch (mfi->mode) {
Brian Norrisbeb133f2011-08-30 18:45:41 -0700891 case MTD_FILE_MODE_OTP_FACTORY:
Christian Riesch4b78fc42014-01-28 09:29:44 +0100892 ret = mtd_get_fact_prot_info(mtd, 4096, &retlen, buf);
Nicolas Pitre31f42332005-02-08 17:45:55 +0000893 break;
Brian Norrisbeb133f2011-08-30 18:45:41 -0700894 case MTD_FILE_MODE_OTP_USER:
Christian Riesch4b78fc42014-01-28 09:29:44 +0100895 ret = mtd_get_user_prot_info(mtd, 4096, &retlen, buf);
Nicolas Pitre31f42332005-02-08 17:45:55 +0000896 break;
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200897 default:
Artem Bityutskiy87e858a92011-12-28 18:47:46 +0200898 ret = -EINVAL;
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200899 break;
Nicolas Pitre31f42332005-02-08 17:45:55 +0000900 }
Christian Riesch4b78fc42014-01-28 09:29:44 +0100901 if (!ret) {
Nicolas Pitre31f42332005-02-08 17:45:55 +0000902 if (cmd == OTPGETREGIONCOUNT) {
Christian Riesch4b78fc42014-01-28 09:29:44 +0100903 int nbr = retlen / sizeof(struct otp_info);
Nicolas Pitre31f42332005-02-08 17:45:55 +0000904 ret = copy_to_user(argp, &nbr, sizeof(int));
905 } else
Christian Riesch4b78fc42014-01-28 09:29:44 +0100906 ret = copy_to_user(argp, buf, retlen);
Nicolas Pitre31f42332005-02-08 17:45:55 +0000907 if (ret)
908 ret = -EFAULT;
909 }
910 kfree(buf);
911 break;
912 }
913
914 case OTPLOCK:
915 {
Harvey Harrison175428b2008-07-03 23:40:14 -0700916 struct otp_info oinfo;
Nicolas Pitre31f42332005-02-08 17:45:55 +0000917
Brian Norrisbeb133f2011-08-30 18:45:41 -0700918 if (mfi->mode != MTD_FILE_MODE_OTP_USER)
Nicolas Pitre31f42332005-02-08 17:45:55 +0000919 return -EINVAL;
Harvey Harrison175428b2008-07-03 23:40:14 -0700920 if (copy_from_user(&oinfo, argp, sizeof(oinfo)))
Nicolas Pitre31f42332005-02-08 17:45:55 +0000921 return -EFAULT;
Artem Bityutskiy4403dbfb2011-12-23 18:55:49 +0200922 ret = mtd_lock_user_prot_reg(mtd, oinfo.start, oinfo.length);
Nicolas Pitre31f42332005-02-08 17:45:55 +0000923 break;
924 }
Nicolas Pitre31f42332005-02-08 17:45:55 +0000925
Brian Norris7854d3f2011-06-23 14:12:08 -0700926 /* This ioctl is being deprecated - it truncates the ECC layout */
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200927 case ECCGETLAYOUT:
928 {
Brian Norriscc26c3c2010-08-24 18:12:00 -0700929 struct nand_ecclayout_user *usrlay;
930
Boris Brezillonadbbc3b2016-02-03 19:01:31 +0100931 if (!mtd->ooblayout)
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200932 return -EOPNOTSUPP;
933
Brian Norriscc26c3c2010-08-24 18:12:00 -0700934 usrlay = kmalloc(sizeof(*usrlay), GFP_KERNEL);
935 if (!usrlay)
936 return -ENOMEM;
937
Boris Brezillonc2b78452016-02-03 20:10:30 +0100938 shrink_ecclayout(mtd, usrlay);
Brian Norriscc26c3c2010-08-24 18:12:00 -0700939
940 if (copy_to_user(argp, usrlay, sizeof(*usrlay)))
941 ret = -EFAULT;
942 kfree(usrlay);
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200943 break;
944 }
945
946 case ECCGETSTATS:
947 {
948 if (copy_to_user(argp, &mtd->ecc_stats,
949 sizeof(struct mtd_ecc_stats)))
950 return -EFAULT;
951 break;
952 }
953
954 case MTDFILEMODE:
955 {
956 mfi->mode = 0;
957
958 switch(arg) {
Brian Norrisbeb133f2011-08-30 18:45:41 -0700959 case MTD_FILE_MODE_OTP_FACTORY:
960 case MTD_FILE_MODE_OTP_USER:
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200961 ret = otp_select_filemode(mfi, arg);
962 break;
963
Brian Norrisbeb133f2011-08-30 18:45:41 -0700964 case MTD_FILE_MODE_RAW:
Artem Bityutskiyfc002e32011-12-28 18:35:07 +0200965 if (!mtd_has_oob(mtd))
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200966 return -EOPNOTSUPP;
967 mfi->mode = arg;
968
Brian Norrisbeb133f2011-08-30 18:45:41 -0700969 case MTD_FILE_MODE_NORMAL:
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200970 break;
971 default:
972 ret = -EINVAL;
973 }
974 file->f_pos = 0;
975 break;
976 }
977
Roman Tereshonkovd0f79592010-09-17 13:31:42 +0300978 case BLKPG:
979 {
Brian Norris53bb7242015-09-21 13:26:59 -0700980 struct blkpg_ioctl_arg __user *blk_arg = argp;
981 struct blkpg_ioctl_arg a;
982
983 if (copy_from_user(&a, blk_arg, sizeof(a)))
984 ret = -EFAULT;
985 else
986 ret = mtdchar_blkpg_ioctl(mtd, &a);
Roman Tereshonkovd0f79592010-09-17 13:31:42 +0300987 break;
988 }
989
990 case BLKRRPART:
991 {
992 /* No reread partition feature. Just return ok */
993 ret = 0;
994 break;
995 }
Roman Tereshonkovd0f79592010-09-17 13:31:42 +0300996
Linus Torvalds1da177e2005-04-16 15:20:36 -0700997 default:
998 ret = -ENOTTY;
999 }
1000
1001 return ret;
1002} /* memory_ioctl */
1003
Artem Bityutskiy969e57a2011-12-23 17:27:46 +02001004static long mtdchar_unlocked_ioctl(struct file *file, u_int cmd, u_long arg)
Arnd Bergmann55929332010-04-27 00:24:05 +02001005{
1006 int ret;
1007
Arnd Bergmann5aa82942010-06-02 14:28:52 +02001008 mutex_lock(&mtd_mutex);
Artem Bityutskiy969e57a2011-12-23 17:27:46 +02001009 ret = mtdchar_ioctl(file, cmd, arg);
Arnd Bergmann5aa82942010-06-02 14:28:52 +02001010 mutex_unlock(&mtd_mutex);
Arnd Bergmann55929332010-04-27 00:24:05 +02001011
1012 return ret;
1013}
1014
Kevin Cernekee97718542009-04-08 22:53:13 -07001015#ifdef CONFIG_COMPAT
1016
1017struct mtd_oob_buf32 {
1018 u_int32_t start;
1019 u_int32_t length;
1020 compat_caddr_t ptr; /* unsigned char* */
1021};
1022
1023#define MEMWRITEOOB32 _IOWR('M', 3, struct mtd_oob_buf32)
1024#define MEMREADOOB32 _IOWR('M', 4, struct mtd_oob_buf32)
1025
Artem Bityutskiy969e57a2011-12-23 17:27:46 +02001026static long mtdchar_compat_ioctl(struct file *file, unsigned int cmd,
Kevin Cernekee97718542009-04-08 22:53:13 -07001027 unsigned long arg)
1028{
1029 struct mtd_file_info *mfi = file->private_data;
1030 struct mtd_info *mtd = mfi->mtd;
David Woodhouse0b6585c2009-05-29 16:09:08 +01001031 void __user *argp = compat_ptr(arg);
Kevin Cernekee97718542009-04-08 22:53:13 -07001032 int ret = 0;
1033
Arnd Bergmann5aa82942010-06-02 14:28:52 +02001034 mutex_lock(&mtd_mutex);
Kevin Cernekee97718542009-04-08 22:53:13 -07001035
1036 switch (cmd) {
1037 case MEMWRITEOOB32:
1038 {
1039 struct mtd_oob_buf32 buf;
1040 struct mtd_oob_buf32 __user *buf_user = argp;
1041
1042 if (copy_from_user(&buf, argp, sizeof(buf)))
1043 ret = -EFAULT;
1044 else
Artem Bityutskiy969e57a2011-12-23 17:27:46 +02001045 ret = mtdchar_writeoob(file, mtd, buf.start,
Kevin Cernekee97718542009-04-08 22:53:13 -07001046 buf.length, compat_ptr(buf.ptr),
1047 &buf_user->length);
1048 break;
1049 }
1050
1051 case MEMREADOOB32:
1052 {
1053 struct mtd_oob_buf32 buf;
1054 struct mtd_oob_buf32 __user *buf_user = argp;
1055
1056 /* NOTE: writes return length to buf->start */
1057 if (copy_from_user(&buf, argp, sizeof(buf)))
1058 ret = -EFAULT;
1059 else
Artem Bityutskiy969e57a2011-12-23 17:27:46 +02001060 ret = mtdchar_readoob(file, mtd, buf.start,
Kevin Cernekee97718542009-04-08 22:53:13 -07001061 buf.length, compat_ptr(buf.ptr),
1062 &buf_user->start);
1063 break;
1064 }
Brian Norris53bb7242015-09-21 13:26:59 -07001065
1066 case BLKPG:
1067 {
1068 /* Convert from blkpg_compat_ioctl_arg to blkpg_ioctl_arg */
1069 struct blkpg_compat_ioctl_arg __user *uarg = argp;
1070 struct blkpg_compat_ioctl_arg compat_arg;
1071 struct blkpg_ioctl_arg a;
1072
1073 if (copy_from_user(&compat_arg, uarg, sizeof(compat_arg))) {
1074 ret = -EFAULT;
1075 break;
1076 }
1077
1078 memset(&a, 0, sizeof(a));
1079 a.op = compat_arg.op;
1080 a.flags = compat_arg.flags;
1081 a.datalen = compat_arg.datalen;
1082 a.data = compat_ptr(compat_arg.data);
1083
1084 ret = mtdchar_blkpg_ioctl(mtd, &a);
1085 break;
1086 }
1087
Kevin Cernekee97718542009-04-08 22:53:13 -07001088 default:
Artem Bityutskiy969e57a2011-12-23 17:27:46 +02001089 ret = mtdchar_ioctl(file, cmd, (unsigned long)argp);
Kevin Cernekee97718542009-04-08 22:53:13 -07001090 }
1091
Arnd Bergmann5aa82942010-06-02 14:28:52 +02001092 mutex_unlock(&mtd_mutex);
Kevin Cernekee97718542009-04-08 22:53:13 -07001093
1094 return ret;
1095}
1096
1097#endif /* CONFIG_COMPAT */
1098
David Howells402d3262009-02-12 10:40:00 +00001099/*
1100 * try to determine where a shared mapping can be made
1101 * - only supported for NOMMU at the moment (MMU can't doesn't copy private
1102 * mappings)
1103 */
1104#ifndef CONFIG_MMU
Artem Bityutskiy969e57a2011-12-23 17:27:46 +02001105static unsigned long mtdchar_get_unmapped_area(struct file *file,
David Howells402d3262009-02-12 10:40:00 +00001106 unsigned long addr,
1107 unsigned long len,
1108 unsigned long pgoff,
1109 unsigned long flags)
1110{
1111 struct mtd_file_info *mfi = file->private_data;
1112 struct mtd_info *mtd = mfi->mtd;
Artem Bityutskiycd621272011-12-30 14:31:57 +02001113 unsigned long offset;
1114 int ret;
David Howells402d3262009-02-12 10:40:00 +00001115
Artem Bityutskiycd621272011-12-30 14:31:57 +02001116 if (addr != 0)
1117 return (unsigned long) -EINVAL;
David Howells402d3262009-02-12 10:40:00 +00001118
Artem Bityutskiycd621272011-12-30 14:31:57 +02001119 if (len > mtd->size || pgoff >= (mtd->size >> PAGE_SHIFT))
1120 return (unsigned long) -EINVAL;
David Howells402d3262009-02-12 10:40:00 +00001121
Artem Bityutskiycd621272011-12-30 14:31:57 +02001122 offset = pgoff << PAGE_SHIFT;
1123 if (offset > mtd->size - len)
1124 return (unsigned long) -EINVAL;
David Howells402d3262009-02-12 10:40:00 +00001125
Artem Bityutskiycd621272011-12-30 14:31:57 +02001126 ret = mtd_get_unmapped_area(mtd, len, offset, flags);
Vladimir Zapolskiyb9995932013-10-28 18:08:15 +02001127 return ret == -EOPNOTSUPP ? -ENODEV : ret;
David Howells402d3262009-02-12 10:40:00 +00001128}
Christoph Hellwigb4caecd2015-01-14 10:42:32 +01001129
1130static unsigned mtdchar_mmap_capabilities(struct file *file)
1131{
1132 struct mtd_file_info *mfi = file->private_data;
1133
1134 return mtd_mmap_capabilities(mfi->mtd);
1135}
David Howells402d3262009-02-12 10:40:00 +00001136#endif
1137
1138/*
1139 * set up a mapping for shared memory segments
1140 */
Artem Bityutskiy969e57a2011-12-23 17:27:46 +02001141static int mtdchar_mmap(struct file *file, struct vm_area_struct *vma)
David Howells402d3262009-02-12 10:40:00 +00001142{
1143#ifdef CONFIG_MMU
1144 struct mtd_file_info *mfi = file->private_data;
1145 struct mtd_info *mtd = mfi->mtd;
Anatolij Gustschindd02b672010-06-15 09:30:15 +02001146 struct map_info *map = mtd->priv;
David Howells402d3262009-02-12 10:40:00 +00001147
David Woodhousef5cf8f02012-10-09 15:08:10 +01001148 /* This is broken because it assumes the MTD device is map-based
1149 and that mtd->priv is a valid struct map_info. It should be
1150 replaced with something that uses the mtd_get_unmapped_area()
1151 operation properly. */
1152 if (0 /*mtd->type == MTD_RAM || mtd->type == MTD_ROM*/) {
Anatolij Gustschindd02b672010-06-15 09:30:15 +02001153#ifdef pgprot_noncached
Linus Torvalds8558e4a2013-04-19 09:53:07 -07001154 if (file->f_flags & O_DSYNC || map->phys >= __pa(high_memory))
Anatolij Gustschindd02b672010-06-15 09:30:15 +02001155 vma->vm_page_prot = pgprot_noncached(vma->vm_page_prot);
1156#endif
Linus Torvalds8558e4a2013-04-19 09:53:07 -07001157 return vm_iomap_memory(vma, map->phys, map->size);
Anatolij Gustschindd02b672010-06-15 09:30:15 +02001158 }
Vladimir Zapolskiyb9995932013-10-28 18:08:15 +02001159 return -ENODEV;
David Howells402d3262009-02-12 10:40:00 +00001160#else
Vladimir Zapolskiyb9995932013-10-28 18:08:15 +02001161 return vma->vm_flags & VM_SHARED ? 0 : -EACCES;
David Howells402d3262009-02-12 10:40:00 +00001162#endif
1163}
1164
Arjan van de Vend54b1fd2007-02-12 00:55:34 -08001165static const struct file_operations mtd_fops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001166 .owner = THIS_MODULE,
Artem Bityutskiy969e57a2011-12-23 17:27:46 +02001167 .llseek = mtdchar_lseek,
1168 .read = mtdchar_read,
1169 .write = mtdchar_write,
1170 .unlocked_ioctl = mtdchar_unlocked_ioctl,
Kevin Cernekee97718542009-04-08 22:53:13 -07001171#ifdef CONFIG_COMPAT
Artem Bityutskiy969e57a2011-12-23 17:27:46 +02001172 .compat_ioctl = mtdchar_compat_ioctl,
Kevin Cernekee97718542009-04-08 22:53:13 -07001173#endif
Artem Bityutskiy969e57a2011-12-23 17:27:46 +02001174 .open = mtdchar_open,
1175 .release = mtdchar_close,
1176 .mmap = mtdchar_mmap,
David Howells402d3262009-02-12 10:40:00 +00001177#ifndef CONFIG_MMU
Artem Bityutskiy969e57a2011-12-23 17:27:46 +02001178 .get_unmapped_area = mtdchar_get_unmapped_area,
Christoph Hellwigb4caecd2015-01-14 10:42:32 +01001179 .mmap_capabilities = mtdchar_mmap_capabilities,
David Howells402d3262009-02-12 10:40:00 +00001180#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07001181};
1182
Artem Bityutskiy660685d2013-03-14 13:27:40 +02001183int __init init_mtdchar(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001184{
Kirill A. Shutemovcd874232010-05-17 16:55:47 +03001185 int ret;
David Brownell1f24b5a2009-03-26 00:42:41 -07001186
Kirill A. Shutemovcd874232010-05-17 16:55:47 +03001187 ret = __register_chrdev(MTD_CHAR_MAJOR, 0, 1 << MINORBITS,
Ben Hutchingsdad0db32010-01-29 21:00:04 +00001188 "mtd", &mtd_fops);
Kirill A. Shutemovcd874232010-05-17 16:55:47 +03001189 if (ret < 0) {
Artem Bityutskiy57ae2b62013-03-15 12:59:36 +02001190 pr_err("Can't allocate major number %d for MTD\n",
1191 MTD_CHAR_MAJOR);
Kirill A. Shutemovcd874232010-05-17 16:55:47 +03001192 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001193 }
1194
Kirill A. Shutemovcd874232010-05-17 16:55:47 +03001195 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001196}
1197
Artem Bityutskiy660685d2013-03-14 13:27:40 +02001198void __exit cleanup_mtdchar(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001199{
Ben Hutchingsdad0db32010-01-29 21:00:04 +00001200 __unregister_chrdev(MTD_CHAR_MAJOR, 0, 1 << MINORBITS, "mtd");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001201}
1202
Scott James Remnant90160e12009-03-02 18:42:39 +00001203MODULE_ALIAS_CHARDEV_MAJOR(MTD_CHAR_MAJOR);