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