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