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