git.oblomov.eu Git - linux-2.6/blob - drivers/media/video/ivtv/ivtv-driver.h

   1 /*
   2     ivtv driver internal defines and structures
   3     Copyright (C) 2003-2004  Kevin Thayer <nufan_wfk at yahoo.com>
   4     Copyright (C) 2004  Chris Kennedy <c@groovy.org>
   5     Copyright (C) 2005-2007  Hans Verkuil <hverkuil@xs4all.nl>
   6
   7     This program is free software; you can redistribute it and/or modify
   8     it under the terms of the GNU General Public License as published by
   9     the Free Software Foundation; either version 2 of the License, or
  10     (at your option) any later version.
  11
  12     This program is distributed in the hope that it will be useful,
  13     but WITHOUT ANY WARRANTY; without even the implied warranty of
  14     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15     GNU General Public License for more details.
  16
  17     You should have received a copy of the GNU General Public License
  18     along with this program; if not, write to the Free Software
  19     Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  20  */
  21
  22 #ifndef IVTV_DRIVER_H
  23 #define IVTV_DRIVER_H
  24
  25 /* Internal header for ivtv project:
  26  * Driver for the cx23415/6 chip.
  27  * Author: Kevin Thayer (nufan_wfk at yahoo.com)
  28  * License: GPL
  29  * http://www.ivtvdriver.org
  30  *
  31  * -----
  32  * MPG600/MPG160 support by  T.Adachi <tadachi@tadachi-net.com>
  33  *                      and Takeru KOMORIYA<komoriya@paken.org>
  34  *
  35  * AVerMedia M179 GPIO info by Chris Pinkham <cpinkham@bc2va.org>
  36  *                using information provided by Jiun-Kuei Jung @ AVerMedia.
  37  */
  38
  39 #include <linux/version.h>
  40 #include <linux/module.h>
  41 #include <linux/moduleparam.h>
  42 #include <linux/init.h>
  43 #include <linux/delay.h>
  44 #include <linux/sched.h>
  45 #include <linux/fs.h>
  46 #include <linux/pci.h>
  47 #include <linux/interrupt.h>
  48 #include <linux/spinlock.h>
  49 #include <linux/i2c.h>
  50 #include <linux/i2c-algo-bit.h>
  51 #include <linux/list.h>
  52 #include <linux/unistd.h>
  53 #include <linux/byteorder/swab.h>
  54 #include <linux/pagemap.h>
  55 #include <linux/workqueue.h>
  56 #include <linux/mutex.h>
  57 #include <asm/uaccess.h>
  58 #include <asm/system.h>
  59
  60 #include <linux/dvb/video.h>
  61 #include <linux/dvb/audio.h>
  62 #include <media/v4l2-common.h>
  63 #include <media/tuner.h>
  64 #include <media/cx2341x.h>
  65
  66 #include <media/ivtv.h>
  67
  68
  69 #define IVTV_ENCODER_OFFSET     0x00000000
  70 #define IVTV_ENCODER_SIZE       0x00800000      /* Last half isn't needed 0x01000000 */
  71
  72 #define IVTV_DECODER_OFFSET     0x01000000
  73 #define IVTV_DECODER_SIZE       0x00800000      /* Last half isn't needed 0x01000000 */
  74
  75 #define IVTV_REG_OFFSET         0x02000000
  76 #define IVTV_REG_SIZE           0x00010000
  77
  78 /* Buffers on hardware offsets */
  79 #define IVTV_YUV_BUFFER_OFFSET    0x001a8600    /* First YUV Buffer */
  80 #define IVTV_YUV_BUFFER_OFFSET_1  0x00240400    /* Second YUV Buffer */
  81 #define IVTV_YUV_BUFFER_OFFSET_2  0x002d8200    /* Third YUV Buffer */
  82 #define IVTV_YUV_BUFFER_OFFSET_3  0x00370000    /* Fourth YUV Buffer */
  83 #define IVTV_YUV_BUFFER_UV_OFFSET 0x65400       /* Offset to UV Buffer */
  84
  85 /* Offset to filter table in firmware */
  86 #define IVTV_YUV_HORIZONTAL_FILTER_OFFSET 0x025d8
  87 #define IVTV_YUV_VERTICAL_FILTER_OFFSET 0x03358
  88
  89 extern const u32 yuv_offset[4];
  90
  91 /* Maximum ivtv driver instances. Some people have a huge number of
  92    capture cards, so set this to a high value. */
  93 #define IVTV_MAX_CARDS 32
  94
  95 /* Supported cards */
  96 #define IVTV_CARD_PVR_250             0 /* WinTV PVR 250 */
  97 #define IVTV_CARD_PVR_350             1 /* encoder, decoder, tv-out */
  98 #define IVTV_CARD_PVR_150             2 /* WinTV PVR 150 and PVR 500 (really just two
  99                                            PVR150s on one PCI board) */
 100 #define IVTV_CARD_M179                3 /* AVerMedia M179 (encoder only) */
 101 #define IVTV_CARD_MPG600              4 /* Kuroutoshikou ITVC16-STVLP/YUAN MPG600, encoder only */
 102 #define IVTV_CARD_MPG160              5 /* Kuroutoshikou ITVC15-STVLP/YUAN MPG160
 103                                            cx23415 based, but does not have tv-out */
 104 #define IVTV_CARD_PG600               6 /* YUAN PG600/DIAMONDMM PVR-550 based on the CX Falcon 2 */
 105 #define IVTV_CARD_AVC2410             7 /* Adaptec AVC-2410 */
 106 #define IVTV_CARD_AVC2010             8 /* Adaptec AVD-2010 (No Tuner) */
 107 #define IVTV_CARD_TG5000TV            9 /* NAGASE TRANSGEAR 5000TV, encoder only */
 108 #define IVTV_CARD_VA2000MAX_SNT6     10 /* VA2000MAX-STN6 */
 109 #define IVTV_CARD_CX23416GYC         11 /* Kuroutoshikou CX23416GYC-STVLP (Yuan MPG600GR OEM) */
 110 #define IVTV_CARD_GV_MVPRX           12 /* I/O Data GV-MVP/RX, RX2, RX2W */
 111 #define IVTV_CARD_GV_MVPRX2E         13 /* I/O Data GV-MVP/RX2E */
 112 #define IVTV_CARD_GOTVIEW_PCI_DVD    14 /* GotView PCI DVD */
 113 #define IVTV_CARD_GOTVIEW_PCI_DVD2   15 /* GotView PCI DVD2 */
 114 #define IVTV_CARD_YUAN_MPC622        16 /* Yuan MPC622 miniPCI */
 115 #define IVTV_CARD_DCTMTVP1           17 /* DIGITAL COWBOY DCT-MTVP1 */
 116 #define IVTV_CARD_PG600V2            18 /* Yuan PG600V2/GotView PCI DVD Lite */
 117 #define IVTV_CARD_CLUB3D             19 /* Club3D ZAP-TV1x01 */
 118 #define IVTV_CARD_AVERTV_MCE116      20 /* AVerTV MCE 116 Plus */
 119 #define IVTV_CARD_LAST               20
 120
 121 /* Variants of existing cards but with the same PCI IDs. The driver
 122    detects these based on other device information.
 123    These cards must always come last.
 124    New cards must be inserted above, and the indices of the cards below
 125    must be adjusted accordingly. */
 126
 127 /* PVR-350 V1 (uses saa7114) */
 128 #define IVTV_CARD_PVR_350_V1         (IVTV_CARD_LAST+1)
 129 /* 2 variants of Kuroutoshikou CX23416GYC-STVLP (Yuan MPG600GR OEM) */
 130 #define IVTV_CARD_CX23416GYC_NOGR    (IVTV_CARD_LAST+2)
 131 #define IVTV_CARD_CX23416GYC_NOGRYCS (IVTV_CARD_LAST+3)
 132
 133 #define IVTV_ENC_STREAM_TYPE_MPG  0
 134 #define IVTV_ENC_STREAM_TYPE_YUV  1
 135 #define IVTV_ENC_STREAM_TYPE_VBI  2
 136 #define IVTV_ENC_STREAM_TYPE_PCM  3
 137 #define IVTV_ENC_STREAM_TYPE_RAD  4
 138 #define IVTV_DEC_STREAM_TYPE_MPG  5
 139 #define IVTV_DEC_STREAM_TYPE_VBI  6
 140 #define IVTV_DEC_STREAM_TYPE_VOUT 7
 141 #define IVTV_DEC_STREAM_TYPE_YUV  8
 142 #define IVTV_MAX_STREAMS          9
 143
 144 #define IVTV_V4L2_DEC_MPG_OFFSET  16    /* offset from 0 to register decoder mpg v4l2 minors on */
 145 #define IVTV_V4L2_ENC_PCM_OFFSET  24    /* offset from 0 to register pcm v4l2 minors on */
 146 #define IVTV_V4L2_ENC_YUV_OFFSET  32    /* offset from 0 to register yuv v4l2 minors on */
 147 #define IVTV_V4L2_DEC_YUV_OFFSET  48    /* offset from 0 to register decoder yuv v4l2 minors on */
 148 #define IVTV_V4L2_DEC_VBI_OFFSET   8    /* offset from 0 to register decoder vbi input v4l2 minors on */
 149 #define IVTV_V4L2_DEC_VOUT_OFFSET 16    /* offset from 0 to register vbi output v4l2 minors on */
 150
 151 #define IVTV_ENC_MEM_START 0x00000000
 152 #define IVTV_DEC_MEM_START 0x01000000
 153
 154 /* system vendor and device IDs */
 155 #define PCI_VENDOR_ID_ICOMP  0x4444
 156 #define PCI_DEVICE_ID_IVTV15 0x0803
 157 #define PCI_DEVICE_ID_IVTV16 0x0016
 158
 159 /* subsystem vendor ID */
 160 #define IVTV_PCI_ID_HAUPPAUGE           0x0070
 161 #define IVTV_PCI_ID_HAUPPAUGE_ALT1      0x0270
 162 #define IVTV_PCI_ID_HAUPPAUGE_ALT2      0x4070
 163 #define IVTV_PCI_ID_ADAPTEC             0x9005
 164 #define IVTV_PCI_ID_AVERMEDIA           0x1461
 165 #define IVTV_PCI_ID_YUAN1               0x12ab
 166 #define IVTV_PCI_ID_YUAN2               0xff01
 167 #define IVTV_PCI_ID_YUAN3               0xffab
 168 #define IVTV_PCI_ID_YUAN4               0xfbab
 169 #define IVTV_PCI_ID_DIAMONDMM           0xff92
 170 #define IVTV_PCI_ID_IODATA              0x10fc
 171 #define IVTV_PCI_ID_MELCO               0x1154
 172 #define IVTV_PCI_ID_GOTVIEW1            0xffac
 173 #define IVTV_PCI_ID_GOTVIEW2            0xffad
 174
 175 /* Decoder Buffer hardware size on Chip */
 176 #define IVTV_DEC_MAX_BUF        0x00100000      /* max bytes in decoder buffer */
 177 #define IVTV_DEC_MIN_BUF        0x00010000      /* min bytes in dec buffer */
 178
 179 /* ======================================================================== */
 180 /* ========================== START USER SETTABLE DMA VARIABLES =========== */
 181 /* ======================================================================== */
 182
 183 #define IVTV_DMA_SG_OSD_ENT     (2883584/PAGE_SIZE)     /* sg entities */
 184
 185 /* DMA Buffers, Default size in MB allocated */
 186 #define IVTV_DEFAULT_ENC_MPG_BUFFERS 4
 187 #define IVTV_DEFAULT_ENC_YUV_BUFFERS 2
 188 #define IVTV_DEFAULT_ENC_VBI_BUFFERS 1
 189 /* Exception: size in kB for this stream (MB is overkill) */
 190 #define IVTV_DEFAULT_ENC_PCM_BUFFERS 320
 191 #define IVTV_DEFAULT_DEC_MPG_BUFFERS 1
 192 #define IVTV_DEFAULT_DEC_YUV_BUFFERS 1
 193 /* Exception: size in kB for this stream (MB is way overkill) */
 194 #define IVTV_DEFAULT_DEC_VBI_BUFFERS 64
 195
 196 /* ======================================================================== */
 197 /* ========================== END USER SETTABLE DMA VARIABLES ============= */
 198 /* ======================================================================== */
 199
 200 /* Decoder Status Register */
 201 #define IVTV_DMA_ERR_LIST       0x00000010
 202 #define IVTV_DMA_ERR_WRITE      0x00000008
 203 #define IVTV_DMA_ERR_READ       0x00000004
 204 #define IVTV_DMA_SUCCESS_WRITE  0x00000002
 205 #define IVTV_DMA_SUCCESS_READ   0x00000001
 206 #define IVTV_DMA_READ_ERR       (IVTV_DMA_ERR_LIST | IVTV_DMA_ERR_READ)
 207 #define IVTV_DMA_WRITE_ERR      (IVTV_DMA_ERR_LIST | IVTV_DMA_ERR_WRITE)
 208 #define IVTV_DMA_ERR            (IVTV_DMA_ERR_LIST | IVTV_DMA_ERR_WRITE | IVTV_DMA_ERR_READ)
 209
 210 /* DMA Registers */
 211 #define IVTV_REG_DMAXFER        (0x0000)
 212 #define IVTV_REG_DMASTATUS      (0x0004)
 213 #define IVTV_REG_DECDMAADDR     (0x0008)
 214 #define IVTV_REG_ENCDMAADDR     (0x000c)
 215 #define IVTV_REG_DMACONTROL     (0x0010)
 216 #define IVTV_REG_IRQSTATUS      (0x0040)
 217 #define IVTV_REG_IRQMASK        (0x0048)
 218
 219 /* Setup Registers */
 220 #define IVTV_REG_ENC_SDRAM_REFRESH      (0x07F8)
 221 #define IVTV_REG_ENC_SDRAM_PRECHARGE    (0x07FC)
 222 #define IVTV_REG_DEC_SDRAM_REFRESH      (0x08F8)
 223 #define IVTV_REG_DEC_SDRAM_PRECHARGE    (0x08FC)
 224 #define IVTV_REG_VDM                    (0x2800)
 225 #define IVTV_REG_AO                     (0x2D00)
 226 #define IVTV_REG_BYTEFLUSH              (0x2D24)
 227 #define IVTV_REG_SPU                    (0x9050)
 228 #define IVTV_REG_HW_BLOCKS              (0x9054)
 229 #define IVTV_REG_VPU                    (0x9058)
 230 #define IVTV_REG_APU                    (0xA064)
 231
 232 #define IVTV_IRQ_ENC_START_CAP          (0x1 << 31)
 233 #define IVTV_IRQ_ENC_EOS                (0x1 << 30)
 234 #define IVTV_IRQ_ENC_VBI_CAP            (0x1 << 29)
 235 #define IVTV_IRQ_ENC_VIM_RST            (0x1 << 28)
 236 #define IVTV_IRQ_ENC_DMA_COMPLETE       (0x1 << 27)
 237 #define IVTV_IRQ_ENC_PIO_COMPLETE       (0x1 << 25)
 238 #define IVTV_IRQ_DEC_AUD_MODE_CHG       (0x1 << 24)
 239 #define IVTV_IRQ_DEC_DATA_REQ           (0x1 << 22)
 240 #define IVTV_IRQ_DEC_DMA_COMPLETE       (0x1 << 20)
 241 #define IVTV_IRQ_DEC_VBI_RE_INSERT      (0x1 << 19)
 242 #define IVTV_IRQ_DMA_ERR                (0x1 << 18)
 243 #define IVTV_IRQ_DMA_WRITE              (0x1 << 17)
 244 #define IVTV_IRQ_DMA_READ               (0x1 << 16)
 245 #define IVTV_IRQ_DEC_VSYNC              (0x1 << 10)
 246
 247 /* IRQ Masks */
 248 #define IVTV_IRQ_MASK_INIT (IVTV_IRQ_DMA_ERR|IVTV_IRQ_ENC_DMA_COMPLETE|\
 249                 IVTV_IRQ_DMA_READ|IVTV_IRQ_ENC_PIO_COMPLETE)
 250
 251 #define IVTV_IRQ_MASK_CAPTURE (IVTV_IRQ_ENC_START_CAP | IVTV_IRQ_ENC_EOS)
 252 #define IVTV_IRQ_MASK_DECODE  (IVTV_IRQ_DEC_DATA_REQ|IVTV_IRQ_DEC_AUD_MODE_CHG)
 253
 254 /* i2c stuff */
 255 #define I2C_CLIENTS_MAX 16
 256
 257 /* debugging */
 258
 259 #define IVTV_DBGFLG_WARN  (1 << 0)
 260 #define IVTV_DBGFLG_INFO  (1 << 1)
 261 #define IVTV_DBGFLG_API   (1 << 2)
 262 #define IVTV_DBGFLG_DMA   (1 << 3)
 263 #define IVTV_DBGFLG_IOCTL (1 << 4)
 264 #define IVTV_DBGFLG_I2C   (1 << 5)
 265 #define IVTV_DBGFLG_IRQ   (1 << 6)
 266 #define IVTV_DBGFLG_DEC   (1 << 7)
 267 #define IVTV_DBGFLG_YUV   (1 << 8)
 268 /* Flag to turn on high volume debugging */
 269 #define IVTV_DBGFLG_HIGHVOL (1 << 9)
 270
 271 /* NOTE: extra space before comma in 'itv->num , ## args' is required for
 272    gcc-2.95, otherwise it won't compile. */
 273 #define IVTV_DEBUG(x, type, fmt, args...) \
 274         do { \
 275                 if ((x) & ivtv_debug) \
 276                         printk(KERN_INFO "ivtv%d " type ": " fmt, itv->num , ## args); \
 277         } while (0)
 278 #define IVTV_DEBUG_WARN(fmt, args...)  IVTV_DEBUG(IVTV_DBGFLG_WARN, "warning", fmt , ## args)
 279 #define IVTV_DEBUG_INFO(fmt, args...)  IVTV_DEBUG(IVTV_DBGFLG_INFO, "info",fmt , ## args)
 280 #define IVTV_DEBUG_API(fmt, args...)   IVTV_DEBUG(IVTV_DBGFLG_API, "api", fmt , ## args)
 281 #define IVTV_DEBUG_DMA(fmt, args...)   IVTV_DEBUG(IVTV_DBGFLG_DMA, "dma", fmt , ## args)
 282 #define IVTV_DEBUG_IOCTL(fmt, args...) IVTV_DEBUG(IVTV_DBGFLG_IOCTL, "ioctl", fmt , ## args)
 283 #define IVTV_DEBUG_I2C(fmt, args...)   IVTV_DEBUG(IVTV_DBGFLG_I2C, "i2c", fmt , ## args)
 284 #define IVTV_DEBUG_IRQ(fmt, args...)   IVTV_DEBUG(IVTV_DBGFLG_IRQ, "irq", fmt , ## args)
 285 #define IVTV_DEBUG_DEC(fmt, args...)   IVTV_DEBUG(IVTV_DBGFLG_DEC, "dec", fmt , ## args)
 286 #define IVTV_DEBUG_YUV(fmt, args...)   IVTV_DEBUG(IVTV_DBGFLG_YUV, "yuv", fmt , ## args)
 287
 288 #define IVTV_DEBUG_HIGH_VOL(x, type, fmt, args...) \
 289         do { \
 290                 if (((x) & ivtv_debug) && (ivtv_debug & IVTV_DBGFLG_HIGHVOL)) \
 291                         printk(KERN_INFO "ivtv%d " type ": " fmt, itv->num , ## args); \
 292         } while (0)
 293 #define IVTV_DEBUG_HI_WARN(fmt, args...)  IVTV_DEBUG_HIGH_VOL(IVTV_DBGFLG_WARN, "warning", fmt , ## args)
 294 #define IVTV_DEBUG_HI_INFO(fmt, args...)  IVTV_DEBUG_HIGH_VOL(IVTV_DBGFLG_INFO, "info",fmt , ## args)
 295 #define IVTV_DEBUG_HI_API(fmt, args...)   IVTV_DEBUG_HIGH_VOL(IVTV_DBGFLG_API, "api", fmt , ## args)
 296 #define IVTV_DEBUG_HI_DMA(fmt, args...)   IVTV_DEBUG_HIGH_VOL(IVTV_DBGFLG_DMA, "dma", fmt , ## args)
 297 #define IVTV_DEBUG_HI_IOCTL(fmt, args...) IVTV_DEBUG_HIGH_VOL(IVTV_DBGFLG_IOCTL, "ioctl", fmt , ## args)
 298 #define IVTV_DEBUG_HI_I2C(fmt, args...)   IVTV_DEBUG_HIGH_VOL(IVTV_DBGFLG_I2C, "i2c", fmt , ## args)
 299 #define IVTV_DEBUG_HI_IRQ(fmt, args...)   IVTV_DEBUG_HIGH_VOL(IVTV_DBGFLG_IRQ, "irq", fmt , ## args)
 300 #define IVTV_DEBUG_HI_DEC(fmt, args...)   IVTV_DEBUG_HIGH_VOL(IVTV_DBGFLG_DEC, "dec", fmt , ## args)
 301 #define IVTV_DEBUG_HI_YUV(fmt, args...)   IVTV_DEBUG_HIGH_VOL(IVTV_DBGFLG_YUV, "yuv", fmt , ## args)
 302
 303 /* Standard kernel messages */
 304 #define IVTV_ERR(fmt, args...)      printk(KERN_ERR  "ivtv%d: " fmt, itv->num , ## args)
 305 #define IVTV_WARN(fmt, args...)     printk(KERN_WARNING "ivtv%d: " fmt, itv->num , ## args)
 306 #define IVTV_INFO(fmt, args...)     printk(KERN_INFO "ivtv%d: " fmt, itv->num , ## args)
 307
 308 /* Values for IVTV_API_DEC_PLAYBACK_SPEED mpeg_frame_type_mask parameter: */
 309 #define MPEG_FRAME_TYPE_IFRAME 1
 310 #define MPEG_FRAME_TYPE_IFRAME_PFRAME 3
 311 #define MPEG_FRAME_TYPE_ALL 7
 312
 313 /* output modes (cx23415 only) */
 314 #define OUT_NONE        0
 315 #define OUT_MPG         1
 316 #define OUT_YUV         2
 317 #define OUT_UDMA_YUV    3
 318 #define OUT_PASSTHROUGH 4
 319
 320 #define IVTV_MAX_PGM_INDEX (400)
 321
 322 extern int ivtv_debug;
 323
 324
 325 struct ivtv_options {
 326         int kilobytes[IVTV_MAX_STREAMS]; /* Size in kilobytes of each stream */
 327         int cardtype;           /* force card type on load */
 328         int tuner;              /* set tuner on load */
 329         int radio;              /* enable/disable radio */
 330         int newi2c;             /* New I2C algorithm */
 331 };
 332
 333 #define IVTV_MBOX_DMA_START 6
 334 #define IVTV_MBOX_DMA_END 8
 335 #define IVTV_MBOX_DMA 9
 336 #define IVTV_MBOX_FIELD_DISPLAYED 8
 337
 338 /* ivtv-specific mailbox template */
 339 struct ivtv_mailbox {
 340         u32 flags;
 341         u32 cmd;
 342         u32 retval;
 343         u32 timeout;
 344         u32 data[CX2341X_MBOX_MAX_DATA];
 345 };
 346
 347 struct ivtv_api_cache {
 348         unsigned long last_jiffies;             /* when last command was issued */
 349         u32 data[CX2341X_MBOX_MAX_DATA];        /* last sent api data */
 350 };
 351
 352 struct ivtv_mailbox_data {
 353         volatile struct ivtv_mailbox __iomem *mbox;
 354         /* Bits 0-2 are for the encoder mailboxes, 0-1 are for the decoder mailboxes.
 355            If the bit is set, then the corresponding mailbox is in use by the driver. */
 356         unsigned long busy;
 357         u8 max_mbox;
 358 };
 359
 360 /* per-buffer bit flags */
 361 #define IVTV_F_B_NEED_BUF_SWAP  (1 << 0)        /* this buffer should be byte swapped */
 362
 363 /* per-stream, s_flags */
 364 #define IVTV_F_S_DMA_PENDING    0       /* this stream has pending DMA */
 365 #define IVTV_F_S_DMA_HAS_VBI    1       /* the current DMA request also requests VBI data */
 366 #define IVTV_F_S_NEEDS_DATA     2       /* this decoding stream needs more data */
 367
 368 #define IVTV_F_S_CLAIMED        3       /* this stream is claimed */
 369 #define IVTV_F_S_STREAMING      4       /* the fw is decoding/encoding this stream */
 370 #define IVTV_F_S_INTERNAL_USE   5       /* this stream is used internally (sliced VBI processing) */
 371 #define IVTV_F_S_PASSTHROUGH    6       /* this stream is in passthrough mode */
 372 #define IVTV_F_S_STREAMOFF      7       /* signal end of stream EOS */
 373 #define IVTV_F_S_APPL_IO        8       /* this stream is used read/written by an application */
 374
 375 #define IVTV_F_S_PIO_PENDING    9       /* this stream has pending PIO */
 376 #define IVTV_F_S_PIO_HAS_VBI    1       /* the current PIO request also requests VBI data */
 377
 378 /* per-ivtv, i_flags */
 379 #define IVTV_F_I_DMA               0    /* DMA in progress */
 380 #define IVTV_F_I_UDMA              1    /* UDMA in progress */
 381 #define IVTV_F_I_UDMA_PENDING      2    /* UDMA pending */
 382 #define IVTV_F_I_SPEED_CHANGE      3    /* A speed change is in progress */
 383 #define IVTV_F_I_EOS               4    /* End of encoder stream reached */
 384 #define IVTV_F_I_RADIO_USER        5    /* The radio tuner is selected */
 385 #define IVTV_F_I_DIG_RST           6    /* Reset digitizer */
 386 #define IVTV_F_I_DEC_YUV           7    /* YUV instead of MPG is being decoded */
 387 #define IVTV_F_I_UPDATE_CC         9    /* CC should be updated */
 388 #define IVTV_F_I_UPDATE_WSS        10   /* WSS should be updated */
 389 #define IVTV_F_I_UPDATE_VPS        11   /* VPS should be updated */
 390 #define IVTV_F_I_DECODING_YUV      12   /* this stream is YUV frame decoding */
 391 #define IVTV_F_I_ENC_PAUSED        13   /* the encoder is paused */
 392 #define IVTV_F_I_VALID_DEC_TIMINGS 14   /* last_dec_timing is valid */
 393 #define IVTV_F_I_HAVE_WORK         15   /* Used in the interrupt handler: there is work to be done */
 394 #define IVTV_F_I_WORK_HANDLER_VBI  16   /* there is work to be done for VBI */
 395 #define IVTV_F_I_WORK_HANDLER_YUV  17   /* there is work to be done for YUV */
 396 #define IVTV_F_I_WORK_HANDLER_PIO  18   /* there is work to be done for PIO */
 397 #define IVTV_F_I_PIO               19   /* PIO in progress */
 398 #define IVTV_F_I_DEC_PAUSED        20   /* the decoder is paused */
 399 #define IVTV_F_I_INITED            21   /* set after first open */
 400 #define IVTV_F_I_FAILED            22   /* set if first open failed */
 401
 402 /* Event notifications */
 403 #define IVTV_F_I_EV_DEC_STOPPED    28   /* decoder stopped event */
 404 #define IVTV_F_I_EV_VSYNC          29   /* VSYNC event */
 405 #define IVTV_F_I_EV_VSYNC_FIELD    30   /* VSYNC event field (0 = first, 1 = second field) */
 406 #define IVTV_F_I_EV_VSYNC_ENABLED  31   /* VSYNC event enabled */
 407
 408 /* Scatter-Gather array element, used in DMA transfers */
 409 struct ivtv_sg_element {
 410         u32 src;
 411         u32 dst;
 412         u32 size;
 413 };
 414
 415 struct ivtv_user_dma {
 416         struct mutex lock;
 417         int page_count;
 418         struct page *map[IVTV_DMA_SG_OSD_ENT];
 419
 420         /* Base Dev SG Array for cx23415/6 */
 421         struct ivtv_sg_element SGarray[IVTV_DMA_SG_OSD_ENT];
 422         dma_addr_t SG_handle;
 423         int SG_length;
 424
 425         /* SG List of Buffers */
 426         struct scatterlist SGlist[IVTV_DMA_SG_OSD_ENT];
 427 };
 428
 429 struct ivtv_dma_page_info {
 430         unsigned long uaddr;
 431         unsigned long first;
 432         unsigned long last;
 433         unsigned int offset;
 434         unsigned int tail;
 435         int page_count;
 436 };
 437
 438 struct ivtv_buffer {
 439         struct list_head list;
 440         dma_addr_t dma_handle;
 441         unsigned short b_flags;
 442         unsigned short dma_xfer_cnt;
 443         char *buf;
 444
 445         u32 bytesused;
 446         u32 readpos;
 447 };
 448
 449 struct ivtv_queue {
 450         struct list_head list;
 451         u32 buffers;
 452         u32 length;
 453         u32 bytesused;
 454 };
 455
 456 struct ivtv;    /* forward reference */
 457
 458 struct ivtv_stream {
 459         /* These first four fields are always set, even if the stream
 460            is not actually created. */
 461         struct video_device *v4l2dev;   /* NULL when stream not created */
 462         struct ivtv *itv;               /* for ease of use */
 463         const char *name;               /* name of the stream */
 464         int type;                       /* stream type */
 465
 466         u32 id;
 467         spinlock_t qlock;       /* locks access to the queues */
 468         unsigned long s_flags;  /* status flags, see above */
 469         int dma;                /* can be PCI_DMA_TODEVICE,
 470                                    PCI_DMA_FROMDEVICE or
 471                                    PCI_DMA_NONE */
 472         u32 pending_offset;
 473         u32 pending_backup;
 474         u64 pending_pts;
 475
 476         u32 dma_offset;
 477         u32 dma_backup;
 478         u64 dma_pts;
 479
 480         int subtype;
 481         wait_queue_head_t waitq;
 482         u32 dma_last_offset;
 483
 484         /* Buffer Stats */
 485         u32 buffers;
 486         u32 buf_size;
 487         u32 buffers_stolen;
 488
 489         /* Buffer Queues */
 490         struct ivtv_queue q_free;       /* free buffers */
 491         struct ivtv_queue q_full;       /* full buffers */
 492         struct ivtv_queue q_io;         /* waiting for I/O */
 493         struct ivtv_queue q_dma;        /* waiting for DMA */
 494         struct ivtv_queue q_predma;     /* waiting for DMA */
 495
 496         /* DMA xfer counter, buffers belonging to the same DMA
 497            xfer will have the same dma_xfer_cnt. */
 498         u16 dma_xfer_cnt;
 499
 500         /* Base Dev SG Array for cx23415/6 */
 501         struct ivtv_sg_element *sg_pending;
 502         struct ivtv_sg_element *sg_processing;
 503         struct ivtv_sg_element *sg_dma;
 504         dma_addr_t sg_handle;
 505         int sg_pending_size;
 506         int sg_processing_size;
 507         int sg_processed;
 508
 509         /* SG List of Buffers */
 510         struct scatterlist *SGlist;
 511 };
 512
 513 struct ivtv_open_id {
 514         u32 open_id;
 515         int type;
 516         enum v4l2_priority prio;
 517         struct ivtv *itv;
 518 };
 519
 520 #define IVTV_YUV_UPDATE_HORIZONTAL  0x01
 521 #define IVTV_YUV_UPDATE_VERTICAL    0x02
 522
 523 struct yuv_frame_info
 524 {
 525         u32 update;
 526         int src_x;
 527         int src_y;
 528         unsigned int src_w;
 529         unsigned int src_h;
 530         int dst_x;
 531         int dst_y;
 532         unsigned int dst_w;
 533         unsigned int dst_h;
 534         int pan_x;
 535         int pan_y;
 536         u32 vis_w;
 537         u32 vis_h;
 538         u32 interlaced_y;
 539         u32 interlaced_uv;
 540         int tru_x;
 541         u32 tru_w;
 542         u32 tru_h;
 543         u32 offset_y;
 544         int lace_mode;
 545 };
 546
 547 #define IVTV_YUV_MODE_INTERLACED        0x00
 548 #define IVTV_YUV_MODE_PROGRESSIVE       0x01
 549 #define IVTV_YUV_MODE_AUTO              0x02
 550 #define IVTV_YUV_MODE_MASK              0x03
 551
 552 #define IVTV_YUV_SYNC_EVEN              0x00
 553 #define IVTV_YUV_SYNC_ODD               0x04
 554 #define IVTV_YUV_SYNC_MASK              0x04
 555
 556 struct yuv_playback_info
 557 {
 558         u32 reg_2834;
 559         u32 reg_2838;
 560         u32 reg_283c;
 561         u32 reg_2840;
 562         u32 reg_2844;
 563         u32 reg_2848;
 564         u32 reg_2854;
 565         u32 reg_285c;
 566         u32 reg_2864;
 567
 568         u32 reg_2870;
 569         u32 reg_2874;
 570         u32 reg_2890;
 571         u32 reg_2898;
 572         u32 reg_289c;
 573
 574         u32 reg_2918;
 575         u32 reg_291c;
 576         u32 reg_2920;
 577         u32 reg_2924;
 578         u32 reg_2928;
 579         u32 reg_292c;
 580         u32 reg_2930;
 581
 582         u32 reg_2934;
 583
 584         u32 reg_2938;
 585         u32 reg_293c;
 586         u32 reg_2940;
 587         u32 reg_2944;
 588         u32 reg_2948;
 589         u32 reg_294c;
 590         u32 reg_2950;
 591         u32 reg_2954;
 592         u32 reg_2958;
 593         u32 reg_295c;
 594         u32 reg_2960;
 595         u32 reg_2964;
 596         u32 reg_2968;
 597         u32 reg_296c;
 598
 599         u32 reg_2970;
 600
 601         int v_filter_1;
 602         int v_filter_2;
 603         int h_filter;
 604
 605         u32 osd_x_offset;
 606         u32 osd_y_offset;
 607
 608         u32 osd_x_pan;
 609         u32 osd_y_pan;
 610
 611         u32 osd_vis_w;
 612         u32 osd_vis_h;
 613
 614         int decode_height;
 615
 616         int frame_interlaced;
 617
 618         int lace_mode;
 619         int lace_threshold;
 620         int lace_sync_field;
 621
 622         atomic_t next_dma_frame;
 623         atomic_t next_fill_frame;
 624
 625         u32 yuv_forced_update;
 626         int update_frame;
 627
 628         int sync_field[4];  /* Field to sync on */
 629         int field_delay[4]; /* Flag to extend duration of previous frame */
 630         u8 fields_lapsed;   /* Counter used when delaying a frame */
 631
 632         struct yuv_frame_info new_frame_info[4];
 633         struct yuv_frame_info old_frame_info;
 634         struct yuv_frame_info old_frame_info_args;
 635
 636         void *blanking_ptr;
 637         dma_addr_t blanking_dmaptr;
 638 };
 639
 640 #define IVTV_VBI_FRAMES 32
 641
 642 /* VBI data */
 643 struct vbi_info {
 644         u32 dec_start;
 645         u32 enc_start, enc_size;
 646         int fpi;
 647         u32 frame;
 648         u8 cc_data_odd[256];
 649         u8 cc_data_even[256];
 650         int cc_pos;
 651         u8 cc_no_update;
 652         u8 vps[5];
 653         u8 vps_found;
 654         int wss;
 655         u8 wss_found;
 656         u8 wss_no_update;
 657         u32 raw_decoder_line_size;
 658         u8 raw_decoder_sav_odd_field;
 659         u8 raw_decoder_sav_even_field;
 660         u32 sliced_decoder_line_size;
 661         u8 sliced_decoder_sav_odd_field;
 662         u8 sliced_decoder_sav_even_field;
 663         struct v4l2_format in;
 664         /* convenience pointer to sliced struct in vbi_in union */
 665         struct v4l2_sliced_vbi_format *sliced_in;
 666         int insert_mpeg;
 667
 668         /* Buffer for the maximum of 2 * 18 * packet_size sliced VBI lines.
 669            One for /dev/vbi0 and one for /dev/vbi8 */
 670         struct v4l2_sliced_vbi_data sliced_data[36];
 671         struct v4l2_sliced_vbi_data sliced_dec_data[36];
 672
 673         /* Buffer for VBI data inserted into MPEG stream.
 674            The first byte is a dummy byte that's never used.
 675            The next 16 bytes contain the MPEG header for the VBI data,
 676            the remainder is the actual VBI data.
 677            The max size accepted by the MPEG VBI reinsertion turns out
 678            to be 1552 bytes, which happens to be 4 + (1 + 42) * (2 * 18) bytes,
 679            where 4 is a four byte header, 42 is the max sliced VBI payload, 1 is
 680            a single line header byte and 2 * 18 is the number of VBI lines per frame.
 681
 682            However, it seems that the data must be 1K aligned, so we have to
 683            pad the data until the 1 or 2 K boundary.
 684
 685            This pointer array will allocate 2049 bytes to store each VBI frame. */
 686         u8 *sliced_mpeg_data[IVTV_VBI_FRAMES];
 687         u32 sliced_mpeg_size[IVTV_VBI_FRAMES];
 688         struct ivtv_buffer sliced_mpeg_buf;
 689         u32 inserted_frame;
 690
 691         u32 start[2], count;
 692         u32 raw_size;
 693         u32 sliced_size;
 694 };
 695
 696 /* forward declaration of struct defined in ivtv-cards.h */
 697 struct ivtv_card;
 698
 699 /* Struct to hold info about ivtv cards */
 700 struct ivtv {
 701         int num;                /* board number, -1 during init! */
 702         char name[8];           /* board name for printk and interrupts (e.g. 'ivtv0') */
 703         struct pci_dev *dev;    /* PCI device */
 704         const struct ivtv_card *card;   /* card information */
 705         const char *card_name;  /* full name of the card */
 706         u8 has_cx23415;         /* 1 if it is a cx23415 based card, 0 for cx23416 */
 707         u8 is_50hz;
 708         u8 is_60hz;
 709         u8 is_out_50hz;
 710         u8 is_out_60hz;
 711         u8 pvr150_workaround;   /* 1 if the cx25840 needs to workaround a PVR150 bug */
 712         u8 nof_inputs;          /* number of video inputs */
 713         u8 nof_audio_inputs;    /* number of audio inputs */
 714         u32 v4l2_cap;           /* V4L2 capabilities of card */
 715         u32 hw_flags;           /* Hardware description of the board */
 716         int tunerid;            /* Userspace tuner ID for experimental Xceive tuner support */
 717
 718         /* controlling Video decoder function */
 719         int (*video_dec_func)(struct ivtv *, unsigned int, void *);
 720
 721         struct ivtv_options options;    /* User options */
 722         int stream_buf_size[IVTV_MAX_STREAMS]; /* Stream buffer size */
 723         struct ivtv_stream streams[IVTV_MAX_STREAMS];   /* Stream data */
 724         int speed;
 725         u8 speed_mute_audio;
 726         unsigned long i_flags;  /* global ivtv flags */
 727         atomic_t capturing;     /* count number of active capture streams */
 728         atomic_t decoding;      /* count number of active decoding streams */
 729         u32 irq_rr_idx; /* Round-robin stream index */
 730         int cur_dma_stream;     /* index of stream doing DMA */
 731         int cur_pio_stream;     /* index of stream doing PIO */
 732         u32 dma_data_req_offset;
 733         u32 dma_data_req_size;
 734         int dma_retries;
 735         int output_mode;        /* NONE, MPG, YUV, UDMA YUV, passthrough */
 736         spinlock_t lock;        /* lock access to this struct */
 737         int search_pack_header;
 738
 739         spinlock_t dma_reg_lock; /* lock access to DMA engine registers */
 740         struct mutex serialize_lock;  /* lock used to serialize starting streams */
 741
 742         /* User based DMA for OSD */
 743         struct ivtv_user_dma udma;
 744
 745         int open_id;            /* incremented each time an open occurs, used as unique ID.
 746                                    starts at 1, so 0 can be used as uninitialized value
 747                                    in the stream->id. */
 748
 749         u32 base_addr;
 750         u32 irqmask;
 751
 752         struct v4l2_prio_state prio;
 753         struct workqueue_struct *irq_work_queues;
 754         struct work_struct irq_work_queue;
 755         struct timer_list dma_timer; /* Timer used to catch unfinished DMAs */
 756
 757         struct vbi_info vbi;
 758
 759         struct ivtv_mailbox_data enc_mbox;
 760         struct ivtv_mailbox_data dec_mbox;
 761         struct ivtv_api_cache api_cache[256];   /* Cached API Commands */
 762
 763         u8 card_rev;
 764         volatile void __iomem *enc_mem, *dec_mem, *reg_mem;
 765
 766         u32 pgm_info_offset;
 767         u32 pgm_info_num;
 768         u32 pgm_info_write_idx;
 769         u32 pgm_info_read_idx;
 770         struct v4l2_enc_idx_entry pgm_info[IVTV_MAX_PGM_INDEX];
 771
 772         u64 mpg_data_received;
 773         u64 vbi_data_inserted;
 774
 775         wait_queue_head_t cap_w;
 776         /* when the next decoder event arrives this queue is woken up */
 777         wait_queue_head_t event_waitq;
 778         /* when the next decoder vsync arrives this queue is woken up */
 779         wait_queue_head_t vsync_waitq;
 780         /* when the current DMA is finished this queue is woken up */
 781         wait_queue_head_t dma_waitq;
 782
 783         /* OSD support */
 784         unsigned long osd_video_pbase;
 785         int osd_global_alpha_state; /* 0=off : 1=on */
 786         int osd_local_alpha_state;  /* 0=off : 1=on */
 787         int osd_color_key_state;    /* 0=off : 1=on */
 788         u8  osd_global_alpha;       /* Current global alpha */
 789         u32 osd_color_key;          /* Current color key */
 790         u32 osd_pixelformat;        /* Current pixel format */
 791         struct v4l2_rect osd_rect;  /* Current OSD position and size */
 792         struct v4l2_rect main_rect; /* Current Main window position and size */
 793
 794         u32 last_dec_timing[3];     /* Store last retrieved pts/scr/frame values */
 795
 796         /* i2c */
 797         struct i2c_adapter i2c_adap;
 798         struct i2c_algo_bit_data i2c_algo;
 799         struct i2c_client i2c_client;
 800         struct mutex i2c_bus_lock;
 801         int i2c_state;
 802         struct i2c_client *i2c_clients[I2C_CLIENTS_MAX];
 803
 804         /* v4l2 and User settings */
 805
 806         /* codec settings */
 807         struct cx2341x_mpeg_params params;
 808         u32 audio_input;
 809         u32 active_input;
 810         u32 active_output;
 811         v4l2_std_id std;
 812         v4l2_std_id std_out;
 813         v4l2_std_id tuner_std;  /* The norm of the tuner (fixed) */
 814         u8 audio_stereo_mode;
 815         u8 audio_bilingual_mode;
 816
 817         /* dualwatch */
 818         unsigned long dualwatch_jiffies;
 819         u16 dualwatch_stereo_mode;
 820
 821         /* Digitizer type */
 822         int digitizer;          /* 0x00EF = saa7114 0x00FO = saa7115 0x0106 = mic */
 823
 824         u32 lastVsyncFrame;
 825
 826         struct yuv_playback_info yuv_info;
 827         struct osd_info *osd_info;
 828 };
 829
 830 /* Globals */
 831 extern struct ivtv *ivtv_cards[];
 832 extern int ivtv_cards_active;
 833 extern int ivtv_first_minor;
 834 extern spinlock_t ivtv_cards_lock;
 835
 836 /*==============Prototypes==================*/
 837
 838 /* Hardware/IRQ */
 839 void ivtv_set_irq_mask(struct ivtv *itv, u32 mask);
 840 void ivtv_clear_irq_mask(struct ivtv *itv, u32 mask);
 841
 842 /* try to set output mode, return current mode. */
 843 int ivtv_set_output_mode(struct ivtv *itv, int mode);
 844
 845 /* return current output stream based on current mode */
 846 struct ivtv_stream *ivtv_get_output_stream(struct ivtv *itv);
 847
 848 /* Return non-zero if a signal is pending */
 849 int ivtv_msleep_timeout(unsigned int msecs, int intr);
 850
 851 /* Wait on queue, returns -EINTR if interrupted */
 852 int ivtv_waitq(wait_queue_head_t *waitq);
 853
 854 /* Read Hauppauge eeprom */
 855 struct tveeprom; /* forward reference */
 856 void ivtv_read_eeprom(struct ivtv *itv, struct tveeprom *tv);
 857
 858 /* First-open initialization: load firmware, init cx25840, etc. */
 859 int ivtv_init_on_first_open(struct ivtv *itv);
 860
 861 /* This is a PCI post thing, where if the pci register is not read, then
 862    the write doesn't always take effect right away. By reading back the
 863    register any pending PCI writes will be performed (in order), and so
 864    you can be sure that the writes are guaranteed to be done.
 865
 866    Rarely needed, only in some timing sensitive cases.
 867    Apparently if this is not done some motherboards seem
 868    to kill the firmware and get into the broken state until computer is
 869    rebooted. */
 870 #define write_sync(val, reg) \
 871         do { writel(val, reg); readl(reg); } while (0)
 872
 873 #define read_reg(reg) readl(itv->reg_mem + (reg))
 874 #define write_reg(val, reg) writel(val, itv->reg_mem + (reg))
 875 #define write_reg_sync(val, reg) \
 876         do { write_reg(val, reg); read_reg(reg); } while (0)
 877
 878 #define read_enc(addr) readl(itv->enc_mem + (u32)(addr))
 879 #define write_enc(val, addr) writel(val, itv->enc_mem + (u32)(addr))
 880 #define write_enc_sync(val, addr) \
 881         do { write_enc(val, addr); read_enc(addr); } while (0)
 882
 883 #define read_dec(addr) readl(itv->dec_mem + (u32)(addr))
 884 #define write_dec(val, addr) writel(val, itv->dec_mem + (u32)(addr))
 885 #define write_dec_sync(val, addr) \
 886         do { write_dec(val, addr); read_dec(addr); } while (0)
 887
 888 #endif /* IVTV_DRIVER_H */