// SPDX-License-Identifier: GPL-2.0-or-later
/*
 * budget-core.ko: base-driver for the SAA7146 based Budget DVB cards
 *
 * Compiled from various sources by Michael Hunold <michael@mihu.de>
 *
 * Copyright (C) 2002 Ralph Metzler <rjkm@metzlerbros.de>
 *
 * Copyright (C) 1999-2002 Ralph  Metzler
 *                       & Marcus Metzler for convergence integrated media GmbH
 *
 * 26feb2004 Support for FS Activy Card (Grundig tuner) by
 *           Michael Dreher <michael@5dot1.de>,
 *           Oliver Endriss <o.endriss@gmx.de>,
 *           Andreas 'randy' Weinberger
 *
 * the project's page is at https://linuxtv.org
 */


#include "budget.h"
#include "ttpci-eeprom.h"

#define TS_WIDTH                (2 * TS_SIZE)
#define TS_WIDTH_ACTIVY         TS_SIZE
#define TS_WIDTH_DVBC           TS_SIZE
#define TS_HEIGHT_MASK          0xf00
#define TS_HEIGHT_MASK_ACTIVY   0xc00
#define TS_HEIGHT_MASK_DVBC     0xe00
#define TS_MIN_BUFSIZE_K        188
#define TS_MAX_BUFSIZE_K        1410
#define TS_MAX_BUFSIZE_K_ACTIVY 564
#define TS_MAX_BUFSIZE_K_DVBC   1316
#define BUFFER_WARNING_WAIT     (30*HZ)

int budget_debug;
EXPORT_SYMBOL_GPL(budget_debug);
static int dma_buffer_size = TS_MIN_BUFSIZE_K;
module_param_named(debug, budget_debug, int, 0644);
module_param_named(bufsize, dma_buffer_size, int, 0444);
MODULE_PARM_DESC(debug, "Turn on/off budget debugging (default:off).");
MODULE_PARM_DESC(bufsize, "DMA buffer size in KB, default: 188, min: 188, max: 1410 (Activy: 564)");

/****************************************************************************
 * TT budget / WinTV Nova
 ****************************************************************************/

static int stop_ts_capture(struct budget *budget)
{
        dprintk(2, "budget: %p\n", budget);

        saa7146_write(budget->dev, MC1, MASK_20);       // DMA3 off
        SAA7146_IER_DISABLE(budget->dev, MASK_10);
        return 0;
}

