xref: /freebsd/sys/powerpc/ofw/openpic_ofw.c (revision 22cf89c938886d14f5796fc49f9f020c23ea8eaf)
1 /*-
2  * SPDX-License-Identifier: BSD-3-Clause
3  *
4  * Copyright 2003 by Peter Grehan. All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
14  * 3. The name of the author may not be used to endorse or promote products
15  *    derived from this software without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
22  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
23  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
24  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
25  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27  * SUCH DAMAGE.
28  *
29  */
30 
31 #include <sys/cdefs.h>
32 #include <sys/param.h>
33 #include <sys/systm.h>
34 #include <sys/module.h>
35 #include <sys/bus.h>
36 #include <sys/conf.h>
37 #include <sys/kernel.h>
38 
39 #include <dev/ofw/ofw_bus.h>
40 #include <dev/ofw/ofw_bus_subr.h>
41 #include <dev/ofw/openfirm.h>
42 
43 #include <machine/bus.h>
44 #include <machine/intr_machdep.h>
45 #include <machine/md_var.h>
46 #include <machine/pio.h>
47 #include <machine/resource.h>
48 
49 #include <vm/vm.h>
50 #include <vm/pmap.h>
51 
52 #include <sys/rman.h>
53 
54 #include <machine/openpicreg.h>
55 #include <machine/openpicvar.h>
56 
57 #include "pic_if.h"
58 
59 /*
60  * OFW interface
61  */
62 static int	openpic_ofw_probe(device_t);
63 static int	openpic_ofw_attach(device_t);
64 
65 static void	openpic_ofw_translate_code(device_t, u_int irq, int code,
66 		    enum intr_trigger *trig, enum intr_polarity *pol);
67 
68 static device_method_t  openpic_ofw_methods[] = {
69 	/* Device interface */
70 	DEVMETHOD(device_probe,		openpic_ofw_probe),
71 	DEVMETHOD(device_attach,	openpic_ofw_attach),
72 	DEVMETHOD(device_suspend,	openpic_suspend),
73 	DEVMETHOD(device_resume,	openpic_resume),
74 
75 	/* PIC interface */
76 	DEVMETHOD(pic_bind,		openpic_bind),
77 	DEVMETHOD(pic_config,		openpic_config),
78 	DEVMETHOD(pic_dispatch,		openpic_dispatch),
79 	DEVMETHOD(pic_enable,		openpic_enable),
80 	DEVMETHOD(pic_eoi,		openpic_eoi),
81 	DEVMETHOD(pic_ipi,		openpic_ipi),
82 	DEVMETHOD(pic_mask,		openpic_mask),
83 	DEVMETHOD(pic_unmask,		openpic_unmask),
84 
85 	DEVMETHOD(pic_translate_code,	openpic_ofw_translate_code),
86 
87 	DEVMETHOD_END
88 };
89 
90 static driver_t openpic_ofw_driver = {
91 	"openpic",
92 	openpic_ofw_methods,
93 	sizeof(struct openpic_softc),
94 };
95 
96 EARLY_DRIVER_MODULE(openpic, ofwbus, openpic_ofw_driver, 0, 0,
97     BUS_PASS_INTERRUPT);
98 EARLY_DRIVER_MODULE(openpic, simplebus, openpic_ofw_driver, 0, 0,
99     BUS_PASS_INTERRUPT);
100 EARLY_DRIVER_MODULE(openpic, macio, openpic_ofw_driver, 0, 0,
101     BUS_PASS_INTERRUPT);
102 
103 static int
104 openpic_ofw_probe(device_t dev)
105 {
106 	const char *type = ofw_bus_get_type(dev);
107 
108 	if (type == NULL)
109                 return (ENXIO);
110 
111 	if (!ofw_bus_is_compatible(dev, "chrp,open-pic") &&
112 	    strcmp(type, "open-pic") != 0)
113                 return (ENXIO);
114 
115 	/*
116 	 * On some U4 systems, there is a phantom MPIC in the mac-io cell.
117 	 * The uninorth driver will pick up the real PIC, so ignore it here.
118 	 */
119 	if (OF_finddevice("/u4") != (phandle_t)-1)
120 		return (ENXIO);
121 
122 	device_set_desc(dev, OPENPIC_DEVSTR);
123 	return (0);
124 }
125 
126 static int
127 openpic_ofw_attach(device_t dev)
128 {
129 	struct openpic_softc *sc;
130 	phandle_t xref, node;
131 
132 	node = ofw_bus_get_node(dev);
133 	sc = device_get_softc(dev);
134 
135 	if (OF_getencprop(node, "phandle", &xref, sizeof(xref)) == -1 &&
136 	    OF_getencprop(node, "ibm,phandle", &xref, sizeof(xref)) == -1 &&
137 	    OF_getencprop(node, "linux,phandle", &xref, sizeof(xref)) == -1)
138 		xref = node;
139 
140 	if (ofw_bus_is_compatible(dev, "fsl,mpic")) {
141 		sc->sc_quirks = OPENPIC_QUIRK_SINGLE_BIND;
142 		sc->sc_quirks |= OPENPIC_QUIRK_HIDDEN_IRQS;
143 	}
144 
145 	return (openpic_common_attach(dev, xref));
146 }
147 
148 static void
149 openpic_ofw_translate_code(device_t dev, u_int irq, int code,
150     enum intr_trigger *trig, enum intr_polarity *pol)
151 {
152 	switch (code) {
153 	case 0:
154 		/* L to H edge */
155 		*trig = INTR_TRIGGER_EDGE;
156 		*pol = INTR_POLARITY_HIGH;
157 		break;
158 	case 1:
159 		/* Active L level */
160 		*trig = INTR_TRIGGER_LEVEL;
161 		*pol = INTR_POLARITY_LOW;
162 		break;
163 	case 2:
164 		/* Active H level */
165 		*trig = INTR_TRIGGER_LEVEL;
166 		*pol = INTR_POLARITY_HIGH;
167 		break;
168 	case 3:
169 		/* H to L edge */
170 		*trig = INTR_TRIGGER_EDGE;
171 		*pol = INTR_POLARITY_LOW;
172 		break;
173 	default:
174 		*trig = INTR_TRIGGER_CONFORM;
175 		*pol = INTR_POLARITY_CONFORM;
176 	}
177 }
178