/*      $NetBSD: vidcaudio.c,v 1.62 2022/09/27 06:14:41 skrll Exp $     */

/*
 * Copyright (c) 1995 Melvin Tang-Richardson
 *
 * 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.
 * 3. All advertising materials mentioning features or use of this software
 *    must display the following acknowledgement:
 *      This product includes software developed by the RiscBSD team.
 * 4. The name of the author may not be used to endorse or promote products
 *    derived from this software without specific prior written permission.
 *
 * 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.
 */

/*-
 * Copyright (c) 2003 Ben Harris
 * 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.
 * 3. The name of the author may not be used to endorse or promote products
 *    derived from this software without specific prior written permission.
 * 
 * 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.
 */

/*
 * audio driver for the RiscPC 8/16 bit sound
 *
 * Interfaces with the NetBSD generic audio driver to provide SUN
 * /dev/audio (partial) compatibility.
 */

#include <sys/param.h>  /* proc.h */

__KERNEL_RCSID(0, "$NetBSD: vidcaudio.c,v 1.62 2022/09/27 06:14:41 skrll Exp $");

#include <sys/audioio.h>
#include <sys/conf.h>   /* autoconfig functions */
#include <sys/device.h> /* device calls */
#include <sys/errno.h>
#include <sys/kmem.h>
#include <sys/proc.h>   /* device calls */
#include <sys/systm.h>

#include <uvm/uvm_extern.h>

#include <dev/audio/audio_if.h>
#include <dev/audio/audiobellvar.h>
#include <dev/audio/mulaw.h>

#include <machine/intr.h>
#include <machine/machdep.h>

#include <arm/iomd/vidcaudiovar.h>
#include <arm/iomd/iomdreg.h>
#include <arm/iomd/iomdvar.h>
#include <arm/iomd/vidc.h>
#include <arm/mainbus/mainbus.h>

#include "pckbd.h"
#if NPCKBD > 0
#include <dev/pckbport/pckbdvar.h>
#endif

extern int *vidc_base;

#ifdef VIDCAUDIO_DEBUG
#define DPRINTF(x)      printf x
#else
#define DPRINTF(x)
#endif

#define WriteWord(a, b) \
*((volatile unsigned int *)(a)) = (b)

#define ReadWord(a) \
(*((volatile unsigned int *)(a)))

struct vidcaudio_softc {
        device_t        sc_dev;

        irqhandler_t    sc_ih;
        int     sc_dma_intr;

        int     sc_is16bit;

        size_t  sc_pblksize;
        vaddr_t sc_poffset;
        vaddr_t sc_pbufsize;
        paddr_t *sc_ppages;
        size_t  sc_szppages;
        void    (*sc_pintr)(void *);
        void    *sc_parg;
        int     sc_pcountdown;

        kmutex_t        sc_lock;
        kmutex_t        sc_intr_lock;
};

static int  vidcaudio_probe(device_t , cfdata_t , void *);
static void vidcaudio_attach(device_t , device_t , void *);
static void vidcaudio_close(void *);

static int vidcaudio_intr(void *);
static void vidcaudio_rate(int);
static void vidcaudio_ctrl(int);
static void vidcaudio_stereo(int, int);

CFATTACH_DECL_NEW(vidcaudio, sizeof(struct vidcaudio_softc),
    vidcaudio_probe, vidcaudio_attach, NULL, NULL);

static int    vidcaudio_query_format(void *, audio_format_query_t *);
static int    vidcaudio_set_format(void *, int,
    const audio_params_t *, const audio_params_t *,
    audio_filter_reg_t *, audio_filter_reg_t *);
static int    vidcaudio_round_blocksize(void *, int, int, const audio_params_t *);
static int    vidcaudio_trigger_output(void *, void *, void *, int,
    void (*)(void *), void *, const audio_params_t *);
static int    vidcaudio_halt_output(void *);
static int    vidcaudio_getdev(void *, struct audio_device *);
static int    vidcaudio_set_port(void *, mixer_ctrl_t *);
static int    vidcaudio_get_port(void *, mixer_ctrl_t *);
static int    vidcaudio_query_devinfo(void *, mixer_devinfo_t *);
static int    vidcaudio_get_props(void *);
static void   vidcaudio_get_locks(void *, kmutex_t **, kmutex_t **);

