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 { "s25fl256s", 0x01, 0x0219, 64 * 1024, 512, FL_NONE }, 111 { "SST25VF032B", 0xbf, 0x254a, 64 * 1024, 64, FL_ERASE_4K | FL_ERASE_32K }, 112 113 /* Winbond -- w25x "blocks" are 64K, "sectors" are 4KiB */ 114 { "w25x32", 0xef, 0x3016, 64 * 1024, 64, FL_ERASE_4K }, 115 { "w25q32", 0xef, 0x4016, 64 * 1024, 64, FL_ERASE_4K }, 116 { "w25q64", 0xef, 0x4017, 64 * 1024, 128, FL_ERASE_4K }, 117 { "w25q64bv", 0xef, 0x4017, 64 * 1024, 128, FL_ERASE_4K }, 118 { "w25q128", 0xef, 0x4018, 64 * 1024, 256, FL_ERASE_4K }, 119 { "w25q256", 0xef, 0x4019, 64 * 1024, 512, FL_ERASE_4K }, 120 }; 121 122 static uint8_t 123 mx25l_get_status(device_t dev) 124 { 125 uint8_t txBuf[2], rxBuf[2]; 126 struct spi_command cmd; 127 int err; 128 129 memset(&cmd, 0, sizeof(cmd)); 130 memset(txBuf, 0, sizeof(txBuf)); 131 memset(rxBuf, 0, sizeof(rxBuf)); 132 133 txBuf[0] = CMD_READ_STATUS; 134 cmd.tx_cmd = txBuf; 135 cmd.rx_cmd = rxBuf; 136 cmd.rx_cmd_sz = 2; 137 cmd.tx_cmd_sz = 2; 138 err = SPIBUS_TRANSFER(device_get_parent(dev), dev, &cmd); 139 return (rxBuf[1]); 140 } 141 142 static void 143 mx25l_wait_for_device_ready(device_t dev) 144 { 145 while ((mx25l_get_status(dev) & STATUS_WIP)) 146 continue; 147 } 148 149 static struct mx25l_flash_ident* 150 mx25l_get_device_ident(struct mx25l_softc *sc) 151 { 152 device_t dev = sc->sc_dev; 153 uint8_t txBuf[8], rxBuf[8]; 154 struct spi_command cmd; 155 uint8_t manufacturer_id; 156 uint16_t dev_id; 157 int err, i; 158 159 memset(&cmd, 0, sizeof(cmd)); 160 memset(txBuf, 0, sizeof(txBuf)); 161 memset(rxBuf, 0, sizeof(rxBuf)); 162 163 txBuf[0] = CMD_READ_IDENT; 164 cmd.tx_cmd = &txBuf; 165 cmd.rx_cmd = &rxBuf; 166 /* 167 * Some compatible devices has extended two-bytes ID 168 * We'll use only manufacturer/deviceid atm 169 */ 170 cmd.tx_cmd_sz = 4; 171 cmd.rx_cmd_sz = 4; 172 err = SPIBUS_TRANSFER(device_get_parent(dev), dev, &cmd); 173 if (err) 174 return (NULL); 175 176 manufacturer_id = rxBuf[1]; 177 dev_id = (rxBuf[2] << 8) | (rxBuf[3]); 178 179 for (i = 0; 180 i < sizeof(flash_devices)/sizeof(struct mx25l_flash_ident); i++) { 181 if ((flash_devices[i].manufacturer_id == manufacturer_id) && 182 (flash_devices[i].device_id == dev_id)) 183 return &flash_devices[i]; 184 } 185 186 printf("Unknown SPI flash device. Vendor: %02x, device id: %04x\n", 187 manufacturer_id, dev_id); 188 return (NULL); 189 } 190 191 static void 192 mx25l_set_writable(device_t dev, int writable) 193 { 194 uint8_t txBuf[1], rxBuf[1]; 195 struct spi_command cmd; 196 int err; 197 198 memset(&cmd, 0, sizeof(cmd)); 199 memset(txBuf, 0, sizeof(txBuf)); 200 memset(rxBuf, 0, sizeof(rxBuf)); 201 202 txBuf[0] = writable ? CMD_WRITE_ENABLE : CMD_WRITE_DISABLE; 203 cmd.tx_cmd = txBuf; 204 cmd.rx_cmd = rxBuf; 205 cmd.rx_cmd_sz = 1; 206 cmd.tx_cmd_sz = 1; 207 err = SPIBUS_TRANSFER(device_get_parent(dev), dev, &cmd); 208 } 209 210 static void 211 mx25l_erase_cmd(device_t dev, off_t sector, uint8_t ecmd) 212 { 213 uint8_t txBuf[4], rxBuf[4]; 214 struct spi_command cmd; 215 int err; 216 217 mx25l_wait_for_device_ready(dev); 218 mx25l_set_writable(dev, 1); 219 220 memset(&cmd, 0, sizeof(cmd)); 221 memset(txBuf, 0, sizeof(txBuf)); 222 memset(rxBuf, 0, sizeof(rxBuf)); 223 224 txBuf[0] = ecmd; 225 cmd.tx_cmd = txBuf; 226 cmd.rx_cmd = rxBuf; 227 cmd.rx_cmd_sz = 4; 228 cmd.tx_cmd_sz = 4; 229 txBuf[1] = ((sector >> 16) & 0xff); 230 txBuf[2] = ((sector >> 8) & 0xff); 231 txBuf[3] = (sector & 0xff); 232 err = SPIBUS_TRANSFER(device_get_parent(dev), dev, &cmd); 233 } 234 235 static int 236 mx25l_write(device_t dev, off_t offset, caddr_t data, off_t count) 237 { 238 struct mx25l_softc *sc; 239 uint8_t txBuf[8], rxBuf[8]; 240 struct spi_command cmd; 241 off_t write_offset; 242 long bytes_to_write, bytes_writen; 243 device_t pdev; 244 int err = 0; 245 246 pdev = device_get_parent(dev); 247 sc = device_get_softc(dev); 248 249 cmd.tx_cmd_sz = 4; 250 cmd.rx_cmd_sz = 4; 251 252 bytes_writen = 0; 253 write_offset = offset; 254 255 /* 256 * Use the erase sectorsize here since blocks are fully erased 257 * first before they're written to. 258 */ 259 if (count % sc->sc_sectorsize != 0 || offset % sc->sc_sectorsize != 0) 260 return (EIO); 261 262 /* 263 * Assume here that we write per-sector only 264 * and sector size should be 256 bytes aligned 265 */ 266 KASSERT(write_offset % FLASH_PAGE_SIZE == 0, 267 ("offset for BIO_WRITE is not page size (%d bytes) aligned", 268 FLASH_PAGE_SIZE)); 269 270 /* 271 * Maximum write size for CMD_PAGE_PROGRAM is 272 * FLASH_PAGE_SIZE, so split data to chunks 273 * FLASH_PAGE_SIZE bytes eash and write them 274 * one by one 275 */ 276 while (bytes_writen < count) { 277 /* 278 * If we crossed sector boundary - erase next sector 279 */ 280 if (((offset + bytes_writen) % sc->sc_sectorsize) == 0) 281 mx25l_erase_cmd(dev, offset + bytes_writen, CMD_SECTOR_ERASE); 282 283 txBuf[0] = CMD_PAGE_PROGRAM; 284 txBuf[1] = ((write_offset >> 16) & 0xff); 285 txBuf[2] = ((write_offset >> 8) & 0xff); 286 txBuf[3] = (write_offset & 0xff); 287 288 bytes_to_write = MIN(FLASH_PAGE_SIZE, 289 count - bytes_writen); 290 cmd.tx_cmd = txBuf; 291 cmd.rx_cmd = rxBuf; 292 cmd.tx_data = data + bytes_writen; 293 cmd.tx_data_sz = bytes_to_write; 294 cmd.rx_data = data + bytes_writen; 295 cmd.rx_data_sz = bytes_to_write; 296 297 /* 298 * Eash completed write operation resets WEL 299 * (write enable latch) to disabled state, 300 * so we re-enable it here 301 */ 302 mx25l_wait_for_device_ready(dev); 303 mx25l_set_writable(dev, 1); 304 305 err = SPIBUS_TRANSFER(pdev, dev, &cmd); 306 if (err) 307 break; 308 309 bytes_writen += bytes_to_write; 310 write_offset += bytes_to_write; 311 } 312 313 return (err); 314 } 315 316 static int 317 mx25l_read(device_t dev, off_t offset, caddr_t data, off_t count) 318 { 319 struct mx25l_softc *sc; 320 uint8_t txBuf[8], rxBuf[8]; 321 struct spi_command cmd; 322 device_t pdev; 323 int err = 0; 324 325 pdev = device_get_parent(dev); 326 sc = device_get_softc(dev); 327 328 /* 329 * Enforce the disk read sectorsize not the erase sectorsize. 330 * In this way, smaller read IO is possible,dramatically 331 * speeding up filesystem/geom_compress access. 332 */ 333 if (count % sc->sc_disk->d_sectorsize != 0 334 || offset % sc->sc_disk->d_sectorsize != 0) 335 return (EIO); 336 337 txBuf[0] = CMD_FAST_READ; 338 cmd.tx_cmd_sz = 5; 339 cmd.rx_cmd_sz = 5; 340 341 txBuf[1] = ((offset >> 16) & 0xff); 342 txBuf[2] = ((offset >> 8) & 0xff); 343 txBuf[3] = (offset & 0xff); 344 /* Dummy byte */ 345 txBuf[4] = 0; 346 347 cmd.tx_cmd = txBuf; 348 cmd.rx_cmd = rxBuf; 349 cmd.tx_data = data; 350 cmd.tx_data_sz = count; 351 cmd.rx_data = data; 352 cmd.rx_data_sz = count; 353 354 err = SPIBUS_TRANSFER(pdev, dev, &cmd); 355 356 return (err); 357 } 358 359 static int 360 mx25l_probe(device_t dev) 361 { 362 device_set_desc(dev, "M25Pxx Flash Family"); 363 return (0); 364 } 365 366 static int 367 mx25l_attach(device_t dev) 368 { 369 struct mx25l_softc *sc; 370 struct mx25l_flash_ident *ident; 371 372 sc = device_get_softc(dev); 373 sc->sc_dev = dev; 374 M25PXX_LOCK_INIT(sc); 375 376 ident = mx25l_get_device_ident(sc); 377 if (ident == NULL) 378 return (ENXIO); 379 380 mx25l_wait_for_device_ready(sc->sc_dev); 381 382 sc->sc_disk = disk_alloc(); 383 sc->sc_disk->d_open = mx25l_open; 384 sc->sc_disk->d_close = mx25l_close; 385 sc->sc_disk->d_strategy = mx25l_strategy; 386 sc->sc_disk->d_ioctl = mx25l_ioctl; 387 sc->sc_disk->d_name = "flash/spi"; 388 sc->sc_disk->d_drv1 = sc; 389 sc->sc_disk->d_maxsize = DFLTPHYS; 390 sc->sc_disk->d_sectorsize = MX25L_SECTORSIZE; 391 sc->sc_disk->d_mediasize = ident->sectorsize * ident->sectorcount; 392 sc->sc_disk->d_unit = device_get_unit(sc->sc_dev); 393 sc->sc_disk->d_dump = NULL; /* NB: no dumps */ 394 /* Sectorsize for erase operations */ 395 sc->sc_sectorsize = ident->sectorsize; 396 sc->sc_flags = ident->flags; 397 398 /* NB: use stripesize to hold the erase/region size for RedBoot */ 399 sc->sc_disk->d_stripesize = ident->sectorsize; 400 401 disk_create(sc->sc_disk, DISK_VERSION); 402 bioq_init(&sc->sc_bio_queue); 403 404 kproc_create(&mx25l_task, sc, &sc->sc_p, 0, 0, "task: mx25l flash"); 405 device_printf(sc->sc_dev, "%s, sector %d bytes, %d sectors\n", 406 ident->name, ident->sectorsize, ident->sectorcount); 407 408 return (0); 409 } 410 411 static int 412 mx25l_detach(device_t dev) 413 { 414 415 return (EIO); 416 } 417 418 static int 419 mx25l_open(struct disk *dp) 420 { 421 return (0); 422 } 423 424 static int 425 mx25l_close(struct disk *dp) 426 { 427 428 return (0); 429 } 430 431 static int 432 mx25l_ioctl(struct disk *dp, u_long cmd, void *data, int fflag, 433 struct thread *td) 434 { 435 436 return (EINVAL); 437 } 438 439 static void 440 mx25l_strategy(struct bio *bp) 441 { 442 struct mx25l_softc *sc; 443 444 sc = (struct mx25l_softc *)bp->bio_disk->d_drv1; 445 M25PXX_LOCK(sc); 446 bioq_disksort(&sc->sc_bio_queue, bp); 447 wakeup(sc); 448 M25PXX_UNLOCK(sc); 449 } 450 451 static void 452 mx25l_task(void *arg) 453 { 454 struct mx25l_softc *sc = (struct mx25l_softc*)arg; 455 struct bio *bp; 456 device_t dev; 457 458 for (;;) { 459 dev = sc->sc_dev; 460 M25PXX_LOCK(sc); 461 do { 462 bp = bioq_first(&sc->sc_bio_queue); 463 if (bp == NULL) 464 msleep(sc, &sc->sc_mtx, PRIBIO, "jobqueue", 0); 465 } while (bp == NULL); 466 bioq_remove(&sc->sc_bio_queue, bp); 467 M25PXX_UNLOCK(sc); 468 469 switch (bp->bio_cmd) { 470 case BIO_READ: 471 bp->bio_error = mx25l_read(dev, bp->bio_offset, 472 bp->bio_data, bp->bio_bcount); 473 break; 474 case BIO_WRITE: 475 bp->bio_error = mx25l_write(dev, bp->bio_offset, 476 bp->bio_data, bp->bio_bcount); 477 break; 478 default: 479 bp->bio_error = EINVAL; 480 } 481 482 483 biodone(bp); 484 } 485 } 486 487 static devclass_t mx25l_devclass; 488 489 static device_method_t mx25l_methods[] = { 490 /* Device interface */ 491 DEVMETHOD(device_probe, mx25l_probe), 492 DEVMETHOD(device_attach, mx25l_attach), 493 DEVMETHOD(device_detach, mx25l_detach), 494 495 { 0, 0 } 496 }; 497 498 static driver_t mx25l_driver = { 499 "mx25l", 500 mx25l_methods, 501 sizeof(struct mx25l_softc), 502 }; 503 504 DRIVER_MODULE(mx25l, spibus, mx25l_driver, mx25l_devclass, 0, 0); 505