/* SPDX-License-Identifier: GPL-2.0-or-later */
/*

    bttv - Bt848 frame grabber driver

    bttv's *private* header file  --  nobody other than bttv itself
    should ever include this file.

    (c) 2000-2002 Gerd Knorr <kraxel@bytesex.org>

*/

#ifndef _BTTVP_H_
#define _BTTVP_H_

#include <linux/types.h>
#include <linux/wait.h>
#include <linux/i2c.h>
#include <linux/i2c-algo-bit.h>
#include <linux/pci.h>
#include <linux/input.h>
#include <linux/mutex.h>
#include <linux/scatterlist.h>
#include <linux/device.h>
#include <asm/io.h>
#include <media/v4l2-common.h>
#include <media/v4l2-ctrls.h>
#include <media/v4l2-fh.h>
#include <media/videobuf2-dma-sg.h>
#include <media/tveeprom.h>
#include <media/rc-core.h>
#include <media/i2c/ir-kbd-i2c.h>
#include <media/drv-intf/tea575x.h>

#include "bt848.h"
#include "bttv.h"
#include "btcx-risc.h"

#ifdef __KERNEL__

#define FORMAT_FLAGS_DITHER       0x01
#define FORMAT_FLAGS_PACKED       0x02
#define FORMAT_FLAGS_PLANAR       0x04
#define FORMAT_FLAGS_RAW          0x08
#define FORMAT_FLAGS_CrCb         0x10

#define RISC_SLOT_O_VBI        4
#define RISC_SLOT_O_FIELD      6
#define RISC_SLOT_E_VBI       10
#define RISC_SLOT_E_FIELD     12
#define RISC_SLOT_LOOP        14

#define RESOURCE_VIDEO_STREAM  2
#define RESOURCE_VBI           4
#define RESOURCE_VIDEO_READ    8

#define RAW_LINES            640
#define RAW_BPL             1024

#define UNSET (-1U)

/* Min. value in VDELAY register. */
#define MIN_VDELAY 2
/* Even to get Cb first, odd for Cr. */
#define MAX_HDELAY (0x3FF & -2)
/* Limits scaled width, which must be a multiple of 4. */
#define MAX_HACTIVE (0x3FF & -4)

#define BTTV_NORMS    (\
                V4L2_STD_PAL    | V4L2_STD_PAL_N | \
                V4L2_STD_PAL_Nc | V4L2_STD_SECAM | \
                V4L2_STD_NTSC   | V4L2_STD_PAL_M | \
                V4L2_STD_PAL_60)
/* ---------------------------------------------------------- */

struct bttv_tvnorm {
        int   v4l2_id;
        char  *name;
        u32   Fsc;
        u16   swidth, sheight; /* scaled standard width, height */
        u16   totalwidth;
        u8    adelay, bdelay, iform;
        u32   scaledtwidth;
        u16   hdelayx1, hactivex1;
        u16   vdelay;
        u8    vbipack;
        u16   vtotal;
        int   sram;
        /* ITU-R frame line number of the first VBI line we can
           capture, of the first and second field. The last possible line
           is determined by cropcap.bounds. */
        u16   vbistart[2];
        /* Horizontally this counts fCLKx1 samples following the leading
           edge of the horizontal sync pulse, vertically ITU-R frame line
           numbers of the first field times two (2, 4, 6, ... 524 or 624). */
        struct v4l2_cropcap cropcap;
};
extern const struct bttv_tvnorm bttv_tvnorms[];

struct bttv_format {
        int  fourcc;          /* video4linux 2      */
        int  btformat;        /* BT848_COLOR_FMT_*  */
        int  btswap;          /* BT848_COLOR_CTL_*  */
        int  depth;           /* bit/pixel          */
        int  flags;
        int  hshift,vshift;   /* for planar modes   */
};

struct bttv_ir {
        struct rc_dev           *dev;
        struct bttv             *btv;
        struct timer_list       timer;

        char                    name[32];
        char                    phys[32];

        /* Usual gpio signalling */
        u32                     mask_keycode;
        u32                     mask_keydown;
        u32                     mask_keyup;
        u32                     polling;
        u32                     last_gpio;
        int                     shift_by;
        int                     rc5_remote_gap;

