drivers/mtd/devices/spear_smi.c

   1 /*
   2  * SMI (Serial Memory Controller) device driver for Serial NOR Flash on
   3  * SPEAr platform
   4  * The serial nor interface is largely based on m25p80.c, however the SPI
   5  * interface has been replaced by SMI.
   6  *
   7  * Copyright © 2010 STMicroelectronics.
   8  * Ashish Priyadarshi
   9  * Shiraz Hashim <shiraz.linux.kernel@gmail.com>
  10  *
  11  * This file is licensed under the terms of the GNU General Public
  12  * License version 2. This program is licensed "as is" without any
  13  * warranty of any kind, whether express or implied.
  14  */
  15
  16 #include <linux/clk.h>
  17 #include <linux/delay.h>
  18 #include <linux/device.h>
  19 #include <linux/err.h>
  20 #include <linux/errno.h>
  21 #include <linux/interrupt.h>
  22 #include <linux/io.h>
  23 #include <linux/ioport.h>
  24 #include <linux/jiffies.h>
  25 #include <linux/kernel.h>
  26 #include <linux/module.h>
  27 #include <linux/param.h>
  28 #include <linux/platform_device.h>
  29 #include <linux/pm.h>
  30 #include <linux/mtd/mtd.h>
  31 #include <linux/mtd/partitions.h>
  32 #include <linux/mtd/spear_smi.h>
  33 #include <linux/mutex.h>
  34 #include <linux/sched.h>
  35 #include <linux/slab.h>
  36 #include <linux/wait.h>
  37 #include <linux/of.h>
  38 #include <linux/of_address.h>
  39
  40 /* SMI clock rate */
  41 #define SMI_MAX_CLOCK_FREQ      50000000 /* 50 MHz */
  42
  43 /* MAX time out to safely come out of a erase or write busy conditions */
  44 #define SMI_PROBE_TIMEOUT       (HZ / 10)
  45 #define SMI_MAX_TIME_OUT        (3 * HZ)
  46
  47 /* timeout for command completion */
  48 #define SMI_CMD_TIMEOUT         (HZ / 10)
  49
  50 /* registers of smi */
  51 #define SMI_CR1         0x0     /* SMI control register 1 */
  52 #define SMI_CR2         0x4     /* SMI control register 2 */
  53 #define SMI_SR          0x8     /* SMI status register */
  54 #define SMI_TR          0xC     /* SMI transmit register */
  55 #define SMI_RR          0x10    /* SMI receive register */
  56
  57 /* defines for control_reg 1 */
  58 #define BANK_EN         (0xF << 0)      /* enables all banks */
  59 #define DSEL_TIME       (0x6 << 4)      /* Deselect time 6 + 1 SMI_CK periods */
  60 #define SW_MODE         (0x1 << 28)     /* enables SW Mode */
  61 #define WB_MODE         (0x1 << 29)     /* Write Burst Mode */
  62 #define FAST_MODE       (0x1 << 15)     /* Fast Mode */
  63 #define HOLD1           (0x1 << 16)     /* Clock Hold period selection */
  64
  65 /* defines for control_reg 2 */
  66 #define SEND            (0x1 << 7)      /* Send data */
  67 #define TFIE            (0x1 << 8)      /* Transmission Flag Interrupt Enable */
  68 #define WCIE            (0x1 << 9)      /* Write Complete Interrupt Enable */
  69 #define RD_STATUS_REG   (0x1 << 10)     /* reads status reg */
  70 #define WE              (0x1 << 11)     /* Write Enable */
  71
  72 #define TX_LEN_SHIFT    0
  73 #define RX_LEN_SHIFT    4
  74 #define BANK_SHIFT      12
  75
  76 /* defines for status register */
  77 #define SR_WIP          0x1     /* Write in progress */
  78 #define SR_WEL          0x2     /* Write enable latch */
  79 #define SR_BP0          0x4     /* Block protect 0 */
  80 #define SR_BP1          0x8     /* Block protect 1 */
  81 #define SR_BP2          0x10    /* Block protect 2 */
  82 #define SR_SRWD         0x80    /* SR write protect */
  83 #define TFF             0x100   /* Transfer Finished Flag */
  84 #define WCF             0x200   /* Transfer Finished Flag */
  85 #define ERF1            0x400   /* Forbidden Write Request */
  86 #define ERF2            0x800   /* Forbidden Access */
  87
  88 #define WM_SHIFT        12
  89
  90 /* flash opcodes */
  91 #define OPCODE_RDID     0x9f    /* Read JEDEC ID */
  92
  93 /* Flash Device Ids maintenance section */
  94
  95 /* data structure to maintain flash ids from different vendors */
  96 struct flash_device {
  97         char *name;
  98         u8 erase_cmd;
  99         u32 device_id;
 100         u32 pagesize;
 101         unsigned long sectorsize;
 102         unsigned long size_in_bytes;
 103 };
 104
 105 #define FLASH_ID(n, es, id, psize, ssize, size) \
 106 {                               \
 107         .name = n,              \
 108         .erase_cmd = es,        \
 109         .device_id = id,        \
 110         .pagesize = psize,      \
 111         .sectorsize = ssize,    \
 112         .size_in_bytes = size   \
 113 }
 114
 115 static struct flash_device flash_devices[] = {
 116         FLASH_ID("st m25p16"     , 0xd8, 0x00152020, 0x100, 0x10000, 0x200000),
 117         FLASH_ID("st m25p32"     , 0xd8, 0x00162020, 0x100, 0x10000, 0x400000),
 118         FLASH_ID("st m25p64"     , 0xd8, 0x00172020, 0x100, 0x10000, 0x800000),
 119         FLASH_ID("st m25p128"    , 0xd8, 0x00182020, 0x100, 0x40000, 0x1000000),
 120         FLASH_ID("st m25p05"     , 0xd8, 0x00102020, 0x80 , 0x8000 , 0x10000),
 121         FLASH_ID("st m25p10"     , 0xd8, 0x00112020, 0x80 , 0x8000 , 0x20000),
 122         FLASH_ID("st m25p20"     , 0xd8, 0x00122020, 0x100, 0x10000, 0x40000),
 123         FLASH_ID("st m25p40"     , 0xd8, 0x00132020, 0x100, 0x10000, 0x80000),
 124         FLASH_ID("st m25p80"     , 0xd8, 0x00142020, 0x100, 0x10000, 0x100000),
 125         FLASH_ID("st m45pe10"    , 0xd8, 0x00114020, 0x100, 0x10000, 0x20000),
 126         FLASH_ID("st m45pe20"    , 0xd8, 0x00124020, 0x100, 0x10000, 0x40000),
 127         FLASH_ID("st m45pe40"    , 0xd8, 0x00134020, 0x100, 0x10000, 0x80000),
 128         FLASH_ID("st m45pe80"    , 0xd8, 0x00144020, 0x100, 0x10000, 0x100000),
 129         FLASH_ID("sp s25fl004"   , 0xd8, 0x00120201, 0x100, 0x10000, 0x80000),
 130         FLASH_ID("sp s25fl008"   , 0xd8, 0x00130201, 0x100, 0x10000, 0x100000),
 131         FLASH_ID("sp s25fl016"   , 0xd8, 0x00140201, 0x100, 0x10000, 0x200000),
 132         FLASH_ID("sp s25fl032"   , 0xd8, 0x00150201, 0x100, 0x10000, 0x400000),
 133         FLASH_ID("sp s25fl064"   , 0xd8, 0x00160201, 0x100, 0x10000, 0x800000),
 134         FLASH_ID("atmel 25f512"  , 0x52, 0x0065001F, 0x80 , 0x8000 , 0x10000),
 135         FLASH_ID("atmel 25f1024" , 0x52, 0x0060001F, 0x100, 0x8000 , 0x20000),
 136         FLASH_ID("atmel 25f2048" , 0x52, 0x0063001F, 0x100, 0x10000, 0x40000),
 137         FLASH_ID("atmel 25f4096" , 0x52, 0x0064001F, 0x100, 0x10000, 0x80000),
 138         FLASH_ID("atmel 25fs040" , 0xd7, 0x0004661F, 0x100, 0x10000, 0x80000),
 139         FLASH_ID("mac 25l512"    , 0xd8, 0x001020C2, 0x010, 0x10000, 0x10000),
 140         FLASH_ID("mac 25l1005"   , 0xd8, 0x001120C2, 0x010, 0x10000, 0x20000),
 141         FLASH_ID("mac 25l2005"   , 0xd8, 0x001220C2, 0x010, 0x10000, 0x40000),
 142         FLASH_ID("mac 25l4005"   , 0xd8, 0x001320C2, 0x010, 0x10000, 0x80000),
 143         FLASH_ID("mac 25l4005a"  , 0xd8, 0x001320C2, 0x010, 0x10000, 0x80000),
 144         FLASH_ID("mac 25l8005"   , 0xd8, 0x001420C2, 0x010, 0x10000, 0x100000),
 145         FLASH_ID("mac 25l1605"   , 0xd8, 0x001520C2, 0x100, 0x10000, 0x200000),
 146         FLASH_ID("mac 25l1605a"  , 0xd8, 0x001520C2, 0x010, 0x10000, 0x200000),
 147         FLASH_ID("mac 25l3205"   , 0xd8, 0x001620C2, 0x100, 0x10000, 0x400000),
 148         FLASH_ID("mac 25l3205a"  , 0xd8, 0x001620C2, 0x100, 0x10000, 0x400000),
 149         FLASH_ID("mac 25l6405"   , 0xd8, 0x001720C2, 0x100, 0x10000, 0x800000),
 150 };
 151
 152 /* Define spear specific structures */
 153
 154 struct spear_snor_flash;
 155
 156 /**
 157  * struct spear_smi - Structure for SMI Device
 158  *
 159  * @clk: functional clock
 160  * @status: current status register of SMI.
 161  * @clk_rate: functional clock rate of SMI (default: SMI_MAX_CLOCK_FREQ)
 162  * @lock: lock to prevent parallel access of SMI.
 163  * @io_base: base address for registers of SMI.
 164  * @pdev: platform device
 165  * @cmd_complete: queue to wait for command completion of NOR-flash.
 166  * @num_flashes: number of flashes actually present on board.
 167  * @flash: separate structure for each Serial NOR-flash attached to SMI.
 168  */
 169 struct spear_smi {
 170         struct clk *clk;
 171         u32 status;
 172         unsigned long clk_rate;
 173         struct mutex lock;
 174         void __iomem *io_base;
 175         struct platform_device *pdev;
 176         wait_queue_head_t cmd_complete;
 177         u32 num_flashes;
 178         struct spear_snor_flash *flash[MAX_NUM_FLASH_CHIP];
 179 };
 180
 181 /**
 182  * struct spear_snor_flash - Structure for Serial NOR Flash
 183  *
 184  * @bank: Bank number(0, 1, 2, 3) for each NOR-flash.
 185  * @dev_id: Device ID of NOR-flash.
 186  * @lock: lock to manage flash read, write and erase operations
 187  * @mtd: MTD info for each NOR-flash.
 188  * @num_parts: Total number of partition in each bank of NOR-flash.
 189  * @parts: Partition info for each bank of NOR-flash.
 190  * @page_size: Page size of NOR-flash.
 191  * @base_addr: Base address of NOR-flash.
 192  * @erase_cmd: erase command may vary on different flash types
 193  * @fast_mode: flash supports read in fast mode
 194  */
 195 struct spear_snor_flash {
 196         u32 bank;
 197         u32 dev_id;
 198         struct mutex lock;
 199         struct mtd_info mtd;
 200         u32 num_parts;
 201         struct mtd_partition *parts;
 202         u32 page_size;
 203         void __iomem *base_addr;
 204         u8 erase_cmd;
 205         u8 fast_mode;
 206 };
 207
 208 static inline struct spear_snor_flash *get_flash_data(struct mtd_info *mtd)
 209 {
 210         return container_of(mtd, struct spear_snor_flash, mtd);
 211 }
 212
 213 /**
 214  * spear_smi_read_sr - Read status register of flash through SMI
 215  * @dev: structure of SMI information.
 216  * @bank: bank to which flash is connected
 217  *
 218  * This routine will return the status register of the flash chip present at the
 219  * given bank.
 220  */
 221 static int spear_smi_read_sr(struct spear_smi *dev, u32 bank)
 222 {
 223         int ret;
 224         u32 ctrlreg1;
 225
 226         mutex_lock(&dev->lock);
 227         dev->status = 0; /* Will be set in interrupt handler */
 228
 229         ctrlreg1 = readl(dev->io_base + SMI_CR1);
 230         /* program smi in hw mode */
 231         writel(ctrlreg1 & ~(SW_MODE | WB_MODE), dev->io_base + SMI_CR1);
 232
 233         /* performing a rsr instruction in hw mode */
 234         writel((bank << BANK_SHIFT) | RD_STATUS_REG | TFIE,
 235                         dev->io_base + SMI_CR2);
 236
 237         /* wait for tff */
 238         ret = wait_event_interruptible_timeout(dev->cmd_complete,
 239                         dev->status & TFF, SMI_CMD_TIMEOUT);
 240
 241         /* copy dev->status (lower 16 bits) in order to release lock */
 242         if (ret > 0)
 243                 ret = dev->status & 0xffff;
 244         else if (ret == 0)
 245                 ret = -ETIMEDOUT;
 246
 247         /* restore the ctrl regs state */
 248         writel(ctrlreg1, dev->io_base + SMI_CR1);
 249         writel(0, dev->io_base + SMI_CR2);
 250         mutex_unlock(&dev->lock);
 251
 252         return ret;
 253 }
 254
 255 /**
 256  * spear_smi_wait_till_ready - wait till flash is ready
 257  * @dev: structure of SMI information.
 258  * @bank: flash corresponding to this bank
 259  * @timeout: timeout for busy wait condition
 260  *
 261  * This routine checks for WIP (write in progress) bit in Status register
 262  * If successful the routine returns 0 else -EBUSY
 263  */
 264 static int spear_smi_wait_till_ready(struct spear_smi *dev, u32 bank,
 265                 unsigned long timeout)
 266 {
 267         unsigned long finish;
 268         int status;
 269
 270         finish = jiffies + timeout;
 271         do {
 272                 status = spear_smi_read_sr(dev, bank);
 273                 if (status < 0) {
 274                         if (status == -ETIMEDOUT)
 275                                 continue; /* try till finish */
 276                         return status;
 277                 } else if (!(status & SR_WIP)) {
 278                         return 0;
 279                 }
 280
 281                 cond_resched();
 282         } while (!time_after_eq(jiffies, finish));
 283
 284         dev_err(&dev->pdev->dev, "smi controller is busy, timeout\n");
 285         return -EBUSY;
 286 }
 287
 288 /**
 289  * spear_smi_int_handler - SMI Interrupt Handler.
 290  * @irq: irq number
 291  * @dev_id: structure of SMI device, embedded in dev_id.
 292  *
 293  * The handler clears all interrupt conditions and records the status in
 294  * dev->status which is used by the driver later.
 295  */
 296 static irqreturn_t spear_smi_int_handler(int irq, void *dev_id)
 297 {
 298         u32 status = 0;
 299         struct spear_smi *dev = dev_id;
 300
 301         status = readl(dev->io_base + SMI_SR);
 302
 303         if (unlikely(!status))
 304                 return IRQ_NONE;
 305
 306         /* clear all interrupt conditions */
 307         writel(0, dev->io_base + SMI_SR);
 308
 309         /* copy the status register in dev->status */
 310         dev->status |= status;
 311
 312         /* send the completion */
 313         wake_up_interruptible(&dev->cmd_complete);
 314
 315         return IRQ_HANDLED;
 316 }
 317
 318 /**
 319  * spear_smi_hw_init - initializes the smi controller.
 320  * @dev: structure of smi device
 321  *
 322  * this routine initializes the smi controller wit the default values
 323  */
 324 static void spear_smi_hw_init(struct spear_smi *dev)
 325 {
 326         unsigned long rate = 0;
 327         u32 prescale = 0;
 328         u32 val;
 329
 330         rate = clk_get_rate(dev->clk);
 331
 332         /* functional clock of smi */
 333         prescale = DIV_ROUND_UP(rate, dev->clk_rate);
 334
 335         /*
 336          * setting the standard values, fast mode, prescaler for
 337          * SMI_MAX_CLOCK_FREQ (50MHz) operation and bank enable
 338          */
 339         val = HOLD1 | BANK_EN | DSEL_TIME | (prescale << 8);
 340
 341         mutex_lock(&dev->lock);
 342         /* clear all interrupt conditions */
 343         writel(0, dev->io_base + SMI_SR);
 344
 345         writel(val, dev->io_base + SMI_CR1);
 346         mutex_unlock(&dev->lock);
 347 }
 348
 349 /**
 350  * get_flash_index - match chip id from a flash list.
 351  * @flash_id: a valid nor flash chip id obtained from board.
 352  *
 353  * try to validate the chip id by matching from a list, if not found then simply
 354  * returns negative. In case of success returns index in to the flash devices
 355  * array.
 356  */
 357 static int get_flash_index(u32 flash_id)
 358 {
 359         int index;
 360
 361         /* Matches chip-id to entire list of 'serial-nor flash' ids */
 362         for (index = 0; index < ARRAY_SIZE(flash_devices); index++) {
 363                 if (flash_devices[index].device_id == flash_id)
 364                         return index;
 365         }
 366
 367         /* Memory chip is not listed and not supported */
 368         return -ENODEV;
 369 }
 370
 371 /**
 372  * spear_smi_write_enable - Enable the flash to do write operation
 373  * @dev: structure of SMI device
 374  * @bank: enable write for flash connected to this bank
 375  *
 376  * Set write enable latch with Write Enable command.
 377  * Returns 0 on success.
 378  */
 379 static int spear_smi_write_enable(struct spear_smi *dev, u32 bank)
 380 {
 381         int ret;
 382         u32 ctrlreg1;
 383
 384         mutex_lock(&dev->lock);
 385         dev->status = 0; /* Will be set in interrupt handler */
 386
 387         ctrlreg1 = readl(dev->io_base + SMI_CR1);
 388         /* program smi in h/w mode */
 389         writel(ctrlreg1 & ~SW_MODE, dev->io_base + SMI_CR1);
 390
 391         /* give the flash, write enable command */
 392         writel((bank << BANK_SHIFT) | WE | TFIE, dev->io_base + SMI_CR2);
 393
 394         ret = wait_event_interruptible_timeout(dev->cmd_complete,
 395                         dev->status & TFF, SMI_CMD_TIMEOUT);
 396
 397         /* restore the ctrl regs state */
 398         writel(ctrlreg1, dev->io_base + SMI_CR1);
 399         writel(0, dev->io_base + SMI_CR2);
 400
 401         if (ret == 0) {
 402                 ret = -EIO;
 403                 dev_err(&dev->pdev->dev,
 404                         "smi controller failed on write enable\n");
 405         } else if (ret > 0) {
 406                 /* check whether write mode status is set for required bank */
 407                 if (dev->status & (1 << (bank + WM_SHIFT)))
 408                         ret = 0;
 409                 else {
 410                         dev_err(&dev->pdev->dev, "couldn't enable write\n");
 411                         ret = -EIO;
 412                 }
 413         }
 414
 415         mutex_unlock(&dev->lock);
 416         return ret;
 417 }
 418
 419 static inline u32
 420 get_sector_erase_cmd(struct spear_snor_flash *flash, u32 offset)
 421 {
 422         u32 cmd;
 423         u8 *x = (u8 *)&cmd;
 424
 425         x[0] = flash->erase_cmd;
 426         x[1] = offset >> 16;
 427         x[2] = offset >> 8;
 428         x[3] = offset;
 429
 430         return cmd;
 431 }
 432
 433 /**
 434  * spear_smi_erase_sector - erase one sector of flash
 435  * @dev: structure of SMI information
 436  * @command: erase command to be send
 437  * @bank: bank to which this command needs to be send
 438  * @bytes: size of command
 439  *
 440  * Erase one sector of flash memory at offset ``offset'' which is any
 441  * address within the sector which should be erased.
 442  * Returns 0 if successful, non-zero otherwise.
 443  */
 444 static int spear_smi_erase_sector(struct spear_smi *dev,
 445                 u32 bank, u32 command, u32 bytes)
 446 {
 447         u32 ctrlreg1 = 0;
 448         int ret;
 449
 450         ret = spear_smi_wait_till_ready(dev, bank, SMI_MAX_TIME_OUT);
 451         if (ret)
 452                 return ret;
 453
 454         ret = spear_smi_write_enable(dev, bank);
 455         if (ret)
 456                 return ret;
 457
 458         mutex_lock(&dev->lock);
 459
 460         ctrlreg1 = readl(dev->io_base + SMI_CR1);
 461         writel((ctrlreg1 | SW_MODE) & ~WB_MODE, dev->io_base + SMI_CR1);
 462
 463         /* send command in sw mode */
 464         writel(command, dev->io_base + SMI_TR);
 465
 466         writel((bank << BANK_SHIFT) | SEND | TFIE | (bytes << TX_LEN_SHIFT),
 467                         dev->io_base + SMI_CR2);
 468
 469         ret = wait_event_interruptible_timeout(dev->cmd_complete,
 470                         dev->status & TFF, SMI_CMD_TIMEOUT);
 471
 472         if (ret == 0) {
 473                 ret = -EIO;
 474                 dev_err(&dev->pdev->dev, "sector erase failed\n");
 475         } else if (ret > 0)
 476                 ret = 0; /* success */
 477
 478         /* restore ctrl regs */
 479         writel(ctrlreg1, dev->io_base + SMI_CR1);
 480         writel(0, dev->io_base + SMI_CR2);
 481
 482         mutex_unlock(&dev->lock);
 483         return ret;
 484 }
 485
 486 /**
 487  * spear_mtd_erase - perform flash erase operation as requested by user
 488  * @mtd: Provides the memory characteristics
 489  * @e_info: Provides the erase information
 490  *
 491  * Erase an address range on the flash chip. The address range may extend
 492  * one or more erase sectors. Return an error is there is a problem erasing.
 493  */
 494 static int spear_mtd_erase(struct mtd_info *mtd, struct erase_info *e_info)
 495 {
 496         struct spear_snor_flash *flash = get_flash_data(mtd);
 497         struct spear_smi *dev = mtd->priv;
 498         u32 addr, command, bank;
 499         int len, ret;
 500
 501         if (!flash || !dev)
 502                 return -ENODEV;
 503
 504         bank = flash->bank;
 505         if (bank > dev->num_flashes - 1) {
 506                 dev_err(&dev->pdev->dev, "Invalid Bank Num");
 507                 return -EINVAL;
 508         }
 509
 510         addr = e_info->addr;
 511         len = e_info->len;
 512
 513         mutex_lock(&flash->lock);
 514
 515         /* now erase sectors in loop */
 516         while (len) {
 517                 command = get_sector_erase_cmd(flash, addr);
 518                 /* preparing the command for flash */
 519                 ret = spear_smi_erase_sector(dev, bank, command, 4);
 520                 if (ret) {
 521                         e_info->state = MTD_ERASE_FAILED;
 522                         mutex_unlock(&flash->lock);
 523                         return ret;
 524                 }
 525                 addr += mtd->erasesize;
 526                 len -= mtd->erasesize;
 527         }
 528
 529         mutex_unlock(&flash->lock);
 530         e_info->state = MTD_ERASE_DONE;
 531         mtd_erase_callback(e_info);
 532
 533         return 0;
 534 }
 535
 536 /**
 537  * spear_mtd_read - performs flash read operation as requested by the user
 538  * @mtd: MTD information of the memory bank
 539  * @from: Address from which to start read
 540  * @len: Number of bytes to be read
 541  * @retlen: Fills the Number of bytes actually read
 542  * @buf: Fills this after reading
 543  *
 544  * Read an address range from the flash chip. The address range
 545  * may be any size provided it is within the physical boundaries.
 546  * Returns 0 on success, non zero otherwise
 547  */
 548 static int spear_mtd_read(struct mtd_info *mtd, loff_t from, size_t len,
 549                 size_t *retlen, u8 *buf)
 550 {
 551         struct spear_snor_flash *flash = get_flash_data(mtd);
 552         struct spear_smi *dev = mtd->priv;
 553         void __iomem *src;
 554         u32 ctrlreg1, val;
 555         int ret;
 556
 557         if (!flash || !dev)
 558                 return -ENODEV;
 559
 560         if (flash->bank > dev->num_flashes - 1) {
 561                 dev_err(&dev->pdev->dev, "Invalid Bank Num");
 562                 return -EINVAL;
 563         }
 564
 565         /* select address as per bank number */
 566         src = flash->base_addr + from;
 567
 568         mutex_lock(&flash->lock);
 569
 570         /* wait till previous write/erase is done. */
 571         ret = spear_smi_wait_till_ready(dev, flash->bank, SMI_MAX_TIME_OUT);
 572         if (ret) {
 573                 mutex_unlock(&flash->lock);
 574                 return ret;
 575         }
 576
 577         mutex_lock(&dev->lock);
 578         /* put smi in hw mode not wbt mode */
 579         ctrlreg1 = val = readl(dev->io_base + SMI_CR1);
 580         val &= ~(SW_MODE | WB_MODE);
 581         if (flash->fast_mode)
 582                 val |= FAST_MODE;
 583
 584         writel(val, dev->io_base + SMI_CR1);
 585
 586         memcpy_fromio(buf, src, len);
 587
 588         /* restore ctrl reg1 */
 589         writel(ctrlreg1, dev->io_base + SMI_CR1);
 590         mutex_unlock(&dev->lock);
 591
 592         *retlen = len;
 593         mutex_unlock(&flash->lock);
 594
 595         return 0;
 596 }
 597
 598 /*
 599  * The purpose of this function is to ensure a memcpy_toio() with byte writes
 600  * only. Its structure is inspired from the ARM implementation of _memcpy_toio()
 601  * which also does single byte writes but cannot be used here as this is just an
 602  * implementation detail and not part of the API. Not mentioning the comment
 603  * stating that _memcpy_toio() should be optimized.
 604  */
 605 static void spear_smi_memcpy_toio_b(volatile void __iomem *dest,
 606                                     const void *src, size_t len)
 607 {
 608         const unsigned char *from = src;
 609
 610         while (len) {
 611                 len--;
 612                 writeb(*from, dest);
 613                 from++;
 614                 dest++;
 615         }
 616 }
 617
 618 static inline int spear_smi_cpy_toio(struct spear_smi *dev, u32 bank,
 619                 void __iomem *dest, const void *src, size_t len)
 620 {
 621         int ret;
 622         u32 ctrlreg1;
 623
 624         /* wait until finished previous write command. */
 625         ret = spear_smi_wait_till_ready(dev, bank, SMI_MAX_TIME_OUT);
 626         if (ret)
 627                 return ret;
 628
 629         /* put smi in write enable */
 630         ret = spear_smi_write_enable(dev, bank);
 631         if (ret)
 632                 return ret;
 633
 634         /* put smi in hw, write burst mode */
 635         mutex_lock(&dev->lock);
 636
 637         ctrlreg1 = readl(dev->io_base + SMI_CR1);
 638         writel((ctrlreg1 | WB_MODE) & ~SW_MODE, dev->io_base + SMI_CR1);
 639
 640         /*
 641          * In Write Burst mode (WB_MODE), the specs states that writes must be:
 642          * - incremental
 643          * - of the same size
 644          * The ARM implementation of memcpy_toio() will optimize the number of
 645          * I/O by using as much 4-byte writes as possible, surrounded by
 646          * 2-byte/1-byte access if:
 647          * - the destination is not 4-byte aligned
 648          * - the length is not a multiple of 4-byte.
 649          * Avoid this alternance of write access size by using our own 'byte
 650          * access' helper if at least one of the two conditions above is true.
 651          */
 652         if (IS_ALIGNED(len, sizeof(u32)) &&
 653             IS_ALIGNED((uintptr_t)dest, sizeof(u32)))
 654                 memcpy_toio(dest, src, len);
 655         else
 656                 spear_smi_memcpy_toio_b(dest, src, len);
 657
 658         writel(ctrlreg1, dev->io_base + SMI_CR1);
 659
 660         mutex_unlock(&dev->lock);
 661         return 0;
 662 }
 663
 664 /**
 665  * spear_mtd_write - performs write operation as requested by the user.
 666  * @mtd: MTD information of the memory bank.
 667  * @to: Address to write.
 668  * @len: Number of bytes to be written.
 669  * @retlen: Number of bytes actually wrote.
 670  * @buf: Buffer from which the data to be taken.
 671  *
 672  * Write an address range to the flash chip. Data must be written in
 673  * flash_page_size chunks. The address range may be any size provided
 674  * it is within the physical boundaries.
 675  * Returns 0 on success, non zero otherwise
 676  */
 677 static int spear_mtd_write(struct mtd_info *mtd, loff_t to, size_t len,
 678                 size_t *retlen, const u8 *buf)
 679 {
 680         struct spear_snor_flash *flash = get_flash_data(mtd);
 681         struct spear_smi *dev = mtd->priv;
 682         void __iomem *dest;
 683         u32 page_offset, page_size;
 684         int ret;
 685
 686         if (!flash || !dev)
 687                 return -ENODEV;
 688
 689         if (flash->bank > dev->num_flashes - 1) {
 690                 dev_err(&dev->pdev->dev, "Invalid Bank Num");
 691                 return -EINVAL;
 692         }
 693
 694         /* select address as per bank number */
 695         dest = flash->base_addr + to;
 696         mutex_lock(&flash->lock);
 697
 698         page_offset = (u32)to % flash->page_size;
 699
 700         /* do if all the bytes fit onto one page */
 701         if (page_offset + len <= flash->page_size) {
 702                 ret = spear_smi_cpy_toio(dev, flash->bank, dest, buf, len);
 703                 if (!ret)
 704                         *retlen += len;
 705         } else {
 706                 u32 i;
 707
 708                 /* the size of data remaining on the first page */
 709                 page_size = flash->page_size - page_offset;
 710
 711                 ret = spear_smi_cpy_toio(dev, flash->bank, dest, buf,
 712                                 page_size);
 713                 if (ret)
 714                         goto err_write;
 715                 else
 716                         *retlen += page_size;
 717
 718                 /* write everything in pagesize chunks */
 719                 for (i = page_size; i < len; i += page_size) {
 720                         page_size = len - i;
 721                         if (page_size > flash->page_size)
 722                                 page_size = flash->page_size;
 723
 724                         ret = spear_smi_cpy_toio(dev, flash->bank, dest + i,
 725                                         buf + i, page_size);
 726                         if (ret)
 727                                 break;
 728                         else
 729                                 *retlen += page_size;
 730                 }
 731         }
 732
 733 err_write:
 734         mutex_unlock(&flash->lock);
 735
 736         return ret;
 737 }
 738
 739 /**
 740  * spear_smi_probe_flash - Detects the NOR Flash chip.
 741  * @dev: structure of SMI information.
 742  * @bank: bank on which flash must be probed
 743  *
 744  * This routine will check whether there exists a flash chip on a given memory
 745  * bank ID.
 746  * Return index of the probed flash in flash devices structure
 747  */
 748 static int spear_smi_probe_flash(struct spear_smi *dev, u32 bank)
 749 {
 750         int ret;
 751         u32 val = 0;
 752
 753         ret = spear_smi_wait_till_ready(dev, bank, SMI_PROBE_TIMEOUT);
 754         if (ret)
 755                 return ret;
 756
 757         mutex_lock(&dev->lock);
 758
 759         dev->status = 0; /* Will be set in interrupt handler */
 760         /* put smi in sw mode */
 761         val = readl(dev->io_base + SMI_CR1);
 762         writel(val | SW_MODE, dev->io_base + SMI_CR1);
 763
 764         /* send readid command in sw mode */
 765         writel(OPCODE_RDID, dev->io_base + SMI_TR);
 766
 767         val = (bank << BANK_SHIFT) | SEND | (1 << TX_LEN_SHIFT) |
 768                 (3 << RX_LEN_SHIFT) | TFIE;
 769         writel(val, dev->io_base + SMI_CR2);
 770
 771         /* wait for TFF */
 772         ret = wait_event_interruptible_timeout(dev->cmd_complete,
 773                         dev->status & TFF, SMI_CMD_TIMEOUT);
 774         if (ret <= 0) {
 775                 ret = -ENODEV;
 776                 goto err_probe;
 777         }
 778
 779         /* get memory chip id */
 780         val = readl(dev->io_base + SMI_RR);
 781         val &= 0x00ffffff;
 782         ret = get_flash_index(val);
 783
 784 err_probe:
 785         /* clear sw mode */
 786         val = readl(dev->io_base + SMI_CR1);
 787         writel(val & ~SW_MODE, dev->io_base + SMI_CR1);
 788
 789         mutex_unlock(&dev->lock);
 790         return ret;
 791 }
 792
 793
 794 #ifdef CONFIG_OF
 795 static int spear_smi_probe_config_dt(struct platform_device *pdev,
 796                                      struct device_node *np)
 797 {
 798         struct spear_smi_plat_data *pdata = dev_get_platdata(&pdev->dev);
 799         struct device_node *pp = NULL;
 800         const __be32 *addr;
 801         u32 val;
 802         int len;
 803         int i = 0;
 804
 805         if (!np)
 806                 return -ENODEV;
 807
 808         of_property_read_u32(np, "clock-rate", &val);
 809         pdata->clk_rate = val;
 810
 811         pdata->board_flash_info = devm_kzalloc(&pdev->dev,
 812                                                sizeof(*pdata->board_flash_info),
 813                                                GFP_KERNEL);
 814
 815         /* Fill structs for each subnode (flash device) */
 816         while ((pp = of_get_next_child(np, pp))) {
 817                 struct spear_smi_flash_info *flash_info;
 818
 819                 flash_info = &pdata->board_flash_info[i];
 820                 pdata->np[i] = pp;
 821
 822                 /* Read base-addr and size from DT */
 823                 addr = of_get_property(pp, "reg", &len);
 824                 pdata->board_flash_info->mem_base = be32_to_cpup(&addr[0]);
 825                 pdata->board_flash_info->size = be32_to_cpup(&addr[1]);
 826
 827                 if (of_get_property(pp, "st,smi-fast-mode", NULL))
 828                         pdata->board_flash_info->fast_mode = 1;
 829
 830                 i++;
 831         }
 832
 833         pdata->num_flashes = i;
 834
 835         return 0;
 836 }
 837 #else
 838 static int spear_smi_probe_config_dt(struct platform_device *pdev,
 839                                      struct device_node *np)
 840 {
 841         return -ENOSYS;
 842 }
 843 #endif
 844
 845 static int spear_smi_setup_banks(struct platform_device *pdev,
 846                                  u32 bank, struct device_node *np)
 847 {
 848         struct spear_smi *dev = platform_get_drvdata(pdev);
 849         struct mtd_part_parser_data ppdata = {};
 850         struct spear_smi_flash_info *flash_info;
 851         struct spear_smi_plat_data *pdata;
 852         struct spear_snor_flash *flash;
 853         struct mtd_partition *parts = NULL;
 854         int count = 0;
 855         int flash_index;
 856         int ret = 0;
 857
 858         pdata = dev_get_platdata(&pdev->dev);
 859         if (bank > pdata->num_flashes - 1)
 860                 return -EINVAL;
 861
 862         flash_info = &pdata->board_flash_info[bank];
 863         if (!flash_info)
 864                 return -ENODEV;
 865
 866         flash = devm_kzalloc(&pdev->dev, sizeof(*flash), GFP_ATOMIC);
 867         if (!flash)
 868                 return -ENOMEM;
 869         flash->bank = bank;
 870         flash->fast_mode = flash_info->fast_mode ? 1 : 0;
 871         mutex_init(&flash->lock);
 872
 873         /* verify whether nor flash is really present on board */
 874         flash_index = spear_smi_probe_flash(dev, bank);
 875         if (flash_index < 0) {
 876                 dev_info(&dev->pdev->dev, "smi-nor%d not found\n", bank);
 877                 return flash_index;
 878         }
 879         /* map the memory for nor flash chip */
 880         flash->base_addr = devm_ioremap(&pdev->dev, flash_info->mem_base,
 881                                         flash_info->size);
 882         if (!flash->base_addr)
 883                 return -EIO;
 884
 885         dev->flash[bank] = flash;
 886         flash->mtd.priv = dev;
 887
 888         if (flash_info->name)
 889                 flash->mtd.name = flash_info->name;
 890         else
 891                 flash->mtd.name = flash_devices[flash_index].name;
 892
 893         flash->mtd.dev.parent = &pdev->dev;
 894         flash->mtd.type = MTD_NORFLASH;
 895         flash->mtd.writesize = 1;
 896         flash->mtd.flags = MTD_CAP_NORFLASH;
 897         flash->mtd.size = flash_info->size;
 898         flash->mtd.erasesize = flash_devices[flash_index].sectorsize;
 899         flash->page_size = flash_devices[flash_index].pagesize;
 900         flash->mtd.writebufsize = flash->page_size;
 901         flash->erase_cmd = flash_devices[flash_index].erase_cmd;
 902         flash->mtd._erase = spear_mtd_erase;
 903         flash->mtd._read = spear_mtd_read;
 904         flash->mtd._write = spear_mtd_write;
 905         flash->dev_id = flash_devices[flash_index].device_id;
 906
 907         dev_info(&dev->pdev->dev, "mtd .name=%s .size=%llx(%lluM)\n",
 908                         flash->mtd.name, flash->mtd.size,
 909                         flash->mtd.size / (1024 * 1024));
 910
 911         dev_info(&dev->pdev->dev, ".erasesize = 0x%x(%uK)\n",
 912                         flash->mtd.erasesize, flash->mtd.erasesize / 1024);
 913
 914 #ifndef CONFIG_OF
 915         if (flash_info->partitions) {
 916                 parts = flash_info->partitions;
 917                 count = flash_info->nr_partitions;
 918         }
 919 #endif
 920         ppdata.of_node = np;
 921
 922         ret = mtd_device_parse_register(&flash->mtd, NULL, &ppdata, parts,
 923                                         count);
 924         if (ret) {
 925                 dev_err(&dev->pdev->dev, "Err MTD partition=%d\n", ret);
 926                 return ret;
 927         }
 928
 929         return 0;
 930 }
 931
 932 /**
 933  * spear_smi_probe - Entry routine
 934  * @pdev: platform device structure
 935  *
 936  * This is the first routine which gets invoked during booting and does all
 937  * initialization/allocation work. The routine looks for available memory banks,
 938  * and do proper init for any found one.
 939  * Returns 0 on success, non zero otherwise
 940  */
 941 static int spear_smi_probe(struct platform_device *pdev)
 942 {
 943         struct device_node *np = pdev->dev.of_node;
 944         struct spear_smi_plat_data *pdata = NULL;
 945         struct spear_smi *dev;
 946         struct resource *smi_base;
 947         int irq, ret = 0;
 948         int i;
 949
 950         if (np) {
 951                 pdata = devm_kzalloc(&pdev->dev, sizeof(*pdata), GFP_KERNEL);
 952                 if (!pdata) {
 953                         ret = -ENOMEM;
 954                         goto err;
 955                 }
 956                 pdev->dev.platform_data = pdata;
 957                 ret = spear_smi_probe_config_dt(pdev, np);
 958                 if (ret) {
 959                         ret = -ENODEV;
 960                         dev_err(&pdev->dev, "no platform data\n");
 961                         goto err;
 962                 }
 963         } else {
 964                 pdata = dev_get_platdata(&pdev->dev);
 965                 if (!pdata) {
 966                         ret = -ENODEV;
 967                         dev_err(&pdev->dev, "no platform data\n");
 968                         goto err;
 969                 }
 970         }
 971
 972         irq = platform_get_irq(pdev, 0);
 973         if (irq < 0) {
 974                 ret = -ENODEV;
 975                 dev_err(&pdev->dev, "invalid smi irq\n");
 976                 goto err;
 977         }
 978
 979         dev = devm_kzalloc(&pdev->dev, sizeof(*dev), GFP_ATOMIC);
 980         if (!dev) {
 981                 ret = -ENOMEM;
 982                 goto err;
 983         }
 984
 985         smi_base = platform_get_resource(pdev, IORESOURCE_MEM, 0);
 986
 987         dev->io_base = devm_ioremap_resource(&pdev->dev, smi_base);
 988         if (IS_ERR(dev->io_base)) {
 989                 ret = PTR_ERR(dev->io_base);
 990                 goto err;
 991         }
 992
 993         dev->pdev = pdev;
 994         dev->clk_rate = pdata->clk_rate;
 995
 996         if (dev->clk_rate > SMI_MAX_CLOCK_FREQ)
 997                 dev->clk_rate = SMI_MAX_CLOCK_FREQ;
 998
 999         dev->num_flashes = pdata->num_flashes;
1000
1001         if (dev->num_flashes > MAX_NUM_FLASH_CHIP) {
1002                 dev_err(&pdev->dev, "exceeding max number of flashes\n");
1003                 dev->num_flashes = MAX_NUM_FLASH_CHIP;
1004         }
1005
1006         dev->clk = devm_clk_get(&pdev->dev, NULL);
1007         if (IS_ERR(dev->clk)) {
1008                 ret = PTR_ERR(dev->clk);
1009                 goto err;
1010         }
1011
1012         ret = clk_prepare_enable(dev->clk);
1013         if (ret)
1014                 goto err;
1015
1016         ret = devm_request_irq(&pdev->dev, irq, spear_smi_int_handler, 0,
1017                                pdev->name, dev);
1018         if (ret) {
1019                 dev_err(&dev->pdev->dev, "SMI IRQ allocation failed\n");
1020                 goto err_irq;
1021         }
1022
1023         mutex_init(&dev->lock);
1024         init_waitqueue_head(&dev->cmd_complete);
1025         spear_smi_hw_init(dev);
1026         platform_set_drvdata(pdev, dev);
1027
1028         /* loop for each serial nor-flash which is connected to smi */
1029         for (i = 0; i < dev->num_flashes; i++) {
1030                 ret = spear_smi_setup_banks(pdev, i, pdata->np[i]);
1031                 if (ret) {
1032                         dev_err(&dev->pdev->dev, "bank setup failed\n");
1033                         goto err_irq;
1034                 }
1035         }
1036
1037         return 0;
1038
1039 err_irq:
1040         clk_disable_unprepare(dev->clk);
1041 err:
1042         return ret;
1043 }
1044
1045 /**
1046  * spear_smi_remove - Exit routine
1047  * @pdev: platform device structure
1048  *
1049  * free all allocations and delete the partitions.
1050  */
1051 static int spear_smi_remove(struct platform_device *pdev)
1052 {
1053         struct spear_smi *dev;
1054         struct spear_snor_flash *flash;
1055         int ret, i;
1056
1057         dev = platform_get_drvdata(pdev);
1058         if (!dev) {
1059                 dev_err(&pdev->dev, "dev is null\n");
1060                 return -ENODEV;
1061         }
1062
1063         /* clean up for all nor flash */
1064         for (i = 0; i < dev->num_flashes; i++) {
1065                 flash = dev->flash[i];
1066                 if (!flash)
1067                         continue;
1068
1069                 /* clean up mtd stuff */
1070                 ret = mtd_device_unregister(&flash->mtd);
1071                 if (ret)
1072                         dev_err(&pdev->dev, "error removing mtd\n");
1073         }
1074
1075         clk_disable_unprepare(dev->clk);
1076
1077         return 0;
1078 }
1079
1080 #ifdef CONFIG_PM_SLEEP
1081 static int spear_smi_suspend(struct device *dev)
1082 {
1083         struct spear_smi *sdev = dev_get_drvdata(dev);
1084
1085         if (sdev && sdev->clk)
1086                 clk_disable_unprepare(sdev->clk);
1087
1088         return 0;
1089 }
1090
1091 static int spear_smi_resume(struct device *dev)
1092 {
1093         struct spear_smi *sdev = dev_get_drvdata(dev);
1094         int ret = -EPERM;
1095
1096         if (sdev && sdev->clk)
1097                 ret = clk_prepare_enable(sdev->clk);
1098
1099         if (!ret)
1100                 spear_smi_hw_init(sdev);
1101         return ret;
1102 }
1103 #endif
1104
1105 static SIMPLE_DEV_PM_OPS(spear_smi_pm_ops, spear_smi_suspend, spear_smi_resume);
1106
1107 #ifdef CONFIG_OF
1108 static const struct of_device_id spear_smi_id_table[] = {
1109         { .compatible = "st,spear600-smi" },
1110         {}
1111 };
1112 MODULE_DEVICE_TABLE(of, spear_smi_id_table);
1113 #endif
1114
1115 static struct platform_driver spear_smi_driver = {
1116         .driver = {
1117                 .name = "smi",
1118                 .bus = &platform_bus_type,
1119                 .of_match_table = of_match_ptr(spear_smi_id_table),
1120                 .pm = &spear_smi_pm_ops,
1121         },
1122         .probe = spear_smi_probe,
1123         .remove = spear_smi_remove,
1124 };
1125 module_platform_driver(spear_smi_driver);
1126
1127 MODULE_LICENSE("GPL");
1128 MODULE_AUTHOR("Ashish Priyadarshi, Shiraz Hashim <shiraz.linux.kernel@gmail.com>");
1129 MODULE_DESCRIPTION("MTD SMI driver for serial nor flash chips");