blob: 975aed94f06c12e7e8e948f3d90497690cbd1763 [file] [log] [blame]
Thomas Gleixnerfd534e92019-05-23 11:14:39 +02001// SPDX-License-Identifier: GPL-2.0-or-later
Linus Torvalds1da177e2005-04-16 15:20:36 -07002/*
David Woodhousea1452a32010-08-08 20:58:20 +01003 * Copyright © 1999-2010 David Woodhouse <dwmw2@infradead.org>
Linus Torvalds1da177e2005-04-16 15:20:36 -07004 */
5
Thomas Gleixner15fdc522005-11-07 00:14:42 +01006#include <linux/device.h>
7#include <linux/fs.h>
Andrew Morton0c1eafd2007-08-10 13:01:06 -07008#include <linux/mm.h>
Artem Bityutskiy9c740342006-10-11 14:52:47 +03009#include <linux/err.h>
Thomas Gleixner15fdc522005-11-07 00:14:42 +010010#include <linux/init.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070011#include <linux/kernel.h>
12#include <linux/module.h>
Thomas Gleixner15fdc522005-11-07 00:14:42 +010013#include <linux/slab.h>
14#include <linux/sched.h>
Arnd Bergmann5aa82942010-06-02 14:28:52 +020015#include <linux/mutex.h>
David Howells402d3262009-02-12 10:40:00 +000016#include <linux/backing-dev.h>
Kevin Cernekee97718542009-04-08 22:53:13 -070017#include <linux/compat.h>
Kirill A. Shutemovcd874232010-05-17 16:55:47 +030018#include <linux/mount.h>
Roman Tereshonkovd0f79592010-09-17 13:31:42 +030019#include <linux/blkpg.h>
Muthu Kumarb502bd12012-03-23 15:01:50 -070020#include <linux/magic.h>
Ezequiel Garciaf83c3832013-10-13 18:05:23 -030021#include <linux/major.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070022#include <linux/mtd/mtd.h>
Roman Tereshonkovd0f79592010-09-17 13:31:42 +030023#include <linux/mtd/partitions.h>
Anatolij Gustschindd02b672010-06-15 09:30:15 +020024#include <linux/mtd/map.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070025
Linus Torvalds7c0f6ba2016-12-24 11:46:01 -080026#include <linux/uaccess.h>
Todd Poynor9bc7b382005-06-30 01:23:27 +010027
Artem Bityutskiy660685d2013-03-14 13:27:40 +020028#include "mtdcore.h"
29
Arnd Bergmann5aa82942010-06-02 14:28:52 +020030static DEFINE_MUTEX(mtd_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -070031
Nicolas Pitre045e9a52005-02-08 19:12:53 +000032/*
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +020033 * Data structure to hold the pointer to the mtd device as well
Brian Norris92394b5c2011-07-20 09:53:42 -070034 * as mode information of various use cases.
Nicolas Pitre045e9a52005-02-08 19:12:53 +000035 */
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +020036struct mtd_file_info {
37 struct mtd_info *mtd;
38 enum mtd_file_modes mode;
39};
Nicolas Pitre31f42332005-02-08 17:45:55 +000040
Artem Bityutskiy969e57a2011-12-23 17:27:46 +020041static loff_t mtdchar_lseek(struct file *file, loff_t offset, int orig)
Linus Torvalds1da177e2005-04-16 15:20:36 -070042{
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +020043 struct mtd_file_info *mfi = file->private_data;
Al Virob9599572013-06-16 20:27:42 +040044 return fixed_size_llseek(file, offset, orig, mfi->mtd->size);
Linus Torvalds1da177e2005-04-16 15:20:36 -070045}
46
Artem Bityutskiy969e57a2011-12-23 17:27:46 +020047static int mtdchar_open(struct inode *inode, struct file *file)
Linus Torvalds1da177e2005-04-16 15:20:36 -070048{
49 int minor = iminor(inode);
50 int devnum = minor >> 1;
Jonathan Corbet60712392008-05-15 10:10:37 -060051 int ret = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -070052 struct mtd_info *mtd;
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +020053 struct mtd_file_info *mfi;
Linus Torvalds1da177e2005-04-16 15:20:36 -070054
Brian Norris289c0522011-07-19 10:06:09 -070055 pr_debug("MTD_open\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -070056
Linus Torvalds1da177e2005-04-16 15:20:36 -070057 /* You can't open the RO devices RW */
Al Viroaeb5d722008-09-02 15:28:45 -040058 if ((file->f_mode & FMODE_WRITE) && (minor & 1))
Linus Torvalds1da177e2005-04-16 15:20:36 -070059 return -EACCES;
60
Arnd Bergmann5aa82942010-06-02 14:28:52 +020061 mutex_lock(&mtd_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -070062 mtd = get_mtd_device(NULL, devnum);
Thomas Gleixner97894cd2005-11-07 11:15:26 +000063
Jonathan Corbet60712392008-05-15 10:10:37 -060064 if (IS_ERR(mtd)) {
65 ret = PTR_ERR(mtd);
66 goto out;
67 }
Thomas Gleixner97894cd2005-11-07 11:15:26 +000068
David Howells402d3262009-02-12 10:40:00 +000069 if (mtd->type == MTD_ABSENT) {
Jonathan Corbet60712392008-05-15 10:10:37 -060070 ret = -ENODEV;
Al Viroc65390f2012-04-09 01:36:28 -040071 goto out1;
Linus Torvalds1da177e2005-04-16 15:20:36 -070072 }
73
Linus Torvalds1da177e2005-04-16 15:20:36 -070074 /* You can't open it RW if it's not a writeable device */
Al Viroaeb5d722008-09-02 15:28:45 -040075 if ((file->f_mode & FMODE_WRITE) && !(mtd->flags & MTD_WRITEABLE)) {
Jonathan Corbet60712392008-05-15 10:10:37 -060076 ret = -EACCES;
Christoph Hellwigb4caecd2015-01-14 10:42:32 +010077 goto out1;
Linus Torvalds1da177e2005-04-16 15:20:36 -070078 }
Thomas Gleixner97894cd2005-11-07 11:15:26 +000079
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +020080 mfi = kzalloc(sizeof(*mfi), GFP_KERNEL);
81 if (!mfi) {
Jonathan Corbet60712392008-05-15 10:10:37 -060082 ret = -ENOMEM;
Christoph Hellwigb4caecd2015-01-14 10:42:32 +010083 goto out1;
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +020084 }
85 mfi->mtd = mtd;
86 file->private_data = mfi;
Al Viroc65390f2012-04-09 01:36:28 -040087 mutex_unlock(&mtd_mutex);
88 return 0;
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +020089
Al Viroc65390f2012-04-09 01:36:28 -040090out1:
91 put_mtd_device(mtd);
Jonathan Corbet60712392008-05-15 10:10:37 -060092out:
Arnd Bergmann5aa82942010-06-02 14:28:52 +020093 mutex_unlock(&mtd_mutex);
Jonathan Corbet60712392008-05-15 10:10:37 -060094 return ret;
Artem Bityutskiy969e57a2011-12-23 17:27:46 +020095} /* mtdchar_open */
Linus Torvalds1da177e2005-04-16 15:20:36 -070096
97/*====================================================================*/
98
Artem Bityutskiy969e57a2011-12-23 17:27:46 +020099static int mtdchar_close(struct inode *inode, struct file *file)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700100{
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200101 struct mtd_file_info *mfi = file->private_data;
102 struct mtd_info *mtd = mfi->mtd;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700103
Brian Norris289c0522011-07-19 10:06:09 -0700104 pr_debug("MTD_close\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700105
Joakim Tjernlund7eafaed2007-06-27 00:56:40 +0200106 /* Only sync if opened RW */
Artem Bityutskiy327cf292011-12-30 16:35:35 +0200107 if ((file->f_mode & FMODE_WRITE))
Artem Bityutskiy85f2f2a2011-12-23 19:03:12 +0200108 mtd_sync(mtd);
Thomas Gleixner97894cd2005-11-07 11:15:26 +0000109
Linus Torvalds1da177e2005-04-16 15:20:36 -0700110 put_mtd_device(mtd);
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200111 file->private_data = NULL;
112 kfree(mfi);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700113
114 return 0;
Artem Bityutskiy969e57a2011-12-23 17:27:46 +0200115} /* mtdchar_close */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700116
Grant Erickson3e45cf52011-04-08 08:51:33 -0700117/* Back in June 2001, dwmw2 wrote:
118 *
119 * FIXME: This _really_ needs to die. In 2.5, we should lock the
120 * userspace buffer down and use it directly with readv/writev.
121 *
122 * The implementation below, using mtd_kmalloc_up_to, mitigates
123 * allocation failures when the system is under low-memory situations
124 * or if memory is highly fragmented at the cost of reducing the
125 * performance of the requested transfer due to a smaller buffer size.
126 *
127 * A more complex but more memory-efficient implementation based on
128 * get_user_pages and iovecs to cover extents of those pages is a
129 * longer-term goal, as intimated by dwmw2 above. However, for the
130 * write case, this requires yet more complex head and tail transfer
131 * handling when those head and tail offsets and sizes are such that
132 * alignment requirements are not met in the NAND subdriver.
133 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700134
Artem Bityutskiy969e57a2011-12-23 17:27:46 +0200135static ssize_t mtdchar_read(struct file *file, char __user *buf, size_t count,
136 loff_t *ppos)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700137{
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200138 struct mtd_file_info *mfi = file->private_data;
139 struct mtd_info *mtd = mfi->mtd;
Artem Bityutskiy30fa9842011-12-29 15:16:28 +0200140 size_t retlen;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700141 size_t total_retlen=0;
142 int ret=0;
143 int len;
Grant Erickson3e45cf52011-04-08 08:51:33 -0700144 size_t size = count;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700145 char *kbuf;
Thomas Gleixner97894cd2005-11-07 11:15:26 +0000146
Brian Norris289c0522011-07-19 10:06:09 -0700147 pr_debug("MTD_read\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700148
Jann Horn6c6bc9e2018-07-07 05:37:22 +0200149 if (*ppos + count > mtd->size) {
150 if (*ppos < mtd->size)
151 count = mtd->size - *ppos;
152 else
153 count = 0;
154 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700155
156 if (!count)
157 return 0;
Thomas Gleixner97894cd2005-11-07 11:15:26 +0000158
Grant Erickson3e45cf52011-04-08 08:51:33 -0700159 kbuf = mtd_kmalloc_up_to(mtd, &size);
Thago Galesib802c072006-04-17 17:38:15 +0100160 if (!kbuf)
161 return -ENOMEM;
162
Linus Torvalds1da177e2005-04-16 15:20:36 -0700163 while (count) {
Grant Erickson3e45cf52011-04-08 08:51:33 -0700164 len = min_t(size_t, count, size);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700165
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200166 switch (mfi->mode) {
Brian Norrisbeb133f2011-08-30 18:45:41 -0700167 case MTD_FILE_MODE_OTP_FACTORY:
Artem Bityutskiyd264f722011-12-23 18:40:06 +0200168 ret = mtd_read_fact_prot_reg(mtd, *ppos, len,
169 &retlen, kbuf);
Nicolas Pitre31f42332005-02-08 17:45:55 +0000170 break;
Brian Norrisbeb133f2011-08-30 18:45:41 -0700171 case MTD_FILE_MODE_OTP_USER:
Artem Bityutskiy4ea1cab2011-12-23 18:47:59 +0200172 ret = mtd_read_user_prot_reg(mtd, *ppos, len,
173 &retlen, kbuf);
Nicolas Pitre31f42332005-02-08 17:45:55 +0000174 break;
Brian Norrisbeb133f2011-08-30 18:45:41 -0700175 case MTD_FILE_MODE_RAW:
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200176 {
177 struct mtd_oob_ops ops;
178
Brian Norris0612b9d2011-08-30 18:45:40 -0700179 ops.mode = MTD_OPS_RAW;
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200180 ops.datbuf = kbuf;
181 ops.oobbuf = NULL;
182 ops.len = len;
183
Artem Bityutskiyfd2819b2011-12-23 18:27:05 +0200184 ret = mtd_read_oob(mtd, *ppos, &ops);
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200185 retlen = ops.retlen;
186 break;
187 }
Nicolas Pitre31f42332005-02-08 17:45:55 +0000188 default:
Artem Bityutskiy329ad392011-12-23 17:30:16 +0200189 ret = mtd_read(mtd, *ppos, len, &retlen, kbuf);
Nicolas Pitre31f42332005-02-08 17:45:55 +0000190 }
Brian Norris7854d3f2011-06-23 14:12:08 -0700191 /* Nand returns -EBADMSG on ECC errors, but it returns
Linus Torvalds1da177e2005-04-16 15:20:36 -0700192 * the data. For our userspace tools it is important
Brian Norris7854d3f2011-06-23 14:12:08 -0700193 * to dump areas with ECC errors!
Thomas Gleixner9a1fcdf2006-05-29 14:56:39 +0200194 * For kernel internal usage it also might return -EUCLEAN
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300195 * to signal the caller that a bitflip has occurred and has
Thomas Gleixner9a1fcdf2006-05-29 14:56:39 +0200196 * been corrected by the ECC algorithm.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700197 * Userspace software which accesses NAND this way
198 * must be aware of the fact that it deals with NAND
199 */
Brian Norrisd57f40542011-09-20 18:34:25 -0700200 if (!ret || mtd_is_bitflip_or_eccerr(ret)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700201 *ppos += retlen;
202 if (copy_to_user(buf, kbuf, retlen)) {
Thomas Gleixnerf4a43cf2006-05-28 11:01:53 +0200203 kfree(kbuf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700204 return -EFAULT;
205 }
206 else
207 total_retlen += retlen;
208
209 count -= retlen;
210 buf += retlen;
Nicolas Pitre31f42332005-02-08 17:45:55 +0000211 if (retlen == 0)
212 count = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700213 }
214 else {
215 kfree(kbuf);
216 return ret;
217 }
Thomas Gleixner97894cd2005-11-07 11:15:26 +0000218
Linus Torvalds1da177e2005-04-16 15:20:36 -0700219 }
220
Thago Galesib802c072006-04-17 17:38:15 +0100221 kfree(kbuf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700222 return total_retlen;
Artem Bityutskiy969e57a2011-12-23 17:27:46 +0200223} /* mtdchar_read */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700224
Artem Bityutskiy969e57a2011-12-23 17:27:46 +0200225static ssize_t mtdchar_write(struct file *file, const char __user *buf, size_t count,
226 loff_t *ppos)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700227{
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200228 struct mtd_file_info *mfi = file->private_data;
229 struct mtd_info *mtd = mfi->mtd;
Grant Erickson3e45cf52011-04-08 08:51:33 -0700230 size_t size = count;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700231 char *kbuf;
232 size_t retlen;
233 size_t total_retlen=0;
234 int ret=0;
235 int len;
236
Brian Norris289c0522011-07-19 10:06:09 -0700237 pr_debug("MTD_write\n");
Thomas Gleixner97894cd2005-11-07 11:15:26 +0000238
Jann Horn6c6bc9e2018-07-07 05:37:22 +0200239 if (*ppos >= mtd->size)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700240 return -ENOSPC;
Thomas Gleixner97894cd2005-11-07 11:15:26 +0000241
Linus Torvalds1da177e2005-04-16 15:20:36 -0700242 if (*ppos + count > mtd->size)
243 count = mtd->size - *ppos;
244
245 if (!count)
246 return 0;
247
Grant Erickson3e45cf52011-04-08 08:51:33 -0700248 kbuf = mtd_kmalloc_up_to(mtd, &size);
Thago Galesib802c072006-04-17 17:38:15 +0100249 if (!kbuf)
250 return -ENOMEM;
251
Linus Torvalds1da177e2005-04-16 15:20:36 -0700252 while (count) {
Grant Erickson3e45cf52011-04-08 08:51:33 -0700253 len = min_t(size_t, count, size);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700254
Linus Torvalds1da177e2005-04-16 15:20:36 -0700255 if (copy_from_user(kbuf, buf, len)) {
256 kfree(kbuf);
257 return -EFAULT;
258 }
Thomas Gleixner97894cd2005-11-07 11:15:26 +0000259
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200260 switch (mfi->mode) {
Brian Norrisbeb133f2011-08-30 18:45:41 -0700261 case MTD_FILE_MODE_OTP_FACTORY:
Nicolas Pitre31f42332005-02-08 17:45:55 +0000262 ret = -EROFS;
263 break;
Brian Norrisbeb133f2011-08-30 18:45:41 -0700264 case MTD_FILE_MODE_OTP_USER:
Artem Bityutskiy482b43a2011-12-23 18:50:04 +0200265 ret = mtd_write_user_prot_reg(mtd, *ppos, len,
266 &retlen, kbuf);
Nicolas Pitre31f42332005-02-08 17:45:55 +0000267 break;
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200268
Brian Norrisbeb133f2011-08-30 18:45:41 -0700269 case MTD_FILE_MODE_RAW:
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200270 {
271 struct mtd_oob_ops ops;
272
Brian Norris0612b9d2011-08-30 18:45:40 -0700273 ops.mode = MTD_OPS_RAW;
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200274 ops.datbuf = kbuf;
275 ops.oobbuf = NULL;
Peter Wippichbf514082011-06-06 15:50:58 +0200276 ops.ooboffs = 0;
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200277 ops.len = len;
278
Artem Bityutskiya2cc5ba2011-12-23 18:29:55 +0200279 ret = mtd_write_oob(mtd, *ppos, &ops);
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200280 retlen = ops.retlen;
281 break;
282 }
283
Nicolas Pitre31f42332005-02-08 17:45:55 +0000284 default:
Artem Bityutskiyeda95cb2011-12-23 17:35:41 +0200285 ret = mtd_write(mtd, *ppos, len, &retlen, kbuf);
Nicolas Pitre31f42332005-02-08 17:45:55 +0000286 }
Christian Riesch9a78bc82014-03-06 12:42:37 +0100287
288 /*
289 * Return -ENOSPC only if no data could be written at all.
290 * Otherwise just return the number of bytes that actually
291 * have been written.
292 */
293 if ((ret == -ENOSPC) && (total_retlen))
294 break;
295
Linus Torvalds1da177e2005-04-16 15:20:36 -0700296 if (!ret) {
297 *ppos += retlen;
298 total_retlen += retlen;
299 count -= retlen;
300 buf += retlen;
301 }
302 else {
303 kfree(kbuf);
304 return ret;
305 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700306 }
307
Thago Galesib802c072006-04-17 17:38:15 +0100308 kfree(kbuf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700309 return total_retlen;
Artem Bityutskiy969e57a2011-12-23 17:27:46 +0200310} /* mtdchar_write */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700311
312/*======================================================================
313
314 IOCTL calls for getting device parameters.
315
316======================================================================*/
Linus Torvalds1da177e2005-04-16 15:20:36 -0700317
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200318static int otp_select_filemode(struct mtd_file_info *mfi, int mode)
319{
320 struct mtd_info *mtd = mfi->mtd;
Artem Bityutskiyb6de3d62011-12-29 10:06:32 +0200321 size_t retlen;
Artem Bityutskiyb6de3d62011-12-29 10:06:32 +0200322
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200323 switch (mode) {
324 case MTD_OTP_FACTORY:
Uwe Kleine-König5dc63fa2013-03-04 17:35:24 +0100325 if (mtd_read_fact_prot_reg(mtd, -1, 0, &retlen, NULL) ==
326 -EOPNOTSUPP)
327 return -EOPNOTSUPP;
328
Artem Bityutskiyb6de3d62011-12-29 10:06:32 +0200329 mfi->mode = MTD_FILE_MODE_OTP_FACTORY;
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200330 break;
331 case MTD_OTP_USER:
Uwe Kleine-König5dc63fa2013-03-04 17:35:24 +0100332 if (mtd_read_user_prot_reg(mtd, -1, 0, &retlen, NULL) ==
333 -EOPNOTSUPP)
334 return -EOPNOTSUPP;
335
Artem Bityutskiyb6de3d62011-12-29 10:06:32 +0200336 mfi->mode = MTD_FILE_MODE_OTP_USER;
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200337 break;
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200338 case MTD_OTP_OFF:
Uwe Kleine-König5dc63fa2013-03-04 17:35:24 +0100339 mfi->mode = MTD_FILE_MODE_NORMAL;
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200340 break;
Uwe Kleine-König5dc63fa2013-03-04 17:35:24 +0100341 default:
342 return -EINVAL;
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200343 }
Uwe Kleine-König5dc63fa2013-03-04 17:35:24 +0100344
345 return 0;
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200346}
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200347
Artem Bityutskiy969e57a2011-12-23 17:27:46 +0200348static int mtdchar_writeoob(struct file *file, struct mtd_info *mtd,
Kevin Cernekee97718542009-04-08 22:53:13 -0700349 uint64_t start, uint32_t length, void __user *ptr,
350 uint32_t __user *retp)
351{
Brian Norris9ce244b2011-08-30 18:45:37 -0700352 struct mtd_file_info *mfi = file->private_data;
Kevin Cernekee97718542009-04-08 22:53:13 -0700353 struct mtd_oob_ops ops;
354 uint32_t retlen;
355 int ret = 0;
356
357 if (!(file->f_mode & FMODE_WRITE))
358 return -EPERM;
359
360 if (length > 4096)
361 return -EINVAL;
362
Artem Bityutskiy3c3c10b2012-01-30 14:58:32 +0200363 if (!mtd->_write_oob)
Al Viro0db188f2017-09-29 13:55:19 -0400364 return -EOPNOTSUPP;
Kevin Cernekee97718542009-04-08 22:53:13 -0700365
366 ops.ooblen = length;
Brian Norris305b93f2011-08-23 17:17:32 -0700367 ops.ooboffs = start & (mtd->writesize - 1);
Kevin Cernekee97718542009-04-08 22:53:13 -0700368 ops.datbuf = NULL;
Brian Norrisbeb133f2011-08-30 18:45:41 -0700369 ops.mode = (mfi->mode == MTD_FILE_MODE_RAW) ? MTD_OPS_RAW :
Brian Norris0612b9d2011-08-30 18:45:40 -0700370 MTD_OPS_PLACE_OOB;
Kevin Cernekee97718542009-04-08 22:53:13 -0700371
372 if (ops.ooboffs && ops.ooblen > (mtd->oobsize - ops.ooboffs))
373 return -EINVAL;
374
Julia Lawalldf1f1d12010-05-22 10:22:49 +0200375 ops.oobbuf = memdup_user(ptr, length);
376 if (IS_ERR(ops.oobbuf))
377 return PTR_ERR(ops.oobbuf);
Kevin Cernekee97718542009-04-08 22:53:13 -0700378
Brian Norris305b93f2011-08-23 17:17:32 -0700379 start &= ~((uint64_t)mtd->writesize - 1);
Artem Bityutskiya2cc5ba2011-12-23 18:29:55 +0200380 ret = mtd_write_oob(mtd, start, &ops);
Kevin Cernekee97718542009-04-08 22:53:13 -0700381
382 if (ops.oobretlen > 0xFFFFFFFFU)
383 ret = -EOVERFLOW;
384 retlen = ops.oobretlen;
385 if (copy_to_user(retp, &retlen, sizeof(length)))
386 ret = -EFAULT;
387
388 kfree(ops.oobbuf);
389 return ret;
390}
391
Artem Bityutskiy969e57a2011-12-23 17:27:46 +0200392static int mtdchar_readoob(struct file *file, struct mtd_info *mtd,
Brian Norrisc46f6482011-08-30 18:45:38 -0700393 uint64_t start, uint32_t length, void __user *ptr,
394 uint32_t __user *retp)
Kevin Cernekee97718542009-04-08 22:53:13 -0700395{
Brian Norrisc46f6482011-08-30 18:45:38 -0700396 struct mtd_file_info *mfi = file->private_data;
Kevin Cernekee97718542009-04-08 22:53:13 -0700397 struct mtd_oob_ops ops;
398 int ret = 0;
399
400 if (length > 4096)
401 return -EINVAL;
402
Kevin Cernekee97718542009-04-08 22:53:13 -0700403 ops.ooblen = length;
Brian Norris305b93f2011-08-23 17:17:32 -0700404 ops.ooboffs = start & (mtd->writesize - 1);
Kevin Cernekee97718542009-04-08 22:53:13 -0700405 ops.datbuf = NULL;
Brian Norrisbeb133f2011-08-30 18:45:41 -0700406 ops.mode = (mfi->mode == MTD_FILE_MODE_RAW) ? MTD_OPS_RAW :
Brian Norris0612b9d2011-08-30 18:45:40 -0700407 MTD_OPS_PLACE_OOB;
Kevin Cernekee97718542009-04-08 22:53:13 -0700408
409 if (ops.ooboffs && ops.ooblen > (mtd->oobsize - ops.ooboffs))
410 return -EINVAL;
411
412 ops.oobbuf = kmalloc(length, GFP_KERNEL);
413 if (!ops.oobbuf)
414 return -ENOMEM;
415
Brian Norris305b93f2011-08-23 17:17:32 -0700416 start &= ~((uint64_t)mtd->writesize - 1);
Artem Bityutskiyfd2819b2011-12-23 18:27:05 +0200417 ret = mtd_read_oob(mtd, start, &ops);
Kevin Cernekee97718542009-04-08 22:53:13 -0700418
419 if (put_user(ops.oobretlen, retp))
420 ret = -EFAULT;
421 else if (ops.oobretlen && copy_to_user(ptr, ops.oobbuf,
422 ops.oobretlen))
423 ret = -EFAULT;
424
425 kfree(ops.oobbuf);
Brian Norris041e4572011-06-23 16:45:24 -0700426
427 /*
428 * NAND returns -EBADMSG on ECC errors, but it returns the OOB
429 * data. For our userspace tools it is important to dump areas
430 * with ECC errors!
431 * For kernel internal usage it also might return -EUCLEAN
Nobuhiro Iwamatsu5d708ec2017-01-27 10:36:38 +0900432 * to signal the caller that a bitflip has occurred and has
Brian Norris041e4572011-06-23 16:45:24 -0700433 * been corrected by the ECC algorithm.
434 *
Brian Norrisc478d7e2011-06-28 16:29:00 -0700435 * Note: currently the standard NAND function, nand_read_oob_std,
436 * does not calculate ECC for the OOB area, so do not rely on
437 * this behavior unless you have replaced it with your own.
Brian Norris041e4572011-06-23 16:45:24 -0700438 */
Brian Norrisd57f40542011-09-20 18:34:25 -0700439 if (mtd_is_bitflip_or_eccerr(ret))
Brian Norris041e4572011-06-23 16:45:24 -0700440 return 0;
441
Kevin Cernekee97718542009-04-08 22:53:13 -0700442 return ret;
443}
444
Brian Norriscc26c3c2010-08-24 18:12:00 -0700445/*
Boris Brezillonaab616e2016-02-04 10:16:18 +0100446 * Copies (and truncates, if necessary) OOB layout information to the
447 * deprecated layout struct, nand_ecclayout_user. This is necessary only to
448 * support the deprecated API ioctl ECCGETLAYOUT while allowing all new
449 * functionality to use mtd_ooblayout_ops flexibly (i.e. mtd_ooblayout_ops
450 * can describe any kind of OOB layout with almost zero overhead from a
451 * memory usage point of view).
Brian Norriscc26c3c2010-08-24 18:12:00 -0700452 */
Boris Brezillonc2b78452016-02-03 20:10:30 +0100453static int shrink_ecclayout(struct mtd_info *mtd,
454 struct nand_ecclayout_user *to)
Brian Norriscc26c3c2010-08-24 18:12:00 -0700455{
Boris Brezillonc2b78452016-02-03 20:10:30 +0100456 struct mtd_oob_region oobregion;
457 int i, section = 0, ret;
Brian Norriscc26c3c2010-08-24 18:12:00 -0700458
Boris Brezillonc2b78452016-02-03 20:10:30 +0100459 if (!mtd || !to)
Brian Norriscc26c3c2010-08-24 18:12:00 -0700460 return -EINVAL;
461
462 memset(to, 0, sizeof(*to));
463
Boris Brezillonc2b78452016-02-03 20:10:30 +0100464 to->eccbytes = 0;
465 for (i = 0; i < MTD_MAX_ECCPOS_ENTRIES;) {
466 u32 eccpos;
467
OuYang ZhiZhong6de56492018-03-11 15:59:07 +0800468 ret = mtd_ooblayout_ecc(mtd, section++, &oobregion);
Boris Brezillonc2b78452016-02-03 20:10:30 +0100469 if (ret < 0) {
470 if (ret != -ERANGE)
471 return ret;
472
473 break;
474 }
475
476 eccpos = oobregion.offset;
477 for (; i < MTD_MAX_ECCPOS_ENTRIES &&
478 eccpos < oobregion.offset + oobregion.length; i++) {
479 to->eccpos[i] = eccpos++;
480 to->eccbytes++;
481 }
482 }
Brian Norriscc26c3c2010-08-24 18:12:00 -0700483
484 for (i = 0; i < MTD_MAX_OOBFREE_ENTRIES; i++) {
Boris Brezillonc2b78452016-02-03 20:10:30 +0100485 ret = mtd_ooblayout_free(mtd, i, &oobregion);
486 if (ret < 0) {
487 if (ret != -ERANGE)
488 return ret;
489
Brian Norriscc26c3c2010-08-24 18:12:00 -0700490 break;
Boris Brezillonc2b78452016-02-03 20:10:30 +0100491 }
492
493 to->oobfree[i].offset = oobregion.offset;
494 to->oobfree[i].length = oobregion.length;
495 to->oobavail += to->oobfree[i].length;
Brian Norriscc26c3c2010-08-24 18:12:00 -0700496 }
497
498 return 0;
499}
500
Boris Brezillonc2b78452016-02-03 20:10:30 +0100501static int get_oobinfo(struct mtd_info *mtd, struct nand_oobinfo *to)
502{
503 struct mtd_oob_region oobregion;
504 int i, section = 0, ret;
505
506 if (!mtd || !to)
507 return -EINVAL;
508
509 memset(to, 0, sizeof(*to));
510
511 to->eccbytes = 0;
512 for (i = 0; i < ARRAY_SIZE(to->eccpos);) {
513 u32 eccpos;
514
OuYang ZhiZhong6de56492018-03-11 15:59:07 +0800515 ret = mtd_ooblayout_ecc(mtd, section++, &oobregion);
Boris Brezillonc2b78452016-02-03 20:10:30 +0100516 if (ret < 0) {
517 if (ret != -ERANGE)
518 return ret;
519
520 break;
521 }
522
523 if (oobregion.length + i > ARRAY_SIZE(to->eccpos))
524 return -EINVAL;
525
526 eccpos = oobregion.offset;
527 for (; eccpos < oobregion.offset + oobregion.length; i++) {
528 to->eccpos[i] = eccpos++;
529 to->eccbytes++;
530 }
531 }
532
533 for (i = 0; i < 8; i++) {
534 ret = mtd_ooblayout_free(mtd, i, &oobregion);
535 if (ret < 0) {
536 if (ret != -ERANGE)
537 return ret;
538
539 break;
540 }
541
542 to->oobfree[i][0] = oobregion.offset;
543 to->oobfree[i][1] = oobregion.length;
544 }
545
546 to->useecc = MTD_NANDECC_AUTOPLACE;
547
548 return 0;
549}
550
Artem Bityutskiy969e57a2011-12-23 17:27:46 +0200551static int mtdchar_blkpg_ioctl(struct mtd_info *mtd,
Brian Norris53bb7242015-09-21 13:26:59 -0700552 struct blkpg_ioctl_arg *arg)
Roman Tereshonkovd0f79592010-09-17 13:31:42 +0300553{
Roman Tereshonkovd0f79592010-09-17 13:31:42 +0300554 struct blkpg_partition p;
555
556 if (!capable(CAP_SYS_ADMIN))
557 return -EPERM;
558
Brian Norris53bb7242015-09-21 13:26:59 -0700559 if (copy_from_user(&p, arg->data, sizeof(p)))
Roman Tereshonkovd0f79592010-09-17 13:31:42 +0300560 return -EFAULT;
561
Brian Norris53bb7242015-09-21 13:26:59 -0700562 switch (arg->op) {
Roman Tereshonkovd0f79592010-09-17 13:31:42 +0300563 case BLKPG_ADD_PARTITION:
564
Roman Tereshonkova7e93dc2010-11-23 14:17:17 +0200565 /* Only master mtd device must be used to add partitions */
566 if (mtd_is_partition(mtd))
567 return -EINVAL;
568
Brian Norris1cc8d842014-07-21 19:08:13 -0700569 /* Sanitize user input */
570 p.devname[BLKPG_DEVNAMELTH - 1] = '\0';
571
Roman Tereshonkovd0f79592010-09-17 13:31:42 +0300572 return mtd_add_partition(mtd, p.devname, p.start, p.length);
573
574 case BLKPG_DEL_PARTITION:
575
576 if (p.pno < 0)
577 return -EINVAL;
578
579 return mtd_del_partition(mtd, p.pno);
580
581 default:
582 return -EINVAL;
583 }
584}
Roman Tereshonkovd0f79592010-09-17 13:31:42 +0300585
Artem Bityutskiy969e57a2011-12-23 17:27:46 +0200586static int mtdchar_write_ioctl(struct mtd_info *mtd,
Brian Norrise99d8b02011-09-09 09:59:03 -0700587 struct mtd_write_req __user *argp)
588{
589 struct mtd_write_req req;
590 struct mtd_oob_ops ops;
Geert Uytterhoevenf62cde42014-05-01 20:40:54 +0200591 const void __user *usr_data, *usr_oob;
Brian Norrise99d8b02011-09-09 09:59:03 -0700592 int ret;
593
Geert Uytterhoevenf62cde42014-05-01 20:40:54 +0200594 if (copy_from_user(&req, argp, sizeof(req)))
Brian Norrise99d8b02011-09-09 09:59:03 -0700595 return -EFAULT;
Geert Uytterhoevenf62cde42014-05-01 20:40:54 +0200596
597 usr_data = (const void __user *)(uintptr_t)req.usr_data;
598 usr_oob = (const void __user *)(uintptr_t)req.usr_oob;
Geert Uytterhoevenf62cde42014-05-01 20:40:54 +0200599
Artem Bityutskiy3c3c10b2012-01-30 14:58:32 +0200600 if (!mtd->_write_oob)
Brian Norrise99d8b02011-09-09 09:59:03 -0700601 return -EOPNOTSUPP;
602
603 ops.mode = req.mode;
604 ops.len = (size_t)req.len;
605 ops.ooblen = (size_t)req.ooblen;
606 ops.ooboffs = 0;
607
Geert Uytterhoevenf62cde42014-05-01 20:40:54 +0200608 if (usr_data) {
Brian Norrise99d8b02011-09-09 09:59:03 -0700609 ops.datbuf = memdup_user(usr_data, ops.len);
610 if (IS_ERR(ops.datbuf))
611 return PTR_ERR(ops.datbuf);
612 } else {
613 ops.datbuf = NULL;
614 }
615
Geert Uytterhoevenf62cde42014-05-01 20:40:54 +0200616 if (usr_oob) {
Brian Norrise99d8b02011-09-09 09:59:03 -0700617 ops.oobbuf = memdup_user(usr_oob, ops.ooblen);
618 if (IS_ERR(ops.oobbuf)) {
619 kfree(ops.datbuf);
620 return PTR_ERR(ops.oobbuf);
621 }
622 } else {
623 ops.oobbuf = NULL;
624 }
625
Artem Bityutskiya2cc5ba2011-12-23 18:29:55 +0200626 ret = mtd_write_oob(mtd, (loff_t)req.start, &ops);
Brian Norrise99d8b02011-09-09 09:59:03 -0700627
628 kfree(ops.datbuf);
629 kfree(ops.oobbuf);
630
631 return ret;
632}
633
Artem Bityutskiy969e57a2011-12-23 17:27:46 +0200634static int mtdchar_ioctl(struct file *file, u_int cmd, u_long arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700635{
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200636 struct mtd_file_info *mfi = file->private_data;
637 struct mtd_info *mtd = mfi->mtd;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700638 void __user *argp = (void __user *)arg;
639 int ret = 0;
Joern Engel73c619e2006-05-30 14:25:35 +0200640 struct mtd_info_user info;
Thomas Gleixner97894cd2005-11-07 11:15:26 +0000641
Brian Norris289c0522011-07-19 10:06:09 -0700642 pr_debug("MTD_ioctl\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700643
Linus Torvalds1da177e2005-04-16 15:20:36 -0700644 switch (cmd) {
645 case MEMGETREGIONCOUNT:
646 if (copy_to_user(argp, &(mtd->numeraseregions), sizeof(int)))
647 return -EFAULT;
648 break;
649
650 case MEMGETREGIONINFO:
651 {
Zev Weissb67c5f82008-09-01 05:02:12 -0700652 uint32_t ur_idx;
653 struct mtd_erase_region_info *kr;
H Hartley Sweetenbcc98a42010-01-15 11:25:38 -0700654 struct region_info_user __user *ur = argp;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700655
Zev Weissb67c5f82008-09-01 05:02:12 -0700656 if (get_user(ur_idx, &(ur->regionindex)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700657 return -EFAULT;
658
Dan Carpenter5e59be12010-09-08 21:39:56 +0200659 if (ur_idx >= mtd->numeraseregions)
660 return -EINVAL;
661
Zev Weissb67c5f82008-09-01 05:02:12 -0700662 kr = &(mtd->eraseregions[ur_idx]);
663
664 if (put_user(kr->offset, &(ur->offset))
665 || put_user(kr->erasesize, &(ur->erasesize))
666 || put_user(kr->numblocks, &(ur->numblocks)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700667 return -EFAULT;
Zev Weissb67c5f82008-09-01 05:02:12 -0700668
Linus Torvalds1da177e2005-04-16 15:20:36 -0700669 break;
670 }
671
672 case MEMGETINFO:
Vasiliy Kulikova0c5a392010-11-06 17:41:24 +0300673 memset(&info, 0, sizeof(info));
Joern Engel73c619e2006-05-30 14:25:35 +0200674 info.type = mtd->type;
675 info.flags = mtd->flags;
676 info.size = mtd->size;
677 info.erasesize = mtd->erasesize;
678 info.writesize = mtd->writesize;
679 info.oobsize = mtd->oobsize;
Brian Norris19fb4342011-08-30 18:45:46 -0700680 /* The below field is obsolete */
681 info.padding = 0;
Joern Engel73c619e2006-05-30 14:25:35 +0200682 if (copy_to_user(argp, &info, sizeof(struct mtd_info_user)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700683 return -EFAULT;
684 break;
685
686 case MEMERASE:
Kevin Cernekee0dc54e92009-04-08 22:52:28 -0700687 case MEMERASE64:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700688 {
689 struct erase_info *erase;
690
Al Viroaeb5d722008-09-02 15:28:45 -0400691 if(!(file->f_mode & FMODE_WRITE))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700692 return -EPERM;
693
Burman Yan95b93a02006-11-15 21:10:29 +0200694 erase=kzalloc(sizeof(struct erase_info),GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700695 if (!erase)
696 ret = -ENOMEM;
697 else {
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 }
Thomas Gleixner97894cd2005-11-07 11:15:26 +0000719
Artem Bityutskiy7e1f0dc2011-12-23 15:25:39 +0200720 ret = mtd_erase(mtd, erase);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700721 kfree(erase);
722 }
723 break;
724 }
725
726 case MEMWRITEOOB:
727 {
728 struct mtd_oob_buf buf;
Kevin Cernekee97718542009-04-08 22:53:13 -0700729 struct mtd_oob_buf __user *buf_user = argp;
Thomas Gleixner97894cd2005-11-07 11:15:26 +0000730
Kevin Cernekee97718542009-04-08 22:53:13 -0700731 /* NOTE: writes return length to buf_user->length */
732 if (copy_from_user(&buf, argp, sizeof(buf)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700733 ret = -EFAULT;
Kevin Cernekee97718542009-04-08 22:53:13 -0700734 else
Artem Bityutskiy969e57a2011-12-23 17:27:46 +0200735 ret = mtdchar_writeoob(file, mtd, buf.start, buf.length,
Kevin Cernekee97718542009-04-08 22:53:13 -0700736 buf.ptr, &buf_user->length);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700737 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700738 }
739
740 case MEMREADOOB:
741 {
742 struct mtd_oob_buf buf;
Kevin Cernekee97718542009-04-08 22:53:13 -0700743 struct mtd_oob_buf __user *buf_user = argp;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700744
Kevin Cernekee97718542009-04-08 22:53:13 -0700745 /* NOTE: writes return length to buf_user->start */
746 if (copy_from_user(&buf, argp, sizeof(buf)))
747 ret = -EFAULT;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700748 else
Artem Bityutskiy969e57a2011-12-23 17:27:46 +0200749 ret = mtdchar_readoob(file, mtd, buf.start, buf.length,
Kevin Cernekee97718542009-04-08 22:53:13 -0700750 buf.ptr, &buf_user->start);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700751 break;
752 }
753
Kevin Cernekeeaea7cea2009-04-08 22:53:49 -0700754 case MEMWRITEOOB64:
755 {
756 struct mtd_oob_buf64 buf;
757 struct mtd_oob_buf64 __user *buf_user = argp;
758
759 if (copy_from_user(&buf, argp, sizeof(buf)))
760 ret = -EFAULT;
761 else
Artem Bityutskiy969e57a2011-12-23 17:27:46 +0200762 ret = mtdchar_writeoob(file, mtd, buf.start, buf.length,
Kevin Cernekeeaea7cea2009-04-08 22:53:49 -0700763 (void __user *)(uintptr_t)buf.usr_ptr,
764 &buf_user->length);
765 break;
766 }
767
768 case MEMREADOOB64:
769 {
770 struct mtd_oob_buf64 buf;
771 struct mtd_oob_buf64 __user *buf_user = argp;
772
773 if (copy_from_user(&buf, argp, sizeof(buf)))
774 ret = -EFAULT;
775 else
Artem Bityutskiy969e57a2011-12-23 17:27:46 +0200776 ret = mtdchar_readoob(file, mtd, buf.start, buf.length,
Kevin Cernekeeaea7cea2009-04-08 22:53:49 -0700777 (void __user *)(uintptr_t)buf.usr_ptr,
778 &buf_user->length);
779 break;
780 }
781
Brian Norrise99d8b02011-09-09 09:59:03 -0700782 case MEMWRITE:
783 {
Artem Bityutskiy969e57a2011-12-23 17:27:46 +0200784 ret = mtdchar_write_ioctl(mtd,
Brian Norrise99d8b02011-09-09 09:59:03 -0700785 (struct mtd_write_req __user *)arg);
786 break;
787 }
788
Linus Torvalds1da177e2005-04-16 15:20:36 -0700789 case MEMLOCK:
790 {
Harvey Harrison175428b2008-07-03 23:40:14 -0700791 struct erase_info_user einfo;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700792
Harvey Harrison175428b2008-07-03 23:40:14 -0700793 if (copy_from_user(&einfo, argp, sizeof(einfo)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700794 return -EFAULT;
795
Artem Bityutskiy38134562011-12-30 17:00:35 +0200796 ret = mtd_lock(mtd, einfo.start, einfo.length);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700797 break;
798 }
799
800 case MEMUNLOCK:
801 {
Harvey Harrison175428b2008-07-03 23:40:14 -0700802 struct erase_info_user einfo;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700803
Harvey Harrison175428b2008-07-03 23:40:14 -0700804 if (copy_from_user(&einfo, argp, sizeof(einfo)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700805 return -EFAULT;
806
Artem Bityutskiy38134562011-12-30 17:00:35 +0200807 ret = mtd_unlock(mtd, einfo.start, einfo.length);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700808 break;
809 }
810
Richard Cochran99384242010-06-14 18:10:33 +0200811 case MEMISLOCKED:
812 {
813 struct erase_info_user einfo;
814
815 if (copy_from_user(&einfo, argp, sizeof(einfo)))
816 return -EFAULT;
817
Artem Bityutskiy38134562011-12-30 17:00:35 +0200818 ret = mtd_is_locked(mtd, einfo.start, einfo.length);
Richard Cochran99384242010-06-14 18:10:33 +0200819 break;
820 }
821
Thomas Gleixner5bd34c02006-05-27 22:16:10 +0200822 /* Legacy interface */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700823 case MEMGETOOBSEL:
824 {
Thomas Gleixner5bd34c02006-05-27 22:16:10 +0200825 struct nand_oobinfo oi;
826
Boris Brezillonadbbc3b2016-02-03 19:01:31 +0100827 if (!mtd->ooblayout)
Thomas Gleixner5bd34c02006-05-27 22:16:10 +0200828 return -EOPNOTSUPP;
Thomas Gleixner5bd34c02006-05-27 22:16:10 +0200829
Boris Brezillonc2b78452016-02-03 20:10:30 +0100830 ret = get_oobinfo(mtd, &oi);
831 if (ret)
832 return ret;
Thomas Gleixner5bd34c02006-05-27 22:16:10 +0200833
834 if (copy_to_user(argp, &oi, sizeof(struct nand_oobinfo)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700835 return -EFAULT;
836 break;
837 }
838
839 case MEMGETBADBLOCK:
840 {
841 loff_t offs;
Thomas Gleixner97894cd2005-11-07 11:15:26 +0000842
Linus Torvalds1da177e2005-04-16 15:20:36 -0700843 if (copy_from_user(&offs, argp, sizeof(loff_t)))
844 return -EFAULT;
Artem Bityutskiy8f461a72012-01-02 13:48:54 +0200845 return mtd_block_isbad(mtd, offs);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700846 break;
847 }
848
849 case MEMSETBADBLOCK:
850 {
851 loff_t offs;
852
853 if (copy_from_user(&offs, argp, sizeof(loff_t)))
854 return -EFAULT;
Artem Bityutskiy800ffd32012-01-02 13:59:12 +0200855 return mtd_block_markbad(mtd, offs);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700856 break;
857 }
858
Nicolas Pitre31f42332005-02-08 17:45:55 +0000859 case OTPSELECT:
860 {
861 int mode;
862 if (copy_from_user(&mode, argp, sizeof(int)))
863 return -EFAULT;
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200864
Brian Norrisbeb133f2011-08-30 18:45:41 -0700865 mfi->mode = MTD_FILE_MODE_NORMAL;
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200866
867 ret = otp_select_filemode(mfi, mode);
868
Nicolas Pitre81dba482005-04-01 16:36:15 +0100869 file->f_pos = 0;
Nicolas Pitre31f42332005-02-08 17:45:55 +0000870 break;
871 }
872
873 case OTPGETREGIONCOUNT:
874 case OTPGETREGIONINFO:
875 {
876 struct otp_info *buf = kmalloc(4096, GFP_KERNEL);
Christian Riesch4b78fc42014-01-28 09:29:44 +0100877 size_t retlen;
Nicolas Pitre31f42332005-02-08 17:45:55 +0000878 if (!buf)
879 return -ENOMEM;
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200880 switch (mfi->mode) {
Brian Norrisbeb133f2011-08-30 18:45:41 -0700881 case MTD_FILE_MODE_OTP_FACTORY:
Christian Riesch4b78fc42014-01-28 09:29:44 +0100882 ret = mtd_get_fact_prot_info(mtd, 4096, &retlen, buf);
Nicolas Pitre31f42332005-02-08 17:45:55 +0000883 break;
Brian Norrisbeb133f2011-08-30 18:45:41 -0700884 case MTD_FILE_MODE_OTP_USER:
Christian Riesch4b78fc42014-01-28 09:29:44 +0100885 ret = mtd_get_user_prot_info(mtd, 4096, &retlen, buf);
Nicolas Pitre31f42332005-02-08 17:45:55 +0000886 break;
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200887 default:
Artem Bityutskiy87e858a92011-12-28 18:47:46 +0200888 ret = -EINVAL;
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200889 break;
Nicolas Pitre31f42332005-02-08 17:45:55 +0000890 }
Christian Riesch4b78fc42014-01-28 09:29:44 +0100891 if (!ret) {
Nicolas Pitre31f42332005-02-08 17:45:55 +0000892 if (cmd == OTPGETREGIONCOUNT) {
Christian Riesch4b78fc42014-01-28 09:29:44 +0100893 int nbr = retlen / sizeof(struct otp_info);
Nicolas Pitre31f42332005-02-08 17:45:55 +0000894 ret = copy_to_user(argp, &nbr, sizeof(int));
895 } else
Christian Riesch4b78fc42014-01-28 09:29:44 +0100896 ret = copy_to_user(argp, buf, retlen);
Nicolas Pitre31f42332005-02-08 17:45:55 +0000897 if (ret)
898 ret = -EFAULT;
899 }
900 kfree(buf);
901 break;
902 }
903
904 case OTPLOCK:
905 {
Harvey Harrison175428b2008-07-03 23:40:14 -0700906 struct otp_info oinfo;
Nicolas Pitre31f42332005-02-08 17:45:55 +0000907
Brian Norrisbeb133f2011-08-30 18:45:41 -0700908 if (mfi->mode != MTD_FILE_MODE_OTP_USER)
Nicolas Pitre31f42332005-02-08 17:45:55 +0000909 return -EINVAL;
Harvey Harrison175428b2008-07-03 23:40:14 -0700910 if (copy_from_user(&oinfo, argp, sizeof(oinfo)))
Nicolas Pitre31f42332005-02-08 17:45:55 +0000911 return -EFAULT;
Artem Bityutskiy4403dbfb2011-12-23 18:55:49 +0200912 ret = mtd_lock_user_prot_reg(mtd, oinfo.start, oinfo.length);
Nicolas Pitre31f42332005-02-08 17:45:55 +0000913 break;
914 }
Nicolas Pitre31f42332005-02-08 17:45:55 +0000915
Brian Norris7854d3f2011-06-23 14:12:08 -0700916 /* This ioctl is being deprecated - it truncates the ECC layout */
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200917 case ECCGETLAYOUT:
918 {
Brian Norriscc26c3c2010-08-24 18:12:00 -0700919 struct nand_ecclayout_user *usrlay;
920
Boris Brezillonadbbc3b2016-02-03 19:01:31 +0100921 if (!mtd->ooblayout)
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200922 return -EOPNOTSUPP;
923
Brian Norriscc26c3c2010-08-24 18:12:00 -0700924 usrlay = kmalloc(sizeof(*usrlay), GFP_KERNEL);
925 if (!usrlay)
926 return -ENOMEM;
927
Boris Brezillonc2b78452016-02-03 20:10:30 +0100928 shrink_ecclayout(mtd, usrlay);
Brian Norriscc26c3c2010-08-24 18:12:00 -0700929
930 if (copy_to_user(argp, usrlay, sizeof(*usrlay)))
931 ret = -EFAULT;
932 kfree(usrlay);
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200933 break;
934 }
935
936 case ECCGETSTATS:
937 {
938 if (copy_to_user(argp, &mtd->ecc_stats,
939 sizeof(struct mtd_ecc_stats)))
940 return -EFAULT;
941 break;
942 }
943
944 case MTDFILEMODE:
945 {
946 mfi->mode = 0;
947
948 switch(arg) {
Brian Norrisbeb133f2011-08-30 18:45:41 -0700949 case MTD_FILE_MODE_OTP_FACTORY:
950 case MTD_FILE_MODE_OTP_USER:
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200951 ret = otp_select_filemode(mfi, arg);
952 break;
953
Brian Norrisbeb133f2011-08-30 18:45:41 -0700954 case MTD_FILE_MODE_RAW:
Artem Bityutskiyfc002e32011-12-28 18:35:07 +0200955 if (!mtd_has_oob(mtd))
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200956 return -EOPNOTSUPP;
957 mfi->mode = arg;
958
Brian Norrisbeb133f2011-08-30 18:45:41 -0700959 case MTD_FILE_MODE_NORMAL:
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200960 break;
961 default:
962 ret = -EINVAL;
963 }
964 file->f_pos = 0;
965 break;
966 }
967
Roman Tereshonkovd0f79592010-09-17 13:31:42 +0300968 case BLKPG:
969 {
Brian Norris53bb7242015-09-21 13:26:59 -0700970 struct blkpg_ioctl_arg __user *blk_arg = argp;
971 struct blkpg_ioctl_arg a;
972
973 if (copy_from_user(&a, blk_arg, sizeof(a)))
974 ret = -EFAULT;
975 else
976 ret = mtdchar_blkpg_ioctl(mtd, &a);
Roman Tereshonkovd0f79592010-09-17 13:31:42 +0300977 break;
978 }
979
980 case BLKRRPART:
981 {
982 /* No reread partition feature. Just return ok */
983 ret = 0;
984 break;
985 }
Roman Tereshonkovd0f79592010-09-17 13:31:42 +0300986
Linus Torvalds1da177e2005-04-16 15:20:36 -0700987 default:
988 ret = -ENOTTY;
989 }
990
991 return ret;
992} /* memory_ioctl */
993
Artem Bityutskiy969e57a2011-12-23 17:27:46 +0200994static long mtdchar_unlocked_ioctl(struct file *file, u_int cmd, u_long arg)
Arnd Bergmann55929332010-04-27 00:24:05 +0200995{
996 int ret;
997
Arnd Bergmann5aa82942010-06-02 14:28:52 +0200998 mutex_lock(&mtd_mutex);
Artem Bityutskiy969e57a2011-12-23 17:27:46 +0200999 ret = mtdchar_ioctl(file, cmd, arg);
Arnd Bergmann5aa82942010-06-02 14:28:52 +02001000 mutex_unlock(&mtd_mutex);
Arnd Bergmann55929332010-04-27 00:24:05 +02001001
1002 return ret;
1003}
1004
Kevin Cernekee97718542009-04-08 22:53:13 -07001005#ifdef CONFIG_COMPAT
1006
1007struct mtd_oob_buf32 {
1008 u_int32_t start;
1009 u_int32_t length;
1010 compat_caddr_t ptr; /* unsigned char* */
1011};
1012
1013#define MEMWRITEOOB32 _IOWR('M', 3, struct mtd_oob_buf32)
1014#define MEMREADOOB32 _IOWR('M', 4, struct mtd_oob_buf32)
1015
Artem Bityutskiy969e57a2011-12-23 17:27:46 +02001016static long mtdchar_compat_ioctl(struct file *file, unsigned int cmd,
Kevin Cernekee97718542009-04-08 22:53:13 -07001017 unsigned long arg)
1018{
1019 struct mtd_file_info *mfi = file->private_data;
1020 struct mtd_info *mtd = mfi->mtd;
David Woodhouse0b6585c2009-05-29 16:09:08 +01001021 void __user *argp = compat_ptr(arg);
Kevin Cernekee97718542009-04-08 22:53:13 -07001022 int ret = 0;
1023
Arnd Bergmann5aa82942010-06-02 14:28:52 +02001024 mutex_lock(&mtd_mutex);
Kevin Cernekee97718542009-04-08 22:53:13 -07001025
1026 switch (cmd) {
1027 case MEMWRITEOOB32:
1028 {
1029 struct mtd_oob_buf32 buf;
1030 struct mtd_oob_buf32 __user *buf_user = argp;
1031
1032 if (copy_from_user(&buf, argp, sizeof(buf)))
1033 ret = -EFAULT;
1034 else
Artem Bityutskiy969e57a2011-12-23 17:27:46 +02001035 ret = mtdchar_writeoob(file, mtd, buf.start,
Kevin Cernekee97718542009-04-08 22:53:13 -07001036 buf.length, compat_ptr(buf.ptr),
1037 &buf_user->length);
1038 break;
1039 }
1040
1041 case MEMREADOOB32:
1042 {
1043 struct mtd_oob_buf32 buf;
1044 struct mtd_oob_buf32 __user *buf_user = argp;
1045
1046 /* NOTE: writes return length to buf->start */
1047 if (copy_from_user(&buf, argp, sizeof(buf)))
1048 ret = -EFAULT;
1049 else
Artem Bityutskiy969e57a2011-12-23 17:27:46 +02001050 ret = mtdchar_readoob(file, mtd, buf.start,
Kevin Cernekee97718542009-04-08 22:53:13 -07001051 buf.length, compat_ptr(buf.ptr),
1052 &buf_user->start);
1053 break;
1054 }
Brian Norris53bb7242015-09-21 13:26:59 -07001055
1056 case BLKPG:
1057 {
1058 /* Convert from blkpg_compat_ioctl_arg to blkpg_ioctl_arg */
1059 struct blkpg_compat_ioctl_arg __user *uarg = argp;
1060 struct blkpg_compat_ioctl_arg compat_arg;
1061 struct blkpg_ioctl_arg a;
1062
1063 if (copy_from_user(&compat_arg, uarg, sizeof(compat_arg))) {
1064 ret = -EFAULT;
1065 break;
1066 }
1067
1068 memset(&a, 0, sizeof(a));
1069 a.op = compat_arg.op;
1070 a.flags = compat_arg.flags;
1071 a.datalen = compat_arg.datalen;
1072 a.data = compat_ptr(compat_arg.data);
1073
1074 ret = mtdchar_blkpg_ioctl(mtd, &a);
1075 break;
1076 }
1077
Kevin Cernekee97718542009-04-08 22:53:13 -07001078 default:
Artem Bityutskiy969e57a2011-12-23 17:27:46 +02001079 ret = mtdchar_ioctl(file, cmd, (unsigned long)argp);
Kevin Cernekee97718542009-04-08 22:53:13 -07001080 }
1081
Arnd Bergmann5aa82942010-06-02 14:28:52 +02001082 mutex_unlock(&mtd_mutex);
Kevin Cernekee97718542009-04-08 22:53:13 -07001083
1084 return ret;
1085}
1086
1087#endif /* CONFIG_COMPAT */
1088
David Howells402d3262009-02-12 10:40:00 +00001089/*
1090 * try to determine where a shared mapping can be made
1091 * - only supported for NOMMU at the moment (MMU can't doesn't copy private
1092 * mappings)
1093 */
1094#ifndef CONFIG_MMU
Artem Bityutskiy969e57a2011-12-23 17:27:46 +02001095static unsigned long mtdchar_get_unmapped_area(struct file *file,
David Howells402d3262009-02-12 10:40:00 +00001096 unsigned long addr,
1097 unsigned long len,
1098 unsigned long pgoff,
1099 unsigned long flags)
1100{
1101 struct mtd_file_info *mfi = file->private_data;
1102 struct mtd_info *mtd = mfi->mtd;
Artem Bityutskiycd621272011-12-30 14:31:57 +02001103 unsigned long offset;
1104 int ret;
David Howells402d3262009-02-12 10:40:00 +00001105
Artem Bityutskiycd621272011-12-30 14:31:57 +02001106 if (addr != 0)
1107 return (unsigned long) -EINVAL;
David Howells402d3262009-02-12 10:40:00 +00001108
Artem Bityutskiycd621272011-12-30 14:31:57 +02001109 if (len > mtd->size || pgoff >= (mtd->size >> PAGE_SHIFT))
1110 return (unsigned long) -EINVAL;
David Howells402d3262009-02-12 10:40:00 +00001111
Artem Bityutskiycd621272011-12-30 14:31:57 +02001112 offset = pgoff << PAGE_SHIFT;
1113 if (offset > mtd->size - len)
1114 return (unsigned long) -EINVAL;
David Howells402d3262009-02-12 10:40:00 +00001115
Artem Bityutskiycd621272011-12-30 14:31:57 +02001116 ret = mtd_get_unmapped_area(mtd, len, offset, flags);
Vladimir Zapolskiyb9995932013-10-28 18:08:15 +02001117 return ret == -EOPNOTSUPP ? -ENODEV : ret;
David Howells402d3262009-02-12 10:40:00 +00001118}
Christoph Hellwigb4caecd2015-01-14 10:42:32 +01001119
1120static unsigned mtdchar_mmap_capabilities(struct file *file)
1121{
1122 struct mtd_file_info *mfi = file->private_data;
1123
1124 return mtd_mmap_capabilities(mfi->mtd);
1125}
David Howells402d3262009-02-12 10:40:00 +00001126#endif
1127
1128/*
1129 * set up a mapping for shared memory segments
1130 */
Artem Bityutskiy969e57a2011-12-23 17:27:46 +02001131static int mtdchar_mmap(struct file *file, struct vm_area_struct *vma)
David Howells402d3262009-02-12 10:40:00 +00001132{
1133#ifdef CONFIG_MMU
1134 struct mtd_file_info *mfi = file->private_data;
1135 struct mtd_info *mtd = mfi->mtd;
Anatolij Gustschindd02b672010-06-15 09:30:15 +02001136 struct map_info *map = mtd->priv;
David Howells402d3262009-02-12 10:40:00 +00001137
David Woodhousef5cf8f02012-10-09 15:08:10 +01001138 /* This is broken because it assumes the MTD device is map-based
1139 and that mtd->priv is a valid struct map_info. It should be
1140 replaced with something that uses the mtd_get_unmapped_area()
1141 operation properly. */
1142 if (0 /*mtd->type == MTD_RAM || mtd->type == MTD_ROM*/) {
Anatolij Gustschindd02b672010-06-15 09:30:15 +02001143#ifdef pgprot_noncached
Linus Torvalds8558e4a2013-04-19 09:53:07 -07001144 if (file->f_flags & O_DSYNC || map->phys >= __pa(high_memory))
Anatolij Gustschindd02b672010-06-15 09:30:15 +02001145 vma->vm_page_prot = pgprot_noncached(vma->vm_page_prot);
1146#endif
Linus Torvalds8558e4a2013-04-19 09:53:07 -07001147 return vm_iomap_memory(vma, map->phys, map->size);
Anatolij Gustschindd02b672010-06-15 09:30:15 +02001148 }
Vladimir Zapolskiyb9995932013-10-28 18:08:15 +02001149 return -ENODEV;
David Howells402d3262009-02-12 10:40:00 +00001150#else
Vladimir Zapolskiyb9995932013-10-28 18:08:15 +02001151 return vma->vm_flags & VM_SHARED ? 0 : -EACCES;
David Howells402d3262009-02-12 10:40:00 +00001152#endif
1153}
1154
Arjan van de Vend54b1fd2007-02-12 00:55:34 -08001155static const struct file_operations mtd_fops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001156 .owner = THIS_MODULE,
Artem Bityutskiy969e57a2011-12-23 17:27:46 +02001157 .llseek = mtdchar_lseek,
1158 .read = mtdchar_read,
1159 .write = mtdchar_write,
1160 .unlocked_ioctl = mtdchar_unlocked_ioctl,
Kevin Cernekee97718542009-04-08 22:53:13 -07001161#ifdef CONFIG_COMPAT
Artem Bityutskiy969e57a2011-12-23 17:27:46 +02001162 .compat_ioctl = mtdchar_compat_ioctl,
Kevin Cernekee97718542009-04-08 22:53:13 -07001163#endif
Artem Bityutskiy969e57a2011-12-23 17:27:46 +02001164 .open = mtdchar_open,
1165 .release = mtdchar_close,
1166 .mmap = mtdchar_mmap,
David Howells402d3262009-02-12 10:40:00 +00001167#ifndef CONFIG_MMU
Artem Bityutskiy969e57a2011-12-23 17:27:46 +02001168 .get_unmapped_area = mtdchar_get_unmapped_area,
Christoph Hellwigb4caecd2015-01-14 10:42:32 +01001169 .mmap_capabilities = mtdchar_mmap_capabilities,
David Howells402d3262009-02-12 10:40:00 +00001170#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07001171};
1172
Artem Bityutskiy660685d2013-03-14 13:27:40 +02001173int __init init_mtdchar(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001174{
Kirill A. Shutemovcd874232010-05-17 16:55:47 +03001175 int ret;
David Brownell1f24b5a2009-03-26 00:42:41 -07001176
Kirill A. Shutemovcd874232010-05-17 16:55:47 +03001177 ret = __register_chrdev(MTD_CHAR_MAJOR, 0, 1 << MINORBITS,
Ben Hutchingsdad0db32010-01-29 21:00:04 +00001178 "mtd", &mtd_fops);
Kirill A. Shutemovcd874232010-05-17 16:55:47 +03001179 if (ret < 0) {
Artem Bityutskiy57ae2b62013-03-15 12:59:36 +02001180 pr_err("Can't allocate major number %d for MTD\n",
1181 MTD_CHAR_MAJOR);
Kirill A. Shutemovcd874232010-05-17 16:55:47 +03001182 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001183 }
1184
Kirill A. Shutemovcd874232010-05-17 16:55:47 +03001185 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001186}
1187
Artem Bityutskiy660685d2013-03-14 13:27:40 +02001188void __exit cleanup_mtdchar(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001189{
Ben Hutchingsdad0db32010-01-29 21:00:04 +00001190 __unregister_chrdev(MTD_CHAR_MAJOR, 0, 1 << MINORBITS, "mtd");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001191}
1192
Scott James Remnant90160e12009-03-02 18:42:39 +00001193MODULE_ALIAS_CHARDEV_MAJOR(MTD_CHAR_MAJOR);