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