static int start_ts_capture(struct budget *budget)
{
        struct saa7146_dev *dev = budget->dev;

        dprintk(2, "budget: %p\n", budget);

        if (!budget->feeding || !budget->fe_synced)
                return 0;

        saa7146_write(dev, MC1, MASK_20);       // DMA3 off

        memset(budget->grabbing, 0x00, budget->buffer_size);

        saa7146_write(dev, PCI_BT_V1, 0x001c0000 | (saa7146_read(dev, PCI_BT_V1) & ~0x001f0000));

        budget->ttbp = 0;

        /*
         *  Signal path on the Activy:
         *
         *  tuner -> SAA7146 port A -> SAA7146 BRS -> SAA7146 DMA3 -> memory
         *
         *  Since the tuner feeds 204 bytes packets into the SAA7146,
         *  DMA3 is configured to strip the trailing 16 FEC bytes:
         *      Pitch: 188, NumBytes3: 188, NumLines3: 1024
         */

        switch (budget->card->type) {
        case BUDGET_FS_ACTIVY:
                saa7146_write(dev, DD1_INIT, 0x04000000);
                saa7146_write(dev, MC2, (MASK_09 | MASK_25));
                saa7146_write(dev, BRS_CTRL, 0x00000000);
                break;
        case BUDGET_PATCH:
                saa7146_write(dev, DD1_INIT, 0x00000200);
                saa7146_write(dev, MC2, (MASK_10 | MASK_26));
                saa7146_write(dev, BRS_CTRL, 0x60000000);
                break;
        case BUDGET_CIN1200C_MK3:
        case BUDGET_KNC1C_MK3:
        case BUDGET_KNC1C_TDA10024:
        case BUDGET_KNC1CP_MK3:
                if (budget->video_port == BUDGET_VIDEO_PORTA) {
                        saa7146_write(dev, DD1_INIT, 0x06000200);
                        saa7146_write(dev, MC2, (MASK_09 | MASK_25 | MASK_10 | MASK_26));
                        saa7146_write(dev, BRS_CTRL, 0x00000000);
                } else {
                        saa7146_write(dev, DD1_INIT, 0x00000600);
                        saa7146_write(dev, MC2, (MASK_09 | MASK_25 | MASK_10 | MASK_26));
                        saa7146_write(dev, BRS_CTRL, 0x60000000);
                }
                break;
        default:
                if (budget->video_port == BUDGET_VIDEO_PORTA) {
                        saa7146_write(dev, DD1_INIT, 0x06000200);
                        saa7146_write(dev, MC2, (MASK_09 | MASK_25 | MASK_10 | MASK_26));
                        saa7146_write(dev, BRS_CTRL, 0x00000000);
                } else {
                        saa7146_write(dev, DD1_INIT, 0x02000600);
                        saa7146_write(dev, MC2, (MASK_09 | MASK_25 | MASK_10 | MASK_26));
                        saa7146_write(dev, BRS_CTRL, 0x60000000);
                }
        }

        saa7146_write(dev, MC2, (MASK_08 | MASK_24));
        mdelay(10);

        saa7146_write(dev, BASE_ODD3, 0);
        if (budget->buffer_size > budget->buffer_height * budget->buffer_width) {
                // using odd/even buffers
                saa7146_write(dev, BASE_EVEN3, budget->buffer_height * budget->buffer_width);
        } else {
                // using a single buffer
                saa7146_write(dev, BASE_EVEN3, 0);
        }
        saa7146_write(dev, PROT_ADDR3, budget->buffer_size);
        saa7146_write(dev, BASE_PAGE3, budget->pt.dma | ME1 | 0x90);

        saa7146_write(dev, PITCH3, budget->buffer_width);
        saa7146_write(dev, NUM_LINE_BYTE3,
                        (budget->buffer_height << 16) | budget->buffer_width);

        saa7146_write(dev, MC2, (MASK_04 | MASK_20));

        SAA7146_ISR_CLEAR(budget->dev, MASK_10);        /* VPE */
        SAA7146_IER_ENABLE(budget->dev, MASK_10);       /* VPE */
        saa7146_write(dev, MC1, (MASK_04 | MASK_20));   /* DMA3 on */

        return 0;
}

static int budget_read_fe_status(struct dvb_frontend *fe,
                                 enum fe_status *status)
{
        struct budget *budget = fe->dvb->priv;
        int synced;
        int ret;

        if (budget->read_fe_status)
                ret = budget->read_fe_status(fe, status);
        else
                ret = -EINVAL;

        if (!ret) {
                synced = (*status & FE_HAS_LOCK);
                if (synced != budget->fe_synced) {
                        budget->fe_synced = synced;
                        spin_lock(&budget->feedlock);
                        if (synced)
                                start_ts_capture(budget);
                        else
                                stop_ts_capture(budget);
                        spin_unlock(&budget->feedlock);
                }
        }
        return ret;
}

