Linux v2.6.15-rc7
[pohmelfs.git] / drivers / media / video / cx88 / cx88.h
blob77beafc5c32764c81d67f89bdf3cfd784935a842
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/videodev2.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_STUDIO_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
177 #define CX88_BOARD_AVERMEDIA_ULTRATV_MC_550 32
178 #define CX88_BOARD_KWORLD_VSTREAM_EXPERT_DVD 33
179 #define CX88_BOARD_ATI_HDTVWONDER 34
180 #define CX88_BOARD_WINFAST_DTV1000 35
181 #define CX88_BOARD_AVERTV_303 36
183 enum cx88_itype {
184 CX88_VMUX_COMPOSITE1 = 1,
185 CX88_VMUX_COMPOSITE2,
186 CX88_VMUX_COMPOSITE3,
187 CX88_VMUX_COMPOSITE4,
188 CX88_VMUX_SVIDEO,
189 CX88_VMUX_TELEVISION,
190 CX88_VMUX_CABLE,
191 CX88_VMUX_DVB,
192 CX88_VMUX_DEBUG,
193 CX88_RADIO,
196 struct cx88_input {
197 enum cx88_itype type;
198 unsigned int vmux;
199 u32 gpio0, gpio1, gpio2, gpio3;
202 struct cx88_board {
203 char *name;
204 unsigned int tuner_type;
205 unsigned int radio_type;
206 unsigned char tuner_addr;
207 unsigned char radio_addr;
208 int tda9887_conf;
209 struct cx88_input input[MAX_CX88_INPUT];
210 struct cx88_input radio;
211 unsigned int blackbird:1;
212 unsigned int dvb:1;
215 struct cx88_subid {
216 u16 subvendor;
217 u16 subdevice;
218 u32 card;
221 #define INPUT(nr) (&cx88_boards[core->board].input[nr])
223 /* ----------------------------------------------------------- */
224 /* device / file handle status */
226 #define RESOURCE_OVERLAY 1
227 #define RESOURCE_VIDEO 2
228 #define RESOURCE_VBI 4
230 #define BUFFER_TIMEOUT (HZ/2) /* 0.5 seconds */
232 /* buffer for one video frame */
233 struct cx88_buffer {
234 /* common v4l buffer stuff -- must be first */
235 struct videobuf_buffer vb;
237 /* cx88 specific */
238 unsigned int bpl;
239 struct btcx_riscmem risc;
240 struct cx8800_fmt *fmt;
241 u32 count;
244 struct cx88_dmaqueue {
245 struct list_head active;
246 struct list_head queued;
247 struct timer_list timeout;
248 struct btcx_riscmem stopper;
249 u32 count;
252 struct cx88_core {
253 struct list_head devlist;
254 atomic_t refcount;
256 /* board name */
257 int nr;
258 char name[32];
260 /* pci stuff */
261 int pci_bus;
262 int pci_slot;
263 u32 __iomem *lmmio;
264 u8 __iomem *bmmio;
265 u32 shadow[SHADOW_MAX];
266 int pci_irqmask;
268 /* i2c i/o */
269 struct i2c_adapter i2c_adap;
270 struct i2c_algo_bit_data i2c_algo;
271 struct i2c_client i2c_client;
272 u32 i2c_state, i2c_rc;
274 /* config info -- analog */
275 unsigned int board;
276 unsigned int tuner_type;
277 unsigned int radio_type;
278 unsigned char tuner_addr;
279 unsigned char radio_addr;
280 unsigned int tda9887_conf;
281 unsigned int has_radio;
283 /* config info -- dvb */
284 struct dvb_pll_desc *pll_desc;
285 unsigned int pll_addr;
287 /* state info */
288 struct task_struct *kthread;
289 struct cx88_tvnorm *tvnorm;
290 u32 tvaudio;
291 u32 audiomode_manual;
292 u32 audiomode_current;
293 u32 input;
294 u32 astat;
295 u32 use_nicam;
297 /* IR remote control state */
298 struct cx88_IR *ir;
300 struct semaphore lock;
302 /* various v4l controls */
303 u32 freq;
306 struct cx8800_dev;
307 struct cx8802_dev;
309 /* ----------------------------------------------------------- */
310 /* function 0: video stuff */
312 struct cx8800_fh {
313 struct cx8800_dev *dev;
314 enum v4l2_buf_type type;
315 int radio;
316 unsigned int resources;
318 /* video overlay */
319 struct v4l2_window win;
320 struct v4l2_clip *clips;
321 unsigned int nclips;
323 /* video capture */
324 struct cx8800_fmt *fmt;
325 unsigned int width,height;
326 struct videobuf_queue vidq;
328 /* vbi capture */
329 struct videobuf_queue vbiq;
332 struct cx8800_suspend_state {
333 int disabled;
336 struct cx8800_dev {
337 struct cx88_core *core;
338 struct list_head devlist;
339 spinlock_t slock;
341 /* various device info */
342 unsigned int resources;
343 struct video_device *video_dev;
344 struct video_device *vbi_dev;
345 struct video_device *radio_dev;
347 /* pci i/o */
348 struct pci_dev *pci;
349 unsigned char pci_rev,pci_lat;
352 /* capture queues */
353 struct cx88_dmaqueue vidq;
354 struct cx88_dmaqueue vbiq;
356 /* various v4l controls */
358 /* other global state info */
359 struct cx8800_suspend_state state;
362 /* ----------------------------------------------------------- */
363 /* function 1: audio/alsa stuff */
364 /* =============> moved to cx88-alsa.c <====================== */
367 /* ----------------------------------------------------------- */
368 /* function 2: mpeg stuff */
370 struct cx8802_fh {
371 struct cx8802_dev *dev;
372 struct videobuf_queue mpegq;
375 struct cx8802_suspend_state {
376 int disabled;
379 /* TODO: move this to struct v4l2_mpeg_compression ? */
380 struct blackbird_dnr {
381 u32 mode;
382 u32 type;
383 u32 spatial;
384 u32 temporal;
387 struct cx8802_dev {
388 struct cx88_core *core;
389 spinlock_t slock;
391 /* pci i/o */
392 struct pci_dev *pci;
393 unsigned char pci_rev,pci_lat;
395 /* dma queues */
396 struct cx88_dmaqueue mpegq;
397 u32 ts_packet_size;
398 u32 ts_packet_count;
400 /* other global state info */
401 struct cx8802_suspend_state state;
403 /* for blackbird only */
404 struct list_head devlist;
405 struct video_device *mpeg_dev;
406 u32 mailbox;
407 int width;
408 int height;
410 /* for dvb only */
411 struct videobuf_dvb dvb;
412 void* fe_handle;
413 int (*fe_release)(void *handle);
414 /* for switching modulation types */
415 unsigned char ts_gen_cntrl;
417 /* mpeg params */
418 struct v4l2_mpeg_compression params;
419 struct blackbird_dnr dnr_params;
422 /* ----------------------------------------------------------- */
424 #define cx_read(reg) readl(core->lmmio + ((reg)>>2))
425 #define cx_write(reg,value) writel((value), core->lmmio + ((reg)>>2))
426 #define cx_writeb(reg,value) writeb((value), core->bmmio + (reg))
428 #define cx_andor(reg,mask,value) \
429 writel((readl(core->lmmio+((reg)>>2)) & ~(mask)) |\
430 ((value) & (mask)), core->lmmio+((reg)>>2))
431 #define cx_set(reg,bit) cx_andor((reg),(bit),(bit))
432 #define cx_clear(reg,bit) cx_andor((reg),(bit),0)
434 #define cx_wait(d) { if (need_resched()) schedule(); else udelay(d); }
436 /* shadow registers */
437 #define cx_sread(sreg) (core->shadow[sreg])
438 #define cx_swrite(sreg,reg,value) \
439 (core->shadow[sreg] = value, \
440 writel(core->shadow[sreg], core->lmmio + ((reg)>>2)))
441 #define cx_sandor(sreg,reg,mask,value) \
442 (core->shadow[sreg] = (core->shadow[sreg] & ~(mask)) | ((value) & (mask)), \
443 writel(core->shadow[sreg], core->lmmio + ((reg)>>2)))
445 /* ----------------------------------------------------------- */
446 /* cx88-core.c */
448 extern void cx88_print_irqbits(char *name, char *tag, char **strings,
449 u32 bits, u32 mask);
450 extern void cx88_print_ioctl(char *name, unsigned int cmd);
452 extern int cx88_core_irq(struct cx88_core *core, u32 status);
453 extern void cx88_wakeup(struct cx88_core *core,
454 struct cx88_dmaqueue *q, u32 count);
455 extern void cx88_shutdown(struct cx88_core *core);
456 extern int cx88_reset(struct cx88_core *core);
458 extern int
459 cx88_risc_buffer(struct pci_dev *pci, struct btcx_riscmem *risc,
460 struct scatterlist *sglist,
461 unsigned int top_offset, unsigned int bottom_offset,
462 unsigned int bpl, unsigned int padding, unsigned int lines);
463 extern int
464 cx88_risc_databuffer(struct pci_dev *pci, struct btcx_riscmem *risc,
465 struct scatterlist *sglist, unsigned int bpl,
466 unsigned int lines);
467 extern int
468 cx88_risc_stopper(struct pci_dev *pci, struct btcx_riscmem *risc,
469 u32 reg, u32 mask, u32 value);
470 extern void
471 cx88_free_buffer(struct pci_dev *pci, struct cx88_buffer *buf);
473 extern void cx88_risc_disasm(struct cx88_core *core,
474 struct btcx_riscmem *risc);
475 extern int cx88_sram_channel_setup(struct cx88_core *core,
476 struct sram_channel *ch,
477 unsigned int bpl, u32 risc);
478 extern void cx88_sram_channel_dump(struct cx88_core *core,
479 struct sram_channel *ch);
481 extern int cx88_set_scale(struct cx88_core *core, unsigned int width,
482 unsigned int height, enum v4l2_field field);
483 extern int cx88_set_tvnorm(struct cx88_core *core, struct cx88_tvnorm *norm);
485 extern struct video_device *cx88_vdev_init(struct cx88_core *core,
486 struct pci_dev *pci,
487 struct video_device *template,
488 char *type);
489 extern struct cx88_core* cx88_core_get(struct pci_dev *pci);
490 extern void cx88_core_put(struct cx88_core *core,
491 struct pci_dev *pci);
493 extern int cx88_start_audio_dma(struct cx88_core *core);
494 extern int cx88_stop_audio_dma(struct cx88_core *core);
497 /* ----------------------------------------------------------- */
498 /* cx88-vbi.c */
500 void cx8800_vbi_fmt(struct cx8800_dev *dev, struct v4l2_format *f);
502 int cx8800_start_vbi_dma(struct cx8800_dev *dev,
503 struct cx88_dmaqueue *q,
504 struct cx88_buffer *buf);
506 int cx8800_stop_vbi_dma(struct cx8800_dev *dev);
507 int cx8800_restart_vbi_queue(struct cx8800_dev *dev,
508 struct cx88_dmaqueue *q);
509 void cx8800_vbi_timeout(unsigned long data);
511 extern struct videobuf_queue_ops cx8800_vbi_qops;
513 /* ----------------------------------------------------------- */
514 /* cx88-i2c.c */
516 extern int cx88_i2c_init(struct cx88_core *core, struct pci_dev *pci);
517 extern void cx88_call_i2c_clients(struct cx88_core *core,
518 unsigned int cmd, void *arg);
521 /* ----------------------------------------------------------- */
522 /* cx88-cards.c */
524 extern struct cx88_board cx88_boards[];
525 extern const unsigned int cx88_bcount;
527 extern struct cx88_subid cx88_subids[];
528 extern const unsigned int cx88_idcount;
530 extern void cx88_card_list(struct cx88_core *core, struct pci_dev *pci);
531 extern void cx88_card_setup(struct cx88_core *core);
533 /* ----------------------------------------------------------- */
534 /* cx88-tvaudio.c */
536 #define WW_NONE 1
537 #define WW_BTSC 2
538 #define WW_BG 3
539 #define WW_DK 4
540 #define WW_I 5
541 #define WW_L 6
542 #define WW_EIAJ 7
543 #define WW_I2SPT 8
544 #define WW_FM 9
546 void cx88_set_tvaudio(struct cx88_core *core);
547 void cx88_newstation(struct cx88_core *core);
548 void cx88_get_stereo(struct cx88_core *core, struct v4l2_tuner *t);
549 void cx88_set_stereo(struct cx88_core *core, u32 mode, int manual);
550 int cx88_audio_thread(void *data);
551 int cx88_detect_nicam(struct cx88_core *core);
553 /* ----------------------------------------------------------- */
554 /* cx88-input.c */
556 int cx88_ir_init(struct cx88_core *core, struct pci_dev *pci);
557 int cx88_ir_fini(struct cx88_core *core);
558 void cx88_ir_irq(struct cx88_core *core);
560 /* ----------------------------------------------------------- */
561 /* cx88-mpeg.c */
563 int cx8802_buf_prepare(struct cx8802_dev *dev, struct cx88_buffer *buf,
564 enum v4l2_field field);
565 void cx8802_buf_queue(struct cx8802_dev *dev, struct cx88_buffer *buf);
566 void cx8802_cancel_buffers(struct cx8802_dev *dev);
568 int cx8802_init_common(struct cx8802_dev *dev);
569 void cx8802_fini_common(struct cx8802_dev *dev);
571 int cx8802_suspend_common(struct pci_dev *pci_dev, pm_message_t state);
572 int cx8802_resume_common(struct pci_dev *pci_dev);
574 /* ----------------------------------------------------------- */
575 /* cx88-video.c */
576 extern int cx88_do_ioctl(struct inode *inode, struct file *file, int radio,
577 struct cx88_core *core, unsigned int cmd,
578 void *arg, v4l2_kioctl driver_ioctl);
580 /* ----------------------------------------------------------- */
581 /* cx88-blackbird.c */
582 extern int (*cx88_ioctl_hook)(struct inode *inode, struct file *file,
583 unsigned int cmd, void *arg);
584 extern unsigned int (*cx88_ioctl_translator)(unsigned int cmd);
585 void blackbird_set_params(struct cx8802_dev *dev,
586 struct v4l2_mpeg_compression *params);
587 void blackbird_set_dnr_params(struct cx8802_dev *dev,
588 struct blackbird_dnr* dnr_params);
591 * Local variables:
592 * c-basic-offset: 8
593 * End:
594 * 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