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