pci/bt8xx/bttv.h

0001 /* SPDX-License-Identifier: GPL-2.0 */
0002 /*
0003  *
0004  *  bttv - Bt848 frame grabber driver
0005  *
0006  *  card ID's and external interfaces of the bttv driver
0007  *  basically stuff needed by other drivers (i2c, lirc, ...)
0008  *  and is supported not to change much over time.
0009  *
0010  *  Copyright (C) 1996,97 Ralph Metzler (rjkm@thp.uni-koeln.de)
0011  *  (c) 1999,2000 Gerd Knorr <kraxel@goldbach.in-berlin.de>
0012  *
0013  */
0014
0015 #ifndef _BTTV_H_
0016 #define _BTTV_H_
0017
0018 #include <linux/videodev2.h>
0019 #include <linux/i2c.h>
0020 #include <media/v4l2-device.h>
0021 #include <media/tuner.h>
0022
0023 /* ---------------------------------------------------------- */
0024 /* exported by bttv-cards.c                                   */
0025
0026 #define BTTV_BOARD_UNKNOWN                 0x00
0027 #define BTTV_BOARD_MIRO                    0x01
0028 #define BTTV_BOARD_HAUPPAUGE               0x02
0029 #define BTTV_BOARD_STB                     0x03
0030 #define BTTV_BOARD_INTEL                   0x04
0031 #define BTTV_BOARD_DIAMOND                 0x05
0032 #define BTTV_BOARD_AVERMEDIA               0x06
0033 #define BTTV_BOARD_MATRIX_VISION           0x07
0034 #define BTTV_BOARD_FLYVIDEO                0x08
0035 #define BTTV_BOARD_TURBOTV                 0x09
0036 #define BTTV_BOARD_HAUPPAUGE878            0x0a
0037 #define BTTV_BOARD_MIROPRO                 0x0b
0038 #define BTTV_BOARD_ADSTECH_TV              0x0c
0039 #define BTTV_BOARD_AVERMEDIA98             0x0d
0040 #define BTTV_BOARD_VHX                     0x0e
0041 #define BTTV_BOARD_ZOLTRIX                 0x0f
0042 #define BTTV_BOARD_PIXVIEWPLAYTV           0x10
0043 #define BTTV_BOARD_WINVIEW_601             0x11
0044 #define BTTV_BOARD_AVEC_INTERCAP           0x12
0045 #define BTTV_BOARD_LIFE_FLYKIT             0x13
0046 #define BTTV_BOARD_CEI_RAFFLES             0x14
0047 #define BTTV_BOARD_CONFERENCETV            0x15
0048 #define BTTV_BOARD_PHOEBE_TVMAS            0x16
0049 #define BTTV_BOARD_MODTEC_205              0x17
0050 #define BTTV_BOARD_MAGICTVIEW061           0x18
0051 #define BTTV_BOARD_VOBIS_BOOSTAR           0x19
0052 #define BTTV_BOARD_HAUPPAUG_WCAM           0x1a
0053 #define BTTV_BOARD_MAXI                    0x1b
0054 #define BTTV_BOARD_TERRATV                 0x1c
0055 #define BTTV_BOARD_PXC200                  0x1d
0056 #define BTTV_BOARD_FLYVIDEO_98             0x1e
0057 #define BTTV_BOARD_IPROTV                  0x1f
0058 #define BTTV_BOARD_INTEL_C_S_PCI           0x20
0059 #define BTTV_BOARD_TERRATVALUE             0x21
0060 #define BTTV_BOARD_WINFAST2000             0x22
0061 #define BTTV_BOARD_CHRONOS_VS2             0x23
0062 #define BTTV_BOARD_TYPHOON_TVIEW           0x24
0063 #define BTTV_BOARD_PXELVWPLTVPRO           0x25
0064 #define BTTV_BOARD_MAGICTVIEW063           0x26
0065 #define BTTV_BOARD_PINNACLE                0x27
0066 #define BTTV_BOARD_STB2                    0x28
0067 #define BTTV_BOARD_AVPHONE98               0x29
0068 #define BTTV_BOARD_PV951                   0x2a
0069 #define BTTV_BOARD_ONAIR_TV                0x2b
0070 #define BTTV_BOARD_SIGMA_TVII_FM           0x2c
0071 #define BTTV_BOARD_MATRIX_VISION2          0x2d
0072 #define BTTV_BOARD_ZOLTRIX_GENIE           0x2e
0073 #define BTTV_BOARD_TERRATVRADIO            0x2f
0074 #define BTTV_BOARD_DYNALINK                0x30
0075 #define BTTV_BOARD_GVBCTV3PCI              0x31
0076 #define BTTV_BOARD_PXELVWPLTVPAK           0x32
0077 #define BTTV_BOARD_EAGLE                   0x33
0078 #define BTTV_BOARD_PINNACLEPRO             0x34
0079 #define BTTV_BOARD_TVIEW_RDS_FM            0x35
0080 #define BTTV_BOARD_LIFETEC_9415            0x36
0081 #define BTTV_BOARD_BESTBUY_EASYTV          0x37
0082 #define BTTV_BOARD_FLYVIDEO_98FM           0x38
0083 #define BTTV_BOARD_GRANDTEC                0x39
0084 #define BTTV_BOARD_ASKEY_CPH060            0x3a
0085 #define BTTV_BOARD_ASKEY_CPH03X            0x3b
0086 #define BTTV_BOARD_MM100PCTV               0x3c
0087 #define BTTV_BOARD_GMV1                    0x3d
0088 #define BTTV_BOARD_BESTBUY_EASYTV2         0x3e
0089 #define BTTV_BOARD_ATI_TVWONDER            0x3f
0090 #define BTTV_BOARD_ATI_TVWONDERVE          0x40
0091 #define BTTV_BOARD_FLYVIDEO2000            0x41
0092 #define BTTV_BOARD_TERRATVALUER            0x42
0093 #define BTTV_BOARD_GVBCTV4PCI              0x43
0094 #define BTTV_BOARD_VOODOOTV_FM             0x44
0095 #define BTTV_BOARD_AIMMS                   0x45
0096 #define BTTV_BOARD_PV_BT878P_PLUS          0x46
0097 #define BTTV_BOARD_FLYVIDEO98EZ            0x47
0098 #define BTTV_BOARD_PV_BT878P_9B            0x48
0099 #define BTTV_BOARD_SENSORAY311_611         0x49
0100 #define BTTV_BOARD_RV605                   0x4a
0101 #define BTTV_BOARD_POWERCLR_MTV878         0x4b
0102 #define BTTV_BOARD_WINDVR                  0x4c
0103 #define BTTV_BOARD_GRANDTEC_MULTI          0x4d
0104 #define BTTV_BOARD_KWORLD                  0x4e
0105 #define BTTV_BOARD_DSP_TCVIDEO             0x4f
0106 #define BTTV_BOARD_HAUPPAUGEPVR            0x50
0107 #define BTTV_BOARD_GVBCTV5PCI              0x51
0108 #define BTTV_BOARD_OSPREY1x0               0x52
0109 #define BTTV_BOARD_OSPREY1x0_848           0x53
0110 #define BTTV_BOARD_OSPREY101_848           0x54
0111 #define BTTV_BOARD_OSPREY1x1               0x55
0112 #define BTTV_BOARD_OSPREY1x1_SVID          0x56
0113 #define BTTV_BOARD_OSPREY2xx               0x57
0114 #define BTTV_BOARD_OSPREY2x0_SVID          0x58
0115 #define BTTV_BOARD_OSPREY2x0               0x59
0116 #define BTTV_BOARD_OSPREY500               0x5a
0117 #define BTTV_BOARD_OSPREY540               0x5b
0118 #define BTTV_BOARD_OSPREY2000              0x5c
0119 #define BTTV_BOARD_IDS_EAGLE               0x5d
0120 #define BTTV_BOARD_PINNACLESAT             0x5e
0121 #define BTTV_BOARD_FORMAC_PROTV            0x5f
0122 #define BTTV_BOARD_MACHTV                  0x60
0123 #define BTTV_BOARD_EURESYS_PICOLO          0x61
0124 #define BTTV_BOARD_PV150                   0x62
0125 #define BTTV_BOARD_AD_TVK503               0x63
0126 #define BTTV_BOARD_HERCULES_SM_TV          0x64
0127 #define BTTV_BOARD_PACETV                  0x65
0128 #define BTTV_BOARD_IVC200                  0x66
0129 #define BTTV_BOARD_XGUARD                  0x67
0130 #define BTTV_BOARD_NEBULA_DIGITV           0x68
0131 #define BTTV_BOARD_PV143                   0x69
0132 #define BTTV_BOARD_VD009X1_VD011_MINIDIN   0x6a
0133 #define BTTV_BOARD_VD009X1_VD011_COMBI     0x6b
0134 #define BTTV_BOARD_VD009_MINIDIN           0x6c
0135 #define BTTV_BOARD_VD009_COMBI             0x6d
0136 #define BTTV_BOARD_IVC100                  0x6e
0137 #define BTTV_BOARD_IVC120                  0x6f
0138 #define BTTV_BOARD_PC_HDTV                 0x70
0139 #define BTTV_BOARD_TWINHAN_DST             0x71
0140 #define BTTV_BOARD_WINFASTVC100            0x72
0141 #define BTTV_BOARD_TEV560                  0x73
0142 #define BTTV_BOARD_SIMUS_GVC1100           0x74
0143 #define BTTV_BOARD_NGSTV_PLUS              0x75
0144 #define BTTV_BOARD_LMLBT4                  0x76
0145 #define BTTV_BOARD_TEKRAM_M205             0x77
0146 #define BTTV_BOARD_CONTVFMI                0x78
0147 #define BTTV_BOARD_PICOLO_TETRA_CHIP       0x79
0148 #define BTTV_BOARD_SPIRIT_TV               0x7a
0149 #define BTTV_BOARD_AVDVBT_771              0x7b
0150 #define BTTV_BOARD_AVDVBT_761              0x7c
0151 #define BTTV_BOARD_MATRIX_VISIONSQ         0x7d
0152 #define BTTV_BOARD_MATRIX_VISIONSLC        0x7e
0153 #define BTTV_BOARD_APAC_VIEWCOMP           0x7f
0154 #define BTTV_BOARD_DVICO_DVBT_LITE         0x80
0155 #define BTTV_BOARD_VGEAR_MYVCD             0x81
0156 #define BTTV_BOARD_SUPER_TV                0x82
0157 #define BTTV_BOARD_TIBET_CS16              0x83
0158 #define BTTV_BOARD_KODICOM_4400R           0x84
0159 #define BTTV_BOARD_KODICOM_4400R_SL        0x85
0160 #define BTTV_BOARD_ADLINK_RTV24            0x86
0161 #define BTTV_BOARD_DVICO_FUSIONHDTV_5_LITE 0x87
0162 #define BTTV_BOARD_ACORP_Y878F             0x88
0163 #define BTTV_BOARD_CONCEPTRONIC_CTVFMI2    0x89
0164 #define BTTV_BOARD_PV_BT878P_2E            0x8a
0165 #define BTTV_BOARD_PV_M4900                0x8b
0166 #define BTTV_BOARD_OSPREY440               0x8c
0167 #define BTTV_BOARD_ASOUND_SKYEYE       0x8d
0168 #define BTTV_BOARD_SABRENT_TVFM        0x8e
0169 #define BTTV_BOARD_HAUPPAUGE_IMPACTVCB     0x8f
0170 #define BTTV_BOARD_MACHTV_MAGICTV          0x90
0171 #define BTTV_BOARD_SSAI_SECURITY       0x91
0172 #define BTTV_BOARD_SSAI_ULTRASOUND     0x92
0173 #define BTTV_BOARD_VOODOOTV_200        0x93
0174 #define BTTV_BOARD_DVICO_FUSIONHDTV_2      0x94
0175 #define BTTV_BOARD_TYPHOON_TVTUNERPCI      0x95
0176 #define BTTV_BOARD_GEOVISION_GV600     0x96
0177 #define BTTV_BOARD_KOZUMI_KTV_01C          0x97
0178 #define BTTV_BOARD_ENLTV_FM_2          0x98
0179 #define BTTV_BOARD_VD012           0x99
0180 #define BTTV_BOARD_VD012_X1        0x9a
0181 #define BTTV_BOARD_VD012_X2        0x9b
0182 #define BTTV_BOARD_IVCE8784        0x9c
0183 #define BTTV_BOARD_GEOVISION_GV800S    0x9d
0184 #define BTTV_BOARD_GEOVISION_GV800S_SL     0x9e
0185 #define BTTV_BOARD_PV183                   0x9f
0186 #define BTTV_BOARD_TVT_TD3116          0xa0
0187 #define BTTV_BOARD_APOSONIC_WDVR           0xa1
0188 #define BTTV_BOARD_ADLINK_MPG24            0xa2
0189 #define BTTV_BOARD_BT848_CAP_14            0xa3
0190 #define BTTV_BOARD_CYBERVISION_CV06        0xa4
0191 #define BTTV_BOARD_KWORLD_VSTREAM_XPERT    0xa5
0192 #define BTTV_BOARD_PCI_8604PW              0xa6
0193
0194 /* more card-specific defines */
0195 #define PT2254_L_CHANNEL 0x10
0196 #define PT2254_R_CHANNEL 0x08
0197 #define PT2254_DBS_IN_2 0x400
0198 #define PT2254_DBS_IN_10 0x20000
0199 #define WINVIEW_PT2254_CLK  0x40
0200 #define WINVIEW_PT2254_DATA 0x20
0201 #define WINVIEW_PT2254_STROBE 0x80
0202
0203 struct bttv_core {
0204     /* device structs */
0205     struct v4l2_device   v4l2_dev;
0206     struct pci_dev       *pci;
0207     struct i2c_adapter   i2c_adap;
0208     struct list_head     subs;     /* struct bttv_sub_device */
0209
0210     /* device config */
0211     unsigned int         nr;       /* dev nr (for printk("bttv%d: ...");  */
0212     unsigned int         type;     /* card type (pointer into tvcards[])  */
0213 };
0214
0215 struct bttv;
0216
0217 struct tvcard {
0218     char *name;
0219     void (*volume_gpio)(struct bttv *btv, __u16 volume);
0220     void (*audio_mode_gpio)(struct bttv *btv, struct v4l2_tuner *tuner, int set);
0221     void (*muxsel_hook)(struct bttv *btv, unsigned int input);
0222
0223     /* MUX bits for each input, two bits per input starting with the LSB */
0224     u32 muxsel; /* Use MUXSEL() to set */
0225
0226     u32 gpiomask;
0227     u32 gpiomux[4];  /* Tuner, Radio, external, internal */
0228     u32 gpiomute;    /* GPIO mute setting */
0229     u32 gpiomask2;   /* GPIO MUX mask */
0230
0231     unsigned int tuner_type;
0232     u8 tuner_addr;
0233     u8 video_inputs;    /* Number of inputs */
0234     unsigned int svhs:4;    /* Which input is s-video */
0235 #define NO_SVHS 15
0236     unsigned int pll:2;
0237 #define PLL_NONE 0
0238 #define PLL_28   1
0239 #define PLL_35   2
0240 #define PLL_14   3
0241
0242     /* i2c audio flags */
0243     unsigned int no_msp34xx:1;
0244     unsigned int no_tda7432:1;
0245     unsigned int msp34xx_alt:1;
0246     /* Note: currently no card definition needs to mark the presence
0247        of a RDS saa6588 chip. If this is ever needed, then add a new
0248        'has_saa6588' bit here. */
0249
0250     unsigned int no_video:1; /* video pci function is unused */
0251     unsigned int has_dvb:1;
0252     unsigned int has_remote:1;
0253     unsigned int has_radio:1;
0254     unsigned int has_dig_in:1; /* Has digital input (always last input) */
0255     unsigned int no_gpioirq:1;
0256 };
0257
0258 extern struct tvcard bttv_tvcards[];
0259
0260 /*
0261  * This bit of cpp voodoo is used to create a macro with a variable number of
0262  * arguments (1 to 16).  It will pack each argument into a word two bits at a
0263  * time.  It can't be a function because it needs to be compile time constant to
0264  * initialize structures.  Since each argument must fit in two bits, it's ok
0265  * that they are changed to octal.  One should not use hex number, macros, or
0266  * anything else with this macro.  Just use plain integers from 0 to 3.
0267  */
0268 #define _MUXSELf(a)     0##a << 30
0269 #define _MUXSELe(a, b...)   0##a << 28 | _MUXSELf(b)
0270 #define _MUXSELd(a, b...)   0##a << 26 | _MUXSELe(b)
0271 #define _MUXSELc(a, b...)   0##a << 24 | _MUXSELd(b)
0272 #define _MUXSELb(a, b...)   0##a << 22 | _MUXSELc(b)
0273 #define _MUXSELa(a, b...)   0##a << 20 | _MUXSELb(b)
0274 #define _MUXSEL9(a, b...)   0##a << 18 | _MUXSELa(b)
0275 #define _MUXSEL8(a, b...)   0##a << 16 | _MUXSEL9(b)
0276 #define _MUXSEL7(a, b...)   0##a << 14 | _MUXSEL8(b)
0277 #define _MUXSEL6(a, b...)   0##a << 12 | _MUXSEL7(b)
0278 #define _MUXSEL5(a, b...)   0##a << 10 | _MUXSEL6(b)
0279 #define _MUXSEL4(a, b...)   0##a << 8  | _MUXSEL5(b)
0280 #define _MUXSEL3(a, b...)   0##a << 6  | _MUXSEL4(b)
0281 #define _MUXSEL2(a, b...)   0##a << 4  | _MUXSEL3(b)
0282 #define _MUXSEL1(a, b...)   0##a << 2  | _MUXSEL2(b)
0283 #define MUXSEL(a, b...)     (a | _MUXSEL1(b))
0284
0285 /* identification / initialization of the card */
0286 extern void bttv_idcard(struct bttv *btv);
0287 extern void bttv_init_card1(struct bttv *btv);
0288 extern void bttv_init_card2(struct bttv *btv);
0289 extern void bttv_init_tuner(struct bttv *btv);
0290
0291 /* card-specific functions */
0292 extern void tea5757_set_freq(struct bttv *btv, unsigned short freq);
0293 extern u32 bttv_tda9880_setnorm(struct bttv *btv, u32 gpiobits);
0294
0295 /* extra tweaks for some chipsets */
0296 extern void bttv_check_chipset(void);
0297 extern int bttv_handle_chipset(struct bttv *btv);
0298
0299 /* ---------------------------------------------------------- */
0300 /* exported by bttv-if.c                                      */
0301
0302 /* this obsolete -- please use the sysfs-based
0303    interface below for new code */
0304
0305 extern struct pci_dev* bttv_get_pcidev(unsigned int card);
0306
0307 /* sets GPOE register (BT848_GPIO_OUT_EN) to new value:
0308    data | (current_GPOE_value & ~mask)
0309    returns negative value if error occurred
0310 */
0311 extern int bttv_gpio_enable(unsigned int card,
0312                 unsigned long mask, unsigned long data);
0313
0314 /* fills data with GPDATA register contents
0315    returns negative value if error occurred
0316 */
0317 extern int bttv_read_gpio(unsigned int card, unsigned long *data);
0318
0319 /* sets GPDATA register to new value:
0320   (data & mask) | (current_GPDATA_value & ~mask)
0321   returns negative value if error occurred
0322 */
0323 extern int bttv_write_gpio(unsigned int card,
0324                unsigned long mask, unsigned long data);
0325
0326
0327
0328
0329 /* ---------------------------------------------------------- */
0330 /* sysfs/driver-moded based gpio access interface             */
0331
0332 struct bttv_sub_device {
0333     struct device    dev;
0334     struct bttv_core *core;
0335     struct list_head list;
0336 };
0337 #define to_bttv_sub_dev(x) container_of((x), struct bttv_sub_device, dev)
0338
0339 struct bttv_sub_driver {
0340     struct device_driver   drv;
0341     char                   wanted[20];
0342     int                    (*probe)(struct bttv_sub_device *sub);
0343     void                   (*remove)(struct bttv_sub_device *sub);
0344 };
0345 #define to_bttv_sub_drv(x) container_of((x), struct bttv_sub_driver, drv)
0346
0347 int bttv_sub_register(struct bttv_sub_driver *drv, char *wanted);
0348 int bttv_sub_unregister(struct bttv_sub_driver *drv);
0349
0350 /* gpio access functions */
0351 void bttv_gpio_inout(struct bttv_core *core, u32 mask, u32 outbits);
0352 u32 bttv_gpio_read(struct bttv_core *core);
0353 void bttv_gpio_write(struct bttv_core *core, u32 value);
0354 void bttv_gpio_bits(struct bttv_core *core, u32 mask, u32 bits);
0355
0356 #define gpio_inout(mask,bits)  bttv_gpio_inout(&btv->c, mask, bits)
0357 #define gpio_read()            bttv_gpio_read(&btv->c)
0358 #define gpio_write(value)      bttv_gpio_write(&btv->c, value)
0359 #define gpio_bits(mask,bits)   bttv_gpio_bits(&btv->c, mask, bits)
0360
0361
0362 /* ---------------------------------------------------------- */
0363 /* i2c                                                        */
0364
0365 #define bttv_call_all(btv, o, f, args...) \
0366     v4l2_device_call_all(&btv->c.v4l2_dev, 0, o, f, ##args)
0367
0368 #define bttv_call_all_err(btv, o, f, args...) \
0369     v4l2_device_call_until_err(&btv->c.v4l2_dev, 0, o, f, ##args)
0370
0371 extern int bttv_I2CRead(struct bttv *btv, unsigned char addr, char *probe_for);
0372 extern int bttv_I2CWrite(struct bttv *btv, unsigned char addr, unsigned char b1,
0373              unsigned char b2, int both);
0374 extern void bttv_readee(struct bttv *btv, unsigned char *eedata, int addr);
0375
0376 extern int bttv_input_init(struct bttv *dev);
0377 extern void bttv_input_fini(struct bttv *dev);
0378 extern void bttv_input_irq(struct bttv *dev);
0379
0380 #endif /* _BTTV_H_ */