2 * Copyright (c) 2006 M. Warner Losh. All rights reserved.
3 * Copyright (c) 2009 Oleksandr Tymoshenko. All rights reserved.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
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.
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.
26 #include <sys/cdefs.h>
27 __FBSDID("$FreeBSD$");
29 #include <sys/param.h>
30 #include <sys/systm.h>
34 #include <sys/kernel.h>
35 #include <sys/kthread.h>
38 #include <sys/malloc.h>
39 #include <sys/module.h>
40 #include <sys/mutex.h>
41 #include <geom/geom_disk.h>
43 #include <dev/spibus/spi.h>
44 #include "spibus_if.h"
46 #include <dev/flash/mx25lreg.h>
49 #define FL_ERASE_4K 0x01
50 #define FL_ERASE_32K 0x02
53 * Define the sectorsize to be a smaller size rather than the flash
54 * sector size. Trying to run FFS off of a 64k flash sector size
55 * results in a completely un-usable system.
57 #define MX25L_SECTORSIZE 512
59 struct mx25l_flash_ident
62 uint8_t manufacturer_id;
64 unsigned int sectorsize;
65 unsigned int sectorcount;
72 uint8_t sc_manufacturer_id;
73 uint16_t sc_device_id;
74 unsigned int sc_sectorsize;
78 struct bio_queue_head sc_bio_queue;
79 unsigned int sc_flags;
82 #define M25PXX_LOCK(_sc) mtx_lock(&(_sc)->sc_mtx)
83 #define M25PXX_UNLOCK(_sc) mtx_unlock(&(_sc)->sc_mtx)
84 #define M25PXX_LOCK_INIT(_sc) \
85 mtx_init(&_sc->sc_mtx, device_get_nameunit(_sc->sc_dev), \
87 #define M25PXX_LOCK_DESTROY(_sc) mtx_destroy(&_sc->sc_mtx);
88 #define M25PXX_ASSERT_LOCKED(_sc) mtx_assert(&_sc->sc_mtx, MA_OWNED);
89 #define M25PXX_ASSERT_UNLOCKED(_sc) mtx_assert(&_sc->sc_mtx, MA_NOTOWNED);
92 static int mx25l_open(struct disk *dp);
93 static int mx25l_close(struct disk *dp);
94 static int mx25l_ioctl(struct disk *, u_long, void *, int, struct thread *);
95 static void mx25l_strategy(struct bio *bp);
96 static void mx25l_task(void *arg);
98 struct mx25l_flash_ident flash_devices[] = {
99 { "en25f32", 0x1c, 0x3116, 64 * 1024, 64, FL_NONE },
100 { "en25p32", 0x1c, 0x2016, 64 * 1024, 64, FL_NONE },
101 { "en25p64", 0x1c, 0x2017, 64 * 1024, 128, FL_NONE },
102 { "en25q64", 0x1c, 0x3017, 64 * 1024, 128, FL_ERASE_4K },
103 { "m25p64", 0x20, 0x2017, 64 * 1024, 128, FL_NONE },
104 { "mx25ll32", 0xc2, 0x2016, 64 * 1024, 64, FL_NONE },
105 { "mx25ll64", 0xc2, 0x2017, 64 * 1024, 128, FL_NONE },
106 { "mx25ll128", 0xc2, 0x2018, 64 * 1024, 256, FL_ERASE_4K | FL_ERASE_32K },
107 { "s25fl032", 0x01, 0x0215, 64 * 1024, 64, FL_NONE },
108 { "s25fl064", 0x01, 0x0216, 64 * 1024, 128, FL_NONE },
109 { "s25fl128", 0x01, 0x2018, 64 * 1024, 256, FL_NONE },
110 { "SST25VF032B", 0xbf, 0x254a, 64 * 1024, 64, FL_ERASE_4K | FL_ERASE_32K },
112 /* Winbond -- w25x "blocks" are 64K, "sectors" are 4KiB */
113 { "w25x32", 0xef, 0x3016, 64 * 1024, 64, FL_ERASE_4K },
114 { "w25q32", 0xef, 0x4016, 64 * 1024, 64, FL_ERASE_4K },
115 { "w25q64", 0xef, 0x4017, 64 * 1024, 128, FL_ERASE_4K },
116 { "w25q64bv", 0xef, 0x4017, 64 * 1024, 128, FL_ERASE_4K },
117 { "w25q128", 0xef, 0x4018, 64 * 1024, 256, FL_ERASE_4K },
118 { "w25q256", 0xef, 0x4019, 64 * 1024, 512, FL_ERASE_4K },
122 mx25l_get_status(device_t dev)
124 uint8_t txBuf[2], rxBuf[2];
125 struct spi_command cmd;
128 memset(&cmd, 0, sizeof(cmd));
129 memset(txBuf, 0, sizeof(txBuf));
130 memset(rxBuf, 0, sizeof(rxBuf));
132 txBuf[0] = CMD_READ_STATUS;
137 err = SPIBUS_TRANSFER(device_get_parent(dev), dev, &cmd);
142 mx25l_wait_for_device_ready(device_t dev)
144 while ((mx25l_get_status(dev) & STATUS_WIP))
148 static struct mx25l_flash_ident*
149 mx25l_get_device_ident(struct mx25l_softc *sc)
151 device_t dev = sc->sc_dev;
152 uint8_t txBuf[8], rxBuf[8];
153 struct spi_command cmd;
154 uint8_t manufacturer_id;
158 memset(&cmd, 0, sizeof(cmd));
159 memset(txBuf, 0, sizeof(txBuf));
160 memset(rxBuf, 0, sizeof(rxBuf));
162 txBuf[0] = CMD_READ_IDENT;
166 * Some compatible devices has extended two-bytes ID
167 * We'll use only manufacturer/deviceid atm
171 err = SPIBUS_TRANSFER(device_get_parent(dev), dev, &cmd);
175 manufacturer_id = rxBuf[1];
176 dev_id = (rxBuf[2] << 8) | (rxBuf[3]);
179 i < sizeof(flash_devices)/sizeof(struct mx25l_flash_ident); i++) {
180 if ((flash_devices[i].manufacturer_id == manufacturer_id) &&
181 (flash_devices[i].device_id == dev_id))
182 return &flash_devices[i];
185 printf("Unknown SPI flash device. Vendor: %02x, device id: %04x\n",
186 manufacturer_id, dev_id);
191 mx25l_set_writable(device_t dev, int writable)
193 uint8_t txBuf[1], rxBuf[1];
194 struct spi_command cmd;
197 memset(&cmd, 0, sizeof(cmd));
198 memset(txBuf, 0, sizeof(txBuf));
199 memset(rxBuf, 0, sizeof(rxBuf));
201 txBuf[0] = writable ? CMD_WRITE_ENABLE : CMD_WRITE_DISABLE;
206 err = SPIBUS_TRANSFER(device_get_parent(dev), dev, &cmd);
210 mx25l_erase_cmd(device_t dev, off_t sector, uint8_t ecmd)
212 uint8_t txBuf[4], rxBuf[4];
213 struct spi_command cmd;
216 mx25l_wait_for_device_ready(dev);
217 mx25l_set_writable(dev, 1);
219 memset(&cmd, 0, sizeof(cmd));
220 memset(txBuf, 0, sizeof(txBuf));
221 memset(rxBuf, 0, sizeof(rxBuf));
228 txBuf[1] = ((sector >> 16) & 0xff);
229 txBuf[2] = ((sector >> 8) & 0xff);
230 txBuf[3] = (sector & 0xff);
231 err = SPIBUS_TRANSFER(device_get_parent(dev), dev, &cmd);
235 mx25l_write(device_t dev, off_t offset, caddr_t data, off_t count)
237 struct mx25l_softc *sc;
238 uint8_t txBuf[8], rxBuf[8];
239 struct spi_command cmd;
241 long bytes_to_write, bytes_writen;
245 pdev = device_get_parent(dev);
246 sc = device_get_softc(dev);
252 write_offset = offset;
255 * Use the erase sectorsize here since blocks are fully erased
256 * first before they're written to.
258 if (count % sc->sc_sectorsize != 0 || offset % sc->sc_sectorsize != 0)
262 * Assume here that we write per-sector only
263 * and sector size should be 256 bytes aligned
265 KASSERT(write_offset % FLASH_PAGE_SIZE == 0,
266 ("offset for BIO_WRITE is not page size (%d bytes) aligned",
270 * Maximum write size for CMD_PAGE_PROGRAM is
271 * FLASH_PAGE_SIZE, so split data to chunks
272 * FLASH_PAGE_SIZE bytes eash and write them
275 while (bytes_writen < count) {
277 * If we crossed sector boundary - erase next sector
279 if (((offset + bytes_writen) % sc->sc_sectorsize) == 0)
280 mx25l_erase_cmd(dev, offset + bytes_writen, CMD_SECTOR_ERASE);
282 txBuf[0] = CMD_PAGE_PROGRAM;
283 txBuf[1] = ((write_offset >> 16) & 0xff);
284 txBuf[2] = ((write_offset >> 8) & 0xff);
285 txBuf[3] = (write_offset & 0xff);
287 bytes_to_write = MIN(FLASH_PAGE_SIZE,
288 count - bytes_writen);
291 cmd.tx_data = data + bytes_writen;
292 cmd.tx_data_sz = bytes_to_write;
293 cmd.rx_data = data + bytes_writen;
294 cmd.rx_data_sz = bytes_to_write;
297 * Eash completed write operation resets WEL
298 * (write enable latch) to disabled state,
299 * so we re-enable it here
301 mx25l_wait_for_device_ready(dev);
302 mx25l_set_writable(dev, 1);
304 err = SPIBUS_TRANSFER(pdev, dev, &cmd);
308 bytes_writen += bytes_to_write;
309 write_offset += bytes_to_write;
316 mx25l_read(device_t dev, off_t offset, caddr_t data, off_t count)
318 struct mx25l_softc *sc;
319 uint8_t txBuf[8], rxBuf[8];
320 struct spi_command cmd;
324 pdev = device_get_parent(dev);
325 sc = device_get_softc(dev);
328 * Enforce the disk read sectorsize not the erase sectorsize.
329 * In this way, smaller read IO is possible,dramatically
330 * speeding up filesystem/geom_compress access.
332 if (count % sc->sc_disk->d_sectorsize != 0
333 || offset % sc->sc_disk->d_sectorsize != 0)
336 txBuf[0] = CMD_FAST_READ;
340 txBuf[1] = ((offset >> 16) & 0xff);
341 txBuf[2] = ((offset >> 8) & 0xff);
342 txBuf[3] = (offset & 0xff);
349 cmd.tx_data_sz = count;
351 cmd.rx_data_sz = count;
353 err = SPIBUS_TRANSFER(pdev, dev, &cmd);
359 mx25l_probe(device_t dev)
361 device_set_desc(dev, "M25Pxx Flash Family");
366 mx25l_attach(device_t dev)
368 struct mx25l_softc *sc;
369 struct mx25l_flash_ident *ident;
371 sc = device_get_softc(dev);
373 M25PXX_LOCK_INIT(sc);
375 ident = mx25l_get_device_ident(sc);
379 mx25l_wait_for_device_ready(sc->sc_dev);
381 sc->sc_disk = disk_alloc();
382 sc->sc_disk->d_open = mx25l_open;
383 sc->sc_disk->d_close = mx25l_close;
384 sc->sc_disk->d_strategy = mx25l_strategy;
385 sc->sc_disk->d_ioctl = mx25l_ioctl;
386 sc->sc_disk->d_name = "flash/spi";
387 sc->sc_disk->d_drv1 = sc;
388 sc->sc_disk->d_maxsize = DFLTPHYS;
389 sc->sc_disk->d_sectorsize = MX25L_SECTORSIZE;
390 sc->sc_disk->d_mediasize = ident->sectorsize * ident->sectorcount;
391 sc->sc_disk->d_unit = device_get_unit(sc->sc_dev);
392 sc->sc_disk->d_dump = NULL; /* NB: no dumps */
393 /* Sectorsize for erase operations */
394 sc->sc_sectorsize = ident->sectorsize;
395 sc->sc_flags = ident->flags;
397 /* NB: use stripesize to hold the erase/region size for RedBoot */
398 sc->sc_disk->d_stripesize = ident->sectorsize;
400 disk_create(sc->sc_disk, DISK_VERSION);
401 bioq_init(&sc->sc_bio_queue);
403 kproc_create(&mx25l_task, sc, &sc->sc_p, 0, 0, "task: mx25l flash");
404 device_printf(sc->sc_dev, "%s, sector %d bytes, %d sectors\n",
405 ident->name, ident->sectorsize, ident->sectorcount);
411 mx25l_detach(device_t dev)
418 mx25l_open(struct disk *dp)
424 mx25l_close(struct disk *dp)
431 mx25l_ioctl(struct disk *dp, u_long cmd, void *data, int fflag,
439 mx25l_strategy(struct bio *bp)
441 struct mx25l_softc *sc;
443 sc = (struct mx25l_softc *)bp->bio_disk->d_drv1;
445 bioq_disksort(&sc->sc_bio_queue, bp);
451 mx25l_task(void *arg)
453 struct mx25l_softc *sc = (struct mx25l_softc*)arg;
461 bp = bioq_first(&sc->sc_bio_queue);
463 msleep(sc, &sc->sc_mtx, PRIBIO, "jobqueue", 0);
464 } while (bp == NULL);
465 bioq_remove(&sc->sc_bio_queue, bp);
468 switch (bp->bio_cmd) {
470 bp->bio_error = mx25l_read(dev, bp->bio_offset,
471 bp->bio_data, bp->bio_bcount);
474 bp->bio_error = mx25l_write(dev, bp->bio_offset,
475 bp->bio_data, bp->bio_bcount);
478 bp->bio_error = EINVAL;
486 static devclass_t mx25l_devclass;
488 static device_method_t mx25l_methods[] = {
489 /* Device interface */
490 DEVMETHOD(device_probe, mx25l_probe),
491 DEVMETHOD(device_attach, mx25l_attach),
492 DEVMETHOD(device_detach, mx25l_detach),
497 static driver_t mx25l_driver = {
500 sizeof(struct mx25l_softc),
503 DRIVER_MODULE(mx25l, spibus, mx25l_driver, mx25l_devclass, 0, 0);