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