drivers/media/video/cx88/cx88.h

   1 /*
   2  * $Id: cx88.h,v 1.70 2005/07/24 17:44:09 mkrufky Exp $
   3  *
   4  * v4l2 device driver for cx2388x based TV cards
   5  *
   6  * (c) 2003,04 Gerd Knorr <kraxel@bytesex.org> [SUSE Labs]
   7  *
   8  *  This program is free software; you can redistribute it and/or modify
   9  *  it under the terms of the GNU General Public License as published by
  10  *  the Free Software Foundation; either version 2 of the License, or
  11  *  (at your option) any later version.
  12  *
  13  *  This program is distributed in the hope that it will be useful,
  14  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  *  GNU General Public License for more details.
  17  *
  18  *  You should have received a copy of the GNU General Public License
  19  *  along with this program; if not, write to the Free Software
  20  *  Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  21  */
  22
  23 #include <linux/pci.h>
  24 #include <linux/i2c.h>
  25 #include <linux/i2c-algo-bit.h>
  26 #include <linux/videodev.h>
  27 #include <linux/kdev_t.h>
  28
  29 #include <media/tuner.h>
  30 #include <media/tveeprom.h>
  31 #include <media/audiochip.h>
  32 #include <media/video-buf.h>
  33 #include <media/video-buf-dvb.h>
  34
  35 #include "btcx-risc.h"
  36 #include "cx88-reg.h"
  37
  38 #include <linux/utsname.h>
  39 #define CX88_VERSION_CODE KERNEL_VERSION(0,0,5)
  40
  41 #ifndef TRUE
  42 # define TRUE (1==1)
  43 #endif
  44 #ifndef FALSE
  45 # define FALSE (1==0)
  46 #endif
  47 #define UNSET (-1U)
  48
  49 #define CX88_MAXBOARDS 8
  50
  51 /* ----------------------------------------------------------- */
  52 /* defines and enums                                           */
  53
  54 #define FORMAT_FLAGS_PACKED       0x01
  55 #define FORMAT_FLAGS_PLANAR       0x02
  56
  57 #define VBI_LINE_COUNT              17
  58 #define VBI_LINE_LENGTH           2048
  59
  60 /* need "shadow" registers for some write-only ones ... */
  61 #define SHADOW_AUD_VOL_CTL           1
  62 #define SHADOW_AUD_BAL_CTL           2
  63 #define SHADOW_MAX                   2
  64
  65 /* FM Radio deemphasis type */
  66 enum cx88_deemph_type {
  67         FM_NO_DEEMPH = 0,
  68         FM_DEEMPH_50,
  69         FM_DEEMPH_75
  70 };
  71
  72 /* ----------------------------------------------------------- */
  73 /* tv norms                                                    */
  74
  75 struct cx88_tvnorm {
  76         char                   *name;
  77         v4l2_std_id            id;
  78         u32                    cxiformat;
  79         u32                    cxoformat;
  80 };
  81
  82 static unsigned int inline norm_maxw(struct cx88_tvnorm *norm)
  83 {
  84         return (norm->id & V4L2_STD_625_50) ? 768 : 640;
  85 }
  86
  87
  88 static unsigned int inline norm_maxh(struct cx88_tvnorm *norm)
  89 {
  90         return (norm->id & V4L2_STD_625_50) ? 576 : 480;
  91 }
  92
  93 /* ----------------------------------------------------------- */
  94 /* static data                                                 */
  95
  96 struct cx8800_fmt {
  97         char  *name;
  98         u32   fourcc;          /* v4l2 format id */
  99         int   depth;
 100         int   flags;
 101         u32   cxformat;
 102 };
 103
 104 struct cx88_ctrl {
 105         struct v4l2_queryctrl  v;
 106         u32                    off;
 107         u32                    reg;
 108         u32                    sreg;
 109         u32                    mask;
 110         u32                    shift;
 111 };
 112
 113 /* ----------------------------------------------------------- */
 114 /* SRAM memory management data (see cx88-core.c)               */
 115
 116 #define SRAM_CH21 0   /* video */
 117 #define SRAM_CH22 1
 118 #define SRAM_CH23 2
 119 #define SRAM_CH24 3   /* vbi   */
 120 #define SRAM_CH25 4   /* audio */
 121 #define SRAM_CH26 5
 122 #define SRAM_CH28 6   /* mpeg */
 123 /* more */
 124
 125 struct sram_channel {
 126         char *name;
 127         u32  cmds_start;
 128         u32  ctrl_start;
 129         u32  cdt;
 130         u32  fifo_start;
 131         u32  fifo_size;
 132         u32  ptr1_reg;
 133         u32  ptr2_reg;
 134         u32  cnt1_reg;
 135         u32  cnt2_reg;
 136 };
 137 extern struct sram_channel cx88_sram_channels[];
 138
 139 /* ----------------------------------------------------------- */
 140 /* card configuration                                          */
 141
 142 #define CX88_BOARD_NOAUTO               UNSET
 143 #define CX88_BOARD_UNKNOWN                  0
 144 #define CX88_BOARD_HAUPPAUGE                1
 145 #define CX88_BOARD_GDI                      2
 146 #define CX88_BOARD_PIXELVIEW                3
 147 #define CX88_BOARD_ATI_WONDER_PRO           4
 148 #define CX88_BOARD_WINFAST2000XP_EXPERT     5
 149 #define CX88_BOARD_AVERTV_303               6
 150 #define CX88_BOARD_MSI_TVANYWHERE_MASTER    7
 151 #define CX88_BOARD_WINFAST_DV2000           8
 152 #define CX88_BOARD_LEADTEK_PVR2000          9
 153 #define CX88_BOARD_IODATA_GVVCP3PCI        10
 154 #define CX88_BOARD_PROLINK_PLAYTVPVR       11
 155 #define CX88_BOARD_ASUS_PVR_416            12
 156 #define CX88_BOARD_MSI_TVANYWHERE          13
 157 #define CX88_BOARD_KWORLD_DVB_T            14
 158 #define CX88_BOARD_DVICO_FUSIONHDTV_DVB_T1 15
 159 #define CX88_BOARD_KWORLD_LTV883           16
 160 #define CX88_BOARD_DVICO_FUSIONHDTV_3_GOLD_Q  17
 161 #define CX88_BOARD_HAUPPAUGE_DVB_T1        18
 162 #define CX88_BOARD_CONEXANT_DVB_T1         19
 163 #define CX88_BOARD_PROVIDEO_PV259          20
 164 #define CX88_BOARD_DVICO_FUSIONHDTV_DVB_T_PLUS 21
 165 #define CX88_BOARD_PCHDTV_HD3000           22
 166 #define CX88_BOARD_DNTV_LIVE_DVB_T         23
 167 #define CX88_BOARD_HAUPPAUGE_ROSLYN        24
 168 #define CX88_BOARD_DIGITALLOGIC_MEC        25
 169 #define CX88_BOARD_IODATA_GVBCTV7E         26
 170 #define CX88_BOARD_PIXELVIEW_PLAYTV_ULTRA_PRO 27
 171 #define CX88_BOARD_DVICO_FUSIONHDTV_3_GOLD_T  28
 172 #define CX88_BOARD_ADSTECH_DVB_T_PCI          29
 173 #define CX88_BOARD_TERRATEC_CINERGY_1400_DVB_T1  30
 174 #define CX88_BOARD_DVICO_FUSIONHDTV_5_GOLD 31
 175
 176 enum cx88_itype {
 177         CX88_VMUX_COMPOSITE1 = 1,
 178         CX88_VMUX_COMPOSITE2,
 179         CX88_VMUX_COMPOSITE3,
 180         CX88_VMUX_COMPOSITE4,
 181         CX88_VMUX_SVIDEO,
 182         CX88_VMUX_TELEVISION,
 183         CX88_VMUX_CABLE,
 184         CX88_VMUX_DVB,
 185         CX88_VMUX_DEBUG,
 186         CX88_RADIO,
 187 };
 188
 189 struct cx88_input {
 190         enum cx88_itype type;
 191         unsigned int    vmux;
 192         u32             gpio0, gpio1, gpio2, gpio3;
 193 };
 194
 195 struct cx88_board {
 196         char                    *name;
 197         unsigned int            tuner_type;
 198         unsigned int            radio_type;
 199         unsigned char           tuner_addr;
 200         unsigned char           radio_addr;
 201         int                     tda9887_conf;
 202         struct cx88_input       input[8];
 203         struct cx88_input       radio;
 204         int                     blackbird:1;
 205         int                     dvb:1;
 206 };
 207
 208 struct cx88_subid {
 209         u16     subvendor;
 210         u16     subdevice;
 211         u32     card;
 212 };
 213
 214 #define INPUT(nr) (&cx88_boards[core->board].input[nr])
 215
 216 /* ----------------------------------------------------------- */
 217 /* device / file handle status                                 */
 218
 219 #define RESOURCE_OVERLAY       1
 220 #define RESOURCE_VIDEO         2
 221 #define RESOURCE_VBI           4
 222
 223 #define BUFFER_TIMEOUT     (HZ/2)  /* 0.5 seconds */
 224
 225 /* buffer for one video frame */
 226 struct cx88_buffer {
 227         /* common v4l buffer stuff -- must be first */
 228         struct videobuf_buffer vb;
 229
 230         /* cx88 specific */
 231         unsigned int           bpl;
 232         struct btcx_riscmem    risc;
 233         struct cx8800_fmt      *fmt;
 234         u32                    count;
 235 };
 236
 237 struct cx88_dmaqueue {
 238         struct list_head       active;
 239         struct list_head       queued;
 240         struct timer_list      timeout;
 241         struct btcx_riscmem    stopper;
 242         u32                    count;
 243 };
 244
 245 struct cx88_core {
 246         struct list_head           devlist;
 247         atomic_t                   refcount;
 248
 249         /* board name */
 250         int                        nr;
 251         char                       name[32];
 252
 253         /* pci stuff */
 254         int                        pci_bus;
 255         int                        pci_slot;
 256         u32                        __iomem *lmmio;
 257         u8                         __iomem *bmmio;
 258         u32                        shadow[SHADOW_MAX];
 259         int                        pci_irqmask;
 260
 261         /* i2c i/o */
 262         struct i2c_adapter         i2c_adap;
 263         struct i2c_algo_bit_data   i2c_algo;
 264         struct i2c_client          i2c_client;
 265         u32                        i2c_state, i2c_rc;
 266
 267         /* config info -- analog */
 268         unsigned int               board;
 269         unsigned int               tuner_type;
 270         unsigned int               radio_type;
 271         unsigned char              tuner_addr;
 272         unsigned char              radio_addr;
 273         unsigned int               tda9887_conf;
 274         unsigned int               has_radio;
 275
 276         /* config info -- dvb */
 277         struct dvb_pll_desc        *pll_desc;
 278         unsigned int               pll_addr;
 279
 280         /* state info */
 281         struct task_struct         *kthread;
 282         struct cx88_tvnorm         *tvnorm;
 283         u32                        tvaudio;
 284         u32                        audiomode_manual;
 285         u32                        audiomode_current;
 286         u32                        input;
 287         u32                        astat;
 288
 289         /* IR remote control state */
 290         struct cx88_IR             *ir;
 291 };
 292
 293 struct cx8800_dev;
 294 struct cx8802_dev;
 295
 296 /* ----------------------------------------------------------- */
 297 /* function 0: video stuff                                     */
 298
 299 struct cx8800_fh {
 300         struct cx8800_dev          *dev;
 301         enum v4l2_buf_type         type;
 302         int                        radio;
 303         unsigned int               resources;
 304
 305         /* video overlay */
 306         struct v4l2_window         win;
 307         struct v4l2_clip           *clips;
 308         unsigned int               nclips;
 309
 310         /* video capture */
 311         struct cx8800_fmt          *fmt;
 312         unsigned int               width,height;
 313         struct videobuf_queue      vidq;
 314
 315         /* vbi capture */
 316         struct videobuf_queue      vbiq;
 317 };
 318
 319 struct cx8800_suspend_state {
 320         int                        disabled;
 321 };
 322
 323 struct cx8800_dev {
 324         struct cx88_core           *core;
 325         struct list_head           devlist;
 326         struct semaphore           lock;
 327         spinlock_t                 slock;
 328
 329         /* various device info */
 330         unsigned int               resources;
 331         struct video_device        *video_dev;
 332         struct video_device        *vbi_dev;
 333         struct video_device        *radio_dev;
 334
 335         /* pci i/o */
 336         struct pci_dev             *pci;
 337         unsigned char              pci_rev,pci_lat;
 338
 339
 340         /* capture queues */
 341         struct cx88_dmaqueue       vidq;
 342         struct cx88_dmaqueue       vbiq;
 343
 344         /* various v4l controls */
 345         u32                        freq;
 346
 347         /* other global state info */
 348         struct cx8800_suspend_state state;
 349 };
 350
 351 /* ----------------------------------------------------------- */
 352 /* function 1: audio/alsa stuff                                */
 353
 354 struct cx8801_dev {
 355         struct cx88_core           *core;
 356
 357         /* pci i/o */
 358         struct pci_dev             *pci;
 359         unsigned char              pci_rev,pci_lat;
 360 };
 361
 362 /* ----------------------------------------------------------- */
 363 /* function 2: mpeg stuff                                      */
 364
 365 struct cx8802_fh {
 366         struct cx8802_dev          *dev;
 367         struct videobuf_queue      mpegq;
 368 };
 369
 370 struct cx8802_suspend_state {
 371         int                        disabled;
 372 };
 373
 374 struct cx8802_dev {
 375         struct cx88_core           *core;
 376         struct semaphore           lock;
 377         spinlock_t                 slock;
 378
 379         /* pci i/o */
 380         struct pci_dev             *pci;
 381         unsigned char              pci_rev,pci_lat;
 382
 383         /* dma queues */
 384         struct cx88_dmaqueue       mpegq;
 385         u32                        ts_packet_size;
 386         u32                        ts_packet_count;
 387
 388         /* other global state info */
 389         struct cx8802_suspend_state state;
 390
 391         /* for blackbird only */
 392         struct list_head           devlist;
 393         struct video_device        *mpeg_dev;
 394         u32                        mailbox;
 395         int                        width;
 396         int                        height;
 397
 398         /* for dvb only */
 399         struct videobuf_dvb        dvb;
 400         void*                      fe_handle;
 401         int                        (*fe_release)(void *handle);
 402
 403         /* for switching modulation types */
 404         unsigned char              ts_gen_cntrl;
 405 };
 406
 407 /* ----------------------------------------------------------- */
 408
 409 #define cx_read(reg)             readl(core->lmmio + ((reg)>>2))
 410 #define cx_write(reg,value)      writel((value), core->lmmio + ((reg)>>2))
 411 #define cx_writeb(reg,value)     writeb((value), core->bmmio + (reg))
 412
 413 #define cx_andor(reg,mask,value) \
 414   writel((readl(core->lmmio+((reg)>>2)) & ~(mask)) |\
 415   ((value) & (mask)), core->lmmio+((reg)>>2))
 416 #define cx_set(reg,bit)          cx_andor((reg),(bit),(bit))
 417 #define cx_clear(reg,bit)        cx_andor((reg),(bit),0)
 418
 419 #define cx_wait(d) { if (need_resched()) schedule(); else udelay(d); }
 420
 421 /* shadow registers */
 422 #define cx_sread(sreg)              (core->shadow[sreg])
 423 #define cx_swrite(sreg,reg,value) \
 424   (core->shadow[sreg] = value, \
 425    writel(core->shadow[sreg], core->lmmio + ((reg)>>2)))
 426 #define cx_sandor(sreg,reg,mask,value) \
 427   (core->shadow[sreg] = (core->shadow[sreg] & ~(mask)) | ((value) & (mask)), \
 428    writel(core->shadow[sreg], core->lmmio + ((reg)>>2)))
 429
 430 /* ----------------------------------------------------------- */
 431 /* cx88-core.c                                                 */
 432
 433 extern void cx88_print_irqbits(char *name, char *tag, char **strings,
 434                                u32 bits, u32 mask);
 435 extern void cx88_print_ioctl(char *name, unsigned int cmd);
 436
 437 extern int cx88_core_irq(struct cx88_core *core, u32 status);
 438 extern void cx88_wakeup(struct cx88_core *core,
 439                         struct cx88_dmaqueue *q, u32 count);
 440 extern void cx88_shutdown(struct cx88_core *core);
 441 extern int cx88_reset(struct cx88_core *core);
 442
 443 extern int
 444 cx88_risc_buffer(struct pci_dev *pci, struct btcx_riscmem *risc,
 445                  struct scatterlist *sglist,
 446                  unsigned int top_offset, unsigned int bottom_offset,
 447                  unsigned int bpl, unsigned int padding, unsigned int lines);
 448 extern int
 449 cx88_risc_databuffer(struct pci_dev *pci, struct btcx_riscmem *risc,
 450                      struct scatterlist *sglist, unsigned int bpl,
 451                      unsigned int lines);
 452 extern int
 453 cx88_risc_stopper(struct pci_dev *pci, struct btcx_riscmem *risc,
 454                   u32 reg, u32 mask, u32 value);
 455 extern void
 456 cx88_free_buffer(struct pci_dev *pci, struct cx88_buffer *buf);
 457
 458 extern void cx88_risc_disasm(struct cx88_core *core,
 459                              struct btcx_riscmem *risc);
 460 extern int cx88_sram_channel_setup(struct cx88_core *core,
 461                                    struct sram_channel *ch,
 462                                    unsigned int bpl, u32 risc);
 463 extern void cx88_sram_channel_dump(struct cx88_core *core,
 464                                    struct sram_channel *ch);
 465
 466 extern int cx88_set_scale(struct cx88_core *core, unsigned int width,
 467                           unsigned int height, enum v4l2_field field);
 468 extern int cx88_set_tvnorm(struct cx88_core *core, struct cx88_tvnorm *norm);
 469
 470 extern struct video_device *cx88_vdev_init(struct cx88_core *core,
 471                                            struct pci_dev *pci,
 472                                            struct video_device *template,
 473                                            char *type);
 474 extern struct cx88_core* cx88_core_get(struct pci_dev *pci);
 475 extern void cx88_core_put(struct cx88_core *core,
 476                           struct pci_dev *pci);
 477
 478 /* ----------------------------------------------------------- */
 479 /* cx88-vbi.c                                                  */
 480
 481 void cx8800_vbi_fmt(struct cx8800_dev *dev, struct v4l2_format *f);
 482 /*
 483 int cx8800_start_vbi_dma(struct cx8800_dev    *dev,
 484                          struct cx88_dmaqueue *q,
 485                          struct cx88_buffer   *buf);
 486 */
 487 int cx8800_stop_vbi_dma(struct cx8800_dev *dev);
 488 int cx8800_restart_vbi_queue(struct cx8800_dev    *dev,
 489                              struct cx88_dmaqueue *q);
 490 void cx8800_vbi_timeout(unsigned long data);
 491
 492 extern struct videobuf_queue_ops cx8800_vbi_qops;
 493
 494 /* ----------------------------------------------------------- */
 495 /* cx88-i2c.c                                                  */
 496
 497 extern int cx88_i2c_init(struct cx88_core *core, struct pci_dev *pci);
 498 extern void cx88_call_i2c_clients(struct cx88_core *core,
 499                                   unsigned int cmd, void *arg);
 500
 501
 502 /* ----------------------------------------------------------- */
 503 /* cx88-cards.c                                                */
 504
 505 extern struct cx88_board cx88_boards[];
 506 extern const unsigned int cx88_bcount;
 507
 508 extern struct cx88_subid cx88_subids[];
 509 extern const unsigned int cx88_idcount;
 510
 511 extern void cx88_card_list(struct cx88_core *core, struct pci_dev *pci);
 512 extern void cx88_card_setup(struct cx88_core *core);
 513
 514 /* ----------------------------------------------------------- */
 515 /* cx88-tvaudio.c                                              */
 516
 517 #define WW_NONE          1
 518 #define WW_BTSC          2
 519 #define WW_NICAM_I       3
 520 #define WW_NICAM_BGDKL   4
 521 #define WW_A1            5
 522 #define WW_A2_BG         6
 523 #define WW_A2_DK         7
 524 #define WW_A2_M          8
 525 #define WW_EIAJ          9
 526 #define WW_SYSTEM_L_AM  10
 527 #define WW_I2SPT        11
 528 #define WW_FM           12
 529
 530 void cx88_set_tvaudio(struct cx88_core *core);
 531 void cx88_newstation(struct cx88_core *core);
 532 void cx88_get_stereo(struct cx88_core *core, struct v4l2_tuner *t);
 533 void cx88_set_stereo(struct cx88_core *core, u32 mode, int manual);
 534 int cx88_audio_thread(void *data);
 535
 536 /* ----------------------------------------------------------- */
 537 /* cx88-input.c                                                */
 538
 539 int cx88_ir_init(struct cx88_core *core, struct pci_dev *pci);
 540 int cx88_ir_fini(struct cx88_core *core);
 541 void cx88_ir_irq(struct cx88_core *core);
 542
 543 /* ----------------------------------------------------------- */
 544 /* cx88-mpeg.c                                                 */
 545
 546 int cx8802_buf_prepare(struct cx8802_dev *dev, struct cx88_buffer *buf);
 547 void cx8802_buf_queue(struct cx8802_dev *dev, struct cx88_buffer *buf);
 548 void cx8802_cancel_buffers(struct cx8802_dev *dev);
 549
 550 int cx8802_init_common(struct cx8802_dev *dev);
 551 void cx8802_fini_common(struct cx8802_dev *dev);
 552
 553 int cx8802_suspend_common(struct pci_dev *pci_dev, pm_message_t state);
 554 int cx8802_resume_common(struct pci_dev *pci_dev);
 555
 556 /*
 557  * Local variables:
 558  * c-basic-offset: 8
 559  * End:
 560  */