2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 2019 Justin Hibbits
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
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.
15 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
16 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
17 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
18 * DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
19 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
20 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
21 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
23 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
24 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
25 * POSSIBILITY OF SUCH DAMAGE.
30 #include <sys/param.h>
31 #include <sys/systm.h>
32 #include <sys/module.h>
36 #include <sys/kernel.h>
37 #include <sys/mutex.h>
40 #include <dev/ofw/openfirm.h>
41 #include <dev/ofw/ofw_bus.h>
42 #include <dev/ofw/ofw_bus_subr.h>
44 #include <machine/bus.h>
45 #include <machine/md_var.h>
46 #include <machine/pio.h>
47 #include <machine/resource.h>
56 #define NVRAM_BUFSIZE (65536) /* 64k blocks */
58 struct opal_nvram_softc {
63 vm_paddr_t sc_buf_phys;
69 #define NVRAM_LOCK(sc) mtx_lock(&sc->sc_mtx)
70 #define NVRAM_UNLOCK(sc) mtx_unlock(&sc->sc_mtx)
75 static int opal_nvram_probe(device_t);
76 static int opal_nvram_attach(device_t);
77 static int opal_nvram_detach(device_t);
82 static device_method_t opal_nvram_methods[] = {
83 /* Device interface */
84 DEVMETHOD(device_probe, opal_nvram_probe),
85 DEVMETHOD(device_attach, opal_nvram_attach),
86 DEVMETHOD(device_detach, opal_nvram_detach),
91 static driver_t opal_nvram_driver = {
94 sizeof(struct opal_nvram_softc)
97 static devclass_t opal_nvram_devclass;
99 DRIVER_MODULE(opal_nvram, opal, opal_nvram_driver, opal_nvram_devclass, 0, 0);
105 static d_open_t opal_nvram_open;
106 static d_close_t opal_nvram_close;
107 static d_read_t opal_nvram_read;
108 static d_write_t opal_nvram_write;
109 static d_ioctl_t opal_nvram_ioctl;
111 static struct cdevsw opal_nvram_cdevsw = {
112 .d_version = D_VERSION,
113 .d_open = opal_nvram_open,
114 .d_close = opal_nvram_close,
115 .d_read = opal_nvram_read,
116 .d_write = opal_nvram_write,
117 .d_ioctl = opal_nvram_ioctl,
122 opal_nvram_probe(device_t dev)
125 if (!ofw_bus_is_compatible(dev, "ibm,opal-nvram"))
128 device_set_desc(dev, "OPAL NVRAM");
129 return (BUS_PROBE_DEFAULT);
133 opal_nvram_attach(device_t dev)
135 struct opal_nvram_softc *sc;
139 node = ofw_bus_get_node(dev);
140 sc = device_get_softc(dev);
144 err = OF_getencprop(node, "#bytes", &sc->sc_size,
145 sizeof(sc->sc_size));
150 sc->sc_buf = contigmalloc(NVRAM_BUFSIZE, M_DEVBUF, M_WAITOK,
151 0, BUS_SPACE_MAXADDR, PAGE_SIZE, 0);
152 if (sc->sc_buf == NULL) {
153 device_printf(dev, "No memory for buffer.\n");
156 sc->sc_buf_phys = pmap_kextract((vm_offset_t)sc->sc_buf);
157 sc->sc_cdev = make_dev(&opal_nvram_cdevsw, 0, 0, 0, 0600,
159 sc->sc_cdev->si_drv1 = sc;
161 mtx_init(&sc->sc_mtx, "opal_nvram", 0, MTX_DEF);
167 opal_nvram_detach(device_t dev)
169 struct opal_nvram_softc *sc;
171 sc = device_get_softc(dev);
173 if (sc->sc_cdev != NULL)
174 destroy_dev(sc->sc_cdev);
175 if (sc->sc_buf != NULL)
176 contigfree(sc->sc_buf, NVRAM_BUFSIZE, M_DEVBUF);
178 mtx_destroy(&sc->sc_mtx);
184 opal_nvram_open(struct cdev *dev, int flags, int fmt, struct thread *td)
186 struct opal_nvram_softc *sc = dev->si_drv1;
202 opal_nvram_close(struct cdev *dev, int fflag, int devtype, struct thread *td)
204 struct opal_nvram_softc *sc = dev->si_drv1;
214 opal_nvram_read(struct cdev *dev, struct uio *uio, int ioflag)
216 struct opal_nvram_softc *sc = dev->si_drv1;
222 while (uio->uio_resid > 0) {
223 amnt = MIN(uio->uio_resid, sc->sc_size - uio->uio_offset);
224 amnt = MIN(amnt, NVRAM_BUFSIZE);
228 rv = opal_call(OPAL_READ_NVRAM, sc->sc_buf_phys,
229 amnt, uio->uio_offset);
230 if (rv != OPAL_SUCCESS) {
241 rv = uiomove(sc->sc_buf, amnt, uio);
251 opal_nvram_write(struct cdev *dev, struct uio *uio, int ioflag)
255 struct opal_nvram_softc *sc = dev->si_drv1;
260 while (uio->uio_resid > 0) {
261 amnt = MIN(uio->uio_resid, sc->sc_size - uio->uio_offset);
262 amnt = MIN(amnt, NVRAM_BUFSIZE);
267 offset = uio->uio_offset;
268 rv = uiomove(sc->sc_buf, amnt, uio);
271 rv = opal_call(OPAL_WRITE_NVRAM, sc->sc_buf_phys, amnt,
273 if (rv != OPAL_SUCCESS) {
292 opal_nvram_ioctl(struct cdev *dev, u_long cmd, caddr_t data, int fflag,
295 struct opal_nvram_softc *sc = dev->si_drv1;
299 *(off_t *)data = sc->sc_size;