static void vpeirq(struct work_struct *t)
{
        struct budget *budget = from_work(budget, t, vpe_bh_work);
        u8 *mem = (u8 *) (budget->grabbing);
        u32 olddma = budget->ttbp;
        u32 newdma = saa7146_read(budget->dev, PCI_VDP3);
        u32 count;

        /* Ensure streamed PCI data is synced to CPU */
        dma_sync_sg_for_cpu(&budget->dev->pci->dev, budget->pt.slist,
                            budget->pt.nents, DMA_FROM_DEVICE);

        /* nearest lower position divisible by 188 */
        newdma -= newdma % 188;

        if (newdma >= budget->buffer_size)
                return;

        budget->ttbp = newdma;

        if (budget->feeding == 0 || newdma == olddma)
                return;

        if (newdma > olddma) {  /* no wraparound, dump olddma..newdma */
                count = newdma - olddma;
                dvb_dmx_swfilter_packets(&budget->demux, mem + olddma, count / 188);
        } else {                /* wraparound, dump olddma..buflen and 0..newdma */
                count = budget->buffer_size - olddma;
                dvb_dmx_swfilter_packets(&budget->demux, mem + olddma, count / 188);
                count += newdma;
                dvb_dmx_swfilter_packets(&budget->demux, mem, newdma / 188);
        }

        if (count > budget->buffer_warning_threshold)
                budget->buffer_warnings++;

        if (budget->buffer_warnings && time_after(jiffies, budget->buffer_warning_time)) {
                pr_warn("%s %s: used %d times >80%% of buffer (%u bytes now)\n",
                        budget->dev->name, __func__, budget->buffer_warnings, count);
                budget->buffer_warning_time = jiffies + BUFFER_WARNING_WAIT;
                budget->buffer_warnings = 0;
        }
}


static int ttpci_budget_debiread_nolock(struct budget *budget, u32 config,
                int addr, int count, int nobusyloop)
{
        struct saa7146_dev *saa = budget->dev;
        int result;

        result = saa7146_wait_for_debi_done(saa, nobusyloop);
        if (result < 0)
                return result;

        saa7146_write(saa, DEBI_COMMAND, (count << 17) | 0x10000 | (addr & 0xffff));
        saa7146_write(saa, DEBI_CONFIG, config);
        saa7146_write(saa, DEBI_PAGE, 0);
        saa7146_write(saa, MC2, (2 << 16) | 2);

        result = saa7146_wait_for_debi_done(saa, nobusyloop);
        if (result < 0)
                return result;

        result = saa7146_read(saa, DEBI_AD);
        result &= (0xffffffffUL >> ((4 - count) * 8));
        return result;
}

int ttpci_budget_debiread(struct budget *budget, u32 config, int addr, int count,
                          int uselocks, int nobusyloop)
{
        if (count > 4 || count <= 0)
                return 0;

        if (uselocks) {
                unsigned long flags;
                int result;

                spin_lock_irqsave(&budget->debilock, flags);
                result = ttpci_budget_debiread_nolock(budget, config, addr,
                                                      count, nobusyloop);
                spin_unlock_irqrestore(&budget->debilock, flags);
                return result;
        }
        return ttpci_budget_debiread_nolock(budget, config, addr,
                                            count, nobusyloop);
}
EXPORT_SYMBOL_GPL(ttpci_budget_debiread);

static int ttpci_budget_debiwrite_nolock(struct budget *budget, u32 config,
                int addr, int count, u32 value, int nobusyloop)
{
        struct saa7146_dev *saa = budget->dev;
        int result;

        result = saa7146_wait_for_debi_done(saa, nobusyloop);
        if (result < 0)
                return result;

        saa7146_write(saa, DEBI_COMMAND, (count << 17) | 0x00000 | (addr & 0xffff));
        saa7146_write(saa, DEBI_CONFIG, config);
        saa7146_write(saa, DEBI_PAGE, 0);
        saa7146_write(saa, DEBI_AD, value);
        saa7146_write(saa, MC2, (2 << 16) | 2);

        result = saa7146_wait_for_debi_done(saa, nobusyloop);
        return result < 0 ? result : 0;
}

