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