ftp://ftp.kernel.org/pub/linux/kernel/v2.6/linux-2.6.6.tar.bz2
[linux-2.6.git] / drivers / media / video / bttv.h
1 /*
2  *  bttv - Bt848 frame grabber driver
3  *
4  *  card ID's and external interfaces of the bttv driver
5  *  basically stuff needed by other drivers (i2c, lirc, ...)
6  *  and is supported not to change much over time.
7  *
8  *  Copyright (C) 1996,97 Ralph Metzler (rjkm@thp.uni-koeln.de)
9  *  (c) 1999,2000 Gerd Knorr <kraxel@goldbach.in-berlin.de>
10  *
11  */
12
13 #ifndef _BTTV_H_
14 #define _BTTV_H_
15
16 #include <linux/videodev.h>
17 #include <linux/i2c.h>
18
19 /* ---------------------------------------------------------- */
20 /* exported by bttv-cards.c                                   */
21
22 #define BTTV_UNKNOWN       0x00
23 #define BTTV_MIRO          0x01
24 #define BTTV_HAUPPAUGE     0x02
25 #define BTTV_STB           0x03
26 #define BTTV_INTEL         0x04
27 #define BTTV_DIAMOND       0x05 
28 #define BTTV_AVERMEDIA     0x06 
29 #define BTTV_MATRIX_VISION 0x07 
30 #define BTTV_FLYVIDEO      0x08
31 #define BTTV_TURBOTV       0x09
32 #define BTTV_HAUPPAUGE878  0x0a
33 #define BTTV_MIROPRO       0x0b
34 #define BTTV_ADSTECH_TV    0x0c
35 #define BTTV_AVERMEDIA98   0x0d
36 #define BTTV_VHX           0x0e
37 #define BTTV_ZOLTRIX       0x0f
38 #define BTTV_PIXVIEWPLAYTV 0x10
39 #define BTTV_WINVIEW_601   0x11
40 #define BTTV_AVEC_INTERCAP 0x12
41 #define BTTV_LIFE_FLYKIT   0x13
42 #define BTTV_CEI_RAFFLES   0x14
43 #define BTTV_CONFERENCETV  0x15
44 #define BTTV_PHOEBE_TVMAS  0x16
45 #define BTTV_MODTEC_205    0x17
46 #define BTTV_MAGICTVIEW061 0x18
47 #define BTTV_VOBIS_BOOSTAR 0x19
48 #define BTTV_HAUPPAUG_WCAM 0x1a
49 #define BTTV_MAXI          0x1b
50 #define BTTV_TERRATV       0x1c
51 #define BTTV_PXC200        0x1d
52 #define BTTV_FLYVIDEO_98   0x1e
53 #define BTTV_IPROTV        0x1f
54 #define BTTV_INTEL_C_S_PCI 0x20
55 #define BTTV_TERRATVALUE   0x21
56 #define BTTV_WINFAST2000   0x22
57 #define BTTV_CHRONOS_VS2   0x23
58 #define BTTV_TYPHOON_TVIEW 0x24
59 #define BTTV_PXELVWPLTVPRO 0x25
60 #define BTTV_MAGICTVIEW063 0x26
61 #define BTTV_PINNACLE      0x27
62 #define BTTV_STB2          0x28
63 #define BTTV_AVPHONE98     0x29
64 #define BTTV_PV951         0x2a
65 #define BTTV_ONAIR_TV      0x2b
66 #define BTTV_SIGMA_TVII_FM 0x2c
67 #define BTTV_MATRIX_VISION2 0x2d
68 #define BTTV_ZOLTRIX_GENIE 0x2e
69 #define BTTV_TERRATVRADIO  0x2f
70 #define BTTV_DYNALINK      0x30
71 #define BTTV_GVBCTV3PCI    0x31
72 #define BTTV_PXELVWPLTVPAK 0x32
73 #define BTTV_EAGLE         0x33
74 #define BTTV_PINNACLEPRO   0x34
75 #define BTTV_TVIEW_RDS_FM  0x35
76 #define BTTV_LIFETEC_9415  0x36
77 #define BTTV_BESTBUY_EASYTV 0x37
78 #define BTTV_FLYVIDEO_98FM 0x38
79 #define BTTV_GMV1          0x3d
80 #define BTTV_BESTBUY_EASYTV2 0x3e
81 #define BTTV_ATI_TVWONDER  0x3f
82 #define BTTV_ATI_TVWONDERVE 0x40
83 #define BTTV_FLYVIDEO2000   0x41
84 #define BTTV_TERRATVALUER   0x42
85 #define BTTV_GVBCTV4PCI     0x43
86 #define BTTV_VOODOOTV_FM    0x44
87 #define BTTV_AIMMS          0x45
88 #define BTTV_PV_BT878P_PLUS 0x46
89 #define BTTV_FLYVIDEO98EZ   0x47
90 #define BTTV_PV_BT878P_9B   0x48
91 #define BTTV_SENSORAY311    0x49
92 #define BTTV_RV605          0x4a
93 #define BTTV_WINDVR         0x4c
94 #define BTTV_GRANDTEC       0x4d
95 #define BTTV_KWORLD         0x4e
96 #define BTTV_HAUPPAUGEPVR   0x50
97 #define BTTV_GVBCTV5PCI     0x51
98 #define BTTV_OSPREY1x0      0x52
99 #define BTTV_OSPREY1x0_848  0x53
100 #define BTTV_OSPREY101_848  0x54
101 #define BTTV_OSPREY1x1      0x55
102 #define BTTV_OSPREY1x1_SVID 0x56
103 #define BTTV_OSPREY2xx      0x57
104 #define BTTV_OSPREY2x0_SVID 0x58
105 #define BTTV_OSPREY2x0      0x59
106 #define BTTV_OSPREY500      0x5a
107 #define BTTV_OSPREY540      0x5b
108 #define BTTV_OSPREY2000     0x5c
109 #define BTTV_IDS_EAGLE      0x5d
110 #define BTTV_PINNACLESAT    0x5e
111 #define BTTV_FORMAC_PROTV   0x5f
112 #define BTTV_EURESYS_PICOLO 0x61
113 #define BTTV_PV150          0x62
114 #define BTTV_AD_TVK503      0x63
115 #define BTTV_IVC200         0x66
116 #define BTTV_XGUARD         0x67
117 #define BTTV_NEBULA_DIGITV  0x68
118 #define BTTV_PV143          0x69
119 #define BTTV_IVC100         0x6e
120 #define BTTV_IVC120         0x6f
121 #define BTTV_PC_HDTV        0x70
122 #define BTTV_TWINHAN_DST    0x71
123 #define BTTV_WINFASTVC100   0x72
124 #define BTTV_SIMUS_GVC1100  0x74
125 #define BTTV_NGSTV_PLUS     0x75
126 #define BTTV_LMLBT4         0x76
127
128 /* i2c address list */
129 #define I2C_TSA5522        0xc2
130 #define I2C_TDA7432        0x8a
131 #define I2C_BT832_ALT1     0x88
132 #define I2C_BT832_ALT2     0x8a // alternate setting
133 #define I2C_TDA8425        0x82
134 #define I2C_TDA9840        0x84
135 #define I2C_TDA9850        0xb6 /* also used by 9855,9873 */
136 #define I2C_TDA9874        0xb0 /* also used by 9875 */
137 #define I2C_TDA9875        0xb0
138 #define I2C_HAUPEE         0xa0
139 #define I2C_STBEE          0xae
140 #define I2C_VHX            0xc0
141 #define I2C_MSP3400        0x80
142 #define I2C_MSP3400_ALT    0x88
143 #define I2C_TEA6300        0x80
144 #define I2C_DPL3518        0x84
145 #define I2C_TDA9887        0x86
146
147 /* more card-specific defines */
148 #define PT2254_L_CHANNEL 0x10
149 #define PT2254_R_CHANNEL 0x08
150 #define PT2254_DBS_IN_2 0x400
151 #define PT2254_DBS_IN_10 0x20000
152 #define WINVIEW_PT2254_CLK  0x40
153 #define WINVIEW_PT2254_DATA 0x20
154 #define WINVIEW_PT2254_STROBE 0x80
155
156 /* digital_mode */
157 #define DIGITAL_MODE_VIDEO 1
158 #define DIGITAL_MODE_CAMERA 2
159
160 struct bttv_core {
161         /* device structs */
162         struct pci_dev       *pci;
163         struct i2c_adapter   i2c_adap;
164         struct list_head     subs;     /* struct bttv_sub_device */
165
166         /* device config */
167         unsigned int         nr;       /* dev nr (for printk("bttv%d: ...");  */
168         unsigned int         type;     /* card type (pointer into tvcards[])  */
169         char                 name[8];  /* dev name */
170 };
171
172 struct bttv;
173
174 struct tvcard
175 {
176         char *name;
177         unsigned int video_inputs;
178         unsigned int audio_inputs;
179         unsigned int tuner;
180         unsigned int svhs;
181         unsigned int digital_mode; // DIGITAL_MODE_CAMERA or DIGITAL_MODE_VIDEO
182         u32 gpiomask;
183         u32 muxsel[16];
184         u32 audiomux[6]; /* Tuner, Radio, external, internal, mute, stereo */
185         u32 gpiomask2;   /* GPIO MUX mask */
186
187         /* i2c audio flags */
188         unsigned int no_msp34xx:1;
189         unsigned int no_tda9875:1;
190         unsigned int no_tda7432:1;
191         unsigned int needs_tvaudio:1;
192         unsigned int msp34xx_alt:1;
193
194         /* flag: video pci function is unused */
195         unsigned int no_video:1;
196         unsigned int has_dvb:1;
197         unsigned int has_remote:1;
198         unsigned int no_gpioirq:1;
199
200         /* other settings */
201         unsigned int pll;
202 #define PLL_NONE 0
203 #define PLL_28   1
204 #define PLL_35   2
205
206         unsigned int tuner_type;
207         unsigned int has_radio;
208         void (*audio_hook)(struct bttv *btv, struct video_audio *v, int set);
209         void (*muxsel_hook)(struct bttv *btv, unsigned int input);
210 };
211
212 extern struct tvcard bttv_tvcards[];
213 extern const unsigned int bttv_num_tvcards;
214
215 /* identification / initialization of the card */
216 extern void bttv_idcard(struct bttv *btv);
217 extern void bttv_init_card1(struct bttv *btv);
218 extern void bttv_init_card2(struct bttv *btv);
219
220 /* card-specific funtions */
221 extern void tea5757_set_freq(struct bttv *btv, unsigned short freq);
222 extern void bttv_tda9880_setnorm(struct bttv *btv, int norm);
223
224 /* kernel cmd line parse helper */
225 extern int bttv_parse(char *str, int max, int *vals);
226
227 /* extra tweaks for some chipsets */
228 extern void bttv_check_chipset(void);
229 extern int bttv_handle_chipset(struct bttv *btv);
230
231 /* ---------------------------------------------------------- */
232 /* exported by bttv-if.c                                      */
233
234 /* this obsolete -- please use the sysfs-based
235    interface below for new code */
236
237 /* returns card type + card ID (for bt878-based ones)
238    for possible values see lines below beginning with #define BTTV_UNKNOWN
239    returns negative value if error occurred 
240 */
241 extern int bttv_get_cardinfo(unsigned int card, int *type,
242                              unsigned int *cardid);
243 extern struct pci_dev* bttv_get_pcidev(unsigned int card);
244
245 /* obsolete, use bttv_get_cardinfo instead */
246 extern int bttv_get_id(unsigned int card);
247
248 /* sets GPOE register (BT848_GPIO_OUT_EN) to new value:
249    data | (current_GPOE_value & ~mask)
250    returns negative value if error occurred
251 */
252 extern int bttv_gpio_enable(unsigned int card,
253                             unsigned long mask, unsigned long data);
254
255 /* fills data with GPDATA register contents
256    returns negative value if error occurred
257 */
258 extern int bttv_read_gpio(unsigned int card, unsigned long *data);
259
260 /* sets GPDATA register to new value:
261   (data & mask) | (current_GPDATA_value & ~mask)
262   returns negative value if error occurred 
263 */
264 extern int bttv_write_gpio(unsigned int card,
265                            unsigned long mask, unsigned long data);
266
267 /* returns pointer to task queue which can be used as parameter to 
268    interruptible_sleep_on
269    in interrupt handler if BT848_INT_GPINT bit is set - this queue is activated
270    (wake_up_interruptible) and following call to the function bttv_read_gpio 
271    should return new value of GPDATA,
272    returns NULL value if error occurred or queue is not available
273    WARNING: because there is no buffer for GPIO data, one MUST 
274    process data ASAP
275 */
276 extern wait_queue_head_t* bttv_get_gpio_queue(unsigned int card);
277
278 /* call i2c clients
279 */
280 extern void bttv_i2c_call(unsigned int card, unsigned int cmd, void *arg);
281
282
283
284 /* ---------------------------------------------------------- */
285 /* sysfs/driver-moded based gpio access interface             */
286
287
288 struct bttv_sub_device {
289         struct device    dev;
290         struct bttv_core *core;
291         struct list_head list;
292 };
293 #define to_bttv_sub_dev(x) container_of((x), struct bttv_sub_device, dev)
294
295 struct bttv_sub_driver {
296         struct device_driver   drv;
297         char                   wanted[BUS_ID_SIZE];
298         void                   (*gpio_irq)(struct bttv_sub_device *sub);
299 };
300 #define to_bttv_sub_drv(x) container_of((x), struct bttv_sub_driver, drv)
301
302 int bttv_sub_register(struct bttv_sub_driver *drv, char *wanted);
303 int bttv_sub_unregister(struct bttv_sub_driver *drv);
304
305 /* gpio access functions */
306 void bttv_gpio_inout(struct bttv_core *core, u32 mask, u32 outbits);
307 u32 bttv_gpio_read(struct bttv_core *core);
308 void bttv_gpio_write(struct bttv_core *core, u32 value);
309 void bttv_gpio_bits(struct bttv_core *core, u32 mask, u32 bits);
310
311 #define gpio_inout(mask,bits)  bttv_gpio_inout(&btv->c, mask, bits)
312 #define gpio_read()            bttv_gpio_read(&btv->c)
313 #define gpio_write(value)      bttv_gpio_write(&btv->c, value)
314 #define gpio_bits(mask,bits)   bttv_gpio_bits(&btv->c, mask, bits)
315
316
317 /* ---------------------------------------------------------- */
318 /* i2c                                                        */
319
320 extern void bttv_bit_setscl(void *data, int state);
321 extern void bttv_bit_setsda(void *data, int state);
322 extern void bttv_call_i2c_clients(struct bttv *btv, unsigned int cmd, void *arg);
323 extern int bttv_I2CRead(struct bttv *btv, unsigned char addr, char *probe_for);
324 extern int bttv_I2CWrite(struct bttv *btv, unsigned char addr, unsigned char b1,
325                          unsigned char b2, int both);
326 extern void bttv_readee(struct bttv *btv, unsigned char *eedata, int addr);
327
328 #endif /* _BTTV_H_ */
329 /*
330  * Local variables:
331  * c-basic-offset: 8
332  * End:
333  */