ftp://ftp.kernel.org/pub/linux/kernel/v2.6/linux-2.6.6.tar.bz2
[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,11)
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
156 #define SAA7134_INPUT_MAX 8
157
158 struct saa7134_input {
159         char                    *name;
160         unsigned int            vmux;
161         enum saa7134_audio_in   amux;
162         unsigned int            gpio;
163         unsigned int            tv:1;
164 };
165
166 struct saa7134_board {
167         char                    *name;
168         unsigned int            audio_clock;
169
170         /* input switching */
171         unsigned int            gpiomask;
172         struct saa7134_input    inputs[SAA7134_INPUT_MAX];
173         struct saa7134_input    radio;
174         struct saa7134_input    mute;
175         
176         /* peripheral I/O */
177         unsigned int            i2s_rate;
178         unsigned int            has_ts;
179         enum saa7134_video_out  video_out;
180
181         /* i2c chip info */
182         unsigned int            tuner_type;
183         unsigned int            need_tda9887:1;
184 };
185
186 #define card_has_radio(dev)   (NULL != saa7134_boards[dev->board].radio.name)
187 #define card_has_ts(dev)      (saa7134_boards[dev->board].has_ts)
188 #define card(dev)             (saa7134_boards[dev->board])
189 #define card_in(dev,n)        (saa7134_boards[dev->board].inputs[n])
190
191 /* ----------------------------------------------------------- */
192 /* device / file handle status                                 */
193
194 #define RESOURCE_OVERLAY       1
195 #define RESOURCE_VIDEO         2
196 #define RESOURCE_VBI           4
197
198 #define INTERLACE_AUTO         0
199 #define INTERLACE_ON           1
200 #define INTERLACE_OFF          2
201
202 #define BUFFER_TIMEOUT     (HZ/2)  /* 0.5 seconds */
203
204 struct saa7134_dev;
205 struct saa7134_dma;
206
207 /* saa7134 page table */
208 struct saa7134_pgtable {
209         unsigned int               size;
210         u32                        *cpu;
211         dma_addr_t                 dma;
212 };
213
214 /* tvaudio thread status */
215 struct saa7134_thread {
216         pid_t                      pid;
217         struct completion          exit;
218         wait_queue_head_t          wq;
219         unsigned int               shutdown;
220         unsigned int               scan1;
221         unsigned int               scan2;
222         unsigned int               mode;
223 };
224
225 /* buffer for one video/vbi/ts frame */
226 struct saa7134_buf {
227         /* common v4l buffer stuff -- must be first */
228         struct videobuf_buffer vb;
229
230         /* saa7134 specific */
231         struct saa7134_format   *fmt;
232         unsigned int            top_seen;
233         int (*activate)(struct saa7134_dev *dev,
234                         struct saa7134_buf *buf,
235                         struct saa7134_buf *next);
236
237         /* page tables */
238         struct saa7134_pgtable  *pt;
239 };
240
241 struct saa7134_dmaqueue {
242         struct saa7134_dev         *dev;
243         struct saa7134_buf         *curr;
244         struct list_head           queue;
245         struct timer_list          timeout;
246         unsigned int               need_two;
247 };
248
249 /* video filehandle status */
250 struct saa7134_fh {
251         struct saa7134_dev         *dev;
252         unsigned int               radio;
253         enum v4l2_buf_type         type;
254         unsigned int               resources;
255 #ifdef VIDIOC_G_PRIORITY 
256         enum v4l2_priority         prio;
257 #endif
258
259         /* video overlay */
260         struct v4l2_window         win;
261         struct v4l2_clip           clips[8];
262         unsigned int               nclips;
263
264         /* video capture */
265         struct saa7134_format      *fmt;
266         unsigned int               width,height;
267         struct videobuf_queue      cap;
268         struct saa7134_pgtable     pt_cap;
269
270         /* vbi capture */
271         struct videobuf_queue      vbi;
272         struct saa7134_pgtable     pt_vbi;
273 };
274
275 /* TS status */
276 struct saa7134_ts {
277         unsigned int               users;
278
279         /* TS capture */
280         struct videobuf_queue      ts;
281         struct saa7134_pgtable     pt_ts;
282         int                        started;
283 };
284
285 /* oss dsp status */
286 struct saa7134_oss {
287         struct semaphore           lock;
288         int                        minor_mixer;
289         int                        minor_dsp;
290         unsigned int               users_dsp;
291
292         /* mixer */
293         enum saa7134_audio_in      input;
294         unsigned int               count;
295         unsigned int               line1;
296         unsigned int               line2;
297
298         /* dsp */
299         unsigned int               afmt;
300         unsigned int               rate;
301         unsigned int               channels;
302         unsigned int               recording_on;
303         unsigned int               dma_running;
304         unsigned int               blocks;
305         unsigned int               blksize;
306         unsigned int               bufsize;
307         struct saa7134_pgtable     pt;
308         struct videobuf_dmabuf     dma;
309         wait_queue_head_t          wq;
310         unsigned int               dma_blk;
311         unsigned int               read_offset;
312         unsigned int               read_count;
313 };
314
315 /* IR input */
316 struct saa7134_ir {
317         struct input_dev           dev;
318         struct ir_input_state      ir;
319         char                       name[32];
320         char                       phys[32];
321         u32                        mask_keycode;
322         u32                        mask_keydown;
323         u32                        mask_keyup;
324         int                        polling;
325         u32                        last_gpio;
326         struct timer_list          timer;
327 };
328
329 /* global device status */
330 struct saa7134_dev {
331         struct list_head           devlist;
332         struct semaphore           lock;
333         spinlock_t                 slock;
334 #ifdef VIDIOC_G_PRIORITY 
335         struct v4l2_prio_state     prio;
336 #endif
337
338         /* various device info */
339         unsigned int               resources;
340         struct video_device        *video_dev;
341         struct video_device        *ts_dev;
342         struct video_device        *radio_dev;
343         struct video_device        *vbi_dev;
344         struct saa7134_oss         oss;
345         struct saa7134_ts          ts;
346
347         /* infrared remote */
348         int                        has_remote;
349         struct saa7134_ir          *remote;
350
351         /* pci i/o */
352         char                       name[32];
353         struct pci_dev             *pci;
354         unsigned char              pci_rev,pci_lat;
355         __u32                      *lmmio;
356         __u8                       *bmmio;
357
358         /* config info */
359         unsigned int               board;
360         unsigned int               tuner_type;
361         unsigned int               gpio_value;
362
363         /* i2c i/o */
364         struct i2c_adapter         i2c_adap;
365         struct i2c_client          i2c_client;
366         unsigned char              eedata[64];
367
368         /* video overlay */
369         struct v4l2_framebuffer    ovbuf;
370         struct saa7134_format      *ovfmt;
371         unsigned int               ovenable;
372         enum v4l2_field            ovfield;
373
374         /* video+ts+vbi capture */
375         struct saa7134_dmaqueue    video_q;
376         struct saa7134_dmaqueue    ts_q;
377         struct saa7134_dmaqueue    vbi_q;
378         unsigned int               video_fieldcount;
379         unsigned int               vbi_fieldcount;
380
381         /* various v4l controls */
382         struct saa7134_tvnorm      *tvnorm;              /* video */
383         struct saa7134_tvaudio     *tvaudio;
384         unsigned int               ctl_input;
385         int                        ctl_bright;
386         int                        ctl_contrast;
387         int                        ctl_hue;
388         int                        ctl_saturation;
389         int                        ctl_freq;
390         int                        ctl_mute;             /* audio */
391         int                        ctl_volume;
392         int                        ctl_invert;           /* private */
393         int                        ctl_mirror;
394         int                        ctl_y_odd;
395         int                        ctl_y_even;
396
397         /* crop */
398         struct v4l2_rect           crop_bounds;
399         struct v4l2_rect           crop_defrect;
400         struct v4l2_rect           crop_current;
401
402         /* other global state info */
403         unsigned int               automute;
404         struct saa7134_thread      thread;
405         struct saa7134_input       *input;
406         struct saa7134_input       *hw_input;
407         unsigned int               hw_mute;
408         int                        last_carrier;
409 };
410
411 /* ----------------------------------------------------------- */
412
413 #define saa_readl(reg)             readl(dev->lmmio + (reg))
414 #define saa_writel(reg,value)      writel((value), dev->lmmio + (reg));
415 #define saa_andorl(reg,mask,value) \
416   writel((readl(dev->lmmio+(reg)) & ~(mask)) |\
417   ((value) & (mask)), dev->lmmio+(reg))
418 #define saa_setl(reg,bit)          saa_andorl((reg),(bit),(bit))
419 #define saa_clearl(reg,bit)        saa_andorl((reg),(bit),0)
420
421 #define saa_readb(reg)             readb(dev->bmmio + (reg))
422 #define saa_writeb(reg,value)      writeb((value), dev->bmmio + (reg));
423 #define saa_andorb(reg,mask,value) \
424   writeb((readb(dev->bmmio+(reg)) & ~(mask)) |\
425   ((value) & (mask)), dev->bmmio+(reg))
426 #define saa_setb(reg,bit)          saa_andorb((reg),(bit),(bit))
427 #define saa_clearb(reg,bit)        saa_andorb((reg),(bit),0)
428
429 #define saa_wait(d) { udelay(d); }
430
431 /* ----------------------------------------------------------- */
432 /* saa7134-core.c                                              */
433
434 extern struct list_head  saa7134_devlist;
435 extern unsigned int      saa7134_devcount;
436
437 void saa7134_print_ioctl(char *name, unsigned int cmd);
438 void saa7134_track_gpio(struct saa7134_dev *dev, char *msg);
439
440 #define SAA7134_PGTABLE_SIZE 4096
441
442 int saa7134_pgtable_alloc(struct pci_dev *pci, struct saa7134_pgtable *pt);
443 int  saa7134_pgtable_build(struct pci_dev *pci, struct saa7134_pgtable *pt,
444                            struct scatterlist *list, unsigned int length,
445                            unsigned int startpage);
446 void saa7134_pgtable_free(struct pci_dev *pci, struct saa7134_pgtable *pt);
447
448 int saa7134_buffer_count(unsigned int size, unsigned int count);
449 int saa7134_buffer_startpage(struct saa7134_buf *buf);
450 unsigned long saa7134_buffer_base(struct saa7134_buf *buf);
451
452 int saa7134_buffer_queue(struct saa7134_dev *dev, struct saa7134_dmaqueue *q,
453                          struct saa7134_buf *buf);
454 void saa7134_buffer_finish(struct saa7134_dev *dev, struct saa7134_dmaqueue *q,
455                            unsigned int state);
456 void saa7134_buffer_next(struct saa7134_dev *dev, struct saa7134_dmaqueue *q);
457 void saa7134_buffer_timeout(unsigned long data);
458 void saa7134_dma_free(struct saa7134_dev *dev,struct saa7134_buf *buf);
459
460 int saa7134_set_dmabits(struct saa7134_dev *dev);
461
462 /* ----------------------------------------------------------- */
463 /* saa7134-cards.c                                             */
464
465 extern struct saa7134_board saa7134_boards[];
466 extern const unsigned int saa7134_bcount;
467 extern struct pci_device_id __devinitdata saa7134_pci_tbl[];
468
469 extern int saa7134_board_init(struct saa7134_dev *dev);
470
471
472 /* ----------------------------------------------------------- */
473 /* saa7134-i2c.c                                               */
474
475 int saa7134_i2c_register(struct saa7134_dev *dev);
476 int saa7134_i2c_unregister(struct saa7134_dev *dev);
477 void saa7134_i2c_call_clients(struct saa7134_dev *dev,
478                               unsigned int cmd, void *arg);
479
480
481 /* ----------------------------------------------------------- */
482 /* saa7134-video.c                                             */
483
484 extern struct video_device saa7134_video_template;
485 extern struct video_device saa7134_radio_template;
486
487 int saa7134_common_ioctl(struct saa7134_dev *dev,
488                          unsigned int cmd, void *arg);
489
490 int saa7134_video_init1(struct saa7134_dev *dev);
491 int saa7134_video_init2(struct saa7134_dev *dev);
492 int saa7134_video_fini(struct saa7134_dev *dev);
493 void saa7134_irq_video_intl(struct saa7134_dev *dev);
494 void saa7134_irq_video_done(struct saa7134_dev *dev, unsigned long status);
495
496
497 /* ----------------------------------------------------------- */
498 /* saa7134-ts.c                                                */
499
500 extern struct video_device saa7134_ts_template;
501 int saa7134_ts_init1(struct saa7134_dev *dev);
502 int saa7134_ts_fini(struct saa7134_dev *dev);
503 void saa7134_irq_ts_done(struct saa7134_dev *dev, unsigned long status);
504
505
506 /* ----------------------------------------------------------- */
507 /* saa7134-vbi.c                                               */
508
509 extern struct videobuf_queue_ops saa7134_vbi_qops;
510 extern struct video_device saa7134_vbi_template;
511
512 int saa7134_vbi_init1(struct saa7134_dev *dev);
513 int saa7134_vbi_fini(struct saa7134_dev *dev);
514 void saa7134_irq_vbi_done(struct saa7134_dev *dev, unsigned long status);
515
516
517 /* ----------------------------------------------------------- */
518 /* saa7134-tvaudio.c                                           */
519
520 int saa7134_tvaudio_rx2mode(u32 rx);
521
522 void saa7134_tvaudio_setmute(struct saa7134_dev *dev);
523 void saa7134_tvaudio_setinput(struct saa7134_dev *dev,
524                               struct saa7134_input *in);
525 void saa7134_tvaudio_setvolume(struct saa7134_dev *dev, int level);
526 int saa7134_tvaudio_getstereo(struct saa7134_dev *dev);
527
528 int saa7134_tvaudio_init2(struct saa7134_dev *dev);
529 int saa7134_tvaudio_fini(struct saa7134_dev *dev);
530 int saa7134_tvaudio_do_scan(struct saa7134_dev *dev);
531
532 int saa_dsp_writel(struct saa7134_dev *dev, int reg, u32 value);
533
534 /* ----------------------------------------------------------- */
535 /* saa7134-oss.c                                               */
536
537 extern struct file_operations saa7134_dsp_fops;
538 extern struct file_operations saa7134_mixer_fops;
539
540 int saa7134_oss_init1(struct saa7134_dev *dev);
541 int saa7134_oss_fini(struct saa7134_dev *dev);
542 void saa7134_irq_oss_done(struct saa7134_dev *dev, unsigned long status);
543
544 /* ----------------------------------------------------------- */
545 /* saa7134-input.c                                             */
546
547 int  saa7134_input_init1(struct saa7134_dev *dev);
548 void saa7134_input_fini(struct saa7134_dev *dev);
549 void saa7134_input_irq(struct saa7134_dev *dev);
550
551 /*
552  * Local variables:
553  * c-basic-offset: 8
554  * End:
555  */