drivers/media/video/cx23885/cx23885.h

   1 /*
   2  *  Driver for the Conexant CX23885 PCIe bridge
   3  *
   4  *  Copyright (c) 2006 Steven Toth <stoth@linuxtv.org>
   5  *
   6  *  This program is free software; you can redistribute it and/or modify
   7  *  it under the terms of the GNU General Public License as published by
   8  *  the Free Software Foundation; either version 2 of the License, or
   9  *  (at your option) any later version.
  10  *
  11  *  This program is distributed in the hope that it will be useful,
  12  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  *
  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., 675 Mass Ave, Cambridge, MA 02139, USA.
  20  */
  21
  22 #include <linux/pci.h>
  23 #include <linux/i2c.h>
  24 #include <linux/i2c-algo-bit.h>
  25 #include <linux/kdev_t.h>
  26
  27 #include <media/v4l2-device.h>
  28 #include <media/tuner.h>
  29 #include <media/tveeprom.h>
  30 #include <media/videobuf-dma-sg.h>
  31 #include <media/videobuf-dvb.h>
  32
  33 #include "btcx-risc.h"
  34 #include "cx23885-reg.h"
  35 #include "media/cx2341x.h"
  36
  37 #include <linux/version.h>
  38 #include <linux/mutex.h>
  39
  40 #define CX23885_VERSION_CODE KERNEL_VERSION(0, 0, 2)
  41
  42 #define UNSET (-1U)
  43
  44 #define CX23885_MAXBOARDS 8
  45
  46 /* Max number of inputs by card */
  47 #define MAX_CX23885_INPUT 8
  48 #define INPUT(nr) (&cx23885_boards[dev->board].input[nr])
  49 #define RESOURCE_OVERLAY       1
  50 #define RESOURCE_VIDEO         2
  51 #define RESOURCE_VBI           4
  52
  53 #define BUFFER_TIMEOUT     (HZ)  /* 0.5 seconds */
  54
  55 #define CX23885_BOARD_NOAUTO               UNSET
  56 #define CX23885_BOARD_UNKNOWN                  0
  57 #define CX23885_BOARD_HAUPPAUGE_HVR1800lp      1
  58 #define CX23885_BOARD_HAUPPAUGE_HVR1800        2
  59 #define CX23885_BOARD_HAUPPAUGE_HVR1250        3
  60 #define CX23885_BOARD_DVICO_FUSIONHDTV_5_EXP   4
  61 #define CX23885_BOARD_HAUPPAUGE_HVR1500Q       5
  62 #define CX23885_BOARD_HAUPPAUGE_HVR1500        6
  63 #define CX23885_BOARD_HAUPPAUGE_HVR1200        7
  64 #define CX23885_BOARD_HAUPPAUGE_HVR1700        8
  65 #define CX23885_BOARD_HAUPPAUGE_HVR1400        9
  66 #define CX23885_BOARD_DVICO_FUSIONHDTV_7_DUAL_EXP 10
  67 #define CX23885_BOARD_DVICO_FUSIONHDTV_DVB_T_DUAL_EXP 11
  68 #define CX23885_BOARD_LEADTEK_WINFAST_PXDVR3200_H 12
  69 #define CX23885_BOARD_COMPRO_VIDEOMATE_E650F   13
  70 #define CX23885_BOARD_TBS_6920                 14
  71 #define CX23885_BOARD_TEVII_S470               15
  72 #define CX23885_BOARD_DVBWORLD_2005            16
  73 #define CX23885_BOARD_NETUP_DUAL_DVBS2_CI      17
  74 #define CX23885_BOARD_HAUPPAUGE_HVR1270        18
  75 #define CX23885_BOARD_HAUPPAUGE_HVR1275        19
  76 #define CX23885_BOARD_HAUPPAUGE_HVR1255        20
  77 #define CX23885_BOARD_HAUPPAUGE_HVR1210        21
  78 #define CX23885_BOARD_MYGICA_X8506             22
  79 #define CX23885_BOARD_MAGICPRO_PROHDTVE2       23
  80 #define CX23885_BOARD_HAUPPAUGE_HVR1850        24
  81 #define CX23885_BOARD_COMPRO_VIDEOMATE_E800    25
  82 #define CX23885_BOARD_HAUPPAUGE_HVR1290        26
  83 #define CX23885_BOARD_MYGICA_X8558PRO          27
  84
  85 #define GPIO_0 0x00000001
  86 #define GPIO_1 0x00000002
  87 #define GPIO_2 0x00000004
  88 #define GPIO_3 0x00000008
  89 #define GPIO_4 0x00000010
  90 #define GPIO_5 0x00000020
  91 #define GPIO_6 0x00000040
  92 #define GPIO_7 0x00000080
  93 #define GPIO_8 0x00000100
  94 #define GPIO_9 0x00000200
  95 #define GPIO_10 0x00000400
  96 #define GPIO_11 0x00000800
  97 #define GPIO_12 0x00001000
  98 #define GPIO_13 0x00002000
  99 #define GPIO_14 0x00004000
 100 #define GPIO_15 0x00008000
 101
 102 /* Currently unsupported by the driver: PAL/H, NTSC/Kr, SECAM B/G/H/LC */
 103 #define CX23885_NORMS (\
 104         V4L2_STD_NTSC_M |  V4L2_STD_NTSC_M_JP |  V4L2_STD_NTSC_443 | \
 105         V4L2_STD_PAL_BG |  V4L2_STD_PAL_DK    |  V4L2_STD_PAL_I    | \
 106         V4L2_STD_PAL_M  |  V4L2_STD_PAL_N     |  V4L2_STD_PAL_Nc   | \
 107         V4L2_STD_PAL_60 |  V4L2_STD_SECAM_L   |  V4L2_STD_SECAM_DK)
 108
 109 struct cx23885_fmt {
 110         char  *name;
 111         u32   fourcc;          /* v4l2 format id */
 112         int   depth;
 113         int   flags;
 114         u32   cxformat;
 115 };
 116
 117 struct cx23885_ctrl {
 118         struct v4l2_queryctrl v;
 119         u32                   off;
 120         u32                   reg;
 121         u32                   mask;
 122         u32                   shift;
 123 };
 124
 125 struct cx23885_tvnorm {
 126         char            *name;
 127         v4l2_std_id     id;
 128         u32             cxiformat;
 129         u32             cxoformat;
 130 };
 131
 132 struct cx23885_fh {
 133         struct cx23885_dev         *dev;
 134         enum v4l2_buf_type         type;
 135         int                        radio;
 136         u32                        resources;
 137
 138         /* video overlay */
 139         struct v4l2_window         win;
 140         struct v4l2_clip           *clips;
 141         unsigned int               nclips;
 142
 143         /* video capture */
 144         struct cx23885_fmt         *fmt;
 145         unsigned int               width, height;
 146
 147         /* vbi capture */
 148         struct videobuf_queue      vidq;
 149         struct videobuf_queue      vbiq;
 150
 151         /* MPEG Encoder specifics ONLY */
 152         struct videobuf_queue      mpegq;
 153         atomic_t                   v4l_reading;
 154 };
 155
 156 enum cx23885_itype {
 157         CX23885_VMUX_COMPOSITE1 = 1,
 158         CX23885_VMUX_COMPOSITE2,
 159         CX23885_VMUX_COMPOSITE3,
 160         CX23885_VMUX_COMPOSITE4,
 161         CX23885_VMUX_SVIDEO,
 162         CX23885_VMUX_COMPONENT,
 163         CX23885_VMUX_TELEVISION,
 164         CX23885_VMUX_CABLE,
 165         CX23885_VMUX_DVB,
 166         CX23885_VMUX_DEBUG,
 167         CX23885_RADIO,
 168 };
 169
 170 enum cx23885_src_sel_type {
 171         CX23885_SRC_SEL_EXT_656_VIDEO = 0,
 172         CX23885_SRC_SEL_PARALLEL_MPEG_VIDEO
 173 };
 174
 175 /* buffer for one video frame */
 176 struct cx23885_buffer {
 177         /* common v4l buffer stuff -- must be first */
 178         struct videobuf_buffer vb;
 179
 180         /* cx23885 specific */
 181         unsigned int           bpl;
 182         struct btcx_riscmem    risc;
 183         struct cx23885_fmt     *fmt;
 184         u32                    count;
 185 };
 186
 187 struct cx23885_input {
 188         enum cx23885_itype type;
 189         unsigned int    vmux;
 190         u32             gpio0, gpio1, gpio2, gpio3;
 191 };
 192
 193 typedef enum {
 194         CX23885_MPEG_UNDEFINED = 0,
 195         CX23885_MPEG_DVB,
 196         CX23885_ANALOG_VIDEO,
 197         CX23885_MPEG_ENCODER,
 198 } port_t;
 199
 200 struct cx23885_board {
 201         char                    *name;
 202         port_t                  porta, portb, portc;
 203         unsigned int            tuner_type;
 204         unsigned int            radio_type;
 205         unsigned char           tuner_addr;
 206         unsigned char           radio_addr;
 207
 208         /* Vendors can and do run the PCIe bridge at different
 209          * clock rates, driven physically by crystals on the PCBs.
 210          * The core has to accomodate this. This allows the user
 211          * to add new boards with new frequencys. The value is
 212          * expressed in Hz.
 213          *
 214          * The core framework will default this value based on
 215          * current designs, but it can vary.
 216          */
 217         u32                     clk_freq;
 218         struct cx23885_input    input[MAX_CX23885_INPUT];
 219         int                     cimax; /* for NetUP */
 220 };
 221
 222 struct cx23885_subid {
 223         u16     subvendor;
 224         u16     subdevice;
 225         u32     card;
 226 };
 227
 228 struct cx23885_i2c {
 229         struct cx23885_dev *dev;
 230
 231         int                        nr;
 232
 233         /* i2c i/o */
 234         struct i2c_adapter         i2c_adap;
 235         struct i2c_algo_bit_data   i2c_algo;
 236         struct i2c_client          i2c_client;
 237         u32                        i2c_rc;
 238
 239         /* 885 registers used for raw addess */
 240         u32                        i2c_period;
 241         u32                        reg_ctrl;
 242         u32                        reg_stat;
 243         u32                        reg_addr;
 244         u32                        reg_rdata;
 245         u32                        reg_wdata;
 246 };
 247
 248 struct cx23885_dmaqueue {
 249         struct list_head       active;
 250         struct list_head       queued;
 251         struct timer_list      timeout;
 252         struct btcx_riscmem    stopper;
 253         u32                    count;
 254 };
 255
 256 struct cx23885_tsport {
 257         struct cx23885_dev *dev;
 258
 259         int                        nr;
 260         int                        sram_chno;
 261
 262         struct videobuf_dvb_frontends frontends;
 263
 264         /* dma queues */
 265         struct cx23885_dmaqueue    mpegq;
 266         u32                        ts_packet_size;
 267         u32                        ts_packet_count;
 268
 269         int                        width;
 270         int                        height;
 271
 272         spinlock_t                 slock;
 273
 274         /* registers */
 275         u32                        reg_gpcnt;
 276         u32                        reg_gpcnt_ctl;
 277         u32                        reg_dma_ctl;
 278         u32                        reg_lngth;
 279         u32                        reg_hw_sop_ctrl;
 280         u32                        reg_gen_ctrl;
 281         u32                        reg_bd_pkt_status;
 282         u32                        reg_sop_status;
 283         u32                        reg_fifo_ovfl_stat;
 284         u32                        reg_vld_misc;
 285         u32                        reg_ts_clk_en;
 286         u32                        reg_ts_int_msk;
 287         u32                        reg_ts_int_stat;
 288         u32                        reg_src_sel;
 289
 290         /* Default register vals */
 291         int                        pci_irqmask;
 292         u32                        dma_ctl_val;
 293         u32                        ts_int_msk_val;
 294         u32                        gen_ctrl_val;
 295         u32                        ts_clk_en_val;
 296         u32                        src_sel_val;
 297         u32                        vld_misc_val;
 298         u32                        hw_sop_ctrl_val;
 299
 300         /* Allow a single tsport to have multiple frontends */
 301         u32                        num_frontends;
 302         void                       *port_priv;
 303 };
 304
 305 struct cx23885_dev {
 306         atomic_t                   refcount;
 307         struct v4l2_device         v4l2_dev;
 308
 309         /* pci stuff */
 310         struct pci_dev             *pci;
 311         unsigned char              pci_rev, pci_lat;
 312         int                        pci_bus, pci_slot;
 313         u32                        __iomem *lmmio;
 314         u8                         __iomem *bmmio;
 315         int                        pci_irqmask;
 316         int                        hwrevision;
 317
 318         /* This valud is board specific and is used to configure the
 319          * AV core so we see nice clean and stable video and audio. */
 320         u32                        clk_freq;
 321
 322         /* I2C adapters: Master 1 & 2 (External) & Master 3 (Internal only) */
 323         struct cx23885_i2c         i2c_bus[3];
 324
 325         int                        nr;
 326         struct mutex               lock;
 327         struct mutex               gpio_lock;
 328
 329         /* board details */
 330         unsigned int               board;
 331         char                       name[32];
 332
 333         struct cx23885_tsport      ts1, ts2;
 334
 335         /* sram configuration */
 336         struct sram_channel        *sram_channels;
 337
 338         enum {
 339                 CX23885_BRIDGE_UNDEFINED = 0,
 340                 CX23885_BRIDGE_885 = 885,
 341                 CX23885_BRIDGE_887 = 887,
 342                 CX23885_BRIDGE_888 = 888,
 343         } bridge;
 344
 345         /* Analog video */
 346         u32                        resources;
 347         unsigned int               input;
 348         u32                        tvaudio;
 349         v4l2_std_id                tvnorm;
 350         unsigned int               tuner_type;
 351         unsigned char              tuner_addr;
 352         unsigned int               radio_type;
 353         unsigned char              radio_addr;
 354         unsigned int               has_radio;
 355         struct v4l2_subdev         *sd_cx25840;
 356
 357         /* Infrared */
 358         struct v4l2_subdev         *sd_ir;
 359         struct work_struct         ir_rx_work;
 360         unsigned long              ir_rx_notifications;
 361         struct work_struct         ir_tx_work;
 362         unsigned long              ir_tx_notifications;
 363
 364         struct card_ir             *ir_input;
 365         atomic_t                   ir_input_stopping;
 366
 367         /* V4l */
 368         u32                        freq;
 369         struct video_device        *video_dev;
 370         struct video_device        *vbi_dev;
 371         struct video_device        *radio_dev;
 372
 373         struct cx23885_dmaqueue    vidq;
 374         struct cx23885_dmaqueue    vbiq;
 375         spinlock_t                 slock;
 376
 377         /* MPEG Encoder ONLY settings */
 378         u32                        cx23417_mailbox;
 379         struct cx2341x_mpeg_params mpeg_params;
 380         struct video_device        *v4l_device;
 381         atomic_t                   v4l_reader_count;
 382         struct cx23885_tvnorm      encodernorm;
 383
 384 };
 385
 386 static inline struct cx23885_dev *to_cx23885(struct v4l2_device *v4l2_dev)
 387 {
 388         return container_of(v4l2_dev, struct cx23885_dev, v4l2_dev);
 389 }
 390
 391 #define call_all(dev, o, f, args...) \
 392         v4l2_device_call_all(&dev->v4l2_dev, 0, o, f, ##args)
 393
 394 #define CX23885_HW_888_IR (1 << 0)
 395
 396 #define call_hw(dev, grpid, o, f, args...) \
 397         v4l2_device_call_all(&dev->v4l2_dev, grpid, o, f, ##args)
 398
 399 extern struct v4l2_subdev *cx23885_find_hw(struct cx23885_dev *dev, u32 hw);
 400
 401 #define SRAM_CH01  0 /* Video A */
 402 #define SRAM_CH02  1 /* VBI A */
 403 #define SRAM_CH03  2 /* Video B */
 404 #define SRAM_CH04  3 /* Transport via B */
 405 #define SRAM_CH05  4 /* VBI B */
 406 #define SRAM_CH06  5 /* Video C */
 407 #define SRAM_CH07  6 /* Transport via C */
 408 #define SRAM_CH08  7 /* Audio Internal A */
 409 #define SRAM_CH09  8 /* Audio Internal B */
 410 #define SRAM_CH10  9 /* Audio External */
 411 #define SRAM_CH11 10 /* COMB_3D_N */
 412 #define SRAM_CH12 11 /* Comb 3D N1 */
 413 #define SRAM_CH13 12 /* Comb 3D N2 */
 414 #define SRAM_CH14 13 /* MOE Vid */
 415 #define SRAM_CH15 14 /* MOE RSLT */
 416
 417 struct sram_channel {
 418         char *name;
 419         u32  cmds_start;
 420         u32  ctrl_start;
 421         u32  cdt;
 422         u32  fifo_start;
 423         u32  fifo_size;
 424         u32  ptr1_reg;
 425         u32  ptr2_reg;
 426         u32  cnt1_reg;
 427         u32  cnt2_reg;
 428         u32  jumponly;
 429 };
 430
 431 /* ----------------------------------------------------------- */
 432
 433 #define cx_read(reg)             readl(dev->lmmio + ((reg)>>2))
 434 #define cx_write(reg, value)     writel((value), dev->lmmio + ((reg)>>2))
 435
 436 #define cx_andor(reg, mask, value) \
 437   writel((readl(dev->lmmio+((reg)>>2)) & ~(mask)) |\
 438   ((value) & (mask)), dev->lmmio+((reg)>>2))
 439
 440 #define cx_set(reg, bit)          cx_andor((reg), (bit), (bit))
 441 #define cx_clear(reg, bit)        cx_andor((reg), (bit), 0)
 442
 443 /* ----------------------------------------------------------- */
 444 /* cx23885-core.c                                              */
 445
 446 extern int cx23885_sram_channel_setup(struct cx23885_dev *dev,
 447         struct sram_channel *ch,
 448         unsigned int bpl, u32 risc);
 449
 450 extern void cx23885_sram_channel_dump(struct cx23885_dev *dev,
 451         struct sram_channel *ch);
 452
 453 extern int cx23885_risc_stopper(struct pci_dev *pci, struct btcx_riscmem *risc,
 454         u32 reg, u32 mask, u32 value);
 455
 456 extern int cx23885_risc_buffer(struct pci_dev *pci, struct btcx_riscmem *risc,
 457         struct scatterlist *sglist,
 458         unsigned int top_offset, unsigned int bottom_offset,
 459         unsigned int bpl, unsigned int padding, unsigned int lines);
 460
 461 void cx23885_cancel_buffers(struct cx23885_tsport *port);
 462
 463 extern int cx23885_restart_queue(struct cx23885_tsport *port,
 464                                 struct cx23885_dmaqueue *q);
 465
 466 extern void cx23885_wakeup(struct cx23885_tsport *port,
 467                            struct cx23885_dmaqueue *q, u32 count);
 468
 469 extern void cx23885_gpio_set(struct cx23885_dev *dev, u32 mask);
 470 extern void cx23885_gpio_clear(struct cx23885_dev *dev, u32 mask);
 471 extern u32 cx23885_gpio_get(struct cx23885_dev *dev, u32 mask);
 472 extern void cx23885_gpio_enable(struct cx23885_dev *dev, u32 mask,
 473         int asoutput);
 474
 475
 476 /* ----------------------------------------------------------- */
 477 /* cx23885-cards.c                                             */
 478 extern struct cx23885_board cx23885_boards[];
 479 extern const unsigned int cx23885_bcount;
 480
 481 extern struct cx23885_subid cx23885_subids[];
 482 extern const unsigned int cx23885_idcount;
 483
 484 extern int cx23885_tuner_callback(void *priv, int component,
 485         int command, int arg);
 486 extern void cx23885_card_list(struct cx23885_dev *dev);
 487 extern int  cx23885_ir_init(struct cx23885_dev *dev);
 488 extern void cx23885_ir_pci_int_enable(struct cx23885_dev *dev);
 489 extern void cx23885_ir_fini(struct cx23885_dev *dev);
 490 extern void cx23885_gpio_setup(struct cx23885_dev *dev);
 491 extern void cx23885_card_setup(struct cx23885_dev *dev);
 492 extern void cx23885_card_setup_pre_i2c(struct cx23885_dev *dev);
 493
 494 extern int cx23885_dvb_register(struct cx23885_tsport *port);
 495 extern int cx23885_dvb_unregister(struct cx23885_tsport *port);
 496
 497 extern int cx23885_buf_prepare(struct videobuf_queue *q,
 498                                struct cx23885_tsport *port,
 499                                struct cx23885_buffer *buf,
 500                                enum v4l2_field field);
 501 extern void cx23885_buf_queue(struct cx23885_tsport *port,
 502                               struct cx23885_buffer *buf);
 503 extern void cx23885_free_buffer(struct videobuf_queue *q,
 504                                 struct cx23885_buffer *buf);
 505
 506 /* ----------------------------------------------------------- */
 507 /* cx23885-video.c                                             */
 508 /* Video */
 509 extern int cx23885_video_register(struct cx23885_dev *dev);
 510 extern void cx23885_video_unregister(struct cx23885_dev *dev);
 511 extern int cx23885_video_irq(struct cx23885_dev *dev, u32 status);
 512
 513 /* ----------------------------------------------------------- */
 514 /* cx23885-vbi.c                                               */
 515 extern int cx23885_vbi_fmt(struct file *file, void *priv,
 516         struct v4l2_format *f);
 517 extern void cx23885_vbi_timeout(unsigned long data);
 518 extern struct videobuf_queue_ops cx23885_vbi_qops;
 519
 520 /* cx23885-i2c.c                                                */
 521 extern int cx23885_i2c_register(struct cx23885_i2c *bus);
 522 extern int cx23885_i2c_unregister(struct cx23885_i2c *bus);
 523 extern void cx23885_av_clk(struct cx23885_dev *dev, int enable);
 524
 525 /* ----------------------------------------------------------- */
 526 /* cx23885-417.c                                               */
 527 extern int cx23885_417_register(struct cx23885_dev *dev);
 528 extern void cx23885_417_unregister(struct cx23885_dev *dev);
 529 extern int cx23885_irq_417(struct cx23885_dev *dev, u32 status);
 530 extern void cx23885_417_check_encoder(struct cx23885_dev *dev);
 531 extern void cx23885_mc417_init(struct cx23885_dev *dev);
 532 extern int mc417_memory_read(struct cx23885_dev *dev, u32 address, u32 *value);
 533 extern int mc417_memory_write(struct cx23885_dev *dev, u32 address, u32 value);
 534 extern int mc417_register_read(struct cx23885_dev *dev,
 535                                 u16 address, u32 *value);
 536 extern int mc417_register_write(struct cx23885_dev *dev,
 537                                 u16 address, u32 value);
 538 extern void mc417_gpio_set(struct cx23885_dev *dev, u32 mask);
 539 extern void mc417_gpio_clear(struct cx23885_dev *dev, u32 mask);
 540 extern void mc417_gpio_enable(struct cx23885_dev *dev, u32 mask, int asoutput);
 541
 542
 543 /* ----------------------------------------------------------- */
 544 /* tv norms                                                    */
 545
 546 static inline unsigned int norm_maxw(v4l2_std_id norm)
 547 {
 548         return (norm & (V4L2_STD_MN & ~V4L2_STD_PAL_Nc)) ? 720 : 768;
 549 }
 550
 551 static inline unsigned int norm_maxh(v4l2_std_id norm)
 552 {
 553         return (norm & V4L2_STD_625_50) ? 576 : 480;
 554 }
 555
 556 static inline unsigned int norm_swidth(v4l2_std_id norm)
 557 {
 558         return (norm & (V4L2_STD_MN & ~V4L2_STD_PAL_Nc)) ? 754 : 922;
 559 }