Add bcmdmac, a driver for the DMA controller found on BCM283x SoCs.

Original work by Neil Ashford and dlg@
ok kettenis@

3 files changed, 463 insertions, 1 deletions

diff --git a/sys/dev/fdt/bcm2835_dmac.c b/sys/dev/fdt/bcm2835_dmac.c
new file mode 100644
index 00000000000..95bc611f533
--- /dev/null
+++ b/sys/dev/fdt/bcm2835_dmac.c
@@ -0,0 +1,332 @@
+/*     $OpenBSD: bcm2835_dmac.c,v 1.1 2020/04/21 18:56:54 tobhe Exp $ */
+
+/*
+ * Copyright (c) 2020 Tobias Heider <tobhe@openbsd.org>
+ * Copyright (c) 2019 Neil Ashford <ashfordneil0@gmail.com>
+ *
+ * Permission to use, copy, modify, and distribute this software for any
+ * purpose with or without fee is hereby granted, provided that the above
+ * copyright notice and this permission notice appear in all copies.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+ * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+ * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+ * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+ * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+ */
+
+/*-
+ * Copyright (c) 2014 Jared D. McNeill <jmcneill@invisible.ca>
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ * 1. Redistributions of source code must retain the above copyright
+ *    notice, this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright
+ *    notice, this list of conditions and the following disclaimer in the
+ *    documentation and/or other materials provided with the distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
+ * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
+ * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
+ * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
+ * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
+ * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
+ * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+ * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+ * SUCH DAMAGE.
+ */
+
+#include <sys/types.h>
+#include <sys/atomic.h>
+#include <sys/malloc.h>
+#include <sys/mutex.h>
+#include <sys/systm.h>
+
+#include <machine/bus.h>
+#include <machine/fdt.h>
+#include <machine/intr.h>
+
+#include <dev/ofw/fdt.h>
+#include <dev/ofw/openfirm.h>
+
+#include "dev/ic/bcm2835_dmac.h"
+
+#define BCMDMAC_CHANNELMASK ((1 << 12) - 1)
+#define DEVNAME(sc) ((sc)->sc_dev.dv_xname)
+
+struct bcmdmac_softc {
+	struct device sc_dev;
+	bus_space_tag_t sc_iot;
+	bus_space_handle_t sc_ioh;
+	int sc_fa_node;
+
+	struct mutex sc_lock;
+	struct bcmdmac_channel *sc_channels;
+	int sc_nchannels;
+	uint32_t sc_channelmask;
+};
+
+static struct bcmdmac_softc *bcmdmac_sc = NULL;
+
+struct bcmdmac_channel {
+	struct bcmdmac_softc *ch_sc;
+	void *ch_ih;
+	uint8_t ch_index;
+	void (*ch_callback)(uint32_t, uint32_t, void *);
+	void *ch_callbackarg;
+	uint32_t ch_debug;
+};
+
+int bcmdmac_match(struct device *, void *, void *);
+void bcmdmac_attach(struct device *, struct device *, void *);
+
+struct cfattach bcmdmac_ca = {
+	sizeof(struct bcmdmac_softc),
+	bcmdmac_match,
+	bcmdmac_attach,
+};
+
+struct cfdriver bcmdmac_cd = { NULL, "bcmdmac", DV_DULL };
+
+/* utilities */
+enum bcmdmac_type
+bcmdmac_channel_type(struct bcmdmac_channel ch)
+{
+	if (ISSET(ch.ch_debug, DMAC_DEBUG_LITE))
+		return BCMDMAC_TYPE_LITE;
+	else
+		return BCMDMAC_TYPE_NORMAL;
+}
+
+int
+bcmdmac_channel_used(struct bcmdmac_channel ch)
+{
+	return ch.ch_callback != NULL;
+}
+
+void
+bcmdmac_write(struct bcmdmac_softc *sc, bus_size_t offset, uint32_t value)
+{
+	bus_space_write_4(sc->sc_iot, sc->sc_ioh, offset, value);
+}
+
+uint32_t
+bcmdmac_read(struct bcmdmac_softc *sc, bus_size_t offset)
+{
+	return bus_space_read_4(sc->sc_iot, sc->sc_ioh, offset);
+}
+
+/* driver handles */
+int
+bcmdmac_match(struct device *parent, void *match, void *aux)
+{
+	struct fdt_attach_args *faa = aux;
+
+	return OF_is_compatible(faa->fa_node, "brcm,bcm2835-dma");
+}
+
+void
+bcmdmac_attach(struct device *parent, struct device *self, void *aux)
+{
+	struct bcmdmac_softc *sc = (struct bcmdmac_softc *)self;
+	struct fdt_attach_args *faa = aux;
+	struct bcmdmac_channel *ch;
+	uint32_t val;
+	int index;
+	bus_addr_t addr;
+	bus_size_t size;
+
+	if (bcmdmac_sc) {
+		printf(": already attached\n");
+		return;
+	}
+	bcmdmac_sc = sc;
+
+	sc->sc_iot = faa->fa_iot;
+	sc->sc_fa_node = faa->fa_node;
+
+	if (faa->fa_nreg < 1) {
+		printf(": no registers\n");
+		return;
+	}
+
+	addr = faa->fa_reg[0].addr;
+	size = faa->fa_reg[0].size;
+	if (bus_space_map(sc->sc_iot, addr, size, 0, &sc->sc_ioh)) {
+		printf(": can't map registers\n");
+		return;
+	}
+
+	sc->sc_channelmask =
+	    OF_getpropint(faa->fa_node, "brcm,dma-channel-mask", -1);
+	sc->sc_channelmask &= BCMDMAC_CHANNELMASK;
+
+	mtx_init(&sc->sc_lock, IPL_SCHED);
+
+	sc->sc_nchannels = 31 - __builtin_clz(sc->sc_channelmask);
+	sc->sc_channels = malloc(sizeof(*sc->sc_channels) * sc->sc_nchannels,
+	    M_DEVBUF, M_WAITOK);
+
+	printf(":");
+	for (index = 0; index < sc->sc_nchannels; index++) {
+		ch = &sc->sc_channels[index];
+		ch->ch_sc = sc;
+		ch->ch_index = index;
+		ch->ch_callback = NULL;
+		ch->ch_callbackarg = NULL;
+		ch->ch_ih = NULL;
+		if (!ISSET(sc->sc_channelmask, (1 << index)))
+			continue;
+
+		printf(" DMA%d", index);
+
+		ch->ch_debug = bcmdmac_read(sc, DMAC_DEBUG(index));
+
+		val = bcmdmac_read(sc, DMAC_CS(index));
+		val |= DMAC_CS_RESET;
+		bcmdmac_write(sc, DMAC_CS(index), val);
+	}
+	printf("\n");
+}
+
+int
+bcmdmac_intr(void *arg)
+{
+	struct bcmdmac_channel *ch = arg;
+	struct bcmdmac_softc *sc = ch->ch_sc;
+	uint32_t cs, ce;
+
+	cs = bcmdmac_read(sc, DMAC_CS(ch->ch_index));
+	bcmdmac_write(sc, DMAC_CS(ch->ch_index), cs);
+	cs &= DMAC_CS_INT | DMAC_CS_END | DMAC_CS_ERROR;
+
+	ce = bcmdmac_read(sc, DMAC_DEBUG(ch->ch_index));
+	ce &= DMAC_DEBUG_READ_ERROR | DMAC_DEBUG_FIFO_ERROR
+	    | DMAC_DEBUG_READ_LAST_NOT_SET_ERROR;
+	bcmdmac_write(sc, DMAC_DEBUG(ch->ch_index), ce);
+
+	if (ch->ch_callback)
+		ch->ch_callback(cs, ce, ch->ch_callbackarg);
+
+	return 1;
+}
+
+struct bcmdmac_channel *
+bcmdmac_alloc(enum bcmdmac_type type, int ipl,
+	    void (*cb)(uint32_t, uint32_t, void *), void *cbarg)
+{
+	struct bcmdmac_softc *sc = bcmdmac_sc;
+	struct bcmdmac_channel *ch = NULL;
+	int index;
+
+	if (sc == NULL)
+		return NULL;
+
+	mtx_enter(&sc->sc_lock);
+	for (index = 0; index < sc->sc_nchannels; index++) {
+		if (!ISSET(sc->sc_channelmask, (1 << index)))
+			continue;
+		if (bcmdmac_channel_type(sc->sc_channels[index]) != type)
+			continue;
+		if (bcmdmac_channel_used(sc->sc_channels[index]))
+			continue;
+
+		ch = &sc->sc_channels[index];
+		ch->ch_callback = cb;
+		ch->ch_callbackarg = cbarg;
+		break;
+	}
+	mtx_leave(&sc->sc_lock);
+
+	if (ch == NULL)
+		return NULL;
+
+	KASSERT(ch->ch_ih == NULL);
+
+	ch->ch_ih = fdt_intr_establish_idx(sc->sc_fa_node, ch->ch_index, ipl,
+					   bcmdmac_intr, ch, sc->sc_dev.dv_xname);
+
+	if (ch->ch_ih == NULL) {
+		printf("%s: failed to establish interrupt for DMA%d\n",
+		       DEVNAME(sc), ch->ch_index);
+		ch->ch_callback = NULL;
+		ch->ch_callbackarg = NULL;
+		ch = NULL;
+	}
+
+	return ch;
+}
+
+void
+bcmdmac_free(struct bcmdmac_channel *ch)
+{
+	struct bcmdmac_softc *sc = ch->ch_sc;
+	uint32_t val;
+
+	bcmdmac_halt(ch);
+
+	/* reset chip */
+	val = bcmdmac_read(sc, DMAC_CS(ch->ch_index));
+	val |= DMAC_CS_RESET;
+	val &= ~DMAC_CS_ACTIVE;
+	bcmdmac_write(sc, DMAC_CS(ch->ch_index), val);
+
+	mtx_enter(&sc->sc_lock);
+	fdt_intr_disestablish(ch->ch_ih);
+	ch->ch_ih = NULL;
+	ch->ch_callback = NULL;
+	ch->ch_callbackarg = NULL;
+	mtx_leave(&sc->sc_lock);
+}
+
+void
+bcmdmac_set_conblk_addr(struct bcmdmac_channel *ch, bus_addr_t addr)
+{
+	struct bcmdmac_softc *sc = ch->ch_sc;
+
+	bcmdmac_write(sc, DMAC_CONBLK_AD(ch->ch_index), addr);
+}
+
+int
+bcmdmac_transfer(struct bcmdmac_channel *ch)
+{
+	struct bcmdmac_softc *sc = ch->ch_sc;
+	uint32_t val;
+
+	val = bcmdmac_read(sc, DMAC_CS(ch->ch_index));
+	if (ISSET(val, DMAC_CS_ACTIVE))
+		return EBUSY;
+
+	val |= DMAC_CS_ACTIVE;
+	bcmdmac_write(sc, DMAC_CS(ch->ch_index), val);
+
+	return 0;
+}
+
+void
+bcmdmac_halt(struct bcmdmac_channel *ch)
+{
+	struct bcmdmac_softc *sc = ch->ch_sc;
+	uint32_t val;
+
+	/* pause DMA */
+	val = bcmdmac_read(sc, DMAC_CS(ch->ch_index));
+	val &= ~DMAC_CS_ACTIVE;
+	bcmdmac_write(sc, DMAC_CS(ch->ch_index), val);
+
+	/* XXX wait for paused state */
+
+	/* end descriptor chain */
+	bcmdmac_write(sc, DMAC_NEXTCONBK(ch->ch_index), 0);
+
+	/* resume DMA, which then stops */
+	val |= DMAC_CS_ACTIVE | DMAC_CS_ABORT;
+	bcmdmac_write(sc, DMAC_CS(ch->ch_index), val);
+}
diff --git a/sys/dev/fdt/files.fdt b/sys/dev/fdt/files.fdt
index 44a0cc3cc79..ef3c4106b75 100644
--- a/sys/dev/fdt/files.fdt
+++ b/sys/dev/fdt/files.fdt
@@ -1,4 +1,4 @@
-#	$OpenBSD: files.fdt,v 1.122 2020/04/19 16:00:00 kettenis Exp $
+#	$OpenBSD: files.fdt,v 1.123 2020/04/21 18:56:54 tobhe Exp $
 #
 # Config file and device description for machine-independent FDT code.
 # Included by ports that need it.
