/*      $NetBSD: tx39sib.c,v 1.24 2023/09/10 20:55:30 andvar Exp $ */

/*-
 * Copyright (c) 2000 The NetBSD Foundation, Inc.
 * All rights reserved.
 *
 * This code is derived from software contributed to The NetBSD Foundation
 * by UCHIYAMA Yasushi.
 *
 * 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 NETBSD FOUNDATION, INC. AND CONTRIBUTORS
 * ``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 FOUNDATION OR CONTRIBUTORS
 * 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.
 */

/*
 * TX39 SIB (Serial Interface Bus) module.
 */

#include <sys/cdefs.h>
__KERNEL_RCSID(0, "$NetBSD: tx39sib.c,v 1.24 2023/09/10 20:55:30 andvar Exp $");

#include <sys/param.h>
#include <sys/systm.h>
#include <sys/device.h>

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

#include <hpcmips/tx/tx39var.h>
#include <hpcmips/tx/tx39icureg.h>
#include <hpcmips/tx/tx39sibvar.h>
#include <hpcmips/tx/tx39sibreg.h>

#include "locators.h"

#ifdef TX39SIBDEBUG
#define DPRINTF_ENABLE
#define DPRINTF_DEBUG   tx39sibdebug
#endif
#include <machine/debug.h>

int     tx39sib_match(device_t, cfdata_t, void *);
void    tx39sib_attach(device_t, device_t, void *);
int     tx39sib_print(void *, const char *);
int     tx39sib_search(device_t, cfdata_t, const int *, void *);

#define TX39_CLK2X      18432000
const int sibsclk_divide_table[8] = {
        2, 3, 4, 5, 6, 8, 10, 12
};

struct tx39sib_param {
        /* SIB clock rate */
        int sp_clock;
/*
 *      SIBMCLK = 18.432MHz = (CLK2X /4)
 *      SIBSCLK = SIBMCLK / sp_clock
 *      sp_clock        start   end     divide module
 *      0               7       8       2
 *      1               6       8       3
 *      2               6       9       4
 *      3               5       9       5
 *      4               5       10      6
 *      5               4       11      8
 *      6               3       12      10
 *      7               2       13      12
 */
        /* sampling rate */
        int sp_snd_rate; /* SNDFSDIV + 1 */
        int sp_tel_rate; /* TELFSDIV + 1 */
/*
 *      Fs = (SIBSCLK * 2) / ((FSDIV + 1) * 64)
 *      FSDIV + 1       sampling rate
 *      15              19.2k           (1.6% error vs. CD-XA)
 *      13              22.154k         (0.47% error vs. CD-Audio)
 *      22              7.85k           (1.8% error vs. 8k)
 */
        /* data format 16/8bit */
        int sp_sf0sndmode;
        int sp_sf0telmode;
};

struct tx39sib_param tx39sib_param_default_3912 = {
        0,                      /* SIBSCLK = 9.216MHz (div2) */
#if 0 /* setting sample */
        40,                     /* audio: 7.2kHz */
        26,                     /* audio: CD-Audio(/4) 11.077kHz*/
        6,                      /* audio: 48kHz */
#endif
        13,                     /* audio: CD-Audio(/2 = 22.050) 22.154kHz*/
        40,                     /* telecom: 7.2kHz */
        TX39_SIBCTRL_SND16,     /* Audio 16bit mono */
        TX39_SIBCTRL_TEL16      /* Telecom 16bit mono */
};

struct tx39sib_param tx39sib_param_default_3922 = {
        7,                      /* SIBSCLK = 9.216MHz (div1) */
        13,                     /* audio: CD-Audio(/2 = 22.050) 22.154kHz*/
        40,                     /* telecom: 7.2kHz */
        TX39_SIBCTRL_SND16,     /* Audio 16bit mono */
        TX39_SIBCTRL_TEL16      /* Telecom 16bit mono */
};

