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