/*      $NetBSD: asc.c,v 1.60 2025/04/09 13:09:49 nat Exp $     */

/*
* Copyright (C) 1997 Scott Reynolds
* 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.
*/
/*-
* Copyright (C) 1993   Allen K. Briggs, Chris P. Caputo,
*                      Michael L. Finch, Bradley A. Grantham, and
*                      Lawrence A. Kesteloot
* 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. All advertising materials mentioning features or use of this software
*    must display the following acknowledgement:
*      This product includes software developed by the Alice Group.
* 4. The names of the Alice Group or any of its members may not be used
*    to endorse or promote products derived from this software without
*    specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE ALICE GROUP ``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 ALICE GROUP 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.
*/

/*
* ASC driver code and console bell support
*/

#include <sys/cdefs.h>
__KERNEL_RCSID(0, "$NetBSD: asc.c,v 1.60 2025/04/09 13:09:49 nat Exp $");

#include <sys/types.h>
#include <sys/errno.h>
#include <sys/time.h>
#include <sys/systm.h>
#include <sys/param.h>
#include <sys/device.h>
#include <sys/conf.h>

#include <uvm/uvm_extern.h>

#include <machine/autoconf.h>
#include <machine/cpu.h>
#include <machine/bus.h>
#include <machine/viareg.h>

#include <mac68k/obio/ascreg.h>
#include <mac68k/obio/ascvar.h>
#include <mac68k/obio/obiovar.h>

#define MAC68K_ASC_BASE         0x50f14000
#define MAC68K_IIFX_ASC_BASE    0x50f10000
#define MAC68K_ASC_LEN          0x01000

#ifdef DEBUG
#define ASC_DEBUG
#endif

#ifdef ASC_DEBUG
int     asc_debug = 0;          /* non-zero enables debugging output */
#endif

static u_int8_t         asc_wave_tab[0x800];

static int      asc_ring_bell(void *, int, int, int);
static void     asc_stop_bell(void *);
#if __notyet__
static void     asc_intr_enable(void);
static void     asc_intr(void *);
#endif

static int      ascmatch(device_t, cfdata_t, void *);
static void     ascattach(device_t, device_t, void *);

CFATTACH_DECL_NEW(asc, sizeof(struct asc_softc),
   ascmatch, ascattach, NULL, NULL);

extern struct cfdriver asc_cd;

dev_type_open(ascopen);
dev_type_close(ascclose);
dev_type_read(ascread);
dev_type_write(ascwrite);
dev_type_ioctl(ascioctl);
dev_type_mmap(ascmmap);

const struct cdevsw asc_cdevsw = {
       .d_open = ascopen,
       .d_close = ascclose,
       .d_read = ascread,
       .d_write = ascwrite,
       .d_ioctl = ascioctl,
       .d_stop = nostop,
       .d_tty = notty,
       .d_poll = nopoll,
       .d_mmap = ascmmap,
       .d_kqfilter = nokqfilter,
       .d_discard = nodiscard,
       .d_flag = 0
};

static const uint8_t easc_version_tab[] = { EASC_VER, EASC_VER2 };

static int
ascmatch(device_t parent, cfdata_t cf, void *aux)
{
       struct obio_attach_args *oa = (struct obio_attach_args *)aux;
       bus_addr_t addr;
       bus_space_handle_t bsh;
       int rval = 0;
       uint8_t ver;

       if (oa->oa_addr != (-1))
               addr = (bus_addr_t)oa->oa_addr;
       else if (current_mac_model->machineid == MACH_MACTV)
               return 0;
       else if (current_mac_model->machineid == MACH_MACIIFX)
               addr = (bus_addr_t)MAC68K_IIFX_ASC_BASE;
       else
               addr = (bus_addr_t)MAC68K_ASC_BASE;

       if (bus_space_map(oa->oa_tag, addr, MAC68K_ASC_LEN, 0, &bsh))
               return (0);

       if (mac68k_bus_space_probe(oa->oa_tag, bsh, 0, 1)) {
               rval = 1;

               /*
                * Enhanced Apple Sound Chip (EASC) does not support wavetable
                * mode, exclude it for now.
                */
               ver = bus_space_read_1(oa->oa_tag, bsh, VERLOC);
               for (size_t i = 0; i < __arraycount(easc_version_tab); i++)
                       if (ver == easc_version_tab[i]) {
                               rval = 0;
                               break;
                       }
       } else
               rval = 0;

       bus_space_unmap(oa->oa_tag, bsh, MAC68K_ASC_LEN);

       return rval;
}