struct tx39sib_softc {
        tx_chipset_tag_t sc_tc;

        struct tx39sib_param sc_param;
        int sc_attached;
};

inline int      __txsibsf0_ready(tx_chipset_tag_t);
#ifdef TX39SIBDEBUG
void    tx39sib_dump(struct tx39sib_softc *);
#endif

CFATTACH_DECL_NEW(tx39sib, sizeof(struct tx39sib_softc),
    tx39sib_match, tx39sib_attach, NULL, NULL);

int
tx39sib_match(device_t parent, cfdata_t cf, void *aux)
{
        return (ATTACH_FIRST);
}

void
tx39sib_attach(device_t parent, device_t self, void *aux)
{
        struct txsim_attach_args *ta = aux;
        struct tx39sib_softc *sc = device_private(self);
        tx_chipset_tag_t tc;
        
        sc->sc_tc = tc = ta->ta_tc;

        /* set default param */
#ifdef TX391X
        sc->sc_param = tx39sib_param_default_3912;
#endif /* TX391X */
#ifdef TX392X
        sc->sc_param = tx39sib_param_default_3922;
#endif /* TX392X */

#define MHZ(a) ((a) / 1000000), (((a) % 1000000) / 1000)
        printf(": %d.%03d MHz", MHZ(tx39sib_clock(self)));
        
        printf("\n");
#ifdef TX39SIBDEBUG
        if (tx39sibdebug)
                tx39sib_dump(sc);
#endif  
        /* enable subframe0 */
        tx39sib_enable1(self);
        /* enable SIB */
        tx39sib_enable2(self);

#ifdef TX39SIBDEBUG
        if (tx39sibdebug)
                tx39sib_dump(sc);
#endif  

        config_search(self, NULL,
            CFARGS(.search = tx39sib_search));
}

void
tx39sib_enable1(device_t dev)
{
        struct tx39sib_softc *sc = device_private(dev);
        struct tx39sib_param *param = &sc->sc_param;
        tx_chipset_tag_t tc = sc->sc_tc;

        txreg_t reg;

        /* disable SIB */
        tx39sib_disable(dev);

        /* setup */
        reg = 0;
        /*  SIB clock rate */
        reg = TX39_SIBCTRL_SCLKDIV_SET(reg, param->sp_clock);
        /*  sampling rate (sound) */
        reg = TX39_SIBCTRL_SNDFSDIV_SET(reg, param->sp_snd_rate - 1);
        /*  sampling rate (telecom) */
        reg = TX39_SIBCTRL_TELFSDIV_SET(reg, param->sp_tel_rate - 1);
        /*  data format (8/16bit) */
        reg |= param->sp_sf0sndmode;
        reg |= param->sp_sf0telmode;
        tx_conf_write(tc, TX39_SIBCTRL_REG, reg);

        /* DMA */
        reg = tx_conf_read(tc, TX39_SIBDMACTRL_REG);
        reg &= ~(TX39_SIBDMACTRL_ENDMARXSND |
            TX39_SIBDMACTRL_ENDMATXSND |
            TX39_SIBDMACTRL_ENDMARXTEL |
            TX39_SIBDMACTRL_ENDMATXTEL);
        tx_conf_write(tc, TX39_SIBDMACTRL_REG, reg);

        /* 
         * Enable subframe0 (BETTY)
         */
        reg = tx_conf_read(tc, TX39_SIBCTRL_REG);
        reg |= TX39_SIBCTRL_ENSF0;
        tx_conf_write(tc, TX39_SIBCTRL_REG, reg);
}

void
tx39sib_enable2(device_t dev)
{
        struct tx39sib_softc *sc = device_private(dev);
        tx_chipset_tag_t tc = sc->sc_tc;
        txreg_t reg;
        
        reg = tx_conf_read(tc, TX39_SIBCTRL_REG);
        reg |= TX39_SIBCTRL_ENSIB;
        tx_conf_write(tc, TX39_SIBCTRL_REG, reg);
}

