V4L/DVB (6079): Cleanup: remove linux/moduleparam.h from drivers/media files
[linux-2.6.git] / drivers / media / video / ivtv / ivtv-driver.h
1 /*
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>
6
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.
11
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.
16
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
20  */
21
22 #ifndef IVTV_DRIVER_H
23 #define IVTV_DRIVER_H
24
25 /* Internal header for ivtv project:
26  * Driver for the cx23415/6 chip.
27  * Author: Kevin Thayer (nufan_wfk at yahoo.com)
28  * License: GPL
29  * http://www.ivtvdriver.org
30  *
31  * -----
32  * MPG600/MPG160 support by  T.Adachi <tadachi@tadachi-net.com>
33  *                      and Takeru KOMORIYA<komoriya@paken.org>
34  *
35  * AVerMedia M179 GPIO info by Chris Pinkham <cpinkham@bc2va.org>
36  *                using information provided by Jiun-Kuei Jung @ AVerMedia.
37  */
38
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>
44 #include <linux/fs.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/workqueue.h>
55 #include <linux/mutex.h>
56 #include <asm/uaccess.h>
57 #include <asm/system.h>
58
59 #include <linux/dvb/video.h>
60 #include <linux/dvb/audio.h>
61 #include <media/v4l2-common.h>
62 #include <media/tuner.h>
63 #include <media/cx2341x.h>
64
65 #include <media/ivtv.h>
66
67
68 #define IVTV_ENCODER_OFFSET     0x00000000
69 #define IVTV_ENCODER_SIZE       0x00800000      /* Last half isn't needed 0x01000000 */
70
71 #define IVTV_DECODER_OFFSET     0x01000000
72 #define IVTV_DECODER_SIZE       0x00800000      /* Last half isn't needed 0x01000000 */
73
74 #define IVTV_REG_OFFSET         0x02000000
75 #define IVTV_REG_SIZE           0x00010000
76
77 /* Buffers on hardware offsets */
78 #define IVTV_YUV_BUFFER_OFFSET    0x001a8600    /* First YUV Buffer */
79 #define IVTV_YUV_BUFFER_OFFSET_1  0x00240400    /* Second YUV Buffer */
80 #define IVTV_YUV_BUFFER_OFFSET_2  0x002d8200    /* Third YUV Buffer */
81 #define IVTV_YUV_BUFFER_OFFSET_3  0x00370000    /* Fourth YUV Buffer */
82 #define IVTV_YUV_BUFFER_UV_OFFSET 0x65400       /* Offset to UV Buffer */
83
84 /* Offset to filter table in firmware */
85 #define IVTV_YUV_HORIZONTAL_FILTER_OFFSET 0x025d8
86 #define IVTV_YUV_VERTICAL_FILTER_OFFSET 0x03358
87
88 extern const u32 yuv_offset[4];
89
90 /* Maximum ivtv driver instances. Some people have a huge number of
91    capture cards, so set this to a high value. */
92 #define IVTV_MAX_CARDS 32
93
94 /* Supported cards */
95 #define IVTV_CARD_PVR_250             0 /* WinTV PVR 250 */
96 #define IVTV_CARD_PVR_350             1 /* encoder, decoder, tv-out */
97 #define IVTV_CARD_PVR_150             2 /* WinTV PVR 150 and PVR 500 (really just two
98                                            PVR150s on one PCI board) */
99 #define IVTV_CARD_M179                3 /* AVerMedia M179 (encoder only) */
100 #define IVTV_CARD_MPG600              4 /* Kuroutoshikou ITVC16-STVLP/YUAN MPG600, encoder only */
101 #define IVTV_CARD_MPG160              5 /* Kuroutoshikou ITVC15-STVLP/YUAN MPG160
102                                            cx23415 based, but does not have tv-out */
103 #define IVTV_CARD_PG600               6 /* YUAN PG600/DIAMONDMM PVR-550 based on the CX Falcon 2 */
104 #define IVTV_CARD_AVC2410             7 /* Adaptec AVC-2410 */
105 #define IVTV_CARD_AVC2010             8 /* Adaptec AVD-2010 (No Tuner) */
106 #define IVTV_CARD_TG5000TV            9 /* NAGASE TRANSGEAR 5000TV, encoder only */
107 #define IVTV_CARD_VA2000MAX_SNT6     10 /* VA2000MAX-STN6 */
108 #define IVTV_CARD_CX23416GYC         11 /* Kuroutoshikou CX23416GYC-STVLP (Yuan MPG600GR OEM) */
109 #define IVTV_CARD_GV_MVPRX           12 /* I/O Data GV-MVP/RX, RX2, RX2W */
110 #define IVTV_CARD_GV_MVPRX2E         13 /* I/O Data GV-MVP/RX2E */
111 #define IVTV_CARD_GOTVIEW_PCI_DVD    14 /* GotView PCI DVD */
112 #define IVTV_CARD_GOTVIEW_PCI_DVD2   15 /* GotView PCI DVD2 */
113 #define IVTV_CARD_YUAN_MPC622        16 /* Yuan MPC622 miniPCI */
114 #define IVTV_CARD_DCTMTVP1           17 /* DIGITAL COWBOY DCT-MTVP1 */
115 #define IVTV_CARD_PG600V2            18 /* Yuan PG600V2/GotView PCI DVD Lite */
116 #define IVTV_CARD_CLUB3D             19 /* Club3D ZAP-TV1x01 */
117 #define IVTV_CARD_AVERTV_MCE116      20 /* AVerTV MCE 116 Plus */
118 #define IVTV_CARD_LAST               20
119
120 /* Variants of existing cards but with the same PCI IDs. The driver
121    detects these based on other device information.
122    These cards must always come last.
123    New cards must be inserted above, and the indices of the cards below
124    must be adjusted accordingly. */
125
126 /* PVR-350 V1 (uses saa7114) */
127 #define IVTV_CARD_PVR_350_V1         (IVTV_CARD_LAST+1)
128 /* 2 variants of Kuroutoshikou CX23416GYC-STVLP (Yuan MPG600GR OEM) */
129 #define IVTV_CARD_CX23416GYC_NOGR    (IVTV_CARD_LAST+2)
130 #define IVTV_CARD_CX23416GYC_NOGRYCS (IVTV_CARD_LAST+3)
131
132 #define IVTV_ENC_STREAM_TYPE_MPG  0
133 #define IVTV_ENC_STREAM_TYPE_YUV  1
134 #define IVTV_ENC_STREAM_TYPE_VBI  2
135 #define IVTV_ENC_STREAM_TYPE_PCM  3
136 #define IVTV_ENC_STREAM_TYPE_RAD  4
137 #define IVTV_DEC_STREAM_TYPE_MPG  5
138 #define IVTV_DEC_STREAM_TYPE_VBI  6
139 #define IVTV_DEC_STREAM_TYPE_VOUT 7
140 #define IVTV_DEC_STREAM_TYPE_YUV  8
141 #define IVTV_MAX_STREAMS          9
142
143 #define IVTV_V4L2_DEC_MPG_OFFSET  16    /* offset from 0 to register decoder mpg v4l2 minors on */
144 #define IVTV_V4L2_ENC_PCM_OFFSET  24    /* offset from 0 to register pcm v4l2 minors on */
145 #define IVTV_V4L2_ENC_YUV_OFFSET  32    /* offset from 0 to register yuv v4l2 minors on */
146 #define IVTV_V4L2_DEC_YUV_OFFSET  48    /* offset from 0 to register decoder yuv v4l2 minors on */
147 #define IVTV_V4L2_DEC_VBI_OFFSET   8    /* offset from 0 to register decoder vbi input v4l2 minors on */
148 #define IVTV_V4L2_DEC_VOUT_OFFSET 16    /* offset from 0 to register vbi output v4l2 minors on */
149
150 #define IVTV_ENC_MEM_START 0x00000000
151 #define IVTV_DEC_MEM_START 0x01000000
152
153 /* system vendor and device IDs */
154 #define PCI_VENDOR_ID_ICOMP  0x4444
155 #define PCI_DEVICE_ID_IVTV15 0x0803
156 #define PCI_DEVICE_ID_IVTV16 0x0016
157
158 /* subsystem vendor ID */
159 #define IVTV_PCI_ID_HAUPPAUGE           0x0070
160 #define IVTV_PCI_ID_HAUPPAUGE_ALT1      0x0270
161 #define IVTV_PCI_ID_HAUPPAUGE_ALT2      0x4070
162 #define IVTV_PCI_ID_ADAPTEC             0x9005
163 #define IVTV_PCI_ID_AVERMEDIA           0x1461
164 #define IVTV_PCI_ID_YUAN1               0x12ab
165 #define IVTV_PCI_ID_YUAN2               0xff01
166 #define IVTV_PCI_ID_YUAN3               0xffab
167 #define IVTV_PCI_ID_YUAN4               0xfbab
168 #define IVTV_PCI_ID_DIAMONDMM           0xff92
169 #define IVTV_PCI_ID_IODATA              0x10fc
170 #define IVTV_PCI_ID_MELCO               0x1154
171 #define IVTV_PCI_ID_GOTVIEW1            0xffac
172 #define IVTV_PCI_ID_GOTVIEW2            0xffad
173
174 /* Decoder Buffer hardware size on Chip */
175 #define IVTV_DEC_MAX_BUF        0x00100000      /* max bytes in decoder buffer */
176 #define IVTV_DEC_MIN_BUF        0x00010000      /* min bytes in dec buffer */
177
178 /* ======================================================================== */
179 /* ========================== START USER SETTABLE DMA VARIABLES =========== */
180 /* ======================================================================== */
181
182 #define IVTV_DMA_SG_OSD_ENT     (2883584/PAGE_SIZE)     /* sg entities */
183
184 /* DMA Buffers, Default size in MB allocated */
185 #define IVTV_DEFAULT_ENC_MPG_BUFFERS 4
186 #define IVTV_DEFAULT_ENC_YUV_BUFFERS 2
187 #define IVTV_DEFAULT_ENC_VBI_BUFFERS 1
188 /* Exception: size in kB for this stream (MB is overkill) */
189 #define IVTV_DEFAULT_ENC_PCM_BUFFERS 320
190 #define IVTV_DEFAULT_DEC_MPG_BUFFERS 1
191 #define IVTV_DEFAULT_DEC_YUV_BUFFERS 1
192 /* Exception: size in kB for this stream (MB is way overkill) */
193 #define IVTV_DEFAULT_DEC_VBI_BUFFERS 64
194
195 /* ======================================================================== */
196 /* ========================== END USER SETTABLE DMA VARIABLES ============= */
197 /* ======================================================================== */
198
199 /* Decoder Status Register */
200 #define IVTV_DMA_ERR_LIST       0x00000010
201 #define IVTV_DMA_ERR_WRITE      0x00000008
202 #define IVTV_DMA_ERR_READ       0x00000004
203 #define IVTV_DMA_SUCCESS_WRITE  0x00000002
204 #define IVTV_DMA_SUCCESS_READ   0x00000001
205 #define IVTV_DMA_READ_ERR       (IVTV_DMA_ERR_LIST | IVTV_DMA_ERR_READ)
206 #define IVTV_DMA_WRITE_ERR      (IVTV_DMA_ERR_LIST | IVTV_DMA_ERR_WRITE)
207 #define IVTV_DMA_ERR            (IVTV_DMA_ERR_LIST | IVTV_DMA_ERR_WRITE | IVTV_DMA_ERR_READ)
208
209 /* DMA Registers */
210 #define IVTV_REG_DMAXFER        (0x0000)
211 #define IVTV_REG_DMASTATUS      (0x0004)
212 #define IVTV_REG_DECDMAADDR     (0x0008)
213 #define IVTV_REG_ENCDMAADDR     (0x000c)
214 #define IVTV_REG_DMACONTROL     (0x0010)
215 #define IVTV_REG_IRQSTATUS      (0x0040)
216 #define IVTV_REG_IRQMASK        (0x0048)
217
218 /* Setup Registers */
219 #define IVTV_REG_ENC_SDRAM_REFRESH      (0x07F8)
220 #define IVTV_REG_ENC_SDRAM_PRECHARGE    (0x07FC)
221 #define IVTV_REG_DEC_SDRAM_REFRESH      (0x08F8)
222 #define IVTV_REG_DEC_SDRAM_PRECHARGE    (0x08FC)
223 #define IVTV_REG_VDM                    (0x2800)
224 #define IVTV_REG_AO                     (0x2D00)
225 #define IVTV_REG_BYTEFLUSH              (0x2D24)
226 #define IVTV_REG_SPU                    (0x9050)
227 #define IVTV_REG_HW_BLOCKS              (0x9054)
228 #define IVTV_REG_VPU                    (0x9058)
229 #define IVTV_REG_APU                    (0xA064)
230
231 #define IVTV_IRQ_ENC_START_CAP          (0x1 << 31)
232 #define IVTV_IRQ_ENC_EOS                (0x1 << 30)
233 #define IVTV_IRQ_ENC_VBI_CAP            (0x1 << 29)
234 #define IVTV_IRQ_ENC_VIM_RST            (0x1 << 28)
235 #define IVTV_IRQ_ENC_DMA_COMPLETE       (0x1 << 27)
236 #define IVTV_IRQ_ENC_PIO_COMPLETE       (0x1 << 25)
237 #define IVTV_IRQ_DEC_AUD_MODE_CHG       (0x1 << 24)
238 #define IVTV_IRQ_DEC_DATA_REQ           (0x1 << 22)
239 #define IVTV_IRQ_DEC_DMA_COMPLETE       (0x1 << 20)
240 #define IVTV_IRQ_DEC_VBI_RE_INSERT      (0x1 << 19)
241 #define IVTV_IRQ_DMA_ERR                (0x1 << 18)
242 #define IVTV_IRQ_DMA_WRITE              (0x1 << 17)
243 #define IVTV_IRQ_DMA_READ               (0x1 << 16)
244 #define IVTV_IRQ_DEC_VSYNC              (0x1 << 10)
245
246 /* IRQ Masks */
247 #define IVTV_IRQ_MASK_INIT (IVTV_IRQ_DMA_ERR|IVTV_IRQ_ENC_DMA_COMPLETE|\
248                 IVTV_IRQ_DMA_READ|IVTV_IRQ_ENC_PIO_COMPLETE)
249
250 #define IVTV_IRQ_MASK_CAPTURE (IVTV_IRQ_ENC_START_CAP | IVTV_IRQ_ENC_EOS)
251 #define IVTV_IRQ_MASK_DECODE  (IVTV_IRQ_DEC_DATA_REQ|IVTV_IRQ_DEC_AUD_MODE_CHG)
252
253 /* i2c stuff */
254 #define I2C_CLIENTS_MAX 16
255
256 /* debugging */
257
258 #define IVTV_DBGFLG_WARN    (1 << 0)
259 #define IVTV_DBGFLG_INFO    (1 << 1)
260 #define IVTV_DBGFLG_MB      (1 << 2)
261 #define IVTV_DBGFLG_IOCTL   (1 << 3)
262 #define IVTV_DBGFLG_FILE    (1 << 4)
263 #define IVTV_DBGFLG_DMA     (1 << 5)
264 #define IVTV_DBGFLG_IRQ     (1 << 6)
265 #define IVTV_DBGFLG_DEC     (1 << 7)
266 #define IVTV_DBGFLG_YUV     (1 << 8)
267 #define IVTV_DBGFLG_I2C     (1 << 9)
268 /* Flag to turn on high volume debugging */
269 #define IVTV_DBGFLG_HIGHVOL (1 << 10)
270
271 /* NOTE: extra space before comma in 'itv->num , ## args' is required for
272    gcc-2.95, otherwise it won't compile. */
273 #define IVTV_DEBUG(x, type, fmt, args...) \
274         do { \
275                 if ((x) & ivtv_debug) \
276                         printk(KERN_INFO "ivtv%d " type ": " fmt, itv->num , ## args); \
277         } while (0)
278 #define IVTV_DEBUG_WARN(fmt, args...)  IVTV_DEBUG(IVTV_DBGFLG_WARN,  "warn",  fmt , ## args)
279 #define IVTV_DEBUG_INFO(fmt, args...)  IVTV_DEBUG(IVTV_DBGFLG_INFO,  "info",  fmt , ## args)
280 #define IVTV_DEBUG_MB(fmt, args...)    IVTV_DEBUG(IVTV_DBGFLG_MB,    "mb",    fmt , ## args)
281 #define IVTV_DEBUG_DMA(fmt, args...)   IVTV_DEBUG(IVTV_DBGFLG_DMA,   "dma",   fmt , ## args)
282 #define IVTV_DEBUG_IOCTL(fmt, args...) IVTV_DEBUG(IVTV_DBGFLG_IOCTL, "ioctl", fmt , ## args)
283 #define IVTV_DEBUG_FILE(fmt, args...)  IVTV_DEBUG(IVTV_DBGFLG_FILE,  "file",  fmt , ## args)
284 #define IVTV_DEBUG_I2C(fmt, args...)   IVTV_DEBUG(IVTV_DBGFLG_I2C,   "i2c",   fmt , ## args)
285 #define IVTV_DEBUG_IRQ(fmt, args...)   IVTV_DEBUG(IVTV_DBGFLG_IRQ,   "irq",   fmt , ## args)
286 #define IVTV_DEBUG_DEC(fmt, args...)   IVTV_DEBUG(IVTV_DBGFLG_DEC,   "dec",   fmt , ## args)
287 #define IVTV_DEBUG_YUV(fmt, args...)   IVTV_DEBUG(IVTV_DBGFLG_YUV,   "yuv",   fmt , ## args)
288
289 #define IVTV_DEBUG_HIGH_VOL(x, type, fmt, args...) \
290         do { \
291                 if (((x) & ivtv_debug) && (ivtv_debug & IVTV_DBGFLG_HIGHVOL)) \
292                         printk(KERN_INFO "ivtv%d " type ": " fmt, itv->num , ## args); \
293         } while (0)
294 #define IVTV_DEBUG_HI_WARN(fmt, args...)  IVTV_DEBUG_HIGH_VOL(IVTV_DBGFLG_WARN,  "warn",  fmt , ## args)
295 #define IVTV_DEBUG_HI_INFO(fmt, args...)  IVTV_DEBUG_HIGH_VOL(IVTV_DBGFLG_INFO,  "info",  fmt , ## args)
296 #define IVTV_DEBUG_HI_MB(fmt, args...)    IVTV_DEBUG_HIGH_VOL(IVTV_DBGFLG_MB,    "mb",    fmt , ## args)
297 #define IVTV_DEBUG_HI_DMA(fmt, args...)   IVTV_DEBUG_HIGH_VOL(IVTV_DBGFLG_DMA,   "dma",   fmt , ## args)
298 #define IVTV_DEBUG_HI_IOCTL(fmt, args...) IVTV_DEBUG_HIGH_VOL(IVTV_DBGFLG_IOCTL, "ioctl", fmt , ## args)
299 #define IVTV_DEBUG_HI_FILE(fmt, args...)  IVTV_DEBUG_HIGH_VOL(IVTV_DBGFLG_FILE,  "file",  fmt , ## args)
300 #define IVTV_DEBUG_HI_I2C(fmt, args...)   IVTV_DEBUG_HIGH_VOL(IVTV_DBGFLG_I2C,   "i2c",   fmt , ## args)
301 #define IVTV_DEBUG_HI_IRQ(fmt, args...)   IVTV_DEBUG_HIGH_VOL(IVTV_DBGFLG_IRQ,   "irq",   fmt , ## args)
302 #define IVTV_DEBUG_HI_DEC(fmt, args...)   IVTV_DEBUG_HIGH_VOL(IVTV_DBGFLG_DEC,   "dec",   fmt , ## args)
303 #define IVTV_DEBUG_HI_YUV(fmt, args...)   IVTV_DEBUG_HIGH_VOL(IVTV_DBGFLG_YUV,   "yuv",   fmt , ## args)
304
305 /* Standard kernel messages */
306 #define IVTV_ERR(fmt, args...)      printk(KERN_ERR  "ivtv%d: " fmt, itv->num , ## args)
307 #define IVTV_WARN(fmt, args...)     printk(KERN_WARNING "ivtv%d: " fmt, itv->num , ## args)
308 #define IVTV_INFO(fmt, args...)     printk(KERN_INFO "ivtv%d: " fmt, itv->num , ## args)
309
310 /* Values for IVTV_API_DEC_PLAYBACK_SPEED mpeg_frame_type_mask parameter: */
311 #define MPEG_FRAME_TYPE_IFRAME 1
312 #define MPEG_FRAME_TYPE_IFRAME_PFRAME 3
313 #define MPEG_FRAME_TYPE_ALL 7
314
315 /* output modes (cx23415 only) */
316 #define OUT_NONE        0
317 #define OUT_MPG         1
318 #define OUT_YUV         2
319 #define OUT_UDMA_YUV    3
320 #define OUT_PASSTHROUGH 4
321
322 #define IVTV_MAX_PGM_INDEX (400)
323
324 extern int ivtv_debug;
325
326
327 struct ivtv_options {
328         int kilobytes[IVTV_MAX_STREAMS]; /* Size in kilobytes of each stream */
329         int cardtype;           /* force card type on load */
330         int tuner;              /* set tuner on load */
331         int radio;              /* enable/disable radio */
332         int newi2c;             /* New I2C algorithm */
333 };
334
335 #define IVTV_MBOX_DMA_START 6
336 #define IVTV_MBOX_DMA_END 8
337 #define IVTV_MBOX_DMA 9
338 #define IVTV_MBOX_FIELD_DISPLAYED 8
339
340 /* ivtv-specific mailbox template */
341 struct ivtv_mailbox {
342         u32 flags;
343         u32 cmd;
344         u32 retval;
345         u32 timeout;
346         u32 data[CX2341X_MBOX_MAX_DATA];
347 };
348
349 struct ivtv_api_cache {
350         unsigned long last_jiffies;             /* when last command was issued */
351         u32 data[CX2341X_MBOX_MAX_DATA];        /* last sent api data */
352 };
353
354 struct ivtv_mailbox_data {
355         volatile struct ivtv_mailbox __iomem *mbox;
356         /* Bits 0-2 are for the encoder mailboxes, 0-1 are for the decoder mailboxes.
357            If the bit is set, then the corresponding mailbox is in use by the driver. */
358         unsigned long busy;
359         u8 max_mbox;
360 };
361
362 /* per-buffer bit flags */
363 #define IVTV_F_B_NEED_BUF_SWAP  (1 << 0)        /* this buffer should be byte swapped */
364
365 /* per-stream, s_flags */
366 #define IVTV_F_S_DMA_PENDING    0       /* this stream has pending DMA */
367 #define IVTV_F_S_DMA_HAS_VBI    1       /* the current DMA request also requests VBI data */
368 #define IVTV_F_S_NEEDS_DATA     2       /* this decoding stream needs more data */
369
370 #define IVTV_F_S_CLAIMED        3       /* this stream is claimed */
371 #define IVTV_F_S_STREAMING      4       /* the fw is decoding/encoding this stream */
372 #define IVTV_F_S_INTERNAL_USE   5       /* this stream is used internally (sliced VBI processing) */
373 #define IVTV_F_S_PASSTHROUGH    6       /* this stream is in passthrough mode */
374 #define IVTV_F_S_STREAMOFF      7       /* signal end of stream EOS */
375 #define IVTV_F_S_APPL_IO        8       /* this stream is used read/written by an application */
376
377 #define IVTV_F_S_PIO_PENDING    9       /* this stream has pending PIO */
378 #define IVTV_F_S_PIO_HAS_VBI    1       /* the current PIO request also requests VBI data */
379
380 /* per-ivtv, i_flags */
381 #define IVTV_F_I_DMA               0    /* DMA in progress */
382 #define IVTV_F_I_UDMA              1    /* UDMA in progress */
383 #define IVTV_F_I_UDMA_PENDING      2    /* UDMA pending */
384 #define IVTV_F_I_SPEED_CHANGE      3    /* A speed change is in progress */
385 #define IVTV_F_I_EOS               4    /* End of encoder stream reached */
386 #define IVTV_F_I_RADIO_USER        5    /* The radio tuner is selected */
387 #define IVTV_F_I_DIG_RST           6    /* Reset digitizer */
388 #define IVTV_F_I_DEC_YUV           7    /* YUV instead of MPG is being decoded */
389 #define IVTV_F_I_UPDATE_CC         9    /* CC should be updated */
390 #define IVTV_F_I_UPDATE_WSS        10   /* WSS should be updated */
391 #define IVTV_F_I_UPDATE_VPS        11   /* VPS should be updated */
392 #define IVTV_F_I_DECODING_YUV      12   /* this stream is YUV frame decoding */
393 #define IVTV_F_I_ENC_PAUSED        13   /* the encoder is paused */
394 #define IVTV_F_I_VALID_DEC_TIMINGS 14   /* last_dec_timing is valid */
395 #define IVTV_F_I_HAVE_WORK         15   /* Used in the interrupt handler: there is work to be done */
396 #define IVTV_F_I_WORK_HANDLER_VBI  16   /* there is work to be done for VBI */
397 #define IVTV_F_I_WORK_HANDLER_YUV  17   /* there is work to be done for YUV */
398 #define IVTV_F_I_WORK_HANDLER_PIO  18   /* there is work to be done for PIO */
399 #define IVTV_F_I_PIO               19   /* PIO in progress */
400 #define IVTV_F_I_DEC_PAUSED        20   /* the decoder is paused */
401 #define IVTV_F_I_INITED            21   /* set after first open */
402 #define IVTV_F_I_FAILED            22   /* set if first open failed */
403
404 /* Event notifications */
405 #define IVTV_F_I_EV_DEC_STOPPED    28   /* decoder stopped event */
406 #define IVTV_F_I_EV_VSYNC          29   /* VSYNC event */
407 #define IVTV_F_I_EV_VSYNC_FIELD    30   /* VSYNC event field (0 = first, 1 = second field) */
408 #define IVTV_F_I_EV_VSYNC_ENABLED  31   /* VSYNC event enabled */
409
410 /* Scatter-Gather array element, used in DMA transfers */
411 struct ivtv_sg_element {
412         u32 src;
413         u32 dst;
414         u32 size;
415 };
416
417 struct ivtv_user_dma {
418         struct mutex lock;
419         int page_count;
420         struct page *map[IVTV_DMA_SG_OSD_ENT];
421         /* Needed when dealing with highmem userspace buffers */
422         struct page *bouncemap[IVTV_DMA_SG_OSD_ENT];
423
424         /* Base Dev SG Array for cx23415/6 */
425         struct ivtv_sg_element SGarray[IVTV_DMA_SG_OSD_ENT];
426         dma_addr_t SG_handle;
427         int SG_length;
428
429         /* SG List of Buffers */
430         struct scatterlist SGlist[IVTV_DMA_SG_OSD_ENT];
431 };
432
433 struct ivtv_dma_page_info {
434         unsigned long uaddr;
435         unsigned long first;
436         unsigned long last;
437         unsigned int offset;
438         unsigned int tail;
439         int page_count;
440 };
441
442 struct ivtv_buffer {
443         struct list_head list;
444         dma_addr_t dma_handle;
445         unsigned short b_flags;
446         unsigned short dma_xfer_cnt;
447         char *buf;
448
449         u32 bytesused;
450         u32 readpos;
451 };
452
453 struct ivtv_queue {
454         struct list_head list;
455         u32 buffers;
456         u32 length;
457         u32 bytesused;
458 };
459
460 struct ivtv;    /* forward reference */
461
462 struct ivtv_stream {
463         /* These first four fields are always set, even if the stream
464            is not actually created. */
465         struct video_device *v4l2dev;   /* NULL when stream not created */
466         struct ivtv *itv;               /* for ease of use */
467         const char *name;               /* name of the stream */
468         int type;                       /* stream type */
469
470         u32 id;
471         spinlock_t qlock;       /* locks access to the queues */
472         unsigned long s_flags;  /* status flags, see above */
473         int dma;                /* can be PCI_DMA_TODEVICE,
474                                    PCI_DMA_FROMDEVICE or
475                                    PCI_DMA_NONE */
476         u32 pending_offset;
477         u32 pending_backup;
478         u64 pending_pts;
479
480         u32 dma_offset;
481         u32 dma_backup;
482         u64 dma_pts;
483
484         int subtype;
485         wait_queue_head_t waitq;
486         u32 dma_last_offset;
487
488         /* Buffer Stats */
489         u32 buffers;
490         u32 buf_size;
491         u32 buffers_stolen;
492
493         /* Buffer Queues */
494         struct ivtv_queue q_free;       /* free buffers */
495         struct ivtv_queue q_full;       /* full buffers */
496         struct ivtv_queue q_io;         /* waiting for I/O */
497         struct ivtv_queue q_dma;        /* waiting for DMA */
498         struct ivtv_queue q_predma;     /* waiting for DMA */
499
500         /* DMA xfer counter, buffers belonging to the same DMA
501            xfer will have the same dma_xfer_cnt. */
502         u16 dma_xfer_cnt;
503
504         /* Base Dev SG Array for cx23415/6 */
505         struct ivtv_sg_element *sg_pending;
506         struct ivtv_sg_element *sg_processing;
507         struct ivtv_sg_element *sg_dma;
508         dma_addr_t sg_handle;
509         int sg_pending_size;
510         int sg_processing_size;
511         int sg_processed;
512
513         /* SG List of Buffers */
514         struct scatterlist *SGlist;
515 };
516
517 struct ivtv_open_id {
518         u32 open_id;
519         int type;
520         enum v4l2_priority prio;
521         struct ivtv *itv;
522 };
523
524 #define IVTV_YUV_UPDATE_HORIZONTAL  0x01
525 #define IVTV_YUV_UPDATE_VERTICAL    0x02
526
527 struct yuv_frame_info
528 {
529         u32 update;
530         int src_x;
531         int src_y;
532         unsigned int src_w;
533         unsigned int src_h;
534         int dst_x;
535         int dst_y;
536         unsigned int dst_w;
537         unsigned int dst_h;
538         int pan_x;
539         int pan_y;
540         u32 vis_w;
541         u32 vis_h;
542         u32 interlaced_y;
543         u32 interlaced_uv;
544         int tru_x;
545         u32 tru_w;
546         u32 tru_h;
547         u32 offset_y;
548         int lace_mode;
549 };
550
551 #define IVTV_YUV_MODE_INTERLACED        0x00
552 #define IVTV_YUV_MODE_PROGRESSIVE       0x01
553 #define IVTV_YUV_MODE_AUTO              0x02
554 #define IVTV_YUV_MODE_MASK              0x03
555
556 #define IVTV_YUV_SYNC_EVEN              0x00
557 #define IVTV_YUV_SYNC_ODD               0x04
558 #define IVTV_YUV_SYNC_MASK              0x04
559
560 struct yuv_playback_info
561 {
562         u32 reg_2834;
563         u32 reg_2838;
564         u32 reg_283c;
565         u32 reg_2840;
566         u32 reg_2844;
567         u32 reg_2848;
568         u32 reg_2854;
569         u32 reg_285c;
570         u32 reg_2864;
571
572         u32 reg_2870;
573         u32 reg_2874;
574         u32 reg_2890;
575         u32 reg_2898;
576         u32 reg_289c;
577
578         u32 reg_2918;
579         u32 reg_291c;
580         u32 reg_2920;
581         u32 reg_2924;
582         u32 reg_2928;
583         u32 reg_292c;
584         u32 reg_2930;
585
586         u32 reg_2934;
587
588         u32 reg_2938;
589         u32 reg_293c;
590         u32 reg_2940;
591         u32 reg_2944;
592         u32 reg_2948;
593         u32 reg_294c;
594         u32 reg_2950;
595         u32 reg_2954;
596         u32 reg_2958;
597         u32 reg_295c;
598         u32 reg_2960;
599         u32 reg_2964;
600         u32 reg_2968;
601         u32 reg_296c;
602
603         u32 reg_2970;
604
605         int v_filter_1;
606         int v_filter_2;
607         int h_filter;
608
609         u32 osd_x_offset;
610         u32 osd_y_offset;
611
612         u32 osd_x_pan;
613         u32 osd_y_pan;
614
615         u32 osd_vis_w;
616         u32 osd_vis_h;
617
618         int decode_height;
619
620         int frame_interlaced;
621
622         int lace_mode;
623         int lace_threshold;
624         int lace_sync_field;
625
626         atomic_t next_dma_frame;
627         atomic_t next_fill_frame;
628
629         u32 yuv_forced_update;
630         int update_frame;
631
632         int sync_field[4];  /* Field to sync on */
633         int field_delay[4]; /* Flag to extend duration of previous frame */
634         u8 fields_lapsed;   /* Counter used when delaying a frame */
635
636         struct yuv_frame_info new_frame_info[4];
637         struct yuv_frame_info old_frame_info;
638         struct yuv_frame_info old_frame_info_args;
639
640         void *blanking_ptr;
641         dma_addr_t blanking_dmaptr;
642 };
643
644 #define IVTV_VBI_FRAMES 32
645
646 /* VBI data */
647 struct vbi_info {
648         u32 dec_start;
649         u32 enc_start, enc_size;
650         int fpi;
651         u32 frame;
652         u8 cc_data_odd[256];
653         u8 cc_data_even[256];
654         int cc_pos;
655         u8 cc_no_update;
656         u8 vps[5];
657         u8 vps_found;
658         int wss;
659         u8 wss_found;
660         u8 wss_no_update;
661         u32 raw_decoder_line_size;
662         u8 raw_decoder_sav_odd_field;
663         u8 raw_decoder_sav_even_field;
664         u32 sliced_decoder_line_size;
665         u8 sliced_decoder_sav_odd_field;
666         u8 sliced_decoder_sav_even_field;
667         struct v4l2_format in;
668         /* convenience pointer to sliced struct in vbi_in union */
669         struct v4l2_sliced_vbi_format *sliced_in;
670         int insert_mpeg;
671
672         /* Buffer for the maximum of 2 * 18 * packet_size sliced VBI lines.
673            One for /dev/vbi0 and one for /dev/vbi8 */
674         struct v4l2_sliced_vbi_data sliced_data[36];
675         struct v4l2_sliced_vbi_data sliced_dec_data[36];
676
677         /* Buffer for VBI data inserted into MPEG stream.
678            The first byte is a dummy byte that's never used.
679            The next 16 bytes contain the MPEG header for the VBI data,
680            the remainder is the actual VBI data.
681            The max size accepted by the MPEG VBI reinsertion turns out
682            to be 1552 bytes, which happens to be 4 + (1 + 42) * (2 * 18) bytes,
683            where 4 is a four byte header, 42 is the max sliced VBI payload, 1 is
684            a single line header byte and 2 * 18 is the number of VBI lines per frame.
685
686            However, it seems that the data must be 1K aligned, so we have to
687            pad the data until the 1 or 2 K boundary.
688
689            This pointer array will allocate 2049 bytes to store each VBI frame. */
690         u8 *sliced_mpeg_data[IVTV_VBI_FRAMES];
691         u32 sliced_mpeg_size[IVTV_VBI_FRAMES];
692         struct ivtv_buffer sliced_mpeg_buf;
693         u32 inserted_frame;
694
695         u32 start[2], count;
696         u32 raw_size;
697         u32 sliced_size;
698 };
699
700 /* forward declaration of struct defined in ivtv-cards.h */
701 struct ivtv_card;
702
703 /* Struct to hold info about ivtv cards */
704 struct ivtv {
705         int num;                /* board number, -1 during init! */
706         char name[8];           /* board name for printk and interrupts (e.g. 'ivtv0') */
707         struct pci_dev *dev;    /* PCI device */
708         const struct ivtv_card *card;   /* card information */
709         const char *card_name;  /* full name of the card */
710         u8 has_cx23415;         /* 1 if it is a cx23415 based card, 0 for cx23416 */
711         u8 is_50hz;
712         u8 is_60hz;
713         u8 is_out_50hz;
714         u8 is_out_60hz;
715         u8 pvr150_workaround;   /* 1 if the cx25840 needs to workaround a PVR150 bug */
716         u8 nof_inputs;          /* number of video inputs */
717         u8 nof_audio_inputs;    /* number of audio inputs */
718         u32 v4l2_cap;           /* V4L2 capabilities of card */
719         u32 hw_flags;           /* Hardware description of the board */
720         int tunerid;            /* Userspace tuner ID for experimental Xceive tuner support */
721
722         /* controlling Video decoder function */
723         int (*video_dec_func)(struct ivtv *, unsigned int, void *);
724
725         struct ivtv_options options;    /* User options */
726         int stream_buf_size[IVTV_MAX_STREAMS]; /* Stream buffer size */
727         struct ivtv_stream streams[IVTV_MAX_STREAMS];   /* Stream data */
728         int speed;
729         u8 speed_mute_audio;
730         unsigned long i_flags;  /* global ivtv flags */
731         atomic_t capturing;     /* count number of active capture streams */
732         atomic_t decoding;      /* count number of active decoding streams */
733         u32 irq_rr_idx; /* Round-robin stream index */
734         int cur_dma_stream;     /* index of stream doing DMA */
735         int cur_pio_stream;     /* index of stream doing PIO */
736         u32 dma_data_req_offset;
737         u32 dma_data_req_size;
738         int dma_retries;
739         int output_mode;        /* NONE, MPG, YUV, UDMA YUV, passthrough */
740         spinlock_t lock;        /* lock access to this struct */
741         int search_pack_header;
742
743         spinlock_t dma_reg_lock; /* lock access to DMA engine registers */
744         struct mutex serialize_lock;  /* lock used to serialize starting streams */
745
746         /* User based DMA for OSD */
747         struct ivtv_user_dma udma;
748
749         int open_id;            /* incremented each time an open occurs, used as unique ID.
750                                    starts at 1, so 0 can be used as uninitialized value
751                                    in the stream->id. */
752
753         u32 base_addr;
754         u32 irqmask;
755
756         struct v4l2_prio_state prio;
757         struct workqueue_struct *irq_work_queues;
758         struct work_struct irq_work_queue;
759         struct timer_list dma_timer; /* Timer used to catch unfinished DMAs */
760
761         struct vbi_info vbi;
762
763         struct ivtv_mailbox_data enc_mbox;
764         struct ivtv_mailbox_data dec_mbox;
765         struct ivtv_api_cache api_cache[256];   /* Cached API Commands */
766
767         u8 card_rev;
768         volatile void __iomem *enc_mem, *dec_mem, *reg_mem;
769
770         u32 pgm_info_offset;
771         u32 pgm_info_num;
772         u32 pgm_info_write_idx;
773         u32 pgm_info_read_idx;
774         struct v4l2_enc_idx_entry pgm_info[IVTV_MAX_PGM_INDEX];
775
776         u64 mpg_data_received;
777         u64 vbi_data_inserted;
778
779         wait_queue_head_t cap_w;
780         /* when the next decoder event arrives this queue is woken up */
781         wait_queue_head_t event_waitq;
782         /* when the next decoder vsync arrives this queue is woken up */
783         wait_queue_head_t vsync_waitq;
784         /* when the current DMA is finished this queue is woken up */
785         wait_queue_head_t dma_waitq;
786
787         /* OSD support */
788         unsigned long osd_video_pbase;
789         int osd_global_alpha_state; /* 0=off : 1=on */
790         int osd_local_alpha_state;  /* 0=off : 1=on */
791         int osd_color_key_state;    /* 0=off : 1=on */
792         u8  osd_global_alpha;       /* Current global alpha */
793         u32 osd_color_key;          /* Current color key */
794         u32 osd_pixelformat;        /* Current pixel format */
795         struct v4l2_rect osd_rect;  /* Current OSD position and size */
796         struct v4l2_rect main_rect; /* Current Main window position and size */
797
798         u32 last_dec_timing[3];     /* Store last retrieved pts/scr/frame values */
799
800         /* i2c */
801         struct i2c_adapter i2c_adap;
802         struct i2c_algo_bit_data i2c_algo;
803         struct i2c_client i2c_client;
804         struct mutex i2c_bus_lock;
805         int i2c_state;
806         struct i2c_client *i2c_clients[I2C_CLIENTS_MAX];
807
808         /* v4l2 and User settings */
809
810         /* codec settings */
811         struct cx2341x_mpeg_params params;
812         u32 audio_input;
813         u32 active_input;
814         u32 active_output;
815         v4l2_std_id std;
816         v4l2_std_id std_out;
817         v4l2_std_id tuner_std;  /* The norm of the tuner (fixed) */
818         u8 audio_stereo_mode;
819         u8 audio_bilingual_mode;
820
821         /* dualwatch */
822         unsigned long dualwatch_jiffies;
823         u16 dualwatch_stereo_mode;
824
825         /* Digitizer type */
826         int digitizer;          /* 0x00EF = saa7114 0x00FO = saa7115 0x0106 = mic */
827
828         u32 lastVsyncFrame;
829
830         struct yuv_playback_info yuv_info;
831         struct osd_info *osd_info;
832 };
833
834 /* Globals */
835 extern struct ivtv *ivtv_cards[];
836 extern int ivtv_cards_active;
837 extern int ivtv_first_minor;
838 extern spinlock_t ivtv_cards_lock;
839
840 /*==============Prototypes==================*/
841
842 /* Hardware/IRQ */
843 void ivtv_set_irq_mask(struct ivtv *itv, u32 mask);
844 void ivtv_clear_irq_mask(struct ivtv *itv, u32 mask);
845
846 /* try to set output mode, return current mode. */
847 int ivtv_set_output_mode(struct ivtv *itv, int mode);
848
849 /* return current output stream based on current mode */
850 struct ivtv_stream *ivtv_get_output_stream(struct ivtv *itv);
851
852 /* Return non-zero if a signal is pending */
853 int ivtv_msleep_timeout(unsigned int msecs, int intr);
854
855 /* Wait on queue, returns -EINTR if interrupted */
856 int ivtv_waitq(wait_queue_head_t *waitq);
857
858 /* Read Hauppauge eeprom */
859 struct tveeprom; /* forward reference */
860 void ivtv_read_eeprom(struct ivtv *itv, struct tveeprom *tv);
861
862 /* First-open initialization: load firmware, init cx25840, etc. */
863 int ivtv_init_on_first_open(struct ivtv *itv);
864
865 /* This is a PCI post thing, where if the pci register is not read, then
866    the write doesn't always take effect right away. By reading back the
867    register any pending PCI writes will be performed (in order), and so
868    you can be sure that the writes are guaranteed to be done.
869
870    Rarely needed, only in some timing sensitive cases.
871    Apparently if this is not done some motherboards seem
872    to kill the firmware and get into the broken state until computer is
873    rebooted. */
874 #define write_sync(val, reg) \
875         do { writel(val, reg); readl(reg); } while (0)
876
877 #define read_reg(reg) readl(itv->reg_mem + (reg))
878 #define write_reg(val, reg) writel(val, itv->reg_mem + (reg))
879 #define write_reg_sync(val, reg) \
880         do { write_reg(val, reg); read_reg(reg); } while (0)
881
882 #define read_enc(addr) readl(itv->enc_mem + (u32)(addr))
883 #define write_enc(val, addr) writel(val, itv->enc_mem + (u32)(addr))
884 #define write_enc_sync(val, addr) \
885         do { write_enc(val, addr); read_enc(addr); } while (0)
886
887 #define read_dec(addr) readl(itv->dec_mem + (u32)(addr))
888 #define write_dec(val, addr) writel(val, itv->dec_mem + (u32)(addr))
889 #define write_dec_sync(val, addr) \
890         do { write_dec(val, addr); read_dec(addr); } while (0)
891
892 #endif /* IVTV_DRIVER_H */