xref: /freebsd/sys/riscv/riscv/riscv_syscon.c (revision c1d255d3)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
3  *
4  * Copyright (c) 2018 Kyle Evans <kevans@FreeBSD.org>
5  * Copyright (c) 2020 Jessica Clarke <jrtc27@FreeBSD.org>
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26  * SUCH DAMAGE.
27  */
28 
29 /*
30  * RISC-V syscon driver. Used as a generic interface by QEMU's virt machine for
31  * describing the SiFive test finisher as a power and reset controller.
32  */
33 
34 #include <sys/cdefs.h>
35 __FBSDID("$FreeBSD$");
36 
37 #include <sys/param.h>
38 #include <sys/bus.h>
39 #include <sys/kernel.h>
40 #include <sys/module.h>
41 #include <sys/mutex.h>
42 #include <sys/rman.h>
43 #include <machine/bus.h>
44 
45 #include <dev/ofw/openfirm.h>
46 #include <dev/ofw/ofw_bus.h>
47 #include <dev/ofw/ofw_bus_subr.h>
48 
49 #include <dev/extres/syscon/syscon.h>
50 #include <dev/extres/syscon/syscon_generic.h>
51 
52 static struct ofw_compat_data compat_data[] = {
53 	{"sifive,test0",	1},
54 	{"sifive,test1",	1},
55 	{NULL,			0}
56 };
57 
58 static int
59 riscv_syscon_probe(device_t dev)
60 {
61 
62 	if (!ofw_bus_status_okay(dev))
63 		return (ENXIO);
64 	if (ofw_bus_search_compatible(dev, compat_data)->ocd_data == 0)
65 		return (ENXIO);
66 
67 	device_set_desc(dev, "RISC-V syscon");
68 	return (BUS_PROBE_DEFAULT);
69 }
70 
71 static device_method_t riscv_syscon_methods[] = {
72 	DEVMETHOD(device_probe, riscv_syscon_probe),
73 
74 	DEVMETHOD_END
75 };
76 
77 DEFINE_CLASS_1(riscv_syscon, riscv_syscon_driver, riscv_syscon_methods,
78     sizeof(struct syscon_generic_softc), syscon_generic_driver);
79 
80 static devclass_t riscv_syscon_devclass;
81 /* riscv_syscon needs to attach prior to syscon_power */
82 EARLY_DRIVER_MODULE(riscv_syscon, simplebus, riscv_syscon_driver,
83     riscv_syscon_devclass, 0, 0, BUS_PASS_SCHEDULER + BUS_PASS_ORDER_LAST);
84 MODULE_VERSION(riscv_syscon, 1);
85