?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
Linux 2.6.34-rc3
[pohmelfs.git] / drivers / media / video / ivtv / ivtv-driver.h
blobe4816da6482b655d9b5be7311a5e1b25cafca036
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/pagemap.h>
53 #include <linux/scatterlist.h>
54 #include <linux/workqueue.h>
55 #include <linux/mutex.h>
56 #include <asm/uaccess.h>
57 #include <asm/system.h>
58 #include <asm/byteorder.h>
59
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/v4l2-device.h>
65 #include <media/tuner.h>
66 #include <media/cx2341x.h>
67 #include <media/ir-kbd-i2c.h>
68
69 #include <linux/ivtv.h>
70
71 /* Memory layout */
72 #define IVTV_ENCODER_OFFSET 0x00000000
73 #define IVTV_ENCODER_SIZE 0x00800000 /* Total size is 0x01000000, but only first half is used */
74 #define IVTV_DECODER_OFFSET 0x01000000
75 #define IVTV_DECODER_SIZE 0x00800000 /* Total size is 0x01000000, but only first half is used */
76 #define IVTV_REG_OFFSET 0x02000000
77 #define IVTV_REG_SIZE 0x00010000
78
79 /* Maximum ivtv driver instances. Some people have a huge number of
80 capture cards, so set this to a high value. */
81 #define IVTV_MAX_CARDS 32
82
83 #define IVTV_ENC_STREAM_TYPE_MPG 0
84 #define IVTV_ENC_STREAM_TYPE_YUV 1
85 #define IVTV_ENC_STREAM_TYPE_VBI 2
86 #define IVTV_ENC_STREAM_TYPE_PCM 3
87 #define IVTV_ENC_STREAM_TYPE_RAD 4
88 #define IVTV_DEC_STREAM_TYPE_MPG 5
89 #define IVTV_DEC_STREAM_TYPE_VBI 6
90 #define IVTV_DEC_STREAM_TYPE_VOUT 7
91 #define IVTV_DEC_STREAM_TYPE_YUV 8
92 #define IVTV_MAX_STREAMS 9
93
94 #define IVTV_DMA_SG_OSD_ENT (2883584/PAGE_SIZE) /* sg entities */
95
96 /* DMA Registers */
97 #define IVTV_REG_DMAXFER (0x0000)
98 #define IVTV_REG_DMASTATUS (0x0004)
99 #define IVTV_REG_DECDMAADDR (0x0008)
100 #define IVTV_REG_ENCDMAADDR (0x000c)
101 #define IVTV_REG_DMACONTROL (0x0010)
102 #define IVTV_REG_IRQSTATUS (0x0040)
103 #define IVTV_REG_IRQMASK (0x0048)
104
105 /* Setup Registers */
106 #define IVTV_REG_ENC_SDRAM_REFRESH (0x07F8)
107 #define IVTV_REG_ENC_SDRAM_PRECHARGE (0x07FC)
108 #define IVTV_REG_DEC_SDRAM_REFRESH (0x08F8)
109 #define IVTV_REG_DEC_SDRAM_PRECHARGE (0x08FC)
110 #define IVTV_REG_VDM (0x2800)
111 #define IVTV_REG_AO (0x2D00)
112 #define IVTV_REG_BYTEFLUSH (0x2D24)
113 #define IVTV_REG_SPU (0x9050)
114 #define IVTV_REG_HW_BLOCKS (0x9054)
115 #define IVTV_REG_VPU (0x9058)
116 #define IVTV_REG_APU (0xA064)
117
118 /* debugging */
119 extern int ivtv_debug;
120
121 #define IVTV_DBGFLG_WARN (1 << 0)
122 #define IVTV_DBGFLG_INFO (1 << 1)
123 #define IVTV_DBGFLG_MB (1 << 2)
124 #define IVTV_DBGFLG_IOCTL (1 << 3)
125 #define IVTV_DBGFLG_FILE (1 << 4)
126 #define IVTV_DBGFLG_DMA (1 << 5)
127 #define IVTV_DBGFLG_IRQ (1 << 6)
128 #define IVTV_DBGFLG_DEC (1 << 7)
129 #define IVTV_DBGFLG_YUV (1 << 8)
130 #define IVTV_DBGFLG_I2C (1 << 9)
131 /* Flag to turn on high volume debugging */
132 #define IVTV_DBGFLG_HIGHVOL (1 << 10)
133
134 #define IVTV_DEBUG(x, type, fmt, args...) \
135 do { \
136 if ((x) & ivtv_debug) \
137 v4l2_info(&itv->v4l2_dev, " " type ": " fmt , ##args); \
138 } while (0)
139 #define IVTV_DEBUG_WARN(fmt, args...) IVTV_DEBUG(IVTV_DBGFLG_WARN, "warn", fmt , ## args)
140 #define IVTV_DEBUG_INFO(fmt, args...) IVTV_DEBUG(IVTV_DBGFLG_INFO, "info", fmt , ## args)
141 #define IVTV_DEBUG_MB(fmt, args...) IVTV_DEBUG(IVTV_DBGFLG_MB, "mb", fmt , ## args)
142 #define IVTV_DEBUG_DMA(fmt, args...) IVTV_DEBUG(IVTV_DBGFLG_DMA, "dma", fmt , ## args)
143 #define IVTV_DEBUG_IOCTL(fmt, args...) IVTV_DEBUG(IVTV_DBGFLG_IOCTL, "ioctl", fmt , ## args)
144 #define IVTV_DEBUG_FILE(fmt, args...) IVTV_DEBUG(IVTV_DBGFLG_FILE, "file", fmt , ## args)
145 #define IVTV_DEBUG_I2C(fmt, args...) IVTV_DEBUG(IVTV_DBGFLG_I2C, "i2c", fmt , ## args)
146 #define IVTV_DEBUG_IRQ(fmt, args...) IVTV_DEBUG(IVTV_DBGFLG_IRQ, "irq", fmt , ## args)
147 #define IVTV_DEBUG_DEC(fmt, args...) IVTV_DEBUG(IVTV_DBGFLG_DEC, "dec", fmt , ## args)
148 #define IVTV_DEBUG_YUV(fmt, args...) IVTV_DEBUG(IVTV_DBGFLG_YUV, "yuv", fmt , ## args)
149
150 #define IVTV_DEBUG_HIGH_VOL(x, type, fmt, args...) \
151 do { \
152 if (((x) & ivtv_debug) && (ivtv_debug & IVTV_DBGFLG_HIGHVOL)) \
153 v4l2_info(&itv->v4l2_dev, " " type ": " fmt , ##args); \
154 } while (0)
155 #define IVTV_DEBUG_HI_WARN(fmt, args...) IVTV_DEBUG_HIGH_VOL(IVTV_DBGFLG_WARN, "warn", fmt , ## args)
156 #define IVTV_DEBUG_HI_INFO(fmt, args...) IVTV_DEBUG_HIGH_VOL(IVTV_DBGFLG_INFO, "info", fmt , ## args)
157 #define IVTV_DEBUG_HI_MB(fmt, args...) IVTV_DEBUG_HIGH_VOL(IVTV_DBGFLG_MB, "mb", fmt , ## args)
158 #define IVTV_DEBUG_HI_DMA(fmt, args...) IVTV_DEBUG_HIGH_VOL(IVTV_DBGFLG_DMA, "dma", fmt , ## args)
159 #define IVTV_DEBUG_HI_IOCTL(fmt, args...) IVTV_DEBUG_HIGH_VOL(IVTV_DBGFLG_IOCTL, "ioctl", fmt , ## args)
160 #define IVTV_DEBUG_HI_FILE(fmt, args...) IVTV_DEBUG_HIGH_VOL(IVTV_DBGFLG_FILE, "file", fmt , ## args)
161 #define IVTV_DEBUG_HI_I2C(fmt, args...) IVTV_DEBUG_HIGH_VOL(IVTV_DBGFLG_I2C, "i2c", fmt , ## args)
162 #define IVTV_DEBUG_HI_IRQ(fmt, args...) IVTV_DEBUG_HIGH_VOL(IVTV_DBGFLG_IRQ, "irq", fmt , ## args)
163 #define IVTV_DEBUG_HI_DEC(fmt, args...) IVTV_DEBUG_HIGH_VOL(IVTV_DBGFLG_DEC, "dec", fmt , ## args)
164 #define IVTV_DEBUG_HI_YUV(fmt, args...) IVTV_DEBUG_HIGH_VOL(IVTV_DBGFLG_YUV, "yuv", fmt , ## args)
165
166 /* Standard kernel messages */
167 #define IVTV_ERR(fmt, args...) v4l2_err(&itv->v4l2_dev, fmt , ## args)
168 #define IVTV_WARN(fmt, args...) v4l2_warn(&itv->v4l2_dev, fmt , ## args)
169 #define IVTV_INFO(fmt, args...) v4l2_info(&itv->v4l2_dev, fmt , ## args)
170
171 /* output modes (cx23415 only) */
172 #define OUT_NONE 0
173 #define OUT_MPG 1
174 #define OUT_YUV 2
175 #define OUT_UDMA_YUV 3
176 #define OUT_PASSTHROUGH 4
177
178 #define IVTV_MAX_PGM_INDEX (400)
179
180 /* Default I2C SCL period in microseconds */
181 #define IVTV_DEFAULT_I2C_CLOCK_PERIOD 20
182
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 */
189 int i2c_clock_period; /* period of SCL for I2C bus */
190 };
191
192 /* ivtv-specific mailbox template */
193 struct ivtv_mailbox {
194 u32 flags;
195 u32 cmd;
196 u32 retval;
197 u32 timeout;
198 u32 data[CX2341X_MBOX_MAX_DATA];
199 };
200
201 struct ivtv_api_cache {
202 unsigned long last_jiffies; /* when last command was issued */
203 u32 data[CX2341X_MBOX_MAX_DATA]; /* last sent api data */
204 };
205
206 struct ivtv_mailbox_data {
207 volatile struct ivtv_mailbox __iomem *mbox;
208 /* Bits 0-2 are for the encoder mailboxes, 0-1 are for the decoder mailboxes.
209 If the bit is set, then the corresponding mailbox is in use by the driver. */
210 unsigned long busy;
211 u8 max_mbox;
212 };
213
214 /* per-buffer bit flags */
215 #define IVTV_F_B_NEED_BUF_SWAP (1 << 0) /* this buffer should be byte swapped */
216
217 /* per-stream, s_flags */
218 #define IVTV_F_S_DMA_PENDING 0 /* this stream has pending DMA */
219 #define IVTV_F_S_DMA_HAS_VBI 1 /* the current DMA request also requests VBI data */
220 #define IVTV_F_S_NEEDS_DATA 2 /* this decoding stream needs more data */
221
222 #define IVTV_F_S_CLAIMED 3 /* this stream is claimed */
223 #define IVTV_F_S_STREAMING 4 /* the fw is decoding/encoding this stream */
224 #define IVTV_F_S_INTERNAL_USE 5 /* this stream is used internally (sliced VBI processing) */
225 #define IVTV_F_S_PASSTHROUGH 6 /* this stream is in passthrough mode */
226 #define IVTV_F_S_STREAMOFF 7 /* signal end of stream EOS */
227 #define IVTV_F_S_APPL_IO 8 /* this stream is used read/written by an application */
228
229 #define IVTV_F_S_PIO_PENDING 9 /* this stream has pending PIO */
230 #define IVTV_F_S_PIO_HAS_VBI 1 /* the current PIO request also requests VBI data */
231
232 /* per-ivtv, i_flags */
233 #define IVTV_F_I_DMA 0 /* DMA in progress */
234 #define IVTV_F_I_UDMA 1 /* UDMA in progress */
235 #define IVTV_F_I_UDMA_PENDING 2 /* UDMA pending */
236 #define IVTV_F_I_SPEED_CHANGE 3 /* a speed change is in progress */
237 #define IVTV_F_I_EOS 4 /* end of encoder stream reached */
238 #define IVTV_F_I_RADIO_USER 5 /* the radio tuner is selected */
239 #define IVTV_F_I_DIG_RST 6 /* reset digitizer */
240 #define IVTV_F_I_DEC_YUV 7 /* YUV instead of MPG is being decoded */
241 #define IVTV_F_I_UPDATE_CC 9 /* CC should be updated */
242 #define IVTV_F_I_UPDATE_WSS 10 /* WSS should be updated */
243 #define IVTV_F_I_UPDATE_VPS 11 /* VPS should be updated */
244 #define IVTV_F_I_DECODING_YUV 12 /* this stream is YUV frame decoding */
245 #define IVTV_F_I_ENC_PAUSED 13 /* the encoder is paused */
246 #define IVTV_F_I_VALID_DEC_TIMINGS 14 /* last_dec_timing is valid */
247 #define IVTV_F_I_HAVE_WORK 15 /* used in the interrupt handler: there is work to be done */
248 #define IVTV_F_I_WORK_HANDLER_VBI 16 /* there is work to be done for VBI */
249 #define IVTV_F_I_WORK_HANDLER_YUV 17 /* there is work to be done for YUV */
250 #define IVTV_F_I_WORK_HANDLER_PIO 18 /* there is work to be done for PIO */
251 #define IVTV_F_I_PIO 19 /* PIO in progress */
252 #define IVTV_F_I_DEC_PAUSED 20 /* the decoder is paused */
253 #define IVTV_F_I_INITED 21 /* set after first open */
254 #define IVTV_F_I_FAILED 22 /* set if first open failed */
255 #define IVTV_F_I_WORK_INITED 23 /* worker thread was initialized */
256
257 /* Event notifications */
258 #define IVTV_F_I_EV_DEC_STOPPED 28 /* decoder stopped event */
259 #define IVTV_F_I_EV_VSYNC 29 /* VSYNC event */
260 #define IVTV_F_I_EV_VSYNC_FIELD 30 /* VSYNC event field (0 = first, 1 = second field) */
261 #define IVTV_F_I_EV_VSYNC_ENABLED 31 /* VSYNC event enabled */
262
263 /* Scatter-Gather array element, used in DMA transfers */
264 struct ivtv_sg_element {
265 __le32 src;
266 __le32 dst;
267 __le32 size;
268 };
269
270 struct ivtv_sg_host_element {
271 u32 src;
272 u32 dst;
273 u32 size;
274 };
275
276 struct ivtv_user_dma {
277 struct mutex lock;
278 int page_count;
279 struct page *map[IVTV_DMA_SG_OSD_ENT];
280 /* Needed when dealing with highmem userspace buffers */
281 struct page *bouncemap[IVTV_DMA_SG_OSD_ENT];
282
283 /* Base Dev SG Array for cx23415/6 */
284 struct ivtv_sg_element SGarray[IVTV_DMA_SG_OSD_ENT];
285 dma_addr_t SG_handle;
286 int SG_length;
287
288 /* SG List of Buffers */
289 struct scatterlist SGlist[IVTV_DMA_SG_OSD_ENT];
290 };
291
292 struct ivtv_dma_page_info {
293 unsigned long uaddr;
294 unsigned long first;
295 unsigned long last;
296 unsigned int offset;
297 unsigned int tail;
298 int page_count;
299 };
300
301 struct ivtv_buffer {
302 struct list_head list;
303 dma_addr_t dma_handle;
304 unsigned short b_flags;
305 unsigned short dma_xfer_cnt;
306 char *buf;
307 u32 bytesused;
308 u32 readpos;
309 };
310
311 struct ivtv_queue {
312 struct list_head list; /* the list of buffers in this queue */
313 u32 buffers; /* number of buffers in this queue */
314 u32 length; /* total number of bytes of available buffer space */
315 u32 bytesused; /* total number of bytes used in this queue */
316 };
317
318 struct ivtv; /* forward reference */
319
320 struct ivtv_stream {
321 /* These first four fields are always set, even if the stream
322 is not actually created. */
323 struct video_device *vdev; /* NULL when stream not created */
324 struct ivtv *itv; /* for ease of use */
325 const char *name; /* name of the stream */
326 int type; /* stream type */
327
328 u32 id;
329 spinlock_t qlock; /* locks access to the queues */
330 unsigned long s_flags; /* status flags, see above */
331 int dma; /* can be PCI_DMA_TODEVICE, PCI_DMA_FROMDEVICE or PCI_DMA_NONE */
332 u32 pending_offset;
333 u32 pending_backup;
334 u64 pending_pts;
335
336 u32 dma_offset;
337 u32 dma_backup;
338 u64 dma_pts;
339
340 int subtype;
341 wait_queue_head_t waitq;
342 u32 dma_last_offset;
343
344 /* Buffer Stats */
345 u32 buffers;
346 u32 buf_size;
347 u32 buffers_stolen;
348
349 /* Buffer Queues */
350 struct ivtv_queue q_free; /* free buffers */
351 struct ivtv_queue q_full; /* full buffers */
352 struct ivtv_queue q_io; /* waiting for I/O */
353 struct ivtv_queue q_dma; /* waiting for DMA */
354 struct ivtv_queue q_predma; /* waiting for DMA */
355
356 /* DMA xfer counter, buffers belonging to the same DMA
357 xfer will have the same dma_xfer_cnt. */
358 u16 dma_xfer_cnt;
359
360 /* Base Dev SG Array for cx23415/6 */
361 struct ivtv_sg_host_element *sg_pending;
362 struct ivtv_sg_host_element *sg_processing;
363 struct ivtv_sg_element *sg_dma;
364 dma_addr_t sg_handle;
365 int sg_pending_size;
366 int sg_processing_size;
367 int sg_processed;
368
369 /* SG List of Buffers */
370 struct scatterlist *SGlist;
371 };
372
373 struct ivtv_open_id {
374 u32 open_id; /* unique ID for this file descriptor */
375 int type; /* stream type */
376 int yuv_frames; /* 1: started OUT_UDMA_YUV output mode */
377 enum v4l2_priority prio; /* priority */
378 struct ivtv *itv;
379 };
380
381 struct yuv_frame_info
382 {
383 u32 update;
384 s32 src_x;
385 s32 src_y;
386 u32 src_w;
387 u32 src_h;
388 s32 dst_x;
389 s32 dst_y;
390 u32 dst_w;
391 u32 dst_h;
392 s32 pan_x;
393 s32 pan_y;
394 u32 vis_w;
395 u32 vis_h;
396 u32 interlaced_y;
397 u32 interlaced_uv;
398 s32 tru_x;
399 u32 tru_w;
400 u32 tru_h;
401 u32 offset_y;
402 s32 lace_mode;
403 u32 sync_field;
404 u32 delay;
405 u32 interlaced;
406 };
407
408 #define IVTV_YUV_MODE_INTERLACED 0x00
409 #define IVTV_YUV_MODE_PROGRESSIVE 0x01
410 #define IVTV_YUV_MODE_AUTO 0x02
411 #define IVTV_YUV_MODE_MASK 0x03
412
413 #define IVTV_YUV_SYNC_EVEN 0x00
414 #define IVTV_YUV_SYNC_ODD 0x04
415 #define IVTV_YUV_SYNC_MASK 0x04
416
417 #define IVTV_YUV_BUFFERS 8
418
419 struct yuv_playback_info
420 {
421 u32 reg_2834;
422 u32 reg_2838;
423 u32 reg_283c;
424 u32 reg_2840;
425 u32 reg_2844;
426 u32 reg_2848;
427 u32 reg_2854;
428 u32 reg_285c;
429 u32 reg_2864;
430
431 u32 reg_2870;
432 u32 reg_2874;
433 u32 reg_2890;
434 u32 reg_2898;
435 u32 reg_289c;
436
437 u32 reg_2918;
438 u32 reg_291c;
439 u32 reg_2920;
440 u32 reg_2924;
441 u32 reg_2928;
442 u32 reg_292c;
443 u32 reg_2930;
444
445 u32 reg_2934;
446
447 u32 reg_2938;
448 u32 reg_293c;
449 u32 reg_2940;
450 u32 reg_2944;
451 u32 reg_2948;
452 u32 reg_294c;
453 u32 reg_2950;
454 u32 reg_2954;
455 u32 reg_2958;
456 u32 reg_295c;
457 u32 reg_2960;
458 u32 reg_2964;
459 u32 reg_2968;
460 u32 reg_296c;
461
462 u32 reg_2970;
463
464 int v_filter_1;
465 int v_filter_2;
466 int h_filter;
467
468 u8 track_osd; /* Should yuv output track the OSD size & position */
469
470 u32 osd_x_offset;
471 u32 osd_y_offset;
472
473 u32 osd_x_pan;
474 u32 osd_y_pan;
475
476 u32 osd_vis_w;
477 u32 osd_vis_h;
478
479 u32 osd_full_w;
480 u32 osd_full_h;
481
482 int decode_height;
483
484 int lace_mode;
485 int lace_threshold;
486 int lace_sync_field;
487
488 atomic_t next_dma_frame;
489 atomic_t next_fill_frame;
490
491 u32 yuv_forced_update;
492 int update_frame;
493
494 u8 fields_lapsed; /* Counter used when delaying a frame */
495
496 struct yuv_frame_info new_frame_info[IVTV_YUV_BUFFERS];
497 struct yuv_frame_info old_frame_info;
498 struct yuv_frame_info old_frame_info_args;
499
500 void *blanking_ptr;
501 dma_addr_t blanking_dmaptr;
502
503 int stream_size;
504
505 u8 draw_frame; /* PVR350 buffer to draw into */
506 u8 max_frames_buffered; /* Maximum number of frames to buffer */
507
508 struct v4l2_rect main_rect;
509 u32 v4l2_src_w;
510 u32 v4l2_src_h;
511
512 u8 running; /* Have any frames been displayed */
513 };
514
515 #define IVTV_VBI_FRAMES 32
516
517 /* VBI data */
518 struct vbi_cc {
519 u8 odd[2]; /* two-byte payload of odd field */
520 u8 even[2]; /* two-byte payload of even field */;
521 };
522
523 struct vbi_vps {
524 u8 data[5]; /* five-byte VPS payload */
525 };
526
527 struct vbi_info {
528 /* VBI general data, does not change during streaming */
529
530 u32 raw_decoder_line_size; /* raw VBI line size from digitizer */
531 u8 raw_decoder_sav_odd_field; /* raw VBI Start Active Video digitizer code of odd field */
532 u8 raw_decoder_sav_even_field; /* raw VBI Start Active Video digitizer code of even field */
533 u32 sliced_decoder_line_size; /* sliced VBI line size from digitizer */
534 u8 sliced_decoder_sav_odd_field; /* sliced VBI Start Active Video digitizer code of odd field */
535 u8 sliced_decoder_sav_even_field; /* sliced VBI Start Active Video digitizer code of even field */
536
537 u32 start[2]; /* start of first VBI line in the odd/even fields */
538 u32 count; /* number of VBI lines per field */
539 u32 raw_size; /* size of raw VBI line from the digitizer */
540 u32 sliced_size; /* size of sliced VBI line from the digitizer */
541
542 u32 dec_start; /* start in decoder memory of VBI re-insertion buffers */
543 u32 enc_start; /* start in encoder memory of VBI capture buffers */
544 u32 enc_size; /* size of VBI capture area */
545 int fpi; /* number of VBI frames per interrupt */
546
547 struct v4l2_format in; /* current VBI capture format */
548 struct v4l2_sliced_vbi_format *sliced_in; /* convenience pointer to sliced struct in vbi.in union */
549 int insert_mpeg; /* if non-zero, then embed VBI data in MPEG stream */
550
551 /* Raw VBI compatibility hack */
552
553 u32 frame; /* frame counter hack needed for backwards compatibility
554 of old VBI software */
555
556 /* Sliced VBI output data */
557
558 struct vbi_cc cc_payload[256]; /* sliced VBI CC payload array: it is an array to
559 prevent dropping CC data if they couldn't be
560 processed fast enough */
561 int cc_payload_idx; /* index in cc_payload */
562 u8 cc_missing_cnt; /* counts number of frames without CC for passthrough mode */
563 int wss_payload; /* sliced VBI WSS payload */
564 u8 wss_missing_cnt; /* counts number of frames without WSS for passthrough mode */
565 struct vbi_vps vps_payload; /* sliced VBI VPS payload */
566
567 /* Sliced VBI capture data */
568
569 struct v4l2_sliced_vbi_data sliced_data[36]; /* sliced VBI storage for VBI encoder stream */
570 struct v4l2_sliced_vbi_data sliced_dec_data[36];/* sliced VBI storage for VBI decoder stream */
571
572 /* VBI Embedding data */
573
574 /* Buffer for VBI data inserted into MPEG stream.
575 The first byte is a dummy byte that's never used.
576 The next 16 bytes contain the MPEG header for the VBI data,
577 the remainder is the actual VBI data.
578 The max size accepted by the MPEG VBI reinsertion turns out
579 to be 1552 bytes, which happens to be 4 + (1 + 42) * (2 * 18) bytes,
580 where 4 is a four byte header, 42 is the max sliced VBI payload, 1 is
581 a single line header byte and 2 * 18 is the number of VBI lines per frame.
582
583 However, it seems that the data must be 1K aligned, so we have to
584 pad the data until the 1 or 2 K boundary.
585
586 This pointer array will allocate 2049 bytes to store each VBI frame. */
587 u8 *sliced_mpeg_data[IVTV_VBI_FRAMES];
588 u32 sliced_mpeg_size[IVTV_VBI_FRAMES];
589 struct ivtv_buffer sliced_mpeg_buf; /* temporary buffer holding data from sliced_mpeg_data */
590 u32 inserted_frame; /* index in sliced_mpeg_size of next sliced data
591 to be inserted in the MPEG stream */
592 };
593
594 /* forward declaration of struct defined in ivtv-cards.h */
595 struct ivtv_card;
596
597 /* Struct to hold info about ivtv cards */
598 struct ivtv {
599 /* General fixed card data */
600 struct pci_dev *pdev; /* PCI device */
601 const struct ivtv_card *card; /* card information */
602 const char *card_name; /* full name of the card */
603 const struct ivtv_card_tuner_i2c *card_i2c; /* i2c addresses to probe for tuner */
604 u8 has_cx23415; /* 1 if it is a cx23415 based card, 0 for cx23416 */
605 u8 pvr150_workaround; /* 1 if the cx25840 needs to workaround a PVR150 bug */
606 u8 nof_inputs; /* number of video inputs */
607 u8 nof_audio_inputs; /* number of audio inputs */
608 u32 v4l2_cap; /* V4L2 capabilities of card */
609 u32 hw_flags; /* hardware description of the board */
610 v4l2_std_id tuner_std; /* the norm of the card's tuner (fixed) */
611 struct v4l2_subdev *sd_video; /* controlling video decoder subdev */
612 struct v4l2_subdev *sd_audio; /* controlling audio subdev */
613 struct v4l2_subdev *sd_muxer; /* controlling audio muxer subdev */
614 u32 base_addr; /* PCI resource base address */
615 volatile void __iomem *enc_mem; /* pointer to mapped encoder memory */
616 volatile void __iomem *dec_mem; /* pointer to mapped decoder memory */
617 volatile void __iomem *reg_mem; /* pointer to mapped registers */
618 struct ivtv_options options; /* user options */
619
620 struct v4l2_device v4l2_dev;
621 struct v4l2_subdev sd_gpio; /* GPIO sub-device */
622 u16 instance;
623
624 /* High-level state info */
625 unsigned long i_flags; /* global ivtv flags */
626 u8 is_50hz; /* 1 if the current capture standard is 50 Hz */
627 u8 is_60hz /* 1 if the current capture standard is 60 Hz */;
628 u8 is_out_50hz /* 1 if the current TV output standard is 50 Hz */;
629 u8 is_out_60hz /* 1 if the current TV output standard is 60 Hz */;
630 int output_mode; /* decoder output mode: NONE, MPG, YUV, UDMA YUV, passthrough */
631 u32 audio_input; /* current audio input */
632 u32 active_input; /* current video input */
633 u32 active_output; /* current video output */
634 v4l2_std_id std; /* current capture TV standard */
635 v4l2_std_id std_out; /* current TV output standard */
636 u8 audio_stereo_mode; /* decoder setting how to handle stereo MPEG audio */
637 u8 audio_bilingual_mode; /* decoder setting how to handle bilingual MPEG audio */
638 struct cx2341x_mpeg_params params; /* current encoder parameters */
639
640
641 /* Locking */
642 spinlock_t lock; /* lock access to this struct */
643 struct mutex serialize_lock; /* mutex used to serialize open/close/start/stop/ioctl operations */
644
645 /* Streams */
646 int stream_buf_size[IVTV_MAX_STREAMS]; /* stream buffer size */
647 struct ivtv_stream streams[IVTV_MAX_STREAMS]; /* stream data */
648 atomic_t capturing; /* count number of active capture streams */
649 atomic_t decoding; /* count number of active decoding streams */
650
651
652 /* Interrupts & DMA */
653 u32 irqmask; /* active interrupts */
654 u32 irq_rr_idx; /* round-robin stream index */
655 struct workqueue_struct *irq_work_queues; /* workqueue for PIO/YUV/VBI actions */
656 struct work_struct irq_work_queue; /* work entry */
657 spinlock_t dma_reg_lock; /* lock access to DMA engine registers */
658 int cur_dma_stream; /* index of current stream doing DMA (-1 if none) */
659 int cur_pio_stream; /* index of current stream doing PIO (-1 if none) */
660 u32 dma_data_req_offset; /* store offset in decoder memory of current DMA request */
661 u32 dma_data_req_size; /* store size of current DMA request */
662 int dma_retries; /* current DMA retry attempt */
663 struct ivtv_user_dma udma; /* user based DMA for OSD */
664 struct timer_list dma_timer; /* timer used to catch unfinished DMAs */
665 u32 last_vsync_field; /* last seen vsync field */
666 wait_queue_head_t dma_waitq; /* wake up when the current DMA is finished */
667 wait_queue_head_t eos_waitq; /* wake up when EOS arrives */
668 wait_queue_head_t event_waitq; /* wake up when the next decoder event arrives */
669 wait_queue_head_t vsync_waitq; /* wake up when the next decoder vsync arrives */
670
671
672 /* Mailbox */
673 struct ivtv_mailbox_data enc_mbox; /* encoder mailboxes */
674 struct ivtv_mailbox_data dec_mbox; /* decoder mailboxes */
675 struct ivtv_api_cache api_cache[256]; /* cached API commands */
676
677
678 /* I2C */
679 struct i2c_adapter i2c_adap;
680 struct i2c_algo_bit_data i2c_algo;
681 struct i2c_client i2c_client;
682 int i2c_state; /* i2c bit state */
683 struct mutex i2c_bus_lock; /* lock i2c bus */
684
685 struct IR_i2c_init_data ir_i2c_init_data;
686
687 /* Program Index information */
688 u32 pgm_info_offset; /* start of pgm info in encoder memory */
689 u32 pgm_info_num; /* number of elements in the pgm cyclic buffer in encoder memory */
690 u32 pgm_info_write_idx; /* last index written by the card that was transferred to pgm_info[] */
691 u32 pgm_info_read_idx; /* last index in pgm_info read by the application */
692 struct v4l2_enc_idx_entry pgm_info[IVTV_MAX_PGM_INDEX]; /* filled from the pgm cyclic buffer on the card */
693
694
695 /* Miscellaneous */
696 u32 open_id; /* incremented each time an open occurs, is >= 1 */
697 struct v4l2_prio_state prio; /* priority state */
698 int search_pack_header; /* 1 if ivtv_copy_buf_to_user() is scanning for a pack header (0xba) */
699 int speed; /* current playback speed setting */
700 u8 speed_mute_audio; /* 1 if audio should be muted when fast forward */
701 u64 mpg_data_received; /* number of bytes received from the MPEG stream */
702 u64 vbi_data_inserted; /* number of VBI bytes inserted into the MPEG stream */
703 u32 last_dec_timing[3]; /* cache last retrieved pts/scr/frame values */
704 unsigned long dualwatch_jiffies;/* jiffies value of the previous dualwatch check */
705 u32 dualwatch_stereo_mode; /* current detected dualwatch stereo mode */
706
707
708 /* VBI state info */
709 struct vbi_info vbi; /* VBI-specific data */
710
711
712 /* YUV playback */
713 struct yuv_playback_info yuv_info; /* YUV playback data */
714
715
716 /* OSD support */
717 unsigned long osd_video_pbase;
718 int osd_global_alpha_state; /* 1 = global alpha is on */
719 int osd_local_alpha_state; /* 1 = local alpha is on */
720 int osd_chroma_key_state; /* 1 = chroma-keying is on */
721 u8 osd_global_alpha; /* current global alpha */
722 u32 osd_chroma_key; /* current chroma key */
723 struct v4l2_rect osd_rect; /* current OSD position and size */
724 struct v4l2_rect main_rect; /* current Main window position and size */
725 struct osd_info *osd_info; /* ivtvfb private OSD info */
726 };
727
728 static inline struct ivtv *to_ivtv(struct v4l2_device *v4l2_dev)
729 {
730 return container_of(v4l2_dev, struct ivtv, v4l2_dev);
731 }
732
733 /* Globals */
734 extern int ivtv_first_minor;
735
736 /*==============Prototypes==================*/
737
738 /* Hardware/IRQ */
739 void ivtv_set_irq_mask(struct ivtv *itv, u32 mask);
740 void ivtv_clear_irq_mask(struct ivtv *itv, u32 mask);
741
742 /* try to set output mode, return current mode. */
743 int ivtv_set_output_mode(struct ivtv *itv, int mode);
744
745 /* return current output stream based on current mode */
746 struct ivtv_stream *ivtv_get_output_stream(struct ivtv *itv);
747
748 /* Return non-zero if a signal is pending */
749 int ivtv_msleep_timeout(unsigned int msecs, int intr);
750
751 /* Wait on queue, returns -EINTR if interrupted */
752 int ivtv_waitq(wait_queue_head_t *waitq);
753
754 /* Read Hauppauge eeprom */
755 struct tveeprom; /* forward reference */
756 void ivtv_read_eeprom(struct ivtv *itv, struct tveeprom *tv);
757
758 /* First-open initialization: load firmware, init cx25840, etc. */
759 int ivtv_init_on_first_open(struct ivtv *itv);
760
761 /* Test if the current VBI mode is raw (1) or sliced (0) */
762 static inline int ivtv_raw_vbi(const struct ivtv *itv)
763 {
764 return itv->vbi.in.type == V4L2_BUF_TYPE_VBI_CAPTURE;
765 }
766
767 /* This is a PCI post thing, where if the pci register is not read, then
768 the write doesn't always take effect right away. By reading back the
769 register any pending PCI writes will be performed (in order), and so
770 you can be sure that the writes are guaranteed to be done.
771
772 Rarely needed, only in some timing sensitive cases.
773 Apparently if this is not done some motherboards seem
774 to kill the firmware and get into the broken state until computer is
775 rebooted. */
776 #define write_sync(val, reg) \
777 do { writel(val, reg); readl(reg); } while (0)
778
779 #define read_reg(reg) readl(itv->reg_mem + (reg))
780 #define write_reg(val, reg) writel(val, itv->reg_mem + (reg))
781 #define write_reg_sync(val, reg) \
782 do { write_reg(val, reg); read_reg(reg); } while (0)
783
784 #define read_enc(addr) readl(itv->enc_mem + (u32)(addr))
785 #define write_enc(val, addr) writel(val, itv->enc_mem + (u32)(addr))
786 #define write_enc_sync(val, addr) \
787 do { write_enc(val, addr); read_enc(addr); } while (0)
788
789 #define read_dec(addr) readl(itv->dec_mem + (u32)(addr))
790 #define write_dec(val, addr) writel(val, itv->dec_mem + (u32)(addr))
791 #define write_dec_sync(val, addr) \
792 do { write_dec(val, addr); read_dec(addr); } while (0)
793
794 /* Call the specified callback for all subdevs matching hw (if 0, then
795 match them all). Ignore any errors. */
796 #define ivtv_call_hw(itv, hw, o, f, args...) \
797 __v4l2_device_call_subdevs(&(itv)->v4l2_dev, !(hw) || (sd->grp_id & (hw)), o, f , ##args)
798
799 #define ivtv_call_all(itv, o, f, args...) ivtv_call_hw(itv, 0, o, f , ##args)
800
801 /* Call the specified callback for all subdevs matching hw (if 0, then
802 match them all). If the callback returns an error other than 0 or
803 -ENOIOCTLCMD, then return with that error code. */
804 #define ivtv_call_hw_err(itv, hw, o, f, args...) \
805 __v4l2_device_call_subdevs_until_err(&(itv)->v4l2_dev, !(hw) || (sd->grp_id & (hw)), o, f , ##args)
806
807 #define ivtv_call_all_err(itv, o, f, args...) ivtv_call_hw_err(itv, 0, o, f , ##args)
808
809 #endif