Add tascodec(4), a driver for the TI TAS2770/TAS5770 digital audio

amplifier codec found on Apple M1 Macs.

ok patrick@, ratchov@

2 files changed, 340 insertions, 1 deletions

diff --git a/sys/dev/fdt/files.fdt b/sys/dev/fdt/files.fdt
index 569db67c783..13c5932f9a1 100644
--- a/sys/dev/fdt/files.fdt
+++ b/sys/dev/fdt/files.fdt
@@ -1,4 +1,4 @@
-#	$OpenBSD: files.fdt,v 1.161 2022/01/18 07:53:39 visa Exp $
+#	$OpenBSD: files.fdt,v 1.162 2022/01/30 21:40:50 kettenis Exp $
 #
 # Config file and device description for machine-independent FDT code.
 # Included by ports that need it.
@@ -608,3 +608,7 @@ file	dev/fdt/gpioleds.c		gpioleds
 device	gpiokeys
 attach	gpiokeys at fdt
 file	dev/fdt/gpiokeys.c		gpiokeys
+
+device	tascodec
+attach	tascodec at i2c
+file	dev/fdt/tascodec.c		tascodec
diff --git a/sys/dev/fdt/tascodec.c b/sys/dev/fdt/tascodec.c
new file mode 100644
index 00000000000..481e763f233
--- /dev/null
+++ b/sys/dev/fdt/tascodec.c
@@ -0,0 +1,335 @@
+/*	$OpenBSD: tascodec.c,v 1.1 2022/01/30 21:40:50 kettenis Exp $	*/
+/*
+ * Copyright (c) 2022 Mark Kettenis <kettenis@openbsd.org>
+ *
+ * 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.
+ */
+
+#include <sys/param.h>
+#include <sys/systm.h>
+#include <sys/audioio.h>
+#include <sys/device.h>
+#include <sys/malloc.h>
+
+#include <machine/bus.h>
+
+#include <dev/ofw/openfirm.h>
+#include <dev/ofw/ofw_gpio.h>
+#include <dev/ofw/ofw_misc.h>
+#include <dev/ofw/fdt.h>
+
+#include <dev/i2c/i2cvar.h>
+
+#include <dev/audio_if.h>
+
+#define PWR_CTL				0x02
+#define  PWR_CTL_ISNS_PD		(1 << 3)
+#define  PWR_CTL_VSNS_PD		(1 << 2)
+#define  PWR_CTL_MODE_ACTIVE		(0 << 0)
+#define  PWR_CTL_MODE_MUTE		(1 << 0)
+#define  PWR_CTL_MODE_SHUTDOWN		(2 << 0)
+#define PB_CFG2				0x05
+#define  PB_CFG2_DVC_PCM_MIN		0xc9
+#define TDM_CFG0			0x0a
+#define  TDM_CFG0_FRAME_START		(1 << 0)
+#define TDM_CFG1			0x0b
+#define  TDM_CFG1_RX_JUSTIFY		(1 << 6)
+#define  TDM_CFG1_RX_OFFSET_MASK	(0x1f << 1)
+#define  TDM_CFG1_RX_OFFSET_SHIFT	1
+#define  TDM_CFG1_RX_EDGE		(1 << 0)
+#define TDM_CFG2			0x0c
+#define  TDM_CFG2_SCFG_MASK		(3 << 4)
+#define  TDM_CFG2_SCFG_STEREO_DOWNMIX	(3 << 4)
+
+struct tascodec_softc {
+	struct device		sc_dev;
+	i2c_tag_t		sc_tag;
+	i2c_addr_t		sc_addr;
+
+	struct dai_device	sc_dai;
+	uint8_t			sc_dvc;
+};
+
+int	tascodec_match(struct device *, void *, void *);
+void	tascodec_attach(struct device *, struct device *, void *);
+int	tascodec_activate(struct device *, int);
+
+const struct cfattach tascodec_ca = {
+	sizeof(struct tascodec_softc), tascodec_match, tascodec_attach,
+	NULL, tascodec_activate
+};
+
+struct cfdriver tascodec_cd = {
+	NULL, "tascodec", DV_DULL
+};
+
+int	tascodec_set_format(void *, uint32_t, uint32_t, uint32_t);
+
+int	tascodec_set_port(void *, mixer_ctrl_t *);
+int	tascodec_get_port(void *, mixer_ctrl_t *);
+int	tascodec_query_devinfo(void *, mixer_devinfo_t *);
+int	tascodec_trigger_output(void *, void *, void *, int,
+	    void (*)(void *), void *, struct audio_params *);
+int	tascodec_halt_output(void *);
+
+struct audio_hw_if tascodec_hw_if = {
+	.set_port = tascodec_set_port,
+	.get_port = tascodec_get_port,
+	.query_devinfo = tascodec_query_devinfo,
+	.trigger_output = tascodec_trigger_output,
+	.halt_output = tascodec_halt_output,
+};
+
+uint8_t	tascodec_read(struct tascodec_softc *, int);
+void	tascodec_write(struct tascodec_softc *, int, uint8_t);
+
+int
+tascodec_match(struct device *parent, void *match, void *aux)
+{
+	struct i2c_attach_args *ia = aux;
+
+	return (strcmp(ia->ia_name, "ti,tas5770l") == 0);
+}
+
+void
+tascodec_attach(struct device *parent, struct device *self, void *aux)
+{
+	struct tascodec_softc *sc = (struct tascodec_softc *)self;
+	struct i2c_attach_args *ia = aux;
+	int node = *(int *)ia->ia_cookie;
+	uint32_t *reset_gpio;
+	int reset_gpiolen;
+	uint8_t cfg2;
+
+	sc->sc_tag = ia->ia_tag;
+	sc->sc_addr = ia->ia_addr;
+
+	printf("\n");
+
+	reset_gpiolen = OF_getproplen(node, "reset-gpios");
+	if (reset_gpiolen > 0) {
+		reset_gpio = malloc(reset_gpiolen, M_TEMP, M_WAITOK);
+		OF_getpropintarray(node, "reset-gpios",
+		    reset_gpio, reset_gpiolen);
+		gpio_controller_config_pin(reset_gpio, GPIO_CONFIG_OUTPUT);
+		gpio_controller_set_pin(reset_gpio, 1);
+		free(reset_gpio, M_TEMP, reset_gpiolen);
+		delay(1000);
+	}
+
+	sc->sc_dvc = tascodec_read(sc, PB_CFG2);
+	if (sc->sc_dvc > PB_CFG2_DVC_PCM_MIN)
+		sc->sc_dvc = PB_CFG2_DVC_PCM_MIN;
+
+	/* Default to stereo downmix mode for now. */
+	cfg2 = tascodec_read(sc, TDM_CFG2);
+	cfg2 &= ~TDM_CFG2_SCFG_MASK;
+	cfg2 |= TDM_CFG2_SCFG_STEREO_DOWNMIX;
+	tascodec_write(sc, TDM_CFG2, cfg2);
+
+	sc->sc_dai.dd_node = node;
+	sc->sc_dai.dd_cookie = sc;
+	sc->sc_dai.dd_hw_if = &tascodec_hw_if;
+	sc->sc_dai.dd_set_format = tascodec_set_format;
+	dai_register(&sc->sc_dai);
+}
+
+int
+tascodec_activate(struct device *self, int act)
+{
+	struct tascodec_softc *sc = (struct tascodec_softc *)self;
+
+	switch (act) {
+	case DVACT_POWERDOWN:
+		tascodec_write(sc, PWR_CTL,
+		    PWR_CTL_ISNS_PD | PWR_CTL_VSNS_PD | PWR_CTL_MODE_SHUTDOWN);
+		break;
+	}
+
+	return 0;
+}
+
+int
+tascodec_set_format(void *cookie, uint32_t fmt, uint32_t pol,
+    uint32_t clk)
+{
+	struct tascodec_softc *sc = cookie;
+	uint8_t cfg0, cfg1;
+
+	cfg0 = tascodec_read(sc, TDM_CFG0);
+	cfg1 = tascodec_read(sc, TDM_CFG1);
+	cfg1 &= ~TDM_CFG1_RX_OFFSET_MASK;
+
+	switch (fmt) {
+	case DAI_FORMAT_I2S:
+		cfg0 |= TDM_CFG0_FRAME_START;
+		cfg1 &= ~TDM_CFG1_RX_JUSTIFY;
+		cfg1 |= (1 << TDM_CFG1_RX_OFFSET_SHIFT);
+		cfg1 &= ~TDM_CFG1_RX_EDGE;
+		break;
+	case DAI_FORMAT_RJ:
+		cfg0 &= ~TDM_CFG0_FRAME_START;
+		cfg1 |= TDM_CFG1_RX_JUSTIFY;
+		cfg1 &= ~TDM_CFG1_RX_EDGE;
+		break;
+	case DAI_FORMAT_LJ:
+		cfg0 &= ~TDM_CFG0_FRAME_START;
+		cfg1 &= ~TDM_CFG1_RX_JUSTIFY;
+		cfg1 &= ~TDM_CFG1_RX_EDGE;
+		break;
+	default:
+		return EINVAL;
+	}
+
+	if (pol & DAI_POLARITY_IB)
+		cfg1 ^= TDM_CFG1_RX_EDGE;
+	if (pol & DAI_POLARITY_IF)
+		cfg0 ^= TDM_CFG0_FRAME_START;
+
+	if (!(clk & DAI_CLOCK_CBM) || !(clk & DAI_CLOCK_CFM))
+		return EINVAL;
+
+	tascodec_write(sc, TDM_CFG0, cfg0);
+	tascodec_write(sc, TDM_CFG1, cfg1);
+
+	return 0;
+}
+
+/*
+ * Mixer controls; the gain of the TAS2770 is determined by the
+ * amplifier gain and digital volume control setting, but we only
+ * expose the digital volume control setting through the mixer
+ * interface.
+ */
+enum {
+	TASCODEC_MASTER_VOL,
+	TASCODEC_OUTPUT_CLASS
+};
+
+int
+tascodec_set_port(void *priv, mixer_ctrl_t *mc)
+{
+	struct tascodec_softc *sc = priv;
+	u_char level;
+
+	switch (mc->dev) {
+	case TASCODEC_MASTER_VOL:
+		level = mc->un.value.level[AUDIO_MIXER_LEVEL_MONO];
+		sc->sc_dvc = (PB_CFG2_DVC_PCM_MIN * (255 - level)) / 255;
+		tascodec_write(sc, PB_CFG2, sc->sc_dvc);
+		return 0;
+	}
+
+	return EINVAL;
+}
+
+int
+tascodec_get_port(void *priv, mixer_ctrl_t *mc)
+{
+	struct tascodec_softc *sc = priv;
+	u_char level;
+
+	switch (mc->dev) {
+	case TASCODEC_MASTER_VOL:
+		mc->un.value.num_channels = 1;
+		level = 255 - ((255 * sc->sc_dvc) / PB_CFG2_DVC_PCM_MIN);
+		mc->un.value.level[AUDIO_MIXER_LEVEL_MONO] = level;
+		return 0;
+	}
+
+	return EINVAL;
+}
+
+int
+tascodec_query_devinfo(void *priv, mixer_devinfo_t *di)
+{
+	switch (di->index) {
+	case TASCODEC_MASTER_VOL:
+		di->mixer_class = TASCODEC_OUTPUT_CLASS;
+		di->next = di->prev = AUDIO_MIXER_LAST;
+		strlcpy(di->label.name, AudioNmaster, sizeof(di->label.name));
+		di->type = AUDIO_MIXER_VALUE;
+		di->un.v.num_channels = 1;
+		strlcpy(di->un.v.units.name, AudioNvolume,
+		    sizeof(di->un.v.units.name));
+		return 0;
+
+	case TASCODEC_OUTPUT_CLASS:
+		di->mixer_class = TASCODEC_OUTPUT_CLASS;
+		di->next = di->prev = AUDIO_MIXER_LAST;
+		strlcpy(di->label.name, AudioCoutputs, sizeof(di->label.name));
+		di->type = AUDIO_MIXER_CLASS;
+		return 0;
+	}
+
+	return ENXIO;
+}
+
+int
+tascodec_trigger_output(void *cookie, void *start, void *end, int blksize,
+    void (*intr)(void *), void *intrarg, struct audio_params *params)
+{
+	struct tascodec_softc *sc = cookie;
+
+	tascodec_write(sc, PWR_CTL,
+	    PWR_CTL_ISNS_PD | PWR_CTL_VSNS_PD | PWR_CTL_MODE_ACTIVE);
+	return 0;
+}
+
+int
+tascodec_halt_output(void *cookie)
+{
+	struct tascodec_softc *sc = cookie;
+
+	tascodec_write(sc, PWR_CTL,
+	    PWR_CTL_ISNS_PD | PWR_CTL_VSNS_PD | PWR_CTL_MODE_SHUTDOWN);
+	return 0;
+}
+
+uint8_t
+tascodec_read(struct tascodec_softc *sc, int reg)
+{
+	uint8_t cmd = reg;
+	uint8_t val;
+	int error;
+
+	iic_acquire_bus(sc->sc_tag, I2C_F_POLL);
+	error = iic_exec(sc->sc_tag, I2C_OP_READ_WITH_STOP, sc->sc_addr,
+	    &cmd, sizeof cmd, &val, sizeof val, I2C_F_POLL);
+	iic_release_bus(sc->sc_tag, I2C_F_POLL);
+
+	if (error) {
+		printf("%s: can't read register 0x%02x\n",
+		    sc->sc_dev.dv_xname, reg);
+		val = 0xff;
+	}
+
+	return val;
+}
+
+void
+tascodec_write(struct tascodec_softc *sc, int reg, uint8_t val)
+{
+	uint8_t cmd = reg;
+	int error;
+
+	iic_acquire_bus(sc->sc_tag, I2C_F_POLL);
+	error = iic_exec(sc->sc_tag, I2C_OP_WRITE_WITH_STOP, sc->sc_addr,
+	    &cmd, sizeof cmd, &val, sizeof val, I2C_F_POLL);
+	iic_release_bus(sc->sc_tag, I2C_F_POLL);
+
+	if (error) {
+		printf("%s: can't write register 0x%02x\n",
+		    sc->sc_dev.dv_xname, reg);
+	}
+}