V4L/DVB (3735): Add support for pcHDTV HD5500 ATSC/QAM
[linux-2.6.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 #define CX88_BOARD_PCHDTV_HD5500           47
193
194 enum cx88_itype {
195         CX88_VMUX_COMPOSITE1 = 1,
196         CX88_VMUX_COMPOSITE2,
197         CX88_VMUX_COMPOSITE3,
198         CX88_VMUX_COMPOSITE4,
199         CX88_VMUX_SVIDEO,
200         CX88_VMUX_TELEVISION,
201         CX88_VMUX_CABLE,
202         CX88_VMUX_DVB,
203         CX88_VMUX_DEBUG,
204         CX88_RADIO,
205 };
206
207 struct cx88_input {
208         enum cx88_itype type;
209         unsigned int    vmux;
210         u32             gpio0, gpio1, gpio2, gpio3;
211 };
212
213 struct cx88_board {
214         char                    *name;
215         unsigned int            tuner_type;
216         unsigned int            radio_type;
217         unsigned char           tuner_addr;
218         unsigned char           radio_addr;
219         int                     tda9887_conf;
220         struct cx88_input       input[MAX_CX88_INPUT];
221         struct cx88_input       radio;
222         unsigned int            blackbird:1;
223         unsigned int            dvb:1;
224 };
225
226 struct cx88_subid {
227         u16     subvendor;
228         u16     subdevice;
229         u32     card;
230 };
231
232 #define INPUT(nr) (&cx88_boards[core->board].input[nr])
233
234 /* ----------------------------------------------------------- */
235 /* device / file handle status                                 */
236
237 #define RESOURCE_OVERLAY       1
238 #define RESOURCE_VIDEO         2
239 #define RESOURCE_VBI           4
240
241 #define BUFFER_TIMEOUT     (HZ/2)  /* 0.5 seconds */
242
243 /* buffer for one video frame */
244 struct cx88_buffer {
245         /* common v4l buffer stuff -- must be first */
246         struct videobuf_buffer vb;
247
248         /* cx88 specific */
249         unsigned int           bpl;
250         struct btcx_riscmem    risc;
251         struct cx8800_fmt      *fmt;
252         u32                    count;
253 };
254
255 struct cx88_dmaqueue {
256         struct list_head       active;
257         struct list_head       queued;
258         struct timer_list      timeout;
259         struct btcx_riscmem    stopper;
260         u32                    count;
261 };
262
263 struct cx88_core {
264         struct list_head           devlist;
265         atomic_t                   refcount;
266
267         /* board name */
268         int                        nr;
269         char                       name[32];
270
271         /* pci stuff */
272         int                        pci_bus;
273         int                        pci_slot;
274         u32                        __iomem *lmmio;
275         u8                         __iomem *bmmio;
276         u32                        shadow[SHADOW_MAX];
277         int                        pci_irqmask;
278
279         /* i2c i/o */
280         struct i2c_adapter         i2c_adap;
281         struct i2c_algo_bit_data   i2c_algo;
282         struct i2c_client          i2c_client;
283         u32                        i2c_state, i2c_rc;
284
285         /* config info -- analog */
286         unsigned int               board;
287         unsigned int               tuner_type;
288         unsigned int               radio_type;
289         unsigned char              tuner_addr;
290         unsigned char              radio_addr;
291         unsigned int               tda9887_conf;
292         unsigned int               has_radio;
293
294         /* Supported V4L _STD_ tuner formats */
295         unsigned int               tuner_formats;
296
297         /* config info -- dvb */
298         struct dvb_pll_desc        *pll_desc;
299         unsigned int               pll_addr;
300
301         /* state info */
302         struct task_struct         *kthread;
303         struct cx88_tvnorm         *tvnorm;
304         u32                        tvaudio;
305         u32                        audiomode_manual;
306         u32                        audiomode_current;
307         u32                        input;
308         u32                        astat;
309         u32                        use_nicam;
310
311         /* IR remote control state */
312         struct cx88_IR             *ir;
313
314         struct mutex               lock;
315         /* various v4l controls */
316         u32                        freq;
317
318         /* cx88-video needs to access cx8802 for hybrid tuner pll access. */
319         struct cx8802_dev          *dvbdev;
320 };
321
322 struct cx8800_dev;
323 struct cx8802_dev;
324
325 /* ----------------------------------------------------------- */
326 /* function 0: video stuff                                     */
327
328 struct cx8800_fh {
329         struct cx8800_dev          *dev;
330         enum v4l2_buf_type         type;
331         int                        radio;
332         unsigned int               resources;
333
334         /* video overlay */
335         struct v4l2_window         win;
336         struct v4l2_clip           *clips;
337         unsigned int               nclips;
338
339         /* video capture */
340         struct cx8800_fmt          *fmt;
341         unsigned int               width,height;
342         struct videobuf_queue      vidq;
343
344         /* vbi capture */
345         struct videobuf_queue      vbiq;
346 };
347
348 struct cx8800_suspend_state {
349         int                        disabled;
350 };
351
352 struct cx8800_dev {
353         struct cx88_core           *core;
354         struct list_head           devlist;
355         spinlock_t                 slock;
356
357         /* various device info */
358         unsigned int               resources;
359         struct video_device        *video_dev;
360         struct video_device        *vbi_dev;
361         struct video_device        *radio_dev;
362
363         /* pci i/o */
364         struct pci_dev             *pci;
365         unsigned char              pci_rev,pci_lat;
366
367
368         /* capture queues */
369         struct cx88_dmaqueue       vidq;
370         struct cx88_dmaqueue       vbiq;
371
372         /* various v4l controls */
373
374         /* other global state info */
375         struct cx8800_suspend_state state;
376 };
377
378 /* ----------------------------------------------------------- */
379 /* function 1: audio/alsa stuff                                */
380 /* =============> moved to cx88-alsa.c <====================== */
381
382
383 /* ----------------------------------------------------------- */
384 /* function 2: mpeg stuff                                      */
385
386 struct cx8802_fh {
387         struct cx8802_dev          *dev;
388         struct videobuf_queue      mpegq;
389 };
390
391 struct cx8802_suspend_state {
392         int                        disabled;
393 };
394
395 /* TODO: move this to struct v4l2_mpeg_compression ? */
396 struct blackbird_dnr {
397         u32                       mode;
398         u32                       type;
399         u32                       spatial;
400         u32                       temporal;
401 };
402
403 struct cx8802_dev {
404         struct cx88_core           *core;
405         spinlock_t                 slock;
406
407         /* pci i/o */
408         struct pci_dev             *pci;
409         unsigned char              pci_rev,pci_lat;
410
411         /* dma queues */
412         struct cx88_dmaqueue       mpegq;
413         u32                        ts_packet_size;
414         u32                        ts_packet_count;
415
416         /* other global state info */
417         struct cx8802_suspend_state state;
418
419         /* for blackbird only */
420         struct list_head           devlist;
421         struct video_device        *mpeg_dev;
422         u32                        mailbox;
423         int                        width;
424         int                        height;
425
426         /* for dvb only */
427         struct videobuf_dvb        dvb;
428         void*                      fe_handle;
429         int                        (*fe_release)(void *handle);
430
431         void                       *card_priv;
432         /* for switching modulation types */
433         unsigned char              ts_gen_cntrl;
434
435         /* mpeg params */
436         struct v4l2_mpeg_compression params;
437         struct blackbird_dnr       dnr_params;
438 };
439
440 /* ----------------------------------------------------------- */
441
442 #define cx_read(reg)             readl(core->lmmio + ((reg)>>2))
443 #define cx_write(reg,value)      writel((value), core->lmmio + ((reg)>>2))
444 #define cx_writeb(reg,value)     writeb((value), core->bmmio + (reg))
445
446 #define cx_andor(reg,mask,value) \
447   writel((readl(core->lmmio+((reg)>>2)) & ~(mask)) |\
448   ((value) & (mask)), core->lmmio+((reg)>>2))
449 #define cx_set(reg,bit)          cx_andor((reg),(bit),(bit))
450 #define cx_clear(reg,bit)        cx_andor((reg),(bit),0)
451
452 #define cx_wait(d) { if (need_resched()) schedule(); else udelay(d); }
453
454 /* shadow registers */
455 #define cx_sread(sreg)              (core->shadow[sreg])
456 #define cx_swrite(sreg,reg,value) \
457   (core->shadow[sreg] = value, \
458    writel(core->shadow[sreg], core->lmmio + ((reg)>>2)))
459 #define cx_sandor(sreg,reg,mask,value) \
460   (core->shadow[sreg] = (core->shadow[sreg] & ~(mask)) | ((value) & (mask)), \
461    writel(core->shadow[sreg], core->lmmio + ((reg)>>2)))
462
463 /* ----------------------------------------------------------- */
464 /* cx88-core.c                                                 */
465
466 extern void cx88_print_irqbits(char *name, char *tag, char **strings,
467                                u32 bits, u32 mask);
468
469 extern int cx88_core_irq(struct cx88_core *core, u32 status);
470 extern void cx88_wakeup(struct cx88_core *core,
471                         struct cx88_dmaqueue *q, u32 count);
472 extern void cx88_shutdown(struct cx88_core *core);
473 extern int cx88_reset(struct cx88_core *core);
474
475 extern int
476 cx88_risc_buffer(struct pci_dev *pci, struct btcx_riscmem *risc,
477                  struct scatterlist *sglist,
478                  unsigned int top_offset, unsigned int bottom_offset,
479                  unsigned int bpl, unsigned int padding, unsigned int lines);
480 extern int
481 cx88_risc_databuffer(struct pci_dev *pci, struct btcx_riscmem *risc,
482                      struct scatterlist *sglist, unsigned int bpl,
483                      unsigned int lines);
484 extern int
485 cx88_risc_stopper(struct pci_dev *pci, struct btcx_riscmem *risc,
486                   u32 reg, u32 mask, u32 value);
487 extern void
488 cx88_free_buffer(struct videobuf_queue *q, struct cx88_buffer *buf);
489
490 extern void cx88_risc_disasm(struct cx88_core *core,
491                              struct btcx_riscmem *risc);
492 extern int cx88_sram_channel_setup(struct cx88_core *core,
493                                    struct sram_channel *ch,
494                                    unsigned int bpl, u32 risc);
495 extern void cx88_sram_channel_dump(struct cx88_core *core,
496                                    struct sram_channel *ch);
497
498 extern int cx88_set_scale(struct cx88_core *core, unsigned int width,
499                           unsigned int height, enum v4l2_field field);
500 extern int cx88_set_tvnorm(struct cx88_core *core, struct cx88_tvnorm *norm);
501
502 extern struct video_device *cx88_vdev_init(struct cx88_core *core,
503                                            struct pci_dev *pci,
504                                            struct video_device *template,
505                                            char *type);
506 extern struct cx88_core* cx88_core_get(struct pci_dev *pci);
507 extern void cx88_core_put(struct cx88_core *core,
508                           struct pci_dev *pci);
509
510 extern int cx88_start_audio_dma(struct cx88_core *core);
511 extern int cx88_stop_audio_dma(struct cx88_core *core);
512
513
514 /* ----------------------------------------------------------- */
515 /* cx88-vbi.c                                                  */
516
517 void cx8800_vbi_fmt(struct cx8800_dev *dev, struct v4l2_format *f);
518 /*
519 int cx8800_start_vbi_dma(struct cx8800_dev    *dev,
520                          struct cx88_dmaqueue *q,
521                          struct cx88_buffer   *buf);
522 */
523 int cx8800_stop_vbi_dma(struct cx8800_dev *dev);
524 int cx8800_restart_vbi_queue(struct cx8800_dev    *dev,
525                              struct cx88_dmaqueue *q);
526 void cx8800_vbi_timeout(unsigned long data);
527
528 extern struct videobuf_queue_ops cx8800_vbi_qops;
529
530 /* ----------------------------------------------------------- */
531 /* cx88-i2c.c                                                  */
532
533 extern int cx88_i2c_init(struct cx88_core *core, struct pci_dev *pci);
534 extern void cx88_call_i2c_clients(struct cx88_core *core,
535                                   unsigned int cmd, void *arg);
536
537
538 /* ----------------------------------------------------------- */
539 /* cx88-cards.c                                                */
540
541 extern struct cx88_board cx88_boards[];
542 extern const unsigned int cx88_bcount;
543
544 extern struct cx88_subid cx88_subids[];
545 extern const unsigned int cx88_idcount;
546
547 extern void cx88_card_list(struct cx88_core *core, struct pci_dev *pci);
548 extern void cx88_card_setup(struct cx88_core *core);
549
550 /* ----------------------------------------------------------- */
551 /* cx88-tvaudio.c                                              */
552
553 #define WW_NONE          1
554 #define WW_BTSC          2
555 #define WW_BG            3
556 #define WW_DK            4
557 #define WW_I             5
558 #define WW_L             6
559 #define WW_EIAJ          7
560 #define WW_I2SPT         8
561 #define WW_FM            9
562
563 void cx88_set_tvaudio(struct cx88_core *core);
564 void cx88_newstation(struct cx88_core *core);
565 void cx88_get_stereo(struct cx88_core *core, struct v4l2_tuner *t);
566 void cx88_set_stereo(struct cx88_core *core, u32 mode, int manual);
567 int cx88_audio_thread(void *data);
568 int cx88_detect_nicam(struct cx88_core *core);
569
570 /* ----------------------------------------------------------- */
571 /* cx88-input.c                                                */
572
573 int cx88_ir_init(struct cx88_core *core, struct pci_dev *pci);
574 int cx88_ir_fini(struct cx88_core *core);
575 void cx88_ir_irq(struct cx88_core *core);
576
577 /* ----------------------------------------------------------- */
578 /* cx88-mpeg.c                                                 */
579
580 int cx8802_buf_prepare(struct videobuf_queue *q,struct cx8802_dev *dev,
581                         struct cx88_buffer *buf, enum v4l2_field field);
582 void cx8802_buf_queue(struct cx8802_dev *dev, struct cx88_buffer *buf);
583 void cx8802_cancel_buffers(struct cx8802_dev *dev);
584
585 int cx8802_init_common(struct cx8802_dev *dev);
586 void cx8802_fini_common(struct cx8802_dev *dev);
587
588 int cx8802_suspend_common(struct pci_dev *pci_dev, pm_message_t state);
589 int cx8802_resume_common(struct pci_dev *pci_dev);
590
591 /* ----------------------------------------------------------- */
592 /* cx88-video.c                                                */
593 extern int cx88_do_ioctl(struct inode *inode, struct file *file, int radio,
594                                 struct cx88_core *core, unsigned int cmd,
595                                 void *arg, v4l2_kioctl driver_ioctl);
596
597 /* ----------------------------------------------------------- */
598 /* cx88-blackbird.c                                            */
599 extern int (*cx88_ioctl_hook)(struct inode *inode, struct file *file,
600                                 unsigned int cmd, void *arg);
601 extern unsigned int (*cx88_ioctl_translator)(unsigned int cmd);
602 void blackbird_set_params(struct cx8802_dev *dev,
603                                 struct v4l2_mpeg_compression *params);
604 void blackbird_set_dnr_params(struct cx8802_dev *dev,
605                                 struct blackbird_dnr* dnr_params);
606
607 /*
608  * Local variables:
609  * c-basic-offset: 8
610  * End:
611  * 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
612  */