        /* RC5 gpio */
        bool                    rc5_gpio;   /* Is RC5 legacy GPIO enabled? */
        u32                     last_bit;   /* last raw bit seen */
        u32                     code;       /* raw code under construction */
        ktime_t                                         base_time;  /* time of last seen code */
        bool                    active;     /* building raw code */
};


/* ---------------------------------------------------------- */

struct bttv_geometry {
        u8  vtc,crop,comb;
        u16 width,hscale,hdelay;
        u16 sheight,vscale,vdelay,vtotal;
};

struct bttv_buffer {
        /* common v4l buffer stuff -- must be first */
        struct vb2_v4l2_buffer vbuf;
        struct list_head list;

        /* bttv specific */
        int                        btformat;
        int                        btswap;
        struct bttv_geometry       geo;
        struct btcx_riscmem        top;
        struct btcx_riscmem        bottom;
};

struct bttv_buffer_set {
        struct bttv_buffer     *top;       /* top field buffer    */
        struct bttv_buffer     *bottom;    /* bottom field buffer */
        unsigned int           top_irq;
        unsigned int           frame_irq;
};

struct bttv_vbi_fmt {
        struct v4l2_vbi_format fmt;

        /* fmt.start[] and count[] refer to this video standard. */
        const struct bttv_tvnorm *tvnorm;

        /* Earliest possible start of video capturing with this
           v4l2_vbi_format, in struct bttv_crop.rect units. */
        __s32                  end;
};

/* bttv-vbi.c */
extern const struct vb2_ops bttv_vbi_qops;

void bttv_vbi_fmt_reset(struct bttv_vbi_fmt *f, unsigned int norm);

struct bttv_crop {
        /* A cropping rectangle in struct bttv_tvnorm.cropcap units. */
        struct v4l2_rect       rect;

        /* Scaled image size limits with this crop rect. Divide
           max_height, but not min_height, by two when capturing
           single fields. See also bttv_crop_reset() and
           bttv_crop_adjust() in bttv-driver.c. */
        __s32                  min_scaled_width;
        __s32                  min_scaled_height;
        __s32                  max_scaled_width;
        __s32                  max_scaled_height;
};

/* ---------------------------------------------------------- */
/* bttv-risc.c                                                */

/* risc code generators - capture */
int bttv_risc_packed(struct bttv *btv, struct btcx_riscmem *risc,
                     struct scatterlist *sglist,
                     unsigned int offset, unsigned int bpl,
                     unsigned int pitch, unsigned int skip_lines,
                     unsigned int store_lines);

/* control dma register + risc main loop */
void bttv_set_dma(struct bttv *btv, int override);
int bttv_risc_init_main(struct bttv *btv);
int bttv_risc_hook(struct bttv *btv, int slot, struct btcx_riscmem *risc,
                   int irqflags);

/* capture buffer handling */
int bttv_buffer_risc(struct bttv *btv, struct bttv_buffer *buf);
int bttv_buffer_activate_video(struct bttv *btv,
                               struct bttv_buffer_set *set);
int bttv_buffer_risc_vbi(struct bttv *btv, struct bttv_buffer *buf);
int bttv_buffer_activate_vbi(struct bttv *btv,
                             struct bttv_buffer *vbi);

/* ---------------------------------------------------------- */
/* bttv-vbi.c                                                 */

/*
 * 2048 for compatibility with earlier driver versions. The driver really
 * stores 1024 + tvnorm->vbipack * 4 samples per line in the buffer. Note
 * tvnorm->vbipack is <= 0xFF (limit of VBIPACK_LO + HI is 0x1FF DWORDs) and
 * VBI read()s store a frame counter in the last four bytes of the VBI image.
 */
#define VBI_BPL 2048

#define VBI_DEFLINES 16

int bttv_try_fmt_vbi_cap(struct file *file, void *fh, struct v4l2_format *f);
int bttv_g_fmt_vbi_cap(struct file *file, void *fh, struct v4l2_format *f);
int bttv_s_fmt_vbi_cap(struct file *file, void *fh, struct v4l2_format *f);

/* ---------------------------------------------------------- */
/* bttv-gpio.c */

