xref: /netbsd/sys/arch/arm/sociox/sni_gpio.c (revision 6ac9135a)
1 /*	$NetBSD: sni_gpio.c,v 1.8 2020/05/31 23:55:18 thorpej Exp $	*/
2 
3 /*-
4  * Copyright (c) 2020 The NetBSD Foundation, Inc.
5  * All rights reserved.
6  *
7  * This code is derived from software contributed to The NetBSD Foundation
8  * by Tohru Nishimura.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in the
17  *    documentation and/or other materials provided with the distribution.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
20  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
21  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
23  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29  * POSSIBILITY OF SUCH DAMAGE.
30  */
31 
32 /*
33  * Socionext SC2A11 SynQuacer GPIO driver
34  */
35 
36 #include <sys/cdefs.h>
37 __KERNEL_RCSID(0, "$NetBSD: sni_gpio.c,v 1.8 2020/05/31 23:55:18 thorpej Exp $");
38 
39 #include <sys/param.h>
40 #include <sys/device.h>
41 #include <sys/systm.h>
42 #include <sys/gpio.h>
43 #include <sys/kernel.h>
44 #include <sys/systm.h>
45 
46 #include <machine/endian.h>
47 #include <sys/bus.h>
48 #include <sys/intr.h>
49 
50 #include <dev/gpio/gpiovar.h>
51 #include <dev/fdt/fdtvar.h>
52 #include <dev/acpi/acpireg.h>
53 #include <dev/acpi/acpivar.h>
54 #include <dev/acpi/acpi_intr.h>
55 
56 static int snigpio_fdt_match(device_t, struct cfdata *, void *);
57 static void snigpio_fdt_attach(device_t, device_t, void *);
58 static int snigpio_acpi_match(device_t, struct cfdata *, void *);
59 static void snigpio_acpi_attach(device_t, device_t, void *);
60 
61 struct snigpio_softc {
62 	device_t		sc_dev;
63 	bus_space_tag_t		sc_iot;
64 	bus_space_handle_t	sc_ioh;
65 	bus_addr_t		sc_iob;
66 	bus_size_t		sc_ios;
67 	void			*sc_ih;
68 	kmutex_t		sc_lock;
69 	struct gpio_chipset_tag	sc_gpio_gc;
70 	gpio_pin_t		sc_gpio_pins[32];
71 	int			sc_maxpins;
72 	int			sc_phandle;
73 };
74 
75 CFATTACH_DECL_NEW(snigpio_fdt, sizeof(struct snigpio_softc),
76     snigpio_fdt_match, snigpio_fdt_attach, NULL, NULL);
77 
78 CFATTACH_DECL_NEW(snigpio_acpi, sizeof(struct snigpio_softc),
79     snigpio_acpi_match, snigpio_acpi_attach, NULL, NULL);
80 
81 /*
82  * "DevelopmentBox" implementation
83  *    DSW3-PIN1,  DSW3-PIN2,  DSW3-PIN3,    DSW3-PIN4,
84  *    DSW3-PIN5,  DSW3-PIN6,  DSW3-PIN7,    DSW3-PIN8,
85  *    PSIN#,      PWROFF#,    GPIO-A,       GPIO-B,
86  *    GPIO-C,     GPIO-D,     PCIE1EXTINT,  PCIE0EXTINT,
87  *    PHY2-INT#,  PHY1-INT#,  GPIO-E,       GPIO-F,
88  *    GPIO-G,     GPIO-H,     GPIO-I,       GPIO-J,
89  *    GPIO-K,     GPIO-L,     PEC-PD26,     PEC-PD27,
90  *    PEC-PD28,   PEC-PD29,   PEC-PD30,     PEC-PD31
91  *
92  *    DSW3-PIN1 -- what's "varstore" really this
93  *    DSW3-PIN3 -- tweek PCIe bus implementation error toggle
94  *    PowerButton (PWROFF#) can be detectable.
95  *
96  *  96board mezzanine
97  *    i2c  "/i2c@51221000"
98  *    spi  "/spi@54810000"
99  *    gpio "/gpio@51000000" pinA-L (10-25) down edge sensitive
100  */
101 static void snigpio_attach_i(struct snigpio_softc *);
102 static int snigpio_intr(void *);
103 
104 static int
105 snigpio_fdt_match(device_t parent, struct cfdata *match, void *aux)
106 {
107 	static const char * compatible[] = {
108 		"socionext,synquacer-gpio",
109 		"fujitsu,mb86s70-gpio",
110 		NULL
111 	};
112 	struct fdt_attach_args * const faa = aux;
113 
114 	return of_match_compatible(faa->faa_phandle, compatible);
115 }
116 
117 static void
118 snigpio_fdt_attach(device_t parent, device_t self, void *aux)
119 {
120 	struct snigpio_softc * const sc = device_private(self);
121 	struct fdt_attach_args * const faa = aux;
122 	const int phandle = faa->faa_phandle;
123 	bus_space_handle_t ioh;
124 	bus_addr_t addr;
125 	bus_size_t size;
126 	char intrstr[128];
127 	const char *list;
128 
129 	if (fdtbus_get_reg(phandle, 0, &addr, &size) != 0
130 	    || bus_space_map(faa->faa_bst, addr, size, 0, &ioh) != 0) {
131 		aprint_error(": unable to map device\n");
132 		return;
133 	}
134 	if (!fdtbus_intr_str(phandle, 0, intrstr, sizeof(intrstr))) {
135 		aprint_error(": failed to decode interrupt\n");
136 		goto fail;
137 	}
138 	sc->sc_ih = fdtbus_intr_establish(phandle,
139 			0, IPL_VM, 0, snigpio_intr, sc);
140 	if (sc->sc_ih == NULL) {
141 		aprint_error_dev(self, "couldn't establish interrupt\n");
142 		goto fail;
143 	}
144 
145 	aprint_naive("\n");
146 	aprint_normal_dev(self, "Socionext GPIO controller\n");
147 	aprint_normal_dev(self, "interrupting on %s\n", intrstr);
148 	list = fdtbus_get_string(phandle, "gpio-line-names");
149 	if (list)
150 		aprint_normal_dev(self, "%s\n", list);
151 
152 	sc->sc_dev = self;
153 	sc->sc_phandle = phandle;
154 	sc->sc_iot = faa->faa_bst;
155 	sc->sc_ioh = ioh;
156 	sc->sc_iob = addr;
157 	sc->sc_ios = size;
158 
159 	snigpio_attach_i(sc);
160 
161 	return;
162  fail:
163 	bus_space_unmap(sc->sc_iot, sc->sc_ioh, sc->sc_ios);
164 	return;
165 }
166 
167 static int
168 snigpio_acpi_match(device_t parent, struct cfdata *match, void *aux)
169 {
170 	static const char * compatible[] = {
171 		"SCX0007",
172 		NULL
173 	};
174 	struct acpi_attach_args *aa = aux;
175 
176 	if (aa->aa_node->ad_type != ACPI_TYPE_DEVICE)
177 		return 0;
178 	return acpi_match_hid(aa->aa_node->ad_devinfo, compatible);
179 }
180 
181 static void
182 snigpio_acpi_attach(device_t parent, device_t self, void *aux)
183 {
184 	struct snigpio_softc * const sc = device_private(self);
185 	struct acpi_attach_args *aa = aux;
186 	ACPI_HANDLE handle = aa->aa_node->ad_handle;
187 	bus_space_handle_t ioh;
188 	struct acpi_resources res;
189 	struct acpi_mem *mem;
190 	struct acpi_irq *irq;
191 	ACPI_STATUS rv;
192 	char *list;
193 
194 	rv = acpi_resource_parse(self, aa->aa_node->ad_handle, "_CRS",
195 	    &res, &acpi_resource_parse_ops_default);
196 	if (ACPI_FAILURE(rv))
197 		return;
198 	mem = acpi_res_mem(&res, 0);
199 	irq = acpi_res_irq(&res, 0);
200 	if (mem == NULL || irq == NULL || mem->ar_length == 0) {
201 		aprint_error(": incomplete resources\n");
202 		return;
203 	}
204 	if (bus_space_map(aa->aa_memt, mem->ar_base, mem->ar_length, 0,
205 	    &ioh)) {
206 		aprint_error(": couldn't map registers\n");
207 		return;
208 	}
209 	sc->sc_ih = acpi_intr_establish(self,
210 	    (uint64_t)(uintptr_t)aa->aa_node->ad_handle,
211 	    IPL_VM, false, snigpio_intr, sc, device_xname(self));
212 	if (sc->sc_ih == NULL) {
213 		aprint_error_dev(self, "couldn't establish interrupt\n");
214 		goto fail;
215 	}
216 
217 	aprint_normal_dev(self, "Socionext GPIO controller\n");
218 	rv = acpi_dsd_string(handle, "gpio-line-names", &list);
219 	if (ACPI_SUCCESS(rv))
220 		aprint_normal_dev(self, "%s\n", list);
221 
222 	sc->sc_dev = self;
223 	sc->sc_iot = aa->aa_memt;
224 	sc->sc_ioh = ioh;
225 	sc->sc_ios = mem->ar_length;
226 
227 	snigpio_attach_i(sc);
228 
229 	acpi_resource_cleanup(&res);
230 	return;
231  fail:
232 	acpi_resource_cleanup(&res);
233 	bus_space_unmap(sc->sc_iot, sc->sc_ioh, sc->sc_ios);
234 	return;
235 }
236 
237 static void
238 snigpio_attach_i(struct snigpio_softc *sc)
239 {
240 	struct gpio_chipset_tag	*gc;
241 	struct gpiobus_attach_args gba;
242 
243 	mutex_init(&sc->sc_lock, MUTEX_DEFAULT, IPL_VM);
244 	sc->sc_maxpins = 32;
245 
246 	/* create controller tag */
247 	gc = &sc->sc_gpio_gc;
248 	gc->gp_cookie = sc;
249 	gc->gp_pin_read = NULL; /* AAA */
250 	gc->gp_pin_write = NULL; /* AAA */
251 	gc->gp_pin_ctl = NULL; /* AAA */
252 	gc->gp_intr_establish = NULL; /* AAA */
253 	gc->gp_intr_disestablish = NULL; /* AAA */
254 	gc->gp_intr_str = NULL; /* AAA */
255 
256 	gba.gba_gc = gc;
257 	gba.gba_pins = &sc->sc_gpio_pins[0];
258 	gba.gba_npins = sc->sc_maxpins;
259 
260 	(void) config_found_ia(sc->sc_dev, "gpiobus", &gba, gpiobus_print);
261 }
262 
263 static int
264 snigpio_intr(void *arg)
265 {
266 	return 1;
267 }
268