int ttpci_budget_debiwrite(struct budget *budget, u32 config, int addr,
                           int count, u32 value, int uselocks, int nobusyloop)
{
        if (count > 4 || count <= 0)
                return 0;

        if (uselocks) {
                unsigned long flags;
                int result;

                spin_lock_irqsave(&budget->debilock, flags);
                result = ttpci_budget_debiwrite_nolock(budget, config, addr,
                                                count, value, nobusyloop);
                spin_unlock_irqrestore(&budget->debilock, flags);
                return result;
        }
        return ttpci_budget_debiwrite_nolock(budget, config, addr,
                                             count, value, nobusyloop);
}
EXPORT_SYMBOL_GPL(ttpci_budget_debiwrite);


/****************************************************************************
 * DVB API SECTION
 ****************************************************************************/

static int budget_start_feed(struct dvb_demux_feed *feed)
{
        struct dvb_demux *demux = feed->demux;
        struct budget *budget = demux->priv;
        int status = 0;

        dprintk(2, "budget: %p\n", budget);

        if (!demux->dmx.frontend)
                return -EINVAL;

        spin_lock(&budget->feedlock);
        feed->pusi_seen = false; /* have a clean section start */
        if (budget->feeding++ == 0)
                status = start_ts_capture(budget);
        spin_unlock(&budget->feedlock);
        return status;
}

static int budget_stop_feed(struct dvb_demux_feed *feed)
{
        struct dvb_demux *demux = feed->demux;
        struct budget *budget = demux->priv;
        int status = 0;

        dprintk(2, "budget: %p\n", budget);

        spin_lock(&budget->feedlock);
        if (--budget->feeding == 0)
                status = stop_ts_capture(budget);
        spin_unlock(&budget->feedlock);
        return status;
}

static int budget_register(struct budget *budget)
{
        struct dvb_demux *dvbdemux = &budget->demux;
        int ret;

        dprintk(2, "budget: %p\n", budget);

        dvbdemux->priv = (void *) budget;

        dvbdemux->filternum = 256;
        dvbdemux->feednum = 256;
        dvbdemux->start_feed = budget_start_feed;
        dvbdemux->stop_feed = budget_stop_feed;
        dvbdemux->write_to_decoder = NULL;

        dvbdemux->dmx.capabilities = (DMX_TS_FILTERING | DMX_SECTION_FILTERING |
                                      DMX_MEMORY_BASED_FILTERING);

        dvb_dmx_init(&budget->demux);

        budget->dmxdev.filternum = 256;
        budget->dmxdev.demux = &dvbdemux->dmx;
        budget->dmxdev.capabilities = 0;

        dvb_dmxdev_init(&budget->dmxdev, &budget->dvb_adapter);

        budget->hw_frontend.source = DMX_FRONTEND_0;

        ret = dvbdemux->dmx.add_frontend(&dvbdemux->dmx, &budget->hw_frontend);

        if (ret < 0)
                goto err_release_dmx;

        budget->mem_frontend.source = DMX_MEMORY_FE;
        ret = dvbdemux->dmx.add_frontend(&dvbdemux->dmx, &budget->mem_frontend);
        if (ret < 0)
                goto err_release_dmx;

        ret = dvbdemux->dmx.connect_frontend(&dvbdemux->dmx, &budget->hw_frontend);
        if (ret < 0)
                goto err_release_dmx;

        dvb_net_init(&budget->dvb_adapter, &budget->dvb_net, &dvbdemux->dmx);

        return 0;

err_release_dmx:
        dvb_dmxdev_release(&budget->dmxdev);
        dvb_dmx_release(&budget->demux);
        return ret;
}

static void budget_unregister(struct budget *budget)
{
        struct dvb_demux *dvbdemux = &budget->demux;

        dprintk(2, "budget: %p\n", budget);

        dvb_net_release(&budget->dvb_net);

        dvbdemux->dmx.close(&dvbdemux->dmx);
        dvbdemux->dmx.remove_frontend(&dvbdemux->dmx, &budget->hw_frontend);
        dvbdemux->dmx.remove_frontend(&dvbdemux->dmx, &budget->mem_frontend);

        dvb_dmxdev_release(&budget->dmxdev);
        dvb_dmx_release(&budget->demux);
}