extern const struct bus_type bttv_sub_bus_type;
int bttv_sub_add_device(struct bttv_core *core, char *name);
int bttv_sub_del_devices(struct bttv_core *core);

/* ---------------------------------------------------------- */
/* bttv-input.c                                               */

extern void init_bttv_i2c_ir(struct bttv *btv);

/* ---------------------------------------------------------- */
/* bttv-i2c.c                                                 */
extern int init_bttv_i2c(struct bttv *btv);
extern int fini_bttv_i2c(struct bttv *btv);

/* ---------------------------------------------------------- */
/* bttv-driver.c                                              */

/* insmod options */
extern unsigned int bttv_verbose;
extern unsigned int bttv_debug;
extern unsigned int bttv_gpio;
int check_alloc_btres_lock(struct bttv *btv, int bit);
void free_btres_lock(struct bttv *btv, int bits);
extern void bttv_gpio_tracking(struct bttv *btv, char *comment);

#define dprintk(fmt, ...)                       \
do {                                            \
        if (bttv_debug >= 1)                    \
                pr_debug(fmt, ##__VA_ARGS__);   \
} while (0)
#define dprintk_cont(fmt, ...)                  \
do {                                            \
        if (bttv_debug >= 1)                    \
                pr_cont(fmt, ##__VA_ARGS__);    \
} while (0)
#define d2printk(fmt, ...)                      \
do {                                            \
        if (bttv_debug >= 2)                    \
                printk(fmt, ##__VA_ARGS__);     \
} while (0)

#define BTTV_MAX_FBUF   0x208000
#define BTTV_TIMEOUT    msecs_to_jiffies(500)    /* 0.5 seconds */
#define BTTV_FREE_IDLE  msecs_to_jiffies(1000)   /* one second */


struct bttv_pll_info {
        unsigned int pll_ifreq;    /* PLL input frequency        */
        unsigned int pll_ofreq;    /* PLL output frequency       */
        unsigned int pll_crystal;  /* Crystal used for input     */
        unsigned int pll_current;  /* Currently programmed ofreq */
};

/* for gpio-connected remote control */
struct bttv_input {
        struct input_dev      *dev;
        char                  name[32];
        char                  phys[32];
        u32                   mask_keycode;
        u32                   mask_keydown;
};

struct bttv_suspend_state {
        u32  gpio_enable;
        u32  gpio_data;
        int  disabled;
        int  loop_irq;
        struct bttv_buffer_set video;
        struct bttv_buffer     *vbi;
};

struct bttv_tea575x_gpio {
        u8 data, clk, wren, most;
};

struct bttv {
        struct bttv_core c;

        /* pci device config */
        unsigned short id;
        unsigned char revision;
        unsigned char __iomem *bt848_mmio;   /* pointer to mmio */

        /* card configuration info */
        unsigned int cardid;   /* pci subsystem id (bt878 based ones) */
        unsigned int tuner_type;  /* tuner chip type */
        unsigned int tda9887_conf;
        unsigned int svhs, dig;
        unsigned int has_saa6588:1;
        struct bttv_pll_info pll;
        int triton1;
        int gpioirq;

        int use_i2c_hw;

        /* old gpio interface */
        int shutdown;

        void (*volume_gpio)(struct bttv *btv, __u16 volume);
        void (*audio_mode_gpio)(struct bttv *btv, struct v4l2_tuner *tuner, int set);

        /* new gpio interface */
        spinlock_t gpio_lock;

        /* i2c layer */
        struct i2c_algo_bit_data   i2c_algo;
        struct i2c_client          i2c_client;
        int                        i2c_state, i2c_rc;
        int                        i2c_done;
        wait_queue_head_t          i2c_queue;
        struct v4l2_subdev        *sd_msp34xx;
        struct v4l2_subdev        *sd_tvaudio;
        struct v4l2_subdev        *sd_tda7432;

        /* video4linux (1) */
        struct video_device video_dev;
        struct video_device radio_dev;
        struct video_device vbi_dev;

        /* controls */
        struct v4l2_ctrl_handler   ctrl_handler;
        struct v4l2_ctrl_handler   radio_ctrl_handler;

        /* infrared remote */
        int has_remote;
        struct bttv_ir *remote;

        /* I2C remote data */
        struct IR_i2c_init_data    init_data;

        /* locking */
        spinlock_t s_lock;
        struct mutex lock;
        int resources;

        /* video state */
        unsigned int input;
        unsigned int audio_input;
        unsigned int mute;
        unsigned long tv_freq;
        unsigned int tvnorm;
        v4l2_std_id std;
        int hue, contrast, bright, saturation;
        struct v4l2_framebuffer fbuf;
        __u32 field_count;

        /* various options */
        int opt_combfilter;
        int opt_automute;
        int opt_vcr_hack;
        int opt_uv_ratio;

        /* radio data/state */
        int has_radio;
        int has_radio_tuner;
        int radio_user;
        int radio_uses_msp_demodulator;
        unsigned long radio_freq;

        /* miro/pinnacle + Aimslab VHX
           philips matchbox (tea5757 radio tuner) support */
        int has_tea575x;
        struct bttv_tea575x_gpio tea_gpio;
        struct snd_tea575x tea;

        /* ISA stuff (Terratec Active Radio Upgrade) */
        int mbox_ior;
        int mbox_iow;
        int mbox_csel;

        /* switch status for multi-controller cards */
        char sw_status[4];

        /* risc memory management data
           - must acquire s_lock before changing these
           - only the irq handler is supported to touch top + bottom + vcurr */
        struct btcx_riscmem     main;
        struct list_head        capture;    /* video capture queue */
        struct list_head        vcapture;   /* vbi capture queue   */
        struct bttv_buffer_set  curr;       /* active buffers      */
        struct bttv_buffer      *cvbi;      /* active vbi buffer   */
        int                     loop_irq;
        int                     new_input;

        unsigned long dma_on;
        struct timer_list timeout;
        struct bttv_suspend_state state;

        /* stats */
        unsigned int errors;
        unsigned int framedrop;
        unsigned int irq_total;
        unsigned int irq_me;

        unsigned int users;
        struct v4l2_fh fh;
        enum v4l2_buf_type type;

        enum v4l2_field field;
        int field_last;

        /* video capture */
        struct vb2_queue capq;
        const struct bttv_format *fmt;
        int width;
        int height;

        /* vbi capture */
        struct vb2_queue vbiq;
        struct bttv_vbi_fmt vbi_fmt;
        unsigned int vbi_count[2];

        /* Application called VIDIOC_S_SELECTION. */
        int do_crop;

        /* used to make dvb-bt8xx autoloadable */
        struct work_struct request_module_wk;

        /* Default (0) and current (1) video capturing
           cropping parameters in bttv_tvnorm.cropcap units. Protected
           by bttv.lock. */
        struct bttv_crop crop[2];

        /* Earliest possible start of video capturing in
           bttv_tvnorm.cropcap line units. Set by check_alloc_btres()
           and free_btres(). Protected by bttv.lock. */
        __s32                   vbi_end;

        /* Latest possible end of VBI capturing (= crop[x].rect.top when
           VIDEO_RESOURCES are locked). Set by check_alloc_btres()
           and free_btres(). Protected by bttv.lock. */
        __s32                   crop_start;
};

static inline struct bttv *to_bttv(struct v4l2_device *v4l2_dev)
{
        return container_of(v4l2_dev, struct bttv, c.v4l2_dev);
}

/* our devices */
#define BTTV_MAX 32
extern unsigned int bttv_num;
extern struct bttv *bttvs[BTTV_MAX];

static inline unsigned int bttv_muxsel(const struct bttv *btv,
                                       unsigned int input)
{
        return (bttv_tvcards[btv->c.type].muxsel >> (input * 2)) & 3;
}

#endif

void init_irqreg(struct bttv *btv);

#define btwrite(dat,adr)    writel((dat), btv->bt848_mmio+(adr))
#define btread(adr)         readl(btv->bt848_mmio+(adr))

#define btand(dat,adr)      btwrite((dat) & btread(adr), adr)
#define btor(dat,adr)       btwrite((dat) | btread(adr), adr)
#define btaor(dat,mask,adr) btwrite((dat) | ((mask) & btread(adr)), adr)

#endif /* _BTTVP_H_ */