static struct audio_device vidcaudio_device = {
        "ARM VIDC",
        "",
        "vidcaudio"
};

static const struct audio_hw_if vidcaudio_hw_if = {
        .close                  = vidcaudio_close,
        .query_format           = vidcaudio_query_format,
        .set_format             = vidcaudio_set_format,
        .round_blocksize        = vidcaudio_round_blocksize,
        .halt_output            = vidcaudio_halt_output,
        .getdev                 = vidcaudio_getdev,
        .set_port               = vidcaudio_set_port,
        .get_port               = vidcaudio_get_port,
        .query_devinfo          = vidcaudio_query_devinfo,
        .get_props              = vidcaudio_get_props,
        .trigger_output         = vidcaudio_trigger_output,
        .get_locks              = vidcaudio_get_locks,
};

static const struct audio_format vidcaudio_formats_16bit = {
        .mode           = AUMODE_PLAY,
        .encoding       = AUDIO_ENCODING_SLINEAR_LE,
        .validbits      = 16,
        .precision      = 16,
        .channels       = 2,
        .channel_mask   = AUFMT_STEREO,
        /* There are more selectable frequencies but these should be enough. */
        .frequency_type = 6,
        .frequency      = {
                19600,  /* /9 */
                22050,  /* /8 */
                25200,  /* /7 */
                29400,  /* /6 */
                35280,  /* /5 */
                44100,  /* /4 */
        },
};
static const struct audio_format vidcaudio_formats_8bit = {
        .mode           = AUMODE_PLAY,
        .encoding       = AUDIO_ENCODING_ULAW,
        .validbits      = 8,
        .precision      = 8,
        .channels       = 2,    /* we use stereo always */
        .channel_mask   = AUFMT_STEREO,
        /* frequency is preferably an integer. */
        .frequency_type = 6,
        .frequency      = {
                10000,  /* 50us */
                12500,  /* 40us */
                20000,  /* 25us */
                25000,  /* 20us */
                31250,  /* 16us */
                50000,  /* 10us */
        },
};

static int
vidcaudio_probe(device_t parent, cfdata_t cf, void *aux)
{
        int id;

        id = IOMD_ID;

        /* So far I only know about this IOMD */
        switch (id) {
        case RPC600_IOMD_ID:
        case ARM7500_IOC_ID:
        case ARM7500FE_IOC_ID:
                return 1;
        default:
                aprint_error("vidcaudio: Unknown IOMD id=%04x", id);
                return 0;
        }
}


static void
vidcaudio_attach(device_t parent, device_t self, void *aux)
{
        struct vidcaudio_softc *sc = device_private(self);
        device_t beepdev;

        sc->sc_dev = self;
        switch (IOMD_ID) {
#ifndef EB7500ATX
        case RPC600_IOMD_ID:
                sc->sc_is16bit = (cmos_read(0xc4) >> 5) & 1;
                sc->sc_dma_intr = IRQ_DMASCH0;
                break;
#endif
        case ARM7500_IOC_ID:
        case ARM7500FE_IOC_ID:
                sc->sc_is16bit = true;
                sc->sc_dma_intr = IRQ_SDMA;
                break;
        default:
                aprint_error(": strange IOMD\n");
                return;
        }

        if (sc->sc_is16bit)
                aprint_normal(": 16-bit external DAC\n");
        else
                aprint_normal(": 8-bit internal DAC\n");

        mutex_init(&sc->sc_lock, MUTEX_DEFAULT, IPL_NONE);
        mutex_init(&sc->sc_intr_lock, MUTEX_DEFAULT, IPL_AUDIO);

        /* Install the irq handler for the DMA interrupt */
        sc->sc_ih.ih_func = vidcaudio_intr;
        sc->sc_ih.ih_arg = sc;
        sc->sc_ih.ih_level = IPL_AUDIO;
        sc->sc_ih.ih_name = device_xname(self);

        if (irq_claim(sc->sc_dma_intr, &sc->sc_ih) != 0) {
                aprint_error("%s: couldn't claim IRQ %d\n",
                    device_xname(self), sc->sc_dma_intr);
                return;
        }

        disable_irq(sc->sc_dma_intr);

        beepdev = audio_attach_mi(&vidcaudio_hw_if, sc, self);
#if NPCKBD > 0
        pckbd_hookup_bell(audiobell, beepdev);
#endif
}

