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