drivers/media/video/bttvp.h

   1 /*
   2
   3     bttv - Bt848 frame grabber driver
   4
   5     bttv's *private* header file  --  nobody other than bttv itself
   6     should ever include this file.
   7
   8     (c) 2000-2002 Gerd Knorr <kraxel@bytesex.org>
   9
  10     This program is free software; you can redistribute it and/or modify
  11     it under the terms of the GNU General Public License as published by
  12     the Free Software Foundation; either version 2 of the License, or
  13     (at your option) any later version.
  14
  15     This program is distributed in the hope that it will be useful,
  16     but WITHOUT ANY WARRANTY; without even the implied warranty of
  17     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18     GNU General Public License for more details.
  19
  20     You should have received a copy of the GNU General Public License
  21     along with this program; if not, write to the Free Software
  22     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  23 */
  24
  25 #ifndef _BTTVP_H_
  26 #define _BTTVP_H_
  27
  28 #include <linux/version.h>
  29 #define BTTV_VERSION_CODE KERNEL_VERSION(0,9,16)
  30
  31 #include <linux/types.h>
  32 #include <linux/wait.h>
  33 #include <linux/i2c.h>
  34 #include <linux/i2c-algo-bit.h>
  35 #include <linux/videodev.h>
  36 #include <linux/pci.h>
  37 #include <linux/input.h>
  38 #include <asm/scatterlist.h>
  39 #include <asm/io.h>
  40
  41 #include <linux/device.h>
  42 #include <media/video-buf.h>
  43 #include <media/audiochip.h>
  44 #include <media/tuner.h>
  45 #include <media/tveeprom.h>
  46 #include <media/ir-common.h>
  47
  48
  49 #include "bt848.h"
  50 #include "bttv.h"
  51 #include "btcx-risc.h"
  52
  53 #ifdef __KERNEL__
  54
  55 #define FORMAT_FLAGS_DITHER       0x01
  56 #define FORMAT_FLAGS_PACKED       0x02
  57 #define FORMAT_FLAGS_PLANAR       0x04
  58 #define FORMAT_FLAGS_RAW          0x08
  59 #define FORMAT_FLAGS_CrCb         0x10
  60
  61 #define RISC_SLOT_O_VBI        4
  62 #define RISC_SLOT_O_FIELD      6
  63 #define RISC_SLOT_E_VBI       10
  64 #define RISC_SLOT_E_FIELD     12
  65 #define RISC_SLOT_LOOP        14
  66
  67 #define RESOURCE_OVERLAY       1
  68 #define RESOURCE_VIDEO         2
  69 #define RESOURCE_VBI           4
  70
  71 #define RAW_LINES            640
  72 #define RAW_BPL             1024
  73
  74 #define UNSET (-1U)
  75
  76 #define clamp(x, low, high) min (max (low, x), high)
  77
  78 /* ---------------------------------------------------------- */
  79
  80 struct bttv_tvnorm {
  81         int   v4l2_id;
  82         char  *name;
  83         u32   Fsc;
  84         u16   swidth, sheight; /* scaled standard width, height */
  85         u16   totalwidth;
  86         u8    adelay, bdelay, iform;
  87         u32   scaledtwidth;
  88         u16   hdelayx1, hactivex1;
  89         u16   vdelay;
  90         u8    vbipack;
  91         u16   vtotal;
  92         int   sram;
  93         /* ITU-R frame line number of the first VBI line we can
  94            capture, of the first and second field. */
  95         u16   vbistart[2];
  96 };
  97 extern const struct bttv_tvnorm bttv_tvnorms[];
  98
  99 struct bttv_format {
 100         char *name;
 101         int  palette;         /* video4linux 1      */
 102         int  fourcc;          /* video4linux 2      */
 103         int  btformat;        /* BT848_COLOR_FMT_*  */
 104         int  btswap;          /* BT848_COLOR_CTL_*  */
 105         int  depth;           /* bit/pixel          */
 106         int  flags;
 107         int  hshift,vshift;   /* for planar modes   */
 108 };
 109
 110 /* ---------------------------------------------------------- */
 111
 112 struct bttv_geometry {
 113         u8  vtc,crop,comb;
 114         u16 width,hscale,hdelay;
 115         u16 sheight,vscale,vdelay,vtotal;
 116 };
 117
 118 struct bttv_buffer {
 119         /* common v4l buffer stuff -- must be first */
 120         struct videobuf_buffer     vb;
 121
 122         /* bttv specific */
 123         const struct bttv_format   *fmt;
 124         int                        tvnorm;
 125         int                        btformat;
 126         int                        btswap;
 127         struct bttv_geometry       geo;
 128         struct btcx_riscmem        top;
 129         struct btcx_riscmem        bottom;
 130 };
 131
 132 struct bttv_buffer_set {
 133         struct bttv_buffer     *top;       /* top field buffer    */
 134         struct bttv_buffer     *bottom;    /* bottom field buffer */
 135         unsigned int           top_irq;
 136         unsigned int           frame_irq;
 137 };
 138
 139 struct bttv_overlay {
 140         int                    tvnorm;
 141         struct v4l2_rect       w;
 142         enum v4l2_field        field;
 143         struct v4l2_clip       *clips;
 144         int                    nclips;
 145         int                    setup_ok;
 146 };
 147
 148 struct bttv_fh {
 149         struct bttv              *btv;
 150         int resources;
 151 #ifdef VIDIOC_G_PRIORITY
 152         enum v4l2_priority       prio;
 153 #endif
 154         enum v4l2_buf_type       type;
 155
 156         /* video capture */
 157         struct videobuf_queue    cap;
 158         const struct bttv_format *fmt;
 159         int                      width;
 160         int                      height;
 161
 162         /* current settings */
 163         const struct bttv_format *ovfmt;
 164         struct bttv_overlay      ov;
 165
 166         /* video overlay */
 167         struct videobuf_queue    vbi;
 168         int                      lines;
 169 };
 170
 171 /* ---------------------------------------------------------- */
 172 /* bttv-risc.c                                                */
 173
 174 /* risc code generators - capture */
 175 int bttv_risc_packed(struct bttv *btv, struct btcx_riscmem *risc,
 176                      struct scatterlist *sglist,
 177                      unsigned int offset, unsigned int bpl,
 178                      unsigned int pitch, unsigned int lines);
 179
 180 /* control dma register + risc main loop */
 181 void bttv_set_dma(struct bttv *btv, int override);
 182 int bttv_risc_init_main(struct bttv *btv);
 183 int bttv_risc_hook(struct bttv *btv, int slot, struct btcx_riscmem *risc,
 184                    int irqflags);
 185
 186 /* capture buffer handling */
 187 int bttv_buffer_risc(struct bttv *btv, struct bttv_buffer *buf);
 188 int bttv_buffer_activate_video(struct bttv *btv,
 189                                struct bttv_buffer_set *set);
 190 int bttv_buffer_activate_vbi(struct bttv *btv,
 191                              struct bttv_buffer *vbi);
 192 void bttv_dma_free(struct bttv *btv, struct bttv_buffer *buf);
 193
 194 /* overlay handling */
 195 int bttv_overlay_risc(struct bttv *btv, struct bttv_overlay *ov,
 196                       const struct bttv_format *fmt,
 197                       struct bttv_buffer *buf);
 198
 199
 200 /* ---------------------------------------------------------- */
 201 /* bttv-vbi.c                                                 */
 202
 203 void bttv_vbi_try_fmt(struct bttv_fh *fh, struct v4l2_format *f);
 204 void bttv_vbi_get_fmt(struct bttv_fh *fh, struct v4l2_format *f);
 205 void bttv_vbi_setlines(struct bttv_fh *fh, struct bttv *btv, int lines);
 206
 207 extern struct videobuf_queue_ops bttv_vbi_qops;
 208
 209 /* ---------------------------------------------------------- */
 210 /* bttv-gpio.c */
 211
 212
 213 extern struct bus_type bttv_sub_bus_type;
 214 int bttv_sub_add_device(struct bttv_core *core, char *name);
 215 int bttv_sub_del_devices(struct bttv_core *core);
 216 void bttv_gpio_irq(struct bttv_core *core);
 217
 218
 219 /* ---------------------------------------------------------- */
 220 /* bttv-driver.c                                              */
 221
 222 /* insmod options */
 223 extern unsigned int bttv_verbose;
 224 extern unsigned int bttv_debug;
 225 extern unsigned int bttv_gpio;
 226 extern void bttv_gpio_tracking(struct bttv *btv, char *comment);
 227 extern int init_bttv_i2c(struct bttv *btv);
 228 extern int fini_bttv_i2c(struct bttv *btv);
 229
 230 #define bttv_printk if (bttv_verbose) printk
 231 #define dprintk  if (bttv_debug >= 1) printk
 232 #define d2printk if (bttv_debug >= 2) printk
 233
 234 #define BTTV_MAX_FBUF   0x208000
 235 #define VBIBUF_SIZE     (2048*VBI_MAXLINES*2)
 236 #define BTTV_TIMEOUT    (HZ/2) /* 0.5 seconds */
 237 #define BTTV_FREE_IDLE  (HZ)   /* one second */
 238
 239
 240 struct bttv_pll_info {
 241         unsigned int pll_ifreq;    /* PLL input frequency        */
 242         unsigned int pll_ofreq;    /* PLL output frequency       */
 243         unsigned int pll_crystal;  /* Crystal used for input     */
 244         unsigned int pll_current;  /* Currently programmed ofreq */
 245 };
 246
 247 /* for gpio-connected remote control */
 248 struct bttv_input {
 249         struct input_dev      *dev;
 250         struct ir_input_state ir;
 251         char                  name[32];
 252         char                  phys[32];
 253         u32                   mask_keycode;
 254         u32                   mask_keydown;
 255 };
 256
 257 struct bttv_suspend_state {
 258         u32  gpio_enable;
 259         u32  gpio_data;
 260         int  disabled;
 261         int  loop_irq;
 262         struct bttv_buffer_set video;
 263         struct bttv_buffer     *vbi;
 264 };
 265
 266 struct bttv {
 267         struct bttv_core c;
 268
 269         /* pci device config */
 270         unsigned short id;
 271         unsigned char revision;
 272         unsigned char __iomem *bt848_mmio;   /* pointer to mmio */
 273
 274         /* card configuration info */
 275         unsigned int cardid;   /* pci subsystem id (bt878 based ones) */
 276         unsigned int tuner_type;  /* tuner chip type */
 277         unsigned int tda9887_conf;
 278         unsigned int svhs;
 279         struct bttv_pll_info pll;
 280         int triton1;
 281         int gpioirq;
 282         int (*custom_irq)(struct bttv *btv);
 283
 284         int use_i2c_hw;
 285
 286         /* old gpio interface */
 287         wait_queue_head_t gpioq;
 288         int shutdown;
 289         void (*audio_hook)(struct bttv *btv, struct video_audio *v, int set);
 290
 291         /* new gpio interface */
 292         spinlock_t gpio_lock;
 293
 294         /* i2c layer */
 295         struct i2c_algo_bit_data   i2c_algo;
 296         struct i2c_client          i2c_client;
 297         int                        i2c_state, i2c_rc;
 298         int                        i2c_done;
 299         wait_queue_head_t          i2c_queue;
 300
 301         /* video4linux (1) */
 302         struct video_device *video_dev;
 303         struct video_device *radio_dev;
 304         struct video_device *vbi_dev;
 305
 306         /* infrared remote */
 307         int has_remote;
 308         struct bttv_ir *remote;
 309
 310         /* locking */
 311         spinlock_t s_lock;
 312         struct semaphore lock;
 313         int resources;
 314         struct semaphore reslock;
 315 #ifdef VIDIOC_G_PRIORITY
 316         struct v4l2_prio_state prio;
 317 #endif
 318
 319         /* video state */
 320         unsigned int input;
 321         unsigned int audio;
 322         unsigned long freq;
 323         int tvnorm,hue,contrast,bright,saturation;
 324         struct v4l2_framebuffer fbuf;
 325         unsigned int field_count;
 326
 327         /* various options */
 328         int opt_combfilter;
 329         int opt_lumafilter;
 330         int opt_automute;
 331         int opt_chroma_agc;
 332         int opt_adc_crush;
 333         int opt_vcr_hack;
 334         int opt_whitecrush_upper;
 335         int opt_whitecrush_lower;
 336         int opt_uv_ratio;
 337         int opt_full_luma_range;
 338         int opt_coring;
 339
 340         /* radio data/state */
 341         int has_radio;
 342         int radio_user;
 343
 344         /* miro/pinnacle + Aimslab VHX
 345            philips matchbox (tea5757 radio tuner) support */
 346         int has_matchbox;
 347         int mbox_we;
 348         int mbox_data;
 349         int mbox_clk;
 350         int mbox_most;
 351         int mbox_mask;
 352
 353         /* ISA stuff (Terratec Active Radio Upgrade) */
 354         int mbox_ior;
 355         int mbox_iow;
 356         int mbox_csel;
 357
 358         /* risc memory management data
 359            - must aquire s_lock before changing these
 360            - only the irq handler is supported to touch top + bottom + vcurr */
 361         struct btcx_riscmem     main;
 362         struct bttv_buffer      *screen;    /* overlay             */
 363         struct list_head        capture;    /* video capture queue */
 364         struct list_head        vcapture;   /* vbi capture queue   */
 365         struct bttv_buffer_set  curr;       /* active buffers      */
 366         struct bttv_buffer      *cvbi;      /* active vbi buffer   */
 367         int                     loop_irq;
 368         int                     new_input;
 369
 370         unsigned long cap_ctl;
 371         unsigned long dma_on;
 372         struct timer_list timeout;
 373         struct bttv_suspend_state state;
 374
 375         /* stats */
 376         unsigned int errors;
 377         unsigned int framedrop;
 378         unsigned int irq_total;
 379         unsigned int irq_me;
 380
 381         unsigned int users;
 382         struct bttv_fh init;
 383 };
 384
 385 /* our devices */
 386 #define BTTV_MAX 16
 387 extern unsigned int bttv_num;
 388 extern struct bttv bttvs[BTTV_MAX];
 389
 390 /* private ioctls */
 391 #define BTTV_VERSION            _IOR('v' , BASE_VIDIOCPRIVATE+6, int)
 392 #define BTTV_VBISIZE            _IOR('v' , BASE_VIDIOCPRIVATE+8, int)
 393
 394 #endif
 395
 396 #define btwrite(dat,adr)    writel((dat), btv->bt848_mmio+(adr))
 397 #define btread(adr)         readl(btv->bt848_mmio+(adr))
 398
 399 #define btand(dat,adr)      btwrite((dat) & btread(adr), adr)
 400 #define btor(dat,adr)       btwrite((dat) | btread(adr), adr)
 401 #define btaor(dat,mask,adr) btwrite((dat) | ((mask) & btread(adr)), adr)
 402
 403 #endif /* _BTTVP_H_ */
 404
 405 /*
 406  * Local variables:
 407  * c-basic-offset: 8
 408  * End:
 409  */