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