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