2 ivtv driver internal defines and structures
3 Copyright (C) 2003-2004 Kevin Thayer <nufan_wfk at yahoo.com>
4 Copyright (C) 2004 Chris Kennedy <c@groovy.org>
5 Copyright (C) 2005-2007 Hans Verkuil <hverkuil@xs4all.nl>
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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
25 /* Internal header for ivtv project:
26 * Driver for the cx23415/6 chip.
27 * Author: Kevin Thayer (nufan_wfk at yahoo.com)
29 * http://www.ivtvdriver.org
32 * MPG600/MPG160 support by T.Adachi <tadachi@tadachi-net.com>
33 * and Takeru KOMORIYA<komoriya@paken.org>
35 * AVerMedia M179 GPIO info by Chris Pinkham <cpinkham@bc2va.org>
36 * using information provided by Jiun-Kuei Jung @ AVerMedia.
39 #include <linux/version.h>
40 #include <linux/module.h>
41 #include <linux/init.h>
42 #include <linux/delay.h>
43 #include <linux/sched.h>
45 #include <linux/pci.h>
46 #include <linux/interrupt.h>
47 #include <linux/spinlock.h>
48 #include <linux/i2c.h>
49 #include <linux/i2c-algo-bit.h>
50 #include <linux/list.h>
51 #include <linux/unistd.h>
52 #include <linux/byteorder/swab.h>
53 #include <linux/pagemap.h>
54 #include <linux/scatterlist.h>
55 #include <linux/workqueue.h>
56 #include <linux/mutex.h>
57 #include <asm/uaccess.h>
58 #include <asm/system.h>
60 #include <linux/dvb/video.h>
61 #include <linux/dvb/audio.h>
62 #include <media/v4l2-common.h>
63 #include <media/v4l2-ioctl.h>
64 #include <media/tuner.h>
65 #include <media/cx2341x.h>
67 #include <linux/ivtv.h>
70 #define IVTV_ENCODER_OFFSET 0x00000000
71 #define IVTV_ENCODER_SIZE 0x00800000 /* Total size is 0x01000000, but only first half is used */
72 #define IVTV_DECODER_OFFSET 0x01000000
73 #define IVTV_DECODER_SIZE 0x00800000 /* Total size is 0x01000000, but only first half is used */
74 #define IVTV_REG_OFFSET 0x02000000
75 #define IVTV_REG_SIZE 0x00010000
77 /* Maximum ivtv driver instances. Some people have a huge number of
78 capture cards, so set this to a high value. */
79 #define IVTV_MAX_CARDS 32
81 #define IVTV_ENC_STREAM_TYPE_MPG 0
82 #define IVTV_ENC_STREAM_TYPE_YUV 1
83 #define IVTV_ENC_STREAM_TYPE_VBI 2
84 #define IVTV_ENC_STREAM_TYPE_PCM 3
85 #define IVTV_ENC_STREAM_TYPE_RAD 4
86 #define IVTV_DEC_STREAM_TYPE_MPG 5
87 #define IVTV_DEC_STREAM_TYPE_VBI 6
88 #define IVTV_DEC_STREAM_TYPE_VOUT 7
89 #define IVTV_DEC_STREAM_TYPE_YUV 8
90 #define IVTV_MAX_STREAMS 9
92 #define IVTV_DMA_SG_OSD_ENT (2883584/PAGE_SIZE) /* sg entities */
95 #define IVTV_REG_DMAXFER (0x0000)
96 #define IVTV_REG_DMASTATUS (0x0004)
97 #define IVTV_REG_DECDMAADDR (0x0008)
98 #define IVTV_REG_ENCDMAADDR (0x000c)
99 #define IVTV_REG_DMACONTROL (0x0010)
100 #define IVTV_REG_IRQSTATUS (0x0040)
101 #define IVTV_REG_IRQMASK (0x0048)
103 /* Setup Registers */
104 #define IVTV_REG_ENC_SDRAM_REFRESH (0x07F8)
105 #define IVTV_REG_ENC_SDRAM_PRECHARGE (0x07FC)
106 #define IVTV_REG_DEC_SDRAM_REFRESH (0x08F8)
107 #define IVTV_REG_DEC_SDRAM_PRECHARGE (0x08FC)
108 #define IVTV_REG_VDM (0x2800)
109 #define IVTV_REG_AO (0x2D00)
110 #define IVTV_REG_BYTEFLUSH (0x2D24)
111 #define IVTV_REG_SPU (0x9050)
112 #define IVTV_REG_HW_BLOCKS (0x9054)
113 #define IVTV_REG_VPU (0x9058)
114 #define IVTV_REG_APU (0xA064)
117 #define I2C_CLIENTS_MAX 16
120 extern int ivtv_debug;
122 #define IVTV_DBGFLG_WARN (1 << 0)
123 #define IVTV_DBGFLG_INFO (1 << 1)
124 #define IVTV_DBGFLG_MB (1 << 2)
125 #define IVTV_DBGFLG_IOCTL (1 << 3)
126 #define IVTV_DBGFLG_FILE (1 << 4)
127 #define IVTV_DBGFLG_DMA (1 << 5)
128 #define IVTV_DBGFLG_IRQ (1 << 6)
129 #define IVTV_DBGFLG_DEC (1 << 7)
130 #define IVTV_DBGFLG_YUV (1 << 8)
131 #define IVTV_DBGFLG_I2C (1 << 9)
132 /* Flag to turn on high volume debugging */
133 #define IVTV_DBGFLG_HIGHVOL (1 << 10)
135 /* NOTE: extra space before comma in 'itv->num , ## args' is required for
136 gcc-2.95, otherwise it won't compile. */
137 #define IVTV_DEBUG(x, type, fmt, args...) \
139 if ((x) & ivtv_debug) \
140 printk(KERN_INFO "ivtv%d " type ": " fmt, itv->num , ## args); \
142 #define IVTV_DEBUG_WARN(fmt, args...) IVTV_DEBUG(IVTV_DBGFLG_WARN, "warn", fmt , ## args)
143 #define IVTV_DEBUG_INFO(fmt, args...) IVTV_DEBUG(IVTV_DBGFLG_INFO, "info", fmt , ## args)
144 #define IVTV_DEBUG_MB(fmt, args...) IVTV_DEBUG(IVTV_DBGFLG_MB, "mb", fmt , ## args)
145 #define IVTV_DEBUG_DMA(fmt, args...) IVTV_DEBUG(IVTV_DBGFLG_DMA, "dma", fmt , ## args)
146 #define IVTV_DEBUG_IOCTL(fmt, args...) IVTV_DEBUG(IVTV_DBGFLG_IOCTL, "ioctl", fmt , ## args)
147 #define IVTV_DEBUG_FILE(fmt, args...) IVTV_DEBUG(IVTV_DBGFLG_FILE, "file", fmt , ## args)
148 #define IVTV_DEBUG_I2C(fmt, args...) IVTV_DEBUG(IVTV_DBGFLG_I2C, "i2c", fmt , ## args)
149 #define IVTV_DEBUG_IRQ(fmt, args...) IVTV_DEBUG(IVTV_DBGFLG_IRQ, "irq", fmt , ## args)
150 #define IVTV_DEBUG_DEC(fmt, args...) IVTV_DEBUG(IVTV_DBGFLG_DEC, "dec", fmt , ## args)
151 #define IVTV_DEBUG_YUV(fmt, args...) IVTV_DEBUG(IVTV_DBGFLG_YUV, "yuv", fmt , ## args)
153 #define IVTV_DEBUG_HIGH_VOL(x, type, fmt, args...) \
155 if (((x) & ivtv_debug) && (ivtv_debug & IVTV_DBGFLG_HIGHVOL)) \
156 printk(KERN_INFO "ivtv%d " type ": " fmt, itv->num , ## args); \
158 #define IVTV_DEBUG_HI_WARN(fmt, args...) IVTV_DEBUG_HIGH_VOL(IVTV_DBGFLG_WARN, "warn", fmt , ## args)
159 #define IVTV_DEBUG_HI_INFO(fmt, args...) IVTV_DEBUG_HIGH_VOL(IVTV_DBGFLG_INFO, "info", fmt , ## args)
160 #define IVTV_DEBUG_HI_MB(fmt, args...) IVTV_DEBUG_HIGH_VOL(IVTV_DBGFLG_MB, "mb", fmt , ## args)
161 #define IVTV_DEBUG_HI_DMA(fmt, args...) IVTV_DEBUG_HIGH_VOL(IVTV_DBGFLG_DMA, "dma", fmt , ## args)
162 #define IVTV_DEBUG_HI_IOCTL(fmt, args...) IVTV_DEBUG_HIGH_VOL(IVTV_DBGFLG_IOCTL, "ioctl", fmt , ## args)
163 #define IVTV_DEBUG_HI_FILE(fmt, args...) IVTV_DEBUG_HIGH_VOL(IVTV_DBGFLG_FILE, "file", fmt , ## args)
164 #define IVTV_DEBUG_HI_I2C(fmt, args...) IVTV_DEBUG_HIGH_VOL(IVTV_DBGFLG_I2C, "i2c", fmt , ## args)
165 #define IVTV_DEBUG_HI_IRQ(fmt, args...) IVTV_DEBUG_HIGH_VOL(IVTV_DBGFLG_IRQ, "irq", fmt , ## args)
166 #define IVTV_DEBUG_HI_DEC(fmt, args...) IVTV_DEBUG_HIGH_VOL(IVTV_DBGFLG_DEC, "dec", fmt , ## args)
167 #define IVTV_DEBUG_HI_YUV(fmt, args...) IVTV_DEBUG_HIGH_VOL(IVTV_DBGFLG_YUV, "yuv", fmt , ## args)
169 /* Standard kernel messages */
170 #define IVTV_ERR(fmt, args...) printk(KERN_ERR "ivtv%d: " fmt, itv->num , ## args)
171 #define IVTV_WARN(fmt, args...) printk(KERN_WARNING "ivtv%d: " fmt, itv->num , ## args)
172 #define IVTV_INFO(fmt, args...) printk(KERN_INFO "ivtv%d: " fmt, itv->num , ## args)
174 /* output modes (cx23415 only) */
178 #define OUT_UDMA_YUV 3
179 #define OUT_PASSTHROUGH 4
181 #define IVTV_MAX_PGM_INDEX (400)
183 struct ivtv_options {
184 int kilobytes[IVTV_MAX_STREAMS]; /* size in kilobytes of each stream */
185 int cardtype; /* force card type on load */
186 int tuner; /* set tuner on load */
187 int radio; /* enable/disable radio */
188 int newi2c; /* new I2C algorithm */
191 /* ivtv-specific mailbox template */
192 struct ivtv_mailbox {
197 u32 data[CX2341X_MBOX_MAX_DATA];
200 struct ivtv_api_cache {
201 unsigned long last_jiffies; /* when last command was issued */
202 u32 data[CX2341X_MBOX_MAX_DATA]; /* last sent api data */
205 struct ivtv_mailbox_data {
206 volatile struct ivtv_mailbox __iomem *mbox;
207 /* Bits 0-2 are for the encoder mailboxes, 0-1 are for the decoder mailboxes.
208 If the bit is set, then the corresponding mailbox is in use by the driver. */
213 /* per-buffer bit flags */
214 #define IVTV_F_B_NEED_BUF_SWAP (1 << 0) /* this buffer should be byte swapped */
216 /* per-stream, s_flags */
217 #define IVTV_F_S_DMA_PENDING 0 /* this stream has pending DMA */
218 #define IVTV_F_S_DMA_HAS_VBI 1 /* the current DMA request also requests VBI data */
219 #define IVTV_F_S_NEEDS_DATA 2 /* this decoding stream needs more data */
221 #define IVTV_F_S_CLAIMED 3 /* this stream is claimed */
222 #define IVTV_F_S_STREAMING 4 /* the fw is decoding/encoding this stream */
223 #define IVTV_F_S_INTERNAL_USE 5 /* this stream is used internally (sliced VBI processing) */
224 #define IVTV_F_S_PASSTHROUGH 6 /* this stream is in passthrough mode */
225 #define IVTV_F_S_STREAMOFF 7 /* signal end of stream EOS */
226 #define IVTV_F_S_APPL_IO 8 /* this stream is used read/written by an application */
228 #define IVTV_F_S_PIO_PENDING 9 /* this stream has pending PIO */
229 #define IVTV_F_S_PIO_HAS_VBI 1 /* the current PIO request also requests VBI data */
231 /* per-ivtv, i_flags */
232 #define IVTV_F_I_DMA 0 /* DMA in progress */
233 #define IVTV_F_I_UDMA 1 /* UDMA in progress */
234 #define IVTV_F_I_UDMA_PENDING 2 /* UDMA pending */
235 #define IVTV_F_I_SPEED_CHANGE 3 /* a speed change is in progress */
236 #define IVTV_F_I_EOS 4 /* end of encoder stream reached */
237 #define IVTV_F_I_RADIO_USER 5 /* the radio tuner is selected */
238 #define IVTV_F_I_DIG_RST 6 /* reset digitizer */
239 #define IVTV_F_I_DEC_YUV 7 /* YUV instead of MPG is being decoded */
240 #define IVTV_F_I_UPDATE_CC 9 /* CC should be updated */
241 #define IVTV_F_I_UPDATE_WSS 10 /* WSS should be updated */
242 #define IVTV_F_I_UPDATE_VPS 11 /* VPS should be updated */
243 #define IVTV_F_I_DECODING_YUV 12 /* this stream is YUV frame decoding */
244 #define IVTV_F_I_ENC_PAUSED 13 /* the encoder is paused */
245 #define IVTV_F_I_VALID_DEC_TIMINGS 14 /* last_dec_timing is valid */
246 #define IVTV_F_I_HAVE_WORK 15 /* used in the interrupt handler: there is work to be done */
247 #define IVTV_F_I_WORK_HANDLER_VBI 16 /* there is work to be done for VBI */
248 #define IVTV_F_I_WORK_HANDLER_YUV 17 /* there is work to be done for YUV */
249 #define IVTV_F_I_WORK_HANDLER_PIO 18 /* there is work to be done for PIO */
250 #define IVTV_F_I_PIO 19 /* PIO in progress */
251 #define IVTV_F_I_DEC_PAUSED 20 /* the decoder is paused */
252 #define IVTV_F_I_INITED 21 /* set after first open */
253 #define IVTV_F_I_FAILED 22 /* set if first open failed */
254 #define IVTV_F_I_WORK_INITED 23 /* worker thread was initialized */
256 /* Event notifications */
257 #define IVTV_F_I_EV_DEC_STOPPED 28 /* decoder stopped event */
258 #define IVTV_F_I_EV_VSYNC 29 /* VSYNC event */
259 #define IVTV_F_I_EV_VSYNC_FIELD 30 /* VSYNC event field (0 = first, 1 = second field) */
260 #define IVTV_F_I_EV_VSYNC_ENABLED 31 /* VSYNC event enabled */
262 /* Scatter-Gather array element, used in DMA transfers */
263 struct ivtv_sg_element {
269 struct ivtv_sg_host_element {
275 struct ivtv_user_dma {
278 struct page *map[IVTV_DMA_SG_OSD_ENT];
279 /* Needed when dealing with highmem userspace buffers */
280 struct page *bouncemap[IVTV_DMA_SG_OSD_ENT];
282 /* Base Dev SG Array for cx23415/6 */
283 struct ivtv_sg_element SGarray[IVTV_DMA_SG_OSD_ENT];
284 dma_addr_t SG_handle;
287 /* SG List of Buffers */
288 struct scatterlist SGlist[IVTV_DMA_SG_OSD_ENT];
291 struct ivtv_dma_page_info {
301 struct list_head list;
302 dma_addr_t dma_handle;
303 unsigned short b_flags;
304 unsigned short dma_xfer_cnt;
311 struct list_head list; /* the list of buffers in this queue */
312 u32 buffers; /* number of buffers in this queue */
313 u32 length; /* total number of bytes of available buffer space */
314 u32 bytesused; /* total number of bytes used in this queue */
317 struct ivtv; /* forward reference */
320 /* These first four fields are always set, even if the stream
321 is not actually created. */
322 struct video_device *v4l2dev; /* NULL when stream not created */
323 struct ivtv *itv; /* for ease of use */
324 const char *name; /* name of the stream */
325 int type; /* stream type */
328 spinlock_t qlock; /* locks access to the queues */
329 unsigned long s_flags; /* status flags, see above */
330 int dma; /* can be PCI_DMA_TODEVICE, PCI_DMA_FROMDEVICE or PCI_DMA_NONE */
340 wait_queue_head_t waitq;
349 struct ivtv_queue q_free; /* free buffers */
350 struct ivtv_queue q_full; /* full buffers */
351 struct ivtv_queue q_io; /* waiting for I/O */
352 struct ivtv_queue q_dma; /* waiting for DMA */
353 struct ivtv_queue q_predma; /* waiting for DMA */
355 /* DMA xfer counter, buffers belonging to the same DMA
356 xfer will have the same dma_xfer_cnt. */
359 /* Base Dev SG Array for cx23415/6 */
360 struct ivtv_sg_host_element *sg_pending;
361 struct ivtv_sg_host_element *sg_processing;
362 struct ivtv_sg_element *sg_dma;
363 dma_addr_t sg_handle;
365 int sg_processing_size;
368 /* SG List of Buffers */
369 struct scatterlist *SGlist;
372 struct ivtv_open_id {
373 u32 open_id; /* unique ID for this file descriptor */
374 int type; /* stream type */
375 int yuv_frames; /* 1: started OUT_UDMA_YUV output mode */
376 enum v4l2_priority prio; /* priority */
380 struct yuv_frame_info
407 #define IVTV_YUV_MODE_INTERLACED 0x00
408 #define IVTV_YUV_MODE_PROGRESSIVE 0x01
409 #define IVTV_YUV_MODE_AUTO 0x02
410 #define IVTV_YUV_MODE_MASK 0x03
412 #define IVTV_YUV_SYNC_EVEN 0x00
413 #define IVTV_YUV_SYNC_ODD 0x04
414 #define IVTV_YUV_SYNC_MASK 0x04
416 #define IVTV_YUV_BUFFERS 8
418 struct yuv_playback_info
467 u8 track_osd; /* Should yuv output track the OSD size & position */
487 atomic_t next_dma_frame;
488 atomic_t next_fill_frame;
490 u32 yuv_forced_update;
493 u8 fields_lapsed; /* Counter used when delaying a frame */
495 struct yuv_frame_info new_frame_info[IVTV_YUV_BUFFERS];
496 struct yuv_frame_info old_frame_info;
497 struct yuv_frame_info old_frame_info_args;
500 dma_addr_t blanking_dmaptr;
504 u8 draw_frame; /* PVR350 buffer to draw into */
505 u8 max_frames_buffered; /* Maximum number of frames to buffer */
507 struct v4l2_rect main_rect;
512 #define IVTV_VBI_FRAMES 32
516 u8 odd[2]; /* two-byte payload of odd field */
517 u8 even[2]; /* two-byte payload of even field */;
521 u8 data[5]; /* five-byte VPS payload */
525 /* VBI general data, does not change during streaming */
527 u32 raw_decoder_line_size; /* raw VBI line size from digitizer */
528 u8 raw_decoder_sav_odd_field; /* raw VBI Start Active Video digitizer code of odd field */
529 u8 raw_decoder_sav_even_field; /* raw VBI Start Active Video digitizer code of even field */
530 u32 sliced_decoder_line_size; /* sliced VBI line size from digitizer */
531 u8 sliced_decoder_sav_odd_field; /* sliced VBI Start Active Video digitizer code of odd field */
532 u8 sliced_decoder_sav_even_field; /* sliced VBI Start Active Video digitizer code of even field */
534 u32 start[2]; /* start of first VBI line in the odd/even fields */
535 u32 count; /* number of VBI lines per field */
536 u32 raw_size; /* size of raw VBI line from the digitizer */
537 u32 sliced_size; /* size of sliced VBI line from the digitizer */
539 u32 dec_start; /* start in decoder memory of VBI re-insertion buffers */
540 u32 enc_start; /* start in encoder memory of VBI capture buffers */
541 u32 enc_size; /* size of VBI capture area */
542 int fpi; /* number of VBI frames per interrupt */
544 struct v4l2_format in; /* current VBI capture format */
545 struct v4l2_sliced_vbi_format *sliced_in; /* convenience pointer to sliced struct in vbi.in union */
546 int insert_mpeg; /* if non-zero, then embed VBI data in MPEG stream */
548 /* Raw VBI compatibility hack */
550 u32 frame; /* frame counter hack needed for backwards compatibility
551 of old VBI software */
553 /* Sliced VBI output data */
555 struct vbi_cc cc_payload[256]; /* sliced VBI CC payload array: it is an array to
556 prevent dropping CC data if they couldn't be
557 processed fast enough */
558 int cc_payload_idx; /* index in cc_payload */
559 u8 cc_missing_cnt; /* counts number of frames without CC for passthrough mode */
560 int wss_payload; /* sliced VBI WSS payload */
561 u8 wss_missing_cnt; /* counts number of frames without WSS for passthrough mode */
562 struct vbi_vps vps_payload; /* sliced VBI VPS payload */
564 /* Sliced VBI capture data */
566 struct v4l2_sliced_vbi_data sliced_data[36]; /* sliced VBI storage for VBI encoder stream */
567 struct v4l2_sliced_vbi_data sliced_dec_data[36];/* sliced VBI storage for VBI decoder stream */
569 /* VBI Embedding data */
571 /* Buffer for VBI data inserted into MPEG stream.
572 The first byte is a dummy byte that's never used.
573 The next 16 bytes contain the MPEG header for the VBI data,
574 the remainder is the actual VBI data.
575 The max size accepted by the MPEG VBI reinsertion turns out
576 to be 1552 bytes, which happens to be 4 + (1 + 42) * (2 * 18) bytes,
577 where 4 is a four byte header, 42 is the max sliced VBI payload, 1 is
578 a single line header byte and 2 * 18 is the number of VBI lines per frame.
580 However, it seems that the data must be 1K aligned, so we have to
581 pad the data until the 1 or 2 K boundary.
583 This pointer array will allocate 2049 bytes to store each VBI frame. */
584 u8 *sliced_mpeg_data[IVTV_VBI_FRAMES];
585 u32 sliced_mpeg_size[IVTV_VBI_FRAMES];
586 struct ivtv_buffer sliced_mpeg_buf; /* temporary buffer holding data from sliced_mpeg_data */
587 u32 inserted_frame; /* index in sliced_mpeg_size of next sliced data
588 to be inserted in the MPEG stream */
591 /* forward declaration of struct defined in ivtv-cards.h */
594 /* Struct to hold info about ivtv cards */
596 /* General fixed card data */
597 int num; /* board number, -1 during init! */
598 char name[8]; /* board name for printk and interrupts (e.g. 'ivtv0') */
599 struct pci_dev *dev; /* PCI device */
600 const struct ivtv_card *card; /* card information */
601 const char *card_name; /* full name of the card */
602 const struct ivtv_card_tuner_i2c *card_i2c; /* i2c addresses to probe for tuner */
603 u8 has_cx23415; /* 1 if it is a cx23415 based card, 0 for cx23416 */
604 u8 pvr150_workaround; /* 1 if the cx25840 needs to workaround a PVR150 bug */
605 u8 nof_inputs; /* number of video inputs */
606 u8 nof_audio_inputs; /* number of audio inputs */
607 u32 v4l2_cap; /* V4L2 capabilities of card */
608 u32 hw_flags; /* hardware description of the board */
609 v4l2_std_id tuner_std; /* the norm of the card's tuner (fixed) */
610 /* controlling video decoder function */
611 int (*video_dec_func)(struct ivtv *, unsigned int, void *);
612 u32 base_addr; /* PCI resource base address */
613 volatile void __iomem *enc_mem; /* pointer to mapped encoder memory */
614 volatile void __iomem *dec_mem; /* pointer to mapped decoder memory */
615 volatile void __iomem *reg_mem; /* pointer to mapped registers */
616 struct ivtv_options options; /* user options */
619 /* High-level state info */
620 unsigned long i_flags; /* global ivtv flags */
621 u8 is_50hz; /* 1 if the current capture standard is 50 Hz */
622 u8 is_60hz /* 1 if the current capture standard is 60 Hz */;
623 u8 is_out_50hz /* 1 if the current TV output standard is 50 Hz */;
624 u8 is_out_60hz /* 1 if the current TV output standard is 60 Hz */;
625 int output_mode; /* decoder output mode: NONE, MPG, YUV, UDMA YUV, passthrough */
626 u32 audio_input; /* current audio input */
627 u32 active_input; /* current video input */
628 u32 active_output; /* current video output */
629 v4l2_std_id std; /* current capture TV standard */
630 v4l2_std_id std_out; /* current TV output standard */
631 u8 audio_stereo_mode; /* decoder setting how to handle stereo MPEG audio */
632 u8 audio_bilingual_mode; /* decoder setting how to handle bilingual MPEG audio */
633 struct cx2341x_mpeg_params params; /* current encoder parameters */
637 spinlock_t lock; /* lock access to this struct */
638 struct mutex serialize_lock; /* mutex used to serialize open/close/start/stop/ioctl operations */
641 int stream_buf_size[IVTV_MAX_STREAMS]; /* stream buffer size */
642 struct ivtv_stream streams[IVTV_MAX_STREAMS]; /* stream data */
643 atomic_t capturing; /* count number of active capture streams */
644 atomic_t decoding; /* count number of active decoding streams */
647 /* Interrupts & DMA */
648 u32 irqmask; /* active interrupts */
649 u32 irq_rr_idx; /* round-robin stream index */
650 struct workqueue_struct *irq_work_queues; /* workqueue for PIO/YUV/VBI actions */
651 struct work_struct irq_work_queue; /* work entry */
652 spinlock_t dma_reg_lock; /* lock access to DMA engine registers */
653 int cur_dma_stream; /* index of current stream doing DMA (-1 if none) */
654 int cur_pio_stream; /* index of current stream doing PIO (-1 if none) */
655 u32 dma_data_req_offset; /* store offset in decoder memory of current DMA request */
656 u32 dma_data_req_size; /* store size of current DMA request */
657 int dma_retries; /* current DMA retry attempt */
658 struct ivtv_user_dma udma; /* user based DMA for OSD */
659 struct timer_list dma_timer; /* timer used to catch unfinished DMAs */
660 u32 last_vsync_field; /* last seen vsync field */
661 wait_queue_head_t dma_waitq; /* wake up when the current DMA is finished */
662 wait_queue_head_t eos_waitq; /* wake up when EOS arrives */
663 wait_queue_head_t event_waitq; /* wake up when the next decoder event arrives */
664 wait_queue_head_t vsync_waitq; /* wake up when the next decoder vsync arrives */
668 struct ivtv_mailbox_data enc_mbox; /* encoder mailboxes */
669 struct ivtv_mailbox_data dec_mbox; /* decoder mailboxes */
670 struct ivtv_api_cache api_cache[256]; /* cached API commands */
674 struct i2c_adapter i2c_adap;
675 struct i2c_algo_bit_data i2c_algo;
676 struct i2c_client i2c_client;
677 struct i2c_client *i2c_clients[I2C_CLIENTS_MAX];/* pointers to all I2C clients */
678 int i2c_state; /* i2c bit state */
679 struct mutex i2c_bus_lock; /* lock i2c bus */
682 /* Program Index information */
683 u32 pgm_info_offset; /* start of pgm info in encoder memory */
684 u32 pgm_info_num; /* number of elements in the pgm cyclic buffer in encoder memory */
685 u32 pgm_info_write_idx; /* last index written by the card that was transferred to pgm_info[] */
686 u32 pgm_info_read_idx; /* last index in pgm_info read by the application */
687 struct v4l2_enc_idx_entry pgm_info[IVTV_MAX_PGM_INDEX]; /* filled from the pgm cyclic buffer on the card */
691 u32 open_id; /* incremented each time an open occurs, is >= 1 */
692 struct v4l2_prio_state prio; /* priority state */
693 int search_pack_header; /* 1 if ivtv_copy_buf_to_user() is scanning for a pack header (0xba) */
694 int speed; /* current playback speed setting */
695 u8 speed_mute_audio; /* 1 if audio should be muted when fast forward */
696 u64 mpg_data_received; /* number of bytes received from the MPEG stream */
697 u64 vbi_data_inserted; /* number of VBI bytes inserted into the MPEG stream */
698 u32 last_dec_timing[3]; /* cache last retrieved pts/scr/frame values */
699 unsigned long dualwatch_jiffies;/* jiffies value of the previous dualwatch check */
700 u16 dualwatch_stereo_mode; /* current detected dualwatch stereo mode */
704 struct vbi_info vbi; /* VBI-specific data */
708 struct yuv_playback_info yuv_info; /* YUV playback data */
712 unsigned long osd_video_pbase;
713 int osd_global_alpha_state; /* 1 = global alpha is on */
714 int osd_local_alpha_state; /* 1 = local alpha is on */
715 int osd_chroma_key_state; /* 1 = chroma-keying is on */
716 u8 osd_global_alpha; /* current global alpha */
717 u32 osd_chroma_key; /* current chroma key */
718 struct v4l2_rect osd_rect; /* current OSD position and size */
719 struct v4l2_rect main_rect; /* current Main window position and size */
720 struct osd_info *osd_info; /* ivtvfb private OSD info */
724 extern struct ivtv *ivtv_cards[];
725 extern int ivtv_cards_active;
726 extern int ivtv_first_minor;
727 extern spinlock_t ivtv_cards_lock;
729 /*==============Prototypes==================*/
732 void ivtv_set_irq_mask(struct ivtv *itv, u32 mask);
733 void ivtv_clear_irq_mask(struct ivtv *itv, u32 mask);
735 /* try to set output mode, return current mode. */
736 int ivtv_set_output_mode(struct ivtv *itv, int mode);
738 /* return current output stream based on current mode */
739 struct ivtv_stream *ivtv_get_output_stream(struct ivtv *itv);
741 /* Return non-zero if a signal is pending */
742 int ivtv_msleep_timeout(unsigned int msecs, int intr);
744 /* Wait on queue, returns -EINTR if interrupted */
745 int ivtv_waitq(wait_queue_head_t *waitq);
747 /* Read Hauppauge eeprom */
748 struct tveeprom; /* forward reference */
749 void ivtv_read_eeprom(struct ivtv *itv, struct tveeprom *tv);
751 /* First-open initialization: load firmware, init cx25840, etc. */
752 int ivtv_init_on_first_open(struct ivtv *itv);
754 /* This is a PCI post thing, where if the pci register is not read, then
755 the write doesn't always take effect right away. By reading back the
756 register any pending PCI writes will be performed (in order), and so
757 you can be sure that the writes are guaranteed to be done.
759 Rarely needed, only in some timing sensitive cases.
760 Apparently if this is not done some motherboards seem
761 to kill the firmware and get into the broken state until computer is
763 #define write_sync(val, reg) \
764 do { writel(val, reg); readl(reg); } while (0)
766 #define read_reg(reg) readl(itv->reg_mem + (reg))
767 #define write_reg(val, reg) writel(val, itv->reg_mem + (reg))
768 #define write_reg_sync(val, reg) \
769 do { write_reg(val, reg); read_reg(reg); } while (0)
771 #define read_enc(addr) readl(itv->enc_mem + (u32)(addr))
772 #define write_enc(val, addr) writel(val, itv->enc_mem + (u32)(addr))
773 #define write_enc_sync(val, addr) \
774 do { write_enc(val, addr); read_enc(addr); } while (0)
776 #define read_dec(addr) readl(itv->dec_mem + (u32)(addr))
777 #define write_dec(val, addr) writel(val, itv->dec_mem + (u32)(addr))
778 #define write_dec_sync(val, addr) \
779 do { write_dec(val, addr); read_dec(addr); } while (0)