sys/dev/flash/mx25l.c

   1 /*-
   2  * Copyright (c) 2006 M. Warner Losh.  All rights reserved.
   3  * Copyright (c) 2009 Oleksandr Tymoshenko.  All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  *
  14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  15  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  16  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  17  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  18  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  19  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  20  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  21  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  23  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  24  */
  25
  26 #include <sys/cdefs.h>
  27 __FBSDID("$FreeBSD$");
  28
  29 #include <sys/param.h>
  30 #include <sys/systm.h>
  31 #include <sys/bio.h>
  32 #include <sys/bus.h>
  33 #include <sys/conf.h>
  34 #include <sys/kernel.h>
  35 #include <sys/kthread.h>
  36 #include <sys/lock.h>
  37 #include <sys/mbuf.h>
  38 #include <sys/malloc.h>
  39 #include <sys/module.h>
  40 #include <sys/mutex.h>
  41 #include <geom/geom_disk.h>
  42
  43 #include <dev/spibus/spi.h>
  44 #include "spibus_if.h"
  45
  46 #include <dev/flash/mx25lreg.h>
  47
  48 #define FL_NONE                 0x00
  49 #define FL_ERASE_4K             0x01
  50 #define FL_ERASE_32K            0x02
  51
  52 /*
  53  * Define the sectorsize to be a smaller size rather than the flash
  54  * sector size. Trying to run FFS off of a 64k flash sector size
  55  * results in a completely un-usable system.
  56  */
  57 #define MX25L_SECTORSIZE        512
  58
  59 struct mx25l_flash_ident
  60 {
  61         const char      *name;
  62         uint8_t         manufacturer_id;
  63         uint16_t        device_id;
  64         unsigned int    sectorsize;
  65         unsigned int    sectorcount;
  66         unsigned int    flags;
  67 };
  68
  69 struct mx25l_softc
  70 {
  71         device_t        sc_dev;
  72         uint8_t         sc_manufacturer_id;
  73         uint16_t        sc_device_id;
  74         unsigned int    sc_sectorsize;
  75         struct mtx      sc_mtx;
  76         struct disk     *sc_disk;
  77         struct proc     *sc_p;
  78         struct bio_queue_head sc_bio_queue;
  79         unsigned int    sc_flags;
  80 };
  81
  82 #define M25PXX_LOCK(_sc)                mtx_lock(&(_sc)->sc_mtx)
  83 #define M25PXX_UNLOCK(_sc)              mtx_unlock(&(_sc)->sc_mtx)
  84 #define M25PXX_LOCK_INIT(_sc) \
  85         mtx_init(&_sc->sc_mtx, device_get_nameunit(_sc->sc_dev), \
  86             "mx25l", MTX_DEF)
  87 #define M25PXX_LOCK_DESTROY(_sc)        mtx_destroy(&_sc->sc_mtx);
  88 #define M25PXX_ASSERT_LOCKED(_sc)       mtx_assert(&_sc->sc_mtx, MA_OWNED);
  89 #define M25PXX_ASSERT_UNLOCKED(_sc) mtx_assert(&_sc->sc_mtx, MA_NOTOWNED);
  90
  91 /* disk routines */
  92 static int mx25l_open(struct disk *dp);
  93 static int mx25l_close(struct disk *dp);
  94 static int mx25l_ioctl(struct disk *, u_long, void *, int, struct thread *);
  95 static void mx25l_strategy(struct bio *bp);
  96 static void mx25l_task(void *arg);
  97
  98 struct mx25l_flash_ident flash_devices[] = {
  99         { "en25f32",    0x1c, 0x3116, 64 * 1024, 64, FL_NONE },
 100         { "en25p32",    0x1c, 0x2016, 64 * 1024, 64, FL_NONE },
 101         { "en25p64",    0x1c, 0x2017, 64 * 1024, 128, FL_NONE },
 102         { "en25q64",    0x1c, 0x3017, 64 * 1024, 128, FL_ERASE_4K },
 103         { "m25p64",     0x20, 0x2017, 64 * 1024, 128, FL_NONE },
 104         { "mx25ll32",   0xc2, 0x2016, 64 * 1024, 64, FL_NONE },
 105         { "mx25ll64",   0xc2, 0x2017, 64 * 1024, 128, FL_NONE },
 106         { "mx25ll128",  0xc2, 0x2018, 64 * 1024, 256, FL_ERASE_4K | FL_ERASE_32K },
 107         { "s25fl032",   0x01, 0x0215, 64 * 1024, 64, FL_NONE },
 108         { "s25fl064",   0x01, 0x0216, 64 * 1024, 128, FL_NONE },
 109         { "s25fl128",   0x01, 0x2018, 64 * 1024, 256, FL_NONE },
 110         { "SST25VF032B", 0xbf, 0x254a, 64 * 1024, 64, FL_ERASE_4K | FL_ERASE_32K },
 111
 112         /* Winbond -- w25x "blocks" are 64K, "sectors" are 4KiB */
 113         { "w25x32",     0xef, 0x3016, 64 * 1024, 64, FL_ERASE_4K },
 114         { "w25q32",     0xef, 0x4016, 64 * 1024, 64, FL_ERASE_4K },
 115         { "w25q64",     0xef, 0x4017, 64 * 1024, 128, FL_ERASE_4K },
 116         { "w25q64bv",   0xef, 0x4017, 64 * 1024, 128, FL_ERASE_4K },
 117         { "w25q128",    0xef, 0x4018, 64 * 1024, 256, FL_ERASE_4K },
 118         { "w25q256",    0xef, 0x4019, 64 * 1024, 512, FL_ERASE_4K },
 119 };
 120
 121 static uint8_t
 122 mx25l_get_status(device_t dev)
 123 {
 124         uint8_t txBuf[2], rxBuf[2];
 125         struct spi_command cmd;
 126         int err;
 127
 128         memset(&cmd, 0, sizeof(cmd));
 129         memset(txBuf, 0, sizeof(txBuf));
 130         memset(rxBuf, 0, sizeof(rxBuf));
 131
 132         txBuf[0] = CMD_READ_STATUS;
 133         cmd.tx_cmd = txBuf;
 134         cmd.rx_cmd = rxBuf;
 135         cmd.rx_cmd_sz = 2;
 136         cmd.tx_cmd_sz = 2;
 137         err = SPIBUS_TRANSFER(device_get_parent(dev), dev, &cmd);
 138         return (rxBuf[1]);
 139 }
 140
 141 static void
 142 mx25l_wait_for_device_ready(device_t dev)
 143 {
 144         while ((mx25l_get_status(dev) & STATUS_WIP))
 145                 continue;
 146 }
 147
 148 static struct mx25l_flash_ident*
 149 mx25l_get_device_ident(struct mx25l_softc *sc)
 150 {
 151         device_t dev = sc->sc_dev;
 152         uint8_t txBuf[8], rxBuf[8];
 153         struct spi_command cmd;
 154         uint8_t manufacturer_id;
 155         uint16_t dev_id;
 156         int err, i;
 157
 158         memset(&cmd, 0, sizeof(cmd));
 159         memset(txBuf, 0, sizeof(txBuf));
 160         memset(rxBuf, 0, sizeof(rxBuf));
 161
 162         txBuf[0] = CMD_READ_IDENT;
 163         cmd.tx_cmd = &txBuf;
 164         cmd.rx_cmd = &rxBuf;
 165         /*
 166          * Some compatible devices has extended two-bytes ID
 167          * We'll use only manufacturer/deviceid atm
 168          */
 169         cmd.tx_cmd_sz = 4;
 170         cmd.rx_cmd_sz = 4;
 171         err = SPIBUS_TRANSFER(device_get_parent(dev), dev, &cmd);
 172         if (err)
 173                 return (NULL);
 174
 175         manufacturer_id = rxBuf[1];
 176         dev_id = (rxBuf[2] << 8) | (rxBuf[3]);
 177
 178         for (i = 0;
 179             i < sizeof(flash_devices)/sizeof(struct mx25l_flash_ident); i++) {
 180                 if ((flash_devices[i].manufacturer_id == manufacturer_id) &&
 181                     (flash_devices[i].device_id == dev_id))
 182                         return &flash_devices[i];
 183         }
 184
 185         printf("Unknown SPI flash device. Vendor: %02x, device id: %04x\n",
 186             manufacturer_id, dev_id);
 187         return (NULL);
 188 }
 189
 190 static void
 191 mx25l_set_writable(device_t dev, int writable)
 192 {
 193         uint8_t txBuf[1], rxBuf[1];
 194         struct spi_command cmd;
 195         int err;
 196
 197         memset(&cmd, 0, sizeof(cmd));
 198         memset(txBuf, 0, sizeof(txBuf));
 199         memset(rxBuf, 0, sizeof(rxBuf));
 200
 201         txBuf[0] = writable ? CMD_WRITE_ENABLE : CMD_WRITE_DISABLE;
 202         cmd.tx_cmd = txBuf;
 203         cmd.rx_cmd = rxBuf;
 204         cmd.rx_cmd_sz = 1;
 205         cmd.tx_cmd_sz = 1;
 206         err = SPIBUS_TRANSFER(device_get_parent(dev), dev, &cmd);
 207 }
 208
 209 static void
 210 mx25l_erase_cmd(device_t dev, off_t sector, uint8_t ecmd)
 211 {
 212         uint8_t txBuf[4], rxBuf[4];
 213         struct spi_command cmd;
 214         int err;
 215
 216         mx25l_wait_for_device_ready(dev);
 217         mx25l_set_writable(dev, 1);
 218
 219         memset(&cmd, 0, sizeof(cmd));
 220         memset(txBuf, 0, sizeof(txBuf));
 221         memset(rxBuf, 0, sizeof(rxBuf));
 222
 223         txBuf[0] = ecmd;
 224         cmd.tx_cmd = txBuf;
 225         cmd.rx_cmd = rxBuf;
 226         cmd.rx_cmd_sz = 4;
 227         cmd.tx_cmd_sz = 4;
 228         txBuf[1] = ((sector >> 16) & 0xff);
 229         txBuf[2] = ((sector >> 8) & 0xff);
 230         txBuf[3] = (sector & 0xff);
 231         err = SPIBUS_TRANSFER(device_get_parent(dev), dev, &cmd);
 232 }
 233
 234 static int
 235 mx25l_write(device_t dev, off_t offset, caddr_t data, off_t count)
 236 {
 237         struct mx25l_softc *sc;
 238         uint8_t txBuf[8], rxBuf[8];
 239         struct spi_command cmd;
 240         off_t write_offset;
 241         long bytes_to_write, bytes_writen;
 242         device_t pdev;
 243         int err = 0;
 244
 245         pdev = device_get_parent(dev);
 246         sc = device_get_softc(dev);
 247
 248         cmd.tx_cmd_sz = 4;
 249         cmd.rx_cmd_sz = 4;
 250
 251         bytes_writen = 0;
 252         write_offset = offset;
 253
 254         /*
 255          * Use the erase sectorsize here since blocks are fully erased
 256          * first before they're written to.
 257          */
 258         if (count % sc->sc_sectorsize != 0 || offset % sc->sc_sectorsize != 0)
 259                 return (EIO);
 260
 261         /*
 262          * Assume here that we write per-sector only
 263          * and sector size should be 256 bytes aligned
 264          */
 265         KASSERT(write_offset % FLASH_PAGE_SIZE == 0,
 266             ("offset for BIO_WRITE is not page size (%d bytes) aligned",
 267                 FLASH_PAGE_SIZE));
 268
 269         /*
 270          * Maximum write size for CMD_PAGE_PROGRAM is
 271          * FLASH_PAGE_SIZE, so split data to chunks
 272          * FLASH_PAGE_SIZE bytes eash and write them
 273          * one by one
 274          */
 275         while (bytes_writen < count) {
 276                 /*
 277                  * If we crossed sector boundary - erase next sector
 278                  */
 279                 if (((offset + bytes_writen) % sc->sc_sectorsize) == 0)
 280                         mx25l_erase_cmd(dev, offset + bytes_writen, CMD_SECTOR_ERASE);
 281
 282                 txBuf[0] = CMD_PAGE_PROGRAM;
 283                 txBuf[1] = ((write_offset >> 16) & 0xff);
 284                 txBuf[2] = ((write_offset >> 8) & 0xff);
 285                 txBuf[3] = (write_offset & 0xff);
 286
 287                 bytes_to_write = MIN(FLASH_PAGE_SIZE,
 288                     count - bytes_writen);
 289                 cmd.tx_cmd = txBuf;
 290                 cmd.rx_cmd = rxBuf;
 291                 cmd.tx_data = data + bytes_writen;
 292                 cmd.tx_data_sz = bytes_to_write;
 293                 cmd.rx_data = data + bytes_writen;
 294                 cmd.rx_data_sz = bytes_to_write;
 295
 296                 /*
 297                  * Eash completed write operation resets WEL
 298                  * (write enable latch) to disabled state,
 299                  * so we re-enable it here
 300                  */
 301                 mx25l_wait_for_device_ready(dev);
 302                 mx25l_set_writable(dev, 1);
 303
 304                 err = SPIBUS_TRANSFER(pdev, dev, &cmd);
 305                 if (err)
 306                         break;
 307
 308                 bytes_writen += bytes_to_write;
 309                 write_offset += bytes_to_write;
 310         }
 311
 312         return (err);
 313 }
 314
 315 static int
 316 mx25l_read(device_t dev, off_t offset, caddr_t data, off_t count)
 317 {
 318         struct mx25l_softc *sc;
 319         uint8_t txBuf[8], rxBuf[8];
 320         struct spi_command cmd;
 321         device_t pdev;
 322         int err = 0;
 323
 324         pdev = device_get_parent(dev);
 325         sc = device_get_softc(dev);
 326
 327         /*
 328          * Enforce the disk read sectorsize not the erase sectorsize.
 329          * In this way, smaller read IO is possible,dramatically
 330          * speeding up filesystem/geom_compress access.
 331          */
 332         if (count % sc->sc_disk->d_sectorsize != 0
 333             || offset % sc->sc_disk->d_sectorsize != 0)
 334                 return (EIO);
 335
 336         txBuf[0] = CMD_FAST_READ;
 337         cmd.tx_cmd_sz = 5;
 338         cmd.rx_cmd_sz = 5;
 339
 340         txBuf[1] = ((offset >> 16) & 0xff);
 341         txBuf[2] = ((offset >> 8) & 0xff);
 342         txBuf[3] = (offset & 0xff);
 343         /* Dummy byte */
 344         txBuf[4] = 0;
 345
 346         cmd.tx_cmd = txBuf;
 347         cmd.rx_cmd = rxBuf;
 348         cmd.tx_data = data;
 349         cmd.tx_data_sz = count;
 350         cmd.rx_data = data;
 351         cmd.rx_data_sz = count;
 352
 353         err = SPIBUS_TRANSFER(pdev, dev, &cmd);
 354
 355         return (err);
 356 }
 357
 358 static int
 359 mx25l_probe(device_t dev)
 360 {
 361         device_set_desc(dev, "M25Pxx Flash Family");
 362         return (0);
 363 }
 364
 365 static int
 366 mx25l_attach(device_t dev)
 367 {
 368         struct mx25l_softc *sc;
 369         struct mx25l_flash_ident *ident;
 370
 371         sc = device_get_softc(dev);
 372         sc->sc_dev = dev;
 373         M25PXX_LOCK_INIT(sc);
 374
 375         ident = mx25l_get_device_ident(sc);
 376         if (ident == NULL)
 377                 return (ENXIO);
 378
 379         mx25l_wait_for_device_ready(sc->sc_dev);
 380
 381         sc->sc_disk = disk_alloc();
 382         sc->sc_disk->d_open = mx25l_open;
 383         sc->sc_disk->d_close = mx25l_close;
 384         sc->sc_disk->d_strategy = mx25l_strategy;
 385         sc->sc_disk->d_ioctl = mx25l_ioctl;
 386         sc->sc_disk->d_name = "flash/spi";
 387         sc->sc_disk->d_drv1 = sc;
 388         sc->sc_disk->d_maxsize = DFLTPHYS;
 389         sc->sc_disk->d_sectorsize = MX25L_SECTORSIZE;
 390         sc->sc_disk->d_mediasize = ident->sectorsize * ident->sectorcount;
 391         sc->sc_disk->d_unit = device_get_unit(sc->sc_dev);
 392         sc->sc_disk->d_dump = NULL;             /* NB: no dumps */
 393         /* Sectorsize for erase operations */
 394         sc->sc_sectorsize =  ident->sectorsize;
 395         sc->sc_flags = ident->flags;
 396
 397         /* NB: use stripesize to hold the erase/region size for RedBoot */
 398         sc->sc_disk->d_stripesize = ident->sectorsize;
 399
 400         disk_create(sc->sc_disk, DISK_VERSION);
 401         bioq_init(&sc->sc_bio_queue);
 402
 403         kproc_create(&mx25l_task, sc, &sc->sc_p, 0, 0, "task: mx25l flash");
 404         device_printf(sc->sc_dev, "%s, sector %d bytes, %d sectors\n",
 405             ident->name, ident->sectorsize, ident->sectorcount);
 406
 407         return (0);
 408 }
 409
 410 static int
 411 mx25l_detach(device_t dev)
 412 {
 413
 414         return (EIO);
 415 }
 416
 417 static int
 418 mx25l_open(struct disk *dp)
 419 {
 420         return (0);
 421 }
 422
 423 static int
 424 mx25l_close(struct disk *dp)
 425 {
 426
 427         return (0);
 428 }
 429
 430 static int
 431 mx25l_ioctl(struct disk *dp, u_long cmd, void *data, int fflag,
 432         struct thread *td)
 433 {
 434
 435         return (EINVAL);
 436 }
 437
 438 static void
 439 mx25l_strategy(struct bio *bp)
 440 {
 441         struct mx25l_softc *sc;
 442
 443         sc = (struct mx25l_softc *)bp->bio_disk->d_drv1;
 444         M25PXX_LOCK(sc);
 445         bioq_disksort(&sc->sc_bio_queue, bp);
 446         wakeup(sc);
 447         M25PXX_UNLOCK(sc);
 448 }
 449
 450 static void
 451 mx25l_task(void *arg)
 452 {
 453         struct mx25l_softc *sc = (struct mx25l_softc*)arg;
 454         struct bio *bp;
 455         device_t dev;
 456
 457         for (;;) {
 458                 dev = sc->sc_dev;
 459                 M25PXX_LOCK(sc);
 460                 do {
 461                         bp = bioq_first(&sc->sc_bio_queue);
 462                         if (bp == NULL)
 463                                 msleep(sc, &sc->sc_mtx, PRIBIO, "jobqueue", 0);
 464                 } while (bp == NULL);
 465                 bioq_remove(&sc->sc_bio_queue, bp);
 466                 M25PXX_UNLOCK(sc);
 467
 468                 switch (bp->bio_cmd) {
 469                 case BIO_READ:
 470                         bp->bio_error = mx25l_read(dev, bp->bio_offset,
 471                             bp->bio_data, bp->bio_bcount);
 472                         break;
 473                 case BIO_WRITE:
 474                         bp->bio_error = mx25l_write(dev, bp->bio_offset,
 475                             bp->bio_data, bp->bio_bcount);
 476                         break;
 477                 default:
 478                         bp->bio_error = EINVAL;
 479                 }
 480
 481
 482                 biodone(bp);
 483         }
 484 }
 485
 486 static devclass_t mx25l_devclass;
 487
 488 static device_method_t mx25l_methods[] = {
 489         /* Device interface */
 490         DEVMETHOD(device_probe,         mx25l_probe),
 491         DEVMETHOD(device_attach,        mx25l_attach),
 492         DEVMETHOD(device_detach,        mx25l_detach),
 493
 494         { 0, 0 }
 495 };
 496
 497 static driver_t mx25l_driver = {
 498         "mx25l",
 499         mx25l_methods,
 500         sizeof(struct mx25l_softc),
 501 };
 502
 503 DRIVER_MODULE(mx25l, spibus, mx25l_driver, mx25l_devclass, 0, 0);