@@ -85,6 +85,10 @@ device bcmclock
 attach bcmclock at fdt
 file	dev/fdt/bcm2835_clock.c		bcmclock
 
+device	bcmdmac
+attach	bcmdmac at fdt
+file	dev/fdt/bcm2835_dmac.c		bcmdmac
+
 device	bcmdog
 attach	bcmdog at fdt
 file	dev/fdt/bcm2835_dog.c		bcmdog
diff --git a/sys/dev/ic/bcm2835_dmac.h b/sys/dev/ic/bcm2835_dmac.h
new file mode 100644
index 00000000000..180b3648256
--- /dev/null
+++ b/sys/dev/ic/bcm2835_dmac.h
@@ -0,0 +1,126 @@
+/*     $OpenBSD: bcm2835_dmac.h,v 1.1 2020/04/21 18:56:54 tobhe Exp $ */
+
+/*
+ * Copyright (c) 2020 Tobias Heider <tobhe@openbsd.org>
+ * Copyright (c) 2019 Neil Ashford <ashfordneil0@gmail.com>
+ *
+ * Permission to use, copy, modify, and distribute this software for any
+ * purpose with or without fee is hereby granted, provided that the above
+ * copyright notice and this permission notice appear in all copies.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+ * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+ * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+ * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+ * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+ */
+
+/*-
+ * Copyright (c) 2014 Jared D. McNeill <jmcneill@invisible.ca>
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ * 1. Redistributions of source code must retain the above copyright
+ *    notice, this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright
+ *    notice, this list of conditions and the following disclaimer in the
+ *    documentation and/or other materials provided with the distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
+ * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
+ * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
+ * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
+ * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
+ * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
+ * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+ * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+ * SUCH DAMAGE.
+ */
+
+#ifndef BCM2835_DMAC_H
+#define BCM2835_DMAC_H
+
+#define DMAC_CS(n)		(0x00 + (0x100 * (n)))
+#define  DMAC_CS_RESET		(1<<31)
+#define  DMAC_CS_ABORT		(1<<30)
+#define  DMAC_CS_DISDEBUG	(1<<29)
+#define  DMAC_CS_WAIT_FOR_OUTSTANDING_WRITES (1<<28)
+#define  DMAC_CS_PANIC_PRIORITY	(((1<<24) - 1) ^ (1<<20))
+#define  DMAC_CS_PRIORITY	(((1<<20) - 1) ^ (1<<16))
+#define  DMAC_CS_ERROR		(1<<8)
+#define  DMAC_CS_WAITING_FOR_OUTSTANDING_WRITES (1<<6)
+#define  DMAC_CS_DREQ_STOPS_DMA	(1<<5)
+#define  DMAC_CS_PAUSED		(1<<4)
+#define  DMAC_CS_DREQ		(1<<3)
+#define  DMAC_CS_INT		(1<<2)
+#define  DMAC_CS_END		(1<<1)
+#define  DMAC_CS_ACTIVE		(1<<0)
+#define  DMAC_CS_INTMASK	(DMAC_CS_INT|DMAC_CS_END)
+#define DMAC_CONBLK_AD(n)	(0x04 + (0x100 * (n)))
+#define DMAC_TI(n)		(0x08 + (0x100 * (n)))
+#define DMAC_SOURCE_AD(n)	(0x0c + (0x100 * (n)))
+#define DMAC_DEST_AD(n)		(0x10 + (0x100 * (n)))
+#define DMAC_TXFR_LEN(n)	(0x14 + (0x100 * (n)))
+#define DMAC_STRIDE(n)		(0x18 + (0x100 * (n)))
+#define DMAC_NEXTCONBK(n)	(0x1c + (0x100 * (n)))
+#define DMAC_DEBUG(n)		(0x20 + (0x100 * (n)))
+#define  DMAC_DEBUG_LITE	(1<<28)
+#define  DMAC_DEBUG_VERSION	(((1<<28) - 1) ^ (1<<25))
+#define  DMAC_DEBUG_DMA_STATE	(((1<<25) - 1) ^ (1<<16))
+#define  DMAC_DEBUG_DMA_ID	(((1<<16) - 1) ^ (1<<8))
+#define  DMAC_DEBUG_OUTSTANDING_WRITES (((1<<8) - 1) ^ (1<<4))
+#define  DMAC_DEBUG_READ_ERROR	(1<<2)
+#define  DMAC_DEBUG_FIFO_ERROR	(1<<1)
+#define  DMAC_DEBUG_READ_LAST_NOT_SET_ERROR (1<<0)
+
+struct bcmdmac_conblk {
+	uint32_t cb_ti;
+#define DMAC_TI_NO_WIDE_BURSTS (1 << 26)
+#define DMAC_TI_WAITS (((1 << 26) - 1) ^ (1 << 21))
+#define DMAC_TI_PERMAP (((1 << 21) - 1) ^ (1 << 16))
+#define  DMAC_TI_PERMAP_BASE (1 << 16)
+#define DMAC_TI_BURST_LENGTH (((1 << 16) - 1) ^ (1 << 12))
+#define DMAC_TI_SRC_IGNORE (1 << 11)
+#define DMAC_TI_SRC_DREQ (1 << 10)
+#define DMAC_TI_SRC_WIDTH (1 << 9)
+#define DMAC_TI_SRC_INC (1 << 8)
+#define DMAC_TI_DEST_IGNORE (1 << 7)
+#define DMAC_TI_DEST_DREQ (1 << 6)
+#define DMAC_TI_DEST_WIDTH (1 << 5)
+#define DMAC_TI_DEST_INC (1 << 4)
+#define DMAC_TI_WAIT_RESP (1 << 3)
+#define DMAC_TI_TDMODE (1 << 1)
+#define DMAC_TI_INTEN (1 << 0)
+	uint32_t cb_source_ad;
+	uint32_t cb_dest_ad;
+	uint32_t cb_txfr_len;
+#define DMAC_TXFR_LEN_YLENGTH (((1 << 30) - 1) ^ (1 << 16))
+#define DMAC_TXFR_LEN_XLENGTH (((1 << 16) - 1) ^ (1 << 0))
+	uint32_t cb_stride;
+#define DMAC_STRIDE_D_STRIDE (((1 << 32) - 1) ^ (1 << 16))
+#define DMAC_STRIDE_S_STRIDE (((1 << 16) - 1) ^ (1 << 0))
+	uint32_t cb_nextconbk;
+	uint32_t cb_padding[2];
+} __packed;
+
+#define DMAC_INT_STATUS 0xfe0
+#define DMAC_ENABLE 0xff0
+
+enum bcmdmac_type { BCMDMAC_TYPE_NORMAL, BCMDMAC_TYPE_LITE };
+
+struct bcmdmac_channel;
+
+struct bcmdmac_channel *bcmdmac_alloc(enum bcmdmac_type, int,
+				  void (*)(uint32_t, uint32_t, void *), void *);
+void bcmdmac_free(struct bcmdmac_channel *);
+void bcmdmac_set_conblk_addr(struct bcmdmac_channel *, bus_addr_t);
+int bcmdmac_transfer(struct bcmdmac_channel *);
+void bcmdmac_halt(struct bcmdmac_channel *);
+
+#endif /* BCM2835_DMAC_H */