SAFE public projects git trees. - safe/jmp/linux-2.6/blob - drivers/media/video/cx18/cx18-driver.h

   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@radix.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/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>
  42 #include <linux/pagemap.h>
  43 #include <linux/workqueue.h>
  44 #include <linux/mutex.h>
  45 #include <asm/byteorder.h>
  46
  47 #include <linux/dvb/video.h>
  48 #include <linux/dvb/audio.h>
  49 #include <media/v4l2-common.h>
  50 #include <media/v4l2-ioctl.h>
  51 #include <media/v4l2-device.h>
  52 #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 */
  81 #define CX18_CARD_CNXT_RAPTOR_PAL     4 /* Conexant Raptor PAL */
  82 #define CX18_CARD_TOSHIBA_QOSMIO_DVBT 5 /* Toshiba Qosmio Interal DVB-T/Analog*/
  83 #define CX18_CARD_LEADTEK_PVR2100     6 /* Leadtek WinFast PVR2100/DVR3100 H */
  84 #define CX18_CARD_LAST                6
  85
  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
 103 #define CX18_PCI_ID_CONEXANT            0x14f1
 104 #define CX18_PCI_ID_TOSHIBA             0x1179
 105 #define CX18_PCI_ID_LEADTEK             0x107D
 106
 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
 119 /* Maximum firmware DMA buffers per stream */
 120 #define CX18_MAX_FW_MDLS_PER_STREAM 63
 121
 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
 130 /* 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
 147 /* NOTE: extra space before comma in 'fmt , ## args' is required for
 148    gcc-2.95, otherwise it won't compile. */
 149 #define CX18_DEBUG(x, type, fmt, args...) \
 150         do { \
 151                 if ((x) & cx18_debug) \
 152                         v4l2_info(&cx->v4l2_dev, " " type ": " fmt , ## args); \
 153         } 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)) \
 166                         v4l2_info(&cx->v4l2_dev, " " type ": " fmt , ## args); \
 167         } 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 */
 178 #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)
 181
 182 /* Messages for internal subdevs to use */
 183 #define CX18_DEBUG_DEV(x, dev, type, fmt, args...) \
 184         do { \
 185                 if ((x) & cx18_debug) \
 186                         v4l2_info(dev, " " type ": " fmt , ## args); \
 187         } while (0)
 188 #define CX18_DEBUG_WARN_DEV(dev, fmt, args...) \
 189                 CX18_DEBUG_DEV(CX18_DBGFLG_WARN, dev, "warning", fmt , ## args)
 190 #define CX18_DEBUG_INFO_DEV(dev, fmt, args...) \
 191                 CX18_DEBUG_DEV(CX18_DBGFLG_INFO, dev, "info", fmt , ## args)
 192 #define CX18_DEBUG_API_DEV(dev, fmt, args...) \
 193                 CX18_DEBUG_DEV(CX18_DBGFLG_API, dev, "api", fmt , ## args)
 194 #define CX18_DEBUG_DMA_DEV(dev, fmt, args...) \
 195                 CX18_DEBUG_DEV(CX18_DBGFLG_DMA, dev, "dma", fmt , ## args)
 196 #define CX18_DEBUG_IOCTL_DEV(dev, fmt, args...) \
 197                 CX18_DEBUG_DEV(CX18_DBGFLG_IOCTL, dev, "ioctl", fmt , ## args)
 198 #define CX18_DEBUG_FILE_DEV(dev, fmt, args...) \
 199                 CX18_DEBUG_DEV(CX18_DBGFLG_FILE, dev, "file", fmt , ## args)
 200 #define CX18_DEBUG_I2C_DEV(dev, fmt, args...) \
 201                 CX18_DEBUG_DEV(CX18_DBGFLG_I2C, dev, "i2c", fmt , ## args)
 202 #define CX18_DEBUG_IRQ_DEV(dev, fmt, args...) \
 203                 CX18_DEBUG_DEV(CX18_DBGFLG_IRQ, dev, "irq", fmt , ## args)
 204
 205 #define CX18_DEBUG_HIGH_VOL_DEV(x, dev, type, fmt, args...) \
 206         do { \
 207                 if (((x) & cx18_debug) && (cx18_debug & CX18_DBGFLG_HIGHVOL)) \
 208                         v4l2_info(dev, " " type ": " fmt , ## args); \
 209         } while (0)
 210 #define CX18_DEBUG_HI_WARN_DEV(dev, fmt, args...) \
 211         CX18_DEBUG_HIGH_VOL_DEV(CX18_DBGFLG_WARN, dev, "warning", fmt , ## args)
 212 #define CX18_DEBUG_HI_INFO_DEV(dev, fmt, args...) \
 213         CX18_DEBUG_HIGH_VOL_DEV(CX18_DBGFLG_INFO, dev, "info", fmt , ## args)
 214 #define CX18_DEBUG_HI_API_DEV(dev, fmt, args...) \
 215         CX18_DEBUG_HIGH_VOL_DEV(CX18_DBGFLG_API, dev, "api", fmt , ## args)
 216 #define CX18_DEBUG_HI_DMA_DEV(dev, fmt, args...) \
 217         CX18_DEBUG_HIGH_VOL_DEV(CX18_DBGFLG_DMA, dev, "dma", fmt , ## args)
 218 #define CX18_DEBUG_HI_IOCTL_DEV(dev, fmt, args...) \
 219         CX18_DEBUG_HIGH_VOL_DEV(CX18_DBGFLG_IOCTL, dev, "ioctl", fmt , ## args)
 220 #define CX18_DEBUG_HI_FILE_DEV(dev, fmt, args...) \
 221         CX18_DEBUG_HIGH_VOL_DEV(CX18_DBGFLG_FILE, dev, "file", fmt , ## args)
 222 #define CX18_DEBUG_HI_I2C_DEV(dev, fmt, args...) \
 223         CX18_DEBUG_HIGH_VOL_DEV(CX18_DBGFLG_I2C, dev, "i2c", fmt , ## args)
 224 #define CX18_DEBUG_HI_IRQ_DEV(dev, fmt, args...) \
 225         CX18_DEBUG_HIGH_VOL_DEV(CX18_DBGFLG_IRQ, dev, "irq", fmt , ## args)
 226
 227 #define CX18_ERR_DEV(dev, fmt, args...)      v4l2_err(dev, fmt , ## args)
 228 #define CX18_WARN_DEV(dev, fmt, args...)     v4l2_warn(dev, fmt , ## args)
 229 #define CX18_INFO_DEV(dev, fmt, args...)     v4l2_info(dev, fmt , ## args)
 230
 231 /* Values for CX18_API_DEC_PLAYBACK_SPEED mpeg_frame_type_mask parameter: */
 232 #define MPEG_FRAME_TYPE_IFRAME 1
 233 #define MPEG_FRAME_TYPE_IFRAME_PFRAME 3
 234 #define MPEG_FRAME_TYPE_ALL 7
 235
 236 #define CX18_MAX_PGM_INDEX (400)
 237
 238 extern int cx18_debug;
 239
 240
 241 struct cx18_options {
 242         int megabytes[CX18_MAX_STREAMS]; /* Size in megabytes of each stream */
 243         int cardtype;           /* force card type on load */
 244         int tuner;              /* set tuner on load */
 245         int radio;              /* enable/disable radio */
 246 };
 247
 248 /* per-buffer bit flags */
 249 #define CX18_F_B_NEED_BUF_SWAP  0       /* this buffer should be byte swapped */
 250
 251 /* per-stream, s_flags */
 252 #define CX18_F_S_CLAIMED        3       /* this stream is claimed */
 253 #define CX18_F_S_STREAMING      4       /* the fw is decoding/encoding this stream */
 254 #define CX18_F_S_INTERNAL_USE   5       /* this stream is used internally (sliced VBI processing) */
 255 #define CX18_F_S_STREAMOFF      7       /* signal end of stream EOS */
 256 #define CX18_F_S_APPL_IO        8       /* this stream is used read/written by an application */
 257 #define CX18_F_S_STOPPING       9       /* telling the fw to stop capturing */
 258
 259 /* per-cx18, i_flags */
 260 #define CX18_F_I_LOADED_FW              0       /* Loaded firmware 1st time */
 261 #define CX18_F_I_EOS                    4       /* End of encoder stream */
 262 #define CX18_F_I_RADIO_USER             5       /* radio tuner is selected */
 263 #define CX18_F_I_ENC_PAUSED             13      /* the encoder is paused */
 264 #define CX18_F_I_INITED                 21      /* set after first open */
 265 #define CX18_F_I_FAILED                 22      /* set if first open failed */
 266
 267 /* These are the VBI types as they appear in the embedded VBI private packets. */
 268 #define CX18_SLICED_TYPE_TELETEXT_B     (1)
 269 #define CX18_SLICED_TYPE_CAPTION_525    (4)
 270 #define CX18_SLICED_TYPE_WSS_625        (5)
 271 #define CX18_SLICED_TYPE_VPS            (7)
 272
 273 struct cx18_buffer {
 274         struct list_head list;
 275         dma_addr_t dma_handle;
 276         u32 id;
 277         unsigned long b_flags;
 278         unsigned skipped;
 279         char *buf;
 280
 281         u32 bytesused;
 282         u32 readpos;
 283 };
 284
 285 struct cx18_queue {
 286         struct list_head list;
 287         atomic_t buffers;
 288         u32 bytesused;
 289         spinlock_t lock;
 290 };
 291
 292 struct cx18_dvb {
 293         struct dmx_frontend hw_frontend;
 294         struct dmx_frontend mem_frontend;
 295         struct dmxdev dmxdev;
 296         struct dvb_adapter dvb_adapter;
 297         struct dvb_demux demux;
 298         struct dvb_frontend *fe;
 299         struct dvb_net dvbnet;
 300         int enabled;
 301         int feeding;
 302         struct mutex feedlock;
 303 };
 304
 305 struct cx18;     /* forward reference */
 306 struct cx18_scb; /* forward reference */
 307
 308
 309 #define CX18_MAX_MDL_ACKS 2
 310 #define CX18_MAX_IN_WORK_ORDERS (CX18_MAX_FW_MDLS_PER_STREAM + 7)
 311 /* CPU_DE_RELEASE_MDL can burst CX18_MAX_FW_MDLS_PER_STREAM orders in a group */
 312
 313 #define CX18_F_EWO_MB_STALE_UPON_RECEIPT 0x1
 314 #define CX18_F_EWO_MB_STALE_WHILE_PROC   0x2
 315 #define CX18_F_EWO_MB_STALE \
 316              (CX18_F_EWO_MB_STALE_UPON_RECEIPT | CX18_F_EWO_MB_STALE_WHILE_PROC)
 317
 318 struct cx18_in_work_order {
 319         struct work_struct work;
 320         atomic_t pending;
 321         struct cx18 *cx;
 322         unsigned long flags;
 323         int rpu;
 324         struct cx18_mailbox mb;
 325         struct cx18_mdl_ack mdl_ack[CX18_MAX_MDL_ACKS];
 326         char *str;
 327 };
 328
 329 /*
 330  * There are 2 types of deferrable tasks that send messages out to the firmware:
 331  * 1. Sending individual buffers back to the firmware
 332  * 2. Sending as many free buffers for a stream from q_free as we can to the fw
 333  *
 334  * The worst case scenario for multiple simultaneous streams is
 335  * TS, YUV, PCM, VBI, MPEG, and IDX all going at once.
 336  *
 337  * We try to load the firmware queue with as many free buffers as possible,
 338  * whenever we get a buffer back for a stream.  For the TS we return the single
 339  * buffer to the firmware at that time as well.  For all other streams, we
 340  * return single buffers to the firmware as the application drains them.
 341  *
 342  * 6 streams * 2 sets of orders * (1 single buf + 1 load fw from q_free)
 343  * = 24 work orders should cover our needs, provided the applications read
 344  * at a fairly steady rate.  If apps don't, we fall back to non-deferred
 345  * operation, when no cx18_out_work_orders are available for use.
 346  */
 347 #define CX18_MAX_OUT_WORK_ORDERS (24)
 348
 349 struct cx18_out_work_order {
 350         struct work_struct work;
 351         atomic_t pending;
 352         struct cx18_stream *s;
 353         struct cx18_buffer *buf; /* buf == NULL, means load fw from q_free */
 354 };
 355
 356 #define CX18_INVALID_TASK_HANDLE 0xffffffff
 357
 358 struct cx18_stream {
 359         /* These first four fields are always set, even if the stream
 360            is not actually created. */
 361         struct video_device *video_dev; /* NULL when stream not created */
 362         struct cx18 *cx;                /* for ease of use */
 363         const char *name;               /* name of the stream */
 364         int type;                       /* stream type */
 365         u32 handle;                     /* task handle */
 366         unsigned mdl_offset;
 367
 368         u32 id;
 369         unsigned long s_flags;  /* status flags, see above */
 370         int dma;                /* can be PCI_DMA_TODEVICE,
 371                                    PCI_DMA_FROMDEVICE or
 372                                    PCI_DMA_NONE */
 373         wait_queue_head_t waitq;
 374
 375         /* Buffer Stats */
 376         u32 buffers;
 377         u32 buf_size;
 378
 379         /* Buffer Queues */
 380         struct cx18_queue q_free;       /* free buffers */
 381         struct cx18_queue q_busy;       /* busy buffers - in use by firmware */
 382         struct cx18_queue q_full;       /* full buffers - data for user apps */
 383
 384         /* DVB / Digital Transport */
 385         struct cx18_dvb dvb;
 386 };
 387
 388 struct cx18_open_id {
 389         u32 open_id;
 390         int type;
 391         enum v4l2_priority prio;
 392         struct cx18 *cx;
 393 };
 394
 395 /* forward declaration of struct defined in cx18-cards.h */
 396 struct cx18_card;
 397
 398 /*
 399  * A note about "sliced" VBI data as implemented in this driver:
 400  *
 401  * Currently we collect the sliced VBI in the form of Ancillary Data
 402  * packets, inserted by the AV core decoder/digitizer/slicer in the
 403  * horizontal blanking region of the VBI lines, in "raw" mode as far as
 404  * the Encoder is concerned.  We don't ever tell the Encoder itself
 405  * to provide sliced VBI. (AV Core: sliced mode - Encoder: raw mode)
 406  *
 407  * We then process the ancillary data ourselves to send the sliced data
 408  * to the user application directly or build up MPEG-2 private stream 1
 409  * packets to splice into (only!) MPEG-2 PS streams for the user app.
 410  *
 411  * (That's how ivtv essentially does it.)
 412  *
 413  * The Encoder should be able to extract certain sliced VBI data for
 414  * us and provide it in a separate stream or splice it into any type of
 415  * MPEG PS or TS stream, but this isn't implemented yet.
 416  */
 417
 418 /*
 419  * Number of "raw" VBI samples per horizontal line we tell the Encoder to
 420  * grab from the decoder/digitizer/slicer output for raw or sliced VBI.
 421  * It depends on the pixel clock and the horiz rate:
 422  *
 423  * (1/Fh)*(2*Fp) = Samples/line
 424  *     = 4 bytes EAV + Anc data in hblank + 4 bytes SAV + active samples
 425  *
 426  *  Sliced VBI data is sent as ancillary data during horizontal blanking
 427  *  Raw VBI is sent as active video samples during vertcal blanking
 428  *
 429  *  We use a  BT.656 pxiel clock of 13.5 MHz and a BT.656 active line
 430  *  length of 720 pixels @ 4:2:2 sampling.  Thus...
 431  *
 432  *  For systems that use a 15.734 kHz horizontal rate, such as
 433  *  NTSC-M, PAL-M, PAL-60, and other 60 Hz/525 line systems, we have:
 434  *
 435  *  (1/15.734 kHz) * 2 * 13.5 MHz = 1716 samples/line =
 436  *  4 bytes SAV + 268 bytes anc data + 4 bytes SAV + 1440 active samples
 437  *
 438  *  For systems that use a 15.625 kHz horizontal rate, such as
 439  *  PAL-B/G/H, PAL-I, SECAM-L and other 50 Hz/625 line systems, we have:
 440  *
 441  *  (1/15.625 kHz) * 2 * 13.5 MHz = 1728 samples/line =
 442  *  4 bytes SAV + 280 bytes anc data + 4 bytes SAV + 1440 active samples
 443  */
 444 static const u32 vbi_active_samples = 1444; /* 4 byte SAV + 720 Y + 720 U/V */
 445 static const u32 vbi_hblank_samples_60Hz = 272; /* 4 byte EAV + 268 anc/fill */
 446 static const u32 vbi_hblank_samples_50Hz = 284; /* 4 byte EAV + 280 anc/fill */
 447
 448 #define CX18_VBI_FRAMES 32
 449
 450 struct vbi_info {
 451         /* Current state of v4l2 VBI settings for this device */
 452         struct v4l2_format in;
 453         struct v4l2_sliced_vbi_format *sliced_in; /* pointer to in.fmt.sliced */
 454         u32 count;    /* Count of VBI data lines: 60 Hz: 12 or 50 Hz: 18 */
 455         u32 start[2]; /* First VBI data line per field: 10 & 273 or 6 & 318 */
 456
 457         u32 frame; /* Count of VBI buffers/frames received from Encoder */
 458
 459         /*
 460          * Vars for creation and insertion of MPEG Private Stream 1 packets
 461          * of sliced VBI data into an MPEG PS
 462          */
 463
 464         /* Boolean: create and insert Private Stream 1 packets into the PS */
 465         int insert_mpeg;
 466
 467         /*
 468          * Buffer for the maximum of 2 * 18 * packet_size sliced VBI lines.
 469          * Used in cx18-vbi.c only for collecting sliced data, and as a source
 470          * during conversion of sliced VBI data into MPEG Priv Stream 1 packets.
 471          * We don't need to save state here, but the array may have been a bit
 472          * too big (2304 bytes) to alloc from the stack.
 473          */
 474         struct v4l2_sliced_vbi_data sliced_data[36];
 475
 476         /*
 477          * A ring buffer of driver-generated MPEG-2 PS
 478          * Program Pack/Private Stream 1 packets for sliced VBI data insertion
 479          * into the MPEG PS stream.
 480          *
 481          * In each sliced_mpeg_data[] buffer is:
 482          *      16 byte MPEG-2 PS Program Pack Header
 483          *      16 byte MPEG-2 Private Stream 1 PES Header
 484          *       4 byte magic number: "itv0" or "ITV0"
 485          *       4 byte first  field line mask, if "itv0"
 486          *       4 byte second field line mask, if "itv0"
 487          *      36 lines, if "ITV0"; or <36 lines, if "itv0"; of sliced VBI data
 488          *
 489          *      Each line in the payload is
 490          *       1 byte line header derived from the SDID (WSS, CC, VPS, etc.)
 491          *      42 bytes of line data
 492          *
 493          * That's a maximum 1552 bytes of payload in the Private Stream 1 packet
 494          * which is the payload size a PVR-350 (CX23415) MPEG decoder will
 495          * accept for VBI data. So, including the headers, it's a maximum 1584
 496          * bytes total.
 497          */
 498 #define CX18_SLICED_MPEG_DATA_MAXSZ     1584
 499         /* copy_vbi_buf() needs 8 temp bytes on the end for the worst case */
 500 #define CX18_SLICED_MPEG_DATA_BUFSZ     (CX18_SLICED_MPEG_DATA_MAXSZ+8)
 501         u8 *sliced_mpeg_data[CX18_VBI_FRAMES];
 502         u32 sliced_mpeg_size[CX18_VBI_FRAMES];
 503
 504         /* Count of Program Pack/Program Stream 1 packets inserted into PS */
 505         u32 inserted_frame;
 506
 507         /*
 508          * A dummy driver stream transfer buffer with a copy of the next
 509          * sliced_mpeg_data[] buffer for output to userland apps.
 510          * Only used in cx18-fileops.c, but its state needs to persist at times.
 511          */
 512         struct cx18_buffer sliced_mpeg_buf;
 513 };
 514
 515 /* Per cx23418, per I2C bus private algo callback data */
 516 struct cx18_i2c_algo_callback_data {
 517         struct cx18 *cx;
 518         int bus_index;   /* 0 or 1 for the cx23418's 1st or 2nd I2C bus */
 519 };
 520
 521 #define CX18_MAX_MMIO_WR_RETRIES 10
 522
 523 /* Struct to hold info about cx18 cards */
 524 struct cx18 {
 525         int instance;
 526         struct pci_dev *pci_dev;
 527         struct v4l2_device v4l2_dev;
 528         struct v4l2_subdev *sd_av;     /* A/V decoder/digitizer sub-device */
 529         struct v4l2_subdev *sd_extmux; /* External multiplexer sub-dev */
 530
 531         const struct cx18_card *card;   /* card information */
 532         const char *card_name;  /* full name of the card */
 533         const struct cx18_card_tuner_i2c *card_i2c; /* i2c addresses to probe for tuner */
 534         u8 is_50hz;
 535         u8 is_60hz;
 536         u8 nof_inputs;          /* number of video inputs */
 537         u8 nof_audio_inputs;    /* number of audio inputs */
 538         u16 buffer_id;          /* buffer ID counter */
 539         u32 v4l2_cap;           /* V4L2 capabilities of card */
 540         u32 hw_flags;           /* Hardware description of the board */
 541         unsigned mdl_offset;
 542         struct cx18_scb __iomem *scb; /* pointer to SCB */
 543         struct mutex epu2apu_mb_lock; /* protect driver to chip mailbox in SCB*/
 544         struct mutex epu2cpu_mb_lock; /* protect driver to chip mailbox in SCB*/
 545
 546         struct cx18_av_state av_state;
 547
 548         /* codec settings */
 549         struct cx2341x_mpeg_params params;
 550         u32 filter_mode;
 551         u32 temporal_strength;
 552         u32 spatial_strength;
 553
 554         /* dualwatch */
 555         unsigned long dualwatch_jiffies;
 556         u32 dualwatch_stereo_mode;
 557
 558         struct mutex serialize_lock;    /* mutex used to serialize open/close/start/stop/ioctl operations */
 559         struct cx18_options options;    /* User options */
 560         int stream_buffers[CX18_MAX_STREAMS]; /* # of buffers for each stream */
 561         int stream_buf_size[CX18_MAX_STREAMS]; /* Stream buffer size */
 562         struct cx18_stream streams[CX18_MAX_STREAMS];   /* Stream data */
 563         unsigned long i_flags;  /* global cx18 flags */
 564         atomic_t ana_capturing; /* count number of active analog capture streams */
 565         atomic_t tot_capturing; /* total count number of active capture streams */
 566         int search_pack_header;
 567
 568         int open_id;            /* incremented each time an open occurs, used as
 569                                    unique ID. Starts at 1, so 0 can be used as
 570                                    uninitialized value in the stream->id. */
 571
 572         u32 base_addr;
 573         struct v4l2_prio_state prio;
 574
 575         u8 card_rev;
 576         void __iomem *enc_mem, *reg_mem;
 577
 578         struct vbi_info vbi;
 579
 580         u32 pgm_info_offset;
 581         u32 pgm_info_num;
 582         u32 pgm_info_write_idx;
 583         u32 pgm_info_read_idx;
 584         struct v4l2_enc_idx_entry pgm_info[CX18_MAX_PGM_INDEX];
 585
 586         u64 mpg_data_received;
 587         u64 vbi_data_inserted;
 588
 589         wait_queue_head_t mb_apu_waitq;
 590         wait_queue_head_t mb_cpu_waitq;
 591         wait_queue_head_t cap_w;
 592         /* when the current DMA is finished this queue is woken up */
 593         wait_queue_head_t dma_waitq;
 594
 595         u32 sw1_irq_mask;
 596         u32 sw2_irq_mask;
 597         u32 hw2_irq_mask;
 598
 599         struct workqueue_struct *in_work_queue;
 600         char in_workq_name[11]; /* "cx18-NN-in" */
 601         struct cx18_in_work_order in_work_order[CX18_MAX_IN_WORK_ORDERS];
 602         char epu_debug_str[256]; /* CX18_EPU_DEBUG is rare: use shared space */
 603
 604         struct workqueue_struct *out_work_queue;
 605         char out_workq_name[12]; /* "cx18-NN-out" */
 606         struct cx18_out_work_order out_work_order[CX18_MAX_OUT_WORK_ORDERS];
 607
 608         /* i2c */
 609         struct i2c_adapter i2c_adap[2];
 610         struct i2c_algo_bit_data i2c_algo[2];
 611         struct cx18_i2c_algo_callback_data i2c_algo_cb_data[2];
 612
 613         /* gpio */
 614         u32 gpio_dir;
 615         u32 gpio_val;
 616         struct mutex gpio_lock;
 617         struct v4l2_subdev sd_gpiomux;
 618         struct v4l2_subdev sd_resetctrl;
 619
 620         /* v4l2 and User settings */
 621
 622         /* codec settings */
 623         u32 audio_input;
 624         u32 active_input;
 625         v4l2_std_id std;
 626         v4l2_std_id tuner_std;  /* The norm of the tuner (fixed) */
 627 };
 628
 629 static inline struct cx18 *to_cx18(struct v4l2_device *v4l2_dev)
 630 {
 631         return container_of(v4l2_dev, struct cx18, v4l2_dev);
 632 }
 633
 634 /* Globals */
 635 extern int cx18_first_minor;
 636
 637 /*==============Prototypes==================*/
 638
 639 /* Return non-zero if a signal is pending */
 640 int cx18_msleep_timeout(unsigned int msecs, int intr);
 641
 642 /* Read Hauppauge eeprom */
 643 struct tveeprom; /* forward reference */
 644 void cx18_read_eeprom(struct cx18 *cx, struct tveeprom *tv);
 645
 646 /* First-open initialization: load firmware, etc. */
 647 int cx18_init_on_first_open(struct cx18 *cx);
 648
 649 /* Test if the current VBI mode is raw (1) or sliced (0) */
 650 static inline int cx18_raw_vbi(const struct cx18 *cx)
 651 {
 652         return cx->vbi.in.type == V4L2_BUF_TYPE_VBI_CAPTURE;
 653 }
 654
 655 /* Call the specified callback for all subdevs with a grp_id bit matching the
 656  * mask in hw (if 0, then match them all). Ignore any errors. */
 657 #define cx18_call_hw(cx, hw, o, f, args...) \
 658         __v4l2_device_call_subdevs(&(cx)->v4l2_dev, \
 659                                    !(hw) || (sd->grp_id & (hw)), o, f , ##args)
 660
 661 #define cx18_call_all(cx, o, f, args...) cx18_call_hw(cx, 0, o, f , ##args)
 662
 663 /* Call the specified callback for all subdevs with a grp_id bit matching the
 664  * mask in hw (if 0, then match them all). If the callback returns an error
 665  * other than 0 or -ENOIOCTLCMD, then return with that error code. */
 666 #define cx18_call_hw_err(cx, hw, o, f, args...) \
 667         __v4l2_device_call_subdevs_until_err( \
 668                    &(cx)->v4l2_dev, !(hw) || (sd->grp_id & (hw)), o, f , ##args)
 669
 670 #define cx18_call_all_err(cx, o, f, args...) \
 671         cx18_call_hw_err(cx, 0, o, f , ##args)
 672
 673 #endif /* CX18_DRIVER_H */