int ttpci_budget_init(struct budget *budget, struct saa7146_dev *dev,
                      struct saa7146_pci_extension_data *info,
                      struct module *owner, short *adapter_nums)
{
        int ret = 0;
        struct budget_info *bi = info->ext_priv;
        int max_bufsize;
        int height_mask;

        memset(budget, 0, sizeof(struct budget));

        dprintk(2, "dev: %p, budget: %p\n", dev, budget);

        budget->card = bi;
        budget->dev = (struct saa7146_dev *) dev;

        switch (budget->card->type) {
        case BUDGET_FS_ACTIVY:
                budget->buffer_width = TS_WIDTH_ACTIVY;
                max_bufsize = TS_MAX_BUFSIZE_K_ACTIVY;
                height_mask = TS_HEIGHT_MASK_ACTIVY;
                break;

        case BUDGET_KNC1C:
        case BUDGET_KNC1CP:
        case BUDGET_CIN1200C:
        case BUDGET_KNC1C_MK3:
        case BUDGET_KNC1C_TDA10024:
        case BUDGET_KNC1CP_MK3:
        case BUDGET_CIN1200C_MK3:
                budget->buffer_width = TS_WIDTH_DVBC;
                max_bufsize = TS_MAX_BUFSIZE_K_DVBC;
                height_mask = TS_HEIGHT_MASK_DVBC;
                break;

        default:
                budget->buffer_width = TS_WIDTH;
                max_bufsize = TS_MAX_BUFSIZE_K;
                height_mask = TS_HEIGHT_MASK;
        }

        if (dma_buffer_size < TS_MIN_BUFSIZE_K)
                dma_buffer_size = TS_MIN_BUFSIZE_K;
        else if (dma_buffer_size > max_bufsize)
                dma_buffer_size = max_bufsize;

        budget->buffer_height = dma_buffer_size * 1024 / budget->buffer_width;
        if (budget->buffer_height > 0xfff) {
                budget->buffer_height /= 2;
                budget->buffer_height &= height_mask;
                budget->buffer_size = 2 * budget->buffer_height * budget->buffer_width;
        } else {
                budget->buffer_height &= height_mask;
                budget->buffer_size = budget->buffer_height * budget->buffer_width;
        }
        budget->buffer_warning_threshold = budget->buffer_size * 80/100;
        budget->buffer_warnings = 0;
        budget->buffer_warning_time = jiffies;

        dprintk(2, "%s: buffer type = %s, width = %d, height = %d\n",
                budget->dev->name,
                budget->buffer_size > budget->buffer_width * budget->buffer_height ? "odd/even" : "single",
                budget->buffer_width, budget->buffer_height);
        pr_info("%s: dma buffer size %u\n", budget->dev->name, budget->buffer_size);

        ret = dvb_register_adapter(&budget->dvb_adapter, budget->card->name,
                                   owner, &budget->dev->pci->dev, adapter_nums);
        if (ret < 0)
                return ret;

        /* set dd1 stream a & b */
        saa7146_write(dev, DD1_STREAM_B, 0x00000000);
        saa7146_write(dev, MC2, (MASK_09 | MASK_25));
        saa7146_write(dev, MC2, (MASK_10 | MASK_26));
        saa7146_write(dev, DD1_INIT, 0x02000000);
        saa7146_write(dev, MC2, (MASK_09 | MASK_25 | MASK_10 | MASK_26));

        if (bi->type != BUDGET_FS_ACTIVY)
                budget->video_port = BUDGET_VIDEO_PORTB;
        else
                budget->video_port = BUDGET_VIDEO_PORTA;
        spin_lock_init(&budget->feedlock);
        spin_lock_init(&budget->debilock);

