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/pagemap.h>
53 #include <linux/scatterlist.h>
54 #include <linux/workqueue.h>
55 #include <linux/mutex.h>
56 #include <linux/slab.h>
57 #include <asm/uaccess.h>
58 #include <asm/system.h>
59 #include <asm/byteorder.h>
61 #include <linux/dvb/video.h>
62 #include <linux/dvb/audio.h>
63 #include <media/v4l2-common.h>
64 #include <media/v4l2-ioctl.h>
65 #include <media/v4l2-device.h>
66 #include <media/v4l2-fh.h>
67 #include <media/tuner.h>
68 #include <media/cx2341x.h>
69 #include <media/ir-kbd-i2c.h>
71 #include <linux/ivtv.h>
74 #define IVTV_ENCODER_OFFSET 0x00000000
75 #define IVTV_ENCODER_SIZE 0x00800000 /* Total size is 0x01000000, but only first half is used */
76 #define IVTV_DECODER_OFFSET 0x01000000
77 #define IVTV_DECODER_SIZE 0x00800000 /* Total size is 0x01000000, but only first half is used */
78 #define IVTV_REG_OFFSET 0x02000000
79 #define IVTV_REG_SIZE 0x00010000
81 /* Maximum ivtv driver instances. Some people have a huge number of
82 capture cards, so set this to a high value. */
83 #define IVTV_MAX_CARDS 32
85 #define IVTV_ENC_STREAM_TYPE_MPG 0
86 #define IVTV_ENC_STREAM_TYPE_YUV 1
87 #define IVTV_ENC_STREAM_TYPE_VBI 2
88 #define IVTV_ENC_STREAM_TYPE_PCM 3
89 #define IVTV_ENC_STREAM_TYPE_RAD 4
90 #define IVTV_DEC_STREAM_TYPE_MPG 5
91 #define IVTV_DEC_STREAM_TYPE_VBI 6
92 #define IVTV_DEC_STREAM_TYPE_VOUT 7
93 #define IVTV_DEC_STREAM_TYPE_YUV 8
94 #define IVTV_MAX_STREAMS 9
96 #define IVTV_DMA_SG_OSD_ENT (2883584/PAGE_SIZE) /* sg entities */
99 #define IVTV_REG_DMAXFER (0x0000)
100 #define IVTV_REG_DMASTATUS (0x0004)
101 #define IVTV_REG_DECDMAADDR (0x0008)
102 #define IVTV_REG_ENCDMAADDR (0x000c)
103 #define IVTV_REG_DMACONTROL (0x0010)
104 #define IVTV_REG_IRQSTATUS (0x0040)
105 #define IVTV_REG_IRQMASK (0x0048)
107 /* Setup Registers */
108 #define IVTV_REG_ENC_SDRAM_REFRESH (0x07F8)
109 #define IVTV_REG_ENC_SDRAM_PRECHARGE (0x07FC)
110 #define IVTV_REG_DEC_SDRAM_REFRESH (0x08F8)
111 #define IVTV_REG_DEC_SDRAM_PRECHARGE (0x08FC)
112 #define IVTV_REG_VDM (0x2800)
113 #define IVTV_REG_AO (0x2D00)
114 #define IVTV_REG_BYTEFLUSH (0x2D24)
115 #define IVTV_REG_SPU (0x9050)
116 #define IVTV_REG_HW_BLOCKS (0x9054)
117 #define IVTV_REG_VPU (0x9058)
118 #define IVTV_REG_APU (0xA064)
120 /* Other registers */
121 #define IVTV_REG_DEC_LINE_FIELD (0x28C0)
124 extern int ivtv_debug;
126 #define IVTV_DBGFLG_WARN (1 << 0)
127 #define IVTV_DBGFLG_INFO (1 << 1)
128 #define IVTV_DBGFLG_MB (1 << 2)
129 #define IVTV_DBGFLG_IOCTL (1 << 3)
130 #define IVTV_DBGFLG_FILE (1 << 4)
131 #define IVTV_DBGFLG_DMA (1 << 5)
132 #define IVTV_DBGFLG_IRQ (1 << 6)
133 #define IVTV_DBGFLG_DEC (1 << 7)
134 #define IVTV_DBGFLG_YUV (1 << 8)
135 #define IVTV_DBGFLG_I2C (1 << 9)
136 /* Flag to turn on high volume debugging */
137 #define IVTV_DBGFLG_HIGHVOL (1 << 10)
139 #define IVTV_DEBUG(x, type, fmt, args...) \
141 if ((x) & ivtv_debug) \
142 v4l2_info(&itv->v4l2_dev, " " type ": " fmt , ##args); \
144 #define IVTV_DEBUG_WARN(fmt, args...) IVTV_DEBUG(IVTV_DBGFLG_WARN, "warn", fmt , ## args)
145 #define IVTV_DEBUG_INFO(fmt, args...) IVTV_DEBUG(IVTV_DBGFLG_INFO, "info", fmt , ## args)
146 #define IVTV_DEBUG_MB(fmt, args...) IVTV_DEBUG(IVTV_DBGFLG_MB, "mb", fmt , ## args)
147 #define IVTV_DEBUG_DMA(fmt, args...) IVTV_DEBUG(IVTV_DBGFLG_DMA, "dma", fmt , ## args)
148 #define IVTV_DEBUG_IOCTL(fmt, args...) IVTV_DEBUG(IVTV_DBGFLG_IOCTL, "ioctl", fmt , ## args)
149 #define IVTV_DEBUG_FILE(fmt, args...) IVTV_DEBUG(IVTV_DBGFLG_FILE, "file", fmt , ## args)
150 #define IVTV_DEBUG_I2C(fmt, args...) IVTV_DEBUG(IVTV_DBGFLG_I2C, "i2c", fmt , ## args)
151 #define IVTV_DEBUG_IRQ(fmt, args...) IVTV_DEBUG(IVTV_DBGFLG_IRQ, "irq", fmt , ## args)
152 #define IVTV_DEBUG_DEC(fmt, args...) IVTV_DEBUG(IVTV_DBGFLG_DEC, "dec", fmt , ## args)
153 #define IVTV_DEBUG_YUV(fmt, args...) IVTV_DEBUG(IVTV_DBGFLG_YUV, "yuv", fmt , ## args)
155 #define IVTV_DEBUG_HIGH_VOL(x, type, fmt, args...) \
157 if (((x) & ivtv_debug) && (ivtv_debug & IVTV_DBGFLG_HIGHVOL)) \
158 v4l2_info(&itv->v4l2_dev, " " type ": " fmt , ##args); \
160 #define IVTV_DEBUG_HI_WARN(fmt, args...) IVTV_DEBUG_HIGH_VOL(IVTV_DBGFLG_WARN, "warn", fmt , ## args)
161 #define IVTV_DEBUG_HI_INFO(fmt, args...) IVTV_DEBUG_HIGH_VOL(IVTV_DBGFLG_INFO, "info", fmt , ## args)
162 #define IVTV_DEBUG_HI_MB(fmt, args...) IVTV_DEBUG_HIGH_VOL(IVTV_DBGFLG_MB, "mb", fmt , ## args)
163 #define IVTV_DEBUG_HI_DMA(fmt, args...) IVTV_DEBUG_HIGH_VOL(IVTV_DBGFLG_DMA, "dma", fmt , ## args)
164 #define IVTV_DEBUG_HI_IOCTL(fmt, args...) IVTV_DEBUG_HIGH_VOL(IVTV_DBGFLG_IOCTL, "ioctl", fmt , ## args)
165 #define IVTV_DEBUG_HI_FILE(fmt, args...) IVTV_DEBUG_HIGH_VOL(IVTV_DBGFLG_FILE, "file", fmt , ## args)
166 #define IVTV_DEBUG_HI_I2C(fmt, args...) IVTV_DEBUG_HIGH_VOL(IVTV_DBGFLG_I2C, "i2c", fmt , ## args)
167 #define IVTV_DEBUG_HI_IRQ(fmt, args...) IVTV_DEBUG_HIGH_VOL(IVTV_DBGFLG_IRQ, "irq", fmt , ## args)
168 #define IVTV_DEBUG_HI_DEC(fmt, args...) IVTV_DEBUG_HIGH_VOL(IVTV_DBGFLG_DEC, "dec", fmt , ## args)
169 #define IVTV_DEBUG_HI_YUV(fmt, args...) IVTV_DEBUG_HIGH_VOL(IVTV_DBGFLG_YUV, "yuv", fmt , ## args)
171 /* Standard kernel messages */
172 #define IVTV_ERR(fmt, args...) v4l2_err(&itv->v4l2_dev, fmt , ## args)
173 #define IVTV_WARN(fmt, args...) v4l2_warn(&itv->v4l2_dev, fmt , ## args)
174 #define IVTV_INFO(fmt, args...) v4l2_info(&itv->v4l2_dev, fmt , ## args)
176 /* output modes (cx23415 only) */
180 #define OUT_UDMA_YUV 3
181 #define OUT_PASSTHROUGH 4
183 #define IVTV_MAX_PGM_INDEX (400)
185 /* Default I2C SCL period in microseconds */
186 #define IVTV_DEFAULT_I2C_CLOCK_PERIOD 20
188 struct ivtv_options {
189 int kilobytes[IVTV_MAX_STREAMS]; /* size in kilobytes of each stream */
190 int cardtype; /* force card type on load */
191 int tuner; /* set tuner on load */
192 int radio; /* enable/disable radio */
193 int newi2c; /* new I2C algorithm */
194 int i2c_clock_period; /* period of SCL for I2C bus */
197 /* ivtv-specific mailbox template */
198 struct ivtv_mailbox {
203 u32 data[CX2341X_MBOX_MAX_DATA];
206 struct ivtv_api_cache {
207 unsigned long last_jiffies; /* when last command was issued */
208 u32 data[CX2341X_MBOX_MAX_DATA]; /* last sent api data */
211 struct ivtv_mailbox_data {
212 volatile struct ivtv_mailbox __iomem *mbox;
213 /* Bits 0-2 are for the encoder mailboxes, 0-1 are for the decoder mailboxes.
214 If the bit is set, then the corresponding mailbox is in use by the driver. */
219 /* per-buffer bit flags */
220 #define IVTV_F_B_NEED_BUF_SWAP (1 << 0) /* this buffer should be byte swapped */
222 /* per-stream, s_flags */
223 #define IVTV_F_S_DMA_PENDING 0 /* this stream has pending DMA */
224 #define IVTV_F_S_DMA_HAS_VBI 1 /* the current DMA request also requests VBI data */
225 #define IVTV_F_S_NEEDS_DATA 2 /* this decoding stream needs more data */
227 #define IVTV_F_S_CLAIMED 3 /* this stream is claimed */
228 #define IVTV_F_S_STREAMING 4 /* the fw is decoding/encoding this stream */
229 #define IVTV_F_S_INTERNAL_USE 5 /* this stream is used internally (sliced VBI processing) */
230 #define IVTV_F_S_PASSTHROUGH 6 /* this stream is in passthrough mode */
231 #define IVTV_F_S_STREAMOFF 7 /* signal end of stream EOS */
232 #define IVTV_F_S_APPL_IO 8 /* this stream is used read/written by an application */
234 #define IVTV_F_S_PIO_PENDING 9 /* this stream has pending PIO */
235 #define IVTV_F_S_PIO_HAS_VBI 1 /* the current PIO request also requests VBI data */
237 /* per-ivtv, i_flags */
238 #define IVTV_F_I_DMA 0 /* DMA in progress */
239 #define IVTV_F_I_UDMA 1 /* UDMA in progress */
240 #define IVTV_F_I_UDMA_PENDING 2 /* UDMA pending */
241 #define IVTV_F_I_SPEED_CHANGE 3 /* a speed change is in progress */
242 #define IVTV_F_I_EOS 4 /* end of encoder stream reached */
243 #define IVTV_F_I_RADIO_USER 5 /* the radio tuner is selected */
244 #define IVTV_F_I_DIG_RST 6 /* reset digitizer */
245 #define IVTV_F_I_DEC_YUV 7 /* YUV instead of MPG is being decoded */
246 #define IVTV_F_I_UPDATE_CC 9 /* CC should be updated */
247 #define IVTV_F_I_UPDATE_WSS 10 /* WSS should be updated */
248 #define IVTV_F_I_UPDATE_VPS 11 /* VPS should be updated */
249 #define IVTV_F_I_DECODING_YUV 12 /* this stream is YUV frame decoding */
250 #define IVTV_F_I_ENC_PAUSED 13 /* the encoder is paused */
251 #define IVTV_F_I_VALID_DEC_TIMINGS 14 /* last_dec_timing is valid */
252 #define IVTV_F_I_HAVE_WORK 15 /* used in the interrupt handler: there is work to be done */
253 #define IVTV_F_I_WORK_HANDLER_VBI 16 /* there is work to be done for VBI */
254 #define IVTV_F_I_WORK_HANDLER_YUV 17 /* there is work to be done for YUV */
255 #define IVTV_F_I_WORK_HANDLER_PIO 18 /* there is work to be done for PIO */
256 #define IVTV_F_I_PIO 19 /* PIO in progress */
257 #define IVTV_F_I_DEC_PAUSED 20 /* the decoder is paused */
258 #define IVTV_F_I_INITED 21 /* set after first open */
259 #define IVTV_F_I_FAILED 22 /* set if first open failed */
260 #define IVTV_F_I_WORK_INITED 23 /* worker thread was initialized */
262 /* Event notifications */
263 #define IVTV_F_I_EV_DEC_STOPPED 28 /* decoder stopped event */
264 #define IVTV_F_I_EV_VSYNC 29 /* VSYNC event */
265 #define IVTV_F_I_EV_VSYNC_FIELD 30 /* VSYNC event field (0 = first, 1 = second field) */
266 #define IVTV_F_I_EV_VSYNC_ENABLED 31 /* VSYNC event enabled */
268 /* Scatter-Gather array element, used in DMA transfers */
269 struct ivtv_sg_element {
275 struct ivtv_sg_host_element {
281 struct ivtv_user_dma {
284 struct page *map[IVTV_DMA_SG_OSD_ENT];
285 /* Needed when dealing with highmem userspace buffers */
286 struct page *bouncemap[IVTV_DMA_SG_OSD_ENT];
288 /* Base Dev SG Array for cx23415/6 */
289 struct ivtv_sg_element SGarray[IVTV_DMA_SG_OSD_ENT];
290 dma_addr_t SG_handle;
293 /* SG List of Buffers */
294 struct scatterlist SGlist[IVTV_DMA_SG_OSD_ENT];
297 struct ivtv_dma_page_info {
307 struct list_head list;
308 dma_addr_t dma_handle;
309 unsigned short b_flags;
310 unsigned short dma_xfer_cnt;
317 struct list_head list; /* the list of buffers in this queue */
318 u32 buffers; /* number of buffers in this queue */
319 u32 length; /* total number of bytes of available buffer space */
320 u32 bytesused; /* total number of bytes used in this queue */
323 struct ivtv; /* forward reference */
326 /* These first four fields are always set, even if the stream
327 is not actually created. */
328 struct video_device *vdev; /* NULL when stream not created */
329 struct ivtv *itv; /* for ease of use */
330 const char *name; /* name of the stream */
331 int type; /* stream type */
334 spinlock_t qlock; /* locks access to the queues */
335 unsigned long s_flags; /* status flags, see above */
336 int dma; /* can be PCI_DMA_TODEVICE, PCI_DMA_FROMDEVICE or PCI_DMA_NONE */
346 wait_queue_head_t waitq;
355 struct ivtv_queue q_free; /* free buffers */
356 struct ivtv_queue q_full; /* full buffers */
357 struct ivtv_queue q_io; /* waiting for I/O */
358 struct ivtv_queue q_dma; /* waiting for DMA */
359 struct ivtv_queue q_predma; /* waiting for DMA */
361 /* DMA xfer counter, buffers belonging to the same DMA
362 xfer will have the same dma_xfer_cnt. */
365 /* Base Dev SG Array for cx23415/6 */
366 struct ivtv_sg_host_element *sg_pending;
367 struct ivtv_sg_host_element *sg_processing;
368 struct ivtv_sg_element *sg_dma;
369 dma_addr_t sg_handle;
371 int sg_processing_size;
374 /* SG List of Buffers */
375 struct scatterlist *SGlist;
378 struct ivtv_open_id {
380 u32 open_id; /* unique ID for this file descriptor */
381 int type; /* stream type */
382 int yuv_frames; /* 1: started OUT_UDMA_YUV output mode */
383 enum v4l2_priority prio; /* priority */
387 static inline struct ivtv_open_id *fh2id(struct v4l2_fh *fh)
389 return container_of(fh, struct ivtv_open_id, fh);
392 struct yuv_frame_info
419 #define IVTV_YUV_MODE_INTERLACED 0x00
420 #define IVTV_YUV_MODE_PROGRESSIVE 0x01
421 #define IVTV_YUV_MODE_AUTO 0x02
422 #define IVTV_YUV_MODE_MASK 0x03
424 #define IVTV_YUV_SYNC_EVEN 0x00
425 #define IVTV_YUV_SYNC_ODD 0x04
426 #define IVTV_YUV_SYNC_MASK 0x04
428 #define IVTV_YUV_BUFFERS 8
430 struct yuv_playback_info
479 u8 track_osd; /* Should yuv output track the OSD size & position */
499 atomic_t next_dma_frame;
500 atomic_t next_fill_frame;
502 u32 yuv_forced_update;
505 u8 fields_lapsed; /* Counter used when delaying a frame */
507 struct yuv_frame_info new_frame_info[IVTV_YUV_BUFFERS];
508 struct yuv_frame_info old_frame_info;
509 struct yuv_frame_info old_frame_info_args;
512 dma_addr_t blanking_dmaptr;
516 u8 draw_frame; /* PVR350 buffer to draw into */
517 u8 max_frames_buffered; /* Maximum number of frames to buffer */
519 struct v4l2_rect main_rect;
523 u8 running; /* Have any frames been displayed */
526 #define IVTV_VBI_FRAMES 32
530 u8 odd[2]; /* two-byte payload of odd field */
531 u8 even[2]; /* two-byte payload of even field */;
535 u8 data[5]; /* five-byte VPS payload */
539 /* VBI general data, does not change during streaming */
541 u32 raw_decoder_line_size; /* raw VBI line size from digitizer */
542 u8 raw_decoder_sav_odd_field; /* raw VBI Start Active Video digitizer code of odd field */
543 u8 raw_decoder_sav_even_field; /* raw VBI Start Active Video digitizer code of even field */
544 u32 sliced_decoder_line_size; /* sliced VBI line size from digitizer */
545 u8 sliced_decoder_sav_odd_field; /* sliced VBI Start Active Video digitizer code of odd field */
546 u8 sliced_decoder_sav_even_field; /* sliced VBI Start Active Video digitizer code of even field */
548 u32 start[2]; /* start of first VBI line in the odd/even fields */
549 u32 count; /* number of VBI lines per field */
550 u32 raw_size; /* size of raw VBI line from the digitizer */
551 u32 sliced_size; /* size of sliced VBI line from the digitizer */
553 u32 dec_start; /* start in decoder memory of VBI re-insertion buffers */
554 u32 enc_start; /* start in encoder memory of VBI capture buffers */
555 u32 enc_size; /* size of VBI capture area */
556 int fpi; /* number of VBI frames per interrupt */
558 struct v4l2_format in; /* current VBI capture format */
559 struct v4l2_sliced_vbi_format *sliced_in; /* convenience pointer to sliced struct in vbi.in union */
560 int insert_mpeg; /* if non-zero, then embed VBI data in MPEG stream */
562 /* Raw VBI compatibility hack */
564 u32 frame; /* frame counter hack needed for backwards compatibility
565 of old VBI software */
567 /* Sliced VBI output data */
569 struct vbi_cc cc_payload[256]; /* sliced VBI CC payload array: it is an array to
570 prevent dropping CC data if they couldn't be
571 processed fast enough */
572 int cc_payload_idx; /* index in cc_payload */
573 u8 cc_missing_cnt; /* counts number of frames without CC for passthrough mode */
574 int wss_payload; /* sliced VBI WSS payload */
575 u8 wss_missing_cnt; /* counts number of frames without WSS for passthrough mode */
576 struct vbi_vps vps_payload; /* sliced VBI VPS payload */
578 /* Sliced VBI capture data */
580 struct v4l2_sliced_vbi_data sliced_data[36]; /* sliced VBI storage for VBI encoder stream */
581 struct v4l2_sliced_vbi_data sliced_dec_data[36];/* sliced VBI storage for VBI decoder stream */
583 /* VBI Embedding data */
585 /* Buffer for VBI data inserted into MPEG stream.
586 The first byte is a dummy byte that's never used.
587 The next 16 bytes contain the MPEG header for the VBI data,
588 the remainder is the actual VBI data.
589 The max size accepted by the MPEG VBI reinsertion turns out
590 to be 1552 bytes, which happens to be 4 + (1 + 42) * (2 * 18) bytes,
591 where 4 is a four byte header, 42 is the max sliced VBI payload, 1 is
592 a single line header byte and 2 * 18 is the number of VBI lines per frame.
594 However, it seems that the data must be 1K aligned, so we have to
595 pad the data until the 1 or 2 K boundary.
597 This pointer array will allocate 2049 bytes to store each VBI frame. */
598 u8 *sliced_mpeg_data[IVTV_VBI_FRAMES];
599 u32 sliced_mpeg_size[IVTV_VBI_FRAMES];
600 struct ivtv_buffer sliced_mpeg_buf; /* temporary buffer holding data from sliced_mpeg_data */
601 u32 inserted_frame; /* index in sliced_mpeg_size of next sliced data
602 to be inserted in the MPEG stream */
605 /* forward declaration of struct defined in ivtv-cards.h */
608 /* Struct to hold info about ivtv cards */
610 /* General fixed card data */
611 struct pci_dev *pdev; /* PCI device */
612 const struct ivtv_card *card; /* card information */
613 const char *card_name; /* full name of the card */
614 const struct ivtv_card_tuner_i2c *card_i2c; /* i2c addresses to probe for tuner */
615 u8 has_cx23415; /* 1 if it is a cx23415 based card, 0 for cx23416 */
616 u8 pvr150_workaround; /* 1 if the cx25840 needs to workaround a PVR150 bug */
617 u8 nof_inputs; /* number of video inputs */
618 u8 nof_audio_inputs; /* number of audio inputs */
619 u32 v4l2_cap; /* V4L2 capabilities of card */
620 u32 hw_flags; /* hardware description of the board */
621 v4l2_std_id tuner_std; /* the norm of the card's tuner (fixed) */
622 struct v4l2_subdev *sd_video; /* controlling video decoder subdev */
623 struct v4l2_subdev *sd_audio; /* controlling audio subdev */
624 struct v4l2_subdev *sd_muxer; /* controlling audio muxer subdev */
625 u32 base_addr; /* PCI resource base address */
626 volatile void __iomem *enc_mem; /* pointer to mapped encoder memory */
627 volatile void __iomem *dec_mem; /* pointer to mapped decoder memory */
628 volatile void __iomem *reg_mem; /* pointer to mapped registers */
629 struct ivtv_options options; /* user options */
631 struct v4l2_device v4l2_dev;
632 struct v4l2_subdev sd_gpio; /* GPIO sub-device */
635 /* High-level state info */
636 unsigned long i_flags; /* global ivtv flags */
637 u8 is_50hz; /* 1 if the current capture standard is 50 Hz */
638 u8 is_60hz /* 1 if the current capture standard is 60 Hz */;
639 u8 is_out_50hz /* 1 if the current TV output standard is 50 Hz */;
640 u8 is_out_60hz /* 1 if the current TV output standard is 60 Hz */;
641 int output_mode; /* decoder output mode: NONE, MPG, YUV, UDMA YUV, passthrough */
642 u32 audio_input; /* current audio input */
643 u32 active_input; /* current video input */
644 u32 active_output; /* current video output */
645 v4l2_std_id std; /* current capture TV standard */
646 v4l2_std_id std_out; /* current TV output standard */
647 u8 audio_stereo_mode; /* decoder setting how to handle stereo MPEG audio */
648 u8 audio_bilingual_mode; /* decoder setting how to handle bilingual MPEG audio */
649 struct cx2341x_mpeg_params params; /* current encoder parameters */
653 spinlock_t lock; /* lock access to this struct */
654 struct mutex serialize_lock; /* mutex used to serialize open/close/start/stop/ioctl operations */
657 int stream_buf_size[IVTV_MAX_STREAMS]; /* stream buffer size */
658 struct ivtv_stream streams[IVTV_MAX_STREAMS]; /* stream data */
659 atomic_t capturing; /* count number of active capture streams */
660 atomic_t decoding; /* count number of active decoding streams */
663 /* Interrupts & DMA */
664 u32 irqmask; /* active interrupts */
665 u32 irq_rr_idx; /* round-robin stream index */
666 struct workqueue_struct *irq_work_queues; /* workqueue for PIO/YUV/VBI actions */
667 struct work_struct irq_work_queue; /* work entry */
668 spinlock_t dma_reg_lock; /* lock access to DMA engine registers */
669 int cur_dma_stream; /* index of current stream doing DMA (-1 if none) */
670 int cur_pio_stream; /* index of current stream doing PIO (-1 if none) */
671 u32 dma_data_req_offset; /* store offset in decoder memory of current DMA request */
672 u32 dma_data_req_size; /* store size of current DMA request */
673 int dma_retries; /* current DMA retry attempt */
674 struct ivtv_user_dma udma; /* user based DMA for OSD */
675 struct timer_list dma_timer; /* timer used to catch unfinished DMAs */
676 u32 last_vsync_field; /* last seen vsync field */
677 wait_queue_head_t dma_waitq; /* wake up when the current DMA is finished */
678 wait_queue_head_t eos_waitq; /* wake up when EOS arrives */
679 wait_queue_head_t event_waitq; /* wake up when the next decoder event arrives */
680 wait_queue_head_t vsync_waitq; /* wake up when the next decoder vsync arrives */
684 struct ivtv_mailbox_data enc_mbox; /* encoder mailboxes */
685 struct ivtv_mailbox_data dec_mbox; /* decoder mailboxes */
686 struct ivtv_api_cache api_cache[256]; /* cached API commands */
690 struct i2c_adapter i2c_adap;
691 struct i2c_algo_bit_data i2c_algo;
692 struct i2c_client i2c_client;
693 int i2c_state; /* i2c bit state */
694 struct mutex i2c_bus_lock; /* lock i2c bus */
696 struct IR_i2c_init_data ir_i2c_init_data;
698 /* Program Index information */
699 u32 pgm_info_offset; /* start of pgm info in encoder memory */
700 u32 pgm_info_num; /* number of elements in the pgm cyclic buffer in encoder memory */
701 u32 pgm_info_write_idx; /* last index written by the card that was transferred to pgm_info[] */
702 u32 pgm_info_read_idx; /* last index in pgm_info read by the application */
703 struct v4l2_enc_idx_entry pgm_info[IVTV_MAX_PGM_INDEX]; /* filled from the pgm cyclic buffer on the card */
707 u32 open_id; /* incremented each time an open occurs, is >= 1 */
708 struct v4l2_prio_state prio; /* priority state */
709 int search_pack_header; /* 1 if ivtv_copy_buf_to_user() is scanning for a pack header (0xba) */
710 int speed; /* current playback speed setting */
711 u8 speed_mute_audio; /* 1 if audio should be muted when fast forward */
712 u64 mpg_data_received; /* number of bytes received from the MPEG stream */
713 u64 vbi_data_inserted; /* number of VBI bytes inserted into the MPEG stream */
714 u32 last_dec_timing[3]; /* cache last retrieved pts/scr/frame values */
715 unsigned long dualwatch_jiffies;/* jiffies value of the previous dualwatch check */
716 u32 dualwatch_stereo_mode; /* current detected dualwatch stereo mode */
720 struct vbi_info vbi; /* VBI-specific data */
724 struct yuv_playback_info yuv_info; /* YUV playback data */
728 unsigned long osd_video_pbase;
729 int osd_global_alpha_state; /* 1 = global alpha is on */
730 int osd_local_alpha_state; /* 1 = local alpha is on */
731 int osd_chroma_key_state; /* 1 = chroma-keying is on */
732 u8 osd_global_alpha; /* current global alpha */
733 u32 osd_chroma_key; /* current chroma key */
734 struct v4l2_rect osd_rect; /* current OSD position and size */
735 struct v4l2_rect main_rect; /* current Main window position and size */
736 struct osd_info *osd_info; /* ivtvfb private OSD info */
739 static inline struct ivtv *to_ivtv(struct v4l2_device *v4l2_dev)
741 return container_of(v4l2_dev, struct ivtv, v4l2_dev);
745 extern int ivtv_first_minor;
747 /*==============Prototypes==================*/
750 void ivtv_set_irq_mask(struct ivtv *itv, u32 mask);
751 void ivtv_clear_irq_mask(struct ivtv *itv, u32 mask);
753 /* try to set output mode, return current mode. */
754 int ivtv_set_output_mode(struct ivtv *itv, int mode);
756 /* return current output stream based on current mode */
757 struct ivtv_stream *ivtv_get_output_stream(struct ivtv *itv);
759 /* Return non-zero if a signal is pending */
760 int ivtv_msleep_timeout(unsigned int msecs, int intr);
762 /* Wait on queue, returns -EINTR if interrupted */
763 int ivtv_waitq(wait_queue_head_t *waitq);
765 /* Read Hauppauge eeprom */
766 struct tveeprom; /* forward reference */
767 void ivtv_read_eeprom(struct ivtv *itv, struct tveeprom *tv);
769 /* First-open initialization: load firmware, init cx25840, etc. */
770 int ivtv_init_on_first_open(struct ivtv *itv);
772 /* Test if the current VBI mode is raw (1) or sliced (0) */
773 static inline int ivtv_raw_vbi(const struct ivtv *itv)
775 return itv->vbi.in.type == V4L2_BUF_TYPE_VBI_CAPTURE;
778 /* This is a PCI post thing, where if the pci register is not read, then
779 the write doesn't always take effect right away. By reading back the
780 register any pending PCI writes will be performed (in order), and so
781 you can be sure that the writes are guaranteed to be done.
783 Rarely needed, only in some timing sensitive cases.
784 Apparently if this is not done some motherboards seem
785 to kill the firmware and get into the broken state until computer is
787 #define write_sync(val, reg) \
788 do { writel(val, reg); readl(reg); } while (0)
790 #define read_reg(reg) readl(itv->reg_mem + (reg))
791 #define write_reg(val, reg) writel(val, itv->reg_mem + (reg))
792 #define write_reg_sync(val, reg) \
793 do { write_reg(val, reg); read_reg(reg); } while (0)
795 #define read_enc(addr) readl(itv->enc_mem + (u32)(addr))
796 #define write_enc(val, addr) writel(val, itv->enc_mem + (u32)(addr))
797 #define write_enc_sync(val, addr) \
798 do { write_enc(val, addr); read_enc(addr); } while (0)
800 #define read_dec(addr) readl(itv->dec_mem + (u32)(addr))
801 #define write_dec(val, addr) writel(val, itv->dec_mem + (u32)(addr))
802 #define write_dec_sync(val, addr) \
803 do { write_dec(val, addr); read_dec(addr); } while (0)
805 /* Call the specified callback for all subdevs matching hw (if 0, then
806 match them all). Ignore any errors. */
807 #define ivtv_call_hw(itv, hw, o, f, args...) \
808 __v4l2_device_call_subdevs(&(itv)->v4l2_dev, !(hw) || (sd->grp_id & (hw)), o, f , ##args)
810 #define ivtv_call_all(itv, o, f, args...) ivtv_call_hw(itv, 0, o, f , ##args)
812 /* Call the specified callback for all subdevs matching hw (if 0, then
813 match them all). If the callback returns an error other than 0 or
814 -ENOIOCTLCMD, then return with that error code. */
815 #define ivtv_call_hw_err(itv, hw, o, f, args...) \
816 __v4l2_device_call_subdevs_until_err(&(itv)->v4l2_dev, !(hw) || (sd->grp_id & (hw)), o, f , ##args)
818 #define ivtv_call_all_err(itv, o, f, args...) ivtv_call_hw_err(itv, 0, o, f , ##args)