altera_avgen.h revision 330897 
1/*-
2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
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 * $FreeBSD: stable/11/sys/dev/altera/avgen/altera_avgen.h 330897 2018-03-14 03:19:51Z eadler $
33 */
34
35#ifndef _DEV_ALTERA_AVALON_H_
36#define	_DEV_ALTERA_AVALON_H_
37
38struct altera_avgen_softc {
39	/*
40	 * Bus-related fields.
41	 */
42	device_t	 avg_dev;
43	int		 avg_unit;
44	char		*avg_name;
45
46	/*
47	 * The device node and memory-mapped I/O region.
48	 */
49	struct cdev	*avg_cdev;
50	struct resource	*avg_res;
51	int		 avg_rid;
52
53	/*
54	 * Access properties configured by device.hints.
55	 */
56	u_int		 avg_flags;
57	u_int		 avg_width;
58	u_int		 avg_sectorsize;
59
60	/*
61	 * disk(9) state, if required for this device.
62	 */
63	struct disk	*avg_disk;
64	struct mtx	 avg_disk_mtx;
65};
66
67/*
68 * Various flags extracted from device.hints to configure operations on the
69 * device.
70 */
71#define	ALTERA_AVALON_FLAG_READ			0x01
72#define	ALTERA_AVALON_FLAG_WRITE		0x02
73#define	ALTERA_AVALON_FLAG_MMAP_READ		0x04
74#define	ALTERA_AVALON_FLAG_MMAP_WRITE		0x08
75#define	ALTERA_AVALON_FLAG_MMAP_EXEC		0x10
76#define	ALTERA_AVALON_FLAG_GEOM_READ		0x20
77#define	ALTERA_AVALON_FLAG_GEOM_WRITE		0x40
78
79#define	ALTERA_AVALON_CHAR_READ			'r'
80#define	ALTERA_AVALON_CHAR_WRITE		'w'
81#define	ALTERA_AVALON_CHAR_EXEC			'x'
82
83#define	ALTERA_AVALON_STR_WIDTH			"width"
84#define	ALTERA_AVALON_STR_FILEIO		"fileio"
85#define	ALTERA_AVALON_STR_GEOMIO		"geomio"
86#define	ALTERA_AVALON_STR_MMAPIO		"mmapio"
87#define ALTERA_AVALON_STR_DEVNAME		"devname"
88#define	ALTERA_AVALON_STR_DEVUNIT		"devunit"
89
90/*
91 * Driver setup routines from the bus attachment/teardown.
92 */
93int	altera_avgen_attach(struct altera_avgen_softc *sc,
94	    const char *str_fileio, const char *str_geomio,
95	    const char *str_mmapio, const char *str_devname, int devunit);
96void	altera_avgen_detach(struct altera_avgen_softc *sc);
97
98extern devclass_t	altera_avgen_devclass;
99
100#endif /* _DEV_ALTERA_AVALON_H_ */
101