bcm2835_emmc.c revision 1.30 1 /* $NetBSD: bcm2835_emmc.c,v 1.30 2017/06/22 13:13:51 jmcneill Exp $ */
2
3 /*-
4 * Copyright (c) 2012 The NetBSD Foundation, Inc.
5 * All rights reserved.
6 *
7 * This code is derived from software contributed to The NetBSD Foundation
8 * by Nick Hudson
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 #include <sys/cdefs.h>
33 __KERNEL_RCSID(0, "$NetBSD: bcm2835_emmc.c,v 1.30 2017/06/22 13:13:51 jmcneill Exp $");
34
35 #include "bcmdmac.h"
36
37 #include <sys/param.h>
38 #include <sys/systm.h>
39 #include <sys/device.h>
40 #include <sys/bus.h>
41 #include <sys/condvar.h>
42 #include <sys/mutex.h>
43 #include <sys/kernel.h>
44
45 #include <arm/broadcom/bcm2835reg.h>
46 #include <arm/broadcom/bcm_amba.h>
47 #include <arm/broadcom/bcm2835_dmac.h>
48
49 #include <dev/sdmmc/sdhcreg.h>
50 #include <dev/sdmmc/sdhcvar.h>
51 #include <dev/sdmmc/sdmmcvar.h>
52
53 enum bcmemmc_dma_state {
54 EMMC_DMA_STATE_IDLE,
55 EMMC_DMA_STATE_BUSY,
56 };
57
58 struct bcmemmc_softc {
59 struct sdhc_softc sc;
60
61 bus_space_tag_t sc_iot;
62 bus_space_handle_t sc_ioh;
63 bus_addr_t sc_iob;
64 bus_size_t sc_ios;
65 struct sdhc_host *sc_hosts[1];
66 void *sc_ih;
67
68 kcondvar_t sc_cv;
69
70 enum bcmemmc_dma_state sc_state;
71
72 struct bcm_dmac_channel *sc_dmac;
73
74 bus_dmamap_t sc_dmamap;
75 bus_dma_segment_t sc_segs[1]; /* XXX assumes enough descriptors fit in one page */
76 struct bcm_dmac_conblk *sc_cblk;
77 };
78
79 static int bcmemmc_match(device_t, struct cfdata *, void *);
80 static void bcmemmc_attach(device_t, device_t, void *);
81 static void bcmemmc_attach_i(device_t);
82 #if NBCMDMAC > 0
83 static int bcmemmc_xfer_data_dma(struct sdhc_softc *, struct sdmmc_command *);
84 static void bcmemmc_dma_done(uint32_t, uint32_t, void *);
85 #endif
86
87 CFATTACH_DECL_NEW(bcmemmc, sizeof(struct bcmemmc_softc),
88 bcmemmc_match, bcmemmc_attach, NULL, NULL);
89
90 /* ARGSUSED */
91 static int
92 bcmemmc_match(device_t parent, struct cfdata *match, void *aux)
93 {
94 struct amba_attach_args *aaa = aux;
95
96 if (strcmp(aaa->aaa_name, "emmc") != 0)
97 return 0;
98
99 return 1;
100 }
101
102 /* ARGSUSED */
103 static void
104 bcmemmc_attach(device_t parent, device_t self, void *aux)
105 {
106 struct bcmemmc_softc *sc = device_private(self);
107 prop_dictionary_t dict = device_properties(self);
108 struct amba_attach_args *aaa = aux;
109 prop_number_t frequency;
110 int error;
111
112 sc->sc.sc_dev = self;
113 sc->sc.sc_dmat = aaa->aaa_dmat;
114 sc->sc.sc_flags = 0;
115 sc->sc.sc_flags |= SDHC_FLAG_32BIT_ACCESS;
116 sc->sc.sc_flags |= SDHC_FLAG_HOSTCAPS;
117 sc->sc.sc_flags |= SDHC_FLAG_NO_HS_BIT;
118 sc->sc.sc_caps = SDHC_VOLTAGE_SUPP_3_3V | SDHC_HIGH_SPEED_SUPP |
119 (SDHC_MAX_BLK_LEN_1024 << SDHC_MAX_BLK_LEN_SHIFT);
120
121 sc->sc.sc_host = sc->sc_hosts;
122 sc->sc.sc_clkbase = 50000; /* Default to 50MHz */
123 sc->sc_iot = aaa->aaa_iot;
124
125 /* Fetch the EMMC clock frequency from property if set. */
126 frequency = prop_dictionary_get(dict, "frequency");
127 if (frequency != NULL) {
128 sc->sc.sc_clkbase = prop_number_integer_value(frequency) / 1000;
129 }
130
131 error = bus_space_map(sc->sc_iot, aaa->aaa_addr, aaa->aaa_size, 0,
132 &sc->sc_ioh);
133 if (error) {
134 aprint_error_dev(self,
135 "can't map registers for %s: %d\n", aaa->aaa_name, error);
136 return;
137 }
138 sc->sc_iob = aaa->aaa_addr;
139 sc->sc_ios = aaa->aaa_size;
140
141 aprint_naive(": SDHC controller\n");
142 aprint_normal(": SDHC controller\n");
143
144 sc->sc_ih = intr_establish(aaa->aaa_intr, IPL_SDMMC, IST_LEVEL, sdhc_intr,
145 &sc->sc);
146
147 if (sc->sc_ih == NULL) {
148 aprint_error_dev(self, "failed to establish interrupt %d\n",
149 aaa->aaa_intr);
150 goto fail;
151 }
152 aprint_normal_dev(self, "interrupting on intr %d\n", aaa->aaa_intr);
153
154 #if NBCMDMAC > 0
155 sc->sc_dmac = bcm_dmac_alloc(BCM_DMAC_TYPE_NORMAL, IPL_SDMMC,
156 bcmemmc_dma_done, sc);
157 if (sc->sc_dmac == NULL)
158 goto done;
159
160 sc->sc.sc_flags |= SDHC_FLAG_USE_DMA;
161 sc->sc.sc_flags |= SDHC_FLAG_EXTERNAL_DMA;
162 sc->sc.sc_caps |= SDHC_DMA_SUPPORT;
163 sc->sc.sc_vendor_transfer_data_dma = bcmemmc_xfer_data_dma;
164
165 sc->sc_state = EMMC_DMA_STATE_IDLE;
166 cv_init(&sc->sc_cv, "bcmemmcdma");
167
168 int rseg;
169 error = bus_dmamem_alloc(sc->sc.sc_dmat, PAGE_SIZE, PAGE_SIZE,
170 PAGE_SIZE, sc->sc_segs, 1, &rseg, BUS_DMA_WAITOK);
171 if (error) {
172 aprint_error_dev(self, "dmamem_alloc failed (%d)\n", error);
173 goto fail;
174 }
175
176 error = bus_dmamem_map(sc->sc.sc_dmat, sc->sc_segs, rseg, PAGE_SIZE,
177 (void **)&sc->sc_cblk, BUS_DMA_WAITOK);
178 if (error) {
179 aprint_error_dev(self, "dmamem_map failed (%d)\n", error);
180 goto fail;
181 }
182 KASSERT(sc->sc_cblk != NULL);
183
184 memset(sc->sc_cblk, 0, PAGE_SIZE);
185
186 error = bus_dmamap_create(sc->sc.sc_dmat, PAGE_SIZE, 1, PAGE_SIZE, 0,
187 BUS_DMA_WAITOK, &sc->sc_dmamap);
188 if (error) {
189 aprint_error_dev(self, "dmamap_create failed (%d)\n", error);
190 goto fail;
191 }
192
193 error = bus_dmamap_load(sc->sc.sc_dmat, sc->sc_dmamap, sc->sc_cblk,
194 PAGE_SIZE, NULL, BUS_DMA_WAITOK|BUS_DMA_WRITE);
195 if (error) {
196 aprint_error_dev(self, "dmamap_load failed (%d)\n", error);
197 goto fail;
198 }
199
200 done:
201 #endif
202 config_interrupts(self, bcmemmc_attach_i);
203 return;
204
205 fail:
206 /* XXX add bus_dma failure cleanup */
207 if (sc->sc_ih) {
208 intr_disestablish(sc->sc_ih);
209 sc->sc_ih = NULL;
210 }
211 bus_space_unmap(sc->sc_iot, sc->sc_ioh, sc->sc_ios);
212 }
213
214 static void
215 bcmemmc_attach_i(device_t self)
216 {
217 struct bcmemmc_softc * const sc = device_private(self);
218 int error;
219
220 error = sdhc_host_found(&sc->sc, sc->sc_iot, sc->sc_ioh, sc->sc_ios);
221 if (error != 0) {
222 aprint_error_dev(self, "couldn't initialize host, error=%d\n",
223 error);
224 goto fail;
225 }
226 return;
227
228 fail:
229 /* XXX add bus_dma failure cleanup */
230 if (sc->sc_ih) {
231 intr_disestablish(sc->sc_ih);
232 sc->sc_ih = NULL;
233 }
234 bus_space_unmap(sc->sc_iot, sc->sc_ioh, sc->sc_ios);
235 }
236
237 #if NBCMDMAC > 0
238 static int
239 bcmemmc_xfer_data_dma(struct sdhc_softc *sdhc_sc, struct sdmmc_command *cmd)
240 {
241 struct bcmemmc_softc * const sc = device_private(sdhc_sc->sc_dev);
242 kmutex_t *plock = sdhc_host_lock(sc->sc_hosts[0]);
243 size_t seg;
244 int error;
245
246 KASSERT(mutex_owned(plock));
247
248 for (seg = 0; seg < cmd->c_dmamap->dm_nsegs; seg++) {
249 sc->sc_cblk[seg].cb_ti =
250 __SHIFTIN(11, DMAC_TI_PERMAP); /* e.MMC */
251 sc->sc_cblk[seg].cb_txfr_len =
252 cmd->c_dmamap->dm_segs[seg].ds_len;
253 /*
254 * All transfers are assumed to be multiples of 32-bits.
255 */
256 KASSERTMSG((sc->sc_cblk[seg].cb_txfr_len & 0x3) == 0,
257 "seg %zu len %d", seg, sc->sc_cblk[seg].cb_txfr_len);
258 if (ISSET(cmd->c_flags, SCF_CMD_READ)) {
259 sc->sc_cblk[seg].cb_ti |= DMAC_TI_DEST_INC;
260 /*
261 * Use 128-bit mode if transfer is a multiple of
262 * 16-bytes.
263 */
264 if ((sc->sc_cblk[seg].cb_txfr_len & 0xf) == 0)
265 sc->sc_cblk[seg].cb_ti |= DMAC_TI_DEST_WIDTH;
266 sc->sc_cblk[seg].cb_ti |= DMAC_TI_SRC_DREQ;
267 sc->sc_cblk[seg].cb_source_ad =
268 sc->sc_iob + SDHC_DATA;
269 sc->sc_cblk[seg].cb_dest_ad =
270 cmd->c_dmamap->dm_segs[seg].ds_addr;
271 } else {
272 sc->sc_cblk[seg].cb_ti |= DMAC_TI_SRC_INC;
273 /*
274 * Use 128-bit mode if transfer is a multiple of
275 * 16-bytes.
276 */
277 if ((sc->sc_cblk[seg].cb_txfr_len & 0xf) == 0)
278 sc->sc_cblk[seg].cb_ti |= DMAC_TI_SRC_WIDTH;
279 sc->sc_cblk[seg].cb_ti |= DMAC_TI_DEST_DREQ;
280 sc->sc_cblk[seg].cb_ti |= DMAC_TI_WAIT_RESP;
281 sc->sc_cblk[seg].cb_source_ad =
282 cmd->c_dmamap->dm_segs[seg].ds_addr;
283 sc->sc_cblk[seg].cb_dest_ad =
284 sc->sc_iob + SDHC_DATA;
285 }
286 sc->sc_cblk[seg].cb_stride = 0;
287 if (seg == cmd->c_dmamap->dm_nsegs - 1) {
288 sc->sc_cblk[seg].cb_ti |= DMAC_TI_INTEN;
289 sc->sc_cblk[seg].cb_nextconbk = 0;
290 } else {
291 sc->sc_cblk[seg].cb_nextconbk =
292 sc->sc_dmamap->dm_segs[0].ds_addr +
293 sizeof(struct bcm_dmac_conblk) * (seg+1);
294 }
295 sc->sc_cblk[seg].cb_padding[0] = 0;
296 sc->sc_cblk[seg].cb_padding[1] = 0;
297 }
298
299 bus_dmamap_sync(sc->sc.sc_dmat, sc->sc_dmamap, 0,
300 sc->sc_dmamap->dm_mapsize, BUS_DMASYNC_PREWRITE);
301
302 error = 0;
303
304 KASSERT(sc->sc_state == EMMC_DMA_STATE_IDLE);
305 sc->sc_state = EMMC_DMA_STATE_BUSY;
306 bcm_dmac_set_conblk_addr(sc->sc_dmac,
307 sc->sc_dmamap->dm_segs[0].ds_addr);
308 error = bcm_dmac_transfer(sc->sc_dmac);
309 if (error)
310 return error;
311
312 while (sc->sc_state == EMMC_DMA_STATE_BUSY) {
313 error = cv_timedwait(&sc->sc_cv, plock, hz * 10);
314 if (error == EWOULDBLOCK) {
315 device_printf(sc->sc.sc_dev, "transfer timeout!\n");
316 bcm_dmac_halt(sc->sc_dmac);
317 sc->sc_state = EMMC_DMA_STATE_IDLE;
318 error = ETIMEDOUT;
319 break;
320 }
321 }
322
323 bus_dmamap_sync(sc->sc.sc_dmat, sc->sc_dmamap, 0,
324 sc->sc_dmamap->dm_mapsize, BUS_DMASYNC_POSTWRITE);
325
326 return error;
327 }
328
329 static void
330 bcmemmc_dma_done(uint32_t status, uint32_t error, void *arg)
331 {
332 struct bcmemmc_softc * const sc = arg;
333 kmutex_t *plock = sdhc_host_lock(sc->sc_hosts[0]);
334
335 if (status != (DMAC_CS_INT|DMAC_CS_END))
336 device_printf(sc->sc.sc_dev, "status %#x error %#x\n",
337 status,error);
338
339 mutex_enter(plock);
340 KASSERT(sc->sc_state == EMMC_DMA_STATE_BUSY);
341 if (status & DMAC_CS_END)
342 sc->sc_state = EMMC_DMA_STATE_IDLE;
343 cv_broadcast(&sc->sc_cv);
344 mutex_exit(plock);
345 }
346 #endif
347