blob: 9ee608063b495d8e67e11fca2070463c3831aa50 [file] [log] [blame]
Hans Verkuil1c1e45d2008-04-28 20:24:33 -03001/*
2 * cx18 driver internal defines and structures
3 *
4 * Derived from ivtv-driver.h
5 *
6 * Copyright (C) 2007 Hans Verkuil <hverkuil@xs4all.nl>
Andy Walls1ed9dcc2008-11-22 01:37:34 -03007 * Copyright (C) 2008 Andy Walls <awalls@radix.net>
Hans Verkuil1c1e45d2008-04-28 20:24:33 -03008 *
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/version.h>
29#include <linux/module.h>
30#include <linux/moduleparam.h>
31#include <linux/init.h>
32#include <linux/delay.h>
33#include <linux/sched.h>
34#include <linux/fs.h>
35#include <linux/pci.h>
36#include <linux/interrupt.h>
37#include <linux/spinlock.h>
38#include <linux/i2c.h>
39#include <linux/i2c-algo-bit.h>
40#include <linux/list.h>
41#include <linux/unistd.h>
Hans Verkuil1c1e45d2008-04-28 20:24:33 -030042#include <linux/pagemap.h>
43#include <linux/workqueue.h>
44#include <linux/mutex.h>
Harvey Harrison1a651a02008-10-18 20:28:37 -070045#include <asm/byteorder.h>
Hans Verkuil1c1e45d2008-04-28 20:24:33 -030046
47#include <linux/dvb/video.h>
48#include <linux/dvb/audio.h>
49#include <media/v4l2-common.h>
Hans Verkuil35ea11f2008-07-20 08:12:02 -030050#include <media/v4l2-ioctl.h>
Andy Walls888cdb02009-01-11 15:08:53 -030051#include <media/v4l2-device.h>
Hans Verkuil1c1e45d2008-04-28 20:24:33 -030052#include <media/tuner.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#ifndef CONFIG_PCI
66# error "This driver requires kernel PCI support."
67#endif
68
69#define CX18_MEM_OFFSET 0x00000000
70#define CX18_MEM_SIZE 0x04000000
71#define CX18_REG_OFFSET 0x02000000
72
73/* Maximum cx18 driver instances. */
74#define CX18_MAX_CARDS 32
75
76/* Supported cards */
77#define CX18_CARD_HVR_1600_ESMT 0 /* Hauppauge HVR 1600 (ESMT memory) */
78#define CX18_CARD_HVR_1600_SAMSUNG 1 /* Hauppauge HVR 1600 (Samsung memory) */
79#define CX18_CARD_COMPRO_H900 2 /* Compro VideoMate H900 */
80#define CX18_CARD_YUAN_MPC718 3 /* Yuan MPC718 */
Sri Deevi03c28082008-06-21 11:06:44 -030081#define CX18_CARD_CNXT_RAPTOR_PAL 4 /* Conexant Raptor PAL */
Andy Walls9eee4fb2008-10-04 20:28:40 -030082#define CX18_CARD_TOSHIBA_QOSMIO_DVBT 5 /* Toshiba Qosmio Interal DVB-T/Analog*/
Andy Walls6ce9ee52009-01-19 18:31:22 -030083#define CX18_CARD_LEADTEK_PVR2100 6 /* Leadtek WinFast PVR2100/DVR3100 H */
Andy Walls9eee4fb2008-10-04 20:28:40 -030084#define CX18_CARD_LAST 6
Hans Verkuil1c1e45d2008-04-28 20:24:33 -030085
86#define CX18_ENC_STREAM_TYPE_MPG 0
87#define CX18_ENC_STREAM_TYPE_TS 1
88#define CX18_ENC_STREAM_TYPE_YUV 2
89#define CX18_ENC_STREAM_TYPE_VBI 3
90#define CX18_ENC_STREAM_TYPE_PCM 4
91#define CX18_ENC_STREAM_TYPE_IDX 5
92#define CX18_ENC_STREAM_TYPE_RAD 6
93#define CX18_MAX_STREAMS 7
94
95/* system vendor and device IDs */
96#define PCI_VENDOR_ID_CX 0x14f1
97#define PCI_DEVICE_ID_CX23418 0x5b7a
98
99/* subsystem vendor ID */
100#define CX18_PCI_ID_HAUPPAUGE 0x0070
101#define CX18_PCI_ID_COMPRO 0x185b
102#define CX18_PCI_ID_YUAN 0x12ab
Sri Deevi03c28082008-06-21 11:06:44 -0300103#define CX18_PCI_ID_CONEXANT 0x14f1
Andy Walls9eee4fb2008-10-04 20:28:40 -0300104#define CX18_PCI_ID_TOSHIBA 0x1179
105#define CX18_PCI_ID_LEADTEK 0x107D
Hans Verkuil1c1e45d2008-04-28 20:24:33 -0300106
107/* ======================================================================== */
108/* ========================== START USER SETTABLE DMA VARIABLES =========== */
109/* ======================================================================== */
110
111/* DMA Buffers, Default size in MB allocated */
112#define CX18_DEFAULT_ENC_TS_BUFFERS 1
113#define CX18_DEFAULT_ENC_MPG_BUFFERS 2
114#define CX18_DEFAULT_ENC_IDX_BUFFERS 1
115#define CX18_DEFAULT_ENC_YUV_BUFFERS 2
116#define CX18_DEFAULT_ENC_VBI_BUFFERS 1
117#define CX18_DEFAULT_ENC_PCM_BUFFERS 1
118
Andy Walls6ecd86d2008-12-07 23:30:17 -0300119/* Maximum firmware DMA buffers per stream */
Andy Walls0ef02892008-12-14 18:52:12 -0300120#define CX18_MAX_FW_MDLS_PER_STREAM 63
Andy Walls6ecd86d2008-12-07 23:30:17 -0300121
122/* DMA buffer, default size in kB allocated */
123#define CX18_DEFAULT_ENC_TS_BUFSIZE 32
124#define CX18_DEFAULT_ENC_MPG_BUFSIZE 32
125#define CX18_DEFAULT_ENC_IDX_BUFSIZE 32
126#define CX18_DEFAULT_ENC_YUV_BUFSIZE 128
127/* Default VBI bufsize based on standards supported by card tuner for now */
128#define CX18_DEFAULT_ENC_PCM_BUFSIZE 4
129
Hans Verkuil1c1e45d2008-04-28 20:24:33 -0300130/* i2c stuff */
131#define I2C_CLIENTS_MAX 16
132
133/* debugging */
134
135/* Flag to turn on high volume debugging */
136#define CX18_DBGFLG_WARN (1 << 0)
137#define CX18_DBGFLG_INFO (1 << 1)
138#define CX18_DBGFLG_API (1 << 2)
139#define CX18_DBGFLG_DMA (1 << 3)
140#define CX18_DBGFLG_IOCTL (1 << 4)
141#define CX18_DBGFLG_FILE (1 << 5)
142#define CX18_DBGFLG_I2C (1 << 6)
143#define CX18_DBGFLG_IRQ (1 << 7)
144/* Flag to turn on high volume debugging */
145#define CX18_DBGFLG_HIGHVOL (1 << 8)
146
Andy Walls5811cf92009-02-14 17:08:37 -0300147/* NOTE: extra space before comma in 'fmt , ## args' is required for
Hans Verkuil1c1e45d2008-04-28 20:24:33 -0300148 gcc-2.95, otherwise it won't compile. */
149#define CX18_DEBUG(x, type, fmt, args...) \
150 do { \
151 if ((x) & cx18_debug) \
Andy Walls5811cf92009-02-14 17:08:37 -0300152 v4l2_info(&cx->v4l2_dev, " " type ": " fmt , ## args); \
Hans Verkuil1c1e45d2008-04-28 20:24:33 -0300153 } while (0)
154#define CX18_DEBUG_WARN(fmt, args...) CX18_DEBUG(CX18_DBGFLG_WARN, "warning", fmt , ## args)
155#define CX18_DEBUG_INFO(fmt, args...) CX18_DEBUG(CX18_DBGFLG_INFO, "info", fmt , ## args)
156#define CX18_DEBUG_API(fmt, args...) CX18_DEBUG(CX18_DBGFLG_API, "api", fmt , ## args)
157#define CX18_DEBUG_DMA(fmt, args...) CX18_DEBUG(CX18_DBGFLG_DMA, "dma", fmt , ## args)
158#define CX18_DEBUG_IOCTL(fmt, args...) CX18_DEBUG(CX18_DBGFLG_IOCTL, "ioctl", fmt , ## args)
159#define CX18_DEBUG_FILE(fmt, args...) CX18_DEBUG(CX18_DBGFLG_FILE, "file", fmt , ## args)
160#define CX18_DEBUG_I2C(fmt, args...) CX18_DEBUG(CX18_DBGFLG_I2C, "i2c", fmt , ## args)
161#define CX18_DEBUG_IRQ(fmt, args...) CX18_DEBUG(CX18_DBGFLG_IRQ, "irq", fmt , ## args)
162
163#define CX18_DEBUG_HIGH_VOL(x, type, fmt, args...) \
164 do { \
165 if (((x) & cx18_debug) && (cx18_debug & CX18_DBGFLG_HIGHVOL)) \
Andy Walls5811cf92009-02-14 17:08:37 -0300166 v4l2_info(&cx->v4l2_dev, " " type ": " fmt , ## args); \
Hans Verkuil1c1e45d2008-04-28 20:24:33 -0300167 } while (0)
168#define CX18_DEBUG_HI_WARN(fmt, args...) CX18_DEBUG_HIGH_VOL(CX18_DBGFLG_WARN, "warning", fmt , ## args)
169#define CX18_DEBUG_HI_INFO(fmt, args...) CX18_DEBUG_HIGH_VOL(CX18_DBGFLG_INFO, "info", fmt , ## args)
170#define CX18_DEBUG_HI_API(fmt, args...) CX18_DEBUG_HIGH_VOL(CX18_DBGFLG_API, "api", fmt , ## args)
171#define CX18_DEBUG_HI_DMA(fmt, args...) CX18_DEBUG_HIGH_VOL(CX18_DBGFLG_DMA, "dma", fmt , ## args)
172#define CX18_DEBUG_HI_IOCTL(fmt, args...) CX18_DEBUG_HIGH_VOL(CX18_DBGFLG_IOCTL, "ioctl", fmt , ## args)
173#define CX18_DEBUG_HI_FILE(fmt, args...) CX18_DEBUG_HIGH_VOL(CX18_DBGFLG_FILE, "file", fmt , ## args)
174#define CX18_DEBUG_HI_I2C(fmt, args...) CX18_DEBUG_HIGH_VOL(CX18_DBGFLG_I2C, "i2c", fmt , ## args)
175#define CX18_DEBUG_HI_IRQ(fmt, args...) CX18_DEBUG_HIGH_VOL(CX18_DBGFLG_IRQ, "irq", fmt , ## args)
176
177/* Standard kernel messages */
Andy Walls5811cf92009-02-14 17:08:37 -0300178#define CX18_ERR(fmt, args...) v4l2_err(&cx->v4l2_dev, fmt , ## args)
179#define CX18_WARN(fmt, args...) v4l2_warn(&cx->v4l2_dev, fmt , ## args)
180#define CX18_INFO(fmt, args...) v4l2_info(&cx->v4l2_dev, fmt , ## args)
Hans Verkuil1c1e45d2008-04-28 20:24:33 -0300181
182/* Values for CX18_API_DEC_PLAYBACK_SPEED mpeg_frame_type_mask parameter: */
183#define MPEG_FRAME_TYPE_IFRAME 1
184#define MPEG_FRAME_TYPE_IFRAME_PFRAME 3
185#define MPEG_FRAME_TYPE_ALL 7
186
187#define CX18_MAX_PGM_INDEX (400)
188
189extern int cx18_debug;
190
191
192struct cx18_options {
193 int megabytes[CX18_MAX_STREAMS]; /* Size in megabytes of each stream */
194 int cardtype; /* force card type on load */
195 int tuner; /* set tuner on load */
196 int radio; /* enable/disable radio */
197};
198
199/* per-buffer bit flags */
200#define CX18_F_B_NEED_BUF_SWAP 0 /* this buffer should be byte swapped */
201
202/* per-stream, s_flags */
203#define CX18_F_S_CLAIMED 3 /* this stream is claimed */
204#define CX18_F_S_STREAMING 4 /* the fw is decoding/encoding this stream */
205#define CX18_F_S_INTERNAL_USE 5 /* this stream is used internally (sliced VBI processing) */
206#define CX18_F_S_STREAMOFF 7 /* signal end of stream EOS */
207#define CX18_F_S_APPL_IO 8 /* this stream is used read/written by an application */
208
209/* per-cx18, i_flags */
Andy Walls1d6782b2008-11-05 00:49:14 -0300210#define CX18_F_I_LOADED_FW 0 /* Loaded firmware 1st time */
211#define CX18_F_I_EOS 4 /* End of encoder stream */
212#define CX18_F_I_RADIO_USER 5 /* radio tuner is selected */
213#define CX18_F_I_ENC_PAUSED 13 /* the encoder is paused */
Andy Walls1d6782b2008-11-05 00:49:14 -0300214#define CX18_F_I_INITED 21 /* set after first open */
215#define CX18_F_I_FAILED 22 /* set if first open failed */
Hans Verkuil1c1e45d2008-04-28 20:24:33 -0300216
217/* These are the VBI types as they appear in the embedded VBI private packets. */
218#define CX18_SLICED_TYPE_TELETEXT_B (1)
219#define CX18_SLICED_TYPE_CAPTION_525 (4)
220#define CX18_SLICED_TYPE_WSS_625 (5)
221#define CX18_SLICED_TYPE_VPS (7)
222
223struct cx18_buffer {
224 struct list_head list;
225 dma_addr_t dma_handle;
226 u32 id;
227 unsigned long b_flags;
Andy Wallsbca11a52008-11-19 01:24:33 -0300228 unsigned skipped;
Hans Verkuil1c1e45d2008-04-28 20:24:33 -0300229 char *buf;
230
231 u32 bytesused;
232 u32 readpos;
233};
234
235struct cx18_queue {
236 struct list_head list;
Andy Wallsb04bce42008-08-22 21:03:11 -0300237 atomic_t buffers;
Hans Verkuil1c1e45d2008-04-28 20:24:33 -0300238 u32 bytesused;
239};
240
241struct cx18_dvb {
242 struct dmx_frontend hw_frontend;
243 struct dmx_frontend mem_frontend;
244 struct dmxdev dmxdev;
245 struct dvb_adapter dvb_adapter;
246 struct dvb_demux demux;
247 struct dvb_frontend *fe;
248 struct dvb_net dvbnet;
249 int enabled;
250 int feeding;
Hans Verkuil1c1e45d2008-04-28 20:24:33 -0300251 struct mutex feedlock;
Hans Verkuil1c1e45d2008-04-28 20:24:33 -0300252};
253
254struct cx18; /* forward reference */
255struct cx18_scb; /* forward reference */
256
Andy Walls72a4f802008-11-16 21:18:00 -0300257
Andy Wallsee2d64f2008-11-16 01:38:19 -0300258#define CX18_MAX_MDL_ACKS 2
Andy Walls0ef02892008-12-14 18:52:12 -0300259#define CX18_MAX_EPU_WORK_ORDERS (CX18_MAX_FW_MDLS_PER_STREAM + 7)
260/* CPU_DE_RELEASE_MDL can burst CX18_MAX_FW_MDLS_PER_STREAM orders in a group */
Andy Wallsee2d64f2008-11-16 01:38:19 -0300261
Andy Walls72a4f802008-11-16 21:18:00 -0300262#define CX18_F_EWO_MB_STALE_UPON_RECEIPT 0x1
263#define CX18_F_EWO_MB_STALE_WHILE_PROC 0x2
264#define CX18_F_EWO_MB_STALE \
265 (CX18_F_EWO_MB_STALE_UPON_RECEIPT | CX18_F_EWO_MB_STALE_WHILE_PROC)
266
Andy Wallsee2d64f2008-11-16 01:38:19 -0300267struct cx18_epu_work_order {
268 struct work_struct work;
269 atomic_t pending;
270 struct cx18 *cx;
Andy Walls72a4f802008-11-16 21:18:00 -0300271 unsigned long flags;
Andy Wallsee2d64f2008-11-16 01:38:19 -0300272 int rpu;
273 struct cx18_mailbox mb;
274 struct cx18_mdl_ack mdl_ack[CX18_MAX_MDL_ACKS];
275 char *str;
276};
277
Andy Wallsd3c5e702008-08-23 16:42:29 -0300278#define CX18_INVALID_TASK_HANDLE 0xffffffff
279
Hans Verkuil1c1e45d2008-04-28 20:24:33 -0300280struct cx18_stream {
281 /* These first four fields are always set, even if the stream
282 is not actually created. */
Andy Walls3d059132009-01-10 21:54:39 -0300283 struct video_device *video_dev; /* NULL when stream not created */
Hans Verkuil1c1e45d2008-04-28 20:24:33 -0300284 struct cx18 *cx; /* for ease of use */
285 const char *name; /* name of the stream */
286 int type; /* stream type */
287 u32 handle; /* task handle */
288 unsigned mdl_offset;
289
290 u32 id;
Andy Wallsf576cee2008-11-16 20:18:05 -0300291 struct mutex qlock; /* locks access to the queues */
Hans Verkuil1c1e45d2008-04-28 20:24:33 -0300292 unsigned long s_flags; /* status flags, see above */
293 int dma; /* can be PCI_DMA_TODEVICE,
294 PCI_DMA_FROMDEVICE or
295 PCI_DMA_NONE */
Hans Verkuil1c1e45d2008-04-28 20:24:33 -0300296 wait_queue_head_t waitq;
297
298 /* Buffer Stats */
299 u32 buffers;
300 u32 buf_size;
Hans Verkuil1c1e45d2008-04-28 20:24:33 -0300301
302 /* Buffer Queues */
303 struct cx18_queue q_free; /* free buffers */
Andy Walls66c2a6b2008-12-08 23:02:45 -0300304 struct cx18_queue q_busy; /* busy buffers - in use by firmware */
305 struct cx18_queue q_full; /* full buffers - data for user apps */
Hans Verkuil1c1e45d2008-04-28 20:24:33 -0300306
307 /* DVB / Digital Transport */
308 struct cx18_dvb dvb;
309};
310
311struct cx18_open_id {
312 u32 open_id;
313 int type;
314 enum v4l2_priority prio;
315 struct cx18 *cx;
316};
317
318/* forward declaration of struct defined in cx18-cards.h */
319struct cx18_card;
320
Andy Walls302df972009-01-31 00:33:02 -0300321/*
322 * A note about "sliced" VBI data as implemented in this driver:
323 *
324 * Currently we collect the sliced VBI in the form of Ancillary Data
325 * packets, inserted by the AV core decoder/digitizer/slicer in the
326 * horizontal blanking region of the VBI lines, in "raw" mode as far as
327 * the Encoder is concerned. We don't ever tell the Encoder itself
328 * to provide sliced VBI. (AV Core: sliced mode - Encoder: raw mode)
329 *
330 * We then process the ancillary data ourselves to send the sliced data
331 * to the user application directly or build up MPEG-2 private stream 1
332 * packets to splice into (only!) MPEG-2 PS streams for the user app.
333 *
334 * (That's how ivtv essentially does it.)
335 *
336 * The Encoder should be able to extract certain sliced VBI data for
337 * us and provide it in a separate stream or splice it into any type of
338 * MPEG PS or TS stream, but this isn't implemented yet.
339 */
340
341/*
342 * Number of "raw" VBI samples per horizontal line we tell the Encoder to
343 * grab from the decoder/digitizer/slicer output for raw or sliced VBI.
344 * It depends on the pixel clock and the horiz rate:
345 *
346 * (1/Fh)*(2*Fp) = Samples/line
347 * = 4 bytes EAV + Anc data in hblank + 4 bytes SAV + active samples
348 *
349 * Sliced VBI data is sent as ancillary data during horizontal blanking
350 * Raw VBI is sent as active video samples during vertcal blanking
351 *
352 * We use a BT.656 pxiel clock of 13.5 MHz and a BT.656 active line
353 * length of 720 pixels @ 4:2:2 sampling. Thus...
354 *
355 * For systems that use a 15.734 kHz horizontal rate, such as
356 * NTSC-M, PAL-M, PAL-60, and other 60 Hz/525 line systems, we have:
357 *
358 * (1/15.734 kHz) * 2 * 13.5 MHz = 1716 samples/line =
359 * 4 bytes SAV + 268 bytes anc data + 4 bytes SAV + 1440 active samples
360 *
361 * For systems that use a 15.625 kHz horizontal rate, such as
362 * PAL-B/G/H, PAL-I, SECAM-L and other 50 Hz/625 line systems, we have:
363 *
364 * (1/15.625 kHz) * 2 * 13.5 MHz = 1728 samples/line =
365 * 4 bytes SAV + 280 bytes anc data + 4 bytes SAV + 1440 active samples
366 */
367static const u32 vbi_active_samples = 1444; /* 4 byte SAV + 720 Y + 720 U/V */
368static const u32 vbi_hblank_samples_60Hz = 272; /* 4 byte EAV + 268 anc/fill */
369static const u32 vbi_hblank_samples_50Hz = 284; /* 4 byte EAV + 280 anc/fill */
Hans Verkuil1c1e45d2008-04-28 20:24:33 -0300370
371#define CX18_VBI_FRAMES 32
372
Hans Verkuil1c1e45d2008-04-28 20:24:33 -0300373struct vbi_info {
Andy Walls302df972009-01-31 00:33:02 -0300374 /* Current state of v4l2 VBI settings for this device */
Hans Verkuil1c1e45d2008-04-28 20:24:33 -0300375 struct v4l2_format in;
Andy Walls302df972009-01-31 00:33:02 -0300376 struct v4l2_sliced_vbi_format *sliced_in; /* pointer to in.fmt.sliced */
377 u32 count; /* Count of VBI data lines: 60 Hz: 12 or 50 Hz: 18 */
378 u32 start[2]; /* First VBI data line per field: 10 & 273 or 6 & 318 */
379
380 u32 frame; /* Count of VBI buffers/frames received from Encoder */
381
382 /*
383 * Vars for creation and insertion of MPEG Private Stream 1 packets
384 * of sliced VBI data into an MPEG PS
385 */
386
387 /* Boolean: create and insert Private Stream 1 packets into the PS */
Hans Verkuil1c1e45d2008-04-28 20:24:33 -0300388 int insert_mpeg;
389
Andy Walls302df972009-01-31 00:33:02 -0300390 /*
391 * Buffer for the maximum of 2 * 18 * packet_size sliced VBI lines.
392 * Used in cx18-vbi.c only for collecting sliced data, and as a source
393 * during conversion of sliced VBI data into MPEG Priv Stream 1 packets.
394 * We don't need to save state here, but the array may have been a bit
395 * too big (2304 bytes) to alloc from the stack.
396 */
Hans Verkuil1c1e45d2008-04-28 20:24:33 -0300397 struct v4l2_sliced_vbi_data sliced_data[36];
398
Andy Walls302df972009-01-31 00:33:02 -0300399 /*
400 * A ring buffer of driver-generated MPEG-2 PS
401 * Program Pack/Private Stream 1 packets for sliced VBI data insertion
402 * into the MPEG PS stream.
403 *
404 * In each sliced_mpeg_data[] buffer is:
405 * 16 byte MPEG-2 PS Program Pack Header
406 * 16 byte MPEG-2 Private Stream 1 PES Header
407 * 4 byte magic number: "itv0" or "ITV0"
408 * 4 byte first field line mask, if "itv0"
409 * 4 byte second field line mask, if "itv0"
410 * 36 lines, if "ITV0"; or <36 lines, if "itv0"; of sliced VBI data
411 *
412 * Each line in the payload is
413 * 1 byte line header derived from the SDID (WSS, CC, VPS, etc.)
414 * 42 bytes of line data
415 *
416 * That's a maximum 1552 bytes of payload in the Private Stream 1 packet
417 * which is the payload size a PVR-350 (CX23415) MPEG decoder will
418 * accept for VBI data. So, including the headers, it's a maximum 1584
419 * bytes total.
420 */
421#define CX18_SLICED_MPEG_DATA_MAXSZ 1584
422 /* copy_vbi_buf() needs 8 temp bytes on the end for the worst case */
423#define CX18_SLICED_MPEG_DATA_BUFSZ (CX18_SLICED_MPEG_DATA_MAXSZ+8)
Hans Verkuil1c1e45d2008-04-28 20:24:33 -0300424 u8 *sliced_mpeg_data[CX18_VBI_FRAMES];
425 u32 sliced_mpeg_size[CX18_VBI_FRAMES];
Andy Walls302df972009-01-31 00:33:02 -0300426
427 /* Count of Program Pack/Program Stream 1 packets inserted into PS */
Hans Verkuil1c1e45d2008-04-28 20:24:33 -0300428 u32 inserted_frame;
429
Andy Walls302df972009-01-31 00:33:02 -0300430 /*
431 * A dummy driver stream transfer buffer with a copy of the next
432 * sliced_mpeg_data[] buffer for output to userland apps.
433 * Only used in cx18-fileops.c, but its state needs to persist at times.
434 */
435 struct cx18_buffer sliced_mpeg_buf;
Hans Verkuil1c1e45d2008-04-28 20:24:33 -0300436};
437
438/* Per cx23418, per I2C bus private algo callback data */
439struct cx18_i2c_algo_callback_data {
440 struct cx18 *cx;
441 int bus_index; /* 0 or 1 for the cx23418's 1st or 2nd I2C bus */
442};
443
Andy Wallsf7823f82008-11-02 18:15:28 -0300444#define CX18_MAX_MMIO_WR_RETRIES 10
Andy Walls330c6ec2008-11-08 14:19:37 -0300445
Hans Verkuil1c1e45d2008-04-28 20:24:33 -0300446/* Struct to hold info about cx18 cards */
447struct cx18 {
Andy Walls5811cf92009-02-14 17:08:37 -0300448 int instance;
Andy Walls3d059132009-01-10 21:54:39 -0300449 struct pci_dev *pci_dev;
Andy Walls888cdb02009-01-11 15:08:53 -0300450 struct v4l2_device v4l2_dev;
Andy Wallsff2a2002009-02-20 23:52:13 -0300451 struct v4l2_subdev *sd_av; /* A/V decoder/digitizer sub-device */
Andy Wallseefe1012009-02-21 18:42:49 -0300452 struct v4l2_subdev *sd_extmux; /* External multiplexer sub-dev */
Andy Walls888cdb02009-01-11 15:08:53 -0300453
Hans Verkuil1c1e45d2008-04-28 20:24:33 -0300454 const struct cx18_card *card; /* card information */
455 const char *card_name; /* full name of the card */
456 const struct cx18_card_tuner_i2c *card_i2c; /* i2c addresses to probe for tuner */
457 u8 is_50hz;
458 u8 is_60hz;
Andy Walls5811cf92009-02-14 17:08:37 -0300459 u8 is_out_50hz; /* FIXME - remove, we don't have an output decoder */
460 u8 is_out_60hz; /* FIXME - remove, we don't have an output decoder */
Hans Verkuil1c1e45d2008-04-28 20:24:33 -0300461 u8 nof_inputs; /* number of video inputs */
462 u8 nof_audio_inputs; /* number of audio inputs */
463 u16 buffer_id; /* buffer ID counter */
464 u32 v4l2_cap; /* V4L2 capabilities of card */
465 u32 hw_flags; /* Hardware description of the board */
466 unsigned mdl_offset;
Andy Walls72c2d6d2008-11-06 01:15:41 -0300467 struct cx18_scb __iomem *scb; /* pointer to SCB */
468 struct mutex epu2apu_mb_lock; /* protect driver to chip mailbox in SCB*/
469 struct mutex epu2cpu_mb_lock; /* protect driver to chip mailbox in SCB*/
470
Hans Verkuil1c1e45d2008-04-28 20:24:33 -0300471 struct cx18_av_state av_state;
472
473 /* codec settings */
474 struct cx2341x_mpeg_params params;
475 u32 filter_mode;
476 u32 temporal_strength;
477 u32 spatial_strength;
478
479 /* dualwatch */
480 unsigned long dualwatch_jiffies;
Andy Walls0d82fe82009-01-01 19:02:31 -0300481 u32 dualwatch_stereo_mode;
Hans Verkuil1c1e45d2008-04-28 20:24:33 -0300482
Hans Verkuil1c1e45d2008-04-28 20:24:33 -0300483 struct mutex serialize_lock; /* mutex used to serialize open/close/start/stop/ioctl operations */
484 struct cx18_options options; /* User options */
Andy Walls6ecd86d2008-12-07 23:30:17 -0300485 int stream_buffers[CX18_MAX_STREAMS]; /* # of buffers for each stream */
Hans Verkuil1c1e45d2008-04-28 20:24:33 -0300486 int stream_buf_size[CX18_MAX_STREAMS]; /* Stream buffer size */
487 struct cx18_stream streams[CX18_MAX_STREAMS]; /* Stream data */
488 unsigned long i_flags; /* global cx18 flags */
Hans Verkuil31554ae2008-05-25 11:21:27 -0300489 atomic_t ana_capturing; /* count number of active analog capture streams */
490 atomic_t tot_capturing; /* total count number of active capture streams */
Hans Verkuil1c1e45d2008-04-28 20:24:33 -0300491 int search_pack_header;
492
Hans Verkuil1c1e45d2008-04-28 20:24:33 -0300493 int open_id; /* incremented each time an open occurs, used as
494 unique ID. Starts at 1, so 0 can be used as
495 uninitialized value in the stream->id. */
496
497 u32 base_addr;
498 struct v4l2_prio_state prio;
499
500 u8 card_rev;
501 void __iomem *enc_mem, *reg_mem;
502
503 struct vbi_info vbi;
504
505 u32 pgm_info_offset;
506 u32 pgm_info_num;
507 u32 pgm_info_write_idx;
508 u32 pgm_info_read_idx;
509 struct v4l2_enc_idx_entry pgm_info[CX18_MAX_PGM_INDEX];
510
511 u64 mpg_data_received;
512 u64 vbi_data_inserted;
513
514 wait_queue_head_t mb_apu_waitq;
515 wait_queue_head_t mb_cpu_waitq;
Hans Verkuil1c1e45d2008-04-28 20:24:33 -0300516 wait_queue_head_t cap_w;
517 /* when the current DMA is finished this queue is woken up */
518 wait_queue_head_t dma_waitq;
519
Andy Wallsd6c7e5f2008-11-17 22:48:46 -0300520 u32 sw1_irq_mask;
521 u32 sw2_irq_mask;
522 u32 hw2_irq_mask;
523
Andy Walls572bfea2008-11-25 21:43:05 -0300524 struct workqueue_struct *work_queue;
Andy Wallsee2d64f2008-11-16 01:38:19 -0300525 struct cx18_epu_work_order epu_work_order[CX18_MAX_EPU_WORK_ORDERS];
526 char epu_debug_str[256]; /* CX18_EPU_DEBUG is rare: use shared space */
Andy Walls1d6782b2008-11-05 00:49:14 -0300527
Hans Verkuil1c1e45d2008-04-28 20:24:33 -0300528 /* i2c */
529 struct i2c_adapter i2c_adap[2];
530 struct i2c_algo_bit_data i2c_algo[2];
531 struct cx18_i2c_algo_callback_data i2c_algo_cb_data[2];
Hans Verkuil1c1e45d2008-04-28 20:24:33 -0300532
Hans Verkuilba60bc62008-05-25 14:34:36 -0300533 /* gpio */
534 u32 gpio_dir;
535 u32 gpio_val;
Andy Walls8abdd002008-07-13 19:05:25 -0300536 struct mutex gpio_lock;
Andy Wallseefe1012009-02-21 18:42:49 -0300537 struct v4l2_subdev sd_gpiomux;
538 struct v4l2_subdev sd_resetctrl;
Hans Verkuilba60bc62008-05-25 14:34:36 -0300539
Hans Verkuil1c1e45d2008-04-28 20:24:33 -0300540 /* v4l2 and User settings */
541
542 /* codec settings */
543 u32 audio_input;
544 u32 active_input;
545 u32 active_output;
546 v4l2_std_id std;
547 v4l2_std_id tuner_std; /* The norm of the tuner (fixed) */
548};
549
Andy Walls5811cf92009-02-14 17:08:37 -0300550static inline struct cx18 *to_cx18(struct v4l2_device *v4l2_dev)
551{
552 return container_of(v4l2_dev, struct cx18, v4l2_dev);
553}
554
Hans Verkuil1c1e45d2008-04-28 20:24:33 -0300555/* Globals */
Hans Verkuil1c1e45d2008-04-28 20:24:33 -0300556extern int cx18_first_minor;
Hans Verkuil1c1e45d2008-04-28 20:24:33 -0300557
558/*==============Prototypes==================*/
559
560/* Return non-zero if a signal is pending */
561int cx18_msleep_timeout(unsigned int msecs, int intr);
562
Hans Verkuil1c1e45d2008-04-28 20:24:33 -0300563/* Read Hauppauge eeprom */
564struct tveeprom; /* forward reference */
565void cx18_read_eeprom(struct cx18 *cx, struct tveeprom *tv);
566
567/* First-open initialization: load firmware, etc. */
568int cx18_init_on_first_open(struct cx18 *cx);
569
Andy Wallsdd073432008-12-12 16:24:04 -0300570/* Test if the current VBI mode is raw (1) or sliced (0) */
571static inline int cx18_raw_vbi(const struct cx18 *cx)
572{
573 return cx->vbi.in.type == V4L2_BUF_TYPE_VBI_CAPTURE;
574}
575
Andy Wallsff2a2002009-02-20 23:52:13 -0300576/* Call the specified callback for all subdevs with a grp_id bit matching the
577 * mask in hw (if 0, then match them all). Ignore any errors. */
578#define cx18_call_hw(cx, hw, o, f, args...) \
579 __v4l2_device_call_subdevs(&(cx)->v4l2_dev, \
580 !(hw) || (sd->grp_id & (hw)), o, f , ##args)
581
582#define cx18_call_all(cx, o, f, args...) cx18_call_hw(cx, 0, o, f , ##args)
583
584/* Call the specified callback for all subdevs with a grp_id bit matching the
585 * mask in hw (if 0, then match them all). If the callback returns an error
586 * other than 0 or -ENOIOCTLCMD, then return with that error code. */
587#define cx18_call_hw_err(cx, hw, o, f, args...) \
588 __v4l2_device_call_subdevs_until_err( \
589 &(cx)->v4l2_dev, !(hw) || (sd->grp_id & (hw)), o, f , ##args)
590
591#define cx18_call_all_err(cx, o, f, args...) \
592 cx18_call_hw_err(cx, 0, o, f , ##args)
593
Hans Verkuil1c1e45d2008-04-28 20:24:33 -0300594#endif /* CX18_DRIVER_H */