drivers/media/usb/cx231xx/cx231xx.h

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