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 
92 static void
93 bcm_vchiq_intr(void *arg)
94 {
95 	VCHIQ_STATE_T *state = &g_state;
96 	unsigned int status;
97 
98 	/* Read (and clear) the doorbell */
99 	status = vchiq_read_4(0x40);
100 
101 	if (status & 0x4) {  /* Was the doorbell rung? */
102 		remote_event_pollall(state);
103 	}
104 }
105 
106 void
107 remote_event_signal(REMOTE_EVENT_T *event)
108 {
109 	event->fired = 1;
110 
111 	/* The test on the next line also ensures the write on the previous line
112 		has completed */
113 	if (event->armed) {
114 		/* trigger vc interrupt */
115 		dsb();
116 		vchiq_write_4(0x48, 0);
117 	}
118 }
119 
120 static int
121 bcm_vchiq_probe(device_t dev)
122 {
123 
124 	if (ofw_bus_is_compatible(dev, "broadcom,bcm2835-vchiq")) {
125 		device_set_desc(dev, "BCM2835 VCHIQ");
126 		return(BUS_PROBE_DEFAULT);
127 	}
128 
129 	return (ENXIO);
130 }
131 
132 static int
133 bcm_vchiq_attach(device_t dev)
134 {
135 	struct bcm_vchiq_softc *sc = device_get_softc(dev);
136 	int rid = 0;
137 
138 	if (bcm_vchiq_sc != NULL)
139 		return (EINVAL);
140 
141 	sc->mem_res = bus_alloc_resource_any(dev, SYS_RES_MEMORY, &rid, RF_ACTIVE);
142 	if (sc->mem_res == NULL) {
143 		device_printf(dev, "could not allocate memory resource\n");
144 		return (ENXIO);
145 	}
146 
147 	sc->bst = rman_get_bustag(sc->mem_res);
148 	sc->bsh = rman_get_bushandle(sc->mem_res);
149 
150 	rid = 0;
151 	sc->irq_res = bus_alloc_resource_any(dev, SYS_RES_IRQ, &rid, RF_ACTIVE);
152 	if (sc->irq_res == NULL) {
153 		device_printf(dev, "could not allocate interrupt resource\n");
154 		return (ENXIO);
155 	}
156 
157 	vchiq_core_initialize();
158 
159 	/* Setup and enable the timer */
160 	if (bus_setup_intr(dev, sc->irq_res, INTR_TYPE_MISC,
161 			NULL, bcm_vchiq_intr, sc,
162 			&sc->intr_hl) != 0) {
163 		bus_release_resource(dev, SYS_RES_IRQ, rid,
164 			sc->irq_res);
165 		device_printf(dev, "Unable to setup the clock irq handler.\n");
166 		return (ENXIO);
167 	}
168 
169 	mtx_init(&sc->lock, "vchiq", MTX_DEF, 0);
170 	bcm_vchiq_sc = sc;
171 
172 	vchiq_init();
173 
174 	bus_generic_probe(dev);
175 	bus_generic_attach(dev);
176 
177 	return (0);
178 }
179 
180 static int
181 bcm_vchiq_detach(device_t dev)
182 {
183 	struct bcm_vchiq_softc *sc = device_get_softc(dev);
184 
185 	vchiq_exit();
186 
187 	if (sc->intr_hl)
188                 bus_teardown_intr(dev, sc->irq_res, sc->intr_hl);
189 	bus_release_resource(dev, SYS_RES_IRQ, 0,
190 		sc->irq_res);
191 	bus_release_resource(dev, SYS_RES_MEMORY, 0,
192 		sc->mem_res);
193 
194 	mtx_destroy(&sc->lock);
195 
196 	return (0);
197 }
198 
199 
200 static device_method_t bcm_vchiq_methods[] = {
201 	DEVMETHOD(device_probe,		bcm_vchiq_probe),
202 	DEVMETHOD(device_attach,	bcm_vchiq_attach),
203 	DEVMETHOD(device_detach,	bcm_vchiq_detach),
204 
205         /* Bus interface */
206         DEVMETHOD(bus_add_child,        bus_generic_add_child),
207 
208 	{ 0, 0 }
209 };
210 
211 static driver_t bcm_vchiq_driver = {
212 	"vchiq",
213 	bcm_vchiq_methods,
214 	sizeof(struct bcm_vchiq_softc),
215 };
216 
217 static devclass_t bcm_vchiq_devclass;
218 
219 DRIVER_MODULE(vchiq, simplebus, bcm_vchiq_driver, bcm_vchiq_devclass, 0, 0);
220 MODULE_VERSION(vchiq, 1);
221