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