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