static void
ascattach(device_t parent, device_t self, void *aux)
{
       struct asc_softc *sc = device_private(self);
       struct obio_attach_args *oa = (struct obio_attach_args *)aux;
       bus_addr_t addr;
       int i;

       sc->sc_dev = self;
       sc->sc_tag = oa->oa_tag;
       if (oa->oa_addr != (-1))
               addr = (bus_addr_t)oa->oa_addr;
       else if (current_mac_model->machineid == MACH_MACIIFX)
               addr = (bus_addr_t)MAC68K_IIFX_ASC_BASE;
       else
               addr = (bus_addr_t)MAC68K_ASC_BASE;
       if (bus_space_map(sc->sc_tag, addr, MAC68K_ASC_LEN, 0,
           &sc->sc_handle)) {
               printf(": can't map memory space\n");
               return;
       }
       sc->sc_open = 0;
       sc->sc_ringing = 0;
       callout_init(&sc->sc_bell_ch, 0);

       for (i = 0; i < 256; i++) {     /* up part of wave, four voices? */
               asc_wave_tab[i] = i / 4;
               asc_wave_tab[i + 512] = i / 4;
               asc_wave_tab[i + 1024] = i / 4;
               asc_wave_tab[i + 1536] = i / 4;
       }
       for (i = 0; i < 256; i++) {     /* down part of wave, four voices? */
               asc_wave_tab[i + 256] = 0x3f - (i / 4);
               asc_wave_tab[i + 768] = 0x3f - (i / 4);
               asc_wave_tab[i + 1280] = 0x3f - (i / 4);
               asc_wave_tab[i + 1792] = 0x3f - (i / 4);
       }

       printf(": Apple Sound Chip");
       if (oa->oa_addr != (-1))
               printf(" at %x", oa->oa_addr);
       printf("\n");

       mac68k_set_bell_callback(asc_ring_bell, sc);
#if __notyet__
       if (mac68k_machine.aux_interrupts) {
               intr_establish((int (*)(void *))asc_intr, sc, 5);
       } else {
               via2_register_irq(VIA2_ASC, asc_intr, sc);
       }
       asc_intr_enable();
#endif
}

int
ascopen(dev_t dev, int flag, int mode, struct lwp *l)
{
       struct asc_softc *sc;

       sc = device_lookup_private(&asc_cd, ASCUNIT(dev));
       if (sc == NULL)
               return (ENXIO);
       if (sc->sc_open)
               return (EBUSY);
       sc->sc_open = 1;

       return (0);
}

int
ascclose(dev_t dev, int flag, int mode, struct lwp *l)
{
       struct asc_softc *sc;

       sc = device_lookup_private(&asc_cd, ASCUNIT(dev));
       sc->sc_open = 0;

       return (0);
}

int
ascread(dev_t dev, struct uio *uio, int ioflag)
{
       return (ENXIO);
}

int
ascwrite(dev_t dev, struct uio *uio, int ioflag)
{
       return (ENXIO);
}

int
ascioctl(dev_t dev, u_long cmd, void *data, int flag, struct lwp *l)
{
       int error;
#ifdef not_yet
       struct asc_softc *sc;
       int unit = ASCUNIT(dev);

       sc = device_lookup_private(&asc_cd, unit);
#endif
       error = 0;

       switch (cmd) {
       default:
               error = EINVAL;
               break;
       }
       return (error);
}

