2 * Copyright (c) 2006 M. Warner Losh. All rights reserved.
3 * Copyright (c) 2009 Oleksandr Tymoshenko. All rights reserved.
4 * Copyright (c) 2018 Ian Lepore. All rights reserved.
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
15 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
16 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
19 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
20 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
21 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
22 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
24 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 #include <sys/cdefs.h>
28 __FBSDID("$FreeBSD$");
30 #include "opt_platform.h"
32 #include <sys/param.h>
33 #include <sys/systm.h>
37 #include <sys/kernel.h>
38 #include <sys/kthread.h>
41 #include <sys/malloc.h>
42 #include <sys/module.h>
43 #include <sys/mutex.h>
44 #include <geom/geom_disk.h>
47 #include <dev/fdt/fdt_common.h>
48 #include <dev/ofw/ofw_bus_subr.h>
49 #include <dev/ofw/openfirm.h>
52 #include <dev/spibus/spi.h>
53 #include "spibus_if.h"
55 #include <dev/flash/mx25lreg.h>
58 #define FL_ERASE_4K 0x01
59 #define FL_ERASE_32K 0x02
60 #define FL_ENABLE_4B_ADDR 0x04
61 #define FL_DISABLE_4B_ADDR 0x08
64 * Define the sectorsize to be a smaller size rather than the flash
65 * sector size. Trying to run FFS off of a 64k flash sector size
66 * results in a completely un-usable system.
68 #define MX25L_SECTORSIZE 512
70 struct mx25l_flash_ident
73 uint8_t manufacturer_id;
75 unsigned int sectorsize;
76 unsigned int sectorcount;
84 uint8_t sc_manufacturer_id;
85 uint16_t sc_device_id;
86 unsigned int sc_erasesize;
90 struct bio_queue_head sc_bio_queue;
91 unsigned int sc_flags;
92 unsigned int sc_taskstate;
93 uint8_t sc_dummybuf[FLASH_PAGE_SIZE];
96 #define TSTATE_STOPPED 0
97 #define TSTATE_STOPPING 1
98 #define TSTATE_RUNNING 2
100 #define M25PXX_LOCK(_sc) mtx_lock(&(_sc)->sc_mtx)
101 #define M25PXX_UNLOCK(_sc) mtx_unlock(&(_sc)->sc_mtx)
102 #define M25PXX_LOCK_INIT(_sc) \
103 mtx_init(&_sc->sc_mtx, device_get_nameunit(_sc->sc_dev), \
105 #define M25PXX_LOCK_DESTROY(_sc) mtx_destroy(&_sc->sc_mtx);
106 #define M25PXX_ASSERT_LOCKED(_sc) mtx_assert(&_sc->sc_mtx, MA_OWNED);
107 #define M25PXX_ASSERT_UNLOCKED(_sc) mtx_assert(&_sc->sc_mtx, MA_NOTOWNED);
110 static int mx25l_open(struct disk *dp);
111 static int mx25l_close(struct disk *dp);
112 static int mx25l_ioctl(struct disk *, u_long, void *, int, struct thread *);
113 static void mx25l_strategy(struct bio *bp);
114 static int mx25l_getattr(struct bio *bp);
115 static void mx25l_task(void *arg);
117 struct mx25l_flash_ident flash_devices[] = {
118 { "en25f32", 0x1c, 0x3116, 64 * 1024, 64, FL_NONE },
119 { "en25p32", 0x1c, 0x2016, 64 * 1024, 64, FL_NONE },
120 { "en25p64", 0x1c, 0x2017, 64 * 1024, 128, FL_NONE },
121 { "en25q32", 0x1c, 0x3016, 64 * 1024, 64, FL_NONE },
122 { "en25q64", 0x1c, 0x3017, 64 * 1024, 128, FL_ERASE_4K },
123 { "m25p32", 0x20, 0x2016, 64 * 1024, 64, FL_NONE },
124 { "m25p64", 0x20, 0x2017, 64 * 1024, 128, FL_NONE },
125 { "mx25ll32", 0xc2, 0x2016, 64 * 1024, 64, FL_NONE },
126 { "mx25ll64", 0xc2, 0x2017, 64 * 1024, 128, FL_NONE },
127 { "mx25ll128", 0xc2, 0x2018, 64 * 1024, 256, FL_ERASE_4K | FL_ERASE_32K },
128 { "mx25ll256", 0xc2, 0x2019, 64 * 1024, 512, FL_ERASE_4K | FL_ERASE_32K | FL_ENABLE_4B_ADDR },
129 { "s25fl032", 0x01, 0x0215, 64 * 1024, 64, FL_NONE },
130 { "s25fl064", 0x01, 0x0216, 64 * 1024, 128, FL_NONE },
131 { "s25fl128", 0x01, 0x2018, 64 * 1024, 256, FL_NONE },
132 { "s25fl256s", 0x01, 0x0219, 64 * 1024, 512, FL_NONE },
133 { "SST25VF010A", 0xbf, 0x2549, 4 * 1024, 32, FL_ERASE_4K | FL_ERASE_32K },
134 { "SST25VF032B", 0xbf, 0x254a, 64 * 1024, 64, FL_ERASE_4K | FL_ERASE_32K },
136 /* Winbond -- w25x "blocks" are 64K, "sectors" are 4KiB */
137 { "w25x32", 0xef, 0x3016, 64 * 1024, 64, FL_ERASE_4K },
138 { "w25x64", 0xef, 0x3017, 64 * 1024, 128, FL_ERASE_4K },
139 { "w25q32", 0xef, 0x4016, 64 * 1024, 64, FL_ERASE_4K },
140 { "w25q64", 0xef, 0x4017, 64 * 1024, 128, FL_ERASE_4K },
141 { "w25q64bv", 0xef, 0x4017, 64 * 1024, 128, FL_ERASE_4K },
142 { "w25q128", 0xef, 0x4018, 64 * 1024, 256, FL_ERASE_4K },
143 { "w25q256", 0xef, 0x4019, 64 * 1024, 512, FL_ERASE_4K },
146 { "at25df641", 0x1f, 0x4800, 64 * 1024, 128, FL_ERASE_4K },
149 { "gd25q64", 0xc8, 0x4017, 64 * 1024, 128, FL_ERASE_4K },
153 mx25l_wait_for_device_ready(struct mx25l_softc *sc)
155 uint8_t txBuf[2], rxBuf[2];
156 struct spi_command cmd;
159 memset(&cmd, 0, sizeof(cmd));
162 txBuf[0] = CMD_READ_STATUS;
167 err = SPIBUS_TRANSFER(sc->sc_parent, sc->sc_dev, &cmd);
168 } while (err == 0 && (rxBuf[1] & STATUS_WIP));
173 static struct mx25l_flash_ident*
174 mx25l_get_device_ident(struct mx25l_softc *sc)
176 uint8_t txBuf[8], rxBuf[8];
177 struct spi_command cmd;
178 uint8_t manufacturer_id;
182 memset(&cmd, 0, sizeof(cmd));
183 memset(txBuf, 0, sizeof(txBuf));
184 memset(rxBuf, 0, sizeof(rxBuf));
186 txBuf[0] = CMD_READ_IDENT;
190 * Some compatible devices has extended two-bytes ID
191 * We'll use only manufacturer/deviceid atm
195 err = SPIBUS_TRANSFER(sc->sc_parent, sc->sc_dev, &cmd);
199 manufacturer_id = rxBuf[1];
200 dev_id = (rxBuf[2] << 8) | (rxBuf[3]);
202 for (i = 0; i < nitems(flash_devices); i++) {
203 if ((flash_devices[i].manufacturer_id == manufacturer_id) &&
204 (flash_devices[i].device_id == dev_id))
205 return &flash_devices[i];
208 device_printf(sc->sc_dev,
209 "Unknown SPI flash device. Vendor: %02x, device id: %04x\n",
210 manufacturer_id, dev_id);
215 mx25l_set_writable(struct mx25l_softc *sc, int writable)
217 uint8_t txBuf[1], rxBuf[1];
218 struct spi_command cmd;
221 memset(&cmd, 0, sizeof(cmd));
222 memset(txBuf, 0, sizeof(txBuf));
223 memset(rxBuf, 0, sizeof(rxBuf));
225 txBuf[0] = writable ? CMD_WRITE_ENABLE : CMD_WRITE_DISABLE;
230 err = SPIBUS_TRANSFER(sc->sc_parent, sc->sc_dev, &cmd);
235 mx25l_erase_cmd(struct mx25l_softc *sc, off_t sector)
237 uint8_t txBuf[5], rxBuf[5];
238 struct spi_command cmd;
241 if ((err = mx25l_set_writable(sc, 1)) != 0)
244 memset(&cmd, 0, sizeof(cmd));
245 memset(txBuf, 0, sizeof(txBuf));
246 memset(rxBuf, 0, sizeof(rxBuf));
251 if (sc->sc_flags & FL_ERASE_4K)
252 txBuf[0] = CMD_BLOCK_4K_ERASE;
253 else if (sc->sc_flags & FL_ERASE_32K)
254 txBuf[0] = CMD_BLOCK_32K_ERASE;
256 txBuf[0] = CMD_SECTOR_ERASE;
258 if (sc->sc_flags & FL_ENABLE_4B_ADDR) {
261 txBuf[1] = ((sector >> 24) & 0xff);
262 txBuf[2] = ((sector >> 16) & 0xff);
263 txBuf[3] = ((sector >> 8) & 0xff);
264 txBuf[4] = (sector & 0xff);
268 txBuf[1] = ((sector >> 16) & 0xff);
269 txBuf[2] = ((sector >> 8) & 0xff);
270 txBuf[3] = (sector & 0xff);
272 if ((err = SPIBUS_TRANSFER(sc->sc_parent, sc->sc_dev, &cmd)) != 0)
274 err = mx25l_wait_for_device_ready(sc);
279 mx25l_write(struct mx25l_softc *sc, off_t offset, caddr_t data, off_t count)
281 uint8_t txBuf[8], rxBuf[8];
282 struct spi_command cmd;
283 off_t bytes_to_write;
286 if (sc->sc_flags & FL_ENABLE_4B_ADDR) {
295 * Writes must be aligned to the erase sectorsize, since blocks are
296 * fully erased before they're written to.
298 if (count % sc->sc_erasesize != 0 || offset % sc->sc_erasesize != 0)
302 * Maximum write size for CMD_PAGE_PROGRAM is FLASH_PAGE_SIZE, so loop
303 * to write chunks of FLASH_PAGE_SIZE bytes each.
306 /* If we crossed a sector boundary, erase the next sector. */
307 if (((offset) % sc->sc_erasesize) == 0) {
308 err = mx25l_erase_cmd(sc, offset);
313 txBuf[0] = CMD_PAGE_PROGRAM;
314 if (sc->sc_flags & FL_ENABLE_4B_ADDR) {
315 txBuf[1] = (offset >> 24) & 0xff;
316 txBuf[2] = (offset >> 16) & 0xff;
317 txBuf[3] = (offset >> 8) & 0xff;
318 txBuf[4] = offset & 0xff;
320 txBuf[1] = (offset >> 16) & 0xff;
321 txBuf[2] = (offset >> 8) & 0xff;
322 txBuf[3] = offset & 0xff;
325 bytes_to_write = MIN(FLASH_PAGE_SIZE, count);
329 cmd.rx_data = sc->sc_dummybuf;
330 cmd.tx_data_sz = (uint32_t)bytes_to_write;
331 cmd.rx_data_sz = (uint32_t)bytes_to_write;
334 * Each completed write operation resets WEL (write enable
335 * latch) to disabled state, so we re-enable it here.
337 if ((err = mx25l_wait_for_device_ready(sc)) != 0)
339 if ((err = mx25l_set_writable(sc, 1)) != 0)
342 err = SPIBUS_TRANSFER(sc->sc_parent, sc->sc_dev, &cmd);
345 err = mx25l_wait_for_device_ready(sc);
349 data += bytes_to_write;
350 offset += bytes_to_write;
351 count -= bytes_to_write;
358 mx25l_read(struct mx25l_softc *sc, off_t offset, caddr_t data, off_t count)
360 uint8_t txBuf[8], rxBuf[8];
361 struct spi_command cmd;
365 * Enforce that reads are aligned to the disk sectorsize, not the
366 * erase sectorsize. In this way, smaller read IO is possible,
367 * dramatically speeding up filesystem/geom_compress access.
369 if (count % sc->sc_disk->d_sectorsize != 0 ||
370 offset % sc->sc_disk->d_sectorsize != 0)
373 txBuf[0] = CMD_FAST_READ;
374 if (sc->sc_flags & FL_ENABLE_4B_ADDR) {
378 txBuf[1] = (offset >> 24) & 0xff;
379 txBuf[2] = (offset >> 16) & 0xff;
380 txBuf[3] = (offset >> 8) & 0xff;
381 txBuf[4] = offset & 0xff;
388 txBuf[1] = (offset >> 16) & 0xff;
389 txBuf[2] = (offset >> 8) & 0xff;
390 txBuf[3] = offset & 0xff;
399 cmd.tx_data_sz = count;
400 cmd.rx_data_sz = count;
402 err = SPIBUS_TRANSFER(sc->sc_parent, sc->sc_dev, &cmd);
407 mx25l_set_4b_mode(struct mx25l_softc *sc, uint8_t command)
409 uint8_t txBuf[1], rxBuf[1];
410 struct spi_command cmd;
413 memset(&cmd, 0, sizeof(cmd));
414 memset(txBuf, 0, sizeof(txBuf));
415 memset(rxBuf, 0, sizeof(rxBuf));
417 cmd.tx_cmd_sz = cmd.rx_cmd_sz = 1;
424 if ((err = SPIBUS_TRANSFER(sc->sc_parent, sc->sc_dev, &cmd)) == 0)
425 err = mx25l_wait_for_device_ready(sc);
431 static struct ofw_compat_data compat_data[] = {
433 { "jedec,spi-nor", 1 },
439 mx25l_probe(device_t dev)
444 if (!ofw_bus_status_okay(dev))
447 /* First try to match the compatible property to the compat_data */
448 if (ofw_bus_search_compatible(dev, compat_data)->ocd_data == 1)
452 * Next, try to find a compatible device using the names in the
453 * flash_devices structure
455 for (i = 0; i < nitems(flash_devices); i++)
456 if (ofw_bus_is_compatible(dev, flash_devices[i].name))
462 device_set_desc(dev, "M25Pxx Flash Family");
468 mx25l_attach(device_t dev)
470 struct mx25l_softc *sc;
471 struct mx25l_flash_ident *ident;
474 sc = device_get_softc(dev);
476 sc->sc_parent = device_get_parent(sc->sc_dev);
478 M25PXX_LOCK_INIT(sc);
480 ident = mx25l_get_device_ident(sc);
484 if ((err = mx25l_wait_for_device_ready(sc)) != 0)
487 sc->sc_flags = ident->flags;
489 if (sc->sc_flags & FL_ERASE_4K)
490 sc->sc_erasesize = 4 * 1024;
491 else if (sc->sc_flags & FL_ERASE_32K)
492 sc->sc_erasesize = 32 * 1024;
494 sc->sc_erasesize = ident->sectorsize;
496 if (sc->sc_flags & FL_ENABLE_4B_ADDR) {
497 if ((err = mx25l_set_4b_mode(sc, CMD_ENTER_4B_MODE)) != 0)
499 } else if (sc->sc_flags & FL_DISABLE_4B_ADDR) {
500 if ((err = mx25l_set_4b_mode(sc, CMD_EXIT_4B_MODE)) != 0)
504 sc->sc_disk = disk_alloc();
505 sc->sc_disk->d_open = mx25l_open;
506 sc->sc_disk->d_close = mx25l_close;
507 sc->sc_disk->d_strategy = mx25l_strategy;
508 sc->sc_disk->d_getattr = mx25l_getattr;
509 sc->sc_disk->d_ioctl = mx25l_ioctl;
510 sc->sc_disk->d_name = "flash/spi";
511 sc->sc_disk->d_drv1 = sc;
512 sc->sc_disk->d_maxsize = DFLTPHYS;
513 sc->sc_disk->d_sectorsize = MX25L_SECTORSIZE;
514 sc->sc_disk->d_mediasize = ident->sectorsize * ident->sectorcount;
515 sc->sc_disk->d_stripesize = sc->sc_erasesize;
516 sc->sc_disk->d_unit = device_get_unit(sc->sc_dev);
517 sc->sc_disk->d_dump = NULL; /* NB: no dumps */
518 strlcpy(sc->sc_disk->d_descr, ident->name,
519 sizeof(sc->sc_disk->d_descr));
521 disk_create(sc->sc_disk, DISK_VERSION);
522 bioq_init(&sc->sc_bio_queue);
524 kproc_create(&mx25l_task, sc, &sc->sc_p, 0, 0, "task: mx25l flash");
525 sc->sc_taskstate = TSTATE_RUNNING;
527 device_printf(sc->sc_dev,
528 "device type %s, size %dK in %d sectors of %dK, erase size %dK\n",
530 ident->sectorcount * ident->sectorsize / 1024,
531 ident->sectorcount, ident->sectorsize / 1024,
532 sc->sc_erasesize / 1024);
538 mx25l_detach(device_t dev)
540 struct mx25l_softc *sc;
543 sc = device_get_softc(dev);
547 if (sc->sc_taskstate == TSTATE_RUNNING) {
548 sc->sc_taskstate = TSTATE_STOPPING;
550 while (err == 0 && sc->sc_taskstate != TSTATE_STOPPED) {
551 err = msleep(sc, &sc->sc_mtx, 0, "mx25dt", hz * 3);
553 sc->sc_taskstate = TSTATE_RUNNING;
554 device_printf(sc->sc_dev,
555 "Failed to stop queue task\n");
561 if (err == 0 && sc->sc_taskstate == TSTATE_STOPPED) {
562 disk_destroy(sc->sc_disk);
563 bioq_flush(&sc->sc_bio_queue, NULL, ENXIO);
564 M25PXX_LOCK_DESTROY(sc);
570 mx25l_open(struct disk *dp)
576 mx25l_close(struct disk *dp)
583 mx25l_ioctl(struct disk *dp, u_long cmd, void *data, int fflag,
591 mx25l_strategy(struct bio *bp)
593 struct mx25l_softc *sc;
595 sc = (struct mx25l_softc *)bp->bio_disk->d_drv1;
597 bioq_disksort(&sc->sc_bio_queue, bp);
603 mx25l_getattr(struct bio *bp)
605 struct mx25l_softc *sc;
608 if (bp->bio_disk == NULL || bp->bio_disk->d_drv1 == NULL)
611 sc = bp->bio_disk->d_drv1;
614 if (strcmp(bp->bio_attribute, "SPI::device") == 0) {
615 if (bp->bio_length != sizeof(dev))
617 bcopy(&dev, bp->bio_data, sizeof(dev));
624 mx25l_task(void *arg)
626 struct mx25l_softc *sc = (struct mx25l_softc*)arg;
634 if (sc->sc_taskstate == TSTATE_STOPPING) {
635 sc->sc_taskstate = TSTATE_STOPPED;
640 bp = bioq_first(&sc->sc_bio_queue);
642 msleep(sc, &sc->sc_mtx, PRIBIO, "mx25jq", 0);
643 } while (bp == NULL);
644 bioq_remove(&sc->sc_bio_queue, bp);
647 switch (bp->bio_cmd) {
649 bp->bio_error = mx25l_read(sc, bp->bio_offset,
650 bp->bio_data, bp->bio_bcount);
653 bp->bio_error = mx25l_write(sc, bp->bio_offset,
654 bp->bio_data, bp->bio_bcount);
657 bp->bio_error = EINVAL;
665 static devclass_t mx25l_devclass;
667 static device_method_t mx25l_methods[] = {
668 /* Device interface */
669 DEVMETHOD(device_probe, mx25l_probe),
670 DEVMETHOD(device_attach, mx25l_attach),
671 DEVMETHOD(device_detach, mx25l_detach),
676 static driver_t mx25l_driver = {
679 sizeof(struct mx25l_softc),
682 DRIVER_MODULE(mx25l, spibus, mx25l_driver, mx25l_devclass, 0, 0);
683 MODULE_DEPEND(mx25l, spibus, 1, 1, 1);
684 MODULE_DEPEND(mx25l, fdt_slicer, 1, 1, 1);