void
tx39sib_disable(device_t dev)
{
        struct tx39sib_softc *sc = device_private(dev);
        tx_chipset_tag_t tc = sc->sc_tc;
        txreg_t reg;
        /* disable codec side */
        /* notyet */

        /* disable TX39 side */
        reg = tx_conf_read(tc, TX39_SIBCTRL_REG);
        reg &= ~(TX39_SIBCTRL_ENTEL | TX39_SIBCTRL_ENSND);
        tx_conf_write(tc, TX39_SIBCTRL_REG, reg);

        /* 
         * Disable subframe0/1 (BETTY/external codec)
         */
        reg = tx_conf_read(tc, TX39_SIBCTRL_REG);
        reg &= ~TX39_SIBCTRL_ENSF0;
        reg &= ~(TX39_SIBCTRL_ENSF1 | TX39_SIBCTRL_SELTELSF1 | 
            TX39_SIBCTRL_SELSNDSF1);
        tx_conf_write(tc, TX39_SIBCTRL_REG, reg);

        /* disable TX39SIB module */
        reg &= ~TX39_SIBCTRL_ENSIB;
        tx_conf_write(tc, TX39_SIBCTRL_REG, reg);       
}

int
tx39sib_clock(device_t dev)
{
        struct tx39sib_softc *sc = device_private(dev);

        return (TX39_CLK2X / sibsclk_divide_table[sc->sc_param.sp_clock]);
}

int
tx39sib_search(device_t parent, cfdata_t cf, const int *ldesc, void *aux)
{
        struct tx39sib_softc *sc = device_private(parent);
        struct txsib_attach_args sa;
        
        sa.sa_tc        = sc->sc_tc;
        sa.sa_slot      = cf->cf_loc[TXSIBIFCF_SLOT];
        sa.sa_snd_rate  = sc->sc_param.sp_snd_rate;
        sa.sa_tel_rate  = sc->sc_param.sp_tel_rate;

        if (sa.sa_slot == TXSIBIFCF_SLOT_DEFAULT) {
                printf("tx39sib_search: wildcarded slot, skipping\n");
                return (0);
        }
        
        if (!(sc->sc_attached & (1 << sa.sa_slot)) &&/* not attached slot */
            config_probe(parent, cf, &sa)) {
                config_attach(parent, cf, &sa, tx39sib_print, CFARGS_NONE);
                sc->sc_attached |= (1 << sa.sa_slot);
        }

        return (0);
}

int
tx39sib_print(void *aux, const char *pnp)
{
        struct txsib_attach_args *sa = aux;

        aprint_normal(" slot %d", sa->sa_slot);

        return (QUIET);
}

/*
 * sync access method. don't use runtime.
 */

inline int
__txsibsf0_ready(tx_chipset_tag_t tc)
{
        int i;
        
        tx_conf_write(tc, TX39_INTRSTATUS1_REG, TX39_INTRSTATUS1_SIBSF0INT);
        for (i = 0; (!(tx_conf_read(tc, TX39_INTRSTATUS1_REG) & 
            TX39_INTRSTATUS1_SIBSF0INT)) && i < 1000; i++) {
                if (i > 100 && !(i % 100)) {
                        printf("sf0 busy loop: retry count %d\n", i);
                }
        }

        if (i >= 1000) {
                printf("sf0 busy\n");
                return (0);
        }

        return (1);
}

void
txsibsf0_reg_write(tx_chipset_tag_t tc, int addr, u_int16_t val)
{
        txreg_t reg;

        reg = txsibsf0_read(tc, addr);
        reg |= TX39_SIBSF0_WRITE;
        TX39_SIBSF0_REGDATA_CLR(reg);
        reg = TX39_SIBSF0_REGDATA_SET(reg, val);

        __txsibsf0_ready(tc);
        tx_conf_write(tc, TX39_SIBSF0CTRL_REG, reg);
}

