xref: /freebsd-11-stable/sys/dev/flash/mx25l.c (revision 755cea5587b1ff5f93350e2ee35a4b5a26ce0591)
1 /*-
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.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
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.
14  *
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.
25  */
26 
27 #include <sys/cdefs.h>
28 __FBSDID("$FreeBSD$");
29 
30 #include "opt_platform.h"
31 
32 #include <sys/param.h>
33 #include <sys/systm.h>
34 #include <sys/bio.h>
35 #include <sys/bus.h>
36 #include <sys/conf.h>
37 #include <sys/kernel.h>
38 #include <sys/kthread.h>
39 #include <sys/lock.h>
40 #include <sys/mbuf.h>
41 #include <sys/malloc.h>
42 #include <sys/module.h>
43 #include <sys/mutex.h>
44 #include <geom/geom_disk.h>
45 
46 #ifdef FDT
47 #include <dev/fdt/fdt_common.h>
48 #include <dev/ofw/ofw_bus_subr.h>
49 #include <dev/ofw/openfirm.h>
50 #endif
51 
52 #include <dev/spibus/spi.h>
53 #include "spibus_if.h"
54 
55 #include <dev/flash/mx25lreg.h>
56 
57 #define	FL_NONE			0x00
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
62 
63 /*
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.
67  */
68 #define	MX25L_SECTORSIZE	512
69 
70 struct mx25l_flash_ident
71 {
72 	const char	*name;
73 	uint8_t		manufacturer_id;
74 	uint16_t	device_id;
75 	unsigned int	sectorsize;
76 	unsigned int	sectorcount;
77 	unsigned int	flags;
78 };
79 
80 struct mx25l_softc
81 {
82 	device_t	sc_dev;
83 	device_t	sc_parent;
84 	uint8_t		sc_manufacturer_id;
85 	uint16_t	sc_device_id;
86 	unsigned int	sc_erasesize;
87 	struct mtx	sc_mtx;
88 	struct disk	*sc_disk;
89 	struct proc	*sc_p;
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];
94 };
95 
96 #define	TSTATE_STOPPED	0
97 #define	TSTATE_STOPPING	1
98 #define	TSTATE_RUNNING	2
99 
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), \
104 	    "mx25l", MTX_DEF)
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);
108 
109 /* disk routines */
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);
116 
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 },
135 
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 },
144 
145 	 /* Atmel */
146 	{ "at25df641",  0x1f, 0x4800, 64 * 1024, 128, FL_ERASE_4K },
147 
148 	/* GigaDevice */
149 	{ "gd25q64",	0xc8, 0x4017, 64 * 1024, 128, FL_ERASE_4K },
150 };
151 
152 static int
mx25l_wait_for_device_ready(struct mx25l_softc * sc)153 mx25l_wait_for_device_ready(struct mx25l_softc *sc)
154 {
155 	uint8_t txBuf[2], rxBuf[2];
156 	struct spi_command cmd;
157 	int err;
158 
159 	memset(&cmd, 0, sizeof(cmd));
160 
161 	do {
162 		txBuf[0] = CMD_READ_STATUS;
163 		cmd.tx_cmd = txBuf;
164 		cmd.rx_cmd = rxBuf;
165 		cmd.rx_cmd_sz = 2;
166 		cmd.tx_cmd_sz = 2;
167 		err = SPIBUS_TRANSFER(sc->sc_parent, sc->sc_dev, &cmd);
168 	} while (err == 0 && (rxBuf[1] & STATUS_WIP));
169 
170 	return (err);
171 }
172 
173 static struct mx25l_flash_ident*
mx25l_get_device_ident(struct mx25l_softc * sc)174 mx25l_get_device_ident(struct mx25l_softc *sc)
175 {
176 	uint8_t txBuf[8], rxBuf[8];
177 	struct spi_command cmd;
178 	uint8_t manufacturer_id;
179 	uint16_t dev_id;
180 	int err, i;
181 
182 	memset(&cmd, 0, sizeof(cmd));
183 	memset(txBuf, 0, sizeof(txBuf));
184 	memset(rxBuf, 0, sizeof(rxBuf));
185 
186 	txBuf[0] = CMD_READ_IDENT;
187 	cmd.tx_cmd = &txBuf;
188 	cmd.rx_cmd = &rxBuf;
189 	/*
190 	 * Some compatible devices has extended two-bytes ID
191 	 * We'll use only manufacturer/deviceid atm
192 	 */
193 	cmd.tx_cmd_sz = 4;
194 	cmd.rx_cmd_sz = 4;
195 	err = SPIBUS_TRANSFER(sc->sc_parent, sc->sc_dev, &cmd);
196 	if (err)
197 		return (NULL);
198 
199 	manufacturer_id = rxBuf[1];
200 	dev_id = (rxBuf[2] << 8) | (rxBuf[3]);
201 
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];
206 	}
207 
208 	device_printf(sc->sc_dev,
209 	    "Unknown SPI flash device. Vendor: %02x, device id: %04x\n",
210 	    manufacturer_id, dev_id);
211 	return (NULL);
212 }
213 
214 static int
mx25l_set_writable(struct mx25l_softc * sc,int writable)215 mx25l_set_writable(struct mx25l_softc *sc, int writable)
216 {
217 	uint8_t txBuf[1], rxBuf[1];
218 	struct spi_command cmd;
219 	int err;
220 
221 	memset(&cmd, 0, sizeof(cmd));
222 	memset(txBuf, 0, sizeof(txBuf));
223 	memset(rxBuf, 0, sizeof(rxBuf));
224 
225 	txBuf[0] = writable ? CMD_WRITE_ENABLE : CMD_WRITE_DISABLE;
226 	cmd.tx_cmd = txBuf;
227 	cmd.rx_cmd = rxBuf;
228 	cmd.rx_cmd_sz = 1;
229 	cmd.tx_cmd_sz = 1;
230 	err = SPIBUS_TRANSFER(sc->sc_parent, sc->sc_dev, &cmd);
231 	return (err);
232 }
233 
234 static int
mx25l_erase_cmd(struct mx25l_softc * sc,off_t sector)235 mx25l_erase_cmd(struct mx25l_softc *sc, off_t sector)
236 {
237 	uint8_t txBuf[5], rxBuf[5];
238 	struct spi_command cmd;
239 	int err;
240 
241 	if ((err = mx25l_set_writable(sc, 1)) != 0)
242 		return (err);
243 
244 	memset(&cmd, 0, sizeof(cmd));
245 	memset(txBuf, 0, sizeof(txBuf));
246 	memset(rxBuf, 0, sizeof(rxBuf));
247 
248 	cmd.tx_cmd = txBuf;
249 	cmd.rx_cmd = rxBuf;
250 
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;
255 	else
256 		txBuf[0] = CMD_SECTOR_ERASE;
257 
258 	if (sc->sc_flags & FL_ENABLE_4B_ADDR) {
259 		cmd.rx_cmd_sz = 5;
260 		cmd.tx_cmd_sz = 5;
261 		txBuf[1] = ((sector >> 24) & 0xff);
262 		txBuf[2] = ((sector >> 16) & 0xff);
263 		txBuf[3] = ((sector >> 8) & 0xff);
264 		txBuf[4] = (sector & 0xff);
265 	} else {
266 		cmd.rx_cmd_sz = 4;
267 		cmd.tx_cmd_sz = 4;
268 		txBuf[1] = ((sector >> 16) & 0xff);
269 		txBuf[2] = ((sector >> 8) & 0xff);
270 		txBuf[3] = (sector & 0xff);
271 	}
272 	if ((err = SPIBUS_TRANSFER(sc->sc_parent, sc->sc_dev, &cmd)) != 0)
273 		return (err);
274 	err = mx25l_wait_for_device_ready(sc);
275 	return (err);
276 }
277 
278 static int
mx25l_write(struct mx25l_softc * sc,off_t offset,caddr_t data,off_t count)279 mx25l_write(struct mx25l_softc *sc, off_t offset, caddr_t data, off_t count)
280 {
281 	uint8_t txBuf[8], rxBuf[8];
282 	struct spi_command cmd;
283 	off_t bytes_to_write;
284 	int err = 0;
285 
286 	if (sc->sc_flags & FL_ENABLE_4B_ADDR) {
287 		cmd.tx_cmd_sz = 5;
288 		cmd.rx_cmd_sz = 5;
289 	} else {
290 		cmd.tx_cmd_sz = 4;
291 		cmd.rx_cmd_sz = 4;
292 	}
293 
294 	/*
295 	 * Writes must be aligned to the erase sectorsize, since blocks are
296 	 * fully erased before they're written to.
297 	 */
298 	if (count % sc->sc_erasesize != 0 || offset % sc->sc_erasesize != 0)
299 		return (EIO);
300 
301 	/*
302 	 * Maximum write size for CMD_PAGE_PROGRAM is FLASH_PAGE_SIZE, so loop
303 	 * to write chunks of FLASH_PAGE_SIZE bytes each.
304 	 */
305 	while (count != 0) {
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);
309 			if (err)
310 				break;
311 		}
312 
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;
319 		} else {
320 			txBuf[1] = (offset >> 16) & 0xff;
321 			txBuf[2] = (offset >> 8) & 0xff;
322 			txBuf[3] = offset & 0xff;
323 		}
324 
325 		bytes_to_write = MIN(FLASH_PAGE_SIZE, count);
326 		cmd.tx_cmd = txBuf;
327 		cmd.rx_cmd = rxBuf;
328 		cmd.tx_data = data;
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;
332 
333 		/*
334 		 * Each completed write operation resets WEL (write enable
335 		 * latch) to disabled state, so we re-enable it here.
336 		 */
337 		if ((err = mx25l_wait_for_device_ready(sc)) != 0)
338 			break;
339 		if ((err = mx25l_set_writable(sc, 1)) != 0)
340 			break;
341 
342 		err = SPIBUS_TRANSFER(sc->sc_parent, sc->sc_dev, &cmd);
343 		if (err != 0)
344 			break;
345 		err = mx25l_wait_for_device_ready(sc);
346 		if (err)
347 			break;
348 
349 		data   += bytes_to_write;
350 		offset += bytes_to_write;
351 		count  -= bytes_to_write;
352 	}
353 
354 	return (err);
355 }
356 
357 static int
mx25l_read(struct mx25l_softc * sc,off_t offset,caddr_t data,off_t count)358 mx25l_read(struct mx25l_softc *sc, off_t offset, caddr_t data, off_t count)
359 {
360 	uint8_t txBuf[8], rxBuf[8];
361 	struct spi_command cmd;
362 	int err = 0;
363 
364 	/*
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.
368 	 */
369 	if (count % sc->sc_disk->d_sectorsize != 0 ||
370 	    offset % sc->sc_disk->d_sectorsize != 0)
371 		return (EIO);
372 
373 	txBuf[0] = CMD_FAST_READ;
374 	if (sc->sc_flags & FL_ENABLE_4B_ADDR) {
375 		cmd.tx_cmd_sz = 6;
376 		cmd.rx_cmd_sz = 6;
377 
378 		txBuf[1] = (offset >> 24) & 0xff;
379 		txBuf[2] = (offset >> 16) & 0xff;
380 		txBuf[3] = (offset >> 8) & 0xff;
381 		txBuf[4] = offset & 0xff;
382 		/* Dummy byte */
383 		txBuf[5] = 0;
384 	} else {
385 		cmd.tx_cmd_sz = 5;
386 		cmd.rx_cmd_sz = 5;
387 
388 		txBuf[1] = (offset >> 16) & 0xff;
389 		txBuf[2] = (offset >> 8) & 0xff;
390 		txBuf[3] = offset & 0xff;
391 		/* Dummy byte */
392 		txBuf[4] = 0;
393 	}
394 
395 	cmd.tx_cmd = txBuf;
396 	cmd.rx_cmd = rxBuf;
397 	cmd.tx_data = data;
398 	cmd.rx_data = data;
399 	cmd.tx_data_sz = count;
400 	cmd.rx_data_sz = count;
401 
402 	err = SPIBUS_TRANSFER(sc->sc_parent, sc->sc_dev, &cmd);
403 	return (err);
404 }
405 
406 static int
mx25l_set_4b_mode(struct mx25l_softc * sc,uint8_t command)407 mx25l_set_4b_mode(struct mx25l_softc *sc, uint8_t command)
408 {
409 	uint8_t txBuf[1], rxBuf[1];
410 	struct spi_command cmd;
411 	int err;
412 
413 	memset(&cmd, 0, sizeof(cmd));
414 	memset(txBuf, 0, sizeof(txBuf));
415 	memset(rxBuf, 0, sizeof(rxBuf));
416 
417 	cmd.tx_cmd_sz = cmd.rx_cmd_sz = 1;
418 
419 	cmd.tx_cmd = txBuf;
420 	cmd.rx_cmd = rxBuf;
421 
422 	txBuf[0] = command;
423 
424 	if ((err = SPIBUS_TRANSFER(sc->sc_parent, sc->sc_dev, &cmd)) == 0)
425 		err = mx25l_wait_for_device_ready(sc);
426 
427 	return (err);
428 }
429 
430 #ifdef	FDT
431 static struct ofw_compat_data compat_data[] = {
432 	{ "st,m25p",		1 },
433 	{ "jedec,spi-nor",	1 },
434 	{ NULL,			0 },
435 };
436 #endif
437 
438 static int
mx25l_probe(device_t dev)439 mx25l_probe(device_t dev)
440 {
441 #ifdef FDT
442 	int i;
443 
444 	if (!ofw_bus_status_okay(dev))
445 		return (ENXIO);
446 
447 	/* First try to match the compatible property to the compat_data */
448 	if (ofw_bus_search_compatible(dev, compat_data)->ocd_data == 1)
449 		goto found;
450 
451 	/*
452 	 * Next, try to find a compatible device using the names in the
453 	 * flash_devices structure
454 	 */
455 	for (i = 0; i < nitems(flash_devices); i++)
456 		if (ofw_bus_is_compatible(dev, flash_devices[i].name))
457 			goto found;
458 
459 	return (ENXIO);
460 found:
461 #endif
462 	device_set_desc(dev, "M25Pxx Flash Family");
463 
464 	return (0);
465 }
466 
467 static int
mx25l_attach(device_t dev)468 mx25l_attach(device_t dev)
469 {
470 	struct mx25l_softc *sc;
471 	struct mx25l_flash_ident *ident;
472 	int err;
473 
474 	sc = device_get_softc(dev);
475 	sc->sc_dev = dev;
476 	sc->sc_parent = device_get_parent(sc->sc_dev);
477 
478 	M25PXX_LOCK_INIT(sc);
479 
480 	ident = mx25l_get_device_ident(sc);
481 	if (ident == NULL)
482 		return (ENXIO);
483 
484 	if ((err = mx25l_wait_for_device_ready(sc)) != 0)
485 		return (err);
486 
487 	sc->sc_flags = ident->flags;
488 
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;
493 	else
494 		sc->sc_erasesize = ident->sectorsize;
495 
496 	if (sc->sc_flags & FL_ENABLE_4B_ADDR) {
497 		if ((err = mx25l_set_4b_mode(sc, CMD_ENTER_4B_MODE)) != 0)
498 			return (err);
499 	} else if (sc->sc_flags & FL_DISABLE_4B_ADDR) {
500 		if ((err = mx25l_set_4b_mode(sc, CMD_EXIT_4B_MODE)) != 0)
501 			return (err);
502 	}
503 
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));
520 
521 	disk_create(sc->sc_disk, DISK_VERSION);
522 	bioq_init(&sc->sc_bio_queue);
523 
524 	kproc_create(&mx25l_task, sc, &sc->sc_p, 0, 0, "task: mx25l flash");
525 	sc->sc_taskstate = TSTATE_RUNNING;
526 
527 	device_printf(sc->sc_dev,
528 	    "device type %s, size %dK in %d sectors of %dK, erase size %dK\n",
529 	    ident->name,
530 	    ident->sectorcount * ident->sectorsize / 1024,
531 	    ident->sectorcount, ident->sectorsize / 1024,
532 	    sc->sc_erasesize / 1024);
533 
534 	return (0);
535 }
536 
537 static int
mx25l_detach(device_t dev)538 mx25l_detach(device_t dev)
539 {
540 	struct mx25l_softc *sc;
541 	int err;
542 
543 	sc = device_get_softc(dev);
544 	err = 0;
545 
546 	M25PXX_LOCK(sc);
547 	if (sc->sc_taskstate == TSTATE_RUNNING) {
548 		sc->sc_taskstate = TSTATE_STOPPING;
549 		wakeup(sc);
550 		while (err == 0 && sc->sc_taskstate != TSTATE_STOPPED) {
551 			err = msleep(sc, &sc->sc_mtx, 0, "mx25dt", hz * 3);
552 			if (err != 0) {
553 				sc->sc_taskstate = TSTATE_RUNNING;
554 				device_printf(sc->sc_dev,
555 				    "Failed to stop queue task\n");
556 			}
557 		}
558 	}
559 	M25PXX_UNLOCK(sc);
560 
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);
565 	}
566 	return (err);
567 }
568 
569 static int
mx25l_open(struct disk * dp)570 mx25l_open(struct disk *dp)
571 {
572 	return (0);
573 }
574 
575 static int
mx25l_close(struct disk * dp)576 mx25l_close(struct disk *dp)
577 {
578 
579 	return (0);
580 }
581 
582 static int
mx25l_ioctl(struct disk * dp,u_long cmd,void * data,int fflag,struct thread * td)583 mx25l_ioctl(struct disk *dp, u_long cmd, void *data, int fflag,
584 	struct thread *td)
585 {
586 
587 	return (EINVAL);
588 }
589 
590 static void
mx25l_strategy(struct bio * bp)591 mx25l_strategy(struct bio *bp)
592 {
593 	struct mx25l_softc *sc;
594 
595 	sc = (struct mx25l_softc *)bp->bio_disk->d_drv1;
596 	M25PXX_LOCK(sc);
597 	bioq_disksort(&sc->sc_bio_queue, bp);
598 	wakeup(sc);
599 	M25PXX_UNLOCK(sc);
600 }
601 
602 static int
mx25l_getattr(struct bio * bp)603 mx25l_getattr(struct bio *bp)
604 {
605 	struct mx25l_softc *sc;
606 	device_t dev;
607 
608 	if (bp->bio_disk == NULL || bp->bio_disk->d_drv1 == NULL)
609 		return (ENXIO);
610 
611 	sc = bp->bio_disk->d_drv1;
612 	dev = sc->sc_dev;
613 
614 	if (strcmp(bp->bio_attribute, "SPI::device") == 0) {
615 		if (bp->bio_length != sizeof(dev))
616 			return (EFAULT);
617 		bcopy(&dev, bp->bio_data, sizeof(dev));
618 	} else
619 		return (-1);
620 	return (0);
621 }
622 
623 static void
mx25l_task(void * arg)624 mx25l_task(void *arg)
625 {
626 	struct mx25l_softc *sc = (struct mx25l_softc*)arg;
627 	struct bio *bp;
628 	device_t dev;
629 
630 	for (;;) {
631 		dev = sc->sc_dev;
632 		M25PXX_LOCK(sc);
633 		do {
634 			if (sc->sc_taskstate == TSTATE_STOPPING) {
635 				sc->sc_taskstate = TSTATE_STOPPED;
636 				M25PXX_UNLOCK(sc);
637 				wakeup(sc);
638 				kproc_exit(0);
639 			}
640 			bp = bioq_first(&sc->sc_bio_queue);
641 			if (bp == NULL)
642 				msleep(sc, &sc->sc_mtx, PRIBIO, "mx25jq", 0);
643 		} while (bp == NULL);
644 		bioq_remove(&sc->sc_bio_queue, bp);
645 		M25PXX_UNLOCK(sc);
646 
647 		switch (bp->bio_cmd) {
648 		case BIO_READ:
649 			bp->bio_error = mx25l_read(sc, bp->bio_offset,
650 			    bp->bio_data, bp->bio_bcount);
651 			break;
652 		case BIO_WRITE:
653 			bp->bio_error = mx25l_write(sc, bp->bio_offset,
654 			    bp->bio_data, bp->bio_bcount);
655 			break;
656 		default:
657 			bp->bio_error = EINVAL;
658 		}
659 
660 
661 		biodone(bp);
662 	}
663 }
664 
665 static devclass_t mx25l_devclass;
666 
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),
672 
673 	{ 0, 0 }
674 };
675 
676 static driver_t mx25l_driver = {
677 	"mx25l",
678 	mx25l_methods,
679 	sizeof(struct mx25l_softc),
680 };
681 
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);
685