2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 2012-2013, 2016 Robert N. M. Watson
7 * This software was developed by SRI International and the University of
8 * Cambridge Computer Laboratory under DARPA/AFRL contract (FA8750-10-C-0237)
9 * ("CTSRD"), as part of the DARPA CRASH research programme.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions and the following disclaimer.
16 * 2. Redistributions in binary form must reproduce the above copyright
17 * notice, this list of conditions and the following disclaimer in the
18 * documentation and/or other materials provided with the distribution.
20 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
21 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
24 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33 #include <sys/cdefs.h>
34 __FBSDID("$FreeBSD$");
36 #include <sys/param.h>
39 #include <sys/condvar.h>
41 #include <sys/kernel.h>
43 #include <sys/malloc.h>
44 #include <sys/module.h>
45 #include <sys/mutex.h>
48 #include <sys/systm.h>
51 #include <geom/geom_disk.h>
53 #include <machine/bus.h>
54 #include <machine/resource.h>
58 #include <dev/altera/avgen/altera_avgen.h>
61 * Generic device driver for allowing read(), write(), and mmap() on
62 * memory-mapped, Avalon-attached devices. There is no actual dependence on
63 * Avalon, so conceivably this should just be soc_dev or similar, since many
64 * system-on-chip bus environments would work fine with the same code.
67 devclass_t altera_avgen_devclass;
69 static d_mmap_t altera_avgen_mmap;
70 static d_read_t altera_avgen_read;
71 static d_write_t altera_avgen_write;
73 #define ALTERA_AVGEN_DEVNAME "altera_avgen"
74 #define ALTERA_AVGEN_DEVNAME_FMT (ALTERA_AVGEN_DEVNAME "%d")
76 static struct cdevsw avg_cdevsw = {
77 .d_version = D_VERSION,
78 .d_mmap = altera_avgen_mmap,
79 .d_read = altera_avgen_read,
80 .d_write = altera_avgen_write,
81 .d_name = ALTERA_AVGEN_DEVNAME,
84 #define ALTERA_AVGEN_SECTORSIZE 512 /* Not configurable at this time. */
87 altera_avgen_read(struct cdev *dev, struct uio *uio, int flag)
89 struct altera_avgen_softc *sc;
101 if ((sc->avg_flags & ALTERA_AVALON_FLAG_READ) == 0)
103 width = sc->avg_width;
104 if (uio->uio_offset < 0 || uio->uio_offset % width != 0 ||
105 uio->uio_resid % width != 0)
107 size = rman_get_size(sc->avg_res);
108 if ((uio->uio_offset + uio->uio_resid < 0) ||
109 (uio->uio_offset + uio->uio_resid > size))
111 while (uio->uio_resid > 0) {
112 offset = uio->uio_offset;
113 if (offset + width > size)
117 v1 = bus_read_1(sc->avg_res, offset);
118 error = uiomove(&v1, sizeof(v1), uio);
122 v2 = bus_read_2(sc->avg_res, offset);
123 error = uiomove(&v2, sizeof(v2), uio);
127 v4 = bus_read_4(sc->avg_res, offset);
128 error = uiomove(&v4, sizeof(v4), uio);
133 v8 = bus_read_8(sc->avg_res, offset);
134 error = uiomove(&v8, sizeof(v8), uio);
140 panic("%s: unexpected widthment %u", __func__, width);
149 altera_avgen_write(struct cdev *dev, struct uio *uio, int flag)
151 struct altera_avgen_softc *sc;
163 if ((sc->avg_flags & ALTERA_AVALON_FLAG_WRITE) == 0)
165 width = sc->avg_width;
166 if (uio->uio_offset < 0 || uio->uio_offset % width != 0 ||
167 uio->uio_resid % width != 0)
169 size = rman_get_size(sc->avg_res);
170 while (uio->uio_resid > 0) {
171 offset = uio->uio_offset;
172 if (offset + width > size)
176 error = uiomove(&v1, sizeof(v1), uio);
179 bus_write_1(sc->avg_res, offset, v1);
183 error = uiomove(&v2, sizeof(v2), uio);
186 bus_write_2(sc->avg_res, offset, v2);
190 error = uiomove(&v4, sizeof(v4), uio);
193 bus_write_4(sc->avg_res, offset, v4);
198 error = uiomove(&v8, sizeof(v8), uio);
201 bus_write_8(sc->avg_res, offset, v8);
206 panic("%s: unexpected width %u", __func__, width);
213 altera_avgen_mmap(struct cdev *dev, vm_ooffset_t offset, vm_paddr_t *paddr,
214 int nprot, vm_memattr_t *memattr)
216 struct altera_avgen_softc *sc;
219 if (nprot & VM_PROT_READ) {
220 if ((sc->avg_flags & ALTERA_AVALON_FLAG_MMAP_READ) == 0)
223 if (nprot & VM_PROT_WRITE) {
224 if ((sc->avg_flags & ALTERA_AVALON_FLAG_MMAP_WRITE) == 0)
227 if (nprot & VM_PROT_EXECUTE) {
228 if ((sc->avg_flags & ALTERA_AVALON_FLAG_MMAP_EXEC) == 0)
231 if (trunc_page(offset) == offset &&
232 offset + PAGE_SIZE > offset &&
233 rman_get_size(sc->avg_res) >= offset + PAGE_SIZE) {
234 *paddr = rman_get_start(sc->avg_res) + offset;
235 *memattr = VM_MEMATTR_UNCACHEABLE;
242 * NB: We serialise block reads and writes in case the OS is generating
243 * concurrent I/O against the same block, in which case we want one I/O (or
244 * another) to win. This is not sufficient to provide atomicity for the
245 * sector in the presence of a fail stop -- however, we're just writing this
246 * to non-persistent DRAM .. right?
249 altera_avgen_disk_strategy(struct bio *bp)
251 struct altera_avgen_softc *sc;
256 sc = bp->bio_disk->d_drv1;
258 bcount = bp->bio_bcount;
259 pblkno = bp->bio_pblkno;
262 * Serialize block reads / writes.
264 mtx_lock(&sc->avg_disk_mtx);
265 switch (bp->bio_cmd) {
267 if (!(sc->avg_flags & ALTERA_AVALON_FLAG_GEOM_READ)) {
268 biofinish(bp, NULL, EIO);
271 switch (sc->avg_width) {
273 bus_read_region_1(sc->avg_res,
274 bp->bio_pblkno * ALTERA_AVGEN_SECTORSIZE,
275 (uint8_t *)data, bcount);
279 bus_read_region_2(sc->avg_res,
280 bp->bio_pblkno * ALTERA_AVGEN_SECTORSIZE,
281 (uint16_t *)data, bcount / 2);
285 bus_read_region_4(sc->avg_res,
286 bp->bio_pblkno * ALTERA_AVGEN_SECTORSIZE,
287 (uint32_t *)data, bcount / 4);
291 panic("%s: unexpected width %u", __func__,
297 if (!(sc->avg_flags & ALTERA_AVALON_FLAG_GEOM_WRITE)) {
298 biofinish(bp, NULL, EROFS);
301 switch (sc->avg_width) {
303 bus_write_region_1(sc->avg_res,
304 bp->bio_pblkno * ALTERA_AVGEN_SECTORSIZE,
305 (uint8_t *)data, bcount);
309 bus_write_region_2(sc->avg_res,
310 bp->bio_pblkno * ALTERA_AVGEN_SECTORSIZE,
311 (uint16_t *)data, bcount / 2);
315 bus_write_region_4(sc->avg_res,
316 bp->bio_pblkno * ALTERA_AVGEN_SECTORSIZE,
317 (uint32_t *)data, bcount / 4);
321 panic("%s: unexpected width %u", __func__,
327 panic("%s: unsupported I/O operation %d", __func__,
330 mtx_unlock(&sc->avg_disk_mtx);
331 biofinish(bp, NULL, 0);
335 altera_avgen_process_options(struct altera_avgen_softc *sc,
336 const char *str_fileio, const char *str_geomio, const char *str_mmapio,
337 const char *str_devname, int devunit)
340 device_t dev = sc->avg_dev;
343 * Check for valid combinations of options.
345 if (str_fileio == NULL && str_geomio == NULL && str_mmapio == NULL) {
347 "at least one of %s, %s, or %s must be specified\n",
348 ALTERA_AVALON_STR_FILEIO, ALTERA_AVALON_STR_GEOMIO,
349 ALTERA_AVALON_STR_MMAPIO);
354 * Validity check: a device can either be a GEOM device (in which case
355 * we use GEOM to register the device node), or a special device --
356 * but not both as that causes a collision in /dev.
358 if (str_geomio != NULL && (str_fileio != NULL || str_mmapio != NULL)) {
360 "at most one of %s and (%s or %s) may be specified\n",
361 ALTERA_AVALON_STR_GEOMIO, ALTERA_AVALON_STR_FILEIO,
362 ALTERA_AVALON_STR_MMAPIO);
367 * Ensure that a unit is specified if a name is also specified.
369 if (str_devname == NULL && devunit != -1) {
370 device_printf(dev, "%s requires %s be specified\n",
371 ALTERA_AVALON_STR_DEVUNIT, ALTERA_AVALON_STR_DEVNAME);
376 * Extract, digest, and save values.
378 switch (sc->avg_width) {
388 device_printf(dev, "%s unsupported value %u\n",
389 ALTERA_AVALON_STR_WIDTH, sc->avg_width);
393 if (str_fileio != NULL) {
394 for (cp = str_fileio; *cp != '\0'; cp++) {
396 case ALTERA_AVALON_CHAR_READ:
397 sc->avg_flags |= ALTERA_AVALON_FLAG_READ;
400 case ALTERA_AVALON_CHAR_WRITE:
401 sc->avg_flags |= ALTERA_AVALON_FLAG_WRITE;
406 "invalid %s character %c\n",
407 ALTERA_AVALON_STR_FILEIO, *cp);
412 if (str_geomio != NULL) {
413 for (cp = str_geomio; *cp != '\0'; cp++){
415 case ALTERA_AVALON_CHAR_READ:
416 sc->avg_flags |= ALTERA_AVALON_FLAG_GEOM_READ;
419 case ALTERA_AVALON_CHAR_WRITE:
420 sc->avg_flags |= ALTERA_AVALON_FLAG_GEOM_WRITE;
425 "invalid %s character %c\n",
426 ALTERA_AVALON_STR_GEOMIO, *cp);
431 if (str_mmapio != NULL) {
432 for (cp = str_mmapio; *cp != '\0'; cp++) {
434 case ALTERA_AVALON_CHAR_READ:
435 sc->avg_flags |= ALTERA_AVALON_FLAG_MMAP_READ;
438 case ALTERA_AVALON_CHAR_WRITE:
440 ALTERA_AVALON_FLAG_MMAP_WRITE;
443 case ALTERA_AVALON_CHAR_EXEC:
444 sc->avg_flags |= ALTERA_AVALON_FLAG_MMAP_EXEC;
449 "invalid %s character %c\n",
450 ALTERA_AVALON_STR_MMAPIO, *cp);
459 altera_avgen_attach(struct altera_avgen_softc *sc, const char *str_fileio,
460 const char *str_geomio, const char *str_mmapio, const char *str_devname,
463 device_t dev = sc->avg_dev;
466 error = altera_avgen_process_options(sc, str_fileio, str_geomio,
467 str_mmapio, str_devname, devunit);
471 if (rman_get_size(sc->avg_res) >= PAGE_SIZE || str_mmapio != NULL) {
472 if (rman_get_size(sc->avg_res) % PAGE_SIZE != 0) {
474 "memory region not even multiple of page size\n");
477 if (rman_get_start(sc->avg_res) % PAGE_SIZE != 0) {
478 device_printf(dev, "memory region not page-aligned\n");
484 * If a GEOM permission is requested, then create the device via GEOM.
485 * Otherwise, create a special device. We checked during options
486 * processing that both weren't requested a once.
488 if (str_devname != NULL) {
489 sc->avg_name = strdup(str_devname, M_TEMP);
490 devunit = sc->avg_unit;
492 sc->avg_name = strdup(ALTERA_AVGEN_DEVNAME, M_TEMP);
493 if (sc->avg_flags & (ALTERA_AVALON_FLAG_GEOM_READ |
494 ALTERA_AVALON_FLAG_GEOM_WRITE)) {
495 mtx_init(&sc->avg_disk_mtx, "altera_avgen_disk", NULL,
497 sc->avg_disk = disk_alloc();
498 sc->avg_disk->d_drv1 = sc;
499 sc->avg_disk->d_strategy = altera_avgen_disk_strategy;
502 sc->avg_disk->d_name = sc->avg_name;
503 sc->avg_disk->d_unit = devunit;
506 * NB: As avg_res is a multiple of PAGE_SIZE, it is also a
507 * multiple of ALTERA_AVGEN_SECTORSIZE.
509 sc->avg_disk->d_sectorsize = ALTERA_AVGEN_SECTORSIZE;
510 sc->avg_disk->d_mediasize = rman_get_size(sc->avg_res);
511 sc->avg_disk->d_maxsize = ALTERA_AVGEN_SECTORSIZE;
512 disk_create(sc->avg_disk, DISK_VERSION);
514 /* Device node allocation. */
515 if (str_devname == NULL) {
516 str_devname = ALTERA_AVGEN_DEVNAME_FMT;
517 devunit = sc->avg_unit;
520 sc->avg_cdev = make_dev(&avg_cdevsw, sc->avg_unit,
521 UID_ROOT, GID_WHEEL, S_IRUSR | S_IWUSR, "%s%d",
522 str_devname, devunit);
524 sc->avg_cdev = make_dev(&avg_cdevsw, sc->avg_unit,
525 UID_ROOT, GID_WHEEL, S_IRUSR | S_IWUSR,
527 if (sc->avg_cdev == NULL) {
528 device_printf(sc->avg_dev, "%s: make_dev failed\n",
533 /* XXXRW: Slight race between make_dev(9) and here. */
534 sc->avg_cdev->si_drv1 = sc;
540 altera_avgen_detach(struct altera_avgen_softc *sc)
543 KASSERT((sc->avg_disk != NULL) || (sc->avg_cdev != NULL),
544 ("%s: neither GEOM nor special device", __func__));
546 if (sc->avg_disk != NULL) {
547 disk_gone(sc->avg_disk);
548 disk_destroy(sc->avg_disk);
549 free(sc->avg_name, M_TEMP);
550 mtx_destroy(&sc->avg_disk_mtx);
552 destroy_dev(sc->avg_cdev);