2 * Copyright (c) 2006 M. Warner Losh
3 * Copyright (c) 2011-2012 Ian Lepore
4 * Copyright (c) 2012 Marius Strobl <marius@FreeBSD.org>
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 <sys/param.h>
32 #include <sys/systm.h>
36 #include <sys/kernel.h>
37 #include <sys/kthread.h>
40 #include <sys/malloc.h>
41 #include <sys/module.h>
42 #include <sys/mutex.h>
43 #include <geom/geom_disk.h>
45 #include <dev/spibus/spi.h>
46 #include "spibus_if.h"
48 struct at45d_flash_ident
60 struct bio_queue_head bio_queue;
64 struct intr_config_hook config_intrhook;
71 #define AT45D_LOCK(_sc) mtx_lock(&(_sc)->sc_mtx)
72 #define AT45D_UNLOCK(_sc) mtx_unlock(&(_sc)->sc_mtx)
73 #define AT45D_LOCK_INIT(_sc) \
74 mtx_init(&_sc->sc_mtx, device_get_nameunit(_sc->dev), \
76 #define AT45D_LOCK_DESTROY(_sc) mtx_destroy(&_sc->sc_mtx);
77 #define AT45D_ASSERT_LOCKED(_sc) mtx_assert(&_sc->sc_mtx, MA_OWNED);
78 #define AT45D_ASSERT_UNLOCKED(_sc) mtx_assert(&_sc->sc_mtx, MA_NOTOWNED);
80 /* bus entry points */
81 static device_attach_t at45d_attach;
82 static device_detach_t at45d_detach;
83 static device_probe_t at45d_probe;
86 static int at45d_close(struct disk *dp);
87 static int at45d_open(struct disk *dp);
88 static void at45d_strategy(struct bio *bp);
89 static void at45d_task(void *arg);
92 static void at45d_delayed_attach(void *xsc);
93 static int at45d_get_mfg_info(device_t dev, uint8_t *resp);
94 static int at45d_get_status(device_t dev, uint8_t *status);
95 static int at45d_wait_ready(device_t dev, uint8_t *status);
97 #define BUFFER_TRANSFER 0x53
98 #define BUFFER_COMPARE 0x60
99 #define PROGRAM_THROUGH_BUFFER 0x82
100 #define MANUFACTURER_ID 0x9f
101 #define STATUS_REGISTER_READ 0xd7
102 #define CONTINUOUS_ARRAY_READ 0xe8
105 * A sectorsize2n != 0 is used to indicate that a device optionally supports
106 * 2^N byte pages. If support for the latter is enabled, the sector offset
107 * has to be reduced by one.
109 static const struct at45d_flash_ident at45d_flash_devices[] = {
110 { "AT45DB011B", 0x1f2200, 512, 9, 264, 256 },
111 { "AT45DB021B", 0x1f2300, 1024, 9, 264, 256 },
112 { "AT45DB041x", 0x1f2400, 2028, 9, 264, 256 },
113 { "AT45DB081B", 0x1f2500, 4096, 9, 264, 256 },
114 { "AT45DB161x", 0x1f2600, 4096, 10, 528, 512 },
115 { "AT45DB321x", 0x1f2700, 8192, 10, 528, 0 },
116 { "AT45DB321x", 0x1f2701, 8192, 10, 528, 512 },
117 { "AT45DB642x", 0x1f2800, 8192, 11, 1056, 1024 }
121 at45d_get_status(device_t dev, uint8_t *status)
123 uint8_t rxBuf[8], txBuf[8];
124 struct spi_command cmd;
127 memset(&cmd, 0, sizeof(cmd));
128 memset(txBuf, 0, sizeof(txBuf));
129 memset(rxBuf, 0, sizeof(rxBuf));
131 txBuf[0] = STATUS_REGISTER_READ;
134 cmd.rx_cmd_sz = cmd.tx_cmd_sz = 2;
135 err = SPIBUS_TRANSFER(device_get_parent(dev), dev, &cmd);
141 at45d_get_mfg_info(device_t dev, uint8_t *resp)
143 uint8_t rxBuf[8], txBuf[8];
144 struct spi_command cmd;
147 memset(&cmd, 0, sizeof(cmd));
148 memset(txBuf, 0, sizeof(txBuf));
149 memset(rxBuf, 0, sizeof(rxBuf));
151 txBuf[0] = MANUFACTURER_ID;
154 cmd.tx_cmd_sz = cmd.rx_cmd_sz = 5;
155 err = SPIBUS_TRANSFER(device_get_parent(dev), dev, &cmd);
158 memcpy(resp, rxBuf + 1, 4);
163 at45d_wait_ready(device_t dev, uint8_t *status)
165 struct timeval now, tout;
168 getmicrouptime(&tout);
171 getmicrouptime(&now);
172 if (now.tv_sec > tout.tv_sec)
175 err = at45d_get_status(dev, status);
176 } while (err == 0 && (*status & 0x80) == 0);
181 at45d_probe(device_t dev)
184 device_set_desc(dev, "AT45D Flash Family");
189 at45d_attach(device_t dev)
191 struct at45d_softc *sc;
193 sc = device_get_softc(dev);
197 /* We'll see what kind of flash we have later... */
198 sc->config_intrhook.ich_func = at45d_delayed_attach;
199 sc->config_intrhook.ich_arg = sc;
200 if (config_intrhook_establish(&sc->config_intrhook) != 0)
201 device_printf(dev, "config_intrhook_establish failed\n");
206 at45d_detach(device_t dev)
209 return (EBUSY) /* XXX */;
213 at45d_delayed_attach(void *xsc)
215 struct at45d_softc *sc;
216 const struct at45d_flash_ident *ident;
220 uint8_t buf[4], status;
226 if (at45d_wait_ready(sc->dev, &status) != 0)
227 device_printf(sc->dev, "Error waiting for device-ready.\n");
228 else if (at45d_get_mfg_info(sc->dev, buf) != 0)
229 device_printf(sc->dev, "Failed to get ID.\n");
231 jedec = buf[0] << 16 | buf[1] << 8 | buf[2];
232 for (i = 0; i < nitems(at45d_flash_devices); i++) {
233 if (at45d_flash_devices[i].jedec == jedec) {
234 ident = &at45d_flash_devices[i];
240 device_printf(sc->dev, "JEDEC 0x%x not in list.\n", jedec);
242 sc->pagecount = ident->pagecount;
243 sc->pageoffset = ident->pageoffset;
244 if (ident->pagesize2n != 0 && (status & 0x01) != 0) {
246 pagesize = ident->pagesize2n;
248 pagesize = ident->pagesize;
249 sc->pagesize = pagesize;
251 sc->disk = disk_alloc();
252 sc->disk->d_open = at45d_open;
253 sc->disk->d_close = at45d_close;
254 sc->disk->d_strategy = at45d_strategy;
255 sc->disk->d_name = "flash/spi";
256 sc->disk->d_drv1 = sc;
257 sc->disk->d_maxsize = DFLTPHYS;
258 sc->disk->d_sectorsize = pagesize;
259 sc->disk->d_mediasize = pagesize * ident->pagecount;
260 sc->disk->d_unit = device_get_unit(sc->dev);
261 disk_create(sc->disk, DISK_VERSION);
262 bioq_init(&sc->bio_queue);
263 kproc_create(&at45d_task, sc, &sc->p, 0, 0,
264 "task: at45d flash");
265 device_printf(sc->dev, "%s, %d bytes per page, %d pages\n",
266 ident->name, pagesize, ident->pagecount);
269 config_intrhook_disestablish(&sc->config_intrhook);
273 at45d_open(struct disk *dp)
280 at45d_close(struct disk *dp)
287 at45d_strategy(struct bio *bp)
289 struct at45d_softc *sc;
291 sc = (struct at45d_softc *)bp->bio_disk->d_drv1;
293 bioq_disksort(&sc->bio_queue, bp);
299 at45d_task(void *arg)
301 uint8_t rxBuf[8], txBuf[8];
302 struct at45d_softc *sc;
304 struct spi_command cmd;
308 u_int addr, berr, err, offset, page;
311 sc = (struct at45d_softc*)arg;
313 pdev = device_get_parent(dev);
314 memset(&cmd, 0, sizeof(cmd));
315 memset(txBuf, 0, sizeof(txBuf));
316 memset(rxBuf, 0, sizeof(rxBuf));
323 bp = bioq_takefirst(&sc->bio_queue);
325 msleep(sc, &sc->sc_mtx, PRIBIO, "jobqueue", 0);
326 } while (bp == NULL);
331 len = resid = bp->bio_bcount;
332 page = bp->bio_offset / sc->pagesize;
333 offset = bp->bio_offset % sc->pagesize;
335 switch (bp->bio_cmd) {
337 txBuf[0] = CONTINUOUS_ARRAY_READ;
338 cmd.tx_cmd_sz = cmd.rx_cmd_sz = 8;
339 cmd.tx_data = cmd.rx_data = buf;
342 cmd.tx_cmd_sz = cmd.rx_cmd_sz = 4;
343 cmd.tx_data = cmd.rx_data = buf;
344 if (resid + offset > sc->pagesize)
345 len = sc->pagesize - offset;
353 * NB: for BIO_READ, this loop is only traversed once.
356 if (page > sc->pagecount) {
360 addr = page << sc->pageoffset;
361 if (bp->bio_cmd == BIO_WRITE) {
362 if (len != sc->pagesize) {
363 txBuf[0] = BUFFER_TRANSFER;
364 txBuf[1] = ((addr >> 16) & 0xff);
365 txBuf[2] = ((addr >> 8) & 0xff);
367 cmd.tx_data_sz = cmd.rx_data_sz = 0;
368 err = SPIBUS_TRANSFER(pdev, dev,
371 err = at45d_wait_ready(dev,
378 txBuf[0] = PROGRAM_THROUGH_BUFFER;
382 txBuf[1] = ((addr >> 16) & 0xff);
383 txBuf[2] = ((addr >> 8) & 0xff);
384 txBuf[3] = (addr & 0xff);
385 cmd.tx_data_sz = cmd.rx_data_sz = len;
386 err = SPIBUS_TRANSFER(pdev, dev, &cmd);
387 if (err == 0 && bp->bio_cmd != BIO_READ)
388 err = at45d_wait_ready(dev, &status);
393 if (bp->bio_cmd == BIO_WRITE) {
394 addr = page << sc->pageoffset;
395 txBuf[0] = BUFFER_COMPARE;
396 txBuf[1] = ((addr >> 16) & 0xff);
397 txBuf[2] = ((addr >> 8) & 0xff);
399 cmd.tx_data_sz = cmd.rx_data_sz = 0;
400 err = SPIBUS_TRANSFER(pdev, dev, &cmd);
402 err = at45d_wait_ready(dev, &status);
403 if (err != 0 || (status & 0x40) != 0) {
404 device_printf(dev, "comparing page "
405 "%d failed (status=0x%x)\n", addr,
415 if (resid > sc->pagesize)
419 cmd.tx_data = cmd.rx_data = buf;
423 bp->bio_flags |= BIO_ERROR;
424 bp->bio_error = berr;
426 bp->bio_resid = resid;
431 static devclass_t at45d_devclass;
433 static device_method_t at45d_methods[] = {
434 /* Device interface */
435 DEVMETHOD(device_probe, at45d_probe),
436 DEVMETHOD(device_attach, at45d_attach),
437 DEVMETHOD(device_detach, at45d_detach),
442 static driver_t at45d_driver = {
445 sizeof(struct at45d_softc),
448 DRIVER_MODULE(at45d, spibus, at45d_driver, at45d_devclass, NULL, NULL);