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