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