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
  89 struct 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 };
 111 extern const struct bttv_tvnorm bttv_tvnorms[];
 112
 113 struct 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
 125 struct bttv_geometry {
 126         u8  vtc,crop,comb;
 127         u16 width,hscale,hdelay;
 128         u16 sheight,vscale,vdelay,vtotal;
 129 };
 130
 131 struct 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         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
 148 struct 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
 155 struct bttv_overlay {
 156         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
 164 struct 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 */
 176 void bttv_vbi_fmt_reset(struct bttv_vbi_fmt *f, int norm);
 177
 178 struct 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
 192 struct 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 */
 225 int 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 */
 232 void bttv_set_dma(struct bttv *btv, int override);
 233 int bttv_risc_init_main(struct bttv *btv);
 234 int bttv_risc_hook(struct bttv *btv, int slot, struct btcx_riscmem *risc,
 235                    int irqflags);
 236
 237 /* capture buffer handling */
 238 int bttv_buffer_risc(struct bttv *btv, struct bttv_buffer *buf);
 239 int bttv_buffer_activate_video(struct bttv *btv,
 240                                struct bttv_buffer_set *set);
 241 int bttv_buffer_activate_vbi(struct bttv *btv,
 242                              struct bttv_buffer *vbi);
 243 void bttv_dma_free(struct videobuf_queue *q, struct bttv *btv,
 244                    struct bttv_buffer *buf);
 245
 246 /* overlay handling */
 247 int 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
 255 int bttv_vbi_try_fmt(struct bttv_fh *fh, struct v4l2_vbi_format *f);
 256 void bttv_vbi_get_fmt(struct bttv_fh *fh, struct v4l2_vbi_format *f);
 257 int bttv_vbi_set_fmt(struct bttv_fh *fh, struct v4l2_vbi_format *f);
 258
 259 extern struct videobuf_queue_ops bttv_vbi_qops;
 260
 261 /* ---------------------------------------------------------- */
 262 /* bttv-gpio.c */
 263
 264
 265 extern struct bus_type bttv_sub_bus_type;
 266 int bttv_sub_add_device(struct bttv_core *core, char *name);
 267 int bttv_sub_del_devices(struct bttv_core *core);
 268
 269
 270 /* ---------------------------------------------------------- */
 271 /* bttv-driver.c                                              */
 272
 273 /* insmod options */
 274 extern unsigned int bttv_verbose;
 275 extern unsigned int bttv_debug;
 276 extern unsigned int bttv_gpio;
 277 extern void bttv_gpio_tracking(struct bttv *btv, char *comment);
 278 extern int init_bttv_i2c(struct bttv *btv);
 279 extern int fini_bttv_i2c(struct bttv *btv);
 280
 281 #define bttv_printk if (bttv_verbose) printk
 282 #define dprintk  if (bttv_debug >= 1) printk
 283 #define d2printk if (bttv_debug >= 2) printk
 284
 285 #define BTTV_MAX_FBUF   0x208000
 286 #define BTTV_TIMEOUT    msecs_to_jiffies(500)    /* 0.5 seconds */
 287 #define BTTV_FREE_IDLE  msecs_to_jiffies(1000)   /* one second */
 288
 289
 290 struct bttv_pll_info {
 291         unsigned int pll_ifreq;    /* PLL input frequency        */
 292         unsigned int pll_ofreq;    /* PLL output frequency       */
 293         unsigned int pll_crystal;  /* Crystal used for input     */
 294         unsigned int pll_current;  /* Currently programmed ofreq */
 295 };
 296
 297 /* for gpio-connected remote control */
 298 struct bttv_input {
 299         struct input_dev      *dev;
 300         struct ir_input_state ir;
 301         char                  name[32];
 302         char                  phys[32];
 303         u32                   mask_keycode;
 304         u32                   mask_keydown;
 305 };
 306
 307 struct bttv_suspend_state {
 308         u32  gpio_enable;
 309         u32  gpio_data;
 310         int  disabled;
 311         int  loop_irq;
 312         struct bttv_buffer_set video;
 313         struct bttv_buffer     *vbi;
 314 };
 315
 316 struct bttv {
 317         struct bttv_core c;
 318
 319         /* pci device config */
 320         unsigned short id;
 321         unsigned char revision;
 322         unsigned char __iomem *bt848_mmio;   /* pointer to mmio */
 323
 324         /* card configuration info */
 325         unsigned int cardid;   /* pci subsystem id (bt878 based ones) */
 326         unsigned int tuner_type;  /* tuner chip type */
 327         unsigned int tda9887_conf;
 328         unsigned int svhs;
 329         struct bttv_pll_info pll;
 330         int triton1;
 331         int gpioirq;
 332         int (*custom_irq)(struct bttv *btv);
 333
 334         int use_i2c_hw;
 335
 336         /* old gpio interface */
 337         wait_queue_head_t gpioq;
 338         int shutdown;
 339
 340         void (*volume_gpio)(struct bttv *btv, __u16 volume);
 341         void (*audio_mode_gpio)(struct bttv *btv, struct v4l2_tuner *tuner, int set);
 342
 343         /* new gpio interface */
 344         spinlock_t gpio_lock;
 345
 346         /* i2c layer */
 347         struct i2c_algo_bit_data   i2c_algo;
 348         struct i2c_client          i2c_client;
 349         int                        i2c_state, i2c_rc;
 350         int                        i2c_done;
 351         wait_queue_head_t          i2c_queue;
 352         struct i2c_client         *i2c_msp34xx_client;
 353         struct i2c_client         *i2c_tvaudio_client;
 354
 355         /* video4linux (1) */
 356         struct video_device *video_dev;
 357         struct video_device *radio_dev;
 358         struct video_device *vbi_dev;
 359
 360         /* infrared remote */
 361         int has_remote;
 362         struct card_ir *remote;
 363
 364         /* locking */
 365         spinlock_t s_lock;
 366         struct mutex lock;
 367         int resources;
 368 #ifdef VIDIOC_G_PRIORITY
 369         struct v4l2_prio_state prio;
 370 #endif
 371
 372         /* video state */
 373         unsigned int input;
 374         unsigned int audio;
 375         unsigned int mute;
 376         unsigned long freq;
 377         int tvnorm,hue,contrast,bright,saturation;
 378         struct v4l2_framebuffer fbuf;
 379         unsigned int field_count;
 380
 381         /* various options */
 382         int opt_combfilter;
 383         int opt_lumafilter;
 384         int opt_automute;
 385         int opt_chroma_agc;
 386         int opt_adc_crush;
 387         int opt_vcr_hack;
 388         int opt_whitecrush_upper;
 389         int opt_whitecrush_lower;
 390         int opt_uv_ratio;
 391         int opt_full_luma_range;
 392         int opt_coring;
 393
 394         /* radio data/state */
 395         int has_radio;
 396         int radio_user;
 397
 398         /* miro/pinnacle + Aimslab VHX
 399            philips matchbox (tea5757 radio tuner) support */
 400         int has_matchbox;
 401         int mbox_we;
 402         int mbox_data;
 403         int mbox_clk;
 404         int mbox_most;
 405         int mbox_mask;
 406
 407         /* ISA stuff (Terratec Active Radio Upgrade) */
 408         int mbox_ior;
 409         int mbox_iow;
 410         int mbox_csel;
 411
 412         /* risc memory management data
 413            - must acquire s_lock before changing these
 414            - only the irq handler is supported to touch top + bottom + vcurr */
 415         struct btcx_riscmem     main;
 416         struct bttv_buffer      *screen;    /* overlay             */
 417         struct list_head        capture;    /* video capture queue */
 418         struct list_head        vcapture;   /* vbi capture queue   */
 419         struct bttv_buffer_set  curr;       /* active buffers      */
 420         struct bttv_buffer      *cvbi;      /* active vbi buffer   */
 421         int                     loop_irq;
 422         int                     new_input;
 423
 424         unsigned long cap_ctl;
 425         unsigned long dma_on;
 426         struct timer_list timeout;
 427         struct bttv_suspend_state state;
 428
 429         /* stats */
 430         unsigned int errors;
 431         unsigned int framedrop;
 432         unsigned int irq_total;
 433         unsigned int irq_me;
 434
 435         unsigned int users;
 436         struct bttv_fh init;
 437
 438         /* used to make dvb-bt8xx autoloadable */
 439         struct work_struct request_module_wk;
 440
 441         /* Default (0) and current (1) video capturing and overlay
 442            cropping parameters in bttv_tvnorm.cropcap units. Protected
 443            by bttv.lock. */
 444         struct bttv_crop crop[2];
 445
 446         /* Earliest possible start of video capturing in
 447            bttv_tvnorm.cropcap line units. Set by check_alloc_btres()
 448            and free_btres(). Protected by bttv.lock. */
 449         __s32                   vbi_end;
 450
 451         /* Latest possible end of VBI capturing (= crop[x].rect.top when
 452            VIDEO_RESOURCES are locked). Set by check_alloc_btres()
 453            and free_btres(). Protected by bttv.lock. */
 454         __s32                   crop_start;
 455 };
 456
 457 /* our devices */
 458 #define BTTV_MAX 16
 459 extern unsigned int bttv_num;
 460 extern struct bttv bttvs[BTTV_MAX];
 461
 462 #endif
 463
 464 #define btwrite(dat,adr)    writel((dat), btv->bt848_mmio+(adr))
 465 #define btread(adr)         readl(btv->bt848_mmio+(adr))
 466
 467 #define btand(dat,adr)      btwrite((dat) & btread(adr), adr)
 468 #define btor(dat,adr)       btwrite((dat) | btread(adr), adr)
 469 #define btaor(dat,mask,adr) btwrite((dat) | ((mask) & btread(adr)), adr)
 470
 471 #endif /* _BTTVP_H_ */
 472
 473 /*
 474  * Local variables:
 475  * c-basic-offset: 8
 476  * End:
 477  */