2 * Copyright (c) 2019 Justin Hibbits
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions
7 * 1. Redistributions of source code must retain the above copyright
8 * notice, this list of conditions and the following disclaimer.
9 * 2. Redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution.
13 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26 #include <sys/cdefs.h>
27 #include <sys/param.h>
28 #include <sys/systm.h>
31 #include <sys/kernel.h>
32 #include <sys/kthread.h>
34 #include <sys/module.h>
35 #include <sys/mutex.h>
37 #include <geom/geom_disk.h>
42 #include <dev/ofw/ofw_bus.h>
43 #include <dev/ofw/ofw_bus_subr.h>
44 #include <dev/ofw/openfirm.h>
48 * OPAL System flash driver, using OPAL firmware calls to access the device.
50 * This just presents the base block interface. The fdt_slicer can be used on
51 * top to present the partitions listed in the fdt.
53 * There are three OPAL methods used: OPAL_FLASH_READ, OPAL_FLASH_WRITE, and
54 * OPAL_FLASH_ERASE. At the firmware layer, READ and WRITE can be on arbitrary
55 * boundaries, but ERASE is only at flash-block-size block alignments and sizes.
56 * To account for this, the following restrictions are in place:
58 * - Reads are on a 512-byte block boundary and size
59 * - Writes and Erases are aligned and sized on flash-block-size bytes.
61 * In order to support the fdt_slicer we present a type attribute of
64 struct opalflash_softc {
69 struct bio_queue_head sc_bio_queue;
71 bool sc_erase; /* Erase is needed before write. */
74 #define OPALFLASH_LOCK(sc) mtx_lock(&(sc)->sc_mtx)
75 #define OPALFLASH_UNLOCK(sc) mtx_unlock(&(sc)->sc_mtx)
76 #define OPALFLASH_LOCK_INIT(sc) \
77 mtx_init(&(sc)->sc_mtx, device_get_nameunit((sc)->sc_dev), \
80 #define FLASH_BLOCKSIZE 512
82 static int opalflash_probe(device_t);
83 static int opalflash_attach(device_t);
85 static device_method_t opalflash_methods[] = {
86 /* Device interface */
87 DEVMETHOD(device_probe, opalflash_probe),
88 DEVMETHOD(device_attach, opalflash_attach),
93 static driver_t opalflash_driver = {
96 sizeof(struct opalflash_softc)
99 DRIVER_MODULE(opalflash, opal, opalflash_driver, 0, 0);
101 /* GEOM Disk interfaces. */
103 opalflash_open(struct disk *dp)
110 opalflash_close(struct disk *dp)
117 opalflash_ioctl(struct disk *dp, u_long cmd, void *data, int fflag,
124 /* Handle the one attribute we need to play nice with geom_flashmap. */
126 opalflash_getattr(struct bio *bp)
128 struct opalflash_softc *sc;
131 if (bp->bio_disk == NULL || bp->bio_disk->d_drv1 == NULL)
134 sc = bp->bio_disk->d_drv1;
137 if (strcmp(bp->bio_attribute, "NAND::device") == 0) {
138 if (bp->bio_length != sizeof(dev))
140 bcopy(&dev, bp->bio_data, sizeof(dev));
147 opalflash_strategy(struct bio *bp)
149 struct opalflash_softc *sc;
151 sc = (struct opalflash_softc *)bp->bio_disk->d_drv1;
153 bioq_disksort(&sc->sc_bio_queue, bp);
155 OPALFLASH_UNLOCK(sc);
159 opalflash_read(struct opalflash_softc *sc, off_t off,
160 caddr_t data, off_t count)
165 /* Ensure we write aligned to a full block size. */
166 if (off % sc->sc_disk->d_sectorsize != 0 ||
167 count % sc->sc_disk->d_sectorsize != 0)
170 token = opal_alloc_async_token();
173 * Read one page at a time. It's not guaranteed that the buffer is
174 * physically contiguous.
178 size = MIN(count, PAGE_SIZE);
179 size = MIN(size, PAGE_SIZE - ((u_long)data & PAGE_MASK));
180 rv = opal_call(OPAL_FLASH_READ, sc->sc_opal_id, off,
181 vtophys(data), size, token);
182 if (rv == OPAL_ASYNC_COMPLETION) {
183 rv = opal_wait_completion(&msg, sizeof(msg), token);
184 if (rv == OPAL_SUCCESS)
187 if (rv != OPAL_SUCCESS)
193 opal_free_async_token(token);
194 if (rv == OPAL_SUCCESS)
203 opalflash_erase(struct opalflash_softc *sc, off_t off, off_t count)
208 /* Ensure we write aligned to a full block size. */
209 if (off % sc->sc_disk->d_stripesize != 0 ||
210 count % sc->sc_disk->d_stripesize != 0)
213 token = opal_alloc_async_token();
215 rv = opal_call(OPAL_FLASH_ERASE, sc->sc_opal_id, off, count, token);
216 if (rv == OPAL_ASYNC_COMPLETION) {
217 rv = opal_wait_completion(&msg, sizeof(msg), token);
218 if (rv == OPAL_SUCCESS)
221 opal_free_async_token(token);
223 if (rv == OPAL_SUCCESS)
232 opalflash_write(struct opalflash_softc *sc, off_t off,
233 caddr_t data, off_t count)
238 /* Ensure we write aligned to a full block size. */
239 if (off % sc->sc_disk->d_sectorsize != 0 ||
240 count % sc->sc_disk->d_sectorsize != 0)
244 /* Erase the full block first, then write in page chunks. */
245 rv = opalflash_erase(sc, off, count);
250 token = opal_alloc_async_token();
253 * Write one page at a time. It's not guaranteed that the buffer is
254 * physically contiguous.
257 size = MIN(count, PAGE_SIZE);
258 size = MIN(size, PAGE_SIZE - ((u_long)data & PAGE_MASK));
259 rv = opal_call(OPAL_FLASH_WRITE, sc->sc_opal_id, off,
260 vtophys(data), size, token);
261 if (rv == OPAL_ASYNC_COMPLETION) {
262 rv = opal_wait_completion(&msg, sizeof(msg), token);
263 if (rv == OPAL_SUCCESS)
266 if (rv != OPAL_SUCCESS)
272 opal_free_async_token(token);
274 if (rv == OPAL_SUCCESS)
282 /* Main flash handling task. */
284 opalflash_task(void *arg)
286 struct opalflash_softc *sc;
294 bp = bioq_first(&sc->sc_bio_queue);
296 msleep(sc, &sc->sc_mtx, PRIBIO, "opalflash", 0);
297 } while (bp == NULL);
298 bioq_remove(&sc->sc_bio_queue, bp);
299 OPALFLASH_UNLOCK(sc);
301 switch (bp->bio_cmd) {
303 bp->bio_error = opalflash_erase(sc, bp->bio_offset,
307 bp->bio_error = opalflash_read(sc, bp->bio_offset,
308 bp->bio_data, bp->bio_bcount);
311 bp->bio_error = opalflash_write(sc, bp->bio_offset,
312 bp->bio_data, bp->bio_bcount);
315 bp->bio_error = EINVAL;
321 /* Device driver interfaces. */
324 opalflash_probe(device_t dev)
326 if (!ofw_bus_is_compatible(dev, "ibm,opal-flash"))
329 device_set_desc(dev, "OPAL System Flash");
331 return (BUS_PROBE_GENERIC);
335 opalflash_attach(device_t dev)
337 struct opalflash_softc *sc;
339 cell_t flash_blocksize, opal_id;
342 sc = device_get_softc(dev);
345 node = ofw_bus_get_node(dev);
346 OF_getencprop(node, "ibm,opal-id", &opal_id, sizeof(opal_id));
347 sc->sc_opal_id = opal_id;
349 if (OF_getencprop(node, "ibm,flash-block-size",
350 &flash_blocksize, sizeof(flash_blocksize)) < 0) {
351 device_printf(dev, "Cannot determine flash block size.\n");
355 if (!OF_hasprop(node, "no-erase"))
358 OPALFLASH_LOCK_INIT(sc);
360 if (OF_getencprop(node, "reg", regs, sizeof(regs)) < 0) {
361 device_printf(dev, "Unable to get flash size.\n");
365 sc->sc_disk = disk_alloc();
366 sc->sc_disk->d_name = "opalflash";
367 sc->sc_disk->d_open = opalflash_open;
368 sc->sc_disk->d_close = opalflash_close;
369 sc->sc_disk->d_strategy = opalflash_strategy;
370 sc->sc_disk->d_ioctl = opalflash_ioctl;
371 sc->sc_disk->d_getattr = opalflash_getattr;
372 sc->sc_disk->d_drv1 = sc;
373 sc->sc_disk->d_maxsize = DFLTPHYS;
374 sc->sc_disk->d_mediasize = regs[1];
375 sc->sc_disk->d_unit = device_get_unit(sc->sc_dev);
376 sc->sc_disk->d_sectorsize = FLASH_BLOCKSIZE;
377 sc->sc_disk->d_stripesize = flash_blocksize;
378 sc->sc_disk->d_dump = NULL;
380 disk_create(sc->sc_disk, DISK_VERSION);
381 bioq_init(&sc->sc_bio_queue);
383 kproc_create(&opalflash_task, sc, &sc->sc_p, 0, 0, "task: OPAL Flash");