vserver 1.9.3
[linux-2.6.git] / drivers / media / video / saa7134 / saa7134.h
1 /*
2  * v4l2 device driver for philips saa7134 based TV cards
3  *
4  * (c) 2001,02 Gerd Knorr <kraxel@bytesex.org>
5  *
6  *  This program is free software; you can redistribute it and/or modify
7  *  it under the terms of the GNU General Public License as published by
8  *  the Free Software Foundation; either version 2 of the License, or
9  *  (at your option) any later version.
10  *
11  *  This program is distributed in the hope that it will be useful,
12  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
13  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  *  GNU General Public License for more details.
15  *
16  *  You should have received a copy of the GNU General Public License
17  *  along with this program; if not, write to the Free Software
18  *  Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
19  */
20
21 #include <linux/version.h>
22 #define SAA7134_VERSION_CODE KERNEL_VERSION(0,2,12)
23
24 #include <linux/pci.h>
25 #include <linux/i2c.h>
26 #include <linux/videodev.h>
27 #include <linux/kdev_t.h>
28 #include <linux/input.h>
29
30 #include <asm/io.h>
31
32 #include <media/video-buf.h>
33 #include <media/tuner.h>
34 #include <media/audiochip.h>
35 #include <media/id.h>
36 #include <media/ir-common.h>
37
38 #ifndef TRUE
39 # define TRUE (1==1)
40 #endif
41 #ifndef FALSE
42 # define FALSE (1==0)
43 #endif
44 #define UNSET (-1U)
45
46 /* 2.4 / 2.5 driver compatibility stuff */
47
48 /* ----------------------------------------------------------- */
49 /* enums                                                       */
50
51 enum saa7134_tvaudio_mode {
52         TVAUDIO_FM_MONO       = 1,
53         TVAUDIO_FM_BG_STEREO  = 2,
54         TVAUDIO_FM_SAT_STEREO = 3,
55         TVAUDIO_FM_K_STEREO   = 4,
56         TVAUDIO_NICAM_AM      = 5,
57         TVAUDIO_NICAM_FM      = 6,
58 };
59
60 enum saa7134_audio_in {
61         TV    = 1,
62         LINE1 = 2,
63         LINE2 = 3,
64 };
65
66 enum saa7134_video_out {
67         CCIR656 = 1,
68 };
69
70 /* ----------------------------------------------------------- */
71 /* static data                                                 */
72
73 struct saa7134_tvnorm {
74         char          *name;
75         v4l2_std_id   id;
76
77         /* video decoder */
78         unsigned int  sync_control;
79         unsigned int  luma_control;
80         unsigned int  chroma_ctrl1;
81         unsigned int  chroma_gain;
82         unsigned int  chroma_ctrl2;
83         unsigned int  vgate_misc;
84
85         /* video scaler */
86         unsigned int  h_start;
87         unsigned int  h_stop;
88         unsigned int  video_v_start;
89         unsigned int  video_v_stop;
90         unsigned int  vbi_v_start;
91         unsigned int  vbi_v_stop;
92         unsigned int  src_timing;
93 };
94
95 struct saa7134_tvaudio {
96         char         *name;
97         v4l2_std_id  std;
98         enum         saa7134_tvaudio_mode mode;
99         int          carr1;
100         int          carr2;
101 };
102
103 struct saa7134_format {
104         char           *name;
105         unsigned int   fourcc;
106         unsigned int   depth;
107         unsigned int   pm;
108         unsigned int   vshift;   /* vertical downsampling (for planar yuv) */
109         unsigned int   hshift;   /* horizontal downsampling (for planar yuv) */
110         unsigned int   bswap:1;
111         unsigned int   wswap:1;
112         unsigned int   yuv:1;
113         unsigned int   planar:1;
114         unsigned int   uvswap:1;
115 };
116
117 /* ----------------------------------------------------------- */
118 /* card configuration                                          */
119
120 #define SAA7134_BOARD_NOAUTO        UNSET
121 #define SAA7134_BOARD_UNKNOWN           0
122 #define SAA7134_BOARD_PROTEUS_PRO       1
123 #define SAA7134_BOARD_FLYVIDEO3000      2
124 #define SAA7134_BOARD_FLYVIDEO2000      3
125 #define SAA7134_BOARD_EMPRESS           4
126 #define SAA7134_BOARD_MONSTERTV         5
127 #define SAA7134_BOARD_MD9717            6
128 #define SAA7134_BOARD_TVSTATION_RDS     7
129 #define SAA7134_BOARD_CINERGY400        8
130 #define SAA7134_BOARD_MD5044            9
131 #define SAA7134_BOARD_KWORLD           10
132 #define SAA7134_BOARD_CINERGY600       11
133 #define SAA7134_BOARD_MD7134           12
134 #define SAA7134_BOARD_TYPHOON_90031    13
135 #define SAA7134_BOARD_ELSA             14
136 #define SAA7134_BOARD_ELSA_500TV       15
137 #define SAA7134_BOARD_ASUSTeK_TVFM7134 16
138 #define SAA7134_BOARD_VA1000POWER      17
139 #define SAA7134_BOARD_BMK_MPEX_NOTUNER 18
140 #define SAA7134_BOARD_VIDEOMATE_TV     19
141 #define SAA7134_BOARD_CRONOS_PLUS      20
142 #define SAA7134_BOARD_10MOONSTVMASTER  21
143 #define SAA7134_BOARD_MD2819           22
144 #define SAA7134_BOARD_BMK_MPEX_TUNER   23
145 #define SAA7134_BOARD_TVSTATION_DVR    24
146 #define SAA7134_BOARD_ASUSTEK_TVFM7133  25
147 #define SAA7134_BOARD_PINNACLE_PCTV_STEREO 26
148 #define SAA7134_BOARD_MANLI_MTV002     27
149 #define SAA7134_BOARD_MANLI_MTV001     28
150 #define SAA7134_BOARD_TG3000TV         29
151 #define SAA7134_BOARD_ECS_TVP3XP       30
152 #define SAA7134_BOARD_ECS_TVP3XP_4CB5  31
153 #define SAA7134_BOARD_AVACSSMARTTV     32
154 #define SAA7134_BOARD_AVERMEDIA_DVD_EZMAKER 33
155 #define SAA7134_BOARD_NOVAC_PRIMETV7133 34
156 #define SAA7134_BOARD_AVERMEDIA_305    35
157 #define SAA7133_BOARD_UPMOST_PURPLE_TV 36
158 #define SAA7134_BOARD_ITEMS_MTV005     37
159 #define SAA7134_BOARD_CINERGY200       38
160 #define SAA7134_BOARD_FLYTVPLATINUM    39
161 #define SAA7134_BOARD_VIDEOMATE_TV_PVR 40
162
163 #define SAA7134_INPUT_MAX 8
164
165 struct saa7134_input {
166         char                    *name;
167         unsigned int            vmux;
168         enum saa7134_audio_in   amux;
169         unsigned int            gpio;
170         unsigned int            tv:1;
171 };
172
173 struct saa7134_board {
174         char                    *name;
175         unsigned int            audio_clock;
176
177         /* input switching */
178         unsigned int            gpiomask;
179         struct saa7134_input    inputs[SAA7134_INPUT_MAX];
180         struct saa7134_input    radio;
181         struct saa7134_input    mute;
182         
183         /* peripheral I/O */
184         unsigned int            has_ts;
185         enum saa7134_video_out  video_out;
186
187         /* i2c chip info */
188         unsigned int            tuner_type;
189         unsigned int            tda9887_conf;
190 };
191
192 #define card_has_radio(dev)   (NULL != saa7134_boards[dev->board].radio.name)
193 #define card_has_ts(dev)      (saa7134_boards[dev->board].has_ts)
194 #define card(dev)             (saa7134_boards[dev->board])
195 #define card_in(dev,n)        (saa7134_boards[dev->board].inputs[n])
196
197 /* ----------------------------------------------------------- */
198 /* device / file handle status                                 */
199
200 #define RESOURCE_OVERLAY       1
201 #define RESOURCE_VIDEO         2
202 #define RESOURCE_VBI           4
203
204 #define INTERLACE_AUTO         0
205 #define INTERLACE_ON           1
206 #define INTERLACE_OFF          2
207
208 #define BUFFER_TIMEOUT     (HZ/2)  /* 0.5 seconds */
209
210 struct saa7134_dev;
211 struct saa7134_dma;
212
213 /* saa7134 page table */
214 struct saa7134_pgtable {
215         unsigned int               size;
216         u32                        *cpu;
217         dma_addr_t                 dma;
218 };
219
220 /* tvaudio thread status */
221 struct saa7134_thread {
222         pid_t                      pid;
223         struct completion          exit;
224         wait_queue_head_t          wq;
225         unsigned int               shutdown;
226         unsigned int               scan1;
227         unsigned int               scan2;
228         unsigned int               mode;
229 };
230
231 /* buffer for one video/vbi/ts frame */
232 struct saa7134_buf {
233         /* common v4l buffer stuff -- must be first */
234         struct videobuf_buffer vb;
235
236         /* saa7134 specific */
237         struct saa7134_format   *fmt;
238         unsigned int            top_seen;
239         int (*activate)(struct saa7134_dev *dev,
240                         struct saa7134_buf *buf,
241                         struct saa7134_buf *next);
242
243         /* page tables */
244         struct saa7134_pgtable  *pt;
245 };
246
247 struct saa7134_dmaqueue {
248         struct saa7134_dev         *dev;
249         struct saa7134_buf         *curr;
250         struct list_head           queue;
251         struct timer_list          timeout;
252         unsigned int               need_two;
253 };
254
255 /* video filehandle status */
256 struct saa7134_fh {
257         struct saa7134_dev         *dev;
258         unsigned int               radio;
259         enum v4l2_buf_type         type;
260         unsigned int               resources;
261 #ifdef VIDIOC_G_PRIORITY 
262         enum v4l2_priority         prio;
263 #endif
264
265         /* video overlay */
266         struct v4l2_window         win;
267         struct v4l2_clip           clips[8];
268         unsigned int               nclips;
269
270         /* video capture */
271         struct saa7134_format      *fmt;
272         unsigned int               width,height;
273         struct videobuf_queue      cap;
274         struct saa7134_pgtable     pt_cap;
275
276         /* vbi capture */
277         struct videobuf_queue      vbi;
278         struct saa7134_pgtable     pt_vbi;
279 };
280
281 /* TS status */
282 struct saa7134_ts {
283         unsigned int               users;
284
285         /* TS capture */
286         struct videobuf_queue      ts;
287         struct saa7134_pgtable     pt_ts;
288         int                        started;
289 };
290
291 /* oss dsp status */
292 struct saa7134_oss {
293         struct semaphore           lock;
294         int                        minor_mixer;
295         int                        minor_dsp;
296         unsigned int               users_dsp;
297
298         /* mixer */
299         enum saa7134_audio_in      input;
300         unsigned int               count;
301         unsigned int               line1;
302         unsigned int               line2;
303
304         /* dsp */
305         unsigned int               afmt;
306         unsigned int               rate;
307         unsigned int               channels;
308         unsigned int               recording_on;
309         unsigned int               dma_running;
310         unsigned int               blocks;
311         unsigned int               blksize;
312         unsigned int               bufsize;
313         struct saa7134_pgtable     pt;
314         struct videobuf_dmabuf     dma;
315         wait_queue_head_t          wq;
316         unsigned int               dma_blk;
317         unsigned int               read_offset;
318         unsigned int               read_count;
319 };
320
321 /* IR input */
322 struct saa7134_ir {
323         struct input_dev           dev;
324         struct ir_input_state      ir;
325         char                       name[32];
326         char                       phys[32];
327         u32                        mask_keycode;
328         u32                        mask_keydown;
329         u32                        mask_keyup;
330         int                        polling;
331         u32                        last_gpio;
332         struct timer_list          timer;
333 };
334
335 /* global device status */
336 struct saa7134_dev {
337         struct list_head           devlist;
338         struct semaphore           lock;
339         spinlock_t                 slock;
340 #ifdef VIDIOC_G_PRIORITY 
341         struct v4l2_prio_state     prio;
342 #endif
343
344         /* various device info */
345         unsigned int               resources;
346         struct video_device        *video_dev;
347         struct video_device        *ts_dev;
348         struct video_device        *radio_dev;
349         struct video_device        *vbi_dev;
350         struct saa7134_oss         oss;
351         struct saa7134_ts          ts;
352
353         /* infrared remote */
354         int                        has_remote;
355         struct saa7134_ir          *remote;
356
357         /* pci i/o */
358         char                       name[32];
359         struct pci_dev             *pci;
360         unsigned char              pci_rev,pci_lat;
361         __u32                      *lmmio;
362         __u8                       *bmmio;
363
364         /* config info */
365         unsigned int               board;
366         unsigned int               tuner_type;
367         unsigned int               tda9887_conf;
368         unsigned int               gpio_value;
369
370         /* i2c i/o */
371         struct i2c_adapter         i2c_adap;
372         struct i2c_client          i2c_client;
373         unsigned char              eedata[64];
374
375         /* video overlay */
376         struct v4l2_framebuffer    ovbuf;
377         struct saa7134_format      *ovfmt;
378         unsigned int               ovenable;
379         enum v4l2_field            ovfield;
380
381         /* video+ts+vbi capture */
382         struct saa7134_dmaqueue    video_q;
383         struct saa7134_dmaqueue    ts_q;
384         struct saa7134_dmaqueue    vbi_q;
385         unsigned int               video_fieldcount;
386         unsigned int               vbi_fieldcount;
387
388         /* various v4l controls */
389         struct saa7134_tvnorm      *tvnorm;              /* video */
390         struct saa7134_tvaudio     *tvaudio;
391         unsigned int               ctl_input;
392         int                        ctl_bright;
393         int                        ctl_contrast;
394         int                        ctl_hue;
395         int                        ctl_saturation;
396         int                        ctl_freq;
397         int                        ctl_mute;             /* audio */
398         int                        ctl_volume;
399         int                        ctl_invert;           /* private */
400         int                        ctl_mirror;
401         int                        ctl_y_odd;
402         int                        ctl_y_even;
403         int                        ctl_automute;
404
405         /* crop */
406         struct v4l2_rect           crop_bounds;
407         struct v4l2_rect           crop_defrect;
408         struct v4l2_rect           crop_current;
409
410         /* other global state info */
411         unsigned int               automute;
412         struct saa7134_thread      thread;
413         struct saa7134_input       *input;
414         struct saa7134_input       *hw_input;
415         unsigned int               hw_mute;
416         int                        last_carrier;
417 };
418
419 /* ----------------------------------------------------------- */
420
421 #define saa_readl(reg)             readl(dev->lmmio + (reg))
422 #define saa_writel(reg,value)      writel((value), dev->lmmio + (reg));
423 #define saa_andorl(reg,mask,value) \
424   writel((readl(dev->lmmio+(reg)) & ~(mask)) |\
425   ((value) & (mask)), dev->lmmio+(reg))
426 #define saa_setl(reg,bit)          saa_andorl((reg),(bit),(bit))
427 #define saa_clearl(reg,bit)        saa_andorl((reg),(bit),0)
428
429 #define saa_readb(reg)             readb(dev->bmmio + (reg))
430 #define saa_writeb(reg,value)      writeb((value), dev->bmmio + (reg));
431 #define saa_andorb(reg,mask,value) \
432   writeb((readb(dev->bmmio+(reg)) & ~(mask)) |\
433   ((value) & (mask)), dev->bmmio+(reg))
434 #define saa_setb(reg,bit)          saa_andorb((reg),(bit),(bit))
435 #define saa_clearb(reg,bit)        saa_andorb((reg),(bit),0)
436
437 #define saa_wait(d) { udelay(d); }
438
439 /* ----------------------------------------------------------- */
440 /* saa7134-core.c                                              */
441
442 extern struct list_head  saa7134_devlist;
443 extern unsigned int      saa7134_devcount;
444
445 void saa7134_print_ioctl(char *name, unsigned int cmd);
446 void saa7134_track_gpio(struct saa7134_dev *dev, char *msg);
447
448 #define SAA7134_PGTABLE_SIZE 4096
449
450 int saa7134_pgtable_alloc(struct pci_dev *pci, struct saa7134_pgtable *pt);
451 int  saa7134_pgtable_build(struct pci_dev *pci, struct saa7134_pgtable *pt,
452                            struct scatterlist *list, unsigned int length,
453                            unsigned int startpage);
454 void saa7134_pgtable_free(struct pci_dev *pci, struct saa7134_pgtable *pt);
455
456 int saa7134_buffer_count(unsigned int size, unsigned int count);
457 int saa7134_buffer_startpage(struct saa7134_buf *buf);
458 unsigned long saa7134_buffer_base(struct saa7134_buf *buf);
459
460 int saa7134_buffer_queue(struct saa7134_dev *dev, struct saa7134_dmaqueue *q,
461                          struct saa7134_buf *buf);
462 void saa7134_buffer_finish(struct saa7134_dev *dev, struct saa7134_dmaqueue *q,
463                            unsigned int state);
464 void saa7134_buffer_next(struct saa7134_dev *dev, struct saa7134_dmaqueue *q);
465 void saa7134_buffer_timeout(unsigned long data);
466 void saa7134_dma_free(struct saa7134_dev *dev,struct saa7134_buf *buf);
467
468 int saa7134_set_dmabits(struct saa7134_dev *dev);
469
470 /* ----------------------------------------------------------- */
471 /* saa7134-cards.c                                             */
472
473 extern struct saa7134_board saa7134_boards[];
474 extern const unsigned int saa7134_bcount;
475 extern struct pci_device_id __devinitdata saa7134_pci_tbl[];
476
477 extern int saa7134_board_init(struct saa7134_dev *dev);
478
479
480 /* ----------------------------------------------------------- */
481 /* saa7134-i2c.c                                               */
482
483 int saa7134_i2c_register(struct saa7134_dev *dev);
484 int saa7134_i2c_unregister(struct saa7134_dev *dev);
485 void saa7134_i2c_call_clients(struct saa7134_dev *dev,
486                               unsigned int cmd, void *arg);
487
488
489 /* ----------------------------------------------------------- */
490 /* saa7134-video.c                                             */
491
492 extern struct video_device saa7134_video_template;
493 extern struct video_device saa7134_radio_template;
494
495 int saa7134_common_ioctl(struct saa7134_dev *dev,
496                          unsigned int cmd, void *arg);
497
498 int saa7134_video_init1(struct saa7134_dev *dev);
499 int saa7134_video_init2(struct saa7134_dev *dev);
500 int saa7134_video_fini(struct saa7134_dev *dev);
501 void saa7134_irq_video_intl(struct saa7134_dev *dev);
502 void saa7134_irq_video_done(struct saa7134_dev *dev, unsigned long status);
503
504
505 /* ----------------------------------------------------------- */
506 /* saa7134-ts.c                                                */
507
508 extern struct video_device saa7134_ts_template;
509 int saa7134_ts_init1(struct saa7134_dev *dev);
510 int saa7134_ts_fini(struct saa7134_dev *dev);
511 void saa7134_irq_ts_done(struct saa7134_dev *dev, unsigned long status);
512
513
514 /* ----------------------------------------------------------- */
515 /* saa7134-vbi.c                                               */
516
517 extern struct videobuf_queue_ops saa7134_vbi_qops;
518 extern struct video_device saa7134_vbi_template;
519
520 int saa7134_vbi_init1(struct saa7134_dev *dev);
521 int saa7134_vbi_fini(struct saa7134_dev *dev);
522 void saa7134_irq_vbi_done(struct saa7134_dev *dev, unsigned long status);
523
524
525 /* ----------------------------------------------------------- */
526 /* saa7134-tvaudio.c                                           */
527
528 int saa7134_tvaudio_rx2mode(u32 rx);
529
530 void saa7134_tvaudio_setmute(struct saa7134_dev *dev);
531 void saa7134_tvaudio_setinput(struct saa7134_dev *dev,
532                               struct saa7134_input *in);
533 void saa7134_tvaudio_setvolume(struct saa7134_dev *dev, int level);
534 int saa7134_tvaudio_getstereo(struct saa7134_dev *dev);
535
536 int saa7134_tvaudio_init2(struct saa7134_dev *dev);
537 int saa7134_tvaudio_fini(struct saa7134_dev *dev);
538 int saa7134_tvaudio_do_scan(struct saa7134_dev *dev);
539
540 int saa_dsp_writel(struct saa7134_dev *dev, int reg, u32 value);
541
542 /* ----------------------------------------------------------- */
543 /* saa7134-oss.c                                               */
544
545 extern struct file_operations saa7134_dsp_fops;
546 extern struct file_operations saa7134_mixer_fops;
547
548 int saa7134_oss_init1(struct saa7134_dev *dev);
549 int saa7134_oss_fini(struct saa7134_dev *dev);
550 void saa7134_irq_oss_done(struct saa7134_dev *dev, unsigned long status);
551
552 /* ----------------------------------------------------------- */
553 /* saa7134-input.c                                             */
554
555 int  saa7134_input_init1(struct saa7134_dev *dev);
556 void saa7134_input_fini(struct saa7134_dev *dev);
557 void saa7134_input_irq(struct saa7134_dev *dev);
558
559 /*
560  * Local variables:
561  * c-basic-offset: 8
562  * End:
563  */