drivers/media/video/cx18/cx18-driver.h

   1 /*
   2  *  cx18 driver internal defines and structures
   3  *
   4  *  Derived from ivtv-driver.h
   5  *
   6  *  Copyright (C) 2007  Hans Verkuil <hverkuil@xs4all.nl>
   7  *
   8  *  This program is free software; you can redistribute it and/or modify
   9  *  it under the terms of the GNU General Public License as published by
  10  *  the Free Software Foundation; either version 2 of the License, or
  11  *  (at your option) any later version.
  12  *
  13  *  This program is distributed in the hope that it will be useful,
  14  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  *  GNU General Public License for more details.
  17  *
  18  *  You should have received a copy of the GNU General Public License
  19  *  along with this program; if not, write to the Free Software
  20  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
  21  *  02111-1307  USA
  22  */
  23
  24 #ifndef CX18_DRIVER_H
  25 #define CX18_DRIVER_H
  26
  27 #include <linux/version.h>
  28 #include <linux/module.h>
  29 #include <linux/moduleparam.h>
  30 #include <linux/init.h>
  31 #include <linux/delay.h>
  32 #include <linux/sched.h>
  33 #include <linux/fs.h>
  34 #include <linux/pci.h>
  35 #include <linux/interrupt.h>
  36 #include <linux/spinlock.h>
  37 #include <linux/i2c.h>
  38 #include <linux/i2c-algo-bit.h>
  39 #include <linux/list.h>
  40 #include <linux/unistd.h>
  41 #include <linux/pagemap.h>
  42 #include <linux/workqueue.h>
  43 #include <linux/mutex.h>
  44 #include <asm/byteorder.h>
  45
  46 #include <linux/dvb/video.h>
  47 #include <linux/dvb/audio.h>
  48 #include <media/v4l2-common.h>
  49 #include <media/v4l2-ioctl.h>
  50 #include <media/tuner.h>
  51 #include "cx18-mailbox.h"
  52 #include "cx18-av-core.h"
  53 #include "cx23418.h"
  54
  55 /* DVB */
  56 #include "demux.h"
  57 #include "dmxdev.h"
  58 #include "dvb_demux.h"
  59 #include "dvb_frontend.h"
  60 #include "dvb_net.h"
  61 #include "dvbdev.h"
  62
  63 #ifndef CONFIG_PCI
  64 #  error "This driver requires kernel PCI support."
  65 #endif
  66
  67 #define CX18_MEM_OFFSET 0x00000000
  68 #define CX18_MEM_SIZE   0x04000000
  69 #define CX18_REG_OFFSET 0x02000000
  70
  71 /* Maximum cx18 driver instances. */
  72 #define CX18_MAX_CARDS 32
  73
  74 /* Supported cards */
  75 #define CX18_CARD_HVR_1600_ESMT       0 /* Hauppauge HVR 1600 (ESMT memory) */
  76 #define CX18_CARD_HVR_1600_SAMSUNG    1 /* Hauppauge HVR 1600 (Samsung memory) */
  77 #define CX18_CARD_COMPRO_H900         2 /* Compro VideoMate H900 */
  78 #define CX18_CARD_YUAN_MPC718         3 /* Yuan MPC718 */
  79 #define CX18_CARD_CNXT_RAPTOR_PAL     4 /* Conexant Raptor PAL */
  80 #define CX18_CARD_TOSHIBA_QOSMIO_DVBT 5 /* Toshiba Qosmio Interal DVB-T/Analog*/
  81 #define CX18_CARD_LEADTEK_PVR2100     6 /* Leadtek WinFast PVR2100 */
  82 #define CX18_CARD_LAST                6
  83
  84 #define CX18_ENC_STREAM_TYPE_MPG  0
  85 #define CX18_ENC_STREAM_TYPE_TS   1
  86 #define CX18_ENC_STREAM_TYPE_YUV  2
  87 #define CX18_ENC_STREAM_TYPE_VBI  3
  88 #define CX18_ENC_STREAM_TYPE_PCM  4
  89 #define CX18_ENC_STREAM_TYPE_IDX  5
  90 #define CX18_ENC_STREAM_TYPE_RAD  6
  91 #define CX18_MAX_STREAMS          7
  92
  93 /* system vendor and device IDs */
  94 #define PCI_VENDOR_ID_CX      0x14f1
  95 #define PCI_DEVICE_ID_CX23418 0x5b7a
  96
  97 /* subsystem vendor ID */
  98 #define CX18_PCI_ID_HAUPPAUGE           0x0070
  99 #define CX18_PCI_ID_COMPRO              0x185b
 100 #define CX18_PCI_ID_YUAN                0x12ab
 101 #define CX18_PCI_ID_CONEXANT            0x14f1
 102 #define CX18_PCI_ID_TOSHIBA             0x1179
 103 #define CX18_PCI_ID_LEADTEK             0x107D
 104
 105 /* ======================================================================== */
 106 /* ========================== START USER SETTABLE DMA VARIABLES =========== */
 107 /* ======================================================================== */
 108
 109 /* DMA Buffers, Default size in MB allocated */
 110 #define CX18_DEFAULT_ENC_TS_BUFFERS  1
 111 #define CX18_DEFAULT_ENC_MPG_BUFFERS 2
 112 #define CX18_DEFAULT_ENC_IDX_BUFFERS 1
 113 #define CX18_DEFAULT_ENC_YUV_BUFFERS 2
 114 #define CX18_DEFAULT_ENC_VBI_BUFFERS 1
 115 #define CX18_DEFAULT_ENC_PCM_BUFFERS 1
 116
 117 /* i2c stuff */
 118 #define I2C_CLIENTS_MAX 16
 119
 120 /* debugging */
 121
 122 /* Flag to turn on high volume debugging */
 123 #define CX18_DBGFLG_WARN  (1 << 0)
 124 #define CX18_DBGFLG_INFO  (1 << 1)
 125 #define CX18_DBGFLG_API   (1 << 2)
 126 #define CX18_DBGFLG_DMA   (1 << 3)
 127 #define CX18_DBGFLG_IOCTL (1 << 4)
 128 #define CX18_DBGFLG_FILE  (1 << 5)
 129 #define CX18_DBGFLG_I2C   (1 << 6)
 130 #define CX18_DBGFLG_IRQ   (1 << 7)
 131 /* Flag to turn on high volume debugging */
 132 #define CX18_DBGFLG_HIGHVOL (1 << 8)
 133
 134 /* NOTE: extra space before comma in 'cx->num , ## args' is required for
 135    gcc-2.95, otherwise it won't compile. */
 136 #define CX18_DEBUG(x, type, fmt, args...) \
 137         do { \
 138                 if ((x) & cx18_debug) \
 139                         printk(KERN_INFO "cx18-%d " type ": " fmt, cx->num , ## args); \
 140         } while (0)
 141 #define CX18_DEBUG_WARN(fmt, args...)  CX18_DEBUG(CX18_DBGFLG_WARN, "warning", fmt , ## args)
 142 #define CX18_DEBUG_INFO(fmt, args...)  CX18_DEBUG(CX18_DBGFLG_INFO, "info", fmt , ## args)
 143 #define CX18_DEBUG_API(fmt, args...)   CX18_DEBUG(CX18_DBGFLG_API, "api", fmt , ## args)
 144 #define CX18_DEBUG_DMA(fmt, args...)   CX18_DEBUG(CX18_DBGFLG_DMA, "dma", fmt , ## args)
 145 #define CX18_DEBUG_IOCTL(fmt, args...) CX18_DEBUG(CX18_DBGFLG_IOCTL, "ioctl", fmt , ## args)
 146 #define CX18_DEBUG_FILE(fmt, args...)  CX18_DEBUG(CX18_DBGFLG_FILE, "file", fmt , ## args)
 147 #define CX18_DEBUG_I2C(fmt, args...)   CX18_DEBUG(CX18_DBGFLG_I2C, "i2c", fmt , ## args)
 148 #define CX18_DEBUG_IRQ(fmt, args...)   CX18_DEBUG(CX18_DBGFLG_IRQ, "irq", fmt , ## args)
 149
 150 #define CX18_DEBUG_HIGH_VOL(x, type, fmt, args...) \
 151         do { \
 152                 if (((x) & cx18_debug) && (cx18_debug & CX18_DBGFLG_HIGHVOL)) \
 153                         printk(KERN_INFO "cx18%d " type ": " fmt, cx->num , ## args); \
 154         } while (0)
 155 #define CX18_DEBUG_HI_WARN(fmt, args...)  CX18_DEBUG_HIGH_VOL(CX18_DBGFLG_WARN, "warning", fmt , ## args)
 156 #define CX18_DEBUG_HI_INFO(fmt, args...)  CX18_DEBUG_HIGH_VOL(CX18_DBGFLG_INFO, "info", fmt , ## args)
 157 #define CX18_DEBUG_HI_API(fmt, args...)   CX18_DEBUG_HIGH_VOL(CX18_DBGFLG_API, "api", fmt , ## args)
 158 #define CX18_DEBUG_HI_DMA(fmt, args...)   CX18_DEBUG_HIGH_VOL(CX18_DBGFLG_DMA, "dma", fmt , ## args)
 159 #define CX18_DEBUG_HI_IOCTL(fmt, args...) CX18_DEBUG_HIGH_VOL(CX18_DBGFLG_IOCTL, "ioctl", fmt , ## args)
 160 #define CX18_DEBUG_HI_FILE(fmt, args...)  CX18_DEBUG_HIGH_VOL(CX18_DBGFLG_FILE, "file", fmt , ## args)
 161 #define CX18_DEBUG_HI_I2C(fmt, args...)   CX18_DEBUG_HIGH_VOL(CX18_DBGFLG_I2C, "i2c", fmt , ## args)
 162 #define CX18_DEBUG_HI_IRQ(fmt, args...)   CX18_DEBUG_HIGH_VOL(CX18_DBGFLG_IRQ, "irq", fmt , ## args)
 163
 164 /* Standard kernel messages */
 165 #define CX18_ERR(fmt, args...)      printk(KERN_ERR  "cx18-%d: " fmt, cx->num , ## args)
 166 #define CX18_WARN(fmt, args...)     printk(KERN_WARNING "cx18-%d: " fmt, cx->num , ## args)
 167 #define CX18_INFO(fmt, args...)     printk(KERN_INFO "cx18-%d: " fmt, cx->num , ## args)
 168
 169 /* Values for CX18_API_DEC_PLAYBACK_SPEED mpeg_frame_type_mask parameter: */
 170 #define MPEG_FRAME_TYPE_IFRAME 1
 171 #define MPEG_FRAME_TYPE_IFRAME_PFRAME 3
 172 #define MPEG_FRAME_TYPE_ALL 7
 173
 174 #define CX18_MAX_PGM_INDEX (400)
 175
 176 extern int cx18_debug;
 177
 178
 179 struct cx18_options {
 180         int megabytes[CX18_MAX_STREAMS]; /* Size in megabytes of each stream */
 181         int cardtype;           /* force card type on load */
 182         int tuner;              /* set tuner on load */
 183         int radio;              /* enable/disable radio */
 184 };
 185
 186 /* per-buffer bit flags */
 187 #define CX18_F_B_NEED_BUF_SWAP  0       /* this buffer should be byte swapped */
 188
 189 /* per-stream, s_flags */
 190 #define CX18_F_S_CLAIMED        3       /* this stream is claimed */
 191 #define CX18_F_S_STREAMING      4       /* the fw is decoding/encoding this stream */
 192 #define CX18_F_S_INTERNAL_USE   5       /* this stream is used internally (sliced VBI processing) */
 193 #define CX18_F_S_STREAMOFF      7       /* signal end of stream EOS */
 194 #define CX18_F_S_APPL_IO        8       /* this stream is used read/written by an application */
 195
 196 /* per-cx18, i_flags */
 197 #define CX18_F_I_LOADED_FW              0       /* Loaded firmware 1st time */
 198 #define CX18_F_I_EOS                    4       /* End of encoder stream */
 199 #define CX18_F_I_RADIO_USER             5       /* radio tuner is selected */
 200 #define CX18_F_I_ENC_PAUSED             13      /* the encoder is paused */
 201 #define CX18_F_I_INITED                 21      /* set after first open */
 202 #define CX18_F_I_FAILED                 22      /* set if first open failed */
 203
 204 /* These are the VBI types as they appear in the embedded VBI private packets. */
 205 #define CX18_SLICED_TYPE_TELETEXT_B     (1)
 206 #define CX18_SLICED_TYPE_CAPTION_525    (4)
 207 #define CX18_SLICED_TYPE_WSS_625        (5)
 208 #define CX18_SLICED_TYPE_VPS            (7)
 209
 210 struct cx18_buffer {
 211         struct list_head list;
 212         dma_addr_t dma_handle;
 213         u32 id;
 214         unsigned long b_flags;
 215         unsigned skipped;
 216         char *buf;
 217
 218         u32 bytesused;
 219         u32 readpos;
 220 };
 221
 222 struct cx18_queue {
 223         struct list_head list;
 224         atomic_t buffers;
 225         u32 bytesused;
 226 };
 227
 228 struct cx18_dvb {
 229         struct dmx_frontend hw_frontend;
 230         struct dmx_frontend mem_frontend;
 231         struct dmxdev dmxdev;
 232         struct dvb_adapter dvb_adapter;
 233         struct dvb_demux demux;
 234         struct dvb_frontend *fe;
 235         struct dvb_net dvbnet;
 236         int enabled;
 237         int feeding;
 238         struct mutex feedlock;
 239 };
 240
 241 struct cx18;     /* forward reference */
 242 struct cx18_scb; /* forward reference */
 243
 244
 245 #define CX18_MAX_MDL_ACKS 2
 246 #define CX18_MAX_EPU_WORK_ORDERS 70 /* CPU_DE_RELEASE_MDL bursts 63 commands */
 247
 248 #define CX18_F_EWO_MB_STALE_UPON_RECEIPT 0x1
 249 #define CX18_F_EWO_MB_STALE_WHILE_PROC   0x2
 250 #define CX18_F_EWO_MB_STALE \
 251              (CX18_F_EWO_MB_STALE_UPON_RECEIPT | CX18_F_EWO_MB_STALE_WHILE_PROC)
 252
 253 struct cx18_epu_work_order {
 254         struct work_struct work;
 255         atomic_t pending;
 256         struct cx18 *cx;
 257         unsigned long flags;
 258         int rpu;
 259         struct cx18_mailbox mb;
 260         struct cx18_mdl_ack mdl_ack[CX18_MAX_MDL_ACKS];
 261         char *str;
 262 };
 263
 264 #define CX18_INVALID_TASK_HANDLE 0xffffffff
 265
 266 struct cx18_stream {
 267         /* These first four fields are always set, even if the stream
 268            is not actually created. */
 269         struct video_device *v4l2dev;   /* NULL when stream not created */
 270         struct cx18 *cx;                /* for ease of use */
 271         const char *name;               /* name of the stream */
 272         int type;                       /* stream type */
 273         u32 handle;                     /* task handle */
 274         unsigned mdl_offset;
 275
 276         u32 id;
 277         struct mutex qlock;     /* locks access to the queues */
 278         unsigned long s_flags;  /* status flags, see above */
 279         int dma;                /* can be PCI_DMA_TODEVICE,
 280                                    PCI_DMA_FROMDEVICE or
 281                                    PCI_DMA_NONE */
 282         u64 dma_pts;
 283         wait_queue_head_t waitq;
 284
 285         /* Buffer Stats */
 286         u32 buffers;
 287         u32 buf_size;
 288
 289         /* Buffer Queues */
 290         struct cx18_queue q_free;       /* free buffers */
 291         struct cx18_queue q_full;       /* full buffers */
 292         struct cx18_queue q_io;         /* waiting for I/O */
 293
 294         /* DVB / Digital Transport */
 295         struct cx18_dvb dvb;
 296 };
 297
 298 struct cx18_open_id {
 299         u32 open_id;
 300         int type;
 301         enum v4l2_priority prio;
 302         struct cx18 *cx;
 303 };
 304
 305 /* forward declaration of struct defined in cx18-cards.h */
 306 struct cx18_card;
 307
 308
 309 #define CX18_VBI_FRAMES 32
 310
 311 /* VBI data */
 312 struct vbi_info {
 313         u32 enc_size;
 314         u32 frame;
 315         u8 cc_data_odd[256];
 316         u8 cc_data_even[256];
 317         int cc_pos;
 318         u8 cc_no_update;
 319         u8 vps[5];
 320         u8 vps_found;
 321         int wss;
 322         u8 wss_found;
 323         u8 wss_no_update;
 324         u32 raw_decoder_line_size;
 325         u8 raw_decoder_sav_odd_field;
 326         u8 raw_decoder_sav_even_field;
 327         u32 sliced_decoder_line_size;
 328         u8 sliced_decoder_sav_odd_field;
 329         u8 sliced_decoder_sav_even_field;
 330         struct v4l2_format in;
 331         /* convenience pointer to sliced struct in vbi_in union */
 332         struct v4l2_sliced_vbi_format *sliced_in;
 333         u32 service_set_in;
 334         int insert_mpeg;
 335
 336         /* Buffer for the maximum of 2 * 18 * packet_size sliced VBI lines.
 337            One for /dev/vbi0 and one for /dev/vbi8 */
 338         struct v4l2_sliced_vbi_data sliced_data[36];
 339
 340         /* Buffer for VBI data inserted into MPEG stream.
 341            The first byte is a dummy byte that's never used.
 342            The next 16 bytes contain the MPEG header for the VBI data,
 343            the remainder is the actual VBI data.
 344            The max size accepted by the MPEG VBI reinsertion turns out
 345            to be 1552 bytes, which happens to be 4 + (1 + 42) * (2 * 18) bytes,
 346            where 4 is a four byte header, 42 is the max sliced VBI payload, 1 is
 347            a single line header byte and 2 * 18 is the number of VBI lines per frame.
 348
 349            However, it seems that the data must be 1K aligned, so we have to
 350            pad the data until the 1 or 2 K boundary.
 351
 352            This pointer array will allocate 2049 bytes to store each VBI frame. */
 353         u8 *sliced_mpeg_data[CX18_VBI_FRAMES];
 354         u32 sliced_mpeg_size[CX18_VBI_FRAMES];
 355         struct cx18_buffer sliced_mpeg_buf;
 356         u32 inserted_frame;
 357
 358         u32 start[2], count;
 359         u32 raw_size;
 360         u32 sliced_size;
 361 };
 362
 363 /* Per cx23418, per I2C bus private algo callback data */
 364 struct cx18_i2c_algo_callback_data {
 365         struct cx18 *cx;
 366         int bus_index;   /* 0 or 1 for the cx23418's 1st or 2nd I2C bus */
 367 };
 368
 369 #define CX18_MAX_MMIO_WR_RETRIES 10
 370
 371 /* Struct to hold info about cx18 cards */
 372 struct cx18 {
 373         int num;                /* board number, -1 during init! */
 374         char name[8];           /* board name for printk and interrupts (e.g. 'cx180') */
 375         struct pci_dev *dev;    /* PCI device */
 376         const struct cx18_card *card;   /* card information */
 377         const char *card_name;  /* full name of the card */
 378         const struct cx18_card_tuner_i2c *card_i2c; /* i2c addresses to probe for tuner */
 379         u8 is_50hz;
 380         u8 is_60hz;
 381         u8 is_out_50hz;
 382         u8 is_out_60hz;
 383         u8 nof_inputs;          /* number of video inputs */
 384         u8 nof_audio_inputs;    /* number of audio inputs */
 385         u16 buffer_id;          /* buffer ID counter */
 386         u32 v4l2_cap;           /* V4L2 capabilities of card */
 387         u32 hw_flags;           /* Hardware description of the board */
 388         unsigned mdl_offset;
 389         struct cx18_scb __iomem *scb; /* pointer to SCB */
 390         struct mutex epu2apu_mb_lock; /* protect driver to chip mailbox in SCB*/
 391         struct mutex epu2cpu_mb_lock; /* protect driver to chip mailbox in SCB*/
 392
 393         struct cx18_av_state av_state;
 394
 395         /* codec settings */
 396         struct cx2341x_mpeg_params params;
 397         u32 filter_mode;
 398         u32 temporal_strength;
 399         u32 spatial_strength;
 400
 401         /* dualwatch */
 402         unsigned long dualwatch_jiffies;
 403         u16 dualwatch_stereo_mode;
 404
 405         /* Digitizer type */
 406         int digitizer;          /* 0x00EF = saa7114 0x00FO = saa7115 0x0106 = mic */
 407
 408         struct mutex serialize_lock;    /* mutex used to serialize open/close/start/stop/ioctl operations */
 409         struct cx18_options options;    /* User options */
 410         int stream_buf_size[CX18_MAX_STREAMS]; /* Stream buffer size */
 411         struct cx18_stream streams[CX18_MAX_STREAMS];   /* Stream data */
 412         unsigned long i_flags;  /* global cx18 flags */
 413         atomic_t ana_capturing; /* count number of active analog capture streams */
 414         atomic_t tot_capturing; /* total count number of active capture streams */
 415         spinlock_t lock;        /* lock access to this struct */
 416         int search_pack_header;
 417
 418         int open_id;            /* incremented each time an open occurs, used as
 419                                    unique ID. Starts at 1, so 0 can be used as
 420                                    uninitialized value in the stream->id. */
 421
 422         u32 base_addr;
 423         struct v4l2_prio_state prio;
 424
 425         u8 card_rev;
 426         void __iomem *enc_mem, *reg_mem;
 427
 428         struct vbi_info vbi;
 429
 430         u32 pgm_info_offset;
 431         u32 pgm_info_num;
 432         u32 pgm_info_write_idx;
 433         u32 pgm_info_read_idx;
 434         struct v4l2_enc_idx_entry pgm_info[CX18_MAX_PGM_INDEX];
 435
 436         u64 mpg_data_received;
 437         u64 vbi_data_inserted;
 438
 439         wait_queue_head_t mb_apu_waitq;
 440         wait_queue_head_t mb_cpu_waitq;
 441         wait_queue_head_t cap_w;
 442         /* when the current DMA is finished this queue is woken up */
 443         wait_queue_head_t dma_waitq;
 444
 445         u32 sw1_irq_mask;
 446         u32 sw2_irq_mask;
 447         u32 hw2_irq_mask;
 448
 449         struct cx18_epu_work_order epu_work_order[CX18_MAX_EPU_WORK_ORDERS];
 450         char epu_debug_str[256]; /* CX18_EPU_DEBUG is rare: use shared space */
 451
 452         /* i2c */
 453         struct i2c_adapter i2c_adap[2];
 454         struct i2c_algo_bit_data i2c_algo[2];
 455         struct cx18_i2c_algo_callback_data i2c_algo_cb_data[2];
 456         struct i2c_client i2c_client[2];
 457         struct mutex i2c_bus_lock[2];
 458         struct i2c_client *i2c_clients[I2C_CLIENTS_MAX];
 459
 460         /* gpio */
 461         u32 gpio_dir;
 462         u32 gpio_val;
 463         struct mutex gpio_lock;
 464
 465         /* v4l2 and User settings */
 466
 467         /* codec settings */
 468         u32 audio_input;
 469         u32 active_input;
 470         u32 active_output;
 471         v4l2_std_id std;
 472         v4l2_std_id tuner_std;  /* The norm of the tuner (fixed) */
 473 };
 474
 475 /* Globals */
 476 extern struct cx18 *cx18_cards[];
 477 extern int cx18_cards_active;
 478 extern int cx18_first_minor;
 479 extern spinlock_t cx18_cards_lock;
 480 extern struct workqueue_struct *cx18_work_queue;
 481
 482 /*==============Prototypes==================*/
 483
 484 /* Return non-zero if a signal is pending */
 485 int cx18_msleep_timeout(unsigned int msecs, int intr);
 486
 487 /* Read Hauppauge eeprom */
 488 struct tveeprom; /* forward reference */
 489 void cx18_read_eeprom(struct cx18 *cx, struct tveeprom *tv);
 490
 491 /* First-open initialization: load firmware, etc. */
 492 int cx18_init_on_first_open(struct cx18 *cx);
 493
 494 #endif /* CX18_DRIVER_H */