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