V4L/DVB (3306): Fixed i2c return value, conversion mdelay to msleep
[linux-2.6] / drivers / media / video / bttv.h
1 /*
2  *
3  *  bttv - Bt848 frame grabber driver
4  *
5  *  card ID's and external interfaces of the bttv driver
6  *  basically stuff needed by other drivers (i2c, lirc, ...)
7  *  and is supported not to change much over time.
8  *
9  *  Copyright (C) 1996,97 Ralph Metzler (rjkm@thp.uni-koeln.de)
10  *  (c) 1999,2000 Gerd Knorr <kraxel@goldbach.in-berlin.de>
11  *
12  */
13
14 #ifndef _BTTV_H_
15 #define _BTTV_H_
16
17 #include <linux/videodev.h>
18 #include <linux/i2c.h>
19 #include <media/ir-common.h>
20 #include <media/ir-kbd-i2c.h>
21
22 /* ---------------------------------------------------------- */
23 /* exported by bttv-cards.c                                   */
24
25 #define BTTV_BOARD_UNKNOWN                 0x00
26 #define BTTV_BOARD_MIRO                    0x01
27 #define BTTV_BOARD_HAUPPAUGE               0x02
28 #define BTTV_BOARD_STB                     0x03
29 #define BTTV_BOARD_INTEL                   0x04
30 #define BTTV_BOARD_DIAMOND                 0x05
31 #define BTTV_BOARD_AVERMEDIA               0x06
32 #define BTTV_BOARD_MATRIX_VISION           0x07
33 #define BTTV_BOARD_FLYVIDEO                0x08
34 #define BTTV_BOARD_TURBOTV                 0x09
35 #define BTTV_BOARD_HAUPPAUGE878            0x0a
36 #define BTTV_BOARD_MIROPRO                 0x0b
37 #define BTTV_BOARD_ADSTECH_TV              0x0c
38 #define BTTV_BOARD_AVERMEDIA98             0x0d
39 #define BTTV_BOARD_VHX                     0x0e
40 #define BTTV_BOARD_ZOLTRIX                 0x0f
41 #define BTTV_BOARD_PIXVIEWPLAYTV           0x10
42 #define BTTV_BOARD_WINVIEW_601             0x11
43 #define BTTV_BOARD_AVEC_INTERCAP           0x12
44 #define BTTV_BOARD_LIFE_FLYKIT             0x13
45 #define BTTV_BOARD_CEI_RAFFLES             0x14
46 #define BTTV_BOARD_CONFERENCETV            0x15
47 #define BTTV_BOARD_PHOEBE_TVMAS            0x16
48 #define BTTV_BOARD_MODTEC_205              0x17
49 #define BTTV_BOARD_MAGICTVIEW061           0x18
50 #define BTTV_BOARD_VOBIS_BOOSTAR           0x19
51 #define BTTV_BOARD_HAUPPAUG_WCAM           0x1a
52 #define BTTV_BOARD_MAXI                    0x1b
53 #define BTTV_BOARD_TERRATV                 0x1c
54 #define BTTV_BOARD_PXC200                  0x1d
55 #define BTTV_BOARD_FLYVIDEO_98             0x1e
56 #define BTTV_BOARD_IPROTV                  0x1f
57 #define BTTV_BOARD_INTEL_C_S_PCI           0x20
58 #define BTTV_BOARD_TERRATVALUE             0x21
59 #define BTTV_BOARD_WINFAST2000             0x22
60 #define BTTV_BOARD_CHRONOS_VS2             0x23
61 #define BTTV_BOARD_TYPHOON_TVIEW           0x24
62 #define BTTV_BOARD_PXELVWPLTVPRO           0x25
63 #define BTTV_BOARD_MAGICTVIEW063           0x26
64 #define BTTV_BOARD_PINNACLE                0x27
65 #define BTTV_BOARD_STB2                    0x28
66 #define BTTV_BOARD_AVPHONE98               0x29
67 #define BTTV_BOARD_PV951                   0x2a
68 #define BTTV_BOARD_ONAIR_TV                0x2b
69 #define BTTV_BOARD_SIGMA_TVII_FM           0x2c
70 #define BTTV_BOARD_MATRIX_VISION2          0x2d
71 #define BTTV_BOARD_ZOLTRIX_GENIE           0x2e
72 #define BTTV_BOARD_TERRATVRADIO            0x2f
73 #define BTTV_BOARD_DYNALINK                0x30
74 #define BTTV_BOARD_GVBCTV3PCI              0x31
75 #define BTTV_BOARD_PXELVWPLTVPAK           0x32
76 #define BTTV_BOARD_EAGLE                   0x33
77 #define BTTV_BOARD_PINNACLEPRO             0x34
78 #define BTTV_BOARD_TVIEW_RDS_FM            0x35
79 #define BTTV_BOARD_LIFETEC_9415            0x36
80 #define BTTV_BOARD_BESTBUY_EASYTV          0x37
81 #define BTTV_BOARD_FLYVIDEO_98FM           0x38
82 #define BTTV_BOARD_GRANDTEC                0x39
83 #define BTTV_BOARD_ASKEY_CPH060            0x3a
84 #define BTTV_BOARD_ASKEY_CPH03X            0x3b
85 #define BTTV_BOARD_MM100PCTV               0x3c
86 #define BTTV_BOARD_GMV1                    0x3d
87 #define BTTV_BOARD_BESTBUY_EASYTV2         0x3e
88 #define BTTV_BOARD_ATI_TVWONDER            0x3f
89 #define BTTV_BOARD_ATI_TVWONDERVE          0x40
90 #define BTTV_BOARD_FLYVIDEO2000            0x41
91 #define BTTV_BOARD_TERRATVALUER            0x42
92 #define BTTV_BOARD_GVBCTV4PCI              0x43
93 #define BTTV_BOARD_VOODOOTV_FM             0x44
94 #define BTTV_BOARD_AIMMS                   0x45
95 #define BTTV_BOARD_PV_BT878P_PLUS          0x46
96 #define BTTV_BOARD_FLYVIDEO98EZ            0x47
97 #define BTTV_BOARD_PV_BT878P_9B            0x48
98 #define BTTV_BOARD_SENSORAY311             0x49
99 #define BTTV_BOARD_RV605                   0x4a
100 #define BTTV_BOARD_POWERCLR_MTV878         0x4b
101 #define BTTV_BOARD_WINDVR                  0x4c
102 #define BTTV_BOARD_GRANDTEC_MULTI          0x4d
103 #define BTTV_BOARD_KWORLD                  0x4e
104 #define BTTV_BOARD_DSP_TCVIDEO             0x4f
105 #define BTTV_BOARD_HAUPPAUGEPVR            0x50
106 #define BTTV_BOARD_GVBCTV5PCI              0x51
107 #define BTTV_BOARD_OSPREY1x0               0x52
108 #define BTTV_BOARD_OSPREY1x0_848           0x53
109 #define BTTV_BOARD_OSPREY101_848           0x54
110 #define BTTV_BOARD_OSPREY1x1               0x55
111 #define BTTV_BOARD_OSPREY1x1_SVID          0x56
112 #define BTTV_BOARD_OSPREY2xx               0x57
113 #define BTTV_BOARD_OSPREY2x0_SVID          0x58
114 #define BTTV_BOARD_OSPREY2x0               0x59
115 #define BTTV_BOARD_OSPREY500               0x5a
116 #define BTTV_BOARD_OSPREY540               0x5b
117 #define BTTV_BOARD_OSPREY2000              0x5c
118 #define BTTV_BOARD_IDS_EAGLE               0x5d
119 #define BTTV_BOARD_PINNACLESAT             0x5e
120 #define BTTV_BOARD_FORMAC_PROTV            0x5f
121 #define BTTV_BOARD_MACHTV                  0x60
122 #define BTTV_BOARD_EURESYS_PICOLO          0x61
123 #define BTTV_BOARD_PV150                   0x62
124 #define BTTV_BOARD_AD_TVK503               0x63
125 #define BTTV_BOARD_HERCULES_SM_TV          0x64
126 #define BTTV_BOARD_PACETV                  0x65
127 #define BTTV_BOARD_IVC200                  0x66
128 #define BTTV_BOARD_XGUARD                  0x67
129 #define BTTV_BOARD_NEBULA_DIGITV           0x68
130 #define BTTV_BOARD_PV143                   0x69
131 #define BTTV_BOARD_VD009X1_MINIDIN         0x6a
132 #define BTTV_BOARD_VD009X1_COMBI           0x6b
133 #define BTTV_BOARD_VD009_MINIDIN           0x6c
134 #define BTTV_BOARD_VD009_COMBI             0x6d
135 #define BTTV_BOARD_IVC100                  0x6e
136 #define BTTV_BOARD_IVC120                  0x6f
137 #define BTTV_BOARD_PC_HDTV                 0x70
138 #define BTTV_BOARD_TWINHAN_DST             0x71
139 #define BTTV_BOARD_WINFASTVC100            0x72
140 #define BTTV_BOARD_TEV560                  0x73
141 #define BTTV_BOARD_SIMUS_GVC1100           0x74
142 #define BTTV_BOARD_NGSTV_PLUS              0x75
143 #define BTTV_BOARD_LMLBT4                  0x76
144 #define BTTV_BOARD_TEKRAM_M205             0x77
145 #define BTTV_BOARD_CONTVFMI                0x78
146 #define BTTV_BOARD_PICOLO_TETRA_CHIP       0x79
147 #define BTTV_BOARD_SPIRIT_TV               0x7a
148 #define BTTV_BOARD_AVDVBT_771              0x7b
149 #define BTTV_BOARD_AVDVBT_761              0x7c
150 #define BTTV_BOARD_MATRIX_VISIONSQ         0x7d
151 #define BTTV_BOARD_MATRIX_VISIONSLC        0x7e
152 #define BTTV_BOARD_APAC_VIEWCOMP           0x7f
153 #define BTTV_BOARD_DVICO_DVBT_LITE         0x80
154 #define BTTV_BOARD_VGEAR_MYVCD             0x81
155 #define BTTV_BOARD_SUPER_TV                0x82
156 #define BTTV_BOARD_TIBET_CS16              0x83
157 #define BTTV_BOARD_KODICOM_4400R           0x84
158 #define BTTV_BOARD_KODICOM_4400R_SL        0x85
159 #define BTTV_BOARD_ADLINK_RTV24            0x86
160 #define BTTV_BOARD_DVICO_FUSIONHDTV_5_LITE 0x87
161 #define BTTV_BOARD_ACORP_Y878F             0x88
162 #define BTTV_BOARD_CONCEPTRONIC_CTVFMI2    0x89
163 #define BTTV_BOARD_PV_BT878P_2E            0x8a
164 #define BTTV_BOARD_PV_M4900                0x8b
165 #define BTTV_BOARD_OSPREY440               0x8c
166 #define BTTV_BOARD_ASOUND_SKYEYE           0x8d
167 #define BTTV_BOARD_SABRENT_TVFM            0x8e
168 #define BTTV_BOARD_HAUPPAUGE_IMPACTVCB     0x8f
169 #define BTTV_BOARD_MACHTV_MAGICTV          0x90
170
171 /* i2c address list */
172 #define I2C_TSA5522        0xc2
173 #define I2C_TDA7432        0x8a
174 #define I2C_BT832_ALT1     0x88
175 #define I2C_BT832_ALT2     0x8a // alternate setting
176 #define I2C_TDA8425        0x82
177 #define I2C_TDA9840        0x84
178 #define I2C_TDA9850        0xb6 /* also used by 9855,9873 */
179 #define I2C_TDA9874        0xb0 /* also used by 9875 */
180 #define I2C_TDA9875        0xb0
181 #define I2C_HAUPEE         0xa0
182 #define I2C_STBEE          0xae
183 #define I2C_VHX            0xc0
184 #define I2C_MSP3400        0x80
185 #define I2C_MSP3400_ALT    0x88
186 #define I2C_TEA6300        0x80 /* also used by 6320 */
187 #define I2C_DPL3518        0x84
188 #define I2C_TDA9887        0x86
189
190 /* more card-specific defines */
191 #define PT2254_L_CHANNEL 0x10
192 #define PT2254_R_CHANNEL 0x08
193 #define PT2254_DBS_IN_2 0x400
194 #define PT2254_DBS_IN_10 0x20000
195 #define WINVIEW_PT2254_CLK  0x40
196 #define WINVIEW_PT2254_DATA 0x20
197 #define WINVIEW_PT2254_STROBE 0x80
198
199 /* digital_mode */
200 #define DIGITAL_MODE_VIDEO 1
201 #define DIGITAL_MODE_CAMERA 2
202
203 struct bttv_core {
204         /* device structs */
205         struct pci_dev       *pci;
206         struct i2c_adapter   i2c_adap;
207         struct list_head     subs;     /* struct bttv_sub_device */
208
209         /* device config */
210         unsigned int         nr;       /* dev nr (for printk("bttv%d: ...");  */
211         unsigned int         type;     /* card type (pointer into tvcards[])  */
212         char                 name[8];  /* dev name */
213 };
214
215 struct bttv;
216
217
218 struct bttv_ir {
219         struct input_dev        *dev;
220         struct ir_input_state   ir;
221         char                    name[32];
222         char                    phys[32];
223
224         /* Usual gpio signalling */
225
226         u32                     mask_keycode;
227         u32                     mask_keydown;
228         u32                     mask_keyup;
229         u32                     polling;
230         u32                     last_gpio;
231         struct work_struct      work;
232         struct timer_list       timer;
233
234         /* RC5 gpio */
235         u32 rc5_gpio;
236         struct timer_list timer_end;    /* timer_end for code completion */
237         struct timer_list timer_keyup;  /* timer_end for key release */
238         u32 last_rc5;                   /* last good rc5 code */
239         u32 last_bit;                   /* last raw bit seen */
240         u32 code;                       /* raw code under construction */
241         struct timeval base_time;       /* time of last seen code */
242         int active;                     /* building raw code */
243 };
244
245 struct tvcard
246 {
247         char *name;
248         unsigned int video_inputs;
249         unsigned int audio_inputs;
250         unsigned int tuner;
251         unsigned int svhs;
252         unsigned int digital_mode; // DIGITAL_MODE_CAMERA or DIGITAL_MODE_VIDEO
253         u32 gpiomask;
254         u32 muxsel[16];
255         u32 audiomux[6]; /* Tuner, Radio, external, internal, mute, stereo */
256         u32 gpiomask2;   /* GPIO MUX mask */
257
258         /* i2c audio flags */
259         unsigned int no_msp34xx:1;
260         unsigned int no_tda9875:1;
261         unsigned int no_tda7432:1;
262         unsigned int needs_tvaudio:1;
263         unsigned int msp34xx_alt:1;
264
265         /* flag: video pci function is unused */
266         unsigned int no_video:1;
267         unsigned int has_dvb:1;
268         unsigned int has_remote:1;
269         unsigned int no_gpioirq:1;
270
271         /* other settings */
272         unsigned int pll;
273 #define PLL_NONE 0
274 #define PLL_28   1
275 #define PLL_35   2
276
277         unsigned int tuner_type;
278         unsigned int tuner_addr;
279         unsigned int radio_addr;
280
281         unsigned int has_radio;
282         void (*audio_hook)(struct bttv *btv, struct video_audio *v, int set);
283         void (*muxsel_hook)(struct bttv *btv, unsigned int input);
284 };
285
286 extern struct tvcard bttv_tvcards[];
287
288 /* identification / initialization of the card */
289 extern void bttv_idcard(struct bttv *btv);
290 extern void bttv_init_card1(struct bttv *btv);
291 extern void bttv_init_card2(struct bttv *btv);
292
293 /* card-specific funtions */
294 extern void tea5757_set_freq(struct bttv *btv, unsigned short freq);
295 extern void bttv_tda9880_setnorm(struct bttv *btv, int norm);
296
297 /* extra tweaks for some chipsets */
298 extern void bttv_check_chipset(void);
299 extern int bttv_handle_chipset(struct bttv *btv);
300
301 /* ---------------------------------------------------------- */
302 /* exported by bttv-if.c                                      */
303
304 /* this obsolete -- please use the sysfs-based
305    interface below for new code */
306
307 /* returns card type + card ID (for bt878-based ones)
308    for possible values see lines below beginning with #define BTTV_BOARD_UNKNOWN
309    returns negative value if error occurred
310 */
311 extern int bttv_get_cardinfo(unsigned int card, int *type,
312                              unsigned int *cardid);
313 extern struct pci_dev* bttv_get_pcidev(unsigned int card);
314
315 /* obsolete, use bttv_get_cardinfo instead */
316 extern int bttv_get_id(unsigned int card);
317
318 /* sets GPOE register (BT848_GPIO_OUT_EN) to new value:
319    data | (current_GPOE_value & ~mask)
320    returns negative value if error occurred
321 */
322 extern int bttv_gpio_enable(unsigned int card,
323                             unsigned long mask, unsigned long data);
324
325 /* fills data with GPDATA register contents
326    returns negative value if error occurred
327 */
328 extern int bttv_read_gpio(unsigned int card, unsigned long *data);
329
330 /* sets GPDATA register to new value:
331   (data & mask) | (current_GPDATA_value & ~mask)
332   returns negative value if error occurred
333 */
334 extern int bttv_write_gpio(unsigned int card,
335                            unsigned long mask, unsigned long data);
336
337 /* returns pointer to task queue which can be used as parameter to
338    interruptible_sleep_on
339    in interrupt handler if BT848_INT_GPINT bit is set - this queue is activated
340    (wake_up_interruptible) and following call to the function bttv_read_gpio
341    should return new value of GPDATA,
342    returns NULL value if error occurred or queue is not available
343    WARNING: because there is no buffer for GPIO data, one MUST
344    process data ASAP
345 */
346 extern wait_queue_head_t* bttv_get_gpio_queue(unsigned int card);
347
348 /* call i2c clients
349 */
350 extern void bttv_i2c_call(unsigned int card, unsigned int cmd, void *arg);
351
352
353
354 /* ---------------------------------------------------------- */
355 /* sysfs/driver-moded based gpio access interface             */
356
357
358 struct bttv_sub_device {
359         struct device    dev;
360         struct bttv_core *core;
361         struct list_head list;
362 };
363 #define to_bttv_sub_dev(x) container_of((x), struct bttv_sub_device, dev)
364
365 struct bttv_sub_driver {
366         struct device_driver   drv;
367         char                   wanted[BUS_ID_SIZE];
368         int                    (*probe)(struct bttv_sub_device *sub);
369         void                   (*remove)(struct bttv_sub_device *sub);
370         void                   (*gpio_irq)(struct bttv_sub_device *sub);
371 };
372 #define to_bttv_sub_drv(x) container_of((x), struct bttv_sub_driver, drv)
373
374 int bttv_sub_register(struct bttv_sub_driver *drv, char *wanted);
375 int bttv_sub_unregister(struct bttv_sub_driver *drv);
376
377 /* gpio access functions */
378 void bttv_gpio_inout(struct bttv_core *core, u32 mask, u32 outbits);
379 u32 bttv_gpio_read(struct bttv_core *core);
380 void bttv_gpio_write(struct bttv_core *core, u32 value);
381 void bttv_gpio_bits(struct bttv_core *core, u32 mask, u32 bits);
382
383 #define gpio_inout(mask,bits)  bttv_gpio_inout(&btv->c, mask, bits)
384 #define gpio_read()            bttv_gpio_read(&btv->c)
385 #define gpio_write(value)      bttv_gpio_write(&btv->c, value)
386 #define gpio_bits(mask,bits)   bttv_gpio_bits(&btv->c, mask, bits)
387
388
389 /* ---------------------------------------------------------- */
390 /* i2c                                                        */
391
392 extern void bttv_call_i2c_clients(struct bttv *btv, unsigned int cmd, void *arg);
393 extern int bttv_I2CRead(struct bttv *btv, unsigned char addr, char *probe_for);
394 extern int bttv_I2CWrite(struct bttv *btv, unsigned char addr, unsigned char b1,
395                          unsigned char b2, int both);
396 extern void bttv_readee(struct bttv *btv, unsigned char *eedata, int addr);
397
398 extern int bttv_input_init(struct bttv *dev);
399 extern void bttv_input_fini(struct bttv *dev);
400 extern void bttv_input_irq(struct bttv *dev);
401
402 #endif /* _BTTV_H_ */
403 /*
404  * Local variables:
405  * c-basic-offset: 8
406  * End:
407  */