Merge master.kernel.org:/pub/scm/linux/kernel/git/sam/kbuild
[sfrench/cifs-2.6.git] / drivers / media / video / bt8xx / 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 #include <media/i2c-addr.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             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_MINIDIN         0x6a
133 #define BTTV_BOARD_VD009X1_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
172 /* more card-specific defines */
173 #define PT2254_L_CHANNEL 0x10
174 #define PT2254_R_CHANNEL 0x08
175 #define PT2254_DBS_IN_2 0x400
176 #define PT2254_DBS_IN_10 0x20000
177 #define WINVIEW_PT2254_CLK  0x40
178 #define WINVIEW_PT2254_DATA 0x20
179 #define WINVIEW_PT2254_STROBE 0x80
180
181 /* digital_mode */
182 #define DIGITAL_MODE_VIDEO 1
183 #define DIGITAL_MODE_CAMERA 2
184
185 struct bttv_core {
186         /* device structs */
187         struct pci_dev       *pci;
188         struct i2c_adapter   i2c_adap;
189         struct list_head     subs;     /* struct bttv_sub_device */
190
191         /* device config */
192         unsigned int         nr;       /* dev nr (for printk("bttv%d: ...");  */
193         unsigned int         type;     /* card type (pointer into tvcards[])  */
194         char                 name[8];  /* dev name */
195 };
196
197 struct bttv;
198
199
200 struct bttv_ir {
201         struct input_dev        *dev;
202         struct ir_input_state   ir;
203         char                    name[32];
204         char                    phys[32];
205
206         /* Usual gpio signalling */
207
208         u32                     mask_keycode;
209         u32                     mask_keydown;
210         u32                     mask_keyup;
211         u32                     polling;
212         u32                     last_gpio;
213         struct work_struct      work;
214         struct timer_list       timer;
215
216         /* RC5 gpio */
217         u32 rc5_gpio;
218         struct timer_list timer_end;    /* timer_end for code completion */
219         struct timer_list timer_keyup;  /* timer_end for key release */
220         u32 last_rc5;                   /* last good rc5 code */
221         u32 last_bit;                   /* last raw bit seen */
222         u32 code;                       /* raw code under construction */
223         struct timeval base_time;       /* time of last seen code */
224         int active;                     /* building raw code */
225 };
226
227 struct tvcard
228 {
229         char *name;
230         unsigned int video_inputs;
231         unsigned int audio_inputs;
232         unsigned int tuner;
233         unsigned int svhs;
234         unsigned int digital_mode; // DIGITAL_MODE_CAMERA or DIGITAL_MODE_VIDEO
235         u32 gpiomask;
236         u32 muxsel[16];
237         u32 gpiomux[4];  /* Tuner, Radio, external, internal */
238         u32 gpiomute;    /* GPIO mute setting */
239         u32 gpiomask2;   /* GPIO MUX mask */
240
241         /* i2c audio flags */
242         unsigned int no_msp34xx:1;
243         unsigned int no_tda9875:1;
244         unsigned int no_tda7432:1;
245         unsigned int needs_tvaudio:1;
246         unsigned int msp34xx_alt:1;
247
248         /* flag: video pci function is unused */
249         unsigned int no_video:1;
250         unsigned int has_dvb:1;
251         unsigned int has_remote:1;
252         unsigned int no_gpioirq:1;
253
254         /* other settings */
255         unsigned int pll;
256 #define PLL_NONE 0
257 #define PLL_28   1
258 #define PLL_35   2
259
260         unsigned int tuner_type;
261         unsigned int tuner_addr;
262         unsigned int radio_addr;
263
264         unsigned int has_radio;
265         void (*audio_hook)(struct bttv *btv, struct video_audio *v, int set);
266         void (*muxsel_hook)(struct bttv *btv, unsigned int input);
267 };
268
269 extern struct tvcard bttv_tvcards[];
270
271 /* identification / initialization of the card */
272 extern void bttv_idcard(struct bttv *btv);
273 extern void bttv_init_card1(struct bttv *btv);
274 extern void bttv_init_card2(struct bttv *btv);
275
276 /* card-specific funtions */
277 extern void tea5757_set_freq(struct bttv *btv, unsigned short freq);
278 extern void bttv_tda9880_setnorm(struct bttv *btv, int norm);
279
280 /* extra tweaks for some chipsets */
281 extern void bttv_check_chipset(void);
282 extern int bttv_handle_chipset(struct bttv *btv);
283
284 /* ---------------------------------------------------------- */
285 /* exported by bttv-if.c                                      */
286
287 /* this obsolete -- please use the sysfs-based
288    interface below for new code */
289
290 /* returns card type + card ID (for bt878-based ones)
291    for possible values see lines below beginning with #define BTTV_BOARD_UNKNOWN
292    returns negative value if error occurred
293 */
294 extern int bttv_get_cardinfo(unsigned int card, int *type,
295                              unsigned int *cardid);
296 extern struct pci_dev* bttv_get_pcidev(unsigned int card);
297
298 /* obsolete, use bttv_get_cardinfo instead */
299 extern int bttv_get_id(unsigned int card);
300
301 /* sets GPOE register (BT848_GPIO_OUT_EN) to new value:
302    data | (current_GPOE_value & ~mask)
303    returns negative value if error occurred
304 */
305 extern int bttv_gpio_enable(unsigned int card,
306                             unsigned long mask, unsigned long data);
307
308 /* fills data with GPDATA register contents
309    returns negative value if error occurred
310 */
311 extern int bttv_read_gpio(unsigned int card, unsigned long *data);
312
313 /* sets GPDATA register to new value:
314   (data & mask) | (current_GPDATA_value & ~mask)
315   returns negative value if error occurred
316 */
317 extern int bttv_write_gpio(unsigned int card,
318                            unsigned long mask, unsigned long data);
319
320 /* returns pointer to task queue which can be used as parameter to
321    interruptible_sleep_on
322    in interrupt handler if BT848_INT_GPINT bit is set - this queue is activated
323    (wake_up_interruptible) and following call to the function bttv_read_gpio
324    should return new value of GPDATA,
325    returns NULL value if error occurred or queue is not available
326    WARNING: because there is no buffer for GPIO data, one MUST
327    process data ASAP
328 */
329 extern wait_queue_head_t* bttv_get_gpio_queue(unsigned int card);
330
331 /* call i2c clients
332 */
333 extern void bttv_i2c_call(unsigned int card, unsigned int cmd, void *arg);
334
335
336
337 /* ---------------------------------------------------------- */
338 /* sysfs/driver-moded based gpio access interface             */
339
340
341 struct bttv_sub_device {
342         struct device    dev;
343         struct bttv_core *core;
344         struct list_head list;
345 };
346 #define to_bttv_sub_dev(x) container_of((x), struct bttv_sub_device, dev)
347
348 struct bttv_sub_driver {
349         struct device_driver   drv;
350         char                   wanted[BUS_ID_SIZE];
351         int                    (*probe)(struct bttv_sub_device *sub);
352         void                   (*remove)(struct bttv_sub_device *sub);
353         void                   (*gpio_irq)(struct bttv_sub_device *sub);
354 };
355 #define to_bttv_sub_drv(x) container_of((x), struct bttv_sub_driver, drv)
356
357 int bttv_sub_register(struct bttv_sub_driver *drv, char *wanted);
358 int bttv_sub_unregister(struct bttv_sub_driver *drv);
359
360 /* gpio access functions */
361 void bttv_gpio_inout(struct bttv_core *core, u32 mask, u32 outbits);
362 u32 bttv_gpio_read(struct bttv_core *core);
363 void bttv_gpio_write(struct bttv_core *core, u32 value);
364 void bttv_gpio_bits(struct bttv_core *core, u32 mask, u32 bits);
365
366 #define gpio_inout(mask,bits)  bttv_gpio_inout(&btv->c, mask, bits)
367 #define gpio_read()            bttv_gpio_read(&btv->c)
368 #define gpio_write(value)      bttv_gpio_write(&btv->c, value)
369 #define gpio_bits(mask,bits)   bttv_gpio_bits(&btv->c, mask, bits)
370
371
372 /* ---------------------------------------------------------- */
373 /* i2c                                                        */
374
375 extern void bttv_call_i2c_clients(struct bttv *btv, unsigned int cmd, void *arg);
376 extern int bttv_I2CRead(struct bttv *btv, unsigned char addr, char *probe_for);
377 extern int bttv_I2CWrite(struct bttv *btv, unsigned char addr, unsigned char b1,
378                          unsigned char b2, int both);
379 extern void bttv_readee(struct bttv *btv, unsigned char *eedata, int addr);
380
381 extern int bttv_input_init(struct bttv *dev);
382 extern void bttv_input_fini(struct bttv *dev);
383 extern void bttv_input_irq(struct bttv *dev);
384
385 #endif /* _BTTV_H_ */
386 /*
387  * Local variables:
388  * c-basic-offset: 8
389  * End:
390  */