xref: /freebsd/sys/contrib/vchiq/interface/vchiq_arm/vchiq_kmod.c (revision 1f4bcc459a76b7aa664f3fd557684cd0ba6da352)
1 /*-
2  * Copyright (c) 2012-2015 Oleksandr Tymoshenko <gonzo@freebsd.org>
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23  * SUCH DAMAGE.
24  */
25 
26 #include <sys/cdefs.h>
27 __FBSDID("$FreeBSD$");
28 
29 #include <sys/param.h>
30 #include <sys/systm.h>
31 #include <sys/bus.h>
32 #include <sys/kernel.h>
33 #include <sys/module.h>
34 #include <sys/malloc.h>
35 #include <sys/rman.h>
36 #include <sys/timeet.h>
37 #include <sys/timetc.h>
38 #include <sys/watchdog.h>
39 #include <machine/bus.h>
40 #include <machine/cpu.h>
41 #include <machine/frame.h>
42 #include <machine/intr.h>
43 
44 #include <dev/fdt/fdt_common.h>
45 #include <dev/ofw/openfirm.h>
46 #include <dev/ofw/ofw_bus.h>
47 #include <dev/ofw/ofw_bus_subr.h>
48 
49 #include <machine/bus.h>
50 #include <machine/fdt.h>
51 
52 #include "vchiq_arm.h"
53 #include "vchiq_2835.h"
54 
55 #define	VCHIQ_LOCK	do {		\
56 	mtx_lock(&bcm_vchiq_sc->lock);	\
57 } while(0)
58 
59 #define	VCHIQ_UNLOCK	do {		\
60 	mtx_unlock(&bcm_vchiq_sc->lock);	\
61 } while(0)
62 
63 #ifdef  DEBUG
64 #define dprintf(fmt, args...) printf(fmt, ##args)
65 #else
66 #define dprintf(fmt, args...)
67 #endif
68 
69 struct bcm_vchiq_softc {
70 	struct mtx		lock;
71 	struct resource *	mem_res;
72 	struct resource *	irq_res;
73 	void*			intr_hl;
74 	bus_space_tag_t		bst;
75 	bus_space_handle_t	bsh;
76 };
77 
78 static struct bcm_vchiq_softc *bcm_vchiq_sc = NULL;
79 
80 #define	vchiq_read_4(reg)		\
81     bus_space_read_4(bcm_vchiq_sc->bst, bcm_vchiq_sc->bsh, reg)
82 #define	vchiq_write_4(reg, val)		\
83     bus_space_write_4(bcm_vchiq_sc->bst, bcm_vchiq_sc->bsh, reg, val)
84 
85 /*
86  * Extern functions */
87 void vchiq_exit(void);
88 int vchiq_init(void);
89 
90 extern VCHIQ_STATE_T g_state;
91 extern int g_cache_line_size;
92 
93 static void
94 bcm_vchiq_intr(void *arg)
95 {
96 	VCHIQ_STATE_T *state = &g_state;
97 	unsigned int status;
98 
99 	/* Read (and clear) the doorbell */
100 	status = vchiq_read_4(0x40);
101 
102 	if (status & 0x4) {  /* Was the doorbell rung? */
103 		remote_event_pollall(state);
104 	}
105 }
106 
107 void
108 remote_event_signal(REMOTE_EVENT_T *event)
109 {
110 	event->fired = 1;
111 
112 	/* The test on the next line also ensures the write on the previous line
113 		has completed */
114 	if (event->armed) {
115 		/* trigger vc interrupt */
116 		dsb();
117 		vchiq_write_4(0x48, 0);
118 	}
119 }
120 
121 static int
122 bcm_vchiq_probe(device_t dev)
123 {
124 
125 	if (ofw_bus_is_compatible(dev, "broadcom,bcm2835-vchiq")) {
126 		device_set_desc(dev, "BCM2835 VCHIQ");
127 		return(BUS_PROBE_DEFAULT);
128 	}
129 
130 	return (ENXIO);
131 }
132 
133 static int
134 bcm_vchiq_attach(device_t dev)
135 {
136 	struct bcm_vchiq_softc *sc = device_get_softc(dev);
137 	phandle_t node;
138 	pcell_t cell;
139 	int rid = 0;
140 
141 	if (bcm_vchiq_sc != NULL)
142 		return (EINVAL);
143 
144 	sc->mem_res = bus_alloc_resource_any(dev, SYS_RES_MEMORY, &rid, RF_ACTIVE);
145 	if (sc->mem_res == NULL) {
146 		device_printf(dev, "could not allocate memory resource\n");
147 		return (ENXIO);
148 	}
149 
150 	sc->bst = rman_get_bustag(sc->mem_res);
151 	sc->bsh = rman_get_bushandle(sc->mem_res);
152 
153 	rid = 0;
154 	sc->irq_res = bus_alloc_resource_any(dev, SYS_RES_IRQ, &rid, RF_ACTIVE);
155 	if (sc->irq_res == NULL) {
156 		device_printf(dev, "could not allocate interrupt resource\n");
157 		return (ENXIO);
158 	}
159 
160 	node = ofw_bus_get_node(dev);
161 	if ((OF_getencprop(node, "cache-line-size", &cell, sizeof(cell))) > 0)
162 		g_cache_line_size = cell;
163 
164 	vchiq_core_initialize();
165 
166 	/* Setup and enable the timer */
167 	if (bus_setup_intr(dev, sc->irq_res, INTR_TYPE_MISC | INTR_MPSAFE,
168 			NULL, bcm_vchiq_intr, sc,
169 			&sc->intr_hl) != 0) {
170 		bus_release_resource(dev, SYS_RES_IRQ, rid,
171 			sc->irq_res);
172 		device_printf(dev, "Unable to setup the clock irq handler.\n");
173 		return (ENXIO);
174 	}
175 
176 	mtx_init(&sc->lock, "vchiq", 0, MTX_DEF);
177 	bcm_vchiq_sc = sc;
178 
179 	vchiq_init();
180 
181 	bus_generic_probe(dev);
182 	bus_generic_attach(dev);
183 
184 	return (0);
185 }
186 
187 static int
188 bcm_vchiq_detach(device_t dev)
189 {
190 	struct bcm_vchiq_softc *sc = device_get_softc(dev);
191 
192 	vchiq_exit();
193 
194 	if (sc->intr_hl)
195                 bus_teardown_intr(dev, sc->irq_res, sc->intr_hl);
196 	bus_release_resource(dev, SYS_RES_IRQ, 0,
197 		sc->irq_res);
198 	bus_release_resource(dev, SYS_RES_MEMORY, 0,
199 		sc->mem_res);
200 
201 	mtx_destroy(&sc->lock);
202 
203 	return (0);
204 }
205 
206 
207 static device_method_t bcm_vchiq_methods[] = {
208 	DEVMETHOD(device_probe,		bcm_vchiq_probe),
209 	DEVMETHOD(device_attach,	bcm_vchiq_attach),
210 	DEVMETHOD(device_detach,	bcm_vchiq_detach),
211 
212         /* Bus interface */
213         DEVMETHOD(bus_add_child,        bus_generic_add_child),
214 
215 	{ 0, 0 }
216 };
217 
218 static driver_t bcm_vchiq_driver = {
219 	"vchiq",
220 	bcm_vchiq_methods,
221 	sizeof(struct bcm_vchiq_softc),
222 };
223 
224 static devclass_t bcm_vchiq_devclass;
225 
226 DRIVER_MODULE(vchiq, simplebus, bcm_vchiq_driver, bcm_vchiq_devclass, 0, 0);
227 MODULE_VERSION(vchiq, 1);
228