Merge branch 'upstream-linus' of git://git.kernel.org/pub/scm/linux/kernel/git/ieee13...
[powerpc.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 #define UNSET (-1U)
44
45 #define CX88_MAXBOARDS 8
46
47 /* Max number of inputs by card */
48 #define MAX_CX88_INPUT 8
49
50 /* ----------------------------------------------------------- */
51 /* defines and enums                                           */
52
53 #define FORMAT_FLAGS_PACKED       0x01
54 #define FORMAT_FLAGS_PLANAR       0x02
55
56 #define VBI_LINE_COUNT              17
57 #define VBI_LINE_LENGTH           2048
58
59 /* need "shadow" registers for some write-only ones ... */
60 #define SHADOW_AUD_VOL_CTL           1
61 #define SHADOW_AUD_BAL_CTL           2
62 #define SHADOW_MAX                   3
63
64 /* FM Radio deemphasis type */
65 enum cx88_deemph_type {
66         FM_NO_DEEMPH = 0,
67         FM_DEEMPH_50,
68         FM_DEEMPH_75
69 };
70
71 enum cx88_board_type {
72         CX88_BOARD_NONE = 0,
73         CX88_MPEG_DVB,
74         CX88_MPEG_BLACKBIRD
75 };
76
77 /* ----------------------------------------------------------- */
78 /* tv norms                                                    */
79
80 struct cx88_tvnorm {
81         char                   *name;
82         v4l2_std_id            id;
83         u32                    cxiformat;
84         u32                    cxoformat;
85 };
86
87 static unsigned int inline norm_maxw(struct cx88_tvnorm *norm)
88 {
89         return (norm->id & V4L2_STD_625_50) ? 768 : 640;
90 }
91
92
93 static unsigned int inline norm_maxh(struct cx88_tvnorm *norm)
94 {
95         return (norm->id & V4L2_STD_625_50) ? 576 : 480;
96 }
97
98 /* ----------------------------------------------------------- */
99 /* static data                                                 */
100
101 struct cx8800_fmt {
102         char  *name;
103         u32   fourcc;          /* v4l2 format id */
104         int   depth;
105         int   flags;
106         u32   cxformat;
107 };
108
109 struct cx88_ctrl {
110         struct v4l2_queryctrl  v;
111         u32                    off;
112         u32                    reg;
113         u32                    sreg;
114         u32                    mask;
115         u32                    shift;
116 };
117
118 /* ----------------------------------------------------------- */
119 /* SRAM memory management data (see cx88-core.c)               */
120
121 #define SRAM_CH21 0   /* video */
122 #define SRAM_CH22 1
123 #define SRAM_CH23 2
124 #define SRAM_CH24 3   /* vbi   */
125 #define SRAM_CH25 4   /* audio */
126 #define SRAM_CH26 5
127 #define SRAM_CH28 6   /* mpeg */
128 /* more */
129
130 struct sram_channel {
131         char *name;
132         u32  cmds_start;
133         u32  ctrl_start;
134         u32  cdt;
135         u32  fifo_start;
136         u32  fifo_size;
137         u32  ptr1_reg;
138         u32  ptr2_reg;
139         u32  cnt1_reg;
140         u32  cnt2_reg;
141 };
142 extern struct sram_channel cx88_sram_channels[];
143
144 /* ----------------------------------------------------------- */
145 /* card configuration                                          */
146
147 #define CX88_BOARD_NOAUTO               UNSET
148 #define CX88_BOARD_UNKNOWN                  0
149 #define CX88_BOARD_HAUPPAUGE                1
150 #define CX88_BOARD_GDI                      2
151 #define CX88_BOARD_PIXELVIEW                3
152 #define CX88_BOARD_ATI_WONDER_PRO           4
153 #define CX88_BOARD_WINFAST2000XP_EXPERT     5
154 #define CX88_BOARD_AVERTV_STUDIO_303        6
155 #define CX88_BOARD_MSI_TVANYWHERE_MASTER    7
156 #define CX88_BOARD_WINFAST_DV2000           8
157 #define CX88_BOARD_LEADTEK_PVR2000          9
158 #define CX88_BOARD_IODATA_GVVCP3PCI        10
159 #define CX88_BOARD_PROLINK_PLAYTVPVR       11
160 #define CX88_BOARD_ASUS_PVR_416            12
161 #define CX88_BOARD_MSI_TVANYWHERE          13
162 #define CX88_BOARD_KWORLD_DVB_T            14
163 #define CX88_BOARD_DVICO_FUSIONHDTV_DVB_T1 15
164 #define CX88_BOARD_KWORLD_LTV883           16
165 #define CX88_BOARD_DVICO_FUSIONHDTV_3_GOLD_Q  17
166 #define CX88_BOARD_HAUPPAUGE_DVB_T1        18
167 #define CX88_BOARD_CONEXANT_DVB_T1         19
168 #define CX88_BOARD_PROVIDEO_PV259          20
169 #define CX88_BOARD_DVICO_FUSIONHDTV_DVB_T_PLUS 21
170 #define CX88_BOARD_PCHDTV_HD3000           22
171 #define CX88_BOARD_DNTV_LIVE_DVB_T         23
172 #define CX88_BOARD_HAUPPAUGE_ROSLYN        24
173 #define CX88_BOARD_DIGITALLOGIC_MEC        25
174 #define CX88_BOARD_IODATA_GVBCTV7E         26
175 #define CX88_BOARD_PIXELVIEW_PLAYTV_ULTRA_PRO 27
176 #define CX88_BOARD_DVICO_FUSIONHDTV_3_GOLD_T  28
177 #define CX88_BOARD_ADSTECH_DVB_T_PCI          29
178 #define CX88_BOARD_TERRATEC_CINERGY_1400_DVB_T1  30
179 #define CX88_BOARD_DVICO_FUSIONHDTV_5_GOLD 31
180 #define CX88_BOARD_AVERMEDIA_ULTRATV_MC_550 32
181 #define CX88_BOARD_KWORLD_VSTREAM_EXPERT_DVD 33
182 #define CX88_BOARD_ATI_HDTVWONDER          34
183 #define CX88_BOARD_WINFAST_DTV1000         35
184 #define CX88_BOARD_AVERTV_303              36
185 #define CX88_BOARD_HAUPPAUGE_NOVASPLUS_S1  37
186 #define CX88_BOARD_HAUPPAUGE_NOVASE2_S1    38
187 #define CX88_BOARD_KWORLD_DVBS_100         39
188 #define CX88_BOARD_HAUPPAUGE_HVR1100       40
189 #define CX88_BOARD_HAUPPAUGE_HVR1100LP     41
190 #define CX88_BOARD_DNTV_LIVE_DVB_T_PRO     42
191 #define CX88_BOARD_KWORLD_DVB_T_CX22702    43
192 #define CX88_BOARD_DVICO_FUSIONHDTV_DVB_T_DUAL 44
193 #define CX88_BOARD_KWORLD_HARDWARE_MPEG_TV_XPERT 45
194 #define CX88_BOARD_DVICO_FUSIONHDTV_DVB_T_HYBRID 46
195 #define CX88_BOARD_PCHDTV_HD5500           47
196 #define CX88_BOARD_KWORLD_MCE200_DELUXE    48
197 #define CX88_BOARD_PIXELVIEW_PLAYTV_P7000  49
198 #define CX88_BOARD_NPGTECH_REALTV_TOP10FM  50
199 #define CX88_BOARD_WINFAST_DTV2000H        51
200 #define CX88_BOARD_GENIATECH_DVBS          52
201 #define CX88_BOARD_HAUPPAUGE_HVR3000       53
202 #define CX88_BOARD_NORWOOD_MICRO           54
203 #define CX88_BOARD_TE_DTV_250_OEM_SWANN    55
204 #define CX88_BOARD_HAUPPAUGE_HVR1300       56
205
206 enum cx88_itype {
207         CX88_VMUX_COMPOSITE1 = 1,
208         CX88_VMUX_COMPOSITE2,
209         CX88_VMUX_COMPOSITE3,
210         CX88_VMUX_COMPOSITE4,
211         CX88_VMUX_SVIDEO,
212         CX88_VMUX_TELEVISION,
213         CX88_VMUX_CABLE,
214         CX88_VMUX_DVB,
215         CX88_VMUX_DEBUG,
216         CX88_RADIO,
217 };
218
219 struct cx88_input {
220         enum cx88_itype type;
221         unsigned int    vmux;
222         u32             gpio0, gpio1, gpio2, gpio3;
223 };
224
225 struct cx88_board {
226         char                    *name;
227         unsigned int            tuner_type;
228         unsigned int            radio_type;
229         unsigned char           tuner_addr;
230         unsigned char           radio_addr;
231         int                     tda9887_conf;
232         struct cx88_input       input[MAX_CX88_INPUT];
233         struct cx88_input       radio;
234         enum cx88_board_type    mpeg;
235         enum audiochip          audio_chip;
236 };
237
238 struct cx88_subid {
239         u16     subvendor;
240         u16     subdevice;
241         u32     card;
242 };
243
244 #define INPUT(nr) (&cx88_boards[core->board].input[nr])
245
246 /* ----------------------------------------------------------- */
247 /* device / file handle status                                 */
248
249 #define RESOURCE_OVERLAY       1
250 #define RESOURCE_VIDEO         2
251 #define RESOURCE_VBI           4
252
253 #define BUFFER_TIMEOUT     (HZ/2)  /* 0.5 seconds */
254
255 /* buffer for one video frame */
256 struct cx88_buffer {
257         /* common v4l buffer stuff -- must be first */
258         struct videobuf_buffer vb;
259
260         /* cx88 specific */
261         unsigned int           bpl;
262         struct btcx_riscmem    risc;
263         struct cx8800_fmt      *fmt;
264         u32                    count;
265 };
266
267 struct cx88_dmaqueue {
268         struct list_head       active;
269         struct list_head       queued;
270         struct timer_list      timeout;
271         struct btcx_riscmem    stopper;
272         u32                    count;
273 };
274
275 struct cx88_core {
276         struct list_head           devlist;
277         atomic_t                   refcount;
278
279         /* board name */
280         int                        nr;
281         char                       name[32];
282
283         /* pci stuff */
284         int                        pci_bus;
285         int                        pci_slot;
286         u32                        __iomem *lmmio;
287         u8                         __iomem *bmmio;
288         u32                        shadow[SHADOW_MAX];
289         int                        pci_irqmask;
290
291         /* i2c i/o */
292         struct i2c_adapter         i2c_adap;
293         struct i2c_algo_bit_data   i2c_algo;
294         struct i2c_client          i2c_client;
295         u32                        i2c_state, i2c_rc;
296
297         /* config info -- analog */
298         unsigned int               board;
299         unsigned int               tuner_type;
300         unsigned int               radio_type;
301         unsigned char              tuner_addr;
302         unsigned char              radio_addr;
303         unsigned int               tda9887_conf;
304         unsigned int               has_radio;
305
306         /* Supported V4L _STD_ tuner formats */
307         unsigned int               tuner_formats;
308
309         /* config info -- dvb */
310         struct dvb_pll_desc        *pll_desc;
311         unsigned int               pll_addr;
312         int                        (*prev_set_voltage)(struct dvb_frontend* fe, fe_sec_voltage_t voltage);
313
314         /* state info */
315         struct task_struct         *kthread;
316         struct cx88_tvnorm         *tvnorm;
317         u32                        tvaudio;
318         u32                        audiomode_manual;
319         u32                        audiomode_current;
320         u32                        input;
321         u32                        astat;
322         u32                        use_nicam;
323
324         /* IR remote control state */
325         struct cx88_IR             *ir;
326
327         struct mutex               lock;
328         /* various v4l controls */
329         u32                        freq;
330
331         /* cx88-video needs to access cx8802 for hybrid tuner pll access. */
332         struct cx8802_dev          *dvbdev;
333 };
334
335 struct cx8800_dev;
336 struct cx8802_dev;
337
338 /* ----------------------------------------------------------- */
339 /* function 0: video stuff                                     */
340
341 struct cx8800_fh {
342         struct cx8800_dev          *dev;
343         enum v4l2_buf_type         type;
344         int                        radio;
345         unsigned int               resources;
346
347         /* video overlay */
348         struct v4l2_window         win;
349         struct v4l2_clip           *clips;
350         unsigned int               nclips;
351
352         /* video capture */
353         struct cx8800_fmt          *fmt;
354         unsigned int               width,height;
355         struct videobuf_queue      vidq;
356
357         /* vbi capture */
358         struct videobuf_queue      vbiq;
359 };
360
361 struct cx8800_suspend_state {
362         int                        disabled;
363 };
364
365 struct cx8800_dev {
366         struct cx88_core           *core;
367         struct list_head           devlist;
368         spinlock_t                 slock;
369
370         /* various device info */
371         unsigned int               resources;
372         struct video_device        *video_dev;
373         struct video_device        *vbi_dev;
374         struct video_device        *radio_dev;
375
376         /* pci i/o */
377         struct pci_dev             *pci;
378         unsigned char              pci_rev,pci_lat;
379
380
381         /* capture queues */
382         struct cx88_dmaqueue       vidq;
383         struct cx88_dmaqueue       vbiq;
384
385         /* various v4l controls */
386
387         /* other global state info */
388         struct cx8800_suspend_state state;
389 };
390
391 /* ----------------------------------------------------------- */
392 /* function 1: audio/alsa stuff                                */
393 /* =============> moved to cx88-alsa.c <====================== */
394
395
396 /* ----------------------------------------------------------- */
397 /* function 2: mpeg stuff                                      */
398
399 struct cx8802_fh {
400         struct cx8802_dev          *dev;
401         struct videobuf_queue      mpegq;
402 };
403
404 struct cx8802_suspend_state {
405         int                        disabled;
406 };
407
408 struct cx8802_dev {
409         struct cx88_core           *core;
410         spinlock_t                 slock;
411
412         /* pci i/o */
413         struct pci_dev             *pci;
414         unsigned char              pci_rev,pci_lat;
415
416         /* dma queues */
417         struct cx88_dmaqueue       mpegq;
418         u32                        ts_packet_size;
419         u32                        ts_packet_count;
420
421         /* other global state info */
422         struct cx8802_suspend_state state;
423
424         /* for blackbird only */
425         struct list_head           devlist;
426         struct video_device        *mpeg_dev;
427         u32                        mailbox;
428         int                        width;
429         int                        height;
430
431         /* for dvb only */
432         struct videobuf_dvb        dvb;
433         void*                      fe_handle;
434         int                        (*fe_release)(void *handle);
435
436         void                       *card_priv;
437         /* for switching modulation types */
438         unsigned char              ts_gen_cntrl;
439
440         /* mpeg params */
441         struct cx2341x_mpeg_params 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 extern void cx88_card_setup_pre_i2c(struct cx88_core *core);
554
555 /* ----------------------------------------------------------- */
556 /* cx88-tvaudio.c                                              */
557
558 #define WW_NONE          1
559 #define WW_BTSC          2
560 #define WW_BG            3
561 #define WW_DK            4
562 #define WW_I             5
563 #define WW_L             6
564 #define WW_EIAJ          7
565 #define WW_I2SPT         8
566 #define WW_FM            9
567
568 void cx88_set_tvaudio(struct cx88_core *core);
569 void cx88_newstation(struct cx88_core *core);
570 void cx88_get_stereo(struct cx88_core *core, struct v4l2_tuner *t);
571 void cx88_set_stereo(struct cx88_core *core, u32 mode, int manual);
572 int cx88_audio_thread(void *data);
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 extern const u32 cx88_user_ctrls[];
601 extern int cx8800_ctrl_query(struct v4l2_queryctrl *qctrl);
602
603 /*
604  * Local variables:
605  * c-basic-offset: 8
606  * End:
607  * 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
608  */