drivers/media/video/cx231xx/cx231xx.h

   1 /*
   2    cx231xx.h - driver for Conexant Cx23100/101/102 USB video capture devices
   3
   4    Copyright (C) 2008 <srinivasa.deevi at conexant dot com>
   5         Based on em28xx driver
   6
   7    This program is free software; you can redistribute it and/or modify
   8    it under the terms of the GNU General Public License as published by
   9    the Free Software Foundation; either version 2 of the License, or
  10    (at your option) any later version.
  11
  12    This program is distributed in the hope that it will be useful,
  13    but WITHOUT ANY WARRANTY; without even the implied warranty of
  14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  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 #ifndef _CX231XX_H
  23 #define _CX231XX_H
  24
  25 #include <linux/videodev2.h>
  26 #include <linux/types.h>
  27 #include <linux/ioctl.h>
  28 #include <linux/i2c.h>
  29 #include <linux/i2c-algo-bit.h>
  30 #include <linux/workqueue.h>
  31 #include <linux/mutex.h>
  32
  33 #include <media/cx2341x.h>
  34
  35 #include <media/videobuf-vmalloc.h>
  36 #include <media/v4l2-device.h>
  37 #include <media/rc-core.h>
  38 #include <media/ir-kbd-i2c.h>
  39 #include <media/videobuf-dvb.h>
  40
  41 #include "cx231xx-reg.h"
  42 #include "cx231xx-pcb-cfg.h"
  43 #include "cx231xx-conf-reg.h"
  44
  45 #define DRIVER_NAME                     "cx231xx"
  46 #define PWR_SLEEP_INTERVAL              5
  47
  48 /* I2C addresses for control block in Cx231xx */
  49 #define     AFE_DEVICE_ADDRESS          0x60
  50 #define     I2S_BLK_DEVICE_ADDRESS      0x98
  51 #define     VID_BLK_I2C_ADDRESS         0x88
  52 #define     VERVE_I2C_ADDRESS           0x40
  53 #define     DIF_USE_BASEBAND            0xFFFFFFFF
  54
  55 /* Boards supported by driver */
  56 #define CX231XX_BOARD_UNKNOWN               0
  57 #define CX231XX_BOARD_CNXT_CARRAERA     1
  58 #define CX231XX_BOARD_CNXT_SHELBY       2
  59 #define CX231XX_BOARD_CNXT_RDE_253S     3
  60 #define CX231XX_BOARD_CNXT_RDU_253S     4
  61 #define CX231XX_BOARD_CNXT_VIDEO_GRABBER        5
  62 #define CX231XX_BOARD_CNXT_RDE_250      6
  63 #define CX231XX_BOARD_CNXT_RDU_250      7
  64 #define CX231XX_BOARD_HAUPPAUGE_EXETER  8
  65 #define CX231XX_BOARD_HAUPPAUGE_USBLIVE2 9
  66 #define CX231XX_BOARD_PV_PLAYTV_USB_HYBRID 10
  67 #define CX231XX_BOARD_PV_XCAPTURE_USB 11
  68 #define CX231XX_BOARD_KWORLD_UB430_USB_HYBRID 12
  69 #define CX231XX_BOARD_ICONBIT_U100 13
  70 #define CX231XX_BOARD_HAUPPAUGE_USB2_FM_PAL 14
  71 #define CX231XX_BOARD_HAUPPAUGE_USB2_FM_NTSC 15
  72
  73 /* Limits minimum and default number of buffers */
  74 #define CX231XX_MIN_BUF                 4
  75 #define CX231XX_DEF_BUF                 12
  76 #define CX231XX_DEF_VBI_BUF             6
  77
  78 #define VBI_LINE_COUNT                  17
  79 #define VBI_LINE_LENGTH                 1440
  80
  81 /*Limits the max URB message size */
  82 #define URB_MAX_CTRL_SIZE               80
  83
  84 /* Params for validated field */
  85 #define CX231XX_BOARD_NOT_VALIDATED     1
  86 #define CX231XX_BOARD_VALIDATED         0
  87
  88 /* maximum number of cx231xx boards */
  89 #define CX231XX_MAXBOARDS               8
  90
  91 /* maximum number of frames that can be queued */
  92 #define CX231XX_NUM_FRAMES              5
  93
  94 /* number of buffers for isoc transfers */
  95 #define CX231XX_NUM_BUFS                8
  96
  97 /* number of packets for each buffer
  98    windows requests only 40 packets .. so we better do the same
  99    this is what I found out for all alternate numbers there!
 100  */
 101 #define CX231XX_NUM_PACKETS             40
 102
 103 /* default alternate; 0 means choose the best */
 104 #define CX231XX_PINOUT                  0
 105
 106 #define CX231XX_INTERLACED_DEFAULT      1
 107
 108 /* time to wait when stopping the isoc transfer */
 109 #define CX231XX_URB_TIMEOUT             \
 110                 msecs_to_jiffies(CX231XX_NUM_BUFS * CX231XX_NUM_PACKETS)
 111
 112 #define CX231xx_NORMS (\
 113         V4L2_STD_NTSC_M |  V4L2_STD_NTSC_M_JP |  V4L2_STD_NTSC_443 | \
 114         V4L2_STD_PAL_BG |  V4L2_STD_PAL_DK    |  V4L2_STD_PAL_I    | \
 115         V4L2_STD_PAL_M  |  V4L2_STD_PAL_N     |  V4L2_STD_PAL_Nc   | \
 116         V4L2_STD_PAL_60 |  V4L2_STD_SECAM_L   |  V4L2_STD_SECAM_DK)
 117
 118 #define SLEEP_S5H1432    30
 119 #define CX23417_OSC_EN   8
 120 #define CX23417_RESET    9
 121
 122 struct cx23417_fmt {
 123         char  *name;
 124         u32   fourcc;          /* v4l2 format id */
 125         int   depth;
 126         int   flags;
 127         u32   cxformat;
 128 };
 129 enum cx231xx_mode {
 130         CX231XX_SUSPEND,
 131         CX231XX_ANALOG_MODE,
 132         CX231XX_DIGITAL_MODE,
 133 };
 134
 135 enum cx231xx_std_mode {
 136         CX231XX_TV_AIR = 0,
 137         CX231XX_TV_CABLE
 138 };
 139
 140 enum cx231xx_stream_state {
 141         STREAM_OFF,
 142         STREAM_INTERRUPT,
 143         STREAM_ON,
 144 };
 145
 146 struct cx231xx;
 147
 148 struct cx231xx_isoc_ctl {
 149         /* max packet size of isoc transaction */
 150         int max_pkt_size;
 151
 152         /* number of allocated urbs */
 153         int num_bufs;
 154
 155         /* urb for isoc transfers */
 156         struct urb **urb;
 157
 158         /* transfer buffers for isoc transfer */
 159         char **transfer_buffer;
 160
 161         /* Last buffer command and region */
 162         u8 cmd;
 163         int pos, size, pktsize;
 164
 165         /* Last field: ODD or EVEN? */
 166         int field;
 167
 168         /* Stores incomplete commands */
 169         u32 tmp_buf;
 170         int tmp_buf_len;
 171
 172         /* Stores already requested buffers */
 173         struct cx231xx_buffer *buf;
 174
 175         /* Stores the number of received fields */
 176         int nfields;
 177
 178         /* isoc urb callback */
 179         int (*isoc_copy) (struct cx231xx *dev, struct urb *urb);
 180 };
 181
 182 struct cx231xx_bulk_ctl {
 183         /* max packet size of bulk transaction */
 184         int max_pkt_size;
 185
 186         /* number of allocated urbs */
 187         int num_bufs;
 188
 189         /* urb for bulk transfers */
 190         struct urb **urb;
 191
 192         /* transfer buffers for bulk transfer */
 193         char **transfer_buffer;
 194
 195         /* Last buffer command and region */
 196         u8 cmd;
 197         int pos, size, pktsize;
 198
 199         /* Last field: ODD or EVEN? */
 200         int field;
 201
 202         /* Stores incomplete commands */
 203         u32 tmp_buf;
 204         int tmp_buf_len;
 205
 206         /* Stores already requested buffers */
 207         struct cx231xx_buffer *buf;
 208
 209         /* Stores the number of received fields */
 210         int nfields;
 211
 212         /* bulk urb callback */
 213         int (*bulk_copy) (struct cx231xx *dev, struct urb *urb);
 214 };
 215
 216 struct cx231xx_fmt {
 217         char *name;
 218         u32 fourcc;             /* v4l2 format id */
 219         int depth;
 220         int reg;
 221 };
 222
 223 /* buffer for one video frame */
 224 struct cx231xx_buffer {
 225         /* common v4l buffer stuff -- must be first */
 226         struct videobuf_buffer vb;
 227
 228         struct list_head frame;
 229         int top_field;
 230         int receiving;
 231 };
 232
 233 enum ps_package_head {
 234         CX231XX_NEED_ADD_PS_PACKAGE_HEAD = 0,
 235         CX231XX_NONEED_PS_PACKAGE_HEAD
 236 };
 237
 238 struct cx231xx_dmaqueue {
 239         struct list_head active;
 240         struct list_head queued;
 241
 242         wait_queue_head_t wq;
 243
 244         /* Counters to control buffer fill */
 245         int pos;
 246         u8 is_partial_line;
 247         u8 partial_buf[8];
 248         u8 last_sav;
 249         int current_field;
 250         u32 bytes_left_in_line;
 251         u32 lines_completed;
 252         u8 field1_done;
 253         u32 lines_per_field;
 254
 255         /*Mpeg2 control buffer*/
 256         u8 *p_left_data;
 257         u32 left_data_count;
 258         u8 mpeg_buffer_done;
 259         u32 mpeg_buffer_completed;
 260         enum ps_package_head add_ps_package_head;
 261         char ps_head[10];
 262 };
 263
 264 /* inputs */
 265
 266 #define MAX_CX231XX_INPUT               4
 267
 268 enum cx231xx_itype {
 269         CX231XX_VMUX_COMPOSITE1 = 1,
 270         CX231XX_VMUX_SVIDEO,
 271         CX231XX_VMUX_TELEVISION,
 272         CX231XX_VMUX_CABLE,
 273         CX231XX_RADIO,
 274         CX231XX_VMUX_DVB,
 275         CX231XX_VMUX_DEBUG
 276 };
 277
 278 enum cx231xx_v_input {
 279         CX231XX_VIN_1_1 = 0x1,
 280         CX231XX_VIN_2_1,
 281         CX231XX_VIN_3_1,
 282         CX231XX_VIN_4_1,
 283         CX231XX_VIN_1_2 = 0x01,
 284         CX231XX_VIN_2_2,
 285         CX231XX_VIN_3_2,
 286         CX231XX_VIN_1_3 = 0x1,
 287         CX231XX_VIN_2_3,
 288         CX231XX_VIN_3_3,
 289 };
 290
 291 /* cx231xx has two audio inputs: tuner and line in */
 292 enum cx231xx_amux {
 293         /* This is the only entry for cx231xx tuner input */
 294         CX231XX_AMUX_VIDEO,     /* cx231xx tuner */
 295         CX231XX_AMUX_LINE_IN,   /* Line In */
 296 };
 297
 298 struct cx231xx_reg_seq {
 299         unsigned char bit;
 300         unsigned char val;
 301         int sleep;
 302 };
 303
 304 struct cx231xx_input {
 305         enum cx231xx_itype type;
 306         unsigned int vmux;
 307         enum cx231xx_amux amux;
 308         struct cx231xx_reg_seq *gpio;
 309 };
 310
 311 #define INPUT(nr) (&cx231xx_boards[dev->model].input[nr])
 312
 313 enum cx231xx_decoder {
 314         CX231XX_NODECODER,
 315         CX231XX_AVDECODER
 316 };
 317
 318 enum CX231XX_I2C_MASTER_PORT {
 319         I2C_0 = 0,
 320         I2C_1 = 1,
 321         I2C_2 = 2,
 322         I2C_3 = 3
 323 };
 324
 325 struct cx231xx_board {
 326         char *name;
 327         int vchannels;
 328         int tuner_type;
 329         int tuner_addr;
 330         v4l2_std_id norm;       /* tv norm */
 331
 332         /* demod related */
 333         int demod_addr;
 334         u8 demod_xfer_mode;     /* 0 - Serial; 1 - parallel */
 335
 336         /* GPIO Pins */
 337         struct cx231xx_reg_seq *dvb_gpio;
 338         struct cx231xx_reg_seq *suspend_gpio;
 339         struct cx231xx_reg_seq *tuner_gpio;
 340                 /* Negative means don't use it */
 341         s8 tuner_sif_gpio;
 342         s8 tuner_scl_gpio;
 343         s8 tuner_sda_gpio;
 344
 345         /* PIN ctrl */
 346         u32 ctl_pin_status_mask;
 347         u8 agc_analog_digital_select_gpio;
 348         u32 gpio_pin_status_mask;
 349
 350         /* i2c masters */
 351         u8 tuner_i2c_master;
 352         u8 demod_i2c_master;
 353         u8 ir_i2c_master;
 354
 355         /* for devices with I2C chips for IR */
 356         char *rc_map_name;
 357
 358         unsigned int max_range_640_480:1;
 359         unsigned int has_dvb:1;
 360         unsigned int has_417:1;
 361         unsigned int valid:1;
 362         unsigned int no_alt_vanc:1;
 363         unsigned int external_av:1;
 364         unsigned int dont_use_port_3:1;
 365
 366         unsigned char xclk, i2c_speed;
 367
 368         enum cx231xx_decoder decoder;
 369         int output_mode;
 370
 371         struct cx231xx_input input[MAX_CX231XX_INPUT];
 372         struct cx231xx_input radio;
 373         struct rc_map *ir_codes;
 374 };
 375
 376 /* device states */
 377 enum cx231xx_dev_state {
 378         DEV_INITIALIZED = 0x01,
 379         DEV_DISCONNECTED = 0x02,
 380         DEV_MISCONFIGURED = 0x04,
 381 };
 382
 383 enum AFE_MODE {
 384         AFE_MODE_LOW_IF,
 385         AFE_MODE_BASEBAND,
 386         AFE_MODE_EU_HI_IF,
 387         AFE_MODE_US_HI_IF,
 388         AFE_MODE_JAPAN_HI_IF
 389 };
 390
 391 enum AUDIO_INPUT {
 392         AUDIO_INPUT_MUTE,
 393         AUDIO_INPUT_LINE,
 394         AUDIO_INPUT_TUNER_TV,
 395         AUDIO_INPUT_SPDIF,
 396         AUDIO_INPUT_TUNER_FM
 397 };
 398
 399 #define CX231XX_AUDIO_BUFS              5
 400 #define CX231XX_NUM_AUDIO_PACKETS       16
 401 #define CX231XX_ISO_NUM_AUDIO_PACKETS   64
 402
 403 /* cx231xx extensions */
 404 #define CX231XX_AUDIO                   0x10
 405 #define CX231XX_DVB                     0x20
 406
 407 struct cx231xx_audio {
 408         char name[50];
 409         char *transfer_buffer[CX231XX_AUDIO_BUFS];
 410         struct urb *urb[CX231XX_AUDIO_BUFS];
 411         struct usb_device *udev;
 412         unsigned int capture_transfer_done;
 413         struct snd_pcm_substream *capture_pcm_substream;
 414
 415         unsigned int hwptr_done_capture;
 416         struct snd_card *sndcard;
 417
 418         int users, shutdown;
 419         /* locks */
 420         spinlock_t slock;
 421
 422         int alt;                /* alternate */
 423         int max_pkt_size;       /* max packet size of isoc transaction */
 424         int num_alt;            /* Number of alternative settings */
 425         unsigned int *alt_max_pkt_size; /* array of wMaxPacketSize */
 426         u16 end_point_addr;
 427 };
 428
 429 struct cx231xx;
 430
 431 struct cx231xx_fh {
 432         struct cx231xx *dev;
 433         unsigned int stream_on:1;       /* Locks streams */
 434         int radio;
 435
 436         struct videobuf_queue vb_vidq;
 437
 438         enum v4l2_buf_type type;
 439
 440
 441
 442 /*following is copyed from cx23885.h*/
 443         u32                        resources;
 444
 445         /* video overlay */
 446         struct v4l2_window         win;
 447         struct v4l2_clip           *clips;
 448         unsigned int               nclips;
 449
 450         /* video capture */
 451         struct cx23417_fmt         *fmt;
 452         unsigned int               width, height;
 453
 454         /* vbi capture */
 455         struct videobuf_queue      vidq;
 456         struct videobuf_queue      vbiq;
 457
 458         /* MPEG Encoder specifics ONLY */
 459
 460         atomic_t                   v4l_reading;
 461 };
 462
 463 /*****************************************************************/
 464 /* set/get i2c */
 465 /* 00--1Mb/s, 01-400kb/s, 10--100kb/s, 11--5Mb/s */
 466 #define I2C_SPEED_1M            0x0
 467 #define I2C_SPEED_400K          0x1
 468 #define I2C_SPEED_100K          0x2
 469 #define I2C_SPEED_5M            0x3
 470
 471 /* 0-- STOP transaction */
 472 #define I2C_STOP                0x0
 473 /* 1-- do not transmit STOP at end of transaction */
 474 #define I2C_NOSTOP              0x1
 475 /* 1--allow slave to insert clock wait states */
 476 #define I2C_SYNC                0x1
 477
 478 struct cx231xx_i2c {
 479         struct cx231xx *dev;
 480
 481         int nr;
 482
 483         /* i2c i/o */
 484         struct i2c_adapter i2c_adap;
 485         struct i2c_algo_bit_data i2c_algo;
 486         struct i2c_client i2c_client;
 487         u32 i2c_rc;
 488
 489         /* different settings for each bus */
 490         u8 i2c_period;
 491         u8 i2c_nostop;
 492         u8 i2c_reserve;
 493 };
 494
 495 struct cx231xx_i2c_xfer_data {
 496         u8 dev_addr;
 497         u8 direction;           /* 1 - IN, 0 - OUT */
 498         u8 saddr_len;           /* sub address len */
 499         u16 saddr_dat;          /* sub addr data */
 500         u8 buf_size;            /* buffer size */
 501         u8 *p_buffer;           /* pointer to the buffer */
 502 };
 503
 504 struct VENDOR_REQUEST_IN {
 505         u8 bRequest;
 506         u16 wValue;
 507         u16 wIndex;
 508         u16 wLength;
 509         u8 direction;
 510         u8 bData;
 511         u8 *pBuff;
 512 };
 513
 514 struct cx231xx_tvnorm {
 515         char            *name;
 516         v4l2_std_id     id;
 517         u32             cxiformat;
 518         u32             cxoformat;
 519 };
 520
 521 struct cx231xx_ctrl {
 522         struct v4l2_queryctrl v;
 523         u32 off;
 524         u32 reg;
 525         u32 mask;
 526         u32 shift;
 527 };
 528
 529 enum TRANSFER_TYPE {
 530         Raw_Video = 0,
 531         Audio,
 532         Vbi,                    /* VANC */
 533         Sliced_cc,              /* HANC */
 534         TS1_serial_mode,
 535         TS2,
 536         TS1_parallel_mode
 537 } ;
 538
 539 struct cx231xx_video_mode {
 540         /* Isoc control struct */
 541         struct cx231xx_dmaqueue vidq;
 542         struct cx231xx_isoc_ctl isoc_ctl;
 543         struct cx231xx_bulk_ctl bulk_ctl;
 544         /* locks */
 545         spinlock_t slock;
 546
 547         /* usb transfer */
 548         int alt;                /* alternate */
 549         int max_pkt_size;       /* max packet size of isoc transaction */
 550         int num_alt;            /* Number of alternative settings */
 551         unsigned int *alt_max_pkt_size; /* array of wMaxPacketSize */
 552         u16 end_point_addr;
 553 };
 554 /*
 555 struct cx23885_dmaqueue {
 556         struct list_head       active;
 557         struct list_head       queued;
 558         struct timer_list      timeout;
 559         struct btcx_riscmem    stopper;
 560         u32                    count;
 561 };
 562 */
 563 struct cx231xx_tsport {
 564         struct cx231xx *dev;
 565
 566         int                        nr;
 567         int                        sram_chno;
 568
 569         struct videobuf_dvb_frontends frontends;
 570
 571         /* dma queues */
 572
 573         u32                        ts_packet_size;
 574         u32                        ts_packet_count;
 575
 576         int                        width;
 577         int                        height;
 578
 579         /* locks */
 580         spinlock_t                 slock;
 581
 582         /* registers */
 583         u32                        reg_gpcnt;
 584         u32                        reg_gpcnt_ctl;
 585         u32                        reg_dma_ctl;
 586         u32                        reg_lngth;
 587         u32                        reg_hw_sop_ctrl;
 588         u32                        reg_gen_ctrl;
 589         u32                        reg_bd_pkt_status;
 590         u32                        reg_sop_status;
 591         u32                        reg_fifo_ovfl_stat;
 592         u32                        reg_vld_misc;
 593         u32                        reg_ts_clk_en;
 594         u32                        reg_ts_int_msk;
 595         u32                        reg_ts_int_stat;
 596         u32                        reg_src_sel;
 597
 598         /* Default register vals */
 599         int                        pci_irqmask;
 600         u32                        dma_ctl_val;
 601         u32                        ts_int_msk_val;
 602         u32                        gen_ctrl_val;
 603         u32                        ts_clk_en_val;
 604         u32                        src_sel_val;
 605         u32                        vld_misc_val;
 606         u32                        hw_sop_ctrl_val;
 607
 608         /* Allow a single tsport to have multiple frontends */
 609         u32                        num_frontends;
 610         void                       *port_priv;
 611 };
 612
 613 /* main device struct */
 614 struct cx231xx {
 615         /* generic device properties */
 616         char name[30];          /* name (including minor) of the device */
 617         int model;              /* index in the device_data struct */
 618         int devno;              /* marks the number of this device */
 619
 620         struct cx231xx_board board;
 621
 622         /* For I2C IR support */
 623         struct IR_i2c_init_data    init_data;
 624
 625         unsigned int stream_on:1;       /* Locks streams */
 626         unsigned int vbi_stream_on:1;   /* Locks streams for VBI */
 627         unsigned int has_audio_class:1;
 628         unsigned int has_alsa_audio:1;
 629
 630         struct cx231xx_fmt *format;
 631
 632         struct v4l2_device v4l2_dev;
 633         struct v4l2_subdev *sd_cx25840;
 634         struct v4l2_subdev *sd_tuner;
 635
 636         struct work_struct wq_trigger;          /* Trigger to start/stop audio for alsa module */
 637         atomic_t           stream_started;      /* stream should be running if true */
 638
 639         struct list_head devlist;
 640
 641         int tuner_type;         /* type of the tuner */
 642         int tuner_addr;         /* tuner address */
 643
 644         /* I2C adapters: Master 1 & 2 (External) & Master 3 (Internal only) */
 645         struct cx231xx_i2c i2c_bus[3];
 646         unsigned int xc_fw_load_done:1;
 647         /* locks */
 648         struct mutex gpio_i2c_lock;
 649         struct mutex i2c_lock;
 650
 651         /* video for linux */
 652         int users;              /* user count for exclusive use */
 653         struct video_device *vdev;      /* video for linux device struct */
 654         v4l2_std_id norm;       /* selected tv norm */
 655         int ctl_freq;           /* selected frequency */
 656         unsigned int ctl_ainput;        /* selected audio input */
 657         int mute;
 658         int volume;
 659
 660         /* frame properties */
 661         int width;              /* current frame width */
 662         int height;             /* current frame height */
 663         int interlaced;         /* 1=interlace fileds, 0=just top fileds */
 664
 665         struct cx231xx_audio adev;
 666
 667         /* states */
 668         enum cx231xx_dev_state state;
 669
 670         struct work_struct request_module_wk;
 671
 672         /* locks */
 673         struct mutex lock;
 674         struct mutex ctrl_urb_lock;     /* protects urb_buf */
 675         struct list_head inqueue, outqueue;
 676         wait_queue_head_t open, wait_frame, wait_stream;
 677         struct video_device *vbi_dev;
 678         struct video_device *radio_dev;
 679
 680         unsigned char eedata[256];
 681
 682         struct cx231xx_video_mode video_mode;
 683         struct cx231xx_video_mode vbi_mode;
 684         struct cx231xx_video_mode sliced_cc_mode;
 685         struct cx231xx_video_mode ts1_mode;
 686
 687         atomic_t devlist_count;
 688
 689         struct usb_device *udev;        /* the usb device */
 690         char urb_buf[URB_MAX_CTRL_SIZE];        /* urb control msg buffer */
 691
 692         /* helper funcs that call usb_control_msg */
 693         int (*cx231xx_read_ctrl_reg) (struct cx231xx *dev, u8 req, u16 reg,
 694                                       char *buf, int len);
 695         int (*cx231xx_write_ctrl_reg) (struct cx231xx *dev, u8 req, u16 reg,
 696                                        char *buf, int len);
 697         int (*cx231xx_send_usb_command) (struct cx231xx_i2c *i2c_bus,
 698                                 struct cx231xx_i2c_xfer_data *req_data);
 699         int (*cx231xx_gpio_i2c_read) (struct cx231xx *dev, u8 dev_addr,
 700                                       u8 *buf, u8 len);
 701         int (*cx231xx_gpio_i2c_write) (struct cx231xx *dev, u8 dev_addr,
 702                                        u8 *buf, u8 len);
 703
 704         int (*cx231xx_set_analog_freq) (struct cx231xx *dev, u32 freq);
 705         int (*cx231xx_reset_analog_tuner) (struct cx231xx *dev);
 706
 707         enum cx231xx_mode mode;
 708
 709         struct cx231xx_dvb *dvb;
 710
 711         /* Cx231xx supported PCB config's */
 712         struct pcb_config current_pcb_config;
 713         u8 current_scenario_idx;
 714         u8 interface_count;
 715         u8 max_iad_interface_count;
 716
 717         /* GPIO related register direction and values */
 718         u32 gpio_dir;
 719         u32 gpio_val;
 720
 721         /* Power Modes */
 722         int power_mode;
 723
 724         /* afe parameters */
 725         enum AFE_MODE afe_mode;
 726         u32 afe_ref_count;
 727
 728         /* video related parameters */
 729         u32 video_input;
 730         u32 active_mode;
 731         u8 vbi_or_sliced_cc_mode;       /* 0 - vbi ; 1 - sliced cc mode */
 732         enum cx231xx_std_mode std_mode; /* 0 - Air; 1 - cable */
 733
 734         /*mode: digital=1 or analog=0*/
 735         u8 mode_tv;
 736
 737         u8 USE_ISO;
 738         struct cx231xx_tvnorm      encodernorm;
 739         struct cx231xx_tsport      ts1, ts2;
 740         struct cx2341x_mpeg_params mpeg_params;
 741         struct video_device        *v4l_device;
 742         atomic_t                   v4l_reader_count;
 743         u32                        freq;
 744         unsigned int               input;
 745         u32                        cx23417_mailbox;
 746         u32                        __iomem *lmmio;
 747         u8                         __iomem *bmmio;
 748 };
 749
 750 extern struct list_head cx231xx_devlist;
 751
 752 #define cx25840_call(cx231xx, o, f, args...) \
 753         v4l2_subdev_call(cx231xx->sd_cx25840, o, f, ##args)
 754 #define tuner_call(cx231xx, o, f, args...) \
 755         v4l2_subdev_call(cx231xx->sd_tuner, o, f, ##args)
 756 #define call_all(dev, o, f, args...) \
 757         v4l2_device_call_until_err(&dev->v4l2_dev, 0, o, f, ##args)
 758
 759 struct cx231xx_ops {
 760         struct list_head next;
 761         char *name;
 762         int id;
 763         int (*init) (struct cx231xx *);
 764         int (*fini) (struct cx231xx *);
 765 };
 766
 767 /* call back functions in dvb module */
 768 int cx231xx_set_analog_freq(struct cx231xx *dev, u32 freq);
 769 int cx231xx_reset_analog_tuner(struct cx231xx *dev);
 770
 771 /* Provided by cx231xx-i2c.c */
 772 void cx231xx_do_i2c_scan(struct cx231xx *dev, struct i2c_client *c);
 773 int cx231xx_i2c_register(struct cx231xx_i2c *bus);
 774 int cx231xx_i2c_unregister(struct cx231xx_i2c *bus);
 775
 776 /* Internal block control functions */
 777 int cx231xx_read_i2c_master(struct cx231xx *dev, u8 dev_addr, u16 saddr,
 778                  u8 saddr_len, u32 *data, u8 data_len, int master);
 779 int cx231xx_write_i2c_master(struct cx231xx *dev, u8 dev_addr, u16 saddr,
 780                  u8 saddr_len, u32 data, u8 data_len, int master);
 781 int cx231xx_read_i2c_data(struct cx231xx *dev, u8 dev_addr,
 782                           u16 saddr, u8 saddr_len, u32 *data, u8 data_len);
 783 int cx231xx_write_i2c_data(struct cx231xx *dev, u8 dev_addr,
 784                            u16 saddr, u8 saddr_len, u32 data, u8 data_len);
 785 int cx231xx_reg_mask_write(struct cx231xx *dev, u8 dev_addr, u8 size,
 786                            u16 register_address, u8 bit_start, u8 bit_end,
 787                            u32 value);
 788 int cx231xx_read_modify_write_i2c_dword(struct cx231xx *dev, u8 dev_addr,
 789                                         u16 saddr, u32 mask, u32 value);
 790 u32 cx231xx_set_field(u32 field_mask, u32 data);
 791
 792 /*verve r/w*/
 793 void initGPIO(struct cx231xx *dev);
 794 void uninitGPIO(struct cx231xx *dev);
 795 /* afe related functions */
 796 int cx231xx_afe_init_super_block(struct cx231xx *dev, u32 ref_count);
 797 int cx231xx_afe_init_channels(struct cx231xx *dev);
 798 int cx231xx_afe_setup_AFE_for_baseband(struct cx231xx *dev);
 799 int cx231xx_afe_set_input_mux(struct cx231xx *dev, u32 input_mux);
 800 int cx231xx_afe_set_mode(struct cx231xx *dev, enum AFE_MODE mode);
 801 int cx231xx_afe_update_power_control(struct cx231xx *dev,
 802                                         enum AV_MODE avmode);
 803 int cx231xx_afe_adjust_ref_count(struct cx231xx *dev, u32 video_input);
 804
 805 /* i2s block related functions */
 806 int cx231xx_i2s_blk_initialize(struct cx231xx *dev);
 807 int cx231xx_i2s_blk_update_power_control(struct cx231xx *dev,
 808                                         enum AV_MODE avmode);
 809 int cx231xx_i2s_blk_set_audio_input(struct cx231xx *dev, u8 audio_input);
 810
 811 /* DIF related functions */
 812 int cx231xx_dif_configure_C2HH_for_low_IF(struct cx231xx *dev, u32 mode,
 813                                           u32 function_mode, u32 standard);
 814 void cx231xx_set_Colibri_For_LowIF(struct cx231xx *dev, u32 if_freq,
 815                                          u8 spectral_invert, u32 mode);
 816 u32 cx231xx_Get_Colibri_CarrierOffset(u32 mode, u32 standerd);
 817 void cx231xx_set_DIF_bandpass(struct cx231xx *dev, u32 if_freq,
 818                                          u8 spectral_invert, u32 mode);
 819 void cx231xx_Setup_AFE_for_LowIF(struct cx231xx *dev);
 820 void reset_s5h1432_demod(struct cx231xx *dev);
 821 void cx231xx_dump_HH_reg(struct cx231xx *dev);
 822 void update_HH_register_after_set_DIF(struct cx231xx *dev);
 823 void cx231xx_dump_SC_reg(struct cx231xx *dev);
 824
 825
 826
 827 int cx231xx_dif_set_standard(struct cx231xx *dev, u32 standard);
 828 int cx231xx_tuner_pre_channel_change(struct cx231xx *dev);
 829 int cx231xx_tuner_post_channel_change(struct cx231xx *dev);
 830
 831 /* video parser functions */
 832 u8 cx231xx_find_next_SAV_EAV(u8 *p_buffer, u32 buffer_size,
 833                              u32 *p_bytes_used);
 834 u8 cx231xx_find_boundary_SAV_EAV(u8 *p_buffer, u8 *partial_buf,
 835                                  u32 *p_bytes_used);
 836 int cx231xx_do_copy(struct cx231xx *dev, struct cx231xx_dmaqueue *dma_q,
 837                     u8 *p_buffer, u32 bytes_to_copy);
 838 void cx231xx_reset_video_buffer(struct cx231xx *dev,
 839                                 struct cx231xx_dmaqueue *dma_q);
 840 u8 cx231xx_is_buffer_done(struct cx231xx *dev, struct cx231xx_dmaqueue *dma_q);
 841 u32 cx231xx_copy_video_line(struct cx231xx *dev, struct cx231xx_dmaqueue *dma_q,
 842                             u8 *p_line, u32 length, int field_number);
 843 u32 cx231xx_get_video_line(struct cx231xx *dev, struct cx231xx_dmaqueue *dma_q,
 844                            u8 sav_eav, u8 *p_buffer, u32 buffer_size);
 845 void cx231xx_swab(u16 *from, u16 *to, u16 len);
 846
 847 /* Provided by cx231xx-core.c */
 848
 849 u32 cx231xx_request_buffers(struct cx231xx *dev, u32 count);
 850 void cx231xx_queue_unusedframes(struct cx231xx *dev);
 851 void cx231xx_release_buffers(struct cx231xx *dev);
 852
 853 /* read from control pipe */
 854 int cx231xx_read_ctrl_reg(struct cx231xx *dev, u8 req, u16 reg,
 855                           char *buf, int len);
 856
 857 /* write to control pipe */
 858 int cx231xx_write_ctrl_reg(struct cx231xx *dev, u8 req, u16 reg,
 859                            char *buf, int len);
 860 int cx231xx_mode_register(struct cx231xx *dev, u16 address, u32 mode);
 861
 862 int cx231xx_send_vendor_cmd(struct cx231xx *dev,
 863                                 struct VENDOR_REQUEST_IN *ven_req);
 864 int cx231xx_send_usb_command(struct cx231xx_i2c *i2c_bus,
 865                                 struct cx231xx_i2c_xfer_data *req_data);
 866
 867 /* Gpio related functions */
 868 int cx231xx_send_gpio_cmd(struct cx231xx *dev, u32 gpio_bit, u8 *gpio_val,
 869                           u8 len, u8 request, u8 direction);
 870 int cx231xx_set_gpio_bit(struct cx231xx *dev, u32 gpio_bit, u8 *gpio_val);
 871 int cx231xx_get_gpio_bit(struct cx231xx *dev, u32 gpio_bit, u8 *gpio_val);
 872 int cx231xx_set_gpio_value(struct cx231xx *dev, int pin_number, int pin_value);
 873 int cx231xx_set_gpio_direction(struct cx231xx *dev, int pin_number,
 874                                int pin_value);
 875
 876 int cx231xx_gpio_i2c_start(struct cx231xx *dev);
 877 int cx231xx_gpio_i2c_end(struct cx231xx *dev);
 878 int cx231xx_gpio_i2c_write_byte(struct cx231xx *dev, u8 data);
 879 int cx231xx_gpio_i2c_read_byte(struct cx231xx *dev, u8 *buf);
 880 int cx231xx_gpio_i2c_read_ack(struct cx231xx *dev);
 881 int cx231xx_gpio_i2c_write_ack(struct cx231xx *dev);
 882 int cx231xx_gpio_i2c_write_nak(struct cx231xx *dev);
 883
 884 int cx231xx_gpio_i2c_read(struct cx231xx *dev, u8 dev_addr, u8 *buf, u8 len);
 885 int cx231xx_gpio_i2c_write(struct cx231xx *dev, u8 dev_addr, u8 *buf, u8 len);
 886
 887 /* audio related functions */
 888 int cx231xx_set_audio_decoder_input(struct cx231xx *dev,
 889                                     enum AUDIO_INPUT audio_input);
 890
 891 int cx231xx_capture_start(struct cx231xx *dev, int start, u8 media_type);
 892 int cx231xx_set_video_alternate(struct cx231xx *dev);
 893 int cx231xx_set_alt_setting(struct cx231xx *dev, u8 index, u8 alt);
 894 int is_fw_load(struct cx231xx *dev);
 895 int cx231xx_check_fw(struct cx231xx *dev);
 896 int cx231xx_init_isoc(struct cx231xx *dev, int max_packets,
 897                       int num_bufs, int max_pkt_size,
 898                       int (*isoc_copy) (struct cx231xx *dev,
 899                                         struct urb *urb));
 900 int cx231xx_init_bulk(struct cx231xx *dev, int max_packets,
 901                       int num_bufs, int max_pkt_size,
 902                       int (*bulk_copy) (struct cx231xx *dev,
 903                                         struct urb *urb));
 904 void cx231xx_stop_TS1(struct cx231xx *dev);
 905 void cx231xx_start_TS1(struct cx231xx *dev);
 906 void cx231xx_uninit_isoc(struct cx231xx *dev);
 907 void cx231xx_uninit_bulk(struct cx231xx *dev);
 908 int cx231xx_set_mode(struct cx231xx *dev, enum cx231xx_mode set_mode);
 909 int cx231xx_unmute_audio(struct cx231xx *dev);
 910 int cx231xx_ep5_bulkout(struct cx231xx *dev, u8 *firmware, u16 size);
 911 void cx231xx_disable656(struct cx231xx *dev);
 912 void cx231xx_enable656(struct cx231xx *dev);
 913 int cx231xx_demod_reset(struct cx231xx *dev);
 914 int cx231xx_gpio_set(struct cx231xx *dev, struct cx231xx_reg_seq *gpio);
 915
 916 /* Device list functions */
 917 void cx231xx_release_resources(struct cx231xx *dev);
 918 void cx231xx_release_analog_resources(struct cx231xx *dev);
 919 int cx231xx_register_analog_devices(struct cx231xx *dev);
 920 void cx231xx_remove_from_devlist(struct cx231xx *dev);
 921 void cx231xx_add_into_devlist(struct cx231xx *dev);
 922 void cx231xx_init_extension(struct cx231xx *dev);
 923 void cx231xx_close_extension(struct cx231xx *dev);
 924
 925 /* hardware init functions */
 926 int cx231xx_dev_init(struct cx231xx *dev);
 927 void cx231xx_dev_uninit(struct cx231xx *dev);
 928 void cx231xx_config_i2c(struct cx231xx *dev);
 929 int cx231xx_config(struct cx231xx *dev);
 930
 931 /* Stream control functions */
 932 int cx231xx_start_stream(struct cx231xx *dev, u32 ep_mask);
 933 int cx231xx_stop_stream(struct cx231xx *dev, u32 ep_mask);
 934
 935 int cx231xx_initialize_stream_xfer(struct cx231xx *dev, u32 media_type);
 936
 937 /* Power control functions */
 938 int cx231xx_set_power_mode(struct cx231xx *dev, enum AV_MODE mode);
 939 int cx231xx_power_suspend(struct cx231xx *dev);
 940
 941 /* chip specific control functions */
 942 int cx231xx_init_ctrl_pin_status(struct cx231xx *dev);
 943 int cx231xx_set_agc_analog_digital_mux_select(struct cx231xx *dev,
 944                                               u8 analog_or_digital);
 945 int cx231xx_enable_i2c_port_3(struct cx231xx *dev, bool is_port_3);
 946
 947 /* video audio decoder related functions */
 948 void video_mux(struct cx231xx *dev, int index);
 949 int cx231xx_set_video_input_mux(struct cx231xx *dev, u8 input);
 950 int cx231xx_set_decoder_video_input(struct cx231xx *dev, u8 pin_type, u8 input);
 951 int cx231xx_do_mode_ctrl_overrides(struct cx231xx *dev);
 952 int cx231xx_set_audio_input(struct cx231xx *dev, u8 input);
 953
 954 /* Provided by cx231xx-video.c */
 955 int cx231xx_register_extension(struct cx231xx_ops *dev);
 956 void cx231xx_unregister_extension(struct cx231xx_ops *dev);
 957 void cx231xx_init_extension(struct cx231xx *dev);
 958 void cx231xx_close_extension(struct cx231xx *dev);
 959
 960 /* Provided by cx231xx-cards.c */
 961 extern void cx231xx_pre_card_setup(struct cx231xx *dev);
 962 extern void cx231xx_card_setup(struct cx231xx *dev);
 963 extern struct cx231xx_board cx231xx_boards[];
 964 extern struct usb_device_id cx231xx_id_table[];
 965 extern const unsigned int cx231xx_bcount;
 966 int cx231xx_tuner_callback(void *ptr, int component, int command, int arg);
 967
 968 /* cx23885-417.c                                               */
 969 extern int cx231xx_417_register(struct cx231xx *dev);
 970 extern void cx231xx_417_unregister(struct cx231xx *dev);
 971
 972 /* cx23885-input.c                                             */
 973
 974 #if defined(CONFIG_VIDEO_CX231XX_RC)
 975 int cx231xx_ir_init(struct cx231xx *dev);
 976 void cx231xx_ir_exit(struct cx231xx *dev);
 977 #else
 978 #define cx231xx_ir_init(dev)    (0)
 979 #define cx231xx_ir_exit(dev)    (0)
 980 #endif
 981
 982
 983 /* printk macros */
 984
 985 #define cx231xx_err(fmt, arg...) do {\
 986         printk(KERN_ERR fmt , ##arg); } while (0)
 987
 988 #define cx231xx_errdev(fmt, arg...) do {\
 989         printk(KERN_ERR "%s: "fmt,\
 990                         dev->name , ##arg); } while (0)
 991
 992 #define cx231xx_info(fmt, arg...) do {\
 993         printk(KERN_INFO "%s: "fmt,\
 994                         dev->name , ##arg); } while (0)
 995 #define cx231xx_warn(fmt, arg...) do {\
 996         printk(KERN_WARNING "%s: "fmt,\
 997                         dev->name , ##arg); } while (0)
 998
 999 static inline unsigned int norm_maxw(struct cx231xx *dev)
1000 {
1001         if (dev->board.max_range_640_480)
1002                 return 640;
1003         else
1004                 return 720;
1005 }
1006
1007 static inline unsigned int norm_maxh(struct cx231xx *dev)
1008 {
1009         if (dev->board.max_range_640_480)
1010                 return 480;
1011         else
1012                 return (dev->norm & V4L2_STD_625_50) ? 576 : 480;
1013 }
1014 #endif