Merge with /pub/scm/linux/kernel/git/torvalds/linux-2.6.git
[pandora-kernel.git] / drivers / media / video / cx88 / cx88.h
1 /*
2  *
3  * v4l2 device driver for cx2388x based TV cards
4  *
5  * (c) 2003,04 Gerd Knorr <kraxel@bytesex.org> [SUSE Labs]
6  *
7  *  This program is free software; you can redistribute it and/or modify
8  *  it under the terms of the GNU General Public License as published by
9  *  the Free Software Foundation; either version 2 of the License, or
10  *  (at your option) any later version.
11  *
12  *  This program is distributed in the hope that it will be useful,
13  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
14  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  *  GNU General Public License for more details.
16  *
17  *  You should have received a copy of the GNU General Public License
18  *  along with this program; if not, write to the Free Software
19  *  Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
20  */
21
22 #include <linux/pci.h>
23 #include <linux/i2c.h>
24 #include <linux/i2c-algo-bit.h>
25 #include <linux/videodev2.h>
26 #include <linux/kdev_t.h>
27
28 #include <media/tuner.h>
29 #include <media/tveeprom.h>
30 #include <media/video-buf.h>
31 #include <media/video-buf-dvb.h>
32
33 #include "btcx-risc.h"
34 #include "cx88-reg.h"
35
36 #include <linux/version.h>
37 #include <linux/mutex.h>
38 #define CX88_VERSION_CODE KERNEL_VERSION(0,0,5)
39
40 #ifndef TRUE
41 # define TRUE (1==1)
42 #endif
43 #ifndef FALSE
44 # define FALSE (1==0)
45 #endif
46 #define UNSET (-1U)
47
48 #define CX88_MAXBOARDS 8
49
50 /* Max number of inputs by card */
51 #define MAX_CX88_INPUT 8
52
53 /* ----------------------------------------------------------- */
54 /* defines and enums                                           */
55
56 #define FORMAT_FLAGS_PACKED       0x01
57 #define FORMAT_FLAGS_PLANAR       0x02
58
59 #define VBI_LINE_COUNT              17
60 #define VBI_LINE_LENGTH           2048
61
62 /* need "shadow" registers for some write-only ones ... */
63 #define SHADOW_AUD_VOL_CTL           1
64 #define SHADOW_AUD_BAL_CTL           2
65 #define SHADOW_MAX                   3
66
67 /* FM Radio deemphasis type */
68 enum cx88_deemph_type {
69         FM_NO_DEEMPH = 0,
70         FM_DEEMPH_50,
71         FM_DEEMPH_75
72 };
73
74 /* ----------------------------------------------------------- */
75 /* tv norms                                                    */
76
77 struct cx88_tvnorm {
78         char                   *name;
79         v4l2_std_id            id;
80         u32                    cxiformat;
81         u32                    cxoformat;
82 };
83
84 static unsigned int inline norm_maxw(struct cx88_tvnorm *norm)
85 {
86         return (norm->id & V4L2_STD_625_50) ? 768 : 640;
87 }
88
89
90 static unsigned int inline norm_maxh(struct cx88_tvnorm *norm)
91 {
92         return (norm->id & V4L2_STD_625_50) ? 576 : 480;
93 }
94
95 /* ----------------------------------------------------------- */
96 /* static data                                                 */
97
98 struct cx8800_fmt {
99         char  *name;
100         u32   fourcc;          /* v4l2 format id */
101         int   depth;
102         int   flags;
103         u32   cxformat;
104 };
105
106 struct cx88_ctrl {
107         struct v4l2_queryctrl  v;
108         u32                    off;
109         u32                    reg;
110         u32                    sreg;
111         u32                    mask;
112         u32                    shift;
113 };
114
115 /* ----------------------------------------------------------- */
116 /* SRAM memory management data (see cx88-core.c)               */
117
118 #define SRAM_CH21 0   /* video */
119 #define SRAM_CH22 1
120 #define SRAM_CH23 2
121 #define SRAM_CH24 3   /* vbi   */
122 #define SRAM_CH25 4   /* audio */
123 #define SRAM_CH26 5
124 #define SRAM_CH28 6   /* mpeg */
125 /* more */
126
127 struct sram_channel {
128         char *name;
129         u32  cmds_start;
130         u32  ctrl_start;
131         u32  cdt;
132         u32  fifo_start;
133         u32  fifo_size;
134         u32  ptr1_reg;
135         u32  ptr2_reg;
136         u32  cnt1_reg;
137         u32  cnt2_reg;
138 };
139 extern struct sram_channel cx88_sram_channels[];
140
141 /* ----------------------------------------------------------- */
142 /* card configuration                                          */
143
144 #define CX88_BOARD_NOAUTO               UNSET
145 #define CX88_BOARD_UNKNOWN                  0
146 #define CX88_BOARD_HAUPPAUGE                1
147 #define CX88_BOARD_GDI                      2
148 #define CX88_BOARD_PIXELVIEW                3
149 #define CX88_BOARD_ATI_WONDER_PRO           4
150 #define CX88_BOARD_WINFAST2000XP_EXPERT     5
151 #define CX88_BOARD_AVERTV_STUDIO_303        6
152 #define CX88_BOARD_MSI_TVANYWHERE_MASTER    7
153 #define CX88_BOARD_WINFAST_DV2000           8
154 #define CX88_BOARD_LEADTEK_PVR2000          9
155 #define CX88_BOARD_IODATA_GVVCP3PCI        10
156 #define CX88_BOARD_PROLINK_PLAYTVPVR       11
157 #define CX88_BOARD_ASUS_PVR_416            12
158 #define CX88_BOARD_MSI_TVANYWHERE          13
159 #define CX88_BOARD_KWORLD_DVB_T            14
160 #define CX88_BOARD_DVICO_FUSIONHDTV_DVB_T1 15
161 #define CX88_BOARD_KWORLD_LTV883           16
162 #define CX88_BOARD_DVICO_FUSIONHDTV_3_GOLD_Q  17
163 #define CX88_BOARD_HAUPPAUGE_DVB_T1        18
164 #define CX88_BOARD_CONEXANT_DVB_T1         19
165 #define CX88_BOARD_PROVIDEO_PV259          20
166 #define CX88_BOARD_DVICO_FUSIONHDTV_DVB_T_PLUS 21
167 #define CX88_BOARD_PCHDTV_HD3000           22
168 #define CX88_BOARD_DNTV_LIVE_DVB_T         23
169 #define CX88_BOARD_HAUPPAUGE_ROSLYN        24
170 #define CX88_BOARD_DIGITALLOGIC_MEC        25
171 #define CX88_BOARD_IODATA_GVBCTV7E         26
172 #define CX88_BOARD_PIXELVIEW_PLAYTV_ULTRA_PRO 27
173 #define CX88_BOARD_DVICO_FUSIONHDTV_3_GOLD_T  28
174 #define CX88_BOARD_ADSTECH_DVB_T_PCI          29
175 #define CX88_BOARD_TERRATEC_CINERGY_1400_DVB_T1  30
176 #define CX88_BOARD_DVICO_FUSIONHDTV_5_GOLD 31
177 #define CX88_BOARD_AVERMEDIA_ULTRATV_MC_550 32
178 #define CX88_BOARD_KWORLD_VSTREAM_EXPERT_DVD 33
179 #define CX88_BOARD_ATI_HDTVWONDER          34
180 #define CX88_BOARD_WINFAST_DTV1000         35
181 #define CX88_BOARD_AVERTV_303              36
182 #define CX88_BOARD_HAUPPAUGE_NOVASPLUS_S1  37
183 #define CX88_BOARD_HAUPPAUGE_NOVASE2_S1    38
184 #define CX88_BOARD_KWORLD_DVBS_100         39
185 #define CX88_BOARD_HAUPPAUGE_HVR1100       40
186 #define CX88_BOARD_HAUPPAUGE_HVR1100LP     41
187 #define CX88_BOARD_DNTV_LIVE_DVB_T_PRO     42
188 #define CX88_BOARD_KWORLD_DVB_T_CX22702    43
189 #define CX88_BOARD_DVICO_FUSIONHDTV_DVB_T_DUAL 44
190 #define CX88_BOARD_KWORLD_HARDWARE_MPEG_TV_XPERT 45
191 #define CX88_BOARD_DVICO_FUSIONHDTV_DVB_T_HYBRID 46
192
193 enum cx88_itype {
194         CX88_VMUX_COMPOSITE1 = 1,
195         CX88_VMUX_COMPOSITE2,
196         CX88_VMUX_COMPOSITE3,
197         CX88_VMUX_COMPOSITE4,
198         CX88_VMUX_SVIDEO,
199         CX88_VMUX_TELEVISION,
200         CX88_VMUX_CABLE,
201         CX88_VMUX_DVB,
202         CX88_VMUX_DEBUG,
203         CX88_RADIO,
204 };
205
206 struct cx88_input {
207         enum cx88_itype type;
208         unsigned int    vmux;
209         u32             gpio0, gpio1, gpio2, gpio3;
210 };
211
212 struct cx88_board {
213         char                    *name;
214         unsigned int            tuner_type;
215         unsigned int            radio_type;
216         unsigned char           tuner_addr;
217         unsigned char           radio_addr;
218         int                     tda9887_conf;
219         struct cx88_input       input[MAX_CX88_INPUT];
220         struct cx88_input       radio;
221         unsigned int            blackbird:1;
222         unsigned int            dvb:1;
223 };
224
225 struct cx88_subid {
226         u16     subvendor;
227         u16     subdevice;
228         u32     card;
229 };
230
231 #define INPUT(nr) (&cx88_boards[core->board].input[nr])
232
233 /* ----------------------------------------------------------- */
234 /* device / file handle status                                 */
235
236 #define RESOURCE_OVERLAY       1
237 #define RESOURCE_VIDEO         2
238 #define RESOURCE_VBI           4
239
240 #define BUFFER_TIMEOUT     (HZ/2)  /* 0.5 seconds */
241
242 /* buffer for one video frame */
243 struct cx88_buffer {
244         /* common v4l buffer stuff -- must be first */
245         struct videobuf_buffer vb;
246
247         /* cx88 specific */
248         unsigned int           bpl;
249         struct btcx_riscmem    risc;
250         struct cx8800_fmt      *fmt;
251         u32                    count;
252 };
253
254 struct cx88_dmaqueue {
255         struct list_head       active;
256         struct list_head       queued;
257         struct timer_list      timeout;
258         struct btcx_riscmem    stopper;
259         u32                    count;
260 };
261
262 struct cx88_core {
263         struct list_head           devlist;
264         atomic_t                   refcount;
265
266         /* board name */
267         int                        nr;
268         char                       name[32];
269
270         /* pci stuff */
271         int                        pci_bus;
272         int                        pci_slot;
273         u32                        __iomem *lmmio;
274         u8                         __iomem *bmmio;
275         u32                        shadow[SHADOW_MAX];
276         int                        pci_irqmask;
277
278         /* i2c i/o */
279         struct i2c_adapter         i2c_adap;
280         struct i2c_algo_bit_data   i2c_algo;
281         struct i2c_client          i2c_client;
282         u32                        i2c_state, i2c_rc;
283
284         /* config info -- analog */
285         unsigned int               board;
286         unsigned int               tuner_type;
287         unsigned int               radio_type;
288         unsigned char              tuner_addr;
289         unsigned char              radio_addr;
290         unsigned int               tda9887_conf;
291         unsigned int               has_radio;
292
293         /* Supported V4L _STD_ tuner formats */
294         unsigned int               tuner_formats;
295
296         /* config info -- dvb */
297         struct dvb_pll_desc        *pll_desc;
298         unsigned int               pll_addr;
299
300         /* state info */
301         struct task_struct         *kthread;
302         struct cx88_tvnorm         *tvnorm;
303         u32                        tvaudio;
304         u32                        audiomode_manual;
305         u32                        audiomode_current;
306         u32                        input;
307         u32                        astat;
308         u32                        use_nicam;
309
310         /* IR remote control state */
311         struct cx88_IR             *ir;
312
313         struct mutex               lock;
314         /* various v4l controls */
315         u32                        freq;
316
317         /* cx88-video needs to access cx8802 for hybrid tuner pll access. */
318         struct cx8802_dev          *dvbdev;
319 };
320
321 struct cx8800_dev;
322 struct cx8802_dev;
323
324 /* ----------------------------------------------------------- */
325 /* function 0: video stuff                                     */
326
327 struct cx8800_fh {
328         struct cx8800_dev          *dev;
329         enum v4l2_buf_type         type;
330         int                        radio;
331         unsigned int               resources;
332
333         /* video overlay */
334         struct v4l2_window         win;
335         struct v4l2_clip           *clips;
336         unsigned int               nclips;
337
338         /* video capture */
339         struct cx8800_fmt          *fmt;
340         unsigned int               width,height;
341         struct videobuf_queue      vidq;
342
343         /* vbi capture */
344         struct videobuf_queue      vbiq;
345 };
346
347 struct cx8800_suspend_state {
348         int                        disabled;
349 };
350
351 struct cx8800_dev {
352         struct cx88_core           *core;
353         struct list_head           devlist;
354         spinlock_t                 slock;
355
356         /* various device info */
357         unsigned int               resources;
358         struct video_device        *video_dev;
359         struct video_device        *vbi_dev;
360         struct video_device        *radio_dev;
361
362         /* pci i/o */
363         struct pci_dev             *pci;
364         unsigned char              pci_rev,pci_lat;
365
366
367         /* capture queues */
368         struct cx88_dmaqueue       vidq;
369         struct cx88_dmaqueue       vbiq;
370
371         /* various v4l controls */
372
373         /* other global state info */
374         struct cx8800_suspend_state state;
375 };
376
377 /* ----------------------------------------------------------- */
378 /* function 1: audio/alsa stuff                                */
379 /* =============> moved to cx88-alsa.c <====================== */
380
381
382 /* ----------------------------------------------------------- */
383 /* function 2: mpeg stuff                                      */
384
385 struct cx8802_fh {
386         struct cx8802_dev          *dev;
387         struct videobuf_queue      mpegq;
388 };
389
390 struct cx8802_suspend_state {
391         int                        disabled;
392 };
393
394 /* TODO: move this to struct v4l2_mpeg_compression ? */
395 struct blackbird_dnr {
396         u32                       mode;
397         u32                       type;
398         u32                       spatial;
399         u32                       temporal;
400 };
401
402 struct cx8802_dev {
403         struct cx88_core           *core;
404         spinlock_t                 slock;
405
406         /* pci i/o */
407         struct pci_dev             *pci;
408         unsigned char              pci_rev,pci_lat;
409
410         /* dma queues */
411         struct cx88_dmaqueue       mpegq;
412         u32                        ts_packet_size;
413         u32                        ts_packet_count;
414
415         /* other global state info */
416         struct cx8802_suspend_state state;
417
418         /* for blackbird only */
419         struct list_head           devlist;
420         struct video_device        *mpeg_dev;
421         u32                        mailbox;
422         int                        width;
423         int                        height;
424
425         /* for dvb only */
426         struct videobuf_dvb        dvb;
427         void*                      fe_handle;
428         int                        (*fe_release)(void *handle);
429
430         void                       *card_priv;
431         /* for switching modulation types */
432         unsigned char              ts_gen_cntrl;
433
434         /* mpeg params */
435         struct v4l2_mpeg_compression params;
436         struct blackbird_dnr       dnr_params;
437 };
438
439 /* ----------------------------------------------------------- */
440
441 #define cx_read(reg)             readl(core->lmmio + ((reg)>>2))
442 #define cx_write(reg,value)      writel((value), core->lmmio + ((reg)>>2))
443 #define cx_writeb(reg,value)     writeb((value), core->bmmio + (reg))
444
445 #define cx_andor(reg,mask,value) \
446   writel((readl(core->lmmio+((reg)>>2)) & ~(mask)) |\
447   ((value) & (mask)), core->lmmio+((reg)>>2))
448 #define cx_set(reg,bit)          cx_andor((reg),(bit),(bit))
449 #define cx_clear(reg,bit)        cx_andor((reg),(bit),0)
450
451 #define cx_wait(d) { if (need_resched()) schedule(); else udelay(d); }
452
453 /* shadow registers */
454 #define cx_sread(sreg)              (core->shadow[sreg])
455 #define cx_swrite(sreg,reg,value) \
456   (core->shadow[sreg] = value, \
457    writel(core->shadow[sreg], core->lmmio + ((reg)>>2)))
458 #define cx_sandor(sreg,reg,mask,value) \
459   (core->shadow[sreg] = (core->shadow[sreg] & ~(mask)) | ((value) & (mask)), \
460    writel(core->shadow[sreg], core->lmmio + ((reg)>>2)))
461
462 /* ----------------------------------------------------------- */
463 /* cx88-core.c                                                 */
464
465 extern void cx88_print_irqbits(char *name, char *tag, char **strings,
466                                u32 bits, u32 mask);
467
468 extern int cx88_core_irq(struct cx88_core *core, u32 status);
469 extern void cx88_wakeup(struct cx88_core *core,
470                         struct cx88_dmaqueue *q, u32 count);
471 extern void cx88_shutdown(struct cx88_core *core);
472 extern int cx88_reset(struct cx88_core *core);
473
474 extern int
475 cx88_risc_buffer(struct pci_dev *pci, struct btcx_riscmem *risc,
476                  struct scatterlist *sglist,
477                  unsigned int top_offset, unsigned int bottom_offset,
478                  unsigned int bpl, unsigned int padding, unsigned int lines);
479 extern int
480 cx88_risc_databuffer(struct pci_dev *pci, struct btcx_riscmem *risc,
481                      struct scatterlist *sglist, unsigned int bpl,
482                      unsigned int lines);
483 extern int
484 cx88_risc_stopper(struct pci_dev *pci, struct btcx_riscmem *risc,
485                   u32 reg, u32 mask, u32 value);
486 extern void
487 cx88_free_buffer(struct videobuf_queue *q, struct cx88_buffer *buf);
488
489 extern void cx88_risc_disasm(struct cx88_core *core,
490                              struct btcx_riscmem *risc);
491 extern int cx88_sram_channel_setup(struct cx88_core *core,
492                                    struct sram_channel *ch,
493                                    unsigned int bpl, u32 risc);
494 extern void cx88_sram_channel_dump(struct cx88_core *core,
495                                    struct sram_channel *ch);
496
497 extern int cx88_set_scale(struct cx88_core *core, unsigned int width,
498                           unsigned int height, enum v4l2_field field);
499 extern int cx88_set_tvnorm(struct cx88_core *core, struct cx88_tvnorm *norm);
500
501 extern struct video_device *cx88_vdev_init(struct cx88_core *core,
502                                            struct pci_dev *pci,
503                                            struct video_device *template,
504                                            char *type);
505 extern struct cx88_core* cx88_core_get(struct pci_dev *pci);
506 extern void cx88_core_put(struct cx88_core *core,
507                           struct pci_dev *pci);
508
509 extern int cx88_start_audio_dma(struct cx88_core *core);
510 extern int cx88_stop_audio_dma(struct cx88_core *core);
511
512
513 /* ----------------------------------------------------------- */
514 /* cx88-vbi.c                                                  */
515
516 void cx8800_vbi_fmt(struct cx8800_dev *dev, struct v4l2_format *f);
517 /*
518 int cx8800_start_vbi_dma(struct cx8800_dev    *dev,
519                          struct cx88_dmaqueue *q,
520                          struct cx88_buffer   *buf);
521 */
522 int cx8800_stop_vbi_dma(struct cx8800_dev *dev);
523 int cx8800_restart_vbi_queue(struct cx8800_dev    *dev,
524                              struct cx88_dmaqueue *q);
525 void cx8800_vbi_timeout(unsigned long data);
526
527 extern struct videobuf_queue_ops cx8800_vbi_qops;
528
529 /* ----------------------------------------------------------- */
530 /* cx88-i2c.c                                                  */
531
532 extern int cx88_i2c_init(struct cx88_core *core, struct pci_dev *pci);
533 extern void cx88_call_i2c_clients(struct cx88_core *core,
534                                   unsigned int cmd, void *arg);
535
536
537 /* ----------------------------------------------------------- */
538 /* cx88-cards.c                                                */
539
540 extern struct cx88_board cx88_boards[];
541 extern const unsigned int cx88_bcount;
542
543 extern struct cx88_subid cx88_subids[];
544 extern const unsigned int cx88_idcount;
545
546 extern void cx88_card_list(struct cx88_core *core, struct pci_dev *pci);
547 extern void cx88_card_setup(struct cx88_core *core);
548
549 /* ----------------------------------------------------------- */
550 /* cx88-tvaudio.c                                              */
551
552 #define WW_NONE          1
553 #define WW_BTSC          2
554 #define WW_BG            3
555 #define WW_DK            4
556 #define WW_I             5
557 #define WW_L             6
558 #define WW_EIAJ          7
559 #define WW_I2SPT         8
560 #define WW_FM            9
561
562 void cx88_set_tvaudio(struct cx88_core *core);
563 void cx88_newstation(struct cx88_core *core);
564 void cx88_get_stereo(struct cx88_core *core, struct v4l2_tuner *t);
565 void cx88_set_stereo(struct cx88_core *core, u32 mode, int manual);
566 int cx88_audio_thread(void *data);
567 int cx88_detect_nicam(struct cx88_core *core);
568
569 /* ----------------------------------------------------------- */
570 /* cx88-input.c                                                */
571
572 int cx88_ir_init(struct cx88_core *core, struct pci_dev *pci);
573 int cx88_ir_fini(struct cx88_core *core);
574 void cx88_ir_irq(struct cx88_core *core);
575
576 /* ----------------------------------------------------------- */
577 /* cx88-mpeg.c                                                 */
578
579 int cx8802_buf_prepare(struct videobuf_queue *q,struct cx8802_dev *dev,
580                         struct cx88_buffer *buf, enum v4l2_field field);
581 void cx8802_buf_queue(struct cx8802_dev *dev, struct cx88_buffer *buf);
582 void cx8802_cancel_buffers(struct cx8802_dev *dev);
583
584 int cx8802_init_common(struct cx8802_dev *dev);
585 void cx8802_fini_common(struct cx8802_dev *dev);
586
587 int cx8802_suspend_common(struct pci_dev *pci_dev, pm_message_t state);
588 int cx8802_resume_common(struct pci_dev *pci_dev);
589
590 /* ----------------------------------------------------------- */
591 /* cx88-video.c                                                */
592 extern int cx88_do_ioctl(struct inode *inode, struct file *file, int radio,
593                                 struct cx88_core *core, unsigned int cmd,
594                                 void *arg, v4l2_kioctl driver_ioctl);
595
596 /* ----------------------------------------------------------- */
597 /* cx88-blackbird.c                                            */
598 extern int (*cx88_ioctl_hook)(struct inode *inode, struct file *file,
599                                 unsigned int cmd, void *arg);
600 extern unsigned int (*cx88_ioctl_translator)(unsigned int cmd);
601 void blackbird_set_params(struct cx8802_dev *dev,
602                                 struct v4l2_mpeg_compression *params);
603 void blackbird_set_dnr_params(struct cx8802_dev *dev,
604                                 struct blackbird_dnr* dnr_params);
605
606 /*
607  * Local variables:
608  * c-basic-offset: 8
609  * End:
610  * kate: eol "unix"; indent-width 3; remove-trailing-space on; replace-trailing-space-save on; tab-width 8; replace-tabs off; space-indent off; mixed-indent off
611  */