xref: /netbsd-src/sys/arch/i386/pci/gscpcib.c (revision abb0f93cd77b67f080613360c65701f85e5f5cfe)
1 /*	$NetBSD: gscpcib.c,v 1.14 2009/08/18 19:51:45 dyoung Exp $	*/
2 /*	$OpenBSD: gscpcib.c,v 1.3 2004/10/05 19:02:33 grange Exp $	*/
3 /*
4  * Copyright (c) 2004 Alexander Yurchenko <grange@openbsd.org>
5  *
6  * Permission to use, copy, modify, and distribute this software for any
7  * purpose with or without fee is hereby granted, provided that the above
8  * copyright notice and this permission notice appear in all copies.
9  *
10  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
11  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
13  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
15  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
16  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17  */
18 
19 /*
20  * Special driver for the National Semiconductor Geode SC1100 PCI-ISA bridge
21  * that attaches instead of pcib(4). In addition to the core pcib(4)
22  * functionality this driver provides support for the GPIO interface.
23  */
24 
25 #include <sys/cdefs.h>
26 __KERNEL_RCSID(0, "$NetBSD: gscpcib.c,v 1.14 2009/08/18 19:51:45 dyoung Exp $");
27 
28 #include <sys/param.h>
29 #include <sys/systm.h>
30 #include <sys/device.h>
31 #include <sys/gpio.h>
32 #include <sys/kernel.h>
33 
34 #include <machine/bus.h>
35 
36 #include <dev/pci/pcireg.h>
37 #include <dev/pci/pcivar.h>
38 #include <dev/pci/pcidevs.h>
39 
40 #include <dev/gpio/gpiovar.h>
41 
42 #include <i386/pci/gscpcibreg.h>
43 #include <arch/x86/pci/pcibvar.h>
44 
45 struct gscpcib_softc {
46 	struct pcib_softc sc_pcib;
47 
48 	bool sc_gpio_present;
49 	device_t sc_gpiobus;
50 
51 	/* GPIO interface */
52 	bus_space_tag_t sc_gpio_iot;
53 	bus_space_handle_t sc_gpio_ioh;
54 	struct gpio_chipset_tag sc_gpio_gc;
55 	gpio_pin_t sc_gpio_pins[GSCGPIO_NPINS];
56 };
57 
58 int	gscpcib_match(device_t, cfdata_t, void *);
59 void	gscpcib_attach(device_t, device_t, void *);
60 int	gscpcib_detach(device_t, int);
61 int	gscpcib_rescan(device_t, const char *, const int *);
62 void	gscpcib_childdetached(device_t, device_t);
63 
64 int	gscpcib_gpio_pin_read(void *, int);
65 void	gscpcib_gpio_pin_write(void *, int, int);
66 void	gscpcib_gpio_pin_ctl(void *, int, int);
67 
68 CFATTACH_DECL3_NEW(gscpcib, sizeof(struct gscpcib_softc),
69 	gscpcib_match, gscpcib_attach, gscpcib_detach, NULL, gscpcib_rescan,
70 	gscpcib_childdetached, DVF_DETACH_SHUTDOWN);
71 
72 extern struct cfdriver gscpcib_cd;
73 
74 void
75 gscpcib_childdetached(device_t self, device_t child)
76 {
77 	struct gscpcib_softc *sc = device_private(self);
78 
79 	if (sc->sc_gpiobus == child)
80 		sc->sc_gpiobus = NULL;
81 	else
82 		pcibchilddet(self, child);
83 }
84 
85 /* XXX share this with sys/arch/i386/pci/elan520.c */
86 static bool
87 ifattr_match(const char *snull, const char *t)
88 {
89 	return (snull == NULL) || strcmp(snull, t) == 0;
90 }
91 
92 int
93 gscpcib_rescan(device_t self, const char *ifattr, const int *loc)
94 {
95 	struct gscpcib_softc *sc = device_private(self);
96 
97 	/* Attach GPIO framework */
98 	if (sc->sc_gpio_present && ifattr_match(ifattr, "gpiobus") &&
99 	    sc->sc_gpiobus == NULL) {
100 		struct gpiobus_attach_args gba;
101 
102 		gba.gba_gc = &sc->sc_gpio_gc;
103 		gba.gba_pins = sc->sc_gpio_pins;
104 		gba.gba_npins = GSCGPIO_NPINS;
105 
106 		sc->sc_gpiobus = config_found_sm_loc(self, "gpiobus", loc,
107 		    &gba, gpiobus_print, NULL);
108 		return 0;
109 	}
110 	return pcibrescan(self, ifattr, loc);
111 }
112 
113 int
114 gscpcib_match(device_t parent, cfdata_t match, void *aux)
115 {
116 	struct pci_attach_args *pa = aux;
117 
118 	if (PCI_CLASS(pa->pa_class) != PCI_CLASS_BRIDGE ||
119 	    PCI_SUBCLASS(pa->pa_class) != PCI_SUBCLASS_BRIDGE_ISA)
120 		return (0);
121 
122 	if (PCI_VENDOR(pa->pa_id) == PCI_VENDOR_NS &&
123 	    PCI_PRODUCT(pa->pa_id) == PCI_PRODUCT_NS_SC1100_ISA)
124 		return (2);	/* supersede pcib(4) */
125 
126 	return (0);
127 }
128 
129 void
130 gscpcib_attach(device_t parent, device_t self, void *aux)
131 {
132 	struct gscpcib_softc *sc = device_private(self);
133 	struct pci_attach_args *pa = aux;
134 	pcireg_t gpiobase;
135 	int i;
136 
137 	/* Map GPIO I/O space */
138 	gpiobase = pci_conf_read(pa->pa_pc, pa->pa_tag, GSCGPIO_BASE);
139 	sc->sc_gpio_iot = pa->pa_iot;
140 	if (bus_space_map(sc->sc_gpio_iot, PCI_MAPREG_IO_ADDR(gpiobase),
141 	    GSCGPIO_SIZE, 0, &sc->sc_gpio_ioh)) {
142 		printf(": failed to map GPIO I/O space");
143 		goto corepcib;
144 	}
145 
146 	/* Initialize pins array */
147 	for (i = 0; i < GSCGPIO_NPINS; i++) {
148 		sc->sc_gpio_pins[i].pin_num = i;
149 		sc->sc_gpio_pins[i].pin_caps = GPIO_PIN_INPUT |
150 		    GPIO_PIN_OUTPUT | GPIO_PIN_OPENDRAIN |
151 		    GPIO_PIN_PUSHPULL | GPIO_PIN_TRISTATE |
152 		    GPIO_PIN_PULLUP;
153 
154 		/* safe defaults */
155 		sc->sc_gpio_pins[i].pin_flags = GPIO_PIN_TRISTATE;
156 		sc->sc_gpio_pins[i].pin_state = GPIO_PIN_LOW;
157 		gscpcib_gpio_pin_ctl(sc, i, sc->sc_gpio_pins[i].pin_flags);
158 		gscpcib_gpio_pin_write(sc, i, sc->sc_gpio_pins[i].pin_state);
159 	}
160 
161 	/* Create controller tag */
162 	sc->sc_gpio_gc.gp_cookie = sc;
163 	sc->sc_gpio_gc.gp_pin_read = gscpcib_gpio_pin_read;
164 	sc->sc_gpio_gc.gp_pin_write = gscpcib_gpio_pin_write;
165 	sc->sc_gpio_gc.gp_pin_ctl = gscpcib_gpio_pin_ctl;
166 
167 	sc->sc_gpio_present = true;
168 
169 corepcib:
170 	/* Provide core pcib(4) functionality */
171 	pcibattach(parent, self, aux);
172 
173 	gscpcib_rescan(self, "gpiobus", NULL);
174 }
175 
176 int
177 gscpcib_detach(device_t self, int flags)
178 {
179 	int rc;
180 	struct gscpcib_softc *sc = device_private(self);
181 
182 	if ((rc = config_detach_children(self, flags)) != 0)
183 		return rc;
184 
185 	if ((rc = pcibdetach(self, flags)) != 0)
186 		return rc;
187 
188 	if (sc->sc_gpio_present)
189 		bus_space_unmap(sc->sc_gpio_iot, sc->sc_gpio_ioh, GSCGPIO_SIZE);
190 
191 	return rc;
192 }
193 
194 static inline void
195 gscpcib_gpio_pin_select(struct gscpcib_softc *sc, int pin)
196 {
197 	bus_space_write_4(sc->sc_gpio_iot, sc->sc_gpio_ioh, GSCGPIO_SEL, pin);
198 }
199 
200 int
201 gscpcib_gpio_pin_read(void *arg, int pin)
202 {
203 	struct gscpcib_softc *sc = arg;
204 	int reg, shift;
205 	uint32_t data;
206 
207 	reg = (pin < 32 ? GSCGPIO_GPDI0 : GSCGPIO_GPDI1);
208 	shift = pin % 32;
209 	data = bus_space_read_4(sc->sc_gpio_iot, sc->sc_gpio_ioh, reg);
210 
211 	return ((data >> shift) & 0x1);
212 }
213 
214 void
215 gscpcib_gpio_pin_write(void *arg, int pin, int value)
216 {
217 	struct gscpcib_softc *sc = arg;
218 	int reg, shift;
219 	uint32_t data;
220 
221 	reg = (pin < 32 ? GSCGPIO_GPDO0 : GSCGPIO_GPDO1);
222 	shift = pin % 32;
223 	data = bus_space_read_4(sc->sc_gpio_iot, sc->sc_gpio_ioh, reg);
224 	if (value == 0)
225 		data &= ~(1 << shift);
226 	else if (value == 1)
227 		data |= (1 << shift);
228 
229 	bus_space_write_4(sc->sc_gpio_iot, sc->sc_gpio_ioh, reg, data);
230 }
231 
232 void
233 gscpcib_gpio_pin_ctl(void *arg, int pin, int flags)
234 {
235 	struct gscpcib_softc *sc = arg;
236 	uint32_t conf;
237 
238 	gscpcib_gpio_pin_select(sc, pin);
239 	conf = bus_space_read_4(sc->sc_gpio_iot, sc->sc_gpio_ioh,
240 	    GSCGPIO_CONF);
241 
242 	conf &= ~(GSCGPIO_CONF_OUTPUTEN | GSCGPIO_CONF_PUSHPULL |
243 	    GSCGPIO_CONF_PULLUP);
244 	if ((flags & GPIO_PIN_TRISTATE) == 0)
245 		conf |= GSCGPIO_CONF_OUTPUTEN;
246 	if (flags & GPIO_PIN_PUSHPULL)
247 		conf |= GSCGPIO_CONF_PUSHPULL;
248 	if (flags & GPIO_PIN_PULLUP)
249 		conf |= GSCGPIO_CONF_PULLUP;
250 	bus_space_write_4(sc->sc_gpio_iot, sc->sc_gpio_ioh,
251 	    GSCGPIO_CONF, conf);
252 }
253