2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 2006 M. Warner Losh. All rights reserved.
5 * Copyright (c) 2009 Oleksandr Tymoshenko. All rights reserved.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
17 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
18 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
19 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
20 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
21 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
22 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
23 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
25 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 #include <sys/cdefs.h>
29 __FBSDID("$FreeBSD$");
31 #include "opt_platform.h"
33 #include <sys/param.h>
34 #include <sys/systm.h>
38 #include <sys/kernel.h>
39 #include <sys/kthread.h>
42 #include <sys/malloc.h>
43 #include <sys/module.h>
44 #include <sys/mutex.h>
45 #include <geom/geom_disk.h>
48 #include <dev/fdt/fdt_common.h>
49 #include <dev/ofw/ofw_bus_subr.h>
50 #include <dev/ofw/openfirm.h>
53 #include <dev/spibus/spi.h>
54 #include "spibus_if.h"
56 #include <dev/flash/mx25lreg.h>
59 #define FL_ERASE_4K 0x01
60 #define FL_ERASE_32K 0x02
61 #define FL_ENABLE_4B_ADDR 0x04
62 #define FL_DISABLE_4B_ADDR 0x08
65 * Define the sectorsize to be a smaller size rather than the flash
66 * sector size. Trying to run FFS off of a 64k flash sector size
67 * results in a completely un-usable system.
69 #define MX25L_SECTORSIZE 512
71 struct mx25l_flash_ident
74 uint8_t manufacturer_id;
76 unsigned int sectorsize;
77 unsigned int sectorcount;
84 uint8_t sc_manufacturer_id;
85 uint16_t sc_device_id;
86 unsigned int sc_sectorsize;
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_get_status(device_t dev)
155 uint8_t txBuf[2], rxBuf[2];
156 struct spi_command cmd;
159 memset(&cmd, 0, sizeof(cmd));
160 memset(txBuf, 0, sizeof(txBuf));
161 memset(rxBuf, 0, sizeof(rxBuf));
163 txBuf[0] = CMD_READ_STATUS;
168 err = SPIBUS_TRANSFER(device_get_parent(dev), dev, &cmd);
173 mx25l_wait_for_device_ready(device_t dev)
175 while ((mx25l_get_status(dev) & STATUS_WIP))
179 static struct mx25l_flash_ident*
180 mx25l_get_device_ident(struct mx25l_softc *sc)
182 device_t dev = sc->sc_dev;
183 uint8_t txBuf[8], rxBuf[8];
184 struct spi_command cmd;
185 uint8_t manufacturer_id;
189 memset(&cmd, 0, sizeof(cmd));
190 memset(txBuf, 0, sizeof(txBuf));
191 memset(rxBuf, 0, sizeof(rxBuf));
193 txBuf[0] = CMD_READ_IDENT;
197 * Some compatible devices has extended two-bytes ID
198 * We'll use only manufacturer/deviceid atm
202 err = SPIBUS_TRANSFER(device_get_parent(dev), dev, &cmd);
206 manufacturer_id = rxBuf[1];
207 dev_id = (rxBuf[2] << 8) | (rxBuf[3]);
210 i < nitems(flash_devices); i++) {
211 if ((flash_devices[i].manufacturer_id == manufacturer_id) &&
212 (flash_devices[i].device_id == dev_id))
213 return &flash_devices[i];
216 printf("Unknown SPI flash device. Vendor: %02x, device id: %04x\n",
217 manufacturer_id, dev_id);
222 mx25l_set_writable(device_t dev, int writable)
224 uint8_t txBuf[1], rxBuf[1];
225 struct spi_command cmd;
228 memset(&cmd, 0, sizeof(cmd));
229 memset(txBuf, 0, sizeof(txBuf));
230 memset(rxBuf, 0, sizeof(rxBuf));
232 txBuf[0] = writable ? CMD_WRITE_ENABLE : CMD_WRITE_DISABLE;
237 err = SPIBUS_TRANSFER(device_get_parent(dev), dev, &cmd);
241 mx25l_erase_cmd(device_t dev, off_t sector, uint8_t ecmd)
243 struct mx25l_softc *sc;
244 uint8_t txBuf[5], rxBuf[5];
245 struct spi_command cmd;
248 sc = device_get_softc(dev);
250 mx25l_wait_for_device_ready(dev);
251 mx25l_set_writable(dev, 1);
253 memset(&cmd, 0, sizeof(cmd));
254 memset(txBuf, 0, sizeof(txBuf));
255 memset(rxBuf, 0, sizeof(rxBuf));
260 if (sc->sc_flags & FL_ENABLE_4B_ADDR) {
263 txBuf[1] = ((sector >> 24) & 0xff);
264 txBuf[2] = ((sector >> 16) & 0xff);
265 txBuf[3] = ((sector >> 8) & 0xff);
266 txBuf[4] = (sector & 0xff);
270 txBuf[1] = ((sector >> 16) & 0xff);
271 txBuf[2] = ((sector >> 8) & 0xff);
272 txBuf[3] = (sector & 0xff);
274 err = SPIBUS_TRANSFER(device_get_parent(dev), dev, &cmd);
278 mx25l_write(device_t dev, off_t offset, caddr_t data, off_t count)
280 struct mx25l_softc *sc;
281 uint8_t txBuf[8], rxBuf[8];
282 struct spi_command cmd;
284 long bytes_to_write, bytes_writen;
288 pdev = device_get_parent(dev);
289 sc = device_get_softc(dev);
291 if (sc->sc_flags & FL_ENABLE_4B_ADDR) {
300 write_offset = offset;
303 * Use the erase sectorsize here since blocks are fully erased
304 * first before they're written to.
306 if (count % sc->sc_sectorsize != 0 || offset % sc->sc_sectorsize != 0)
310 * Assume here that we write per-sector only
311 * and sector size should be 256 bytes aligned
313 KASSERT(write_offset % FLASH_PAGE_SIZE == 0,
314 ("offset for BIO_WRITE is not page size (%d bytes) aligned",
318 * Maximum write size for CMD_PAGE_PROGRAM is
319 * FLASH_PAGE_SIZE, so split data to chunks
320 * FLASH_PAGE_SIZE bytes eash and write them
323 while (bytes_writen < count) {
325 * If we crossed sector boundary - erase next sector
327 if (((offset + bytes_writen) % sc->sc_sectorsize) == 0)
328 mx25l_erase_cmd(dev, offset + bytes_writen, CMD_SECTOR_ERASE);
330 txBuf[0] = CMD_PAGE_PROGRAM;
331 if (sc->sc_flags & FL_ENABLE_4B_ADDR) {
332 txBuf[1] = ((write_offset >> 24) & 0xff);
333 txBuf[2] = ((write_offset >> 16) & 0xff);
334 txBuf[3] = ((write_offset >> 8) & 0xff);
335 txBuf[4] = (write_offset & 0xff);
337 txBuf[1] = ((write_offset >> 16) & 0xff);
338 txBuf[2] = ((write_offset >> 8) & 0xff);
339 txBuf[3] = (write_offset & 0xff);
342 bytes_to_write = MIN(FLASH_PAGE_SIZE,
343 count - bytes_writen);
346 cmd.tx_data = data + bytes_writen;
347 cmd.tx_data_sz = bytes_to_write;
348 cmd.rx_data = sc->sc_dummybuf;
349 cmd.rx_data_sz = bytes_to_write;
352 * Eash completed write operation resets WEL
353 * (write enable latch) to disabled state,
354 * so we re-enable it here
356 mx25l_wait_for_device_ready(dev);
357 mx25l_set_writable(dev, 1);
359 err = SPIBUS_TRANSFER(pdev, dev, &cmd);
363 bytes_writen += bytes_to_write;
364 write_offset += bytes_to_write;
371 mx25l_read(device_t dev, off_t offset, caddr_t data, off_t count)
373 struct mx25l_softc *sc;
374 uint8_t txBuf[8], rxBuf[8];
375 struct spi_command cmd;
379 pdev = device_get_parent(dev);
380 sc = device_get_softc(dev);
383 * Enforce the disk read sectorsize not the erase sectorsize.
384 * In this way, smaller read IO is possible,dramatically
385 * speeding up filesystem/geom_compress access.
387 if (count % sc->sc_disk->d_sectorsize != 0
388 || offset % sc->sc_disk->d_sectorsize != 0)
391 txBuf[0] = CMD_FAST_READ;
392 if (sc->sc_flags & FL_ENABLE_4B_ADDR) {
396 txBuf[1] = ((offset >> 24) & 0xff);
397 txBuf[2] = ((offset >> 16) & 0xff);
398 txBuf[3] = ((offset >> 8) & 0xff);
399 txBuf[4] = (offset & 0xff);
406 txBuf[1] = ((offset >> 16) & 0xff);
407 txBuf[2] = ((offset >> 8) & 0xff);
408 txBuf[3] = (offset & 0xff);
416 cmd.tx_data_sz = count;
418 cmd.rx_data_sz = count;
420 err = SPIBUS_TRANSFER(pdev, dev, &cmd);
426 mx25l_set_4b_mode(device_t dev, uint8_t command)
428 uint8_t txBuf[1], rxBuf[1];
429 struct spi_command cmd;
433 memset(&cmd, 0, sizeof(cmd));
434 memset(txBuf, 0, sizeof(txBuf));
435 memset(rxBuf, 0, sizeof(rxBuf));
437 pdev = device_get_parent(dev);
439 cmd.tx_cmd_sz = cmd.rx_cmd_sz = 1;
446 err = SPIBUS_TRANSFER(pdev, dev, &cmd);
448 mx25l_wait_for_device_ready(dev);
454 static struct ofw_compat_data compat_data[] = {
456 { "jedec,spi-nor", 1 },
462 mx25l_probe(device_t dev)
467 if (!ofw_bus_status_okay(dev))
470 /* First try to match the compatible property to the compat_data */
471 if (ofw_bus_search_compatible(dev, compat_data)->ocd_data == 1)
475 * Next, try to find a compatible device using the names in the
476 * flash_devices structure
478 for (i = 0; i < nitems(flash_devices); i++)
479 if (ofw_bus_is_compatible(dev, flash_devices[i].name))
485 device_set_desc(dev, "M25Pxx Flash Family");
491 mx25l_attach(device_t dev)
493 struct mx25l_softc *sc;
494 struct mx25l_flash_ident *ident;
496 sc = device_get_softc(dev);
498 M25PXX_LOCK_INIT(sc);
500 ident = mx25l_get_device_ident(sc);
504 mx25l_wait_for_device_ready(sc->sc_dev);
506 sc->sc_disk = disk_alloc();
507 sc->sc_disk->d_open = mx25l_open;
508 sc->sc_disk->d_close = mx25l_close;
509 sc->sc_disk->d_strategy = mx25l_strategy;
510 sc->sc_disk->d_getattr = mx25l_getattr;
511 sc->sc_disk->d_ioctl = mx25l_ioctl;
512 sc->sc_disk->d_name = "flash/spi";
513 sc->sc_disk->d_drv1 = sc;
514 sc->sc_disk->d_maxsize = DFLTPHYS;
515 sc->sc_disk->d_sectorsize = MX25L_SECTORSIZE;
516 sc->sc_disk->d_mediasize = ident->sectorsize * ident->sectorcount;
517 sc->sc_disk->d_unit = device_get_unit(sc->sc_dev);
518 sc->sc_disk->d_dump = NULL; /* NB: no dumps */
519 /* Sectorsize for erase operations */
520 sc->sc_sectorsize = ident->sectorsize;
521 sc->sc_flags = ident->flags;
523 if (sc->sc_flags & FL_ENABLE_4B_ADDR)
524 mx25l_set_4b_mode(dev, CMD_ENTER_4B_MODE);
526 if (sc->sc_flags & FL_DISABLE_4B_ADDR)
527 mx25l_set_4b_mode(dev, CMD_EXIT_4B_MODE);
529 /* NB: use stripesize to hold the erase/region size for RedBoot */
530 sc->sc_disk->d_stripesize = ident->sectorsize;
532 disk_create(sc->sc_disk, DISK_VERSION);
533 bioq_init(&sc->sc_bio_queue);
535 kproc_create(&mx25l_task, sc, &sc->sc_p, 0, 0, "task: mx25l flash");
536 sc->sc_taskstate = TSTATE_RUNNING;
538 device_printf(sc->sc_dev, "%s, sector %d bytes, %d sectors\n",
539 ident->name, ident->sectorsize, ident->sectorcount);
545 mx25l_detach(device_t dev)
547 struct mx25l_softc *sc;
550 sc = device_get_softc(dev);
554 if (sc->sc_taskstate == TSTATE_RUNNING) {
555 sc->sc_taskstate = TSTATE_STOPPING;
557 while (err == 0 && sc->sc_taskstate != TSTATE_STOPPED) {
558 err = msleep(sc, &sc->sc_mtx, 0, "mx25dt", hz * 3);
560 sc->sc_taskstate = TSTATE_RUNNING;
562 "Failed to stop queue task\n");
568 if (err == 0 && sc->sc_taskstate == TSTATE_STOPPED) {
569 disk_destroy(sc->sc_disk);
570 bioq_flush(&sc->sc_bio_queue, NULL, ENXIO);
571 M25PXX_LOCK_DESTROY(sc);
577 mx25l_open(struct disk *dp)
583 mx25l_close(struct disk *dp)
590 mx25l_ioctl(struct disk *dp, u_long cmd, void *data, int fflag,
598 mx25l_strategy(struct bio *bp)
600 struct mx25l_softc *sc;
602 sc = (struct mx25l_softc *)bp->bio_disk->d_drv1;
604 bioq_disksort(&sc->sc_bio_queue, bp);
610 mx25l_getattr(struct bio *bp)
612 struct mx25l_softc *sc;
615 if (bp->bio_disk == NULL || bp->bio_disk->d_drv1 == NULL)
618 sc = bp->bio_disk->d_drv1;
621 if (strcmp(bp->bio_attribute, "SPI::device") == 0) {
622 if (bp->bio_length != sizeof(dev))
624 bcopy(&dev, bp->bio_data, sizeof(dev));
631 mx25l_task(void *arg)
633 struct mx25l_softc *sc = (struct mx25l_softc*)arg;
641 if (sc->sc_taskstate == TSTATE_STOPPING) {
642 sc->sc_taskstate = TSTATE_STOPPED;
647 bp = bioq_first(&sc->sc_bio_queue);
649 msleep(sc, &sc->sc_mtx, PRIBIO, "mx25jq", 0);
650 } while (bp == NULL);
651 bioq_remove(&sc->sc_bio_queue, bp);
654 switch (bp->bio_cmd) {
656 bp->bio_error = mx25l_read(dev, bp->bio_offset,
657 bp->bio_data, bp->bio_bcount);
660 bp->bio_error = mx25l_write(dev, bp->bio_offset,
661 bp->bio_data, bp->bio_bcount);
664 bp->bio_error = EINVAL;
672 static devclass_t mx25l_devclass;
674 static device_method_t mx25l_methods[] = {
675 /* Device interface */
676 DEVMETHOD(device_probe, mx25l_probe),
677 DEVMETHOD(device_attach, mx25l_attach),
678 DEVMETHOD(device_detach, mx25l_detach),
683 static driver_t mx25l_driver = {
686 sizeof(struct mx25l_softc),
689 DRIVER_MODULE(mx25l, spibus, mx25l_driver, mx25l_devclass, 0, 0);
690 MODULE_DEPEND(mx25l, spibus, 1, 1, 1);