1 /*- 2 * SPDX-License-Identifier: BSD-2-Clause 3 * 4 * Copyright (c) 2012, 2016 Robert N. M. Watson 5 * All rights reserved. 6 * 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. 10 * 11 * Redistribution and use in source and binary forms, with or without 12 * modification, are permitted provided that the following conditions 13 * are met: 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. 19 * 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 30 * SUCH DAMAGE. 31 */ 32 33 #ifndef _DEV_ALTERA_AVALON_H_ 34 #define _DEV_ALTERA_AVALON_H_ 35 36 struct altera_avgen_softc { 37 /* 38 * Bus-related fields. 39 */ 40 device_t avg_dev; 41 int avg_unit; 42 char *avg_name; 43 44 /* 45 * The device node and memory-mapped I/O region. 46 */ 47 struct cdev *avg_cdev; 48 struct resource *avg_res; 49 int avg_rid; 50 51 /* 52 * Access properties configured by device.hints. 53 */ 54 u_int avg_flags; 55 u_int avg_width; 56 u_int avg_sectorsize; 57 58 /* 59 * disk(9) state, if required for this device. 60 */ 61 struct disk *avg_disk; 62 struct mtx avg_disk_mtx; 63 }; 64 65 /* 66 * Various flags extracted from device.hints to configure operations on the 67 * device. 68 */ 69 #define ALTERA_AVALON_FLAG_READ 0x01 70 #define ALTERA_AVALON_FLAG_WRITE 0x02 71 #define ALTERA_AVALON_FLAG_MMAP_READ 0x04 72 #define ALTERA_AVALON_FLAG_MMAP_WRITE 0x08 73 #define ALTERA_AVALON_FLAG_MMAP_EXEC 0x10 74 #define ALTERA_AVALON_FLAG_GEOM_READ 0x20 75 #define ALTERA_AVALON_FLAG_GEOM_WRITE 0x40 76 77 #define ALTERA_AVALON_CHAR_READ 'r' 78 #define ALTERA_AVALON_CHAR_WRITE 'w' 79 #define ALTERA_AVALON_CHAR_EXEC 'x' 80 81 #define ALTERA_AVALON_STR_WIDTH "width" 82 #define ALTERA_AVALON_STR_FILEIO "fileio" 83 #define ALTERA_AVALON_STR_GEOMIO "geomio" 84 #define ALTERA_AVALON_STR_MMAPIO "mmapio" 85 #define ALTERA_AVALON_STR_DEVNAME "devname" 86 #define ALTERA_AVALON_STR_DEVUNIT "devunit" 87 88 /* 89 * Driver setup routines from the bus attachment/teardown. 90 */ 91 int altera_avgen_attach(struct altera_avgen_softc *sc, 92 const char *str_fileio, const char *str_geomio, 93 const char *str_mmapio, const char *str_devname, int devunit); 94 void altera_avgen_detach(struct altera_avgen_softc *sc); 95 96 #endif /* _DEV_ALTERA_AVALON_H_ */ 97