u_int16_t
txsibsf0_reg_read(tx_chipset_tag_t tc, int addr)
{
        return (TX39_SIBSF0_REGDATA(txsibsf0_read(tc, addr)));
}

u_int32_t
txsibsf0_read(tx_chipset_tag_t tc, int addr)
{
        txreg_t reg;
        int retry = 3;
        
        do {
                reg = TX39_SIBSF0_REGADDR_SET(0, addr);
                __txsibsf0_ready(tc);
                tx_conf_write(tc, TX39_SIBSF0CTRL_REG, reg);
                
                __txsibsf0_ready(tc);   
                reg = tx_conf_read(tc, TX39_SIBSF0STAT_REG);
                
        } while ((TX39_SIBSF0_REGADDR(reg) != addr) && --retry > 0);
        
        if (retry <= 0) 
                printf("txsibsf0_read: command failed\n");

        return (reg);
}

#ifdef TX39SIBDEBUG
#define ISSETPRINT_CTRL(r, m)                                           \
        dbg_bitmask_print(r, TX39_SIBCTRL_##m, #m)
#define ISSETPRINT_DMACTRL(r, m)                                        \
        dbg_bitmask_print(r, TX39_SIBDMACTRL_##m, #m)

void
tx39sib_dump(struct tx39sib_softc *sc)
{
        tx_chipset_tag_t tc = sc->sc_tc;
        txreg_t reg;

        reg = tx_conf_read(tc, TX39_SIBCTRL_REG);
        ISSETPRINT_CTRL(reg, SIBIRQ);
        ISSETPRINT_CTRL(reg, ENCNTTEST);
        ISSETPRINT_CTRL(reg, ENDMATEST);
        ISSETPRINT_CTRL(reg, SNDMONO);
        ISSETPRINT_CTRL(reg, RMONOSNDIN);
        ISSETPRINT_CTRL(reg, TEL16);
        ISSETPRINT_CTRL(reg, SND16);
        ISSETPRINT_CTRL(reg, SELTELSF1);
        ISSETPRINT_CTRL(reg, SELSNDSF1);
        ISSETPRINT_CTRL(reg, ENTEL);
        ISSETPRINT_CTRL(reg, ENSND);
        ISSETPRINT_CTRL(reg, SIBLOOP);
        ISSETPRINT_CTRL(reg, ENSF1);
        ISSETPRINT_CTRL(reg, ENSF0);
        ISSETPRINT_CTRL(reg, ENSIB);
        printf("\n");
        printf("SCLKDIV %d\n", TX39_SIBCTRL_SCLKDIV(reg));
        printf("TELFSDIV %d\n", TX39_SIBCTRL_TELFSDIV(reg));
        printf("SNDFSDIV %d\n", TX39_SIBCTRL_SNDFSDIV(reg));

        reg = tx_conf_read(tc, TX39_SIBDMACTRL_REG);
        ISSETPRINT_DMACTRL(reg, SNDBUFF1TIME);
        ISSETPRINT_DMACTRL(reg, SNDDMALOOP);
        ISSETPRINT_DMACTRL(reg, ENDMARXSND);
        ISSETPRINT_DMACTRL(reg, ENDMATXSND);
        ISSETPRINT_DMACTRL(reg, TELBUFF1TIME);
        ISSETPRINT_DMACTRL(reg, TELDMALOOP);
        ISSETPRINT_DMACTRL(reg, ENDMARXTEL);
        ISSETPRINT_DMACTRL(reg, ENDMATXTEL);
        printf("\n");
        printf("SNDDMAPTR %d\n", TX39_SIBDMACTRL_TELDMAPTR(reg));
        printf("TELDMAPTR %d\n", TX39_SIBDMACTRL_SNDDMAPTR(reg));

}
#endif /* TX39SIBDEBUG */