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