        /*
         * the Siemens DVB needs this if you want to have the i2c chips
         * get recognized before the main driver is loaded
         */
        if (bi->type != BUDGET_FS_ACTIVY)
                saa7146_write(dev, GPIO_CTRL, 0x500000);        /* GPIO 3 = 1 */

        strscpy(budget->i2c_adap.name, budget->card->name,
                sizeof(budget->i2c_adap.name));

        saa7146_i2c_adapter_prepare(dev, &budget->i2c_adap, SAA7146_I2C_BUS_BIT_RATE_120);
        strscpy(budget->i2c_adap.name, budget->card->name,
                sizeof(budget->i2c_adap.name));

        if (i2c_add_adapter(&budget->i2c_adap) < 0) {
                ret = -ENOMEM;
                goto err_dvb_unregister;
        }

        ttpci_eeprom_parse_mac(&budget->i2c_adap, budget->dvb_adapter.proposed_mac);

        budget->grabbing = saa7146_vmalloc_build_pgtable(dev->pci, budget->buffer_size, &budget->pt);
        if (budget->grabbing == NULL) {
                ret = -ENOMEM;
                goto err_del_i2c;
        }

        saa7146_write(dev, PCI_BT_V1, 0x001c0000);
        /* upload all */
        saa7146_write(dev, GPIO_CTRL, 0x000000);

        INIT_WORK(&budget->vpe_bh_work, vpeirq);

        /* frontend power on */
        if (bi->type != BUDGET_FS_ACTIVY)
                saa7146_setgpio(dev, 2, SAA7146_GPIO_OUTHI);

        ret = budget_register(budget);
        if (ret == 0)
                return 0; /* Everything OK */

        /* An error occurred, cleanup resources */
        saa7146_vfree_destroy_pgtable(dev->pci, budget->grabbing, &budget->pt);

err_del_i2c:
        i2c_del_adapter(&budget->i2c_adap);

err_dvb_unregister:
        dvb_unregister_adapter(&budget->dvb_adapter);

        return ret;
}
EXPORT_SYMBOL_GPL(ttpci_budget_init);

void ttpci_budget_init_hooks(struct budget *budget)
{
        if (budget->dvb_frontend && !budget->read_fe_status) {
                budget->read_fe_status = budget->dvb_frontend->ops.read_status;
                budget->dvb_frontend->ops.read_status = budget_read_fe_status;
        }
}
EXPORT_SYMBOL_GPL(ttpci_budget_init_hooks);

int ttpci_budget_deinit(struct budget *budget)
{
        struct saa7146_dev *dev = budget->dev;

        dprintk(2, "budget: %p\n", budget);

        budget_unregister(budget);

        cancel_work_sync(&budget->vpe_bh_work);

        saa7146_vfree_destroy_pgtable(dev->pci, budget->grabbing, &budget->pt);

        i2c_del_adapter(&budget->i2c_adap);

        dvb_unregister_adapter(&budget->dvb_adapter);

        return 0;
}
EXPORT_SYMBOL_GPL(ttpci_budget_deinit);

void ttpci_budget_irq10_handler(struct saa7146_dev *dev, u32 *isr)
{
        struct budget *budget = dev->ext_priv;

        dprintk(8, "dev: %p, budget: %p\n", dev, budget);

        if (*isr & MASK_10)
                queue_work(system_bh_wq, &budget->vpe_bh_work);
}
EXPORT_SYMBOL_GPL(ttpci_budget_irq10_handler);

void ttpci_budget_set_video_port(struct saa7146_dev *dev, int video_port)
{
        struct budget *budget = dev->ext_priv;

        spin_lock(&budget->feedlock);
        budget->video_port = video_port;
        if (budget->feeding) {
                stop_ts_capture(budget);
                start_ts_capture(budget);
        }
        spin_unlock(&budget->feedlock);
}
EXPORT_SYMBOL_GPL(ttpci_budget_set_video_port);

MODULE_DESCRIPTION("base driver for the SAA7146 based Budget DVB cards");
MODULE_LICENSE("GPL");