xref: /netbsd-src/sys/arch/arm/nvidia/tegra_sdhc.c (revision cef8759bd76c1b621f8eab8faa6f208faabc2e15)
1 /* $NetBSD: tegra_sdhc.c,v 1.26 2020/03/01 16:38:59 skrll Exp $ */
2 
3 /*-
4  * Copyright (c) 2015 Jared D. McNeill <jmcneill@invisible.ca>
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 ``AS IS'' AND ANY EXPRESS OR
17  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
18  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
19  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
20  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
21  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
22  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
23  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
24  * 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 #define	TEGRA_SDHC_NO_SDR104
30 
31 #include "locators.h"
32 
33 #include <sys/cdefs.h>
34 __KERNEL_RCSID(0, "$NetBSD: tegra_sdhc.c,v 1.26 2020/03/01 16:38:59 skrll Exp $");
35 
36 #include <sys/param.h>
37 #include <sys/bus.h>
38 #include <sys/device.h>
39 #include <sys/intr.h>
40 #include <sys/systm.h>
41 #include <sys/kernel.h>
42 
43 #include <dev/sdmmc/sdhcreg.h>
44 #include <dev/sdmmc/sdhcvar.h>
45 #include <dev/sdmmc/sdmmcvar.h>
46 
47 #include <arm/nvidia/tegra_reg.h>
48 #include <arm/nvidia/tegra_var.h>
49 
50 #include <dev/fdt/fdtvar.h>
51 
52 static int	tegra_sdhc_match(device_t, cfdata_t, void *);
53 static void	tegra_sdhc_attach(device_t, device_t, void *);
54 
55 static int	tegra_sdhc_card_detect(struct sdhc_softc *);
56 static int	tegra_sdhc_write_protect(struct sdhc_softc *);
57 static int	tegra_sdhc_signal_voltage(struct sdhc_softc *, int);
58 
59 struct tegra_sdhc_softc {
60 	struct sdhc_softc	sc;
61 
62 	struct clk		*sc_clk;
63 	struct fdtbus_reset	*sc_rst;
64 
65 	bus_space_tag_t		sc_bst;
66 	bus_space_handle_t	sc_bsh;
67 	bus_size_t		sc_bsz;
68 	struct sdhc_host	*sc_host;
69 	void			*sc_ih;
70 
71 	struct fdtbus_gpio_pin	*sc_pin_cd;
72 	struct fdtbus_gpio_pin	*sc_pin_power;
73 	struct fdtbus_gpio_pin	*sc_pin_wp;
74 
75 	struct fdtbus_regulator	*sc_reg_vqmmc;
76 };
77 
78 CFATTACH_DECL_NEW(tegra_sdhc, sizeof(struct tegra_sdhc_softc),
79 	tegra_sdhc_match, tegra_sdhc_attach, NULL, NULL);
80 
81 static int
82 tegra_sdhc_match(device_t parent, cfdata_t cf, void *aux)
83 {
84 	const char * const compatible[] = {
85 		"nvidia,tegra210-sdhci",
86 		"nvidia,tegra124-sdhci",
87 		NULL
88 	};
89 	struct fdt_attach_args * const faa = aux;
90 
91 	return of_match_compatible(faa->faa_phandle, compatible);
92 }
93 
94 static void
95 tegra_sdhc_attach(device_t parent, device_t self, void *aux)
96 {
97 	struct tegra_sdhc_softc * const sc = device_private(self);
98 	struct fdt_attach_args * const faa = aux;
99 	char intrstr[128];
100 	bus_addr_t addr;
101 	bus_size_t size;
102 	u_int bus_width;
103 	int error;
104 
105 	if (fdtbus_get_reg(faa->faa_phandle, 0, &addr, &size) != 0) {
106 		aprint_error(": couldn't get registers\n");
107 		return;
108 	}
109 
110 	if (of_getprop_uint32(faa->faa_phandle, "bus-width", &bus_width))
111 		bus_width = 4;
112 
113 	sc->sc.sc_dev = self;
114 	sc->sc.sc_dmat = faa->faa_dmat;
115 
116 #ifdef _LP64
117 	error = bus_dmatag_subregion(faa->faa_dmat, 0, 0xffffffff,
118 	    &sc->sc.sc_dmat, BUS_DMA_WAITOK);
119 	if (error != 0) {
120 		aprint_error(": couldn't create DMA tag: %d\n", error);
121 		return;
122 	}
123 #endif
124 
125 	sc->sc.sc_flags = SDHC_FLAG_32BIT_ACCESS |
126 			  SDHC_FLAG_NO_PWR0 |
127 			  SDHC_FLAG_NO_CLKBASE |
128 			  SDHC_FLAG_NO_TIMEOUT |
129 			  SDHC_FLAG_SINGLE_POWER_WRITE |
130 			  SDHC_FLAG_NO_HS_BIT |
131 			  SDHC_FLAG_USE_DMA |
132 			  SDHC_FLAG_USE_ADMA2;
133 	if (bus_width == 8) {
134 		sc->sc.sc_flags |= SDHC_FLAG_8BIT_MODE;
135 	}
136 	sc->sc.sc_host = &sc->sc_host;
137 
138 	sc->sc_bst = faa->faa_bst;
139 	error = bus_space_map(sc->sc_bst, addr, size, 0, &sc->sc_bsh);
140 	if (error) {
141 		aprint_error(": couldn't map %#" PRIxBUSADDR ": %d", addr, error);
142 		return;
143 	}
144 	sc->sc_bsz = size;
145 
146 #ifdef TEGRA_SDHC_NO_SDR104
147 	/* XXX SDR104 requires a custom tuning method on Tegra K1 */
148 	sc->sc.sc_flags |= SDHC_FLAG_HOSTCAPS;
149 	sc->sc.sc_caps = bus_space_read_4(sc->sc_bst, sc->sc_bsh,
150 	    SDHC_CAPABILITIES);
151 	sc->sc.sc_caps2 = bus_space_read_4(sc->sc_bst, sc->sc_bsh,
152 	    SDHC_CAPABILITIES2);
153 	sc->sc.sc_caps2 &= ~SDHC_SDR104_SUPP;
154 #endif
155 
156 	sc->sc_pin_power = fdtbus_gpio_acquire(faa->faa_phandle,
157 	    "power-gpios", GPIO_PIN_OUTPUT);
158 	if (sc->sc_pin_power)
159 		fdtbus_gpio_write(sc->sc_pin_power, 1);
160 
161 	sc->sc_pin_cd = fdtbus_gpio_acquire(faa->faa_phandle,
162 	    "cd-gpios", GPIO_PIN_INPUT);
163 	sc->sc_pin_wp = fdtbus_gpio_acquire(faa->faa_phandle,
164 	    "wp-gpios", GPIO_PIN_INPUT);
165 
166 	if (sc->sc_pin_cd) {
167 		sc->sc.sc_vendor_card_detect = tegra_sdhc_card_detect;
168 		sc->sc.sc_flags |= SDHC_FLAG_POLL_CARD_DET;
169 	}
170 	if (sc->sc_pin_wp) {
171 		sc->sc.sc_vendor_write_protect = tegra_sdhc_write_protect;
172 	}
173 
174 	sc->sc_reg_vqmmc = fdtbus_regulator_acquire(faa->faa_phandle,
175 	    "vqmmc-supply");
176 	if (sc->sc_reg_vqmmc) {
177 		sc->sc.sc_vendor_signal_voltage = tegra_sdhc_signal_voltage;
178 	} else {
179 		/* Regulator required for UHS signaling */
180 		sc->sc.sc_flags |= SDHC_FLAG_HOSTCAPS;
181 		sc->sc.sc_caps = bus_space_read_4(sc->sc_bst, sc->sc_bsh,
182 		    SDHC_CAPABILITIES);
183 		sc->sc.sc_caps2 = bus_space_read_4(sc->sc_bst, sc->sc_bsh,
184 		    SDHC_CAPABILITIES2);
185 		sc->sc.sc_caps2 &= ~(SDHC_SDR50_SUPP|SDHC_SDR104_SUPP|SDHC_DDR50_SUPP);
186 	}
187 
188 	sc->sc_clk = fdtbus_clock_get_index(faa->faa_phandle, 0);
189 	if (sc->sc_clk == NULL) {
190 		aprint_error(": couldn't get clock\n");
191 		return;
192 	}
193 	sc->sc_rst = fdtbus_reset_get(faa->faa_phandle, "sdhci");
194 	if (sc->sc_rst == NULL) {
195 		aprint_error(": couldn't get reset\n");
196 		return;
197 	}
198 
199 	fdtbus_reset_assert(sc->sc_rst);
200 #ifdef TEGRA_SDHC_NO_SDR104
201 	error = clk_set_rate(sc->sc_clk, 100000000);
202 #else
203 	error = clk_set_rate(sc->sc_clk, 204000000);
204 #endif
205 	if (error) {
206 		aprint_error(": couldn't set frequency: %d\n", error);
207 		return;
208 	}
209 	error = clk_enable(sc->sc_clk);
210 	if (error) {
211 		aprint_error(": couldn't enable clock: %d\n", error);
212 		return;
213 	}
214 	fdtbus_reset_deassert(sc->sc_rst);
215 
216 	sc->sc.sc_clkbase = clk_get_rate(sc->sc_clk) / 1000;
217 
218 	aprint_naive("\n");
219 	aprint_normal(": SDMMC (%u kHz)\n", sc->sc.sc_clkbase);
220 
221 	if (sc->sc.sc_clkbase == 0) {
222 		aprint_error_dev(self, "couldn't determine frequency\n");
223 		return;
224 	}
225 
226 	if (!fdtbus_intr_str(faa->faa_phandle, 0, intrstr, sizeof(intrstr))) {
227 		aprint_error_dev(self, "failed to decode interrupt\n");
228 		return;
229 	}
230 
231 	sc->sc_ih = fdtbus_intr_establish(faa->faa_phandle, 0, IPL_SDMMC, 0,
232 	    sdhc_intr, &sc->sc);
233 	if (sc->sc_ih == NULL) {
234 		aprint_error_dev(self, "couldn't establish interrupt on %s\n",
235 		    intrstr);
236 		return;
237 	}
238 	aprint_normal_dev(self, "interrupting on %s\n", intrstr);
239 
240 	error = sdhc_host_found(&sc->sc, sc->sc_bst, sc->sc_bsh, sc->sc_bsz);
241 	if (error) {
242 		aprint_error_dev(self, "couldn't initialize host, error = %d\n",
243 		    error);
244 		fdtbus_intr_disestablish(faa->faa_phandle, sc->sc_ih);
245 		sc->sc_ih = NULL;
246 		return;
247 	}
248 }
249 
250 static int
251 tegra_sdhc_card_detect(struct sdhc_softc *ssc)
252 {
253 	struct tegra_sdhc_softc *sc = device_private(ssc->sc_dev);
254 
255 	KASSERT(sc->sc_pin_cd != NULL);
256 
257 	return fdtbus_gpio_read(sc->sc_pin_cd);
258 }
259 
260 static int
261 tegra_sdhc_write_protect(struct sdhc_softc *ssc)
262 {
263 	struct tegra_sdhc_softc *sc = device_private(ssc->sc_dev);
264 
265 	KASSERT(sc->sc_pin_wp != NULL);
266 
267 	return fdtbus_gpio_read(sc->sc_pin_wp);
268 }
269 
270 static int
271 tegra_sdhc_signal_voltage(struct sdhc_softc *ssc, int signal_voltage)
272 {
273 	struct tegra_sdhc_softc *sc = device_private(ssc->sc_dev);
274 	u_int uvol;
275 	int error;
276 
277 	KASSERT(sc->sc_reg_vqmmc != NULL);
278 
279 	switch (signal_voltage) {
280 	case SDMMC_SIGNAL_VOLTAGE_330:
281 		uvol = 3300000;
282 		break;
283 	case SDMMC_SIGNAL_VOLTAGE_180:
284 		uvol = 1800000;
285 		break;
286 	default:
287 		return EINVAL;
288 	}
289 
290 	error = fdtbus_regulator_set_voltage(sc->sc_reg_vqmmc, uvol, uvol);
291 	if (error != 0)
292 		return error;
293 
294 	return fdtbus_regulator_enable(sc->sc_reg_vqmmc);
295 }
296