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