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
  76 #define GPIO_0 0x00000001
  77 #define GPIO_1 0x00000002
  78 #define GPIO_2 0x00000004
  79 #define GPIO_3 0x00000008
  80 #define GPIO_4 0x00000010
  81 #define GPIO_5 0x00000020
  82 #define GPIO_6 0x00000040
  83 #define GPIO_7 0x00000080
  84 #define GPIO_8 0x00000100
  85 #define GPIO_9 0x00000200
  86
  87 /* Currently unsupported by the driver: PAL/H, NTSC/Kr, SECAM B/G/H/LC */
  88 #define CX23885_NORMS (\
  89         V4L2_STD_NTSC_M |  V4L2_STD_NTSC_M_JP |  V4L2_STD_NTSC_443 | \
  90         V4L2_STD_PAL_BG |  V4L2_STD_PAL_DK    |  V4L2_STD_PAL_I    | \
  91         V4L2_STD_PAL_M  |  V4L2_STD_PAL_N     |  V4L2_STD_PAL_Nc   | \
  92         V4L2_STD_PAL_60 |  V4L2_STD_SECAM_L   |  V4L2_STD_SECAM_DK)
  93
  94 struct cx23885_fmt {
  95         char  *name;
  96         u32   fourcc;          /* v4l2 format id */
  97         int   depth;
  98         int   flags;
  99         u32   cxformat;
 100 };
 101
 102 struct cx23885_ctrl {
 103         struct v4l2_queryctrl v;
 104         u32                   off;
 105         u32                   reg;
 106         u32                   mask;
 107         u32                   shift;
 108 };
 109
 110 struct cx23885_tvnorm {
 111         char            *name;
 112         v4l2_std_id     id;
 113         u32             cxiformat;
 114         u32             cxoformat;
 115 };
 116
 117 struct cx23885_fh {
 118         struct cx23885_dev         *dev;
 119         enum v4l2_buf_type         type;
 120         int                        radio;
 121         u32                        resources;
 122
 123         /* video overlay */
 124         struct v4l2_window         win;
 125         struct v4l2_clip           *clips;
 126         unsigned int               nclips;
 127
 128         /* video capture */
 129         struct cx23885_fmt         *fmt;
 130         unsigned int               width, height;
 131
 132         /* vbi capture */
 133         struct videobuf_queue      vidq;
 134         struct videobuf_queue      vbiq;
 135
 136         /* MPEG Encoder specifics ONLY */
 137         struct videobuf_queue      mpegq;
 138         atomic_t                   v4l_reading;
 139 };
 140
 141 enum cx23885_itype {
 142         CX23885_VMUX_COMPOSITE1 = 1,
 143         CX23885_VMUX_COMPOSITE2,
 144         CX23885_VMUX_COMPOSITE3,
 145         CX23885_VMUX_COMPOSITE4,
 146         CX23885_VMUX_SVIDEO,
 147         CX23885_VMUX_TELEVISION,
 148         CX23885_VMUX_CABLE,
 149         CX23885_VMUX_DVB,
 150         CX23885_VMUX_DEBUG,
 151         CX23885_RADIO,
 152 };
 153
 154 enum cx23885_src_sel_type {
 155         CX23885_SRC_SEL_EXT_656_VIDEO = 0,
 156         CX23885_SRC_SEL_PARALLEL_MPEG_VIDEO
 157 };
 158
 159 /* buffer for one video frame */
 160 struct cx23885_buffer {
 161         /* common v4l buffer stuff -- must be first */
 162         struct videobuf_buffer vb;
 163
 164         /* cx23885 specific */
 165         unsigned int           bpl;
 166         struct btcx_riscmem    risc;
 167         struct cx23885_fmt     *fmt;
 168         u32                    count;
 169 };
 170
 171 struct cx23885_input {
 172         enum cx23885_itype type;
 173         unsigned int    vmux;
 174         u32             gpio0, gpio1, gpio2, gpio3;
 175 };
 176
 177 typedef enum {
 178         CX23885_MPEG_UNDEFINED = 0,
 179         CX23885_MPEG_DVB,
 180         CX23885_ANALOG_VIDEO,
 181         CX23885_MPEG_ENCODER,
 182 } port_t;
 183
 184 struct cx23885_board {
 185         char                    *name;
 186         port_t                  porta, portb, portc;
 187         unsigned int            tuner_type;
 188         unsigned int            radio_type;
 189         unsigned char           tuner_addr;
 190         unsigned char           radio_addr;
 191
 192         /* Vendors can and do run the PCIe bridge at different
 193          * clock rates, driven physically by crystals on the PCBs.
 194          * The core has to accomodate this. This allows the user
 195          * to add new boards with new frequencys. The value is
 196          * expressed in Hz.
 197          *
 198          * The core framework will default this value based on
 199          * current designs, but it can vary.
 200          */
 201         u32                     clk_freq;
 202         struct cx23885_input    input[MAX_CX23885_INPUT];
 203         int                     cimax; /* for NetUP */
 204 };
 205
 206 struct cx23885_subid {
 207         u16     subvendor;
 208         u16     subdevice;
 209         u32     card;
 210 };
 211
 212 struct cx23885_i2c {
 213         struct cx23885_dev *dev;
 214
 215         int                        nr;
 216
 217         /* i2c i/o */
 218         struct i2c_adapter         i2c_adap;
 219         struct i2c_algo_bit_data   i2c_algo;
 220         struct i2c_client          i2c_client;
 221         u32                        i2c_rc;
 222
 223         /* 885 registers used for raw addess */
 224         u32                        i2c_period;
 225         u32                        reg_ctrl;
 226         u32                        reg_stat;
 227         u32                        reg_addr;
 228         u32                        reg_rdata;
 229         u32                        reg_wdata;
 230 };
 231
 232 struct cx23885_dmaqueue {
 233         struct list_head       active;
 234         struct list_head       queued;
 235         struct timer_list      timeout;
 236         struct btcx_riscmem    stopper;
 237         u32                    count;
 238 };
 239
 240 struct cx23885_tsport {
 241         struct cx23885_dev *dev;
 242
 243         int                        nr;
 244         int                        sram_chno;
 245
 246         struct videobuf_dvb_frontends frontends;
 247
 248         /* dma queues */
 249         struct cx23885_dmaqueue    mpegq;
 250         u32                        ts_packet_size;
 251         u32                        ts_packet_count;
 252
 253         int                        width;
 254         int                        height;
 255
 256         spinlock_t                 slock;
 257
 258         /* registers */
 259         u32                        reg_gpcnt;
 260         u32                        reg_gpcnt_ctl;
 261         u32                        reg_dma_ctl;
 262         u32                        reg_lngth;
 263         u32                        reg_hw_sop_ctrl;
 264         u32                        reg_gen_ctrl;
 265         u32                        reg_bd_pkt_status;
 266         u32                        reg_sop_status;
 267         u32                        reg_fifo_ovfl_stat;
 268         u32                        reg_vld_misc;
 269         u32                        reg_ts_clk_en;
 270         u32                        reg_ts_int_msk;
 271         u32                        reg_ts_int_stat;
 272         u32                        reg_src_sel;
 273
 274         /* Default register vals */
 275         int                        pci_irqmask;
 276         u32                        dma_ctl_val;
 277         u32                        ts_int_msk_val;
 278         u32                        gen_ctrl_val;
 279         u32                        ts_clk_en_val;
 280         u32                        src_sel_val;
 281         u32                        vld_misc_val;
 282         u32                        hw_sop_ctrl_val;
 283
 284         /* Allow a single tsport to have multiple frontends */
 285         u32                        num_frontends;
 286         void                       *port_priv;
 287 };
 288
 289 struct cx23885_dev {
 290         struct list_head           devlist;
 291         atomic_t                   refcount;
 292         struct v4l2_device         v4l2_dev;
 293
 294         /* pci stuff */
 295         struct pci_dev             *pci;
 296         unsigned char              pci_rev, pci_lat;
 297         int                        pci_bus, pci_slot;
 298         u32                        __iomem *lmmio;
 299         u8                         __iomem *bmmio;
 300         int                        pci_irqmask;
 301         int                        hwrevision;
 302
 303         /* This valud is board specific and is used to configure the
 304          * AV core so we see nice clean and stable video and audio. */
 305         u32                        clk_freq;
 306
 307         /* I2C adapters: Master 1 & 2 (External) & Master 3 (Internal only) */
 308         struct cx23885_i2c         i2c_bus[3];
 309
 310         int                        nr;
 311         struct mutex               lock;
 312
 313         /* board details */
 314         unsigned int               board;
 315         char                       name[32];
 316
 317         struct cx23885_tsport      ts1, ts2;
 318
 319         /* sram configuration */
 320         struct sram_channel        *sram_channels;
 321
 322         enum {
 323                 CX23885_BRIDGE_UNDEFINED = 0,
 324                 CX23885_BRIDGE_885 = 885,
 325                 CX23885_BRIDGE_887 = 887,
 326         } bridge;
 327
 328         /* Analog video */
 329         u32                        resources;
 330         unsigned int               input;
 331         u32                        tvaudio;
 332         v4l2_std_id                tvnorm;
 333         unsigned int               tuner_type;
 334         unsigned char              tuner_addr;
 335         unsigned int               radio_type;
 336         unsigned char              radio_addr;
 337         unsigned int               has_radio;
 338         struct v4l2_subdev         *sd_cx25840;
 339
 340         /* V4l */
 341         u32                        freq;
 342         struct video_device        *video_dev;
 343         struct video_device        *vbi_dev;
 344         struct video_device        *radio_dev;
 345
 346         struct cx23885_dmaqueue    vidq;
 347         struct cx23885_dmaqueue    vbiq;
 348         spinlock_t                 slock;
 349
 350         /* MPEG Encoder ONLY settings */
 351         u32                        cx23417_mailbox;
 352         struct cx2341x_mpeg_params mpeg_params;
 353         struct video_device        *v4l_device;
 354         atomic_t                   v4l_reader_count;
 355         struct cx23885_tvnorm      encodernorm;
 356
 357 };
 358
 359 static inline struct cx23885_dev *to_cx23885(struct v4l2_device *v4l2_dev)
 360 {
 361         return container_of(v4l2_dev, struct cx23885_dev, v4l2_dev);
 362 }
 363
 364 #define call_all(dev, o, f, args...) \
 365         v4l2_device_call_all(&dev->v4l2_dev, 0, o, f, ##args)
 366
 367 extern struct list_head cx23885_devlist;
 368
 369 #define SRAM_CH01  0 /* Video A */
 370 #define SRAM_CH02  1 /* VBI A */
 371 #define SRAM_CH03  2 /* Video B */
 372 #define SRAM_CH04  3 /* Transport via B */
 373 #define SRAM_CH05  4 /* VBI B */
 374 #define SRAM_CH06  5 /* Video C */
 375 #define SRAM_CH07  6 /* Transport via C */
 376 #define SRAM_CH08  7 /* Audio Internal A */
 377 #define SRAM_CH09  8 /* Audio Internal B */
 378 #define SRAM_CH10  9 /* Audio External */
 379 #define SRAM_CH11 10 /* COMB_3D_N */
 380 #define SRAM_CH12 11 /* Comb 3D N1 */
 381 #define SRAM_CH13 12 /* Comb 3D N2 */
 382 #define SRAM_CH14 13 /* MOE Vid */
 383 #define SRAM_CH15 14 /* MOE RSLT */
 384
 385 struct sram_channel {
 386         char *name;
 387         u32  cmds_start;
 388         u32  ctrl_start;
 389         u32  cdt;
 390         u32  fifo_start;;
 391         u32  fifo_size;
 392         u32  ptr1_reg;
 393         u32  ptr2_reg;
 394         u32  cnt1_reg;
 395         u32  cnt2_reg;
 396         u32  jumponly;
 397 };
 398
 399 /* ----------------------------------------------------------- */
 400
 401 #define cx_read(reg)             readl(dev->lmmio + ((reg)>>2))
 402 #define cx_write(reg, value)     writel((value), dev->lmmio + ((reg)>>2))
 403
 404 #define cx_andor(reg, mask, value) \
 405   writel((readl(dev->lmmio+((reg)>>2)) & ~(mask)) |\
 406   ((value) & (mask)), dev->lmmio+((reg)>>2))
 407
 408 #define cx_set(reg, bit)          cx_andor((reg), (bit), (bit))
 409 #define cx_clear(reg, bit)        cx_andor((reg), (bit), 0)
 410
 411 /* ----------------------------------------------------------- */
 412 /* cx23885-core.c                                              */
 413
 414 extern int cx23885_sram_channel_setup(struct cx23885_dev *dev,
 415         struct sram_channel *ch,
 416         unsigned int bpl, u32 risc);
 417
 418 extern void cx23885_sram_channel_dump(struct cx23885_dev *dev,
 419         struct sram_channel *ch);
 420
 421 extern int cx23885_risc_stopper(struct pci_dev *pci, struct btcx_riscmem *risc,
 422         u32 reg, u32 mask, u32 value);
 423
 424 extern int cx23885_risc_buffer(struct pci_dev *pci, struct btcx_riscmem *risc,
 425         struct scatterlist *sglist,
 426         unsigned int top_offset, unsigned int bottom_offset,
 427         unsigned int bpl, unsigned int padding, unsigned int lines);
 428
 429 void cx23885_cancel_buffers(struct cx23885_tsport *port);
 430
 431 extern int cx23885_restart_queue(struct cx23885_tsport *port,
 432                                 struct cx23885_dmaqueue *q);
 433
 434 extern void cx23885_wakeup(struct cx23885_tsport *port,
 435                            struct cx23885_dmaqueue *q, u32 count);
 436
 437 extern void cx23885_gpio_set(struct cx23885_dev *dev, u32 mask);
 438 extern void cx23885_gpio_clear(struct cx23885_dev *dev, u32 mask);
 439 extern void cx23885_gpio_enable(struct cx23885_dev *dev, u32 mask,
 440         int asoutput);
 441
 442
 443 /* ----------------------------------------------------------- */
 444 /* cx23885-cards.c                                             */
 445 extern struct cx23885_board cx23885_boards[];
 446 extern const unsigned int cx23885_bcount;
 447
 448 extern struct cx23885_subid cx23885_subids[];
 449 extern const unsigned int cx23885_idcount;
 450
 451 extern int cx23885_tuner_callback(void *priv, int component,
 452         int command, int arg);
 453 extern void cx23885_card_list(struct cx23885_dev *dev);
 454 extern int  cx23885_ir_init(struct cx23885_dev *dev);
 455 extern void cx23885_gpio_setup(struct cx23885_dev *dev);
 456 extern void cx23885_card_setup(struct cx23885_dev *dev);
 457 extern void cx23885_card_setup_pre_i2c(struct cx23885_dev *dev);
 458
 459 extern int cx23885_dvb_register(struct cx23885_tsport *port);
 460 extern int cx23885_dvb_unregister(struct cx23885_tsport *port);
 461
 462 extern int cx23885_buf_prepare(struct videobuf_queue *q,
 463                                struct cx23885_tsport *port,
 464                                struct cx23885_buffer *buf,
 465                                enum v4l2_field field);
 466 extern void cx23885_buf_queue(struct cx23885_tsport *port,
 467                               struct cx23885_buffer *buf);
 468 extern void cx23885_free_buffer(struct videobuf_queue *q,
 469                                 struct cx23885_buffer *buf);
 470
 471 /* ----------------------------------------------------------- */
 472 /* cx23885-video.c                                             */
 473 /* Video */
 474 extern int cx23885_video_register(struct cx23885_dev *dev);
 475 extern void cx23885_video_unregister(struct cx23885_dev *dev);
 476 extern int cx23885_video_irq(struct cx23885_dev *dev, u32 status);
 477
 478 /* ----------------------------------------------------------- */
 479 /* cx23885-vbi.c                                               */
 480 extern int cx23885_vbi_fmt(struct file *file, void *priv,
 481         struct v4l2_format *f);
 482 extern void cx23885_vbi_timeout(unsigned long data);
 483 extern struct videobuf_queue_ops cx23885_vbi_qops;
 484
 485 /* cx23885-i2c.c                                                */
 486 extern int cx23885_i2c_register(struct cx23885_i2c *bus);
 487 extern int cx23885_i2c_unregister(struct cx23885_i2c *bus);
 488 extern void cx23885_av_clk(struct cx23885_dev *dev, int enable);
 489
 490 /* ----------------------------------------------------------- */
 491 /* cx23885-417.c                                               */
 492 extern int cx23885_417_register(struct cx23885_dev *dev);
 493 extern void cx23885_417_unregister(struct cx23885_dev *dev);
 494 extern int cx23885_irq_417(struct cx23885_dev *dev, u32 status);
 495 extern void cx23885_417_check_encoder(struct cx23885_dev *dev);
 496 extern void cx23885_mc417_init(struct cx23885_dev *dev);
 497 extern int mc417_memory_read(struct cx23885_dev *dev, u32 address, u32 *value);
 498 extern int mc417_memory_write(struct cx23885_dev *dev, u32 address, u32 value);
 499
 500
 501 /* ----------------------------------------------------------- */
 502 /* tv norms                                                    */
 503
 504 static inline unsigned int norm_maxw(v4l2_std_id norm)
 505 {
 506         return (norm & (V4L2_STD_MN & ~V4L2_STD_PAL_Nc)) ? 720 : 768;
 507 }
 508
 509 static inline unsigned int norm_maxh(v4l2_std_id norm)
 510 {
 511         return (norm & V4L2_STD_625_50) ? 576 : 480;
 512 }
 513
 514 static inline unsigned int norm_swidth(v4l2_std_id norm)
 515 {
 516         return (norm & (V4L2_STD_MN & ~V4L2_STD_PAL_Nc)) ? 754 : 922;
 517 }