[PATCH] v4l: include saa6588 compiler option and files / fixes comments on tuner.h
[linux-2.6/zen-sources.git] / drivers / media / video / cx88 / cx88.h
blobf48dd43535688f676ba7a9c2f28418e79377f068
1 /*
3 * v4l2 device driver for cx2388x based TV cards
5 * (c) 2003,04 Gerd Knorr <kraxel@bytesex.org> [SUSE Labs]
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.
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.
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.
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>
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>
34 #include "btcx-risc.h"
35 #include "cx88-reg.h"
37 #include <linux/version.h>
38 #define CX88_VERSION_CODE KERNEL_VERSION(0,0,5)
40 #ifndef TRUE
41 # define TRUE (1==1)
42 #endif
43 #ifndef FALSE
44 # define FALSE (1==0)
45 #endif
46 #define UNSET (-1U)
48 #define CX88_MAXBOARDS 8
50 /* Max number of inputs by card */
51 #define MAX_CX88_INPUT 8
53 /* ----------------------------------------------------------- */
54 /* defines and enums */
56 #define FORMAT_FLAGS_PACKED 0x01
57 #define FORMAT_FLAGS_PLANAR 0x02
59 #define VBI_LINE_COUNT 17
60 #define VBI_LINE_LENGTH 2048
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
67 /* FM Radio deemphasis type */
68 enum cx88_deemph_type {
69 FM_NO_DEEMPH = 0,
70 FM_DEEMPH_50,
71 FM_DEEMPH_75
74 /* ----------------------------------------------------------- */
75 /* tv norms */
77 struct cx88_tvnorm {
78 char *name;
79 v4l2_std_id id;
80 u32 cxiformat;
81 u32 cxoformat;
84 static unsigned int inline norm_maxw(struct cx88_tvnorm *norm)
86 return (norm->id & V4L2_STD_625_50) ? 768 : 640;
90 static unsigned int inline norm_maxh(struct cx88_tvnorm *norm)
92 return (norm->id & V4L2_STD_625_50) ? 576 : 480;
95 /* ----------------------------------------------------------- */
96 /* static data */
98 struct cx8800_fmt {
99 char *name;
100 u32 fourcc; /* v4l2 format id */
101 int depth;
102 int flags;
103 u32 cxformat;
106 struct cx88_ctrl {
107 struct v4l2_queryctrl v;
108 u32 off;
109 u32 reg;
110 u32 sreg;
111 u32 mask;
112 u32 shift;
115 /* ----------------------------------------------------------- */
116 /* SRAM memory management data (see cx88-core.c) */
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 */
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;
139 extern struct sram_channel cx88_sram_channels[];
141 /* ----------------------------------------------------------- */
142 /* card configuration */
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
178 enum cx88_itype {
179 CX88_VMUX_COMPOSITE1 = 1,
180 CX88_VMUX_COMPOSITE2,
181 CX88_VMUX_COMPOSITE3,
182 CX88_VMUX_COMPOSITE4,
183 CX88_VMUX_SVIDEO,
184 CX88_VMUX_TELEVISION,
185 CX88_VMUX_CABLE,
186 CX88_VMUX_DVB,
187 CX88_VMUX_DEBUG,
188 CX88_RADIO,
191 struct cx88_input {
192 enum cx88_itype type;
193 unsigned int vmux;
194 u32 gpio0, gpio1, gpio2, gpio3;
197 struct cx88_board {
198 char *name;
199 unsigned int tuner_type;
200 unsigned int radio_type;
201 unsigned char tuner_addr;
202 unsigned char radio_addr;
203 int tda9887_conf;
204 struct cx88_input input[MAX_CX88_INPUT];
205 struct cx88_input radio;
206 int blackbird:1;
207 int dvb:1;
210 struct cx88_subid {
211 u16 subvendor;
212 u16 subdevice;
213 u32 card;
216 #define INPUT(nr) (&cx88_boards[core->board].input[nr])
218 /* ----------------------------------------------------------- */
219 /* device / file handle status */
221 #define RESOURCE_OVERLAY 1
222 #define RESOURCE_VIDEO 2
223 #define RESOURCE_VBI 4
225 #define BUFFER_TIMEOUT (HZ/2) /* 0.5 seconds */
227 /* buffer for one video frame */
228 struct cx88_buffer {
229 /* common v4l buffer stuff -- must be first */
230 struct videobuf_buffer vb;
232 /* cx88 specific */
233 unsigned int bpl;
234 struct btcx_riscmem risc;
235 struct cx8800_fmt *fmt;
236 u32 count;
239 struct cx88_dmaqueue {
240 struct list_head active;
241 struct list_head queued;
242 struct timer_list timeout;
243 struct btcx_riscmem stopper;
244 u32 count;
247 struct cx88_core {
248 struct list_head devlist;
249 atomic_t refcount;
251 /* board name */
252 int nr;
253 char name[32];
255 /* pci stuff */
256 int pci_bus;
257 int pci_slot;
258 u32 __iomem *lmmio;
259 u8 __iomem *bmmio;
260 u32 shadow[SHADOW_MAX];
261 int pci_irqmask;
263 /* i2c i/o */
264 struct i2c_adapter i2c_adap;
265 struct i2c_algo_bit_data i2c_algo;
266 struct i2c_client i2c_client;
267 u32 i2c_state, i2c_rc;
269 /* config info -- analog */
270 unsigned int board;
271 unsigned int tuner_type;
272 unsigned int radio_type;
273 unsigned char tuner_addr;
274 unsigned char radio_addr;
275 unsigned int tda9887_conf;
276 unsigned int has_radio;
278 /* config info -- dvb */
279 struct dvb_pll_desc *pll_desc;
280 unsigned int pll_addr;
282 /* state info */
283 struct task_struct *kthread;
284 struct cx88_tvnorm *tvnorm;
285 u32 tvaudio;
286 u32 audiomode_manual;
287 u32 audiomode_current;
288 u32 input;
289 u32 astat;
291 /* IR remote control state */
292 struct cx88_IR *ir;
294 struct semaphore lock;
296 /* various v4l controls */
297 u32 freq;
300 struct cx8800_dev;
301 struct cx8802_dev;
303 /* ----------------------------------------------------------- */
304 /* function 0: video stuff */
306 struct cx8800_fh {
307 struct cx8800_dev *dev;
308 enum v4l2_buf_type type;
309 int radio;
310 unsigned int resources;
312 /* video overlay */
313 struct v4l2_window win;
314 struct v4l2_clip *clips;
315 unsigned int nclips;
317 /* video capture */
318 struct cx8800_fmt *fmt;
319 unsigned int width,height;
320 struct videobuf_queue vidq;
322 /* vbi capture */
323 struct videobuf_queue vbiq;
326 struct cx8800_suspend_state {
327 int disabled;
330 struct cx8800_dev {
331 struct cx88_core *core;
332 struct list_head devlist;
333 spinlock_t slock;
335 /* various device info */
336 unsigned int resources;
337 struct video_device *video_dev;
338 struct video_device *vbi_dev;
339 struct video_device *radio_dev;
341 /* pci i/o */
342 struct pci_dev *pci;
343 unsigned char pci_rev,pci_lat;
346 /* capture queues */
347 struct cx88_dmaqueue vidq;
348 struct cx88_dmaqueue vbiq;
350 /* various v4l controls */
352 /* other global state info */
353 struct cx8800_suspend_state state;
356 /* ----------------------------------------------------------- */
357 /* function 1: audio/alsa stuff */
358 /* =============> moved to cx88-alsa.c <====================== */
361 /* ----------------------------------------------------------- */
362 /* function 2: mpeg stuff */
364 struct cx8802_fh {
365 struct cx8802_dev *dev;
366 struct videobuf_queue mpegq;
369 struct cx8802_suspend_state {
370 int disabled;
373 struct cx8802_dev {
374 struct cx88_core *core;
375 spinlock_t slock;
377 /* pci i/o */
378 struct pci_dev *pci;
379 unsigned char pci_rev,pci_lat;
381 /* dma queues */
382 struct cx88_dmaqueue mpegq;
383 u32 ts_packet_size;
384 u32 ts_packet_count;
386 /* other global state info */
387 struct cx8802_suspend_state state;
389 /* for blackbird only */
390 struct list_head devlist;
391 struct video_device *mpeg_dev;
392 u32 mailbox;
393 int width;
394 int height;
396 /* for dvb only */
397 struct videobuf_dvb dvb;
398 void* fe_handle;
399 int (*fe_release)(void *handle);
401 /* for switching modulation types */
402 unsigned char ts_gen_cntrl;
405 /* ----------------------------------------------------------- */
407 #define cx_read(reg) readl(core->lmmio + ((reg)>>2))
408 #define cx_write(reg,value) writel((value), core->lmmio + ((reg)>>2))
409 #define cx_writeb(reg,value) writeb((value), core->bmmio + (reg))
411 #define cx_andor(reg,mask,value) \
412 writel((readl(core->lmmio+((reg)>>2)) & ~(mask)) |\
413 ((value) & (mask)), core->lmmio+((reg)>>2))
414 #define cx_set(reg,bit) cx_andor((reg),(bit),(bit))
415 #define cx_clear(reg,bit) cx_andor((reg),(bit),0)
417 #define cx_wait(d) { if (need_resched()) schedule(); else udelay(d); }
419 /* shadow registers */
420 #define cx_sread(sreg) (core->shadow[sreg])
421 #define cx_swrite(sreg,reg,value) \
422 (core->shadow[sreg] = value, \
423 writel(core->shadow[sreg], core->lmmio + ((reg)>>2)))
424 #define cx_sandor(sreg,reg,mask,value) \
425 (core->shadow[sreg] = (core->shadow[sreg] & ~(mask)) | ((value) & (mask)), \
426 writel(core->shadow[sreg], core->lmmio + ((reg)>>2)))
428 /* ----------------------------------------------------------- */
429 /* cx88-core.c */
431 extern void cx88_print_irqbits(char *name, char *tag, char **strings,
432 u32 bits, u32 mask);
433 extern void cx88_print_ioctl(char *name, unsigned int cmd);
435 extern int cx88_core_irq(struct cx88_core *core, u32 status);
436 extern void cx88_wakeup(struct cx88_core *core,
437 struct cx88_dmaqueue *q, u32 count);
438 extern void cx88_shutdown(struct cx88_core *core);
439 extern int cx88_reset(struct cx88_core *core);
441 extern int
442 cx88_risc_buffer(struct pci_dev *pci, struct btcx_riscmem *risc,
443 struct scatterlist *sglist,
444 unsigned int top_offset, unsigned int bottom_offset,
445 unsigned int bpl, unsigned int padding, unsigned int lines);
446 extern int
447 cx88_risc_databuffer(struct pci_dev *pci, struct btcx_riscmem *risc,
448 struct scatterlist *sglist, unsigned int bpl,
449 unsigned int lines);
450 extern int
451 cx88_risc_stopper(struct pci_dev *pci, struct btcx_riscmem *risc,
452 u32 reg, u32 mask, u32 value);
453 extern void
454 cx88_free_buffer(struct pci_dev *pci, struct cx88_buffer *buf);
456 extern void cx88_risc_disasm(struct cx88_core *core,
457 struct btcx_riscmem *risc);
458 extern int cx88_sram_channel_setup(struct cx88_core *core,
459 struct sram_channel *ch,
460 unsigned int bpl, u32 risc);
461 extern void cx88_sram_channel_dump(struct cx88_core *core,
462 struct sram_channel *ch);
464 extern int cx88_set_scale(struct cx88_core *core, unsigned int width,
465 unsigned int height, enum v4l2_field field);
466 extern int cx88_set_tvnorm(struct cx88_core *core, struct cx88_tvnorm *norm);
468 extern struct video_device *cx88_vdev_init(struct cx88_core *core,
469 struct pci_dev *pci,
470 struct video_device *template,
471 char *type);
472 extern struct cx88_core* cx88_core_get(struct pci_dev *pci);
473 extern void cx88_core_put(struct cx88_core *core,
474 struct pci_dev *pci);
476 /* ----------------------------------------------------------- */
477 /* cx88-vbi.c */
479 void cx8800_vbi_fmt(struct cx8800_dev *dev, struct v4l2_format *f);
481 int cx8800_start_vbi_dma(struct cx8800_dev *dev,
482 struct cx88_dmaqueue *q,
483 struct cx88_buffer *buf);
485 int cx8800_stop_vbi_dma(struct cx8800_dev *dev);
486 int cx8800_restart_vbi_queue(struct cx8800_dev *dev,
487 struct cx88_dmaqueue *q);
488 void cx8800_vbi_timeout(unsigned long data);
490 extern struct videobuf_queue_ops cx8800_vbi_qops;
492 /* ----------------------------------------------------------- */
493 /* cx88-i2c.c */
495 extern int cx88_i2c_init(struct cx88_core *core, struct pci_dev *pci);
496 extern void cx88_call_i2c_clients(struct cx88_core *core,
497 unsigned int cmd, void *arg);
500 /* ----------------------------------------------------------- */
501 /* cx88-cards.c */
503 extern struct cx88_board cx88_boards[];
504 extern const unsigned int cx88_bcount;
506 extern struct cx88_subid cx88_subids[];
507 extern const unsigned int cx88_idcount;
509 extern void cx88_card_list(struct cx88_core *core, struct pci_dev *pci);
510 extern void cx88_card_setup(struct cx88_core *core);
512 /* ----------------------------------------------------------- */
513 /* cx88-tvaudio.c */
515 #define WW_NONE 1
516 #define WW_BTSC 2
517 #define WW_NICAM_I 3
518 #define WW_NICAM_BGDKL 4
519 #define WW_A1 5
520 #define WW_A2_BG 6
521 #define WW_A2_DK 7
522 #define WW_A2_M 8
523 #define WW_EIAJ 9
524 #define WW_SYSTEM_L_AM 10
525 #define WW_I2SPT 11
526 #define WW_FM 12
528 void cx88_set_tvaudio(struct cx88_core *core);
529 void cx88_newstation(struct cx88_core *core);
530 void cx88_get_stereo(struct cx88_core *core, struct v4l2_tuner *t);
531 void cx88_set_stereo(struct cx88_core *core, u32 mode, int manual);
532 int cx88_audio_thread(void *data);
534 /* ----------------------------------------------------------- */
535 /* cx88-input.c */
537 int cx88_ir_init(struct cx88_core *core, struct pci_dev *pci);
538 int cx88_ir_fini(struct cx88_core *core);
539 void cx88_ir_irq(struct cx88_core *core);
541 /* ----------------------------------------------------------- */
542 /* cx88-mpeg.c */
544 int cx8802_buf_prepare(struct cx8802_dev *dev, struct cx88_buffer *buf);
545 void cx8802_buf_queue(struct cx8802_dev *dev, struct cx88_buffer *buf);
546 void cx8802_cancel_buffers(struct cx8802_dev *dev);
548 int cx8802_init_common(struct cx8802_dev *dev);
549 void cx8802_fini_common(struct cx8802_dev *dev);
551 int cx8802_suspend_common(struct pci_dev *pci_dev, pm_message_t state);
552 int cx8802_resume_common(struct pci_dev *pci_dev);
554 /* ----------------------------------------------------------- */
555 /* cx88-video.c */
556 extern int cx88_do_ioctl(struct inode *inode, struct file *file, int radio,
557 struct cx88_core *core, unsigned int cmd,
558 void *arg, v4l2_kioctl driver_ioctl);
560 /* ----------------------------------------------------------- */
561 /* cx88-blackbird.c */
562 extern int (*cx88_ioctl_hook)(struct inode *inode, struct file *file,
563 unsigned int cmd, void *arg);
564 extern unsigned int (*cx88_ioctl_translator)(unsigned int cmd);
567 * Local variables:
568 * c-basic-offset: 8
569 * End:
570 * 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