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: stable/11/sys/contrib/vchiq/interface/vchiq_arm/vchiq_kmod.c 307575 2016-10-18 19:15:43Z gonzo $");
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
69struct 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	int			regs_offset;
77};
78
79static struct bcm_vchiq_softc *bcm_vchiq_sc = NULL;
80
81#define	BSD_DTB			1
82#define	UPSTREAM_DTB		2
83static struct ofw_compat_data compat_data[] = {
84	{"broadcom,bcm2835-vchiq",	BSD_DTB},
85	{"brcm,bcm2835-vchiq",		UPSTREAM_DTB},
86	{NULL,				0}
87};
88
89#define	vchiq_read_4(reg)		\
90    bus_space_read_4(bcm_vchiq_sc->bst, bcm_vchiq_sc->bsh, (reg) + \
91    bcm_vchiq_sc->regs_offset)
92#define	vchiq_write_4(reg, val)		\
93    bus_space_write_4(bcm_vchiq_sc->bst, bcm_vchiq_sc->bsh, (reg) + \
94    bcm_vchiq_sc->regs_offset, val)
95
96/*
97 * Extern functions */
98void vchiq_exit(void);
99int vchiq_init(void);
100
101extern VCHIQ_STATE_T g_state;
102extern int g_cache_line_size;
103
104static void
105bcm_vchiq_intr(void *arg)
106{
107	VCHIQ_STATE_T *state = &g_state;
108	unsigned int status;
109
110	/* Read (and clear) the doorbell */
111	status = vchiq_read_4(0x40);
112
113	if (status & 0x4) {  /* Was the doorbell rung? */
114		remote_event_pollall(state);
115	}
116}
117
118void
119remote_event_signal(REMOTE_EVENT_T *event)
120{
121	event->fired = 1;
122
123	/* The test on the next line also ensures the write on the previous line
124		has completed */
125	if (event->armed) {
126		/* trigger vc interrupt */
127		dsb();
128		vchiq_write_4(0x48, 0);
129	}
130}
131
132static int
133bcm_vchiq_probe(device_t dev)
134{
135
136	if (ofw_bus_search_compatible(dev, compat_data)->ocd_data == 0)
137		return (ENXIO);
138
139	device_set_desc(dev, "BCM2835 VCHIQ");
140	return (BUS_PROBE_DEFAULT);
141}
142
143static int
144bcm_vchiq_attach(device_t dev)
145{
146	struct bcm_vchiq_softc *sc = device_get_softc(dev);
147	phandle_t node;
148	pcell_t cell;
149	int rid = 0;
150
151	if (bcm_vchiq_sc != NULL)
152		return (EINVAL);
153
154	sc->mem_res = bus_alloc_resource_any(dev, SYS_RES_MEMORY, &rid, RF_ACTIVE);
155	if (sc->mem_res == NULL) {
156		device_printf(dev, "could not allocate memory resource\n");
157		return (ENXIO);
158	}
159
160	sc->bst = rman_get_bustag(sc->mem_res);
161	sc->bsh = rman_get_bushandle(sc->mem_res);
162
163	rid = 0;
164	sc->irq_res = bus_alloc_resource_any(dev, SYS_RES_IRQ, &rid, RF_ACTIVE);
165	if (sc->irq_res == NULL) {
166		device_printf(dev, "could not allocate interrupt resource\n");
167		return (ENXIO);
168	}
169
170	if (ofw_bus_search_compatible(dev, compat_data)->ocd_data == UPSTREAM_DTB)
171		sc->regs_offset = -0x40;
172
173	node = ofw_bus_get_node(dev);
174	if ((OF_getencprop(node, "cache-line-size", &cell, sizeof(cell))) > 0)
175		g_cache_line_size = cell;
176
177	vchiq_core_initialize();
178
179	/* Setup and enable the timer */
180	if (bus_setup_intr(dev, sc->irq_res, INTR_TYPE_MISC | INTR_MPSAFE,
181			NULL, bcm_vchiq_intr, sc,
182			&sc->intr_hl) != 0) {
183		bus_release_resource(dev, SYS_RES_IRQ, rid,
184			sc->irq_res);
185		device_printf(dev, "Unable to setup the clock irq handler.\n");
186		return (ENXIO);
187	}
188
189	mtx_init(&sc->lock, "vchiq", 0, MTX_DEF);
190	bcm_vchiq_sc = sc;
191
192	vchiq_init();
193
194	bus_generic_probe(dev);
195	bus_generic_attach(dev);
196
197	return (0);
198}
199
200static int
201bcm_vchiq_detach(device_t dev)
202{
203	struct bcm_vchiq_softc *sc = device_get_softc(dev);
204
205	vchiq_exit();
206
207	if (sc->intr_hl)
208                bus_teardown_intr(dev, sc->irq_res, sc->intr_hl);
209	bus_release_resource(dev, SYS_RES_IRQ, 0,
210		sc->irq_res);
211	bus_release_resource(dev, SYS_RES_MEMORY, 0,
212		sc->mem_res);
213
214	mtx_destroy(&sc->lock);
215
216	return (0);
217}
218
219
220static device_method_t bcm_vchiq_methods[] = {
221	DEVMETHOD(device_probe,		bcm_vchiq_probe),
222	DEVMETHOD(device_attach,	bcm_vchiq_attach),
223	DEVMETHOD(device_detach,	bcm_vchiq_detach),
224
225        /* Bus interface */
226        DEVMETHOD(bus_add_child,        bus_generic_add_child),
227
228	{ 0, 0 }
229};
230
231static driver_t bcm_vchiq_driver = {
232	"vchiq",
233	bcm_vchiq_methods,
234	sizeof(struct bcm_vchiq_softc),
235};
236
237static devclass_t bcm_vchiq_devclass;
238
239DRIVER_MODULE(vchiq, simplebus, bcm_vchiq_driver, bcm_vchiq_devclass, 0, 0);
240MODULE_VERSION(vchiq, 1);
241