static void
vidcaudio_close(void *addr)
{
        struct vidcaudio_softc *sc;

        DPRINTF(("DEBUG: vidcaudio_close called\n"));
        sc = addr;
        if (sc->sc_ppages != NULL) {
                kmem_free(sc->sc_ppages, sc->sc_szppages * sizeof(paddr_t));
                sc->sc_ppages = NULL;
                sc->sc_szppages = 0;
        }
}

/*
 * Interface to the generic audio driver
 */

static int
vidcaudio_query_format(void *addr, audio_format_query_t *afp)
{
        struct vidcaudio_softc *sc;

        sc = addr;
        if (sc->sc_is16bit)
                return audio_query_format(&vidcaudio_formats_16bit, 1, afp);
        else
                return audio_query_format(&vidcaudio_formats_8bit, 1, afp);
}

static int
vidcaudio_set_format(void *addr, int setmode,
    const audio_params_t *play, const audio_params_t *rec,
    audio_filter_reg_t *pfil, audio_filter_reg_t *rfil)
{
        struct vidcaudio_softc *sc;
        int sample_period, ch;

        sc = addr;
        if (sc->sc_is16bit) {
                /* ARM7500ish, 16-bit, two-channel */
                sample_period = 705600 / 4 / play->sample_rate;
                if (sample_period < 3)
                        sample_period = 3;
                vidcaudio_rate(sample_period - 2);
                vidcaudio_ctrl(SCR_SERIAL);
        } else {
                /* VIDC20ish, u-law, 8-channel */
                /*
                 * We always use two hardware channels, because using
                 * one at 8kHz gives a nasty whining sound from the
                 * speaker.
                 */
                sample_period = 1000000 / 2 / play->sample_rate;
                if (sample_period < 3)
                        sample_period = 3;
                vidcaudio_rate(sample_period - 2);
                vidcaudio_ctrl(SCR_SDAC | SCR_CLKSEL);
                for (ch = 0; ch < 8; ch += 2)
                        vidcaudio_stereo(ch, SIR_LEFT_100);
                for (ch = 1; ch < 8; ch += 2)
                        vidcaudio_stereo(ch, SIR_RIGHT_100);

                pfil->codec = audio_internal_to_mulaw;
        }
        return 0;
}

static int
vidcaudio_round_blocksize(void *addr, int wantblk,
                          int mode, const audio_params_t *param)
{
        int blk;

        /*
         * Find the smallest power of two that's larger than the
         * requested block size, but don't allow < 32 (DMA burst is 16
         * bytes, and single bursts are tricky) or > PAGE_SIZE (DMA is
         * confined to a page).
         */

        for (blk = 32; blk < PAGE_SIZE; blk <<= 1)
                if (blk >= wantblk)
                        return blk;
        return blk;
}

static int
vidcaudio_trigger_output(void *addr, void *start, void *end, int blksize,
    void (*intr)(void *), void *arg, const audio_params_t *params)
{
        struct vidcaudio_softc *sc;
        size_t npages, i;

        DPRINTF(("vidcaudio_trigger_output %p-%p/0x%x\n",
            start, end, blksize));

        sc = addr;
        KASSERT(blksize == vidcaudio_round_blocksize(addr, blksize, 0, NULL));
        KASSERT((vaddr_t)start % blksize == 0);

        sc->sc_pblksize = blksize;
        sc->sc_pbufsize = (char *)end - (char *)start;
        npages = sc->sc_pbufsize >> PGSHIFT;
        if (sc->sc_ppages != NULL)
                kmem_free(sc->sc_ppages, sc->sc_szppages);
        sc->sc_szppages = npages * sizeof(paddr_t);
        sc->sc_ppages = kmem_alloc(sc->sc_szppages, KM_SLEEP);
        if (sc->sc_ppages == NULL)
                return ENOMEM;
        for (i = 0; i < npages; i++)
                if (!pmap_extract(pmap_kernel(),
                    (vaddr_t)start + i * PAGE_SIZE, &sc->sc_ppages[i]))
                        return EIO;
        sc->sc_poffset = 0;
        sc->sc_pintr = intr;
        sc->sc_parg = arg;

        IOMD_WRITE_WORD(IOMD_SD0CR, IOMD_DMACR_CLEAR | IOMD_DMACR_QUADWORD);
        IOMD_WRITE_WORD(IOMD_SD0CR, IOMD_DMACR_ENABLE | IOMD_DMACR_QUADWORD);

        /*
         * Queue up the first two blocks, but don't tell audio code
         * we're finished with them yet.
         */
        sc->sc_pcountdown = 2;

        enable_irq(sc->sc_dma_intr);

        return 0;
}

