drivers/media/video/bttvp.h

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