xref: /freebsd/sys/powerpc/ofw/openpic_ofw.c (revision b1f9167f94059fd55c630891d359bcff987bd7eb)
1 /*-
2  * Copyright 2003 by Peter Grehan. All rights reserved.
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  * 3. The name of the author may not be used to endorse or promote products
13  *    derived from this software without specific prior written permission.
14  *
15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
16  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
19  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
20  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
21  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
22  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
23  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25  * SUCH DAMAGE.
26  *
27  */
28 
29 #include <sys/cdefs.h>
30 __FBSDID("$FreeBSD$");
31 
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 DRIVER_MODULE(openpic, ofwbus, openpic_ofw_driver, openpic_devclass, 0, 0);
97 DRIVER_MODULE(openpic, simplebus, openpic_ofw_driver, openpic_devclass, 0, 0);
98 DRIVER_MODULE(openpic, macio, openpic_ofw_driver, openpic_devclass, 0, 0);
99 
100 static int
101 openpic_ofw_probe(device_t dev)
102 {
103 	const char *type = ofw_bus_get_type(dev);
104 
105 	if (type == NULL)
106                 return (ENXIO);
107 
108 	if (!ofw_bus_is_compatible(dev, "chrp,open-pic") &&
109 	    strcmp(type, "open-pic") != 0)
110                 return (ENXIO);
111 
112 	/*
113 	 * On some U4 systems, there is a phantom MPIC in the mac-io cell.
114 	 * The uninorth driver will pick up the real PIC, so ignore it here.
115 	 */
116 	if (OF_finddevice("/u4") != (phandle_t)-1)
117 		return (ENXIO);
118 
119 	device_set_desc(dev, OPENPIC_DEVSTR);
120 	return (0);
121 }
122 
123 static int
124 openpic_ofw_attach(device_t dev)
125 {
126 	phandle_t xref, node;
127 
128 	node = ofw_bus_get_node(dev);
129 
130 	if (OF_getprop(node, "phandle", &xref, sizeof(xref)) == -1 &&
131 	    OF_getprop(node, "ibm,phandle", &xref, sizeof(xref)) == -1 &&
132 	    OF_getprop(node, "linux,phandle", &xref, sizeof(xref)) == -1)
133 		xref = node;
134 
135 	return (openpic_common_attach(dev, xref));
136 }
137 
138 static void
139 openpic_ofw_translate_code(device_t dev, u_int irq, int code,
140     enum intr_trigger *trig, enum intr_polarity *pol)
141 {
142 	switch (code) {
143 	case 0:
144 		/* L to H edge */
145 		*trig = INTR_TRIGGER_EDGE;
146 		*pol = INTR_POLARITY_HIGH;
147 		break;
148 	case 1:
149 		/* Active L level */
150 		*trig = INTR_TRIGGER_LEVEL;
151 		*pol = INTR_POLARITY_LOW;
152 		break;
153 	case 2:
154 		/* Active H level */
155 		*trig = INTR_TRIGGER_LEVEL;
156 		*pol = INTR_POLARITY_HIGH;
157 		break;
158 	case 3:
159 		/* H to L edge */
160 		*trig = INTR_TRIGGER_EDGE;
161 		*pol = INTR_POLARITY_LOW;
162 		break;
163 	default:
164 		*trig = INTR_TRIGGER_CONFORM;
165 		*pol = INTR_POLARITY_CONFORM;
166 	}
167 }
168 
169