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