xref: /freebsd/sys/arm/freescale/vybrid/vf_port.c (revision d0b2dbfa0ecf2bbc9709efc5e20baf8e4b44bbbf)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause
3  *
4  * Copyright (c) 2014 Ruslan Bukin <br@bsdpad.com>
5  * All rights reserved.
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  * Vybrid Family Port control and interrupts (PORT)
31  * Chapter 6, Vybrid Reference Manual, Rev. 5, 07/2013
32  */
33 
34 #include <sys/cdefs.h>
35 #include <sys/param.h>
36 #include <sys/systm.h>
37 #include <sys/bus.h>
38 #include <sys/kernel.h>
39 #include <sys/module.h>
40 #include <sys/malloc.h>
41 #include <sys/rman.h>
42 #include <sys/timeet.h>
43 #include <sys/timetc.h>
44 #include <sys/watchdog.h>
45 
46 #include <dev/ofw/openfirm.h>
47 #include <dev/ofw/ofw_bus.h>
48 #include <dev/ofw/ofw_bus_subr.h>
49 
50 #include <machine/bus.h>
51 #include <machine/cpu.h>
52 #include <machine/intr.h>
53 
54 #include <arm/freescale/vybrid/vf_port.h>
55 #include <arm/freescale/vybrid/vf_common.h>
56 
57 /* Pin Control Register */
58 #define PORT_PCR(n)		(0x1000 * (n >> 5) + 0x4 * (n % 32))
59 #define	 PCR_IRQC_S	16
60 #define	 PCR_IRQC_M	0xF
61 #define	 PCR_DMA_RE	0x1
62 #define	 PCR_DMA_FE	0x2
63 #define	 PCR_DMA_EE	0x3
64 #define	 PCR_INT_LZ	0x8
65 #define	 PCR_INT_RE	0x9
66 #define	 PCR_INT_FE	0xA
67 #define	 PCR_INT_EE	0xB
68 #define	 PCR_INT_LO	0xC
69 #define	 PCR_ISF	(1 << 24)
70 #define	PORT0_ISFR	0xA0	/* Interrupt Status Flag Register */
71 #define	PORT0_DFER	0xC0	/* Digital Filter Enable Register */
72 #define	PORT0_DFCR	0xC4	/* Digital Filter Clock Register */
73 #define	PORT0_DFWR	0xC8	/* Digital Filter Width Register */
74 
75 struct port_event {
76 	uint32_t	enabled;
77 	uint32_t	mux_num;
78 	uint32_t	mux_src;
79 	uint32_t	mux_chn;
80 	void		(*ih) (void *);
81 	void		*ih_user;
82 	enum ev_type	pevt;
83 };
84 
85 static struct port_event event_map[NGPIO];
86 
87 struct port_softc {
88 	struct resource		*res[6];
89 	bus_space_tag_t		bst;
90 	bus_space_handle_t	bsh;
91 	void			*gpio_ih[NGPIO];
92 };
93 
94 struct port_softc *port_sc;
95 
96 static struct resource_spec port_spec[] = {
97 	{ SYS_RES_MEMORY,	0,	RF_ACTIVE },
98 	{ SYS_RES_IRQ,		0,	RF_ACTIVE },
99 	{ SYS_RES_IRQ,		1,	RF_ACTIVE },
100 	{ SYS_RES_IRQ,		2,	RF_ACTIVE },
101 	{ SYS_RES_IRQ,		3,	RF_ACTIVE },
102 	{ SYS_RES_IRQ,		4,	RF_ACTIVE },
103 	{ -1, 0 }
104 };
105 
106 static int
107 port_intr(void *arg)
108 {
109 	struct port_event *pev;
110 	struct port_softc *sc;
111 	int reg;
112 	int i;
113 
114 	sc = arg;
115 
116 	for (i = 0; i < NGPIO; i++) {
117 		reg = READ4(sc, PORT_PCR(i));
118 		if (reg & PCR_ISF) {
119 			/* Clear interrupt */
120 			WRITE4(sc, PORT_PCR(i), reg);
121 
122 			/* Handle event */
123 			pev = &event_map[i];
124 			if (pev->enabled == 1) {
125 				if (pev->ih != NULL) {
126 					pev->ih(pev->ih_user);
127 				}
128 			}
129 		}
130 	}
131 
132 	return (FILTER_HANDLED);
133 }
134 
135 int
136 port_setup(int pnum, enum ev_type pevt, void (*ih)(void *), void *ih_user)
137 {
138 	struct port_event *pev;
139 	struct port_softc *sc;
140 	int reg;
141 	int val;
142 
143 	sc = port_sc;
144 
145 	switch (pevt) {
146 	case DMA_RISING_EDGE:
147 		val = PCR_DMA_RE;
148 		break;
149 	case DMA_FALLING_EDGE:
150 		val = PCR_DMA_FE;
151 		break;
152 	case DMA_EITHER_EDGE:
153 		val = PCR_DMA_EE;
154 		break;
155 	case INT_LOGIC_ZERO:
156 		val = PCR_INT_LZ;
157 		break;
158 	case INT_RISING_EDGE:
159 		val = PCR_INT_RE;
160 		break;
161 	case INT_FALLING_EDGE:
162 		val = PCR_INT_FE;
163 		break;
164 	case INT_EITHER_EDGE:
165 		val = PCR_INT_EE;
166 		break;
167 	case INT_LOGIC_ONE:
168 		val = PCR_INT_LO;
169 		break;
170 	default:
171 		return (-1);
172 	}
173 
174 	reg = READ4(sc, PORT_PCR(pnum));
175 	reg &= ~(PCR_IRQC_M << PCR_IRQC_S);
176 	reg |= (val << PCR_IRQC_S);
177 	WRITE4(sc, PORT_PCR(pnum), reg);
178 
179 	pev = &event_map[pnum];
180 	pev->ih = ih;
181 	pev->ih_user = ih_user;
182 	pev->pevt = pevt;
183 	pev->enabled = 1;
184 
185 	return (0);
186 }
187 
188 static int
189 port_probe(device_t dev)
190 {
191 
192 	if (!ofw_bus_status_okay(dev))
193 		return (ENXIO);
194 
195 	if (!ofw_bus_is_compatible(dev, "fsl,mvf600-port"))
196 		return (ENXIO);
197 
198 	device_set_desc(dev, "Vybrid Family Port control and interrupts");
199 	return (BUS_PROBE_DEFAULT);
200 }
201 
202 static int
203 port_attach(device_t dev)
204 {
205 	struct port_softc *sc;
206 	int irq;
207 
208 	sc = device_get_softc(dev);
209 
210 	if (bus_alloc_resources(dev, port_spec, sc->res)) {
211 		device_printf(dev, "could not allocate resources\n");
212 		return (ENXIO);
213 	}
214 
215 	/* Memory interface */
216 	sc->bst = rman_get_bustag(sc->res[0]);
217 	sc->bsh = rman_get_bushandle(sc->res[0]);
218 
219 	port_sc = sc;
220 
221 	for (irq = 0; irq < NPORTS; irq ++) {
222 		if ((bus_setup_intr(dev, sc->res[1 + irq], INTR_TYPE_MISC,
223 		    port_intr, NULL, sc, &sc->gpio_ih[irq]))) {
224 			device_printf(dev,
225 			    "ERROR: Unable to register interrupt handler\n");
226 			return (ENXIO);
227 		}
228 	}
229 
230 	return (0);
231 }
232 
233 static device_method_t port_methods[] = {
234 	DEVMETHOD(device_probe,		port_probe),
235 	DEVMETHOD(device_attach,	port_attach),
236 	{ 0, 0 }
237 };
238 
239 static driver_t port_driver = {
240 	"port",
241 	port_methods,
242 	sizeof(struct port_softc),
243 };
244 
245 DRIVER_MODULE(port, simplebus, port_driver, 0, 0);
246