drivers/mtd/mtdchar.c

   1 /*
   2  * 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
  17  *
  18  */
  19
  20 #include <linux/device.h>
  21 #include <linux/fs.h>
  22 #include <linux/mm.h>
  23 #include <linux/err.h>
  24 #include <linux/init.h>
  25 #include <linux/kernel.h>
  26 #include <linux/module.h>
  27 #include <linux/slab.h>
  28 #include <linux/sched.h>
  29 #include <linux/mutex.h>
  30 #include <linux/backing-dev.h>
  31 #include <linux/compat.h>
  32 #include <linux/mount.h>
  33 #include <linux/blkpg.h>
  34 #include <linux/magic.h>
  35 #include <linux/major.h>
  36 #include <linux/mtd/mtd.h>
  37 #include <linux/mtd/partitions.h>
  38 #include <linux/mtd/map.h>
  39
  40 #include <asm/uaccess.h>
  41
  42 #include "mtdcore.h"
  43
  44 static DEFINE_MUTEX(mtd_mutex);
  45
  46 /*
  47  * Data structure to hold the pointer to the mtd device as well
  48  * as mode information of various use cases.
  49  */
  50 struct mtd_file_info {
  51         struct mtd_info *mtd;
  52         enum mtd_file_modes mode;
  53 };
  54
  55 static loff_t mtdchar_lseek(struct file *file, loff_t offset, int orig)
  56 {
  57         struct mtd_file_info *mfi = file->private_data;
  58         return fixed_size_llseek(file, offset, orig, mfi->mtd->size);
  59 }
  60
  61 static int mtdchar_open(struct inode *inode, struct file *file)
  62 {
  63         int minor = iminor(inode);
  64         int devnum = minor >> 1;
  65         int ret = 0;
  66         struct mtd_info *mtd;
  67         struct mtd_file_info *mfi;
  68
  69         pr_debug("MTD_open\n");
  70
  71         /* You can't open the RO devices RW */
  72         if ((file->f_mode & FMODE_WRITE) && (minor & 1))
  73                 return -EACCES;
  74
  75         mutex_lock(&mtd_mutex);
  76         mtd = get_mtd_device(NULL, devnum);
  77
  78         if (IS_ERR(mtd)) {
  79                 ret = PTR_ERR(mtd);
  80                 goto out;
  81         }
  82
  83         if (mtd->type == MTD_ABSENT) {
  84                 ret = -ENODEV;
  85                 goto out1;
  86         }
  87
  88         /* You can't open it RW if it's not a writeable device */
  89         if ((file->f_mode & FMODE_WRITE) && !(mtd->flags & MTD_WRITEABLE)) {
  90                 ret = -EACCES;
  91                 goto out1;
  92         }
  93
  94         mfi = kzalloc(sizeof(*mfi), GFP_KERNEL);
  95         if (!mfi) {
  96                 ret = -ENOMEM;
  97                 goto out1;
  98         }
  99         mfi->mtd = mtd;
 100         file->private_data = mfi;
 101         mutex_unlock(&mtd_mutex);
 102         return 0;
 103
 104 out1:
 105         put_mtd_device(mtd);
 106 out:
 107         mutex_unlock(&mtd_mutex);
 108         return ret;
 109 } /* mtdchar_open */
 110
 111 /*====================================================================*/
 112
 113 static int mtdchar_close(struct inode *inode, struct file *file)
 114 {
 115         struct mtd_file_info *mfi = file->private_data;
 116         struct mtd_info *mtd = mfi->mtd;
 117
 118         pr_debug("MTD_close\n");
 119
 120         /* Only sync if opened RW */
 121         if ((file->f_mode & FMODE_WRITE))
 122                 mtd_sync(mtd);
 123
 124         put_mtd_device(mtd);
 125         file->private_data = NULL;
 126         kfree(mfi);
 127
 128         return 0;
 129 } /* mtdchar_close */
 130
 131 /* 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  */
 148
 149 static ssize_t mtdchar_read(struct file *file, char __user *buf, size_t count,
 150                         loff_t *ppos)
 151 {
 152         struct mtd_file_info *mfi = file->private_data;
 153         struct mtd_info *mtd = mfi->mtd;
 154         size_t retlen;
 155         size_t total_retlen=0;
 156         int ret=0;
 157         int len;
 158         size_t size = count;
 159         char *kbuf;
 160
 161         pr_debug("MTD_read\n");
 162
 163         if (*ppos + count > mtd->size) {
 164                 if (*ppos < mtd->size)
 165                         count = mtd->size - *ppos;
 166                 else
 167                         count = 0;
 168         }
 169
 170         if (!count)
 171                 return 0;
 172
 173         kbuf = mtd_kmalloc_up_to(mtd, &size);
 174         if (!kbuf)
 175                 return -ENOMEM;
 176
 177         while (count) {
 178                 len = min_t(size_t, count, size);
 179
 180                 switch (mfi->mode) {
 181                 case MTD_FILE_MODE_OTP_FACTORY:
 182                         ret = mtd_read_fact_prot_reg(mtd, *ppos, len,
 183                                                      &retlen, kbuf);
 184                         break;
 185                 case MTD_FILE_MODE_OTP_USER:
 186                         ret = mtd_read_user_prot_reg(mtd, *ppos, len,
 187                                                      &retlen, kbuf);
 188                         break;
 189                 case MTD_FILE_MODE_RAW:
 190                 {
 191                         struct mtd_oob_ops ops;
 192
 193                         ops.mode = MTD_OPS_RAW;
 194                         ops.datbuf = kbuf;
 195                         ops.oobbuf = NULL;
 196                         ops.len = len;
 197
 198                         ret = mtd_read_oob(mtd, *ppos, &ops);
 199                         retlen = ops.retlen;
 200                         break;
 201                 }
 202                 default:
 203                         ret = mtd_read(mtd, *ppos, len, &retlen, kbuf);
 204                 }
 205                 /* Nand returns -EBADMSG on ECC errors, but it returns
 206                  * the data. For our userspace tools it is important
 207                  * to dump areas with ECC errors!
 208                  * For kernel internal usage it also might return -EUCLEAN
 209                  * to signal the caller that a bitflip has occurred and has
 210                  * been corrected by the ECC algorithm.
 211                  * Userspace software which accesses NAND this way
 212                  * must be aware of the fact that it deals with NAND
 213                  */
 214                 if (!ret || mtd_is_bitflip_or_eccerr(ret)) {
 215                         *ppos += retlen;
 216                         if (copy_to_user(buf, kbuf, retlen)) {
 217                                 kfree(kbuf);
 218                                 return -EFAULT;
 219                         }
 220                         else
 221                                 total_retlen += retlen;
 222
 223                         count -= retlen;
 224                         buf += retlen;
 225                         if (retlen == 0)
 226                                 count = 0;
 227                 }
 228                 else {
 229                         kfree(kbuf);
 230                         return ret;
 231                 }
 232
 233         }
 234
 235         kfree(kbuf);
 236         return total_retlen;
 237 } /* mtdchar_read */
 238
 239 static ssize_t mtdchar_write(struct file *file, const char __user *buf, size_t count,
 240                         loff_t *ppos)
 241 {
 242         struct mtd_file_info *mfi = file->private_data;
 243         struct mtd_info *mtd = mfi->mtd;
 244         size_t size = count;
 245         char *kbuf;
 246         size_t retlen;
 247         size_t total_retlen=0;
 248         int ret=0;
 249         int len;
 250
 251         pr_debug("MTD_write\n");
 252
 253         if (*ppos >= mtd->size)
 254                 return -ENOSPC;
 255
 256         if (*ppos + count > mtd->size)
 257                 count = mtd->size - *ppos;
 258
 259         if (!count)
 260                 return 0;
 261
 262         kbuf = mtd_kmalloc_up_to(mtd, &size);
 263         if (!kbuf)
 264                 return -ENOMEM;
 265
 266         while (count) {
 267                 len = min_t(size_t, count, size);
 268
 269                 if (copy_from_user(kbuf, buf, len)) {
 270                         kfree(kbuf);
 271                         return -EFAULT;
 272                 }
 273
 274                 switch (mfi->mode) {
 275                 case MTD_FILE_MODE_OTP_FACTORY:
 276                         ret = -EROFS;
 277                         break;
 278                 case MTD_FILE_MODE_OTP_USER:
 279                         ret = mtd_write_user_prot_reg(mtd, *ppos, len,
 280                                                       &retlen, kbuf);
 281                         break;
 282
 283                 case MTD_FILE_MODE_RAW:
 284                 {
 285                         struct mtd_oob_ops ops;
 286
 287                         ops.mode = MTD_OPS_RAW;
 288                         ops.datbuf = kbuf;
 289                         ops.oobbuf = NULL;
 290                         ops.ooboffs = 0;
 291                         ops.len = len;
 292
 293                         ret = mtd_write_oob(mtd, *ppos, &ops);
 294                         retlen = ops.retlen;
 295                         break;
 296                 }
 297
 298                 default:
 299                         ret = mtd_write(mtd, *ppos, len, &retlen, kbuf);
 300                 }
 301
 302                 /*
 303                  * Return -ENOSPC only if no data could be written at all.
 304                  * Otherwise just return the number of bytes that actually
 305                  * have been written.
 306                  */
 307                 if ((ret == -ENOSPC) && (total_retlen))
 308                         break;
 309
 310                 if (!ret) {
 311                         *ppos += retlen;
 312                         total_retlen += retlen;
 313                         count -= retlen;
 314                         buf += retlen;
 315                 }
 316                 else {
 317                         kfree(kbuf);
 318                         return ret;
 319                 }
 320         }
 321
 322         kfree(kbuf);
 323         return total_retlen;
 324 } /* mtdchar_write */
 325
 326 /*======================================================================
 327
 328     IOCTL calls for getting device parameters.
 329
 330 ======================================================================*/
 331 static void mtdchar_erase_callback (struct erase_info *instr)
 332 {
 333         wake_up((wait_queue_head_t *)instr->priv);
 334 }
 335
 336 static int otp_select_filemode(struct mtd_file_info *mfi, int mode)
 337 {
 338         struct mtd_info *mtd = mfi->mtd;
 339         size_t retlen;
 340
 341         switch (mode) {
 342         case MTD_OTP_FACTORY:
 343                 if (mtd_read_fact_prot_reg(mtd, -1, 0, &retlen, NULL) ==
 344                                 -EOPNOTSUPP)
 345                         return -EOPNOTSUPP;
 346
 347                 mfi->mode = MTD_FILE_MODE_OTP_FACTORY;
 348                 break;
 349         case MTD_OTP_USER:
 350                 if (mtd_read_user_prot_reg(mtd, -1, 0, &retlen, NULL) ==
 351                                 -EOPNOTSUPP)
 352                         return -EOPNOTSUPP;
 353
 354                 mfi->mode = MTD_FILE_MODE_OTP_USER;
 355                 break;
 356         case MTD_OTP_OFF:
 357                 mfi->mode = MTD_FILE_MODE_NORMAL;
 358                 break;
 359         default:
 360                 return -EINVAL;
 361         }
 362
 363         return 0;
 364 }
 365
 366 static int mtdchar_writeoob(struct file *file, struct mtd_info *mtd,
 367         uint64_t start, uint32_t length, void __user *ptr,
 368         uint32_t __user *retp)
 369 {
 370         struct mtd_file_info *mfi = file->private_data;
 371         struct mtd_oob_ops ops;
 372         uint32_t retlen;
 373         int ret = 0;
 374
 375         if (!(file->f_mode & FMODE_WRITE))
 376                 return -EPERM;
 377
 378         if (length > 4096)
 379                 return -EINVAL;
 380
 381         if (!mtd->_write_oob)
 382                 ret = -EOPNOTSUPP;
 383         else
 384                 ret = access_ok(VERIFY_READ, ptr, length) ? 0 : -EFAULT;
 385
 386         if (ret)
 387                 return ret;
 388
 389         ops.ooblen = length;
 390         ops.ooboffs = start & (mtd->writesize - 1);
 391         ops.datbuf = NULL;
 392         ops.mode = (mfi->mode == MTD_FILE_MODE_RAW) ? MTD_OPS_RAW :
 393                 MTD_OPS_PLACE_OOB;
 394
 395         if (ops.ooboffs && ops.ooblen > (mtd->oobsize - ops.ooboffs))
 396                 return -EINVAL;
 397
 398         ops.oobbuf = memdup_user(ptr, length);
 399         if (IS_ERR(ops.oobbuf))
 400                 return PTR_ERR(ops.oobbuf);
 401
 402         start &= ~((uint64_t)mtd->writesize - 1);
 403         ret = mtd_write_oob(mtd, start, &ops);
 404
 405         if (ops.oobretlen > 0xFFFFFFFFU)
 406                 ret = -EOVERFLOW;
 407         retlen = ops.oobretlen;
 408         if (copy_to_user(retp, &retlen, sizeof(length)))
 409                 ret = -EFAULT;
 410
 411         kfree(ops.oobbuf);
 412         return ret;
 413 }
 414
 415 static int mtdchar_readoob(struct file *file, struct mtd_info *mtd,
 416         uint64_t start, uint32_t length, void __user *ptr,
 417         uint32_t __user *retp)
 418 {
 419         struct mtd_file_info *mfi = file->private_data;
 420         struct mtd_oob_ops ops;
 421         int ret = 0;
 422
 423         if (length > 4096)
 424                 return -EINVAL;
 425
 426         if (!access_ok(VERIFY_WRITE, ptr, length))
 427                 return -EFAULT;
 428
 429         ops.ooblen = length;
 430         ops.ooboffs = start & (mtd->writesize - 1);
 431         ops.datbuf = NULL;
 432         ops.mode = (mfi->mode == MTD_FILE_MODE_RAW) ? MTD_OPS_RAW :
 433                 MTD_OPS_PLACE_OOB;
 434
 435         if (ops.ooboffs && ops.ooblen > (mtd->oobsize - ops.ooboffs))
 436                 return -EINVAL;
 437
 438         ops.oobbuf = kmalloc(length, GFP_KERNEL);
 439         if (!ops.oobbuf)
 440                 return -ENOMEM;
 441
 442         start &= ~((uint64_t)mtd->writesize - 1);
 443         ret = mtd_read_oob(mtd, start, &ops);
 444
 445         if (put_user(ops.oobretlen, retp))
 446                 ret = -EFAULT;
 447         else if (ops.oobretlen && copy_to_user(ptr, ops.oobbuf,
 448                                             ops.oobretlen))
 449                 ret = -EFAULT;
 450
 451         kfree(ops.oobbuf);
 452
 453         /*
 454          * NAND returns -EBADMSG on ECC errors, but it returns the OOB
 455          * data. For our userspace tools it is important to dump areas
 456          * with ECC errors!
 457          * For kernel internal usage it also might return -EUCLEAN
 458          * to signal the caller that a bitflip has occured and has
 459          * been corrected by the ECC algorithm.
 460          *
 461          * Note: currently the standard NAND function, nand_read_oob_std,
 462          * does not calculate ECC for the OOB area, so do not rely on
 463          * this behavior unless you have replaced it with your own.
 464          */
 465         if (mtd_is_bitflip_or_eccerr(ret))
 466                 return 0;
 467
 468         return ret;
 469 }
 470
 471 /*
 472  * Copies (and truncates, if necessary) data from the larger struct,
 473  * nand_ecclayout, to the smaller, deprecated layout struct,
 474  * nand_ecclayout_user. This is necessary only to support the deprecated
 475  * API ioctl ECCGETLAYOUT while allowing all new functionality to use
 476  * nand_ecclayout flexibly (i.e. the struct may change size in new
 477  * releases without requiring major rewrites).
 478  */
 479 static int shrink_ecclayout(const struct nand_ecclayout *from,
 480                 struct nand_ecclayout_user *to)
 481 {
 482         int i;
 483
 484         if (!from || !to)
 485                 return -EINVAL;
 486
 487         memset(to, 0, sizeof(*to));
 488
 489         to->eccbytes = min((int)from->eccbytes, MTD_MAX_ECCPOS_ENTRIES);
 490         for (i = 0; i < to->eccbytes; i++)
 491                 to->eccpos[i] = from->eccpos[i];
 492
 493         for (i = 0; i < MTD_MAX_OOBFREE_ENTRIES; i++) {
 494                 if (from->oobfree[i].length == 0 &&
 495                                 from->oobfree[i].offset == 0)
 496                         break;
 497                 to->oobavail += from->oobfree[i].length;
 498                 to->oobfree[i] = from->oobfree[i];
 499         }
 500
 501         return 0;
 502 }
 503
 504 static int mtdchar_blkpg_ioctl(struct mtd_info *mtd,
 505                                struct blkpg_ioctl_arg *arg)
 506 {
 507         struct blkpg_partition p;
 508
 509         if (!capable(CAP_SYS_ADMIN))
 510                 return -EPERM;
 511
 512         if (copy_from_user(&p, arg->data, sizeof(p)))
 513                 return -EFAULT;
 514
 515         switch (arg->op) {
 516         case BLKPG_ADD_PARTITION:
 517
 518                 /* Only master mtd device must be used to add partitions */
 519                 if (mtd_is_partition(mtd))
 520                         return -EINVAL;
 521
 522                 /* Sanitize user input */
 523                 p.devname[BLKPG_DEVNAMELTH - 1] = '\0';
 524
 525                 return mtd_add_partition(mtd, p.devname, p.start, p.length);
 526
 527         case BLKPG_DEL_PARTITION:
 528
 529                 if (p.pno < 0)
 530                         return -EINVAL;
 531
 532                 return mtd_del_partition(mtd, p.pno);
 533
 534         default:
 535                 return -EINVAL;
 536         }
 537 }
 538
 539 static int mtdchar_write_ioctl(struct mtd_info *mtd,
 540                 struct mtd_write_req __user *argp)
 541 {
 542         struct mtd_write_req req;
 543         struct mtd_oob_ops ops;
 544         const void __user *usr_data, *usr_oob;
 545         int ret;
 546
 547         if (copy_from_user(&req, argp, sizeof(req)))
 548                 return -EFAULT;
 549
 550         usr_data = (const void __user *)(uintptr_t)req.usr_data;
 551         usr_oob = (const void __user *)(uintptr_t)req.usr_oob;
 552         if (!access_ok(VERIFY_READ, usr_data, req.len) ||
 553             !access_ok(VERIFY_READ, usr_oob, req.ooblen))
 554                 return -EFAULT;
 555
 556         if (!mtd->_write_oob)
 557                 return -EOPNOTSUPP;
 558
 559         ops.mode = req.mode;
 560         ops.len = (size_t)req.len;
 561         ops.ooblen = (size_t)req.ooblen;
 562         ops.ooboffs = 0;
 563
 564         if (usr_data) {
 565                 ops.datbuf = memdup_user(usr_data, ops.len);
 566                 if (IS_ERR(ops.datbuf))
 567                         return PTR_ERR(ops.datbuf);
 568         } else {
 569                 ops.datbuf = NULL;
 570         }
 571
 572         if (usr_oob) {
 573                 ops.oobbuf = memdup_user(usr_oob, ops.ooblen);
 574                 if (IS_ERR(ops.oobbuf)) {
 575                         kfree(ops.datbuf);
 576                         return PTR_ERR(ops.oobbuf);
 577                 }
 578         } else {
 579                 ops.oobbuf = NULL;
 580         }
 581
 582         ret = mtd_write_oob(mtd, (loff_t)req.start, &ops);
 583
 584         kfree(ops.datbuf);
 585         kfree(ops.oobbuf);
 586
 587         return ret;
 588 }
 589
 590 static int mtdchar_ioctl(struct file *file, u_int cmd, u_long arg)
 591 {
 592         struct mtd_file_info *mfi = file->private_data;
 593         struct mtd_info *mtd = mfi->mtd;
 594         void __user *argp = (void __user *)arg;
 595         int ret = 0;
 596         u_long size;
 597         struct mtd_info_user info;
 598
 599         pr_debug("MTD_ioctl\n");
 600
 601         size = (cmd & IOCSIZE_MASK) >> IOCSIZE_SHIFT;
 602         if (cmd & IOC_IN) {
 603                 if (!access_ok(VERIFY_READ, argp, size))
 604                         return -EFAULT;
 605         }
 606         if (cmd & IOC_OUT) {
 607                 if (!access_ok(VERIFY_WRITE, argp, size))
 608                         return -EFAULT;
 609         }
 610
 611         switch (cmd) {
 612         case MEMGETREGIONCOUNT:
 613                 if (copy_to_user(argp, &(mtd->numeraseregions), sizeof(int)))
 614                         return -EFAULT;
 615                 break;
 616
 617         case MEMGETREGIONINFO:
 618         {
 619                 uint32_t ur_idx;
 620                 struct mtd_erase_region_info *kr;
 621                 struct region_info_user __user *ur = argp;
 622
 623                 if (get_user(ur_idx, &(ur->regionindex)))
 624                         return -EFAULT;
 625
 626                 if (ur_idx >= mtd->numeraseregions)
 627                         return -EINVAL;
 628
 629                 kr = &(mtd->eraseregions[ur_idx]);
 630
 631                 if (put_user(kr->offset, &(ur->offset))
 632                     || put_user(kr->erasesize, &(ur->erasesize))
 633                     || put_user(kr->numblocks, &(ur->numblocks)))
 634                         return -EFAULT;
 635
 636                 break;
 637         }
 638
 639         case MEMGETINFO:
 640                 memset(&info, 0, sizeof(info));
 641                 info.type       = mtd->type;
 642                 info.flags      = mtd->flags;
 643                 info.size       = mtd->size;
 644                 info.erasesize  = mtd->erasesize;
 645                 info.writesize  = mtd->writesize;
 646                 info.oobsize    = mtd->oobsize;
 647                 /* The below field is obsolete */
 648                 info.padding    = 0;
 649                 if (copy_to_user(argp, &info, sizeof(struct mtd_info_user)))
 650                         return -EFAULT;
 651                 break;
 652
 653         case MEMERASE:
 654         case MEMERASE64:
 655         {
 656                 struct erase_info *erase;
 657
 658                 if(!(file->f_mode & FMODE_WRITE))
 659                         return -EPERM;
 660
 661                 erase=kzalloc(sizeof(struct erase_info),GFP_KERNEL);
 662                 if (!erase)
 663                         ret = -ENOMEM;
 664                 else {
 665                         wait_queue_head_t waitq;
 666                         DECLARE_WAITQUEUE(wait, current);
 667
 668                         init_waitqueue_head(&waitq);
 669
 670                         if (cmd == MEMERASE64) {
 671                                 struct erase_info_user64 einfo64;
 672
 673                                 if (copy_from_user(&einfo64, argp,
 674                                             sizeof(struct erase_info_user64))) {
 675                                         kfree(erase);
 676                                         return -EFAULT;
 677                                 }
 678                                 erase->addr = einfo64.start;
 679                                 erase->len = einfo64.length;
 680                         } else {
 681                                 struct erase_info_user einfo32;
 682
 683                                 if (copy_from_user(&einfo32, argp,
 684                                             sizeof(struct erase_info_user))) {
 685                                         kfree(erase);
 686                                         return -EFAULT;
 687                                 }
 688                                 erase->addr = einfo32.start;
 689                                 erase->len = einfo32.length;
 690                         }
 691                         erase->mtd = mtd;
 692                         erase->callback = mtdchar_erase_callback;
 693                         erase->priv = (unsigned long)&waitq;
 694
 695                         /*
 696                           FIXME: Allow INTERRUPTIBLE. Which means
 697                           not having the wait_queue head on the stack.
 698
 699                           If the wq_head is on the stack, and we
 700                           leave because we got interrupted, then the
 701                           wq_head is no longer there when the
 702                           callback routine tries to wake us up.
 703                         */
 704                         ret = mtd_erase(mtd, erase);
 705                         if (!ret) {
 706                                 set_current_state(TASK_UNINTERRUPTIBLE);
 707                                 add_wait_queue(&waitq, &wait);
 708                                 if (erase->state != MTD_ERASE_DONE &&
 709                                     erase->state != MTD_ERASE_FAILED)
 710                                         schedule();
 711                                 remove_wait_queue(&waitq, &wait);
 712                                 set_current_state(TASK_RUNNING);
 713
 714                                 ret = (erase->state == MTD_ERASE_FAILED)?-EIO:0;
 715                         }
 716                         kfree(erase);
 717                 }
 718                 break;
 719         }
 720
 721         case MEMWRITEOOB:
 722         {
 723                 struct mtd_oob_buf buf;
 724                 struct mtd_oob_buf __user *buf_user = argp;
 725
 726                 /* NOTE: writes return length to buf_user->length */
 727                 if (copy_from_user(&buf, argp, sizeof(buf)))
 728                         ret = -EFAULT;
 729                 else
 730                         ret = mtdchar_writeoob(file, mtd, buf.start, buf.length,
 731                                 buf.ptr, &buf_user->length);
 732                 break;
 733         }
 734
 735         case MEMREADOOB:
 736         {
 737                 struct mtd_oob_buf buf;
 738                 struct mtd_oob_buf __user *buf_user = argp;
 739
 740                 /* NOTE: writes return length to buf_user->start */
 741                 if (copy_from_user(&buf, argp, sizeof(buf)))
 742                         ret = -EFAULT;
 743                 else
 744                         ret = mtdchar_readoob(file, mtd, buf.start, buf.length,
 745                                 buf.ptr, &buf_user->start);
 746                 break;
 747         }
 748
 749         case MEMWRITEOOB64:
 750         {
 751                 struct mtd_oob_buf64 buf;
 752                 struct mtd_oob_buf64 __user *buf_user = argp;
 753
 754                 if (copy_from_user(&buf, argp, sizeof(buf)))
 755                         ret = -EFAULT;
 756                 else
 757                         ret = mtdchar_writeoob(file, mtd, buf.start, buf.length,
 758                                 (void __user *)(uintptr_t)buf.usr_ptr,
 759                                 &buf_user->length);
 760                 break;
 761         }
 762
 763         case MEMREADOOB64:
 764         {
 765                 struct mtd_oob_buf64 buf;
 766                 struct mtd_oob_buf64 __user *buf_user = argp;
 767
 768                 if (copy_from_user(&buf, argp, sizeof(buf)))
 769                         ret = -EFAULT;
 770                 else
 771                         ret = mtdchar_readoob(file, mtd, buf.start, buf.length,
 772                                 (void __user *)(uintptr_t)buf.usr_ptr,
 773                                 &buf_user->length);
 774                 break;
 775         }
 776
 777         case MEMWRITE:
 778         {
 779                 ret = mtdchar_write_ioctl(mtd,
 780                       (struct mtd_write_req __user *)arg);
 781                 break;
 782         }
 783
 784         case MEMLOCK:
 785         {
 786                 struct erase_info_user einfo;
 787
 788                 if (copy_from_user(&einfo, argp, sizeof(einfo)))
 789                         return -EFAULT;
 790
 791                 ret = mtd_lock(mtd, einfo.start, einfo.length);
 792                 break;
 793         }
 794
 795         case MEMUNLOCK:
 796         {
 797                 struct erase_info_user einfo;
 798
 799                 if (copy_from_user(&einfo, argp, sizeof(einfo)))
 800                         return -EFAULT;
 801
 802                 ret = mtd_unlock(mtd, einfo.start, einfo.length);
 803                 break;
 804         }
 805
 806         case MEMISLOCKED:
 807         {
 808                 struct erase_info_user einfo;
 809
 810                 if (copy_from_user(&einfo, argp, sizeof(einfo)))
 811                         return -EFAULT;
 812
 813                 ret = mtd_is_locked(mtd, einfo.start, einfo.length);
 814                 break;
 815         }
 816
 817         /* Legacy interface */
 818         case MEMGETOOBSEL:
 819         {
 820                 struct nand_oobinfo oi;
 821
 822                 if (!mtd->ecclayout)
 823                         return -EOPNOTSUPP;
 824                 if (mtd->ecclayout->eccbytes > ARRAY_SIZE(oi.eccpos))
 825                         return -EINVAL;
 826
 827                 oi.useecc = MTD_NANDECC_AUTOPLACE;
 828                 memcpy(&oi.eccpos, mtd->ecclayout->eccpos, sizeof(oi.eccpos));
 829                 memcpy(&oi.oobfree, mtd->ecclayout->oobfree,
 830                        sizeof(oi.oobfree));
 831                 oi.eccbytes = mtd->ecclayout->eccbytes;
 832
 833                 if (copy_to_user(argp, &oi, sizeof(struct nand_oobinfo)))
 834                         return -EFAULT;
 835                 break;
 836         }
 837
 838         case MEMGETBADBLOCK:
 839         {
 840                 loff_t offs;
 841
 842                 if (copy_from_user(&offs, argp, sizeof(loff_t)))
 843                         return -EFAULT;
 844                 return mtd_block_isbad(mtd, offs);
 845                 break;
 846         }
 847
 848         case MEMSETBADBLOCK:
 849         {
 850                 loff_t offs;
 851
 852                 if (copy_from_user(&offs, argp, sizeof(loff_t)))
 853                         return -EFAULT;
 854                 return mtd_block_markbad(mtd, offs);
 855                 break;
 856         }
 857
 858         case OTPSELECT:
 859         {
 860                 int mode;
 861                 if (copy_from_user(&mode, argp, sizeof(int)))
 862                         return -EFAULT;
 863
 864                 mfi->mode = MTD_FILE_MODE_NORMAL;
 865
 866                 ret = otp_select_filemode(mfi, mode);
 867
 868                 file->f_pos = 0;
 869                 break;
 870         }
 871
 872         case OTPGETREGIONCOUNT:
 873         case OTPGETREGIONINFO:
 874         {
 875                 struct otp_info *buf = kmalloc(4096, GFP_KERNEL);
 876                 size_t retlen;
 877                 if (!buf)
 878                         return -ENOMEM;
 879                 switch (mfi->mode) {
 880                 case MTD_FILE_MODE_OTP_FACTORY:
 881                         ret = mtd_get_fact_prot_info(mtd, 4096, &retlen, buf);
 882                         break;
 883                 case MTD_FILE_MODE_OTP_USER:
 884                         ret = mtd_get_user_prot_info(mtd, 4096, &retlen, buf);
 885                         break;
 886                 default:
 887                         ret = -EINVAL;
 888                         break;
 889                 }
 890                 if (!ret) {
 891                         if (cmd == OTPGETREGIONCOUNT) {
 892                                 int nbr = retlen / sizeof(struct otp_info);
 893                                 ret = copy_to_user(argp, &nbr, sizeof(int));
 894                         } else
 895                                 ret = copy_to_user(argp, buf, retlen);
 896                         if (ret)
 897                                 ret = -EFAULT;
 898                 }
 899                 kfree(buf);
 900                 break;
 901         }
 902
 903         case OTPLOCK:
 904         {
 905                 struct otp_info oinfo;
 906
 907                 if (mfi->mode != MTD_FILE_MODE_OTP_USER)
 908                         return -EINVAL;
 909                 if (copy_from_user(&oinfo, argp, sizeof(oinfo)))
 910                         return -EFAULT;
 911                 ret = mtd_lock_user_prot_reg(mtd, oinfo.start, oinfo.length);
 912                 break;
 913         }
 914
 915         /* This ioctl is being deprecated - it truncates the ECC layout */
 916         case ECCGETLAYOUT:
 917         {
 918                 struct nand_ecclayout_user *usrlay;
 919
 920                 if (!mtd->ecclayout)
 921                         return -EOPNOTSUPP;
 922
 923                 usrlay = kmalloc(sizeof(*usrlay), GFP_KERNEL);
 924                 if (!usrlay)
 925                         return -ENOMEM;
 926
 927                 shrink_ecclayout(mtd->ecclayout, usrlay);
 928
 929                 if (copy_to_user(argp, usrlay, sizeof(*usrlay)))
 930                         ret = -EFAULT;
 931                 kfree(usrlay);
 932                 break;
 933         }
 934
 935         case ECCGETSTATS:
 936         {
 937                 if (copy_to_user(argp, &mtd->ecc_stats,
 938                                  sizeof(struct mtd_ecc_stats)))
 939                         return -EFAULT;
 940                 break;
 941         }
 942
 943         case MTDFILEMODE:
 944         {
 945                 mfi->mode = 0;
 946
 947                 switch(arg) {
 948                 case MTD_FILE_MODE_OTP_FACTORY:
 949                 case MTD_FILE_MODE_OTP_USER:
 950                         ret = otp_select_filemode(mfi, arg);
 951                         break;
 952
 953                 case MTD_FILE_MODE_RAW:
 954                         if (!mtd_has_oob(mtd))
 955                                 return -EOPNOTSUPP;
 956                         mfi->mode = arg;
 957
 958                 case MTD_FILE_MODE_NORMAL:
 959                         break;
 960                 default:
 961                         ret = -EINVAL;
 962                 }
 963                 file->f_pos = 0;
 964                 break;
 965         }
 966
 967         case BLKPG:
 968         {
 969                 struct blkpg_ioctl_arg __user *blk_arg = argp;
 970                 struct blkpg_ioctl_arg a;
 971
 972                 if (copy_from_user(&a, blk_arg, sizeof(a)))
 973                         ret = -EFAULT;
 974                 else
 975                         ret = mtdchar_blkpg_ioctl(mtd, &a);
 976                 break;
 977         }
 978
 979         case BLKRRPART:
 980         {
 981                 /* No reread partition feature. Just return ok */
 982                 ret = 0;
 983                 break;
 984         }
 985
 986         default:
 987                 ret = -ENOTTY;
 988         }
 989
 990         return ret;
 991 } /* memory_ioctl */
 992
 993 static long mtdchar_unlocked_ioctl(struct file *file, u_int cmd, u_long arg)
 994 {
 995         int ret;
 996
 997         mutex_lock(&mtd_mutex);
 998         ret = mtdchar_ioctl(file, cmd, arg);
 999         mutex_unlock(&mtd_mutex);
1000
1001         return ret;
1002 }
1003
1004 #ifdef CONFIG_COMPAT
1005
1006 struct mtd_oob_buf32 {
1007         u_int32_t start;
1008         u_int32_t length;
1009         compat_caddr_t ptr;     /* unsigned char* */
1010 };
1011
1012 #define MEMWRITEOOB32           _IOWR('M', 3, struct mtd_oob_buf32)
1013 #define MEMREADOOB32            _IOWR('M', 4, struct mtd_oob_buf32)
1014
1015 static long mtdchar_compat_ioctl(struct file *file, unsigned int cmd,
1016         unsigned long arg)
1017 {
1018         struct mtd_file_info *mfi = file->private_data;
1019         struct mtd_info *mtd = mfi->mtd;
1020         void __user *argp = compat_ptr(arg);
1021         int ret = 0;
1022
1023         mutex_lock(&mtd_mutex);
1024
1025         switch (cmd) {
1026         case MEMWRITEOOB32:
1027         {
1028                 struct mtd_oob_buf32 buf;
1029                 struct mtd_oob_buf32 __user *buf_user = argp;
1030
1031                 if (copy_from_user(&buf, argp, sizeof(buf)))
1032                         ret = -EFAULT;
1033                 else
1034                         ret = mtdchar_writeoob(file, mtd, buf.start,
1035                                 buf.length, compat_ptr(buf.ptr),
1036                                 &buf_user->length);
1037                 break;
1038         }
1039
1040         case MEMREADOOB32:
1041         {
1042                 struct mtd_oob_buf32 buf;
1043                 struct mtd_oob_buf32 __user *buf_user = argp;
1044
1045                 /* NOTE: writes return length to buf->start */
1046                 if (copy_from_user(&buf, argp, sizeof(buf)))
1047                         ret = -EFAULT;
1048                 else
1049                         ret = mtdchar_readoob(file, mtd, buf.start,
1050                                 buf.length, compat_ptr(buf.ptr),
1051                                 &buf_user->start);
1052                 break;
1053         }
1054
1055         case BLKPG:
1056         {
1057                 /* Convert from blkpg_compat_ioctl_arg to blkpg_ioctl_arg */
1058                 struct blkpg_compat_ioctl_arg __user *uarg = argp;
1059                 struct blkpg_compat_ioctl_arg compat_arg;
1060                 struct blkpg_ioctl_arg a;
1061
1062                 if (copy_from_user(&compat_arg, uarg, sizeof(compat_arg))) {
1063                         ret = -EFAULT;
1064                         break;
1065                 }
1066
1067                 memset(&a, 0, sizeof(a));
1068                 a.op = compat_arg.op;
1069                 a.flags = compat_arg.flags;
1070                 a.datalen = compat_arg.datalen;
1071                 a.data = compat_ptr(compat_arg.data);
1072
1073                 ret = mtdchar_blkpg_ioctl(mtd, &a);
1074                 break;
1075         }
1076
1077         default:
1078                 ret = mtdchar_ioctl(file, cmd, (unsigned long)argp);
1079         }
1080
1081         mutex_unlock(&mtd_mutex);
1082
1083         return ret;
1084 }
1085
1086 #endif /* CONFIG_COMPAT */
1087
1088 /*
1089  * try to determine where a shared mapping can be made
1090  * - only supported for NOMMU at the moment (MMU can't doesn't copy private
1091  *   mappings)
1092  */
1093 #ifndef CONFIG_MMU
1094 static unsigned long mtdchar_get_unmapped_area(struct file *file,
1095                                            unsigned long addr,
1096                                            unsigned long len,
1097                                            unsigned long pgoff,
1098                                            unsigned long flags)
1099 {
1100         struct mtd_file_info *mfi = file->private_data;
1101         struct mtd_info *mtd = mfi->mtd;
1102         unsigned long offset;
1103         int ret;
1104
1105         if (addr != 0)
1106                 return (unsigned long) -EINVAL;
1107
1108         if (len > mtd->size || pgoff >= (mtd->size >> PAGE_SHIFT))
1109                 return (unsigned long) -EINVAL;
1110
1111         offset = pgoff << PAGE_SHIFT;
1112         if (offset > mtd->size - len)
1113                 return (unsigned long) -EINVAL;
1114
1115         ret = mtd_get_unmapped_area(mtd, len, offset, flags);
1116         return ret == -EOPNOTSUPP ? -ENODEV : ret;
1117 }
1118
1119 static unsigned mtdchar_mmap_capabilities(struct file *file)
1120 {
1121         struct mtd_file_info *mfi = file->private_data;
1122
1123         return mtd_mmap_capabilities(mfi->mtd);
1124 }
1125 #endif
1126
1127 /*
1128  * set up a mapping for shared memory segments
1129  */
1130 static int mtdchar_mmap(struct file *file, struct vm_area_struct *vma)
1131 {
1132 #ifdef CONFIG_MMU
1133         struct mtd_file_info *mfi = file->private_data;
1134         struct mtd_info *mtd = mfi->mtd;
1135         struct map_info *map = mtd->priv;
1136
1137         /* This is broken because it assumes the MTD device is map-based
1138            and that mtd->priv is a valid struct map_info.  It should be
1139            replaced with something that uses the mtd_get_unmapped_area()
1140            operation properly. */
1141         if (0 /*mtd->type == MTD_RAM || mtd->type == MTD_ROM*/) {
1142 #ifdef pgprot_noncached
1143                 if (file->f_flags & O_DSYNC || map->phys >= __pa(high_memory))
1144                         vma->vm_page_prot = pgprot_noncached(vma->vm_page_prot);
1145 #endif
1146                 return vm_iomap_memory(vma, map->phys, map->size);
1147         }
1148         return -ENODEV;
1149 #else
1150         return vma->vm_flags & VM_SHARED ? 0 : -EACCES;
1151 #endif
1152 }
1153
1154 static const struct file_operations mtd_fops = {
1155         .owner          = THIS_MODULE,
1156         .llseek         = mtdchar_lseek,
1157         .read           = mtdchar_read,
1158         .write          = mtdchar_write,
1159         .unlocked_ioctl = mtdchar_unlocked_ioctl,
1160 #ifdef CONFIG_COMPAT
1161         .compat_ioctl   = mtdchar_compat_ioctl,
1162 #endif
1163         .open           = mtdchar_open,
1164         .release        = mtdchar_close,
1165         .mmap           = mtdchar_mmap,
1166 #ifndef CONFIG_MMU
1167         .get_unmapped_area = mtdchar_get_unmapped_area,
1168         .mmap_capabilities = mtdchar_mmap_capabilities,
1169 #endif
1170 };
1171
1172 int __init init_mtdchar(void)
1173 {
1174         int ret;
1175
1176         ret = __register_chrdev(MTD_CHAR_MAJOR, 0, 1 << MINORBITS,
1177                                    "mtd", &mtd_fops);
1178         if (ret < 0) {
1179                 pr_err("Can't allocate major number %d for MTD\n",
1180                        MTD_CHAR_MAJOR);
1181                 return ret;
1182         }
1183
1184         return ret;
1185 }
1186
1187 void __exit cleanup_mtdchar(void)
1188 {
1189         __unregister_chrdev(MTD_CHAR_MAJOR, 0, 1 << MINORBITS, "mtd");
1190 }
1191
1192 MODULE_ALIAS_CHARDEV_MAJOR(MTD_CHAR_MAJOR);