paddr_t
ascmmap(dev_t dev, off_t off, int prot)
{
       struct asc_softc *sc;
       paddr_t pa;

       sc = device_lookup_private(&asc_cd, ASCUNIT(dev));
       if ((u_int)off < MAC68K_ASC_LEN) {
               (void) pmap_extract(pmap_kernel(), (vaddr_t)sc->sc_handle.base,
                   &pa);
               return m68k_btop(pa + off);
       }

       return (-1);
}

static int
asc_ring_bell(void *arg, int freq, int length, int volume)
{
       struct asc_softc *sc = (struct asc_softc *)arg;
       unsigned long cfreq;
       int i;

       if (!sc)
               return (ENODEV);

       if (sc->sc_ringing == 0) {

               bus_space_write_multi_1(sc->sc_tag, sc->sc_handle,
                   0, 0, 0x800);
               bus_space_write_region_1(sc->sc_tag, sc->sc_handle,
                   0, asc_wave_tab, 0x800);

               /* Fix this.  Need to find exact ASC sampling freq */
               cfreq = 65536 * freq / 466;

               /* printf("beep: from %d, %02x %02x %02x %02x\n",
                * cur_beep.freq, (cfreq >> 24) & 0xff, (cfreq >> 16) & 0xff,
                * (cfreq >> 8) & 0xff, (cfreq) & 0xff); */
               for (i = 0; i < 8; i++) {
                       bus_space_write_1(sc->sc_tag, sc->sc_handle,
                           0x814 + 8 * i, (cfreq >> 24) & 0xff);
                       bus_space_write_1(sc->sc_tag, sc->sc_handle,
                           0x815 + 8 * i, (cfreq >> 16) & 0xff);
                       bus_space_write_1(sc->sc_tag, sc->sc_handle,
                           0x816 + 8 * i, (cfreq >> 8) & 0xff);
                       bus_space_write_1(sc->sc_tag, sc->sc_handle,
                           0x817 + 8 * i, (cfreq) & 0xff);
               }               /* frequency; should put cur_beep.freq in here
                                * somewhere. */

               bus_space_write_1(sc->sc_tag, sc->sc_handle, ASCRATE, F44KHZ);
               bus_space_write_1(sc->sc_tag, sc->sc_handle, INTVOL,
                   255 * volume / 100);
               bus_space_write_1(sc->sc_tag, sc->sc_handle, 0x805, 0);
               bus_space_write_1(sc->sc_tag, sc->sc_handle, ASCTEST, 0);
               bus_space_write_1(sc->sc_tag, sc->sc_handle, ASCTRL, 2);
               /* XXX NS 2 is identified in ascreg.h as STEREO, sampled */
               bus_space_write_1(sc->sc_tag, sc->sc_handle, ASCMODE,
                   MODEWAVE); /* enable sampled */
               sc->sc_ringing = 1;
               callout_reset(&sc->sc_bell_ch, length, asc_stop_bell, sc);
       }

       return (0);
}

static void
asc_stop_bell(void *arg)
{
       struct asc_softc *sc = (struct asc_softc *)arg;

       if (!sc)
               return;

       if (sc->sc_ringing > 1000 || sc->sc_ringing < 0)
               panic("bell got out of sync?");

       if (--sc->sc_ringing == 0) {    /* disable ASC */
               bus_space_write_1(sc->sc_tag, sc->sc_handle, ASCMODE,
                   MODESTOP);
       }
}

#if __notyet__
static void
asc_intr_enable(void)
{
       int s;

       s = splhigh();
       if (VIA2 == VIA2OFF)
               via2_reg(vIER) = 0x80 | V2IF_ASC;
       else
               via2_reg(rIER) = 0x80 | V2IF_ASC;
       splx(s);
}

/*ARGSUSED*/
static void
asc_intr(void *arg)
{
#ifdef ASC_DEBUG
       struct asc_softc *sc = (struct asc_softc *)arg;

       if (asc_debug)
               printf("asc_intr(%p)\n", sc);
#endif
}
#endif