1 /*-
2 * Copyright (c) 2019 Justin Hibbits
3 *
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions
6 * are met:
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.
12 *
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
23 * SUCH DAMAGE.
24 */
25
26 #include <sys/cdefs.h>
27 #include <sys/param.h>
28 #include <sys/systm.h>
29 #include <sys/bio.h>
30 #include <sys/bus.h>
31 #include <sys/kernel.h>
32 #include <sys/kthread.h>
33 #include <sys/lock.h>
34 #include <sys/module.h>
35 #include <sys/mutex.h>
36 #include <sys/proc.h>
37 #include <geom/geom_disk.h>
38
39 #include <vm/vm.h>
40 #include <vm/pmap.h>
41
42 #include <dev/ofw/ofw_bus.h>
43 #include <dev/ofw/ofw_bus_subr.h>
44 #include <dev/ofw/openfirm.h>
45 #include "opal.h"
46
47 /*
48 * OPAL System flash driver, using OPAL firmware calls to access the device.
49 *
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.
52 *
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:
57 *
58 * - Reads are on a 512-byte block boundary and size
59 * - Writes and Erases are aligned and sized on flash-block-size bytes.
60 *
61 * In order to support the fdt_slicer we present a type attribute of
62 * NAND::device.
63 */
64 struct opalflash_softc {
65 device_t sc_dev;
66 struct mtx sc_mtx;
67 struct disk *sc_disk;
68 struct proc *sc_p;
69 struct bio_queue_head sc_bio_queue;
70 int sc_opal_id;
71 bool sc_erase; /* Erase is needed before write. */
72 };
73
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), \
78 "opalflash", MTX_DEF)
79
80 #define FLASH_BLOCKSIZE 512
81
82 static int opalflash_probe(device_t);
83 static int opalflash_attach(device_t);
84
85 static device_method_t opalflash_methods[] = {
86 /* Device interface */
87 DEVMETHOD(device_probe, opalflash_probe),
88 DEVMETHOD(device_attach, opalflash_attach),
89
90 DEVMETHOD_END
91 };
92
93 static driver_t opalflash_driver = {
94 "opalflash",
95 opalflash_methods,
96 sizeof(struct opalflash_softc)
97 };
98
99 static devclass_t opalflash_devclass;
100
101 DRIVER_MODULE(opalflash, opal, opalflash_driver, opalflash_devclass, 0, 0);
102
103 /* GEOM Disk interfaces. */
104 static int
opalflash_open(struct disk * dp)105 opalflash_open(struct disk *dp)
106 {
107
108 return (0);
109 }
110
111 static int
opalflash_close(struct disk * dp)112 opalflash_close(struct disk *dp)
113 {
114
115 return (0);
116 }
117
118 static int
opalflash_ioctl(struct disk * dp,u_long cmd,void * data,int fflag,struct thread * td)119 opalflash_ioctl(struct disk *dp, u_long cmd, void *data, int fflag,
120 struct thread *td)
121 {
122
123 return (EINVAL);
124 }
125
126 /* Handle the one attribute we need to play nice with geom_flashmap. */
127 static int
opalflash_getattr(struct bio * bp)128 opalflash_getattr(struct bio *bp)
129 {
130 struct opalflash_softc *sc;
131 device_t dev;
132
133 if (bp->bio_disk == NULL || bp->bio_disk->d_drv1 == NULL)
134 return (ENXIO);
135
136 sc = bp->bio_disk->d_drv1;
137 dev = sc->sc_dev;
138
139 if (strcmp(bp->bio_attribute, "NAND::device") == 0) {
140 if (bp->bio_length != sizeof(dev))
141 return (EFAULT);
142 bcopy(&dev, bp->bio_data, sizeof(dev));
143 } else
144 return (-1);
145 return (0);
146 }
147
148 static void
opalflash_strategy(struct bio * bp)149 opalflash_strategy(struct bio *bp)
150 {
151 struct opalflash_softc *sc;
152
153 sc = (struct opalflash_softc *)bp->bio_disk->d_drv1;
154 OPALFLASH_LOCK(sc);
155 bioq_disksort(&sc->sc_bio_queue, bp);
156 wakeup(sc);
157 OPALFLASH_UNLOCK(sc);
158 }
159
160 static int
opalflash_read(struct opalflash_softc * sc,off_t off,caddr_t data,off_t count)161 opalflash_read(struct opalflash_softc *sc, off_t off,
162 caddr_t data, off_t count)
163 {
164 struct opal_msg msg;
165 int rv, size, token;
166
167 /* Ensure we write aligned to a full block size. */
168 if (off % sc->sc_disk->d_sectorsize != 0 ||
169 count % sc->sc_disk->d_sectorsize != 0)
170 return (EIO);
171
172 token = opal_alloc_async_token();
173
174 /*
175 * Read one page at a time. It's not guaranteed that the buffer is
176 * physically contiguous.
177 */
178 rv = 0;
179 while (count > 0) {
180 size = MIN(count, PAGE_SIZE);
181 size = MIN(size, PAGE_SIZE - ((u_long)data & PAGE_MASK));
182 rv = opal_call(OPAL_FLASH_READ, sc->sc_opal_id, off,
183 vtophys(data), size, token);
184 if (rv == OPAL_ASYNC_COMPLETION) {
185 rv = opal_wait_completion(&msg, sizeof(msg), token);
186 if (rv == OPAL_SUCCESS)
187 rv = msg.params[1];
188 }
189 if (rv != OPAL_SUCCESS)
190 break;
191 count -= size;
192 off += size;
193 data += size;
194 }
195 opal_free_async_token(token);
196 if (rv == OPAL_SUCCESS)
197 rv = 0;
198 else
199 rv = EIO;
200
201 return (rv);
202 }
203
204 static int
opalflash_erase(struct opalflash_softc * sc,off_t off,off_t count)205 opalflash_erase(struct opalflash_softc *sc, off_t off, off_t count)
206 {
207 struct opal_msg msg;
208 int rv, token;
209
210 /* Ensure we write aligned to a full block size. */
211 if (off % sc->sc_disk->d_stripesize != 0 ||
212 count % sc->sc_disk->d_stripesize != 0)
213 return (EIO);
214
215 token = opal_alloc_async_token();
216
217 rv = opal_call(OPAL_FLASH_ERASE, sc->sc_opal_id, off, count, token);
218 if (rv == OPAL_ASYNC_COMPLETION) {
219 rv = opal_wait_completion(&msg, sizeof(msg), token);
220 if (rv == OPAL_SUCCESS)
221 rv = msg.params[1];
222 }
223 opal_free_async_token(token);
224
225 if (rv == OPAL_SUCCESS)
226 rv = 0;
227 else
228 rv = EIO;
229
230 return (rv);
231 }
232
233 static int
opalflash_write(struct opalflash_softc * sc,off_t off,caddr_t data,off_t count)234 opalflash_write(struct opalflash_softc *sc, off_t off,
235 caddr_t data, off_t count)
236 {
237 struct opal_msg msg;
238 int rv, size, token;
239
240 /* Ensure we write aligned to a full block size. */
241 if (off % sc->sc_disk->d_sectorsize != 0 ||
242 count % sc->sc_disk->d_sectorsize != 0)
243 return (EIO);
244
245 if (sc->sc_erase) {
246 /* Erase the full block first, then write in page chunks. */
247 rv = opalflash_erase(sc, off, count);
248 if (rv != 0)
249 return (rv);
250 }
251
252 token = opal_alloc_async_token();
253
254 /*
255 * Write one page at a time. It's not guaranteed that the buffer is
256 * physically contiguous.
257 */
258 while (count > 0) {
259 size = MIN(count, PAGE_SIZE);
260 size = MIN(size, PAGE_SIZE - ((u_long)data & PAGE_MASK));
261 rv = opal_call(OPAL_FLASH_WRITE, sc->sc_opal_id, off,
262 vtophys(data), size, token);
263 if (rv == OPAL_ASYNC_COMPLETION) {
264 rv = opal_wait_completion(&msg, sizeof(msg), token);
265 if (rv == OPAL_SUCCESS)
266 rv = msg.params[1];
267 }
268 if (rv != OPAL_SUCCESS)
269 break;
270 count -= size;
271 off += size;
272 data += size;
273 }
274 opal_free_async_token(token);
275
276 if (rv == OPAL_SUCCESS)
277 rv = 0;
278 else
279 rv = EIO;
280
281 return (rv);
282 }
283
284 /* Main flash handling task. */
285 static void
opalflash_task(void * arg)286 opalflash_task(void *arg)
287 {
288 struct opalflash_softc *sc;
289 struct bio *bp;
290 device_t dev;
291
292 sc = arg;
293
294 for (;;) {
295 dev = sc->sc_dev;
296 OPALFLASH_LOCK(sc);
297 do {
298 bp = bioq_first(&sc->sc_bio_queue);
299 if (bp == NULL)
300 msleep(sc, &sc->sc_mtx, PRIBIO, "opalflash", 0);
301 } while (bp == NULL);
302 bioq_remove(&sc->sc_bio_queue, bp);
303 OPALFLASH_UNLOCK(sc);
304
305 switch (bp->bio_cmd) {
306 case BIO_DELETE:
307 bp->bio_error = opalflash_erase(sc, bp->bio_offset,
308 bp->bio_bcount);
309 break;
310 case BIO_READ:
311 bp->bio_error = opalflash_read(sc, bp->bio_offset,
312 bp->bio_data, bp->bio_bcount);
313 break;
314 case BIO_WRITE:
315 bp->bio_error = opalflash_write(sc, bp->bio_offset,
316 bp->bio_data, bp->bio_bcount);
317 break;
318 default:
319 bp->bio_error = EINVAL;
320 }
321 biodone(bp);
322 }
323 }
324
325 /* Device driver interfaces. */
326
327 static int
opalflash_probe(device_t dev)328 opalflash_probe(device_t dev)
329 {
330 if (!ofw_bus_is_compatible(dev, "ibm,opal-flash"))
331 return (ENXIO);
332
333 device_set_desc(dev, "OPAL System Flash");
334
335 return (BUS_PROBE_GENERIC);
336 }
337
338 static int
opalflash_attach(device_t dev)339 opalflash_attach(device_t dev)
340 {
341 struct opalflash_softc *sc;
342 phandle_t node;
343 cell_t flash_blocksize, opal_id;
344 uint32_t regs[2];
345
346 sc = device_get_softc(dev);
347 sc->sc_dev = dev;
348
349 node = ofw_bus_get_node(dev);
350 OF_getencprop(node, "ibm,opal-id", &opal_id, sizeof(opal_id));
351 sc->sc_opal_id = opal_id;
352
353 if (OF_getencprop(node, "ibm,flash-block-size",
354 &flash_blocksize, sizeof(flash_blocksize)) < 0) {
355 device_printf(dev, "Cannot determine flash block size.\n");
356 return (ENXIO);
357 }
358
359 if (!OF_hasprop(node, "no-erase"))
360 sc->sc_erase = true;
361
362 OPALFLASH_LOCK_INIT(sc);
363
364 if (OF_getencprop(node, "reg", regs, sizeof(regs)) < 0) {
365 device_printf(dev, "Unable to get flash size.\n");
366 return (ENXIO);
367 }
368
369 sc->sc_disk = disk_alloc();
370 sc->sc_disk->d_name = "opalflash";
371 sc->sc_disk->d_open = opalflash_open;
372 sc->sc_disk->d_close = opalflash_close;
373 sc->sc_disk->d_strategy = opalflash_strategy;
374 sc->sc_disk->d_ioctl = opalflash_ioctl;
375 sc->sc_disk->d_getattr = opalflash_getattr;
376 sc->sc_disk->d_drv1 = sc;
377 sc->sc_disk->d_maxsize = DFLTPHYS;
378 sc->sc_disk->d_mediasize = regs[1];
379 sc->sc_disk->d_unit = device_get_unit(sc->sc_dev);
380 sc->sc_disk->d_sectorsize = FLASH_BLOCKSIZE;
381 sc->sc_disk->d_stripesize = flash_blocksize;
382 sc->sc_disk->d_dump = NULL;
383
384 disk_create(sc->sc_disk, DISK_VERSION);
385 bioq_init(&sc->sc_bio_queue);
386
387 kproc_create(&opalflash_task, sc, &sc->sc_p, 0, 0, "task: OPAL Flash");
388
389 return (0);
390 }
391