blob: 5b081cb84351340dd6164fe448703f93c6dfca47 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07002 * Character-device access to raw MTD devices.
3 *
4 */
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>
Jonathan Corbet60712392008-05-15 10:10:37 -060015#include <linux/smp_lock.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>
Thomas Gleixner15fdc522005-11-07 00:14:42 +010018
Linus Torvalds1da177e2005-04-16 15:20:36 -070019#include <linux/mtd/mtd.h>
20#include <linux/mtd/compatmac.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070021
Thomas Gleixner15fdc522005-11-07 00:14:42 +010022#include <asm/uaccess.h>
Todd Poynor9bc7b382005-06-30 01:23:27 +010023
Linus Torvalds1da177e2005-04-16 15:20:36 -070024
Nicolas Pitre045e9a52005-02-08 19:12:53 +000025/*
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +020026 * Data structure to hold the pointer to the mtd device as well
27 * as mode information ofr various use cases.
Nicolas Pitre045e9a52005-02-08 19:12:53 +000028 */
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +020029struct mtd_file_info {
30 struct mtd_info *mtd;
31 enum mtd_file_modes mode;
32};
Nicolas Pitre31f42332005-02-08 17:45:55 +000033
Linus Torvalds1da177e2005-04-16 15:20:36 -070034static loff_t mtd_lseek (struct file *file, loff_t offset, int orig)
35{
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +020036 struct mtd_file_info *mfi = file->private_data;
37 struct mtd_info *mtd = mfi->mtd;
Linus Torvalds1da177e2005-04-16 15:20:36 -070038
39 switch (orig) {
Josef 'Jeff' Sipekea598302006-09-16 21:09:29 -040040 case SEEK_SET:
Linus Torvalds1da177e2005-04-16 15:20:36 -070041 break;
Josef 'Jeff' Sipekea598302006-09-16 21:09:29 -040042 case SEEK_CUR:
Todd Poynor8b491d72005-08-04 02:05:51 +010043 offset += file->f_pos;
Linus Torvalds1da177e2005-04-16 15:20:36 -070044 break;
Josef 'Jeff' Sipekea598302006-09-16 21:09:29 -040045 case SEEK_END:
Todd Poynor8b491d72005-08-04 02:05:51 +010046 offset += mtd->size;
Linus Torvalds1da177e2005-04-16 15:20:36 -070047 break;
48 default:
49 return -EINVAL;
50 }
51
Herbert Valerio Riedel1887f512006-06-24 00:03:36 +020052 if (offset >= 0 && offset <= mtd->size)
Todd Poynor8b491d72005-08-04 02:05:51 +010053 return file->f_pos = offset;
Linus Torvalds1da177e2005-04-16 15:20:36 -070054
Todd Poynor8b491d72005-08-04 02:05:51 +010055 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -070056}
57
58
59
60static int mtd_open(struct inode *inode, struct file *file)
61{
62 int minor = iminor(inode);
63 int devnum = minor >> 1;
Jonathan Corbet60712392008-05-15 10:10:37 -060064 int ret = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -070065 struct mtd_info *mtd;
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +020066 struct mtd_file_info *mfi;
Linus Torvalds1da177e2005-04-16 15:20:36 -070067
68 DEBUG(MTD_DEBUG_LEVEL0, "MTD_open\n");
69
70 if (devnum >= MAX_MTD_DEVICES)
71 return -ENODEV;
72
73 /* You can't open the RO devices RW */
Al Viroaeb5d722008-09-02 15:28:45 -040074 if ((file->f_mode & FMODE_WRITE) && (minor & 1))
Linus Torvalds1da177e2005-04-16 15:20:36 -070075 return -EACCES;
76
Jonathan Corbet60712392008-05-15 10:10:37 -060077 lock_kernel();
Linus Torvalds1da177e2005-04-16 15:20:36 -070078 mtd = get_mtd_device(NULL, devnum);
Thomas Gleixner97894cd2005-11-07 11:15:26 +000079
Jonathan Corbet60712392008-05-15 10:10:37 -060080 if (IS_ERR(mtd)) {
81 ret = PTR_ERR(mtd);
82 goto out;
83 }
Thomas Gleixner97894cd2005-11-07 11:15:26 +000084
David Howells402d3262009-02-12 10:40:00 +000085 if (mtd->type == MTD_ABSENT) {
Linus Torvalds1da177e2005-04-16 15:20:36 -070086 put_mtd_device(mtd);
Jonathan Corbet60712392008-05-15 10:10:37 -060087 ret = -ENODEV;
88 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -070089 }
90
David Howells402d3262009-02-12 10:40:00 +000091 if (mtd->backing_dev_info)
92 file->f_mapping->backing_dev_info = mtd->backing_dev_info;
93
Linus Torvalds1da177e2005-04-16 15:20:36 -070094 /* You can't open it RW if it's not a writeable device */
Al Viroaeb5d722008-09-02 15:28:45 -040095 if ((file->f_mode & FMODE_WRITE) && !(mtd->flags & MTD_WRITEABLE)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -070096 put_mtd_device(mtd);
Jonathan Corbet60712392008-05-15 10:10:37 -060097 ret = -EACCES;
98 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -070099 }
Thomas Gleixner97894cd2005-11-07 11:15:26 +0000100
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200101 mfi = kzalloc(sizeof(*mfi), GFP_KERNEL);
102 if (!mfi) {
103 put_mtd_device(mtd);
Jonathan Corbet60712392008-05-15 10:10:37 -0600104 ret = -ENOMEM;
105 goto out;
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200106 }
107 mfi->mtd = mtd;
108 file->private_data = mfi;
109
Jonathan Corbet60712392008-05-15 10:10:37 -0600110out:
111 unlock_kernel();
112 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700113} /* mtd_open */
114
115/*====================================================================*/
116
117static int mtd_close(struct inode *inode, struct file *file)
118{
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200119 struct mtd_file_info *mfi = file->private_data;
120 struct mtd_info *mtd = mfi->mtd;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700121
122 DEBUG(MTD_DEBUG_LEVEL0, "MTD_close\n");
123
Joakim Tjernlund7eafaed2007-06-27 00:56:40 +0200124 /* Only sync if opened RW */
Al Viroaeb5d722008-09-02 15:28:45 -0400125 if ((file->f_mode & FMODE_WRITE) && mtd->sync)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700126 mtd->sync(mtd);
Thomas Gleixner97894cd2005-11-07 11:15:26 +0000127
Linus Torvalds1da177e2005-04-16 15:20:36 -0700128 put_mtd_device(mtd);
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200129 file->private_data = NULL;
130 kfree(mfi);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700131
132 return 0;
133} /* mtd_close */
134
135/* FIXME: This _really_ needs to die. In 2.5, we should lock the
136 userspace buffer down and use it directly with readv/writev.
137*/
138#define MAX_KMALLOC_SIZE 0x20000
139
140static ssize_t mtd_read(struct file *file, char __user *buf, size_t count,loff_t *ppos)
141{
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200142 struct mtd_file_info *mfi = file->private_data;
143 struct mtd_info *mtd = mfi->mtd;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700144 size_t retlen=0;
145 size_t total_retlen=0;
146 int ret=0;
147 int len;
148 char *kbuf;
Thomas Gleixner97894cd2005-11-07 11:15:26 +0000149
Linus Torvalds1da177e2005-04-16 15:20:36 -0700150 DEBUG(MTD_DEBUG_LEVEL0,"MTD_read\n");
151
152 if (*ppos + count > mtd->size)
153 count = mtd->size - *ppos;
154
155 if (!count)
156 return 0;
Thomas Gleixner97894cd2005-11-07 11:15:26 +0000157
Linus Torvalds1da177e2005-04-16 15:20:36 -0700158 /* FIXME: Use kiovec in 2.5 to lock down the user's buffers
159 and pass them directly to the MTD functions */
Thago Galesib802c072006-04-17 17:38:15 +0100160
161 if (count > MAX_KMALLOC_SIZE)
162 kbuf=kmalloc(MAX_KMALLOC_SIZE, GFP_KERNEL);
163 else
164 kbuf=kmalloc(count, GFP_KERNEL);
165
166 if (!kbuf)
167 return -ENOMEM;
168
Linus Torvalds1da177e2005-04-16 15:20:36 -0700169 while (count) {
Thago Galesib802c072006-04-17 17:38:15 +0100170
Thomas Gleixner97894cd2005-11-07 11:15:26 +0000171 if (count > MAX_KMALLOC_SIZE)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700172 len = MAX_KMALLOC_SIZE;
173 else
174 len = count;
175
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200176 switch (mfi->mode) {
177 case MTD_MODE_OTP_FACTORY:
Nicolas Pitre31f42332005-02-08 17:45:55 +0000178 ret = mtd->read_fact_prot_reg(mtd, *ppos, len, &retlen, kbuf);
179 break;
180 case MTD_MODE_OTP_USER:
181 ret = mtd->read_user_prot_reg(mtd, *ppos, len, &retlen, kbuf);
182 break;
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200183 case MTD_MODE_RAW:
184 {
185 struct mtd_oob_ops ops;
186
187 ops.mode = MTD_OOB_RAW;
188 ops.datbuf = kbuf;
189 ops.oobbuf = NULL;
190 ops.len = len;
191
192 ret = mtd->read_oob(mtd, *ppos, &ops);
193 retlen = ops.retlen;
194 break;
195 }
Nicolas Pitre31f42332005-02-08 17:45:55 +0000196 default:
Thomas Gleixnerf4a43cf2006-05-28 11:01:53 +0200197 ret = mtd->read(mtd, *ppos, len, &retlen, kbuf);
Nicolas Pitre31f42332005-02-08 17:45:55 +0000198 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700199 /* Nand returns -EBADMSG on ecc errors, but it returns
200 * the data. For our userspace tools it is important
Thomas Gleixner97894cd2005-11-07 11:15:26 +0000201 * to dump areas with ecc errors !
Thomas Gleixner9a1fcdf2006-05-29 14:56:39 +0200202 * For kernel internal usage it also might return -EUCLEAN
203 * to signal the caller that a bitflip has occured and has
204 * been corrected by the ECC algorithm.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700205 * Userspace software which accesses NAND this way
206 * must be aware of the fact that it deals with NAND
207 */
Thomas Gleixner9a1fcdf2006-05-29 14:56:39 +0200208 if (!ret || (ret == -EUCLEAN) || (ret == -EBADMSG)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700209 *ppos += retlen;
210 if (copy_to_user(buf, kbuf, retlen)) {
Thomas Gleixnerf4a43cf2006-05-28 11:01:53 +0200211 kfree(kbuf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700212 return -EFAULT;
213 }
214 else
215 total_retlen += retlen;
216
217 count -= retlen;
218 buf += retlen;
Nicolas Pitre31f42332005-02-08 17:45:55 +0000219 if (retlen == 0)
220 count = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700221 }
222 else {
223 kfree(kbuf);
224 return ret;
225 }
Thomas Gleixner97894cd2005-11-07 11:15:26 +0000226
Linus Torvalds1da177e2005-04-16 15:20:36 -0700227 }
228
Thago Galesib802c072006-04-17 17:38:15 +0100229 kfree(kbuf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700230 return total_retlen;
231} /* mtd_read */
232
233static ssize_t mtd_write(struct file *file, const char __user *buf, size_t count,loff_t *ppos)
234{
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200235 struct mtd_file_info *mfi = file->private_data;
236 struct mtd_info *mtd = mfi->mtd;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700237 char *kbuf;
238 size_t retlen;
239 size_t total_retlen=0;
240 int ret=0;
241 int len;
242
243 DEBUG(MTD_DEBUG_LEVEL0,"MTD_write\n");
Thomas Gleixner97894cd2005-11-07 11:15:26 +0000244
Linus Torvalds1da177e2005-04-16 15:20:36 -0700245 if (*ppos == mtd->size)
246 return -ENOSPC;
Thomas Gleixner97894cd2005-11-07 11:15:26 +0000247
Linus Torvalds1da177e2005-04-16 15:20:36 -0700248 if (*ppos + count > mtd->size)
249 count = mtd->size - *ppos;
250
251 if (!count)
252 return 0;
253
Thago Galesib802c072006-04-17 17:38:15 +0100254 if (count > MAX_KMALLOC_SIZE)
255 kbuf=kmalloc(MAX_KMALLOC_SIZE, GFP_KERNEL);
256 else
257 kbuf=kmalloc(count, GFP_KERNEL);
258
259 if (!kbuf)
260 return -ENOMEM;
261
Linus Torvalds1da177e2005-04-16 15:20:36 -0700262 while (count) {
Thago Galesib802c072006-04-17 17:38:15 +0100263
Thomas Gleixner97894cd2005-11-07 11:15:26 +0000264 if (count > MAX_KMALLOC_SIZE)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700265 len = MAX_KMALLOC_SIZE;
266 else
267 len = count;
268
Linus Torvalds1da177e2005-04-16 15:20:36 -0700269 if (copy_from_user(kbuf, buf, len)) {
270 kfree(kbuf);
271 return -EFAULT;
272 }
Thomas Gleixner97894cd2005-11-07 11:15:26 +0000273
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200274 switch (mfi->mode) {
275 case MTD_MODE_OTP_FACTORY:
Nicolas Pitre31f42332005-02-08 17:45:55 +0000276 ret = -EROFS;
277 break;
278 case MTD_MODE_OTP_USER:
279 if (!mtd->write_user_prot_reg) {
280 ret = -EOPNOTSUPP;
281 break;
282 }
283 ret = mtd->write_user_prot_reg(mtd, *ppos, len, &retlen, kbuf);
284 break;
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200285
286 case MTD_MODE_RAW:
287 {
288 struct mtd_oob_ops ops;
289
290 ops.mode = MTD_OOB_RAW;
291 ops.datbuf = kbuf;
292 ops.oobbuf = NULL;
293 ops.len = len;
294
295 ret = mtd->write_oob(mtd, *ppos, &ops);
296 retlen = ops.retlen;
297 break;
298 }
299
Nicolas Pitre31f42332005-02-08 17:45:55 +0000300 default:
301 ret = (*(mtd->write))(mtd, *ppos, len, &retlen, kbuf);
302 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700303 if (!ret) {
304 *ppos += retlen;
305 total_retlen += retlen;
306 count -= retlen;
307 buf += retlen;
308 }
309 else {
310 kfree(kbuf);
311 return ret;
312 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700313 }
314
Thago Galesib802c072006-04-17 17:38:15 +0100315 kfree(kbuf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700316 return total_retlen;
317} /* mtd_write */
318
319/*======================================================================
320
321 IOCTL calls for getting device parameters.
322
323======================================================================*/
324static void mtdchar_erase_callback (struct erase_info *instr)
325{
326 wake_up((wait_queue_head_t *)instr->priv);
327}
328
David Brownell34a82442008-07-30 12:35:05 -0700329#ifdef CONFIG_HAVE_MTD_OTP
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200330static int otp_select_filemode(struct mtd_file_info *mfi, int mode)
331{
332 struct mtd_info *mtd = mfi->mtd;
333 int ret = 0;
334
335 switch (mode) {
336 case MTD_OTP_FACTORY:
337 if (!mtd->read_fact_prot_reg)
338 ret = -EOPNOTSUPP;
339 else
340 mfi->mode = MTD_MODE_OTP_FACTORY;
341 break;
342 case MTD_OTP_USER:
343 if (!mtd->read_fact_prot_reg)
344 ret = -EOPNOTSUPP;
345 else
346 mfi->mode = MTD_MODE_OTP_USER;
347 break;
348 default:
349 ret = -EINVAL;
350 case MTD_OTP_OFF:
351 break;
352 }
353 return ret;
354}
355#else
356# define otp_select_filemode(f,m) -EOPNOTSUPP
357#endif
358
Kevin Cernekee97718542009-04-08 22:53:13 -0700359static int mtd_do_writeoob(struct file *file, struct mtd_info *mtd,
360 uint64_t start, uint32_t length, void __user *ptr,
361 uint32_t __user *retp)
362{
363 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
373 if (!mtd->write_oob)
374 ret = -EOPNOTSUPP;
375 else
376 ret = access_ok(VERIFY_READ, ptr, length) ? 0 : EFAULT;
377
378 if (ret)
379 return ret;
380
381 ops.ooblen = length;
382 ops.ooboffs = start & (mtd->oobsize - 1);
383 ops.datbuf = NULL;
384 ops.mode = MTD_OOB_PLACE;
385
386 if (ops.ooboffs && ops.ooblen > (mtd->oobsize - ops.ooboffs))
387 return -EINVAL;
388
389 ops.oobbuf = kmalloc(length, GFP_KERNEL);
390 if (!ops.oobbuf)
391 return -ENOMEM;
392
393 if (copy_from_user(ops.oobbuf, ptr, length)) {
394 kfree(ops.oobbuf);
395 return -EFAULT;
396 }
397
398 start &= ~((uint64_t)mtd->oobsize - 1);
399 ret = mtd->write_oob(mtd, start, &ops);
400
401 if (ops.oobretlen > 0xFFFFFFFFU)
402 ret = -EOVERFLOW;
403 retlen = ops.oobretlen;
404 if (copy_to_user(retp, &retlen, sizeof(length)))
405 ret = -EFAULT;
406
407 kfree(ops.oobbuf);
408 return ret;
409}
410
411static int mtd_do_readoob(struct mtd_info *mtd, uint64_t start,
412 uint32_t length, void __user *ptr, uint32_t __user *retp)
413{
414 struct mtd_oob_ops ops;
415 int ret = 0;
416
417 if (length > 4096)
418 return -EINVAL;
419
420 if (!mtd->read_oob)
421 ret = -EOPNOTSUPP;
422 else
423 ret = access_ok(VERIFY_WRITE, ptr,
424 length) ? 0 : -EFAULT;
425 if (ret)
426 return ret;
427
428 ops.ooblen = length;
429 ops.ooboffs = start & (mtd->oobsize - 1);
430 ops.datbuf = NULL;
431 ops.mode = MTD_OOB_PLACE;
432
433 if (ops.ooboffs && ops.ooblen > (mtd->oobsize - ops.ooboffs))
434 return -EINVAL;
435
436 ops.oobbuf = kmalloc(length, GFP_KERNEL);
437 if (!ops.oobbuf)
438 return -ENOMEM;
439
440 start &= ~((uint64_t)mtd->oobsize - 1);
441 ret = mtd->read_oob(mtd, start, &ops);
442
443 if (put_user(ops.oobretlen, retp))
444 ret = -EFAULT;
445 else if (ops.oobretlen && copy_to_user(ptr, ops.oobbuf,
446 ops.oobretlen))
447 ret = -EFAULT;
448
449 kfree(ops.oobbuf);
450 return ret;
451}
452
Linus Torvalds1da177e2005-04-16 15:20:36 -0700453static int mtd_ioctl(struct inode *inode, struct file *file,
454 u_int cmd, u_long arg)
455{
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200456 struct mtd_file_info *mfi = file->private_data;
457 struct mtd_info *mtd = mfi->mtd;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700458 void __user *argp = (void __user *)arg;
459 int ret = 0;
460 u_long size;
Joern Engel73c619e2006-05-30 14:25:35 +0200461 struct mtd_info_user info;
Thomas Gleixner97894cd2005-11-07 11:15:26 +0000462
Linus Torvalds1da177e2005-04-16 15:20:36 -0700463 DEBUG(MTD_DEBUG_LEVEL0, "MTD_ioctl\n");
464
465 size = (cmd & IOCSIZE_MASK) >> IOCSIZE_SHIFT;
466 if (cmd & IOC_IN) {
467 if (!access_ok(VERIFY_READ, argp, size))
468 return -EFAULT;
469 }
470 if (cmd & IOC_OUT) {
471 if (!access_ok(VERIFY_WRITE, argp, size))
472 return -EFAULT;
473 }
Thomas Gleixner97894cd2005-11-07 11:15:26 +0000474
Linus Torvalds1da177e2005-04-16 15:20:36 -0700475 switch (cmd) {
476 case MEMGETREGIONCOUNT:
477 if (copy_to_user(argp, &(mtd->numeraseregions), sizeof(int)))
478 return -EFAULT;
479 break;
480
481 case MEMGETREGIONINFO:
482 {
Zev Weissb67c5f82008-09-01 05:02:12 -0700483 uint32_t ur_idx;
484 struct mtd_erase_region_info *kr;
485 struct region_info_user *ur = (struct region_info_user *) argp;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700486
Zev Weissb67c5f82008-09-01 05:02:12 -0700487 if (get_user(ur_idx, &(ur->regionindex)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700488 return -EFAULT;
489
Zev Weissb67c5f82008-09-01 05:02:12 -0700490 kr = &(mtd->eraseregions[ur_idx]);
491
492 if (put_user(kr->offset, &(ur->offset))
493 || put_user(kr->erasesize, &(ur->erasesize))
494 || put_user(kr->numblocks, &(ur->numblocks)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700495 return -EFAULT;
Zev Weissb67c5f82008-09-01 05:02:12 -0700496
Linus Torvalds1da177e2005-04-16 15:20:36 -0700497 break;
498 }
499
500 case MEMGETINFO:
Joern Engel73c619e2006-05-30 14:25:35 +0200501 info.type = mtd->type;
502 info.flags = mtd->flags;
503 info.size = mtd->size;
504 info.erasesize = mtd->erasesize;
505 info.writesize = mtd->writesize;
506 info.oobsize = mtd->oobsize;
Artem Bityutskiy64f60712007-01-30 10:50:43 +0200507 /* The below fields are obsolete */
508 info.ecctype = -1;
509 info.eccsize = 0;
Joern Engel73c619e2006-05-30 14:25:35 +0200510 if (copy_to_user(argp, &info, sizeof(struct mtd_info_user)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700511 return -EFAULT;
512 break;
513
514 case MEMERASE:
Kevin Cernekee0dc54e92009-04-08 22:52:28 -0700515 case MEMERASE64:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700516 {
517 struct erase_info *erase;
518
Al Viroaeb5d722008-09-02 15:28:45 -0400519 if(!(file->f_mode & FMODE_WRITE))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700520 return -EPERM;
521
Burman Yan95b93a02006-11-15 21:10:29 +0200522 erase=kzalloc(sizeof(struct erase_info),GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700523 if (!erase)
524 ret = -ENOMEM;
525 else {
526 wait_queue_head_t waitq;
527 DECLARE_WAITQUEUE(wait, current);
528
529 init_waitqueue_head(&waitq);
530
Kevin Cernekee0dc54e92009-04-08 22:52:28 -0700531 if (cmd == MEMERASE64) {
532 struct erase_info_user64 einfo64;
533
534 if (copy_from_user(&einfo64, argp,
535 sizeof(struct erase_info_user64))) {
536 kfree(erase);
537 return -EFAULT;
538 }
539 erase->addr = einfo64.start;
540 erase->len = einfo64.length;
541 } else {
542 struct erase_info_user einfo32;
543
544 if (copy_from_user(&einfo32, argp,
545 sizeof(struct erase_info_user))) {
546 kfree(erase);
547 return -EFAULT;
548 }
549 erase->addr = einfo32.start;
550 erase->len = einfo32.length;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700551 }
552 erase->mtd = mtd;
553 erase->callback = mtdchar_erase_callback;
554 erase->priv = (unsigned long)&waitq;
Thomas Gleixner97894cd2005-11-07 11:15:26 +0000555
Linus Torvalds1da177e2005-04-16 15:20:36 -0700556 /*
557 FIXME: Allow INTERRUPTIBLE. Which means
558 not having the wait_queue head on the stack.
Thomas Gleixner97894cd2005-11-07 11:15:26 +0000559
Linus Torvalds1da177e2005-04-16 15:20:36 -0700560 If the wq_head is on the stack, and we
561 leave because we got interrupted, then the
562 wq_head is no longer there when the
563 callback routine tries to wake us up.
564 */
565 ret = mtd->erase(mtd, erase);
566 if (!ret) {
567 set_current_state(TASK_UNINTERRUPTIBLE);
568 add_wait_queue(&waitq, &wait);
569 if (erase->state != MTD_ERASE_DONE &&
570 erase->state != MTD_ERASE_FAILED)
571 schedule();
572 remove_wait_queue(&waitq, &wait);
573 set_current_state(TASK_RUNNING);
574
575 ret = (erase->state == MTD_ERASE_FAILED)?-EIO:0;
576 }
577 kfree(erase);
578 }
579 break;
580 }
581
582 case MEMWRITEOOB:
583 {
584 struct mtd_oob_buf buf;
Kevin Cernekee97718542009-04-08 22:53:13 -0700585 struct mtd_oob_buf __user *buf_user = argp;
Thomas Gleixner97894cd2005-11-07 11:15:26 +0000586
Kevin Cernekee97718542009-04-08 22:53:13 -0700587 /* NOTE: writes return length to buf_user->length */
588 if (copy_from_user(&buf, argp, sizeof(buf)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700589 ret = -EFAULT;
Kevin Cernekee97718542009-04-08 22:53:13 -0700590 else
591 ret = mtd_do_writeoob(file, mtd, buf.start, buf.length,
592 buf.ptr, &buf_user->length);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700593 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700594 }
595
596 case MEMREADOOB:
597 {
598 struct mtd_oob_buf buf;
Kevin Cernekee97718542009-04-08 22:53:13 -0700599 struct mtd_oob_buf __user *buf_user = argp;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700600
Kevin Cernekee97718542009-04-08 22:53:13 -0700601 /* NOTE: writes return length to buf_user->start */
602 if (copy_from_user(&buf, argp, sizeof(buf)))
603 ret = -EFAULT;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700604 else
Kevin Cernekee97718542009-04-08 22:53:13 -0700605 ret = mtd_do_readoob(mtd, buf.start, buf.length,
606 buf.ptr, &buf_user->start);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700607 break;
608 }
609
Kevin Cernekeeaea7cea2009-04-08 22:53:49 -0700610 case MEMWRITEOOB64:
611 {
612 struct mtd_oob_buf64 buf;
613 struct mtd_oob_buf64 __user *buf_user = argp;
614
615 if (copy_from_user(&buf, argp, sizeof(buf)))
616 ret = -EFAULT;
617 else
618 ret = mtd_do_writeoob(file, mtd, buf.start, buf.length,
619 (void __user *)(uintptr_t)buf.usr_ptr,
620 &buf_user->length);
621 break;
622 }
623
624 case MEMREADOOB64:
625 {
626 struct mtd_oob_buf64 buf;
627 struct mtd_oob_buf64 __user *buf_user = argp;
628
629 if (copy_from_user(&buf, argp, sizeof(buf)))
630 ret = -EFAULT;
631 else
632 ret = mtd_do_readoob(mtd, buf.start, buf.length,
633 (void __user *)(uintptr_t)buf.usr_ptr,
634 &buf_user->length);
635 break;
636 }
637
Linus Torvalds1da177e2005-04-16 15:20:36 -0700638 case MEMLOCK:
639 {
Harvey Harrison175428b2008-07-03 23:40:14 -0700640 struct erase_info_user einfo;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700641
Harvey Harrison175428b2008-07-03 23:40:14 -0700642 if (copy_from_user(&einfo, argp, sizeof(einfo)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700643 return -EFAULT;
644
645 if (!mtd->lock)
646 ret = -EOPNOTSUPP;
647 else
Harvey Harrison175428b2008-07-03 23:40:14 -0700648 ret = mtd->lock(mtd, einfo.start, einfo.length);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700649 break;
650 }
651
652 case MEMUNLOCK:
653 {
Harvey Harrison175428b2008-07-03 23:40:14 -0700654 struct erase_info_user einfo;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700655
Harvey Harrison175428b2008-07-03 23:40:14 -0700656 if (copy_from_user(&einfo, argp, sizeof(einfo)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700657 return -EFAULT;
658
659 if (!mtd->unlock)
660 ret = -EOPNOTSUPP;
661 else
Harvey Harrison175428b2008-07-03 23:40:14 -0700662 ret = mtd->unlock(mtd, einfo.start, einfo.length);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700663 break;
664 }
665
Thomas Gleixner5bd34c02006-05-27 22:16:10 +0200666 /* Legacy interface */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700667 case MEMGETOOBSEL:
668 {
Thomas Gleixner5bd34c02006-05-27 22:16:10 +0200669 struct nand_oobinfo oi;
670
671 if (!mtd->ecclayout)
672 return -EOPNOTSUPP;
673 if (mtd->ecclayout->eccbytes > ARRAY_SIZE(oi.eccpos))
674 return -EINVAL;
675
676 oi.useecc = MTD_NANDECC_AUTOPLACE;
677 memcpy(&oi.eccpos, mtd->ecclayout->eccpos, sizeof(oi.eccpos));
678 memcpy(&oi.oobfree, mtd->ecclayout->oobfree,
679 sizeof(oi.oobfree));
Ricard Wanderlöfd25ade72006-10-17 17:27:11 +0200680 oi.eccbytes = mtd->ecclayout->eccbytes;
Thomas Gleixner5bd34c02006-05-27 22:16:10 +0200681
682 if (copy_to_user(argp, &oi, sizeof(struct nand_oobinfo)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700683 return -EFAULT;
684 break;
685 }
686
687 case MEMGETBADBLOCK:
688 {
689 loff_t offs;
Thomas Gleixner97894cd2005-11-07 11:15:26 +0000690
Linus Torvalds1da177e2005-04-16 15:20:36 -0700691 if (copy_from_user(&offs, argp, sizeof(loff_t)))
692 return -EFAULT;
693 if (!mtd->block_isbad)
694 ret = -EOPNOTSUPP;
695 else
696 return mtd->block_isbad(mtd, offs);
697 break;
698 }
699
700 case MEMSETBADBLOCK:
701 {
702 loff_t offs;
703
704 if (copy_from_user(&offs, argp, sizeof(loff_t)))
705 return -EFAULT;
706 if (!mtd->block_markbad)
707 ret = -EOPNOTSUPP;
708 else
709 return mtd->block_markbad(mtd, offs);
710 break;
711 }
712
David Brownell34a82442008-07-30 12:35:05 -0700713#ifdef CONFIG_HAVE_MTD_OTP
Nicolas Pitre31f42332005-02-08 17:45:55 +0000714 case OTPSELECT:
715 {
716 int mode;
717 if (copy_from_user(&mode, argp, sizeof(int)))
718 return -EFAULT;
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200719
720 mfi->mode = MTD_MODE_NORMAL;
721
722 ret = otp_select_filemode(mfi, mode);
723
Nicolas Pitre81dba482005-04-01 16:36:15 +0100724 file->f_pos = 0;
Nicolas Pitre31f42332005-02-08 17:45:55 +0000725 break;
726 }
727
728 case OTPGETREGIONCOUNT:
729 case OTPGETREGIONINFO:
730 {
731 struct otp_info *buf = kmalloc(4096, GFP_KERNEL);
732 if (!buf)
733 return -ENOMEM;
734 ret = -EOPNOTSUPP;
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200735 switch (mfi->mode) {
736 case MTD_MODE_OTP_FACTORY:
Nicolas Pitre31f42332005-02-08 17:45:55 +0000737 if (mtd->get_fact_prot_info)
738 ret = mtd->get_fact_prot_info(mtd, buf, 4096);
739 break;
740 case MTD_MODE_OTP_USER:
741 if (mtd->get_user_prot_info)
742 ret = mtd->get_user_prot_info(mtd, buf, 4096);
743 break;
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200744 default:
745 break;
Nicolas Pitre31f42332005-02-08 17:45:55 +0000746 }
747 if (ret >= 0) {
748 if (cmd == OTPGETREGIONCOUNT) {
749 int nbr = ret / sizeof(struct otp_info);
750 ret = copy_to_user(argp, &nbr, sizeof(int));
751 } else
752 ret = copy_to_user(argp, buf, ret);
753 if (ret)
754 ret = -EFAULT;
755 }
756 kfree(buf);
757 break;
758 }
759
760 case OTPLOCK:
761 {
Harvey Harrison175428b2008-07-03 23:40:14 -0700762 struct otp_info oinfo;
Nicolas Pitre31f42332005-02-08 17:45:55 +0000763
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200764 if (mfi->mode != MTD_MODE_OTP_USER)
Nicolas Pitre31f42332005-02-08 17:45:55 +0000765 return -EINVAL;
Harvey Harrison175428b2008-07-03 23:40:14 -0700766 if (copy_from_user(&oinfo, argp, sizeof(oinfo)))
Nicolas Pitre31f42332005-02-08 17:45:55 +0000767 return -EFAULT;
768 if (!mtd->lock_user_prot_reg)
769 return -EOPNOTSUPP;
Harvey Harrison175428b2008-07-03 23:40:14 -0700770 ret = mtd->lock_user_prot_reg(mtd, oinfo.start, oinfo.length);
Nicolas Pitre31f42332005-02-08 17:45:55 +0000771 break;
772 }
773#endif
774
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200775 case ECCGETLAYOUT:
776 {
777 if (!mtd->ecclayout)
778 return -EOPNOTSUPP;
779
Ricard Wanderlöfd25ade72006-10-17 17:27:11 +0200780 if (copy_to_user(argp, mtd->ecclayout,
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200781 sizeof(struct nand_ecclayout)))
782 return -EFAULT;
783 break;
784 }
785
786 case ECCGETSTATS:
787 {
788 if (copy_to_user(argp, &mtd->ecc_stats,
789 sizeof(struct mtd_ecc_stats)))
790 return -EFAULT;
791 break;
792 }
793
794 case MTDFILEMODE:
795 {
796 mfi->mode = 0;
797
798 switch(arg) {
799 case MTD_MODE_OTP_FACTORY:
800 case MTD_MODE_OTP_USER:
801 ret = otp_select_filemode(mfi, arg);
802 break;
803
804 case MTD_MODE_RAW:
805 if (!mtd->read_oob || !mtd->write_oob)
806 return -EOPNOTSUPP;
807 mfi->mode = arg;
808
809 case MTD_MODE_NORMAL:
810 break;
811 default:
812 ret = -EINVAL;
813 }
814 file->f_pos = 0;
815 break;
816 }
817
Linus Torvalds1da177e2005-04-16 15:20:36 -0700818 default:
819 ret = -ENOTTY;
820 }
821
822 return ret;
823} /* memory_ioctl */
824
Kevin Cernekee97718542009-04-08 22:53:13 -0700825#ifdef CONFIG_COMPAT
826
827struct mtd_oob_buf32 {
828 u_int32_t start;
829 u_int32_t length;
830 compat_caddr_t ptr; /* unsigned char* */
831};
832
833#define MEMWRITEOOB32 _IOWR('M', 3, struct mtd_oob_buf32)
834#define MEMREADOOB32 _IOWR('M', 4, struct mtd_oob_buf32)
835
836static long mtd_compat_ioctl(struct file *file, unsigned int cmd,
837 unsigned long arg)
838{
Kevin Cernekee668ff9a2009-04-14 21:59:22 -0700839 struct inode *inode = file->f_path.dentry->d_inode;
Kevin Cernekee97718542009-04-08 22:53:13 -0700840 struct mtd_file_info *mfi = file->private_data;
841 struct mtd_info *mtd = mfi->mtd;
David Woodhouse0b6585c2009-05-29 16:09:08 +0100842 void __user *argp = compat_ptr(arg);
Kevin Cernekee97718542009-04-08 22:53:13 -0700843 int ret = 0;
844
845 lock_kernel();
846
847 switch (cmd) {
848 case MEMWRITEOOB32:
849 {
850 struct mtd_oob_buf32 buf;
851 struct mtd_oob_buf32 __user *buf_user = argp;
852
853 if (copy_from_user(&buf, argp, sizeof(buf)))
854 ret = -EFAULT;
855 else
856 ret = mtd_do_writeoob(file, mtd, buf.start,
857 buf.length, compat_ptr(buf.ptr),
858 &buf_user->length);
859 break;
860 }
861
862 case MEMREADOOB32:
863 {
864 struct mtd_oob_buf32 buf;
865 struct mtd_oob_buf32 __user *buf_user = argp;
866
867 /* NOTE: writes return length to buf->start */
868 if (copy_from_user(&buf, argp, sizeof(buf)))
869 ret = -EFAULT;
870 else
871 ret = mtd_do_readoob(mtd, buf.start,
872 buf.length, compat_ptr(buf.ptr),
873 &buf_user->start);
874 break;
875 }
876 default:
David Woodhouse0b6585c2009-05-29 16:09:08 +0100877 ret = mtd_ioctl(inode, file, cmd, (unsigned long)argp);
Kevin Cernekee97718542009-04-08 22:53:13 -0700878 }
879
880 unlock_kernel();
881
882 return ret;
883}
884
885#endif /* CONFIG_COMPAT */
886
David Howells402d3262009-02-12 10:40:00 +0000887/*
888 * try to determine where a shared mapping can be made
889 * - only supported for NOMMU at the moment (MMU can't doesn't copy private
890 * mappings)
891 */
892#ifndef CONFIG_MMU
893static unsigned long mtd_get_unmapped_area(struct file *file,
894 unsigned long addr,
895 unsigned long len,
896 unsigned long pgoff,
897 unsigned long flags)
898{
899 struct mtd_file_info *mfi = file->private_data;
900 struct mtd_info *mtd = mfi->mtd;
901
902 if (mtd->get_unmapped_area) {
903 unsigned long offset;
904
905 if (addr != 0)
906 return (unsigned long) -EINVAL;
907
908 if (len > mtd->size || pgoff >= (mtd->size >> PAGE_SHIFT))
909 return (unsigned long) -EINVAL;
910
911 offset = pgoff << PAGE_SHIFT;
912 if (offset > mtd->size - len)
913 return (unsigned long) -EINVAL;
914
915 return mtd->get_unmapped_area(mtd, len, offset, flags);
916 }
917
918 /* can't map directly */
919 return (unsigned long) -ENOSYS;
920}
921#endif
922
923/*
924 * set up a mapping for shared memory segments
925 */
926static int mtd_mmap(struct file *file, struct vm_area_struct *vma)
927{
928#ifdef CONFIG_MMU
929 struct mtd_file_info *mfi = file->private_data;
930 struct mtd_info *mtd = mfi->mtd;
931
932 if (mtd->type == MTD_RAM || mtd->type == MTD_ROM)
933 return 0;
934 return -ENOSYS;
935#else
936 return vma->vm_flags & VM_SHARED ? 0 : -ENOSYS;
937#endif
938}
939
Arjan van de Vend54b1fd2007-02-12 00:55:34 -0800940static const struct file_operations mtd_fops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700941 .owner = THIS_MODULE,
942 .llseek = mtd_lseek,
943 .read = mtd_read,
944 .write = mtd_write,
945 .ioctl = mtd_ioctl,
Kevin Cernekee97718542009-04-08 22:53:13 -0700946#ifdef CONFIG_COMPAT
947 .compat_ioctl = mtd_compat_ioctl,
948#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700949 .open = mtd_open,
950 .release = mtd_close,
David Howells402d3262009-02-12 10:40:00 +0000951 .mmap = mtd_mmap,
952#ifndef CONFIG_MMU
953 .get_unmapped_area = mtd_get_unmapped_area,
954#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700955};
956
957static int __init init_mtdchar(void)
958{
David Brownell1f24b5a2009-03-26 00:42:41 -0700959 int status;
960
961 status = register_chrdev(MTD_CHAR_MAJOR, "mtd", &mtd_fops);
962 if (status < 0) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700963 printk(KERN_NOTICE "Can't allocate major number %d for Memory Technology Devices.\n",
964 MTD_CHAR_MAJOR);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700965 }
966
David Brownell1f24b5a2009-03-26 00:42:41 -0700967 return status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700968}
969
970static void __exit cleanup_mtdchar(void)
971{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700972 unregister_chrdev(MTD_CHAR_MAJOR, "mtd");
973}
974
975module_init(init_mtdchar);
976module_exit(cleanup_mtdchar);
977
David Brownell1f24b5a2009-03-26 00:42:41 -0700978MODULE_ALIAS_CHARDEV_MAJOR(MTD_CHAR_MAJOR);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700979
980MODULE_LICENSE("GPL");
981MODULE_AUTHOR("David Woodhouse <dwmw2@infradead.org>");
982MODULE_DESCRIPTION("Direct character-device access to MTD devices");
Scott James Remnant90160e12009-03-02 18:42:39 +0000983MODULE_ALIAS_CHARDEV_MAJOR(MTD_CHAR_MAJOR);