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