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