drivers/media/video/bt8xx/bttv.h

   1 /*
   2  *
   3  *  bttv - Bt848 frame grabber driver
   4  *
   5  *  card ID's and external interfaces of the bttv driver
   6  *  basically stuff needed by other drivers (i2c, lirc, ...)
   7  *  and is supported not to change much over time.
   8  *
   9  *  Copyright (C) 1996,97 Ralph Metzler (rjkm@thp.uni-koeln.de)
  10  *  (c) 1999,2000 Gerd Knorr <kraxel@goldbach.in-berlin.de>
  11  *
  12  */
  13
  14 #ifndef _BTTV_H_
  15 #define _BTTV_H_
  16
  17 #include <linux/videodev2.h>
  18 #include <linux/i2c.h>
  19 #include <media/v4l2-device.h>
  20 #include <media/ir-common.h>
  21 #include <media/ir-kbd-i2c.h>
  22 #include <media/i2c-addr.h>
  23 #include <media/tuner.h>
  24
  25 /* ---------------------------------------------------------- */
  26 /* exported by bttv-cards.c                                   */
  27
  28 #define BTTV_BOARD_UNKNOWN                 0x00
  29 #define BTTV_BOARD_MIRO                    0x01
  30 #define BTTV_BOARD_HAUPPAUGE               0x02
  31 #define BTTV_BOARD_STB                     0x03
  32 #define BTTV_BOARD_INTEL                   0x04
  33 #define BTTV_BOARD_DIAMOND                 0x05
  34 #define BTTV_BOARD_AVERMEDIA               0x06
  35 #define BTTV_BOARD_MATRIX_VISION           0x07
  36 #define BTTV_BOARD_FLYVIDEO                0x08
  37 #define BTTV_BOARD_TURBOTV                 0x09
  38 #define BTTV_BOARD_HAUPPAUGE878            0x0a
  39 #define BTTV_BOARD_MIROPRO                 0x0b
  40 #define BTTV_BOARD_ADSTECH_TV              0x0c
  41 #define BTTV_BOARD_AVERMEDIA98             0x0d
  42 #define BTTV_BOARD_VHX                     0x0e
  43 #define BTTV_BOARD_ZOLTRIX                 0x0f
  44 #define BTTV_BOARD_PIXVIEWPLAYTV           0x10
  45 #define BTTV_BOARD_WINVIEW_601             0x11
  46 #define BTTV_BOARD_AVEC_INTERCAP           0x12
  47 #define BTTV_BOARD_LIFE_FLYKIT             0x13
  48 #define BTTV_BOARD_CEI_RAFFLES             0x14
  49 #define BTTV_BOARD_CONFERENCETV            0x15
  50 #define BTTV_BOARD_PHOEBE_TVMAS            0x16
  51 #define BTTV_BOARD_MODTEC_205              0x17
  52 #define BTTV_BOARD_MAGICTVIEW061           0x18
  53 #define BTTV_BOARD_VOBIS_BOOSTAR           0x19
  54 #define BTTV_BOARD_HAUPPAUG_WCAM           0x1a
  55 #define BTTV_BOARD_MAXI                    0x1b
  56 #define BTTV_BOARD_TERRATV                 0x1c
  57 #define BTTV_BOARD_PXC200                  0x1d
  58 #define BTTV_BOARD_FLYVIDEO_98             0x1e
  59 #define BTTV_BOARD_IPROTV                  0x1f
  60 #define BTTV_BOARD_INTEL_C_S_PCI           0x20
  61 #define BTTV_BOARD_TERRATVALUE             0x21
  62 #define BTTV_BOARD_WINFAST2000             0x22
  63 #define BTTV_BOARD_CHRONOS_VS2             0x23
  64 #define BTTV_BOARD_TYPHOON_TVIEW           0x24
  65 #define BTTV_BOARD_PXELVWPLTVPRO           0x25
  66 #define BTTV_BOARD_MAGICTVIEW063           0x26
  67 #define BTTV_BOARD_PINNACLE                0x27
  68 #define BTTV_BOARD_STB2                    0x28
  69 #define BTTV_BOARD_AVPHONE98               0x29
  70 #define BTTV_BOARD_PV951                   0x2a
  71 #define BTTV_BOARD_ONAIR_TV                0x2b
  72 #define BTTV_BOARD_SIGMA_TVII_FM           0x2c
  73 #define BTTV_BOARD_MATRIX_VISION2          0x2d
  74 #define BTTV_BOARD_ZOLTRIX_GENIE           0x2e
  75 #define BTTV_BOARD_TERRATVRADIO            0x2f
  76 #define BTTV_BOARD_DYNALINK                0x30
  77 #define BTTV_BOARD_GVBCTV3PCI              0x31
  78 #define BTTV_BOARD_PXELVWPLTVPAK           0x32
  79 #define BTTV_BOARD_EAGLE                   0x33
  80 #define BTTV_BOARD_PINNACLEPRO             0x34
  81 #define BTTV_BOARD_TVIEW_RDS_FM            0x35
  82 #define BTTV_BOARD_LIFETEC_9415            0x36
  83 #define BTTV_BOARD_BESTBUY_EASYTV          0x37
  84 #define BTTV_BOARD_FLYVIDEO_98FM           0x38
  85 #define BTTV_BOARD_GRANDTEC                0x39
  86 #define BTTV_BOARD_ASKEY_CPH060            0x3a
  87 #define BTTV_BOARD_ASKEY_CPH03X            0x3b
  88 #define BTTV_BOARD_MM100PCTV               0x3c
  89 #define BTTV_BOARD_GMV1                    0x3d
  90 #define BTTV_BOARD_BESTBUY_EASYTV2         0x3e
  91 #define BTTV_BOARD_ATI_TVWONDER            0x3f
  92 #define BTTV_BOARD_ATI_TVWONDERVE          0x40
  93 #define BTTV_BOARD_FLYVIDEO2000            0x41
  94 #define BTTV_BOARD_TERRATVALUER            0x42
  95 #define BTTV_BOARD_GVBCTV4PCI              0x43
  96 #define BTTV_BOARD_VOODOOTV_FM             0x44
  97 #define BTTV_BOARD_AIMMS                   0x45
  98 #define BTTV_BOARD_PV_BT878P_PLUS          0x46
  99 #define BTTV_BOARD_FLYVIDEO98EZ            0x47
 100 #define BTTV_BOARD_PV_BT878P_9B            0x48
 101 #define BTTV_BOARD_SENSORAY311             0x49
 102 #define BTTV_BOARD_RV605                   0x4a
 103 #define BTTV_BOARD_POWERCLR_MTV878         0x4b
 104 #define BTTV_BOARD_WINDVR                  0x4c
 105 #define BTTV_BOARD_GRANDTEC_MULTI          0x4d
 106 #define BTTV_BOARD_KWORLD                  0x4e
 107 #define BTTV_BOARD_DSP_TCVIDEO             0x4f
 108 #define BTTV_BOARD_HAUPPAUGEPVR            0x50
 109 #define BTTV_BOARD_GVBCTV5PCI              0x51
 110 #define BTTV_BOARD_OSPREY1x0               0x52
 111 #define BTTV_BOARD_OSPREY1x0_848           0x53
 112 #define BTTV_BOARD_OSPREY101_848           0x54
 113 #define BTTV_BOARD_OSPREY1x1               0x55
 114 #define BTTV_BOARD_OSPREY1x1_SVID          0x56
 115 #define BTTV_BOARD_OSPREY2xx               0x57
 116 #define BTTV_BOARD_OSPREY2x0_SVID          0x58
 117 #define BTTV_BOARD_OSPREY2x0               0x59
 118 #define BTTV_BOARD_OSPREY500               0x5a
 119 #define BTTV_BOARD_OSPREY540               0x5b
 120 #define BTTV_BOARD_OSPREY2000              0x5c
 121 #define BTTV_BOARD_IDS_EAGLE               0x5d
 122 #define BTTV_BOARD_PINNACLESAT             0x5e
 123 #define BTTV_BOARD_FORMAC_PROTV            0x5f
 124 #define BTTV_BOARD_MACHTV                  0x60
 125 #define BTTV_BOARD_EURESYS_PICOLO          0x61
 126 #define BTTV_BOARD_PV150                   0x62
 127 #define BTTV_BOARD_AD_TVK503               0x63
 128 #define BTTV_BOARD_HERCULES_SM_TV          0x64
 129 #define BTTV_BOARD_PACETV                  0x65
 130 #define BTTV_BOARD_IVC200                  0x66
 131 #define BTTV_BOARD_XGUARD                  0x67
 132 #define BTTV_BOARD_NEBULA_DIGITV           0x68
 133 #define BTTV_BOARD_PV143                   0x69
 134 #define BTTV_BOARD_VD009X1_VD011_MINIDIN   0x6a
 135 #define BTTV_BOARD_VD009X1_VD011_COMBI     0x6b
 136 #define BTTV_BOARD_VD009_MINIDIN           0x6c
 137 #define BTTV_BOARD_VD009_COMBI             0x6d
 138 #define BTTV_BOARD_IVC100                  0x6e
 139 #define BTTV_BOARD_IVC120                  0x6f
 140 #define BTTV_BOARD_PC_HDTV                 0x70
 141 #define BTTV_BOARD_TWINHAN_DST             0x71
 142 #define BTTV_BOARD_WINFASTVC100            0x72
 143 #define BTTV_BOARD_TEV560                  0x73
 144 #define BTTV_BOARD_SIMUS_GVC1100           0x74
 145 #define BTTV_BOARD_NGSTV_PLUS              0x75
 146 #define BTTV_BOARD_LMLBT4                  0x76
 147 #define BTTV_BOARD_TEKRAM_M205             0x77
 148 #define BTTV_BOARD_CONTVFMI                0x78
 149 #define BTTV_BOARD_PICOLO_TETRA_CHIP       0x79
 150 #define BTTV_BOARD_SPIRIT_TV               0x7a
 151 #define BTTV_BOARD_AVDVBT_771              0x7b
 152 #define BTTV_BOARD_AVDVBT_761              0x7c
 153 #define BTTV_BOARD_MATRIX_VISIONSQ         0x7d
 154 #define BTTV_BOARD_MATRIX_VISIONSLC        0x7e
 155 #define BTTV_BOARD_APAC_VIEWCOMP           0x7f
 156 #define BTTV_BOARD_DVICO_DVBT_LITE         0x80
 157 #define BTTV_BOARD_VGEAR_MYVCD             0x81
 158 #define BTTV_BOARD_SUPER_TV                0x82
 159 #define BTTV_BOARD_TIBET_CS16              0x83
 160 #define BTTV_BOARD_KODICOM_4400R           0x84
 161 #define BTTV_BOARD_KODICOM_4400R_SL        0x85
 162 #define BTTV_BOARD_ADLINK_RTV24            0x86
 163 #define BTTV_BOARD_DVICO_FUSIONHDTV_5_LITE 0x87
 164 #define BTTV_BOARD_ACORP_Y878F             0x88
 165 #define BTTV_BOARD_CONCEPTRONIC_CTVFMI2    0x89
 166 #define BTTV_BOARD_PV_BT878P_2E            0x8a
 167 #define BTTV_BOARD_PV_M4900                0x8b
 168 #define BTTV_BOARD_OSPREY440               0x8c
 169 #define BTTV_BOARD_ASOUND_SKYEYE           0x8d
 170 #define BTTV_BOARD_SABRENT_TVFM            0x8e
 171 #define BTTV_BOARD_HAUPPAUGE_IMPACTVCB     0x8f
 172 #define BTTV_BOARD_MACHTV_MAGICTV          0x90
 173 #define BTTV_BOARD_SSAI_SECURITY           0x91
 174 #define BTTV_BOARD_SSAI_ULTRASOUND         0x92
 175 #define BTTV_BOARD_VOODOOTV_200            0x93
 176 #define BTTV_BOARD_DVICO_FUSIONHDTV_2      0x94
 177 #define BTTV_BOARD_TYPHOON_TVTUNERPCI      0x95
 178 #define BTTV_BOARD_GEOVISION_GV600         0x96
 179 #define BTTV_BOARD_KOZUMI_KTV_01C          0x97
 180 #define BTTV_BOARD_ENLTV_FM_2              0x98
 181 #define BTTV_BOARD_VD012                   0x99
 182 #define BTTV_BOARD_VD012_X1                0x9a
 183 #define BTTV_BOARD_VD012_X2                0x9b
 184 #define BTTV_BOARD_IVCE8784                0x9c
 185 #define BTTV_BOARD_GEOVISION_GV800S        0x9d
 186 #define BTTV_BOARD_GEOVISION_GV800S_SL     0x9e
 187 #define BTTV_BOARD_PV183                   0x9f
 188
 189
 190 /* more card-specific defines */
 191 #define PT2254_L_CHANNEL 0x10
 192 #define PT2254_R_CHANNEL 0x08
 193 #define PT2254_DBS_IN_2 0x400
 194 #define PT2254_DBS_IN_10 0x20000
 195 #define WINVIEW_PT2254_CLK  0x40
 196 #define WINVIEW_PT2254_DATA 0x20
 197 #define WINVIEW_PT2254_STROBE 0x80
 198
 199 struct bttv_core {
 200         /* device structs */
 201         struct v4l2_device   v4l2_dev;
 202         struct pci_dev       *pci;
 203         struct i2c_adapter   i2c_adap;
 204         struct list_head     subs;     /* struct bttv_sub_device */
 205
 206         /* device config */
 207         unsigned int         nr;       /* dev nr (for printk("bttv%d: ...");  */
 208         unsigned int         type;     /* card type (pointer into tvcards[])  */
 209 };
 210
 211 struct bttv;
 212
 213 struct tvcard {
 214         char *name;
 215         void (*volume_gpio)(struct bttv *btv, __u16 volume);
 216         void (*audio_mode_gpio)(struct bttv *btv, struct v4l2_tuner *tuner, int set);
 217         void (*muxsel_hook)(struct bttv *btv, unsigned int input);
 218
 219         /* MUX bits for each input, two bits per input starting with the LSB */
 220         u32 muxsel; /* Use MUXSEL() to set */
 221
 222         u32 gpiomask;
 223         u32 gpiomux[4];  /* Tuner, Radio, external, internal */
 224         u32 gpiomute;    /* GPIO mute setting */
 225         u32 gpiomask2;   /* GPIO MUX mask */
 226
 227         unsigned int tuner_type;
 228         u8 tuner_addr;
 229         u8 video_inputs;        /* Number of inputs */
 230         unsigned int svhs:4;    /* Which input is s-video */
 231 #define NO_SVHS 15
 232         unsigned int pll:2;
 233 #define PLL_NONE 0
 234 #define PLL_28   1
 235 #define PLL_35   2
 236
 237         /* i2c audio flags */
 238         unsigned int no_msp34xx:1;
 239         unsigned int no_tda9875:1;
 240         unsigned int no_tda7432:1;
 241         unsigned int needs_tvaudio:1;
 242         unsigned int msp34xx_alt:1;
 243         /* Note: currently no card definition needs to mark the presence
 244            of a RDS saa6588 chip. If this is ever needed, then add a new
 245            'has_saa6588' bit here. */
 246
 247         unsigned int no_video:1; /* video pci function is unused */
 248         unsigned int has_dvb:1;
 249         unsigned int has_remote:1;
 250         unsigned int has_radio:1;
 251         unsigned int has_dig_in:1; /* Has digital input (always last input) */
 252         unsigned int no_gpioirq:1;
 253 };
 254
 255 extern struct tvcard bttv_tvcards[];
 256
 257 /*
 258  * This bit of cpp voodoo is used to create a macro with a variable number of
 259  * arguments (1 to 16).  It will pack each argument into a word two bits at a
 260  * time.  It can't be a function because it needs to be compile time constant to
 261  * initialize structures.  Since each argument must fit in two bits, it's ok
 262  * that they are changed to octal.  One should not use hex number, macros, or
 263  * anything else with this macro.  Just use plain integers from 0 to 3.
 264  */
 265 #define _MUXSELf(a)             0##a << 30
 266 #define _MUXSELe(a, b...)       0##a << 28 | _MUXSELf(b)
 267 #define _MUXSELd(a, b...)       0##a << 26 | _MUXSELe(b)
 268 #define _MUXSELc(a, b...)       0##a << 24 | _MUXSELd(b)
 269 #define _MUXSELb(a, b...)       0##a << 22 | _MUXSELc(b)
 270 #define _MUXSELa(a, b...)       0##a << 20 | _MUXSELb(b)
 271 #define _MUXSEL9(a, b...)       0##a << 18 | _MUXSELa(b)
 272 #define _MUXSEL8(a, b...)       0##a << 16 | _MUXSEL9(b)
 273 #define _MUXSEL7(a, b...)       0##a << 14 | _MUXSEL8(b)
 274 #define _MUXSEL6(a, b...)       0##a << 12 | _MUXSEL7(b)
 275 #define _MUXSEL5(a, b...)       0##a << 10 | _MUXSEL6(b)
 276 #define _MUXSEL4(a, b...)       0##a << 8  | _MUXSEL5(b)
 277 #define _MUXSEL3(a, b...)       0##a << 6  | _MUXSEL4(b)
 278 #define _MUXSEL2(a, b...)       0##a << 4  | _MUXSEL3(b)
 279 #define _MUXSEL1(a, b...)       0##a << 2  | _MUXSEL2(b)
 280 #define MUXSEL(a, b...)         (a | _MUXSEL1(b))
 281
 282 /* identification / initialization of the card */
 283 extern void bttv_idcard(struct bttv *btv);
 284 extern void bttv_init_card1(struct bttv *btv);
 285 extern void bttv_init_card2(struct bttv *btv);
 286 extern void bttv_init_tuner(struct bttv *btv);
 287
 288 /* card-specific funtions */
 289 extern void tea5757_set_freq(struct bttv *btv, unsigned short freq);
 290 extern u32 bttv_tda9880_setnorm(struct bttv *btv, u32 gpiobits);
 291
 292 /* extra tweaks for some chipsets */
 293 extern void bttv_check_chipset(void);
 294 extern int bttv_handle_chipset(struct bttv *btv);
 295
 296 /* ---------------------------------------------------------- */
 297 /* exported by bttv-if.c                                      */
 298
 299 /* this obsolete -- please use the sysfs-based
 300    interface below for new code */
 301
 302 extern struct pci_dev* bttv_get_pcidev(unsigned int card);
 303
 304 /* sets GPOE register (BT848_GPIO_OUT_EN) to new value:
 305    data | (current_GPOE_value & ~mask)
 306    returns negative value if error occurred
 307 */
 308 extern int bttv_gpio_enable(unsigned int card,
 309                             unsigned long mask, unsigned long data);
 310
 311 /* fills data with GPDATA register contents
 312    returns negative value if error occurred
 313 */
 314 extern int bttv_read_gpio(unsigned int card, unsigned long *data);
 315
 316 /* sets GPDATA register to new value:
 317   (data & mask) | (current_GPDATA_value & ~mask)
 318   returns negative value if error occurred
 319 */
 320 extern int bttv_write_gpio(unsigned int card,
 321                            unsigned long mask, unsigned long data);
 322
 323
 324
 325
 326 /* ---------------------------------------------------------- */
 327 /* sysfs/driver-moded based gpio access interface             */
 328
 329 struct bttv_sub_device {
 330         struct device    dev;
 331         struct bttv_core *core;
 332         struct list_head list;
 333 };
 334 #define to_bttv_sub_dev(x) container_of((x), struct bttv_sub_device, dev)
 335
 336 struct bttv_sub_driver {
 337         struct device_driver   drv;
 338         char                   wanted[20];
 339         int                    (*probe)(struct bttv_sub_device *sub);
 340         void                   (*remove)(struct bttv_sub_device *sub);
 341 };
 342 #define to_bttv_sub_drv(x) container_of((x), struct bttv_sub_driver, drv)
 343
 344 int bttv_sub_register(struct bttv_sub_driver *drv, char *wanted);
 345 int bttv_sub_unregister(struct bttv_sub_driver *drv);
 346
 347 /* gpio access functions */
 348 void bttv_gpio_inout(struct bttv_core *core, u32 mask, u32 outbits);
 349 u32 bttv_gpio_read(struct bttv_core *core);
 350 void bttv_gpio_write(struct bttv_core *core, u32 value);
 351 void bttv_gpio_bits(struct bttv_core *core, u32 mask, u32 bits);
 352
 353 #define gpio_inout(mask,bits)  bttv_gpio_inout(&btv->c, mask, bits)
 354 #define gpio_read()            bttv_gpio_read(&btv->c)
 355 #define gpio_write(value)      bttv_gpio_write(&btv->c, value)
 356 #define gpio_bits(mask,bits)   bttv_gpio_bits(&btv->c, mask, bits)
 357
 358
 359 /* ---------------------------------------------------------- */
 360 /* i2c                                                        */
 361
 362 #define bttv_call_all(btv, o, f, args...) \
 363         v4l2_device_call_all(&btv->c.v4l2_dev, 0, o, f, ##args)
 364
 365 extern int bttv_I2CRead(struct bttv *btv, unsigned char addr, char *probe_for);
 366 extern int bttv_I2CWrite(struct bttv *btv, unsigned char addr, unsigned char b1,
 367                          unsigned char b2, int both);
 368 extern void bttv_readee(struct bttv *btv, unsigned char *eedata, int addr);
 369
 370 extern int bttv_input_init(struct bttv *dev);
 371 extern void bttv_input_fini(struct bttv *dev);
 372 extern void bttv_input_irq(struct bttv *dev);
 373
 374 #endif /* _BTTV_H_ */
 375 /*
 376  * Local variables:
 377  * c-basic-offset: 8
 378  * End:
 379  */