drivers/media/video/cx23885/cx23885.h

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