1 /*
2  *  cx18 driver internal defines and structures
3  *
4  *  Derived from ivtv-driver.h
5  *
6  *  Copyright (C) 2007  Hans Verkuil <hverkuil@xs4all.nl>
7  *  Copyright (C) 2008  Andy Walls <awalls@md.metrocast.net>
8  *
9  *  This program is free software; you can redistribute it and/or modify
10  *  it under the terms of the GNU General Public License as published by
11  *  the Free Software Foundation; either version 2 of the License, or
12  *  (at your option) any later version.
13  *
14  *  This program is distributed in the hope that it will be useful,
15  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
16  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  *  GNU General Public License for more details.
18  *
19  *  You should have received a copy of the GNU General Public License
20  *  along with this program; if not, write to the Free Software
21  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
22  *  02111-1307  USA
23  */
24 
25 #ifndef CX18_DRIVER_H
26 #define CX18_DRIVER_H
27 
28 #include <linux/module.h>
29 #include <linux/moduleparam.h>
30 #include <linux/init.h>
31 #include <linux/delay.h>
32 #include <linux/sched.h>
33 #include <linux/fs.h>
34 #include <linux/pci.h>
35 #include <linux/interrupt.h>
36 #include <linux/spinlock.h>
37 #include <linux/i2c.h>
38 #include <linux/i2c-algo-bit.h>
39 #include <linux/list.h>
40 #include <linux/unistd.h>
41 #include <linux/pagemap.h>
42 #include <linux/workqueue.h>
43 #include <linux/mutex.h>
44 #include <linux/slab.h>
45 #include <asm/byteorder.h>
46 
47 #include <media/v4l2-common.h>
48 #include <media/v4l2-ioctl.h>
49 #include <media/v4l2-device.h>
50 #include <media/v4l2-fh.h>
51 #include <media/tuner.h>
52 #include <media/i2c/ir-kbd-i2c.h>
53 #include "cx18-mailbox.h"
54 #include "cx18-av-core.h"
55 #include "cx23418.h"
56 
57 /* DVB */
58 #include "demux.h"
59 #include "dmxdev.h"
60 #include "dvb_demux.h"
61 #include "dvb_frontend.h"
62 #include "dvb_net.h"
63 #include "dvbdev.h"
64 
65 /* Videobuf / YUV support */
66 #include <media/videobuf-core.h>
67 #include <media/videobuf-vmalloc.h>
68 
69 #ifndef CONFIG_PCI
70 #  error "This driver requires kernel PCI support."
71 #endif
72 
73 #define CX18_MEM_OFFSET	0x00000000
74 #define CX18_MEM_SIZE	0x04000000
75 #define CX18_REG_OFFSET	0x02000000
76 
77 /* Maximum cx18 driver instances. */
78 #define CX18_MAX_CARDS 32
79 
80 /* Supported cards */
81 #define CX18_CARD_HVR_1600_ESMT	      0	/* Hauppauge HVR 1600 (ESMT memory) */
82 #define CX18_CARD_HVR_1600_SAMSUNG    1	/* Hauppauge HVR 1600 (Samsung memory) */
83 #define CX18_CARD_COMPRO_H900 	      2	/* Compro VideoMate H900 */
84 #define CX18_CARD_YUAN_MPC718 	      3	/* Yuan MPC718 */
85 #define CX18_CARD_CNXT_RAPTOR_PAL     4	/* Conexant Raptor PAL */
86 #define CX18_CARD_TOSHIBA_QOSMIO_DVBT 5 /* Toshiba Qosmio Interal DVB-T/Analog*/
87 #define CX18_CARD_LEADTEK_PVR2100     6 /* Leadtek WinFast PVR2100 */
88 #define CX18_CARD_LEADTEK_DVR3100H    7 /* Leadtek WinFast DVR3100 H */
89 #define CX18_CARD_GOTVIEW_PCI_DVD3    8 /* GoTView PCI DVD3 Hybrid */
90 #define CX18_CARD_HVR_1600_S5H1411    9 /* Hauppauge HVR 1600 s5h1411/tda18271*/
91 #define CX18_CARD_LAST		      9
92 
93 #define CX18_ENC_STREAM_TYPE_MPG  0
94 #define CX18_ENC_STREAM_TYPE_TS   1
95 #define CX18_ENC_STREAM_TYPE_YUV  2
96 #define CX18_ENC_STREAM_TYPE_VBI  3
97 #define CX18_ENC_STREAM_TYPE_PCM  4
98 #define CX18_ENC_STREAM_TYPE_IDX  5
99 #define CX18_ENC_STREAM_TYPE_RAD  6
100 #define CX18_MAX_STREAMS	  7
101 
102 /* system vendor and device IDs */
103 #define PCI_VENDOR_ID_CX      0x14f1
104 #define PCI_DEVICE_ID_CX23418 0x5b7a
105 
106 /* subsystem vendor ID */
107 #define CX18_PCI_ID_HAUPPAUGE 		0x0070
108 #define CX18_PCI_ID_COMPRO 		0x185b
109 #define CX18_PCI_ID_YUAN 		0x12ab
110 #define CX18_PCI_ID_CONEXANT		0x14f1
111 #define CX18_PCI_ID_TOSHIBA		0x1179
112 #define CX18_PCI_ID_LEADTEK		0x107D
113 #define CX18_PCI_ID_GOTVIEW		0x5854
114 
115 /* ======================================================================== */
116 /* ========================== START USER SETTABLE DMA VARIABLES =========== */
117 /* ======================================================================== */
118 
119 /* DMA Buffers, Default size in MB allocated */
120 #define CX18_DEFAULT_ENC_TS_BUFFERS  1
121 #define CX18_DEFAULT_ENC_MPG_BUFFERS 2
122 #define CX18_DEFAULT_ENC_IDX_BUFFERS 1
123 #define CX18_DEFAULT_ENC_YUV_BUFFERS 2
124 #define CX18_DEFAULT_ENC_VBI_BUFFERS 1
125 #define CX18_DEFAULT_ENC_PCM_BUFFERS 1
126 
127 /* Maximum firmware DMA buffers per stream */
128 #define CX18_MAX_FW_MDLS_PER_STREAM 63
129 
130 /* YUV buffer sizes in bytes to ensure integer # of frames per buffer */
131 #define CX18_UNIT_ENC_YUV_BUFSIZE	(720 *  32 * 3 / 2) /* bytes */
132 #define CX18_625_LINE_ENC_YUV_BUFSIZE	(CX18_UNIT_ENC_YUV_BUFSIZE * 576/32)
133 #define CX18_525_LINE_ENC_YUV_BUFSIZE	(CX18_UNIT_ENC_YUV_BUFSIZE * 480/32)
134 
135 /* IDX buffer size should be a multiple of the index entry size from the chip */
136 struct cx18_enc_idx_entry {
137 	__le32 length;
138 	__le32 offset_low;
139 	__le32 offset_high;
140 	__le32 flags;
141 	__le32 pts_low;
142 	__le32 pts_high;
143 } __attribute__ ((packed));
144 #define CX18_UNIT_ENC_IDX_BUFSIZE \
145 	(sizeof(struct cx18_enc_idx_entry) * V4L2_ENC_IDX_ENTRIES)
146 
147 /* DMA buffer, default size in kB allocated */
148 #define CX18_DEFAULT_ENC_TS_BUFSIZE   32
149 #define CX18_DEFAULT_ENC_MPG_BUFSIZE  32
150 #define CX18_DEFAULT_ENC_IDX_BUFSIZE  (CX18_UNIT_ENC_IDX_BUFSIZE * 1 / 1024 + 1)
151 #define CX18_DEFAULT_ENC_YUV_BUFSIZE  (CX18_UNIT_ENC_YUV_BUFSIZE * 3 / 1024 + 1)
152 #define CX18_DEFAULT_ENC_PCM_BUFSIZE   4
153 
154 /* i2c stuff */
155 #define I2C_CLIENTS_MAX 16
156 
157 /* debugging */
158 
159 /* Flag to turn on high volume debugging */
160 #define CX18_DBGFLG_WARN  (1 << 0)
161 #define CX18_DBGFLG_INFO  (1 << 1)
162 #define CX18_DBGFLG_API   (1 << 2)
163 #define CX18_DBGFLG_DMA   (1 << 3)
164 #define CX18_DBGFLG_IOCTL (1 << 4)
165 #define CX18_DBGFLG_FILE  (1 << 5)
166 #define CX18_DBGFLG_I2C   (1 << 6)
167 #define CX18_DBGFLG_IRQ   (1 << 7)
168 /* Flag to turn on high volume debugging */
169 #define CX18_DBGFLG_HIGHVOL (1 << 8)
170 
171 /* NOTE: extra space before comma in 'fmt , ## args' is required for
172    gcc-2.95, otherwise it won't compile. */
173 #define CX18_DEBUG(x, type, fmt, args...) \
174 	do { \
175 		if ((x) & cx18_debug) \
176 			v4l2_info(&cx->v4l2_dev, " " type ": " fmt , ## args); \
177 	} while (0)
178 #define CX18_DEBUG_WARN(fmt, args...)  CX18_DEBUG(CX18_DBGFLG_WARN, "warning", fmt , ## args)
179 #define CX18_DEBUG_INFO(fmt, args...)  CX18_DEBUG(CX18_DBGFLG_INFO, "info", fmt , ## args)
180 #define CX18_DEBUG_API(fmt, args...)   CX18_DEBUG(CX18_DBGFLG_API, "api", fmt , ## args)
181 #define CX18_DEBUG_DMA(fmt, args...)   CX18_DEBUG(CX18_DBGFLG_DMA, "dma", fmt , ## args)
182 #define CX18_DEBUG_IOCTL(fmt, args...) CX18_DEBUG(CX18_DBGFLG_IOCTL, "ioctl", fmt , ## args)
183 #define CX18_DEBUG_FILE(fmt, args...)  CX18_DEBUG(CX18_DBGFLG_FILE, "file", fmt , ## args)
184 #define CX18_DEBUG_I2C(fmt, args...)   CX18_DEBUG(CX18_DBGFLG_I2C, "i2c", fmt , ## args)
185 #define CX18_DEBUG_IRQ(fmt, args...)   CX18_DEBUG(CX18_DBGFLG_IRQ, "irq", fmt , ## args)
186 
187 #define CX18_DEBUG_HIGH_VOL(x, type, fmt, args...) \
188 	do { \
189 		if (((x) & cx18_debug) && (cx18_debug & CX18_DBGFLG_HIGHVOL)) \
190 			v4l2_info(&cx->v4l2_dev, " " type ": " fmt , ## args); \
191 	} while (0)
192 #define CX18_DEBUG_HI_WARN(fmt, args...)  CX18_DEBUG_HIGH_VOL(CX18_DBGFLG_WARN, "warning", fmt , ## args)
193 #define CX18_DEBUG_HI_INFO(fmt, args...)  CX18_DEBUG_HIGH_VOL(CX18_DBGFLG_INFO, "info", fmt , ## args)
194 #define CX18_DEBUG_HI_API(fmt, args...)   CX18_DEBUG_HIGH_VOL(CX18_DBGFLG_API, "api", fmt , ## args)
195 #define CX18_DEBUG_HI_DMA(fmt, args...)   CX18_DEBUG_HIGH_VOL(CX18_DBGFLG_DMA, "dma", fmt , ## args)
196 #define CX18_DEBUG_HI_IOCTL(fmt, args...) CX18_DEBUG_HIGH_VOL(CX18_DBGFLG_IOCTL, "ioctl", fmt , ## args)
197 #define CX18_DEBUG_HI_FILE(fmt, args...)  CX18_DEBUG_HIGH_VOL(CX18_DBGFLG_FILE, "file", fmt , ## args)
198 #define CX18_DEBUG_HI_I2C(fmt, args...)   CX18_DEBUG_HIGH_VOL(CX18_DBGFLG_I2C, "i2c", fmt , ## args)
199 #define CX18_DEBUG_HI_IRQ(fmt, args...)   CX18_DEBUG_HIGH_VOL(CX18_DBGFLG_IRQ, "irq", fmt , ## args)
200 
201 /* Standard kernel messages */
202 #define CX18_ERR(fmt, args...)      v4l2_err(&cx->v4l2_dev, fmt , ## args)
203 #define CX18_WARN(fmt, args...)     v4l2_warn(&cx->v4l2_dev, fmt , ## args)
204 #define CX18_INFO(fmt, args...)     v4l2_info(&cx->v4l2_dev, fmt , ## args)
205 
206 /* Messages for internal subdevs to use */
207 #define CX18_DEBUG_DEV(x, dev, type, fmt, args...) \
208 	do { \
209 		if ((x) & cx18_debug) \
210 			v4l2_info(dev, " " type ": " fmt , ## args); \
211 	} while (0)
212 #define CX18_DEBUG_WARN_DEV(dev, fmt, args...) \
213 		CX18_DEBUG_DEV(CX18_DBGFLG_WARN, dev, "warning", fmt , ## args)
214 #define CX18_DEBUG_INFO_DEV(dev, fmt, args...) \
215 		CX18_DEBUG_DEV(CX18_DBGFLG_INFO, dev, "info", fmt , ## args)
216 #define CX18_DEBUG_API_DEV(dev, fmt, args...) \
217 		CX18_DEBUG_DEV(CX18_DBGFLG_API, dev, "api", fmt , ## args)
218 #define CX18_DEBUG_DMA_DEV(dev, fmt, args...) \
219 		CX18_DEBUG_DEV(CX18_DBGFLG_DMA, dev, "dma", fmt , ## args)
220 #define CX18_DEBUG_IOCTL_DEV(dev, fmt, args...) \
221 		CX18_DEBUG_DEV(CX18_DBGFLG_IOCTL, dev, "ioctl", fmt , ## args)
222 #define CX18_DEBUG_FILE_DEV(dev, fmt, args...) \
223 		CX18_DEBUG_DEV(CX18_DBGFLG_FILE, dev, "file", fmt , ## args)
224 #define CX18_DEBUG_I2C_DEV(dev, fmt, args...) \
225 		CX18_DEBUG_DEV(CX18_DBGFLG_I2C, dev, "i2c", fmt , ## args)
226 #define CX18_DEBUG_IRQ_DEV(dev, fmt, args...) \
227 		CX18_DEBUG_DEV(CX18_DBGFLG_IRQ, dev, "irq", fmt , ## args)
228 
229 #define CX18_DEBUG_HIGH_VOL_DEV(x, dev, type, fmt, args...) \
230 	do { \
231 		if (((x) & cx18_debug) && (cx18_debug & CX18_DBGFLG_HIGHVOL)) \
232 			v4l2_info(dev, " " type ": " fmt , ## args); \
233 	} while (0)
234 #define CX18_DEBUG_HI_WARN_DEV(dev, fmt, args...) \
235 	CX18_DEBUG_HIGH_VOL_DEV(CX18_DBGFLG_WARN, dev, "warning", fmt , ## args)
236 #define CX18_DEBUG_HI_INFO_DEV(dev, fmt, args...) \
237 	CX18_DEBUG_HIGH_VOL_DEV(CX18_DBGFLG_INFO, dev, "info", fmt , ## args)
238 #define CX18_DEBUG_HI_API_DEV(dev, fmt, args...) \
239 	CX18_DEBUG_HIGH_VOL_DEV(CX18_DBGFLG_API, dev, "api", fmt , ## args)
240 #define CX18_DEBUG_HI_DMA_DEV(dev, fmt, args...) \
241 	CX18_DEBUG_HIGH_VOL_DEV(CX18_DBGFLG_DMA, dev, "dma", fmt , ## args)
242 #define CX18_DEBUG_HI_IOCTL_DEV(dev, fmt, args...) \
243 	CX18_DEBUG_HIGH_VOL_DEV(CX18_DBGFLG_IOCTL, dev, "ioctl", fmt , ## args)
244 #define CX18_DEBUG_HI_FILE_DEV(dev, fmt, args...) \
245 	CX18_DEBUG_HIGH_VOL_DEV(CX18_DBGFLG_FILE, dev, "file", fmt , ## args)
246 #define CX18_DEBUG_HI_I2C_DEV(dev, fmt, args...) \
247 	CX18_DEBUG_HIGH_VOL_DEV(CX18_DBGFLG_I2C, dev, "i2c", fmt , ## args)
248 #define CX18_DEBUG_HI_IRQ_DEV(dev, fmt, args...) \
249 	CX18_DEBUG_HIGH_VOL_DEV(CX18_DBGFLG_IRQ, dev, "irq", fmt , ## args)
250 
251 #define CX18_ERR_DEV(dev, fmt, args...)      v4l2_err(dev, fmt , ## args)
252 #define CX18_WARN_DEV(dev, fmt, args...)     v4l2_warn(dev, fmt , ## args)
253 #define CX18_INFO_DEV(dev, fmt, args...)     v4l2_info(dev, fmt , ## args)
254 
255 extern int cx18_debug;
256 
257 struct cx18_options {
258 	int megabytes[CX18_MAX_STREAMS]; /* Size in megabytes of each stream */
259 	int cardtype;		/* force card type on load */
260 	int tuner;		/* set tuner on load */
261 	int radio;		/* enable/disable radio */
262 };
263 
264 /* per-mdl bit flags */
265 #define CX18_F_M_NEED_SWAP  0	/* mdl buffer data must be endianness swapped */
266 
267 /* per-stream, s_flags */
268 #define CX18_F_S_CLAIMED 	3	/* this stream is claimed */
269 #define CX18_F_S_STREAMING      4	/* the fw is decoding/encoding this stream */
270 #define CX18_F_S_INTERNAL_USE	5	/* this stream is used internally (sliced VBI processing) */
271 #define CX18_F_S_STREAMOFF	7	/* signal end of stream EOS */
272 #define CX18_F_S_APPL_IO        8	/* this stream is used read/written by an application */
273 #define CX18_F_S_STOPPING	9	/* telling the fw to stop capturing */
274 
275 /* per-cx18, i_flags */
276 #define CX18_F_I_LOADED_FW		0 	/* Loaded firmware 1st time */
277 #define CX18_F_I_EOS			4 	/* End of encoder stream */
278 #define CX18_F_I_RADIO_USER		5 	/* radio tuner is selected */
279 #define CX18_F_I_ENC_PAUSED		13 	/* the encoder is paused */
280 #define CX18_F_I_INITED			21 	/* set after first open */
281 #define CX18_F_I_FAILED			22 	/* set if first open failed */
282 
283 /* These are the VBI types as they appear in the embedded VBI private packets. */
284 #define CX18_SLICED_TYPE_TELETEXT_B     (1)
285 #define CX18_SLICED_TYPE_CAPTION_525    (4)
286 #define CX18_SLICED_TYPE_WSS_625        (5)
287 #define CX18_SLICED_TYPE_VPS            (7)
288 
289 /**
290  * list_entry_is_past_end - check if a previous loop cursor is off list end
291  * @pos:	the type * previously used as a loop cursor.
292  * @head:	the head for your list.
293  * @member:	the name of the list_head within the struct.
294  *
295  * Check if the entry's list_head is the head of the list, thus it's not a
296  * real entry but was the loop cursor that walked past the end
297  */
298 #define list_entry_is_past_end(pos, head, member) \
299 	(&pos->member == (head))
300 
301 struct cx18_buffer {
302 	struct list_head list;
303 	dma_addr_t dma_handle;
304 	char *buf;
305 
306 	u32 bytesused;
307 	u32 readpos;
308 };
309 
310 struct cx18_mdl {
311 	struct list_head list;
312 	u32 id;		/* index into cx->scb->cpu_mdl[] of 1st cx18_mdl_ent */
313 
314 	unsigned int skipped;
315 	unsigned long m_flags;
316 
317 	struct list_head buf_list;
318 	struct cx18_buffer *curr_buf; /* current buffer in list for reading */
319 
320 	u32 bytesused;
321 	u32 readpos;
322 };
323 
324 struct cx18_queue {
325 	struct list_head list;
326 	atomic_t depth;
327 	u32 bytesused;
328 	spinlock_t lock;
329 };
330 
331 struct cx18_stream; /* forward reference */
332 
333 struct cx18_dvb {
334 	struct cx18_stream *stream;
335 	struct dmx_frontend hw_frontend;
336 	struct dmx_frontend mem_frontend;
337 	struct dmxdev dmxdev;
338 	struct dvb_adapter dvb_adapter;
339 	struct dvb_demux demux;
340 	struct dvb_frontend *fe;
341 	struct dvb_net dvbnet;
342 	int enabled;
343 	int feeding;
344 	struct mutex feedlock;
345 };
346 
347 struct cx18;	 /* forward reference */
348 struct cx18_scb; /* forward reference */
349 
350 
351 #define CX18_MAX_MDL_ACKS 2
352 #define CX18_MAX_IN_WORK_ORDERS (CX18_MAX_FW_MDLS_PER_STREAM + 7)
353 /* CPU_DE_RELEASE_MDL can burst CX18_MAX_FW_MDLS_PER_STREAM orders in a group */
354 
355 #define CX18_F_EWO_MB_STALE_UPON_RECEIPT 0x1
356 #define CX18_F_EWO_MB_STALE_WHILE_PROC   0x2
357 #define CX18_F_EWO_MB_STALE \
358 	     (CX18_F_EWO_MB_STALE_UPON_RECEIPT | CX18_F_EWO_MB_STALE_WHILE_PROC)
359 
360 struct cx18_in_work_order {
361 	struct work_struct work;
362 	atomic_t pending;
363 	struct cx18 *cx;
364 	unsigned long flags;
365 	int rpu;
366 	struct cx18_mailbox mb;
367 	struct cx18_mdl_ack mdl_ack[CX18_MAX_MDL_ACKS];
368 	char *str;
369 };
370 
371 #define CX18_INVALID_TASK_HANDLE 0xffffffff
372 
373 struct cx18_stream {
374 	/* These first five fields are always set, even if the stream
375 	   is not actually created. */
376 	struct video_device video_dev;	/* v4l2_dev is NULL when stream not created */
377 	struct cx18_dvb *dvb;		/* DVB / Digital Transport */
378 	struct cx18 *cx; 		/* for ease of use */
379 	const char *name;		/* name of the stream */
380 	int type;			/* stream type */
381 	u32 handle;			/* task handle */
382 	u32 v4l2_dev_caps;		/* device capabilities */
383 	unsigned int mdl_base_idx;
384 
385 	u32 id;
386 	unsigned long s_flags;	/* status flags, see above */
387 	int dma;		/* can be PCI_DMA_TODEVICE,
388 				   PCI_DMA_FROMDEVICE or
389 				   PCI_DMA_NONE */
390 	wait_queue_head_t waitq;
391 
392 	/* Buffers */
393 	struct list_head buf_pool;	/* buffers not attached to an MDL */
394 	u32 buffers;			/* total buffers owned by this stream */
395 	u32 buf_size;			/* size in bytes of a single buffer */
396 
397 	/* MDL sizes - all stream MDLs are the same size */
398 	u32 bufs_per_mdl;
399 	u32 mdl_size;		/* total bytes in all buffers in a mdl */
400 
401 	/* MDL Queues */
402 	struct cx18_queue q_free;	/* free - in rotation, not committed */
403 	struct cx18_queue q_busy;	/* busy - in use by firmware */
404 	struct cx18_queue q_full;	/* full - data for user apps */
405 	struct cx18_queue q_idle;	/* idle - not in rotation */
406 
407 	struct work_struct out_work_order;
408 
409 	/* Videobuf for YUV video */
410 	u32 pixelformat;
411 	u32 vb_bytes_per_frame;
412 	u32 vb_bytes_per_line;
413 	struct list_head vb_capture;    /* video capture queue */
414 	spinlock_t vb_lock;
415 	struct timer_list vb_timeout;
416 
417 	struct videobuf_queue vbuf_q;
418 	spinlock_t vbuf_q_lock; /* Protect vbuf_q */
419 	enum v4l2_buf_type vb_type;
420 };
421 
422 struct cx18_videobuf_buffer {
423 	/* Common video buffer sub-system struct */
424 	struct videobuf_buffer vb;
425 	v4l2_std_id tvnorm; /* selected tv norm */
426 	u32 bytes_used;
427 };
428 
429 struct cx18_open_id {
430 	struct v4l2_fh fh;
431 	u32 open_id;
432 	int type;
433 	struct cx18 *cx;
434 };
435 
436 static inline struct cx18_open_id *fh2id(struct v4l2_fh *fh)
437 {
438 	return container_of(fh, struct cx18_open_id, fh);
439 }
440 
441 static inline struct cx18_open_id *file2id(struct file *file)
442 {
443 	return fh2id(file->private_data);
444 }
445 
446 /* forward declaration of struct defined in cx18-cards.h */
447 struct cx18_card;
448 
449 /*
450  * A note about "sliced" VBI data as implemented in this driver:
451  *
452  * Currently we collect the sliced VBI in the form of Ancillary Data
453  * packets, inserted by the AV core decoder/digitizer/slicer in the
454  * horizontal blanking region of the VBI lines, in "raw" mode as far as
455  * the Encoder is concerned.  We don't ever tell the Encoder itself
456  * to provide sliced VBI. (AV Core: sliced mode - Encoder: raw mode)
457  *
458  * We then process the ancillary data ourselves to send the sliced data
459  * to the user application directly or build up MPEG-2 private stream 1
460  * packets to splice into (only!) MPEG-2 PS streams for the user app.
461  *
462  * (That's how ivtv essentially does it.)
463  *
464  * The Encoder should be able to extract certain sliced VBI data for
465  * us and provide it in a separate stream or splice it into any type of
466  * MPEG PS or TS stream, but this isn't implemented yet.
467  */
468 
469 /*
470  * Number of "raw" VBI samples per horizontal line we tell the Encoder to
471  * grab from the decoder/digitizer/slicer output for raw or sliced VBI.
472  * It depends on the pixel clock and the horiz rate:
473  *
474  * (1/Fh)*(2*Fp) = Samples/line
475  *     = 4 bytes EAV + Anc data in hblank + 4 bytes SAV + active samples
476  *
477  *  Sliced VBI data is sent as ancillary data during horizontal blanking
478  *  Raw VBI is sent as active video samples during vertcal blanking
479  *
480  *  We use a  BT.656 pxiel clock of 13.5 MHz and a BT.656 active line
481  *  length of 720 pixels @ 4:2:2 sampling.  Thus...
482  *
483  *  For systems that use a 15.734 kHz horizontal rate, such as
484  *  NTSC-M, PAL-M, PAL-60, and other 60 Hz/525 line systems, we have:
485  *
486  *  (1/15.734 kHz) * 2 * 13.5 MHz = 1716 samples/line =
487  *  4 bytes SAV + 268 bytes anc data + 4 bytes SAV + 1440 active samples
488  *
489  *  For systems that use a 15.625 kHz horizontal rate, such as
490  *  PAL-B/G/H, PAL-I, SECAM-L and other 50 Hz/625 line systems, we have:
491  *
492  *  (1/15.625 kHz) * 2 * 13.5 MHz = 1728 samples/line =
493  *  4 bytes SAV + 280 bytes anc data + 4 bytes SAV + 1440 active samples
494  */
495 static const u32 vbi_active_samples = 1444; /* 4 byte SAV + 720 Y + 720 U/V */
496 static const u32 vbi_hblank_samples_60Hz = 272; /* 4 byte EAV + 268 anc/fill */
497 static const u32 vbi_hblank_samples_50Hz = 284; /* 4 byte EAV + 280 anc/fill */
498 
499 #define CX18_VBI_FRAMES 32
500 
501 struct vbi_info {
502 	/* Current state of v4l2 VBI settings for this device */
503 	struct v4l2_format in;
504 	struct v4l2_sliced_vbi_format *sliced_in; /* pointer to in.fmt.sliced */
505 	u32 count;    /* Count of VBI data lines: 60 Hz: 12 or 50 Hz: 18 */
506 	u32 start[2]; /* First VBI data line per field: 10 & 273 or 6 & 318 */
507 
508 	u32 frame; /* Count of VBI buffers/frames received from Encoder */
509 
510 	/*
511 	 * Vars for creation and insertion of MPEG Private Stream 1 packets
512 	 * of sliced VBI data into an MPEG PS
513 	 */
514 
515 	/* Boolean: create and insert Private Stream 1 packets into the PS */
516 	int insert_mpeg;
517 
518 	/*
519 	 * Buffer for the maximum of 2 * 18 * packet_size sliced VBI lines.
520 	 * Used in cx18-vbi.c only for collecting sliced data, and as a source
521 	 * during conversion of sliced VBI data into MPEG Priv Stream 1 packets.
522 	 * We don't need to save state here, but the array may have been a bit
523 	 * too big (2304 bytes) to alloc from the stack.
524 	 */
525 	struct v4l2_sliced_vbi_data sliced_data[36];
526 
527 	/*
528 	 * A ring buffer of driver-generated MPEG-2 PS
529 	 * Program Pack/Private Stream 1 packets for sliced VBI data insertion
530 	 * into the MPEG PS stream.
531 	 *
532 	 * In each sliced_mpeg_data[] buffer is:
533 	 * 	16 byte MPEG-2 PS Program Pack Header
534 	 * 	16 byte MPEG-2 Private Stream 1 PES Header
535 	 * 	 4 byte magic number: "itv0" or "ITV0"
536 	 * 	 4 byte first  field line mask, if "itv0"
537 	 * 	 4 byte second field line mask, if "itv0"
538 	 * 	36 lines, if "ITV0"; or <36 lines, if "itv0"; of sliced VBI data
539 	 *
540 	 * 	Each line in the payload is
541 	 *	 1 byte line header derived from the SDID (WSS, CC, VPS, etc.)
542 	 *	42 bytes of line data
543 	 *
544 	 * That's a maximum 1552 bytes of payload in the Private Stream 1 packet
545 	 * which is the payload size a PVR-350 (CX23415) MPEG decoder will
546 	 * accept for VBI data. So, including the headers, it's a maximum 1584
547 	 * bytes total.
548 	 */
549 #define CX18_SLICED_MPEG_DATA_MAXSZ	1584
550 	/* copy_vbi_buf() needs 8 temp bytes on the end for the worst case */
551 #define CX18_SLICED_MPEG_DATA_BUFSZ	(CX18_SLICED_MPEG_DATA_MAXSZ+8)
552 	u8 *sliced_mpeg_data[CX18_VBI_FRAMES];
553 	u32 sliced_mpeg_size[CX18_VBI_FRAMES];
554 
555 	/* Count of Program Pack/Program Stream 1 packets inserted into PS */
556 	u32 inserted_frame;
557 
558 	/*
559 	 * A dummy driver stream transfer mdl & buffer with a copy of the next
560 	 * sliced_mpeg_data[] buffer for output to userland apps.
561 	 * Only used in cx18-fileops.c, but its state needs to persist at times.
562 	 */
563 	struct cx18_mdl sliced_mpeg_mdl;
564 	struct cx18_buffer sliced_mpeg_buf;
565 };
566 
567 /* Per cx23418, per I2C bus private algo callback data */
568 struct cx18_i2c_algo_callback_data {
569 	struct cx18 *cx;
570 	int bus_index;   /* 0 or 1 for the cx23418's 1st or 2nd I2C bus */
571 };
572 
573 #define CX18_MAX_MMIO_WR_RETRIES 10
574 
575 /* Struct to hold info about cx18 cards */
576 struct cx18 {
577 	int instance;
578 	struct pci_dev *pci_dev;
579 	struct v4l2_device v4l2_dev;
580 	struct v4l2_subdev *sd_av;     /* A/V decoder/digitizer sub-device */
581 	struct v4l2_subdev *sd_extmux; /* External multiplexer sub-dev */
582 
583 	const struct cx18_card *card;	/* card information */
584 	const char *card_name;  /* full name of the card */
585 	const struct cx18_card_tuner_i2c *card_i2c; /* i2c addresses to probe for tuner */
586 	u8 is_50hz;
587 	u8 is_60hz;
588 	u8 nof_inputs;		/* number of video inputs */
589 	u8 nof_audio_inputs;	/* number of audio inputs */
590 	u32 v4l2_cap;		/* V4L2 capabilities of card */
591 	u32 hw_flags; 		/* Hardware description of the board */
592 	unsigned int free_mdl_idx;
593 	struct cx18_scb __iomem *scb; /* pointer to SCB */
594 	struct mutex epu2apu_mb_lock; /* protect driver to chip mailbox in SCB*/
595 	struct mutex epu2cpu_mb_lock; /* protect driver to chip mailbox in SCB*/
596 
597 	struct cx18_av_state av_state;
598 
599 	/* codec settings */
600 	struct cx2341x_handler cxhdl;
601 	u32 filter_mode;
602 	u32 temporal_strength;
603 	u32 spatial_strength;
604 
605 	/* dualwatch */
606 	unsigned long dualwatch_jiffies;
607 	u32 dualwatch_stereo_mode;
608 
609 	struct mutex serialize_lock;    /* mutex used to serialize open/close/start/stop/ioctl operations */
610 	struct cx18_options options; 	/* User options */
611 	int stream_buffers[CX18_MAX_STREAMS]; /* # of buffers for each stream */
612 	int stream_buf_size[CX18_MAX_STREAMS]; /* Stream buffer size */
613 	struct cx18_stream streams[CX18_MAX_STREAMS]; 	/* Stream data */
614 	struct snd_cx18_card *alsa; /* ALSA interface for PCM capture stream */
615 	void (*pcm_announce_callback)(struct snd_cx18_card *card, u8 *pcm_data,
616 				      size_t num_bytes);
617 
618 	unsigned long i_flags;  /* global cx18 flags */
619 	atomic_t ana_capturing;	/* count number of active analog capture streams */
620 	atomic_t tot_capturing;	/* total count number of active capture streams */
621 	int search_pack_header;
622 
623 	int open_id;		/* incremented each time an open occurs, used as
624 				   unique ID. Starts at 1, so 0 can be used as
625 				   uninitialized value in the stream->id. */
626 
627 	resource_size_t base_addr;
628 
629 	u8 card_rev;
630 	void __iomem *enc_mem, *reg_mem;
631 
632 	struct vbi_info vbi;
633 
634 	u64 mpg_data_received;
635 	u64 vbi_data_inserted;
636 
637 	wait_queue_head_t mb_apu_waitq;
638 	wait_queue_head_t mb_cpu_waitq;
639 	wait_queue_head_t cap_w;
640 	/* when the current DMA is finished this queue is woken up */
641 	wait_queue_head_t dma_waitq;
642 
643 	u32 sw1_irq_mask;
644 	u32 sw2_irq_mask;
645 	u32 hw2_irq_mask;
646 
647 	struct workqueue_struct *in_work_queue;
648 	char in_workq_name[11]; /* "cx18-NN-in" */
649 	struct cx18_in_work_order in_work_order[CX18_MAX_IN_WORK_ORDERS];
650 	char epu_debug_str[256]; /* CX18_EPU_DEBUG is rare: use shared space */
651 
652 	/* i2c */
653 	struct i2c_adapter i2c_adap[2];
654 	struct i2c_algo_bit_data i2c_algo[2];
655 	struct cx18_i2c_algo_callback_data i2c_algo_cb_data[2];
656 
657 	struct IR_i2c_init_data ir_i2c_init_data;
658 
659 	/* gpio */
660 	u32 gpio_dir;
661 	u32 gpio_val;
662 	struct mutex gpio_lock;
663 	struct v4l2_subdev sd_gpiomux;
664 	struct v4l2_subdev sd_resetctrl;
665 
666 	/* v4l2 and User settings */
667 
668 	/* codec settings */
669 	u32 audio_input;
670 	u32 active_input;
671 	v4l2_std_id std;
672 	v4l2_std_id tuner_std;	/* The norm of the tuner (fixed) */
673 
674 	/* Used for cx18-alsa module loading */
675 	struct work_struct request_module_wk;
676 };
677 
678 static inline struct cx18 *to_cx18(struct v4l2_device *v4l2_dev)
679 {
680 	return container_of(v4l2_dev, struct cx18, v4l2_dev);
681 }
682 
683 /* cx18 extensions to be loaded */
684 extern int (*cx18_ext_init)(struct cx18 *);
685 
686 /* Globals */
687 extern int cx18_first_minor;
688 
689 /*==============Prototypes==================*/
690 
691 /* Return non-zero if a signal is pending */
692 int cx18_msleep_timeout(unsigned int msecs, int intr);
693 
694 /* Read Hauppauge eeprom */
695 struct tveeprom; /* forward reference */
696 void cx18_read_eeprom(struct cx18 *cx, struct tveeprom *tv);
697 
698 /* First-open initialization: load firmware, etc. */
699 int cx18_init_on_first_open(struct cx18 *cx);
700 
701 /* Test if the current VBI mode is raw (1) or sliced (0) */
702 static inline int cx18_raw_vbi(const struct cx18 *cx)
703 {
704 	return cx->vbi.in.type == V4L2_BUF_TYPE_VBI_CAPTURE;
705 }
706 
707 /* Call the specified callback for all subdevs with a grp_id bit matching the
708  * mask in hw (if 0, then match them all). Ignore any errors. */
709 #define cx18_call_hw(cx, hw, o, f, args...)				\
710 	v4l2_device_mask_call_all(&(cx)->v4l2_dev, hw, o, f, ##args)
711 
712 #define cx18_call_all(cx, o, f, args...) cx18_call_hw(cx, 0, o, f , ##args)
713 
714 /* Call the specified callback for all subdevs with a grp_id bit matching the
715  * mask in hw (if 0, then match them all). If the callback returns an error
716  * other than 0 or -ENOIOCTLCMD, then return with that error code. */
717 #define cx18_call_hw_err(cx, hw, o, f, args...)				\
718 	v4l2_device_mask_call_until_err(&(cx)->v4l2_dev, hw, o, f, ##args)
719 
720 #define cx18_call_all_err(cx, o, f, args...) \
721 	cx18_call_hw_err(cx, 0, o, f , ##args)
722 
723 #endif /* CX18_DRIVER_H */
724