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