drivers/media/video/bt8xx/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,17)
  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 <linux/mutex.h>
  39 #include <linux/scatterlist.h>
  40 #include <asm/io.h>
  41 #include <media/v4l2-common.h>
  42
  43 #include <linux/device.h>
  44 #include <media/videobuf-dma-sg.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_STREAM  2
  69 #define RESOURCE_VBI           4
  70 #define RESOURCE_VIDEO_READ    8
  71
  72 #define RAW_LINES            640
  73 #define RAW_BPL             1024
  74
  75 #define UNSET (-1U)
  76
  77 /* Min. value in VDELAY register. */
  78 #define MIN_VDELAY 2
  79 /* Even to get Cb first, odd for Cr. */
  80 #define MAX_HDELAY (0x3FF & -2)
  81 /* Limits scaled width, which must be a multiple of 4. */
  82 #define MAX_HACTIVE (0x3FF & -4)
  83
  84 #define BTTV_NORMS    (\
  85                 V4L2_STD_PAL    | V4L2_STD_PAL_N | \
  86                 V4L2_STD_PAL_Nc | V4L2_STD_SECAM | \
  87                 V4L2_STD_NTSC   | V4L2_STD_PAL_M | \
  88                 V4L2_STD_PAL_60)
  89 /* ---------------------------------------------------------- */
  90
  91 struct bttv_tvnorm {
  92         int   v4l2_id;
  93         char  *name;
  94         u32   Fsc;
  95         u16   swidth, sheight; /* scaled standard width, height */
  96         u16   totalwidth;
  97         u8    adelay, bdelay, iform;
  98         u32   scaledtwidth;
  99         u16   hdelayx1, hactivex1;
 100         u16   vdelay;
 101         u8    vbipack;
 102         u16   vtotal;
 103         int   sram;
 104         /* ITU-R frame line number of the first VBI line we can
 105            capture, of the first and second field. The last possible line
 106            is determined by cropcap.bounds. */
 107         u16   vbistart[2];
 108         /* Horizontally this counts fCLKx1 samples following the leading
 109            edge of the horizontal sync pulse, vertically ITU-R frame line
 110            numbers of the first field times two (2, 4, 6, ... 524 or 624). */
 111         struct v4l2_cropcap cropcap;
 112 };
 113 extern const struct bttv_tvnorm bttv_tvnorms[];
 114
 115 struct bttv_format {
 116         char *name;
 117         int  fourcc;          /* video4linux 2      */
 118         int  btformat;        /* BT848_COLOR_FMT_*  */
 119         int  btswap;          /* BT848_COLOR_CTL_*  */
 120         int  depth;           /* bit/pixel          */
 121         int  flags;
 122         int  hshift,vshift;   /* for planar modes   */
 123 };
 124
 125 /* ---------------------------------------------------------- */
 126
 127 struct bttv_geometry {
 128         u8  vtc,crop,comb;
 129         u16 width,hscale,hdelay;
 130         u16 sheight,vscale,vdelay,vtotal;
 131 };
 132
 133 struct bttv_buffer {
 134         /* common v4l buffer stuff -- must be first */
 135         struct videobuf_buffer     vb;
 136
 137         /* bttv specific */
 138         const struct bttv_format   *fmt;
 139         int                        tvnorm;
 140         int                        btformat;
 141         int                        btswap;
 142         struct bttv_geometry       geo;
 143         struct btcx_riscmem        top;
 144         struct btcx_riscmem        bottom;
 145         struct v4l2_rect           crop;
 146         unsigned int               vbi_skip[2];
 147         unsigned int               vbi_count[2];
 148 };
 149
 150 struct bttv_buffer_set {
 151         struct bttv_buffer     *top;       /* top field buffer    */
 152         struct bttv_buffer     *bottom;    /* bottom field buffer */
 153         unsigned int           top_irq;
 154         unsigned int           frame_irq;
 155 };
 156
 157 struct bttv_overlay {
 158         int                    tvnorm;
 159         struct v4l2_rect       w;
 160         enum v4l2_field        field;
 161         struct v4l2_clip       *clips;
 162         int                    nclips;
 163         int                    setup_ok;
 164 };
 165
 166 struct bttv_vbi_fmt {
 167         struct v4l2_vbi_format fmt;
 168
 169         /* fmt.start[] and count[] refer to this video standard. */
 170         const struct bttv_tvnorm *tvnorm;
 171
 172         /* Earliest possible start of video capturing with this
 173            v4l2_vbi_format, in struct bttv_crop.rect units. */
 174         __s32                  end;
 175 };
 176
 177 /* bttv-vbi.c */
 178 void bttv_vbi_fmt_reset(struct bttv_vbi_fmt *f, int norm);
 179
 180 struct bttv_crop {
 181         /* A cropping rectangle in struct bttv_tvnorm.cropcap units. */
 182         struct v4l2_rect       rect;
 183
 184         /* Scaled image size limits with this crop rect. Divide
 185            max_height, but not min_height, by two when capturing
 186            single fields. See also bttv_crop_reset() and
 187            bttv_crop_adjust() in bttv-driver.c. */
 188         __s32                  min_scaled_width;
 189         __s32                  min_scaled_height;
 190         __s32                  max_scaled_width;
 191         __s32                  max_scaled_height;
 192 };
 193
 194 struct bttv_fh {
 195         struct bttv              *btv;
 196         int resources;
 197 #ifdef VIDIOC_G_PRIORITY
 198         enum v4l2_priority       prio;
 199 #endif
 200         enum v4l2_buf_type       type;
 201
 202         /* video capture */
 203         struct videobuf_queue    cap;
 204         const struct bttv_format *fmt;
 205         int                      width;
 206         int                      height;
 207
 208         /* video overlay */
 209         const struct bttv_format *ovfmt;
 210         struct bttv_overlay      ov;
 211
 212         /* Application called VIDIOC_S_CROP. */
 213         int                      do_crop;
 214
 215         /* vbi capture */
 216         struct videobuf_queue    vbi;
 217         /* Current VBI capture window as seen through this fh (cannot
 218            be global for compatibility with earlier drivers). Protected
 219            by struct bttv.lock and struct bttv_fh.vbi.lock. */
 220         struct bttv_vbi_fmt      vbi_fmt;
 221 };
 222
 223 /* ---------------------------------------------------------- */
 224 /* bttv-risc.c                                                */
 225
 226 /* risc code generators - capture */
 227 int bttv_risc_packed(struct bttv *btv, struct btcx_riscmem *risc,
 228                      struct scatterlist *sglist,
 229                      unsigned int offset, unsigned int bpl,
 230                      unsigned int pitch, unsigned int skip_lines,
 231                      unsigned int store_lines);
 232
 233 /* control dma register + risc main loop */
 234 void bttv_set_dma(struct bttv *btv, int override);
 235 int bttv_risc_init_main(struct bttv *btv);
 236 int bttv_risc_hook(struct bttv *btv, int slot, struct btcx_riscmem *risc,
 237                    int irqflags);
 238
 239 /* capture buffer handling */
 240 int bttv_buffer_risc(struct bttv *btv, struct bttv_buffer *buf);
 241 int bttv_buffer_activate_video(struct bttv *btv,
 242                                struct bttv_buffer_set *set);
 243 int bttv_buffer_activate_vbi(struct bttv *btv,
 244                              struct bttv_buffer *vbi);
 245 void bttv_dma_free(struct videobuf_queue *q, struct bttv *btv,
 246                    struct bttv_buffer *buf);
 247
 248 /* overlay handling */
 249 int bttv_overlay_risc(struct bttv *btv, struct bttv_overlay *ov,
 250                       const struct bttv_format *fmt,
 251                       struct bttv_buffer *buf);
 252
 253
 254 /* ---------------------------------------------------------- */
 255 /* bttv-vbi.c                                                 */
 256
 257 int bttv_try_fmt_vbi(struct file *file, void *fh, struct v4l2_format *f);
 258 int bttv_g_fmt_vbi(struct file *file, void *fh, struct v4l2_format *f);
 259 int bttv_s_fmt_vbi(struct file *file, void *fh, struct v4l2_format *f);
 260
 261 extern struct videobuf_queue_ops bttv_vbi_qops;
 262
 263 /* ---------------------------------------------------------- */
 264 /* bttv-gpio.c */
 265
 266
 267 extern struct bus_type bttv_sub_bus_type;
 268 int bttv_sub_add_device(struct bttv_core *core, char *name);
 269 int bttv_sub_del_devices(struct bttv_core *core);
 270
 271
 272 /* ---------------------------------------------------------- */
 273 /* bttv-driver.c                                              */
 274
 275 /* insmod options */
 276 extern unsigned int bttv_verbose;
 277 extern unsigned int bttv_debug;
 278 extern unsigned int bttv_gpio;
 279 extern void bttv_gpio_tracking(struct bttv *btv, char *comment);
 280 extern int init_bttv_i2c(struct bttv *btv);
 281 extern int fini_bttv_i2c(struct bttv *btv);
 282
 283 #define bttv_printk if (bttv_verbose) printk
 284 #define dprintk  if (bttv_debug >= 1) printk
 285 #define d2printk if (bttv_debug >= 2) printk
 286
 287 #define BTTV_MAX_FBUF   0x208000
 288 #define BTTV_TIMEOUT    msecs_to_jiffies(500)    /* 0.5 seconds */
 289 #define BTTV_FREE_IDLE  msecs_to_jiffies(1000)   /* one second */
 290
 291
 292 struct bttv_pll_info {
 293         unsigned int pll_ifreq;    /* PLL input frequency        */
 294         unsigned int pll_ofreq;    /* PLL output frequency       */
 295         unsigned int pll_crystal;  /* Crystal used for input     */
 296         unsigned int pll_current;  /* Currently programmed ofreq */
 297 };
 298
 299 /* for gpio-connected remote control */
 300 struct bttv_input {
 301         struct input_dev      *dev;
 302         struct ir_input_state ir;
 303         char                  name[32];
 304         char                  phys[32];
 305         u32                   mask_keycode;
 306         u32                   mask_keydown;
 307 };
 308
 309 struct bttv_suspend_state {
 310         u32  gpio_enable;
 311         u32  gpio_data;
 312         int  disabled;
 313         int  loop_irq;
 314         struct bttv_buffer_set video;
 315         struct bttv_buffer     *vbi;
 316 };
 317
 318 struct bttv {
 319         struct bttv_core c;
 320
 321         /* pci device config */
 322         unsigned short id;
 323         unsigned char revision;
 324         unsigned char __iomem *bt848_mmio;   /* pointer to mmio */
 325
 326         /* card configuration info */
 327         unsigned int cardid;   /* pci subsystem id (bt878 based ones) */
 328         unsigned int tuner_type;  /* tuner chip type */
 329         unsigned int tda9887_conf;
 330         unsigned int svhs;
 331         struct bttv_pll_info pll;
 332         int triton1;
 333         int gpioirq;
 334         int (*custom_irq)(struct bttv *btv);
 335
 336         int use_i2c_hw;
 337
 338         /* old gpio interface */
 339         wait_queue_head_t gpioq;
 340         int shutdown;
 341
 342         void (*volume_gpio)(struct bttv *btv, __u16 volume);
 343         void (*audio_mode_gpio)(struct bttv *btv, struct v4l2_tuner *tuner, int set);
 344
 345         /* new gpio interface */
 346         spinlock_t gpio_lock;
 347
 348         /* i2c layer */
 349         struct i2c_algo_bit_data   i2c_algo;
 350         struct i2c_client          i2c_client;
 351         int                        i2c_state, i2c_rc;
 352         int                        i2c_done;
 353         wait_queue_head_t          i2c_queue;
 354         struct i2c_client         *i2c_msp34xx_client;
 355         struct i2c_client         *i2c_tvaudio_client;
 356
 357         /* video4linux (1) */
 358         struct video_device *video_dev;
 359         struct video_device *radio_dev;
 360         struct video_device *vbi_dev;
 361
 362         /* infrared remote */
 363         int has_remote;
 364         struct card_ir *remote;
 365
 366         /* locking */
 367         spinlock_t s_lock;
 368         struct mutex lock;
 369         int resources;
 370 #ifdef VIDIOC_G_PRIORITY
 371         struct v4l2_prio_state prio;
 372 #endif
 373
 374         /* video state */
 375         unsigned int input;
 376         unsigned int audio;
 377         unsigned int mute;
 378         unsigned long freq;
 379         int tvnorm,hue,contrast,bright,saturation;
 380         struct v4l2_framebuffer fbuf;
 381         unsigned int field_count;
 382
 383         /* various options */
 384         int opt_combfilter;
 385         int opt_lumafilter;
 386         int opt_automute;
 387         int opt_chroma_agc;
 388         int opt_adc_crush;
 389         int opt_vcr_hack;
 390         int opt_whitecrush_upper;
 391         int opt_whitecrush_lower;
 392         int opt_uv_ratio;
 393         int opt_full_luma_range;
 394         int opt_coring;
 395
 396         /* radio data/state */
 397         int has_radio;
 398         int radio_user;
 399
 400         /* miro/pinnacle + Aimslab VHX
 401            philips matchbox (tea5757 radio tuner) support */
 402         int has_matchbox;
 403         int mbox_we;
 404         int mbox_data;
 405         int mbox_clk;
 406         int mbox_most;
 407         int mbox_mask;
 408
 409         /* ISA stuff (Terratec Active Radio Upgrade) */
 410         int mbox_ior;
 411         int mbox_iow;
 412         int mbox_csel;
 413
 414         /* risc memory management data
 415            - must acquire s_lock before changing these
 416            - only the irq handler is supported to touch top + bottom + vcurr */
 417         struct btcx_riscmem     main;
 418         struct bttv_buffer      *screen;    /* overlay             */
 419         struct list_head        capture;    /* video capture queue */
 420         struct list_head        vcapture;   /* vbi capture queue   */
 421         struct bttv_buffer_set  curr;       /* active buffers      */
 422         struct bttv_buffer      *cvbi;      /* active vbi buffer   */
 423         int                     loop_irq;
 424         int                     new_input;
 425
 426         unsigned long cap_ctl;
 427         unsigned long dma_on;
 428         struct timer_list timeout;
 429         struct bttv_suspend_state state;
 430
 431         /* stats */
 432         unsigned int errors;
 433         unsigned int framedrop;
 434         unsigned int irq_total;
 435         unsigned int irq_me;
 436
 437         unsigned int users;
 438         struct bttv_fh init;
 439
 440         /* used to make dvb-bt8xx autoloadable */
 441         struct work_struct request_module_wk;
 442
 443         /* Default (0) and current (1) video capturing and overlay
 444            cropping parameters in bttv_tvnorm.cropcap units. Protected
 445            by bttv.lock. */
 446         struct bttv_crop crop[2];
 447
 448         /* Earliest possible start of video capturing in
 449            bttv_tvnorm.cropcap line units. Set by check_alloc_btres()
 450            and free_btres(). Protected by bttv.lock. */
 451         __s32                   vbi_end;
 452
 453         /* Latest possible end of VBI capturing (= crop[x].rect.top when
 454            VIDEO_RESOURCES are locked). Set by check_alloc_btres()
 455            and free_btres(). Protected by bttv.lock. */
 456         __s32                   crop_start;
 457 };
 458
 459 /* our devices */
 460 #define BTTV_MAX 16
 461 extern unsigned int bttv_num;
 462 extern struct bttv bttvs[BTTV_MAX];
 463
 464 #endif
 465
 466 #define btwrite(dat,adr)    writel((dat), btv->bt848_mmio+(adr))
 467 #define btread(adr)         readl(btv->bt848_mmio+(adr))
 468
 469 #define btand(dat,adr)      btwrite((dat) & btread(adr), adr)
 470 #define btor(dat,adr)       btwrite((dat) | btread(adr), adr)
 471 #define btaor(dat,mask,adr) btwrite((dat) | ((mask) & btread(adr)), adr)
 472
 473 #endif /* _BTTVP_H_ */
 474
 475 /*
 476  * Local variables:
 477  * c-basic-offset: 8
 478  * End:
 479  */