static int
vidcaudio_halt_output(void *addr)
{
        struct vidcaudio_softc *sc;

        DPRINTF(("vidcaudio_halt_output\n"));
        sc = addr;
        disable_irq(sc->sc_dma_intr);
        IOMD_WRITE_WORD(IOMD_SD0CR, IOMD_DMACR_CLEAR | IOMD_DMACR_QUADWORD);
        return 0;
}

static int
vidcaudio_getdev(void *addr, struct audio_device *retp)
{

        *retp = vidcaudio_device;
        return 0;
}


static int
vidcaudio_set_port(void *addr, mixer_ctrl_t *cp)
{

        return EINVAL;
}

static int
vidcaudio_get_port(void *addr, mixer_ctrl_t *cp)
{

        return EINVAL;
}

static int
vidcaudio_query_devinfo(void *addr, mixer_devinfo_t *dip)
{

        return ENXIO;
}

static int
vidcaudio_get_props(void *addr)
{

        return AUDIO_PROP_PLAYBACK | AUDIO_PROP_CAPTURE;
}

static void
vidcaudio_get_locks(void *opaque, kmutex_t **intr, kmutex_t **thread)
{
        struct vidcaudio_softc *sc = opaque;

        *intr = &sc->sc_intr_lock;
        *thread = &sc->sc_lock;
}

static void
vidcaudio_rate(int rate)
{

        WriteWord(vidc_base, VIDC_SFR | rate);
}

static void
vidcaudio_ctrl(int ctrl)
{

        WriteWord(vidc_base, VIDC_SCR | ctrl);
}

static void
vidcaudio_stereo(int channel, int position)
{

        channel = channel << 24 | VIDC_SIR0;
        WriteWord(vidc_base, channel | position);
}

static int
vidcaudio_intr(void *arg)
{
        struct vidcaudio_softc *sc;
        int status;
        paddr_t pnext, pend;

        sc = arg;
        mutex_spin_enter(&sc->sc_intr_lock);

        status = IOMD_READ_BYTE(IOMD_SD0ST);
        DPRINTF(("I[%x]", status));
        if ((status & IOMD_DMAST_INT) == 0) {
                mutex_spin_exit(&sc->sc_intr_lock);
                return 0;
        }

        pnext = sc->sc_ppages[sc->sc_poffset >> PGSHIFT] |
            (sc->sc_poffset & PGOFSET);
        pend = (pnext + sc->sc_pblksize - 16) & IOMD_DMAEND_OFFSET;

        switch (status &
            (IOMD_DMAST_OVERRUN | IOMD_DMAST_INT | IOMD_DMAST_BANKB)) {

        case (IOMD_DMAST_INT | IOMD_DMAST_BANKA):
        case (IOMD_DMAST_OVERRUN | IOMD_DMAST_INT | IOMD_DMAST_BANKB):
                DPRINTF(("B<0x%08lx,0x%03lx>", pnext, pend));
                IOMD_WRITE_WORD(IOMD_SD0CURB, pnext);
                IOMD_WRITE_WORD(IOMD_SD0ENDB, pend);
                break;

        case (IOMD_DMAST_INT | IOMD_DMAST_BANKB):
        case (IOMD_DMAST_OVERRUN | IOMD_DMAST_INT | IOMD_DMAST_BANKA):
                DPRINTF(("A<0x%08lx,0x%03lx>", pnext, pend));
                IOMD_WRITE_WORD(IOMD_SD0CURA, pnext);
                IOMD_WRITE_WORD(IOMD_SD0ENDA, pend);
                break;
        }

        sc->sc_poffset += sc->sc_pblksize;
        if (sc->sc_poffset >= sc->sc_pbufsize)
                sc->sc_poffset = 0;

        if (sc->sc_pcountdown > 0)
                sc->sc_pcountdown--;
        else
                (*sc->sc_pintr)(sc->sc_parg);

        mutex_spin_exit(&sc->sc_intr_lock);
        return 1;
}