[PATCH] v4l: CX88 Update
[linux-2.6.git] / drivers / media / video / cx88 / cx88.h
1 /*
2  * $Id: cx88.h,v 1.68 2005/07/07 14:17:47 mchehab Exp $
3  *
4  * v4l2 device driver for cx2388x based TV cards
5  *
6  * (c) 2003,04 Gerd Knorr <kraxel@bytesex.org> [SUSE Labs]
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/pci.h>
24 #include <linux/i2c.h>
25 #include <linux/i2c-algo-bit.h>
26 #include <linux/videodev.h>
27 #include <linux/kdev_t.h>
28
29 #include <media/tuner.h>
30 #include <media/tveeprom.h>
31 #include <media/audiochip.h>
32 #include <media/video-buf.h>
33 #include <media/video-buf-dvb.h>
34
35 #include "btcx-risc.h"
36 #include "cx88-reg.h"
37
38 #include <linux/version.h>
39 #define CX88_VERSION_CODE KERNEL_VERSION(0,0,4)
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 #define CX88_MAXBOARDS 8
50
51 /* ----------------------------------------------------------- */
52 /* defines and enums                                           */
53
54 #define FORMAT_FLAGS_PACKED       0x01
55 #define FORMAT_FLAGS_PLANAR       0x02
56
57 #define VBI_LINE_COUNT              17
58 #define VBI_LINE_LENGTH           2048
59
60 /* need "shadow" registers for some write-only ones ... */
61 #define SHADOW_AUD_VOL_CTL           1
62 #define SHADOW_AUD_BAL_CTL           2
63 #define SHADOW_MAX                   2
64
65 /* FM Radio deemphasis type */
66 enum cx88_deemph_type {
67         FM_NO_DEEMPH = 0,
68         FM_DEEMPH_50,
69         FM_DEEMPH_75
70 };
71
72 /* ----------------------------------------------------------- */
73 /* tv norms                                                    */
74
75 struct cx88_tvnorm {
76         char                   *name;
77         v4l2_std_id            id;
78         u32                    cxiformat;
79         u32                    cxoformat;
80 };
81
82 static unsigned int inline norm_maxw(struct cx88_tvnorm *norm)
83 {
84         return (norm->id & V4L2_STD_625_50) ? 768 : 640;
85 }
86
87
88 static unsigned int inline norm_maxh(struct cx88_tvnorm *norm)
89 {
90         return (norm->id & V4L2_STD_625_50) ? 576 : 480;
91 }
92
93 /* ----------------------------------------------------------- */
94 /* static data                                                 */
95
96 struct cx8800_fmt {
97         char  *name;
98         u32   fourcc;          /* v4l2 format id */
99         int   depth;
100         int   flags;
101         u32   cxformat;
102 };
103
104 struct cx88_ctrl {
105         struct v4l2_queryctrl  v;
106         u32                    off;
107         u32                    reg;
108         u32                    sreg;
109         u32                    mask;
110         u32                    shift;
111 };
112
113 /* ----------------------------------------------------------- */
114 /* SRAM memory management data (see cx88-core.c)               */
115
116 #define SRAM_CH21 0   /* video */
117 #define SRAM_CH22 1
118 #define SRAM_CH23 2
119 #define SRAM_CH24 3   /* vbi   */
120 #define SRAM_CH25 4   /* audio */
121 #define SRAM_CH26 5
122 #define SRAM_CH28 6   /* mpeg */
123 /* more */
124
125 struct sram_channel {
126         char *name;
127         u32  cmds_start;
128         u32  ctrl_start;
129         u32  cdt;
130         u32  fifo_start;
131         u32  fifo_size;
132         u32  ptr1_reg;
133         u32  ptr2_reg;
134         u32  cnt1_reg;
135         u32  cnt2_reg;
136 };
137 extern struct sram_channel cx88_sram_channels[];
138
139 /* ----------------------------------------------------------- */
140 /* card configuration                                          */
141
142 #define CX88_BOARD_NOAUTO               UNSET
143 #define CX88_BOARD_UNKNOWN                  0
144 #define CX88_BOARD_HAUPPAUGE                1
145 #define CX88_BOARD_GDI                      2
146 #define CX88_BOARD_PIXELVIEW                3
147 #define CX88_BOARD_ATI_WONDER_PRO           4
148 #define CX88_BOARD_WINFAST2000XP_EXPERT     5
149 #define CX88_BOARD_AVERTV_303               6
150 #define CX88_BOARD_MSI_TVANYWHERE_MASTER    7
151 #define CX88_BOARD_WINFAST_DV2000           8
152 #define CX88_BOARD_LEADTEK_PVR2000          9
153 #define CX88_BOARD_IODATA_GVVCP3PCI        10
154 #define CX88_BOARD_PROLINK_PLAYTVPVR       11
155 #define CX88_BOARD_ASUS_PVR_416            12
156 #define CX88_BOARD_MSI_TVANYWHERE          13
157 #define CX88_BOARD_KWORLD_DVB_T            14
158 #define CX88_BOARD_DVICO_FUSIONHDTV_DVB_T1 15
159 #define CX88_BOARD_KWORLD_LTV883           16
160 #define CX88_BOARD_DVICO_FUSIONHDTV_3_GOLD_Q  17
161 #define CX88_BOARD_HAUPPAUGE_DVB_T1        18
162 #define CX88_BOARD_CONEXANT_DVB_T1         19
163 #define CX88_BOARD_PROVIDEO_PV259          20
164 #define CX88_BOARD_DVICO_FUSIONHDTV_DVB_T_PLUS 21
165 #define CX88_BOARD_PCHDTV_HD3000           22
166 #define CX88_BOARD_DNTV_LIVE_DVB_T         23
167 #define CX88_BOARD_HAUPPAUGE_ROSLYN        24
168 #define CX88_BOARD_DIGITALLOGIC_MEC        25
169 #define CX88_BOARD_IODATA_GVBCTV7E         26
170 #define CX88_BOARD_PIXELVIEW_PLAYTV_ULTRA_PRO 27
171 #define CX88_BOARD_DVICO_FUSIONHDTV_3_GOLD_T  28
172 #define CX88_BOARD_ADSTECH_DVB_T_PCI          29
173 #define CX88_BOARD_TERRATEC_CINERGY_1400_DVB_T1  30
174
175 enum cx88_itype {
176         CX88_VMUX_COMPOSITE1 = 1,
177         CX88_VMUX_COMPOSITE2,
178         CX88_VMUX_COMPOSITE3,
179         CX88_VMUX_COMPOSITE4,
180         CX88_VMUX_SVIDEO,
181         CX88_VMUX_TELEVISION,
182         CX88_VMUX_CABLE,
183         CX88_VMUX_DVB,
184         CX88_VMUX_DEBUG,
185         CX88_RADIO,
186 };
187
188 struct cx88_input {
189         enum cx88_itype type;
190         unsigned int    vmux;
191         u32             gpio0, gpio1, gpio2, gpio3;
192 };
193
194 struct cx88_board {
195         char                    *name;
196         unsigned int            tuner_type;
197         unsigned int            radio_type;
198         unsigned char           tuner_addr;
199         unsigned char           radio_addr;
200         int                     tda9887_conf;
201         struct cx88_input       input[8];
202         struct cx88_input       radio;
203         int                     blackbird:1;
204         int                     dvb:1;
205 };
206
207 struct cx88_subid {
208         u16     subvendor;
209         u16     subdevice;
210         u32     card;
211 };
212
213 #define INPUT(nr) (&cx88_boards[core->board].input[nr])
214
215 /* ----------------------------------------------------------- */
216 /* device / file handle status                                 */
217
218 #define RESOURCE_OVERLAY       1
219 #define RESOURCE_VIDEO         2
220 #define RESOURCE_VBI           4
221
222 #define BUFFER_TIMEOUT     (HZ/2)  /* 0.5 seconds */
223
224 /* buffer for one video frame */
225 struct cx88_buffer {
226         /* common v4l buffer stuff -- must be first */
227         struct videobuf_buffer vb;
228
229         /* cx88 specific */
230         unsigned int           bpl;
231         struct btcx_riscmem    risc;
232         struct cx8800_fmt      *fmt;
233         u32                    count;
234 };
235
236 struct cx88_dmaqueue {
237         struct list_head       active;
238         struct list_head       queued;
239         struct timer_list      timeout;
240         struct btcx_riscmem    stopper;
241         u32                    count;
242 };
243
244 struct cx88_core {
245         struct list_head           devlist;
246         atomic_t                   refcount;
247
248         /* board name */
249         int                        nr;
250         char                       name[32];
251
252         /* pci stuff */
253         int                        pci_bus;
254         int                        pci_slot;
255         u32                        __iomem *lmmio;
256         u8                         __iomem *bmmio;
257         u32                        shadow[SHADOW_MAX];
258         int                        pci_irqmask;
259
260         /* i2c i/o */
261         struct i2c_adapter         i2c_adap;
262         struct i2c_algo_bit_data   i2c_algo;
263         struct i2c_client          i2c_client;
264         u32                        i2c_state, i2c_rc;
265
266         /* config info -- analog */
267         unsigned int               board;
268         unsigned int               tuner_type;
269         unsigned int               radio_type;
270         unsigned char              tuner_addr;
271         unsigned char              radio_addr;
272         unsigned int               tda9887_conf;
273         unsigned int               has_radio;
274
275         /* config info -- dvb */
276         struct dvb_pll_desc        *pll_desc;
277         unsigned int               pll_addr;
278
279         /* state info */
280         struct task_struct         *kthread;
281         struct cx88_tvnorm         *tvnorm;
282         u32                        tvaudio;
283         u32                        audiomode_manual;
284         u32                        audiomode_current;
285         u32                        input;
286         u32                        astat;
287
288         /* IR remote control state */
289         struct cx88_IR             *ir;
290 };
291
292 struct cx8800_dev;
293 struct cx8802_dev;
294
295 /* ----------------------------------------------------------- */
296 /* function 0: video stuff                                     */
297
298 struct cx8800_fh {
299         struct cx8800_dev          *dev;
300         enum v4l2_buf_type         type;
301         int                        radio;
302         unsigned int               resources;
303
304         /* video overlay */
305         struct v4l2_window         win;
306         struct v4l2_clip           *clips;
307         unsigned int               nclips;
308
309         /* video capture */
310         struct cx8800_fmt          *fmt;
311         unsigned int               width,height;
312         struct videobuf_queue      vidq;
313
314         /* vbi capture */
315         struct videobuf_queue      vbiq;
316 };
317
318 struct cx8800_suspend_state {
319         int                        disabled;
320 };
321
322 struct cx8800_dev {
323         struct cx88_core           *core;
324         struct list_head           devlist;
325         struct semaphore           lock;
326         spinlock_t                 slock;
327
328         /* various device info */
329         unsigned int               resources;
330         struct video_device        *video_dev;
331         struct video_device        *vbi_dev;
332         struct video_device        *radio_dev;
333
334         /* pci i/o */
335         struct pci_dev             *pci;
336         unsigned char              pci_rev,pci_lat;
337
338
339         /* capture queues */
340         struct cx88_dmaqueue       vidq;
341         struct cx88_dmaqueue       vbiq;
342
343         /* various v4l controls */
344         u32                        freq;
345
346         /* other global state info */
347         struct cx8800_suspend_state state;
348 };
349
350 /* ----------------------------------------------------------- */
351 /* function 1: audio/alsa stuff                                */
352
353 struct cx8801_dev {
354         struct cx88_core           *core;
355
356         /* pci i/o */
357         struct pci_dev             *pci;
358         unsigned char              pci_rev,pci_lat;
359 };
360
361 /* ----------------------------------------------------------- */
362 /* function 2: mpeg stuff                                      */
363
364 struct cx8802_fh {
365         struct cx8802_dev          *dev;
366         struct videobuf_queue      mpegq;
367 };
368
369 struct cx8802_suspend_state {
370         int                        disabled;
371 };
372
373 struct cx8802_dev {
374         struct cx88_core           *core;
375         struct semaphore           lock;
376         spinlock_t                 slock;
377
378         /* pci i/o */
379         struct pci_dev             *pci;
380         unsigned char              pci_rev,pci_lat;
381
382         /* dma queues */
383         struct cx88_dmaqueue       mpegq;
384         u32                        ts_packet_size;
385         u32                        ts_packet_count;
386
387         /* other global state info */
388         struct cx8802_suspend_state state;
389
390         /* for blackbird only */
391         struct list_head           devlist;
392         struct video_device        *mpeg_dev;
393         u32                        mailbox;
394         int                        width;
395         int                        height;
396
397         /* for dvb only */
398         struct videobuf_dvb        dvb;
399         void*                      fe_handle;
400         int                        (*fe_release)(void *handle);
401
402         /* for switching modulation types */
403         unsigned char              ts_gen_cntrl;
404 };
405
406 /* ----------------------------------------------------------- */
407
408 #define cx_read(reg)             readl(core->lmmio + ((reg)>>2))
409 #define cx_write(reg,value)      writel((value), core->lmmio + ((reg)>>2))
410 #define cx_writeb(reg,value)     writeb((value), core->bmmio + (reg))
411
412 #define cx_andor(reg,mask,value) \
413   writel((readl(core->lmmio+((reg)>>2)) & ~(mask)) |\
414   ((value) & (mask)), core->lmmio+((reg)>>2))
415 #define cx_set(reg,bit)          cx_andor((reg),(bit),(bit))
416 #define cx_clear(reg,bit)        cx_andor((reg),(bit),0)
417
418 #define cx_wait(d) { if (need_resched()) schedule(); else udelay(d); }
419
420 /* shadow registers */
421 #define cx_sread(sreg)              (core->shadow[sreg])
422 #define cx_swrite(sreg,reg,value) \
423   (core->shadow[sreg] = value, \
424    writel(core->shadow[sreg], core->lmmio + ((reg)>>2)))
425 #define cx_sandor(sreg,reg,mask,value) \
426   (core->shadow[sreg] = (core->shadow[sreg] & ~(mask)) | ((value) & (mask)), \
427    writel(core->shadow[sreg], core->lmmio + ((reg)>>2)))
428
429 /* ----------------------------------------------------------- */
430 /* cx88-core.c                                                 */
431
432 extern void cx88_print_irqbits(char *name, char *tag, char **strings,
433                                u32 bits, u32 mask);
434 extern void cx88_print_ioctl(char *name, unsigned int cmd);
435
436 extern int cx88_core_irq(struct cx88_core *core, u32 status);
437 extern void cx88_wakeup(struct cx88_core *core,
438                         struct cx88_dmaqueue *q, u32 count);
439 extern void cx88_shutdown(struct cx88_core *core);
440 extern int cx88_reset(struct cx88_core *core);
441
442 extern int
443 cx88_risc_buffer(struct pci_dev *pci, struct btcx_riscmem *risc,
444                  struct scatterlist *sglist,
445                  unsigned int top_offset, unsigned int bottom_offset,
446                  unsigned int bpl, unsigned int padding, unsigned int lines);
447 extern int
448 cx88_risc_databuffer(struct pci_dev *pci, struct btcx_riscmem *risc,
449                      struct scatterlist *sglist, unsigned int bpl,
450                      unsigned int lines);
451 extern int
452 cx88_risc_stopper(struct pci_dev *pci, struct btcx_riscmem *risc,
453                   u32 reg, u32 mask, u32 value);
454 extern void
455 cx88_free_buffer(struct pci_dev *pci, struct cx88_buffer *buf);
456
457 extern void cx88_risc_disasm(struct cx88_core *core,
458                              struct btcx_riscmem *risc);
459 extern int cx88_sram_channel_setup(struct cx88_core *core,
460                                    struct sram_channel *ch,
461                                    unsigned int bpl, u32 risc);
462 extern void cx88_sram_channel_dump(struct cx88_core *core,
463                                    struct sram_channel *ch);
464
465 extern int cx88_set_scale(struct cx88_core *core, unsigned int width,
466                           unsigned int height, enum v4l2_field field);
467 extern int cx88_set_tvnorm(struct cx88_core *core, struct cx88_tvnorm *norm);
468
469 extern struct video_device *cx88_vdev_init(struct cx88_core *core,
470                                            struct pci_dev *pci,
471                                            struct video_device *template,
472                                            char *type);
473 extern struct cx88_core* cx88_core_get(struct pci_dev *pci);
474 extern void cx88_core_put(struct cx88_core *core,
475                           struct pci_dev *pci);
476
477 /* ----------------------------------------------------------- */
478 /* cx88-vbi.c                                                  */
479
480 void cx8800_vbi_fmt(struct cx8800_dev *dev, struct v4l2_format *f);
481 /*
482 int cx8800_start_vbi_dma(struct cx8800_dev    *dev,
483                          struct cx88_dmaqueue *q,
484                          struct cx88_buffer   *buf);
485 */
486 int cx8800_stop_vbi_dma(struct cx8800_dev *dev);
487 int cx8800_restart_vbi_queue(struct cx8800_dev    *dev,
488                              struct cx88_dmaqueue *q);
489 void cx8800_vbi_timeout(unsigned long data);
490
491 extern struct videobuf_queue_ops cx8800_vbi_qops;
492
493 /* ----------------------------------------------------------- */
494 /* cx88-i2c.c                                                  */
495
496 extern int cx88_i2c_init(struct cx88_core *core, struct pci_dev *pci);
497 extern void cx88_call_i2c_clients(struct cx88_core *core,
498                                   unsigned int cmd, void *arg);
499
500
501 /* ----------------------------------------------------------- */
502 /* cx88-cards.c                                                */
503
504 extern struct cx88_board cx88_boards[];
505 extern const unsigned int cx88_bcount;
506
507 extern struct cx88_subid cx88_subids[];
508 extern const unsigned int cx88_idcount;
509
510 extern void cx88_card_list(struct cx88_core *core, struct pci_dev *pci);
511 extern void cx88_card_setup(struct cx88_core *core);
512
513 /* ----------------------------------------------------------- */
514 /* cx88-tvaudio.c                                              */
515
516 #define WW_NONE          1
517 #define WW_BTSC          2
518 #define WW_NICAM_I       3
519 #define WW_NICAM_BGDKL   4
520 #define WW_A1            5
521 #define WW_A2_BG         6
522 #define WW_A2_DK         7
523 #define WW_A2_M          8
524 #define WW_EIAJ          9
525 #define WW_SYSTEM_L_AM  10
526 #define WW_I2SPT        11
527 #define WW_FM           12
528
529 void cx88_set_tvaudio(struct cx88_core *core);
530 void cx88_newstation(struct cx88_core *core);
531 void cx88_get_stereo(struct cx88_core *core, struct v4l2_tuner *t);
532 void cx88_set_stereo(struct cx88_core *core, u32 mode, int manual);
533 int cx88_audio_thread(void *data);
534
535 /* ----------------------------------------------------------- */
536 /* cx88-input.c                                                */
537
538 int cx88_ir_init(struct cx88_core *core, struct pci_dev *pci);
539 int cx88_ir_fini(struct cx88_core *core);
540 void cx88_ir_irq(struct cx88_core *core);
541
542 /* ----------------------------------------------------------- */
543 /* cx88-mpeg.c                                                 */
544
545 int cx8802_buf_prepare(struct cx8802_dev *dev, struct cx88_buffer *buf);
546 void cx8802_buf_queue(struct cx8802_dev *dev, struct cx88_buffer *buf);
547 void cx8802_cancel_buffers(struct cx8802_dev *dev);
548
549 int cx8802_init_common(struct cx8802_dev *dev);
550 void cx8802_fini_common(struct cx8802_dev *dev);
551
552 int cx8802_suspend_common(struct pci_dev *pci_dev, pm_message_t state);
553 int cx8802_resume_common(struct pci_dev *pci_dev);
554
555 /*
556  * Local variables:
557  * c-basic-offset: 8
558  * End:
559  */