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 struct cx23417_fmt {
 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 vb2_v4l2_buffer vb;
 227         struct list_head list;
 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
 241         wait_queue_head_t wq;
 242
 243         /* Counters to control buffer fill */
 244         int pos;
 245         u8 is_partial_line;
 246         u8 partial_buf[8];
 247         u8 last_sav;
 248         int current_field;
 249         u32 bytes_left_in_line;
 250         u32 lines_completed;
 251         u8 field1_done;
 252         u32 lines_per_field;
 253         u32 sequence;
 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 };
 276
 277 enum cx231xx_v_input {
 278         CX231XX_VIN_1_1 = 0x1,
 279         CX231XX_VIN_2_1,
 280         CX231XX_VIN_3_1,
 281         CX231XX_VIN_4_1,
 282         CX231XX_VIN_1_2 = 0x01,
 283         CX231XX_VIN_2_2,
 284         CX231XX_VIN_3_2,
 285         CX231XX_VIN_1_3 = 0x1,
 286         CX231XX_VIN_2_3,
 287         CX231XX_VIN_3_3,
 288 };
 289
 290 /* cx231xx has two audio inputs: tuner and line in */
 291 enum cx231xx_amux {
 292         /* This is the only entry for cx231xx tuner input */
 293         CX231XX_AMUX_VIDEO,     /* cx231xx tuner */
 294         CX231XX_AMUX_LINE_IN,   /* Line In */
 295 };
 296
 297 struct cx231xx_reg_seq {
 298         unsigned char bit;
 299         unsigned char val;
 300         int sleep;
 301 };
 302
 303 struct cx231xx_input {
 304         enum cx231xx_itype type;
 305         unsigned int vmux;
 306         enum cx231xx_amux amux;
 307         struct cx231xx_reg_seq *gpio;
 308 };
 309
 310 #define INPUT(nr) (&cx231xx_boards[dev->model].input[nr])
 311
 312 enum cx231xx_decoder {
 313         CX231XX_NODECODER,
 314         CX231XX_AVDECODER
 315 };
 316
 317 enum CX231XX_I2C_MASTER_PORT {
 318         I2C_0 = 0,       /* master 0 - internal connection */
 319         I2C_1 = 1,       /* master 1 - used with mux */
 320         I2C_2 = 2,       /* master 2 */
 321         I2C_1_MUX_1 = 3, /* master 1 - port 1 (I2C_DEMOD_EN = 0) */
 322         I2C_1_MUX_3 = 4  /* master 1 - port 3 (I2C_DEMOD_EN = 1) */
 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         int demod_addr2;
 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
 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 };
 381
 382 enum AFE_MODE {
 383         AFE_MODE_LOW_IF,
 384         AFE_MODE_BASEBAND,
 385         AFE_MODE_EU_HI_IF,
 386         AFE_MODE_US_HI_IF,
 387         AFE_MODE_JAPAN_HI_IF
 388 };
 389
 390 enum AUDIO_INPUT {
 391         AUDIO_INPUT_MUTE,
 392         AUDIO_INPUT_LINE,
 393         AUDIO_INPUT_TUNER_TV,
 394         AUDIO_INPUT_SPDIF,
 395         AUDIO_INPUT_TUNER_FM
 396 };
 397
 398 #define CX231XX_AUDIO_BUFS              5
 399 #define CX231XX_NUM_AUDIO_PACKETS       16
 400 #define CX231XX_ISO_NUM_AUDIO_PACKETS   64
 401
 402 /* cx231xx extensions */
 403 #define CX231XX_AUDIO                   0x10
 404 #define CX231XX_DVB                     0x20
 405
 406 struct cx231xx_audio {
 407         char name[50];
 408         char *transfer_buffer[CX231XX_AUDIO_BUFS];
 409         struct urb *urb[CX231XX_AUDIO_BUFS];
 410         struct usb_device *udev;
 411         unsigned int capture_transfer_done;
 412         struct snd_pcm_substream *capture_pcm_substream;
 413
 414         unsigned int hwptr_done_capture;
 415         struct snd_card *sndcard;
 416
 417         int users, shutdown;
 418         /* locks */
 419         spinlock_t slock;
 420
 421         int alt;                /* alternate */
 422         int max_pkt_size;       /* max packet size of isoc transaction */
 423         int num_alt;            /* Number of alternative settings */
 424         unsigned int *alt_max_pkt_size; /* array of wMaxPacketSize */
 425         u16 end_point_addr;
 426 };
 427
 428 struct cx231xx;
 429
 430 /*****************************************************************/
 431 /* set/get i2c */
 432 /* 00--1Mb/s, 01-400kb/s, 10--100kb/s, 11--5Mb/s */
 433 #define I2C_SPEED_1M            0x0
 434 #define I2C_SPEED_400K          0x1
 435 #define I2C_SPEED_100K          0x2
 436 #define I2C_SPEED_5M            0x3
 437
 438 /* 0-- STOP transaction */
 439 #define I2C_STOP                0x0
 440 /* 1-- do not transmit STOP at end of transaction */
 441 #define I2C_NOSTOP              0x1
 442 /* 1--allow slave to insert clock wait states */
 443 #define I2C_SYNC                0x1
 444
 445 struct cx231xx_i2c {
 446         struct cx231xx *dev;
 447
 448         int nr;
 449
 450         /* i2c i/o */
 451         struct i2c_adapter i2c_adap;
 452         int i2c_rc;
 453
 454         /* different settings for each bus */
 455         u8 i2c_period;
 456         u8 i2c_nostop;
 457         u8 i2c_reserve;
 458 };
 459
 460 struct cx231xx_i2c_xfer_data {
 461         u8 dev_addr;
 462         u8 direction;           /* 1 - IN, 0 - OUT */
 463         u8 saddr_len;           /* sub address len */
 464         u16 saddr_dat;          /* sub addr data */
 465         u8 buf_size;            /* buffer size */
 466         u8 *p_buffer;           /* pointer to the buffer */
 467 };
 468
 469 struct VENDOR_REQUEST_IN {
 470         u8 bRequest;
 471         u16 wValue;
 472         u16 wIndex;
 473         u16 wLength;
 474         u8 direction;
 475         u8 bData;
 476         u8 *pBuff;
 477 };
 478
 479 struct cx231xx_tvnorm {
 480         char            *name;
 481         v4l2_std_id     id;
 482         u32             cxiformat;
 483         u32             cxoformat;
 484 };
 485
 486 enum TRANSFER_TYPE {
 487         Raw_Video = 0,
 488         Audio,
 489         Vbi,                    /* VANC */
 490         Sliced_cc,              /* HANC */
 491         TS1_serial_mode,
 492         TS2,
 493         TS1_parallel_mode
 494 } ;
 495
 496 struct cx231xx_video_mode {
 497         /* Isoc control struct */
 498         struct cx231xx_dmaqueue vidq;
 499         struct cx231xx_isoc_ctl isoc_ctl;
 500         struct cx231xx_bulk_ctl bulk_ctl;
 501         /* locks */
 502         spinlock_t slock;
 503
 504         /* usb transfer */
 505         int alt;                /* alternate */
 506         int max_pkt_size;       /* max packet size of isoc transaction */
 507         int num_alt;            /* Number of alternative settings */
 508         unsigned int *alt_max_pkt_size; /* array of wMaxPacketSize */
 509         u16 end_point_addr;
 510 };
 511
 512 struct cx231xx_tsport {
 513         struct cx231xx *dev;
 514
 515         int                        nr;
 516         int                        sram_chno;
 517
 518         /* dma queues */
 519
 520         u32                        ts_packet_size;
 521         u32                        ts_packet_count;
 522
 523         int                        width;
 524         int                        height;
 525
 526         /* locks */
 527         spinlock_t                 slock;
 528
 529         /* registers */
 530         u32                        reg_gpcnt;
 531         u32                        reg_gpcnt_ctl;
 532         u32                        reg_dma_ctl;
 533         u32                        reg_lngth;
 534         u32                        reg_hw_sop_ctrl;
 535         u32                        reg_gen_ctrl;
 536         u32                        reg_bd_pkt_status;
 537         u32                        reg_sop_status;
 538         u32                        reg_fifo_ovfl_stat;
 539         u32                        reg_vld_misc;
 540         u32                        reg_ts_clk_en;
 541         u32                        reg_ts_int_msk;
 542         u32                        reg_ts_int_stat;
 543         u32                        reg_src_sel;
 544
 545         /* Default register vals */
 546         int                        pci_irqmask;
 547         u32                        dma_ctl_val;
 548         u32                        ts_int_msk_val;
 549         u32                        gen_ctrl_val;
 550         u32                        ts_clk_en_val;
 551         u32                        src_sel_val;
 552         u32                        vld_misc_val;
 553         u32                        hw_sop_ctrl_val;
 554
 555         /* Allow a single tsport to have multiple frontends */
 556         u32                        num_frontends;
 557         void                       *port_priv;
 558 };
 559
 560 /* main device struct */
 561 struct cx231xx {
 562         /* generic device properties */
 563         char name[30];          /* name (including minor) of the device */
 564         int model;              /* index in the device_data struct */
 565         int devno;              /* marks the number of this device */
 566         struct device *dev;     /* pointer to USB interface's dev */
 567
 568         struct cx231xx_board board;
 569
 570         /* For I2C IR support */
 571         struct IR_i2c_init_data    init_data;
 572         struct i2c_client          *ir_i2c_client;
 573
 574         unsigned int stream_on:1;       /* Locks streams */
 575         unsigned int vbi_stream_on:1;   /* Locks streams for VBI */
 576         unsigned int has_audio_class:1;
 577         unsigned int has_alsa_audio:1;
 578
 579         unsigned int i2c_scan_running:1; /* true only during i2c_scan */
 580
 581         struct cx231xx_fmt *format;
 582
 583         struct v4l2_device v4l2_dev;
 584         struct v4l2_subdev *sd_cx25840;
 585         struct v4l2_subdev *sd_tuner;
 586         struct v4l2_ctrl_handler ctrl_handler;
 587         struct v4l2_ctrl_handler radio_ctrl_handler;
 588         struct cx2341x_handler mpeg_ctrl_handler;
 589
 590         struct work_struct wq_trigger;          /* Trigger to start/stop audio for alsa module */
 591         atomic_t           stream_started;      /* stream should be running if true */
 592
 593         struct list_head devlist;
 594
 595         int tuner_type;         /* type of the tuner */
 596         int tuner_addr;         /* tuner address */
 597
 598         /* I2C adapters: Master 1 & 2 (External) & Master 3 (Internal only) */
 599         struct cx231xx_i2c i2c_bus[3];
 600         struct i2c_mux_core *muxc;
 601         struct i2c_adapter *i2c_mux_adap[2];
 602
 603         unsigned int xc_fw_load_done:1;
 604         unsigned int port_3_switch_enabled:1;
 605         /* locks */
 606         struct mutex gpio_i2c_lock;
 607         struct mutex i2c_lock;
 608
 609         /* video for linux */
 610         int users;              /* user count for exclusive use */
 611         struct video_device vdev;       /* video for linux device struct */
 612         v4l2_std_id norm;       /* selected tv norm */
 613         int ctl_freq;           /* selected frequency */
 614         unsigned int ctl_ainput;        /* selected audio input */
 615
 616         /* frame properties */
 617         int width;              /* current frame width */
 618         int height;             /* current frame height */
 619         int interlaced;         /* 1=interlace fields, 0=just top fields */
 620         unsigned int size;
 621
 622         struct cx231xx_audio adev;
 623
 624         /* states */
 625         enum cx231xx_dev_state state;
 626
 627         struct work_struct request_module_wk;
 628
 629         /* locks */
 630         struct mutex lock;
 631         struct mutex ctrl_urb_lock;     /* protects urb_buf */
 632         struct list_head inqueue, outqueue;
 633         wait_queue_head_t open, wait_frame, wait_stream;
 634         struct video_device vbi_dev;
 635         struct video_device radio_dev;
 636
 637 #if defined(CONFIG_MEDIA_CONTROLLER)
 638         struct media_device *media_dev;
 639         struct media_pad video_pad, vbi_pad;
 640         struct media_entity input_ent[MAX_CX231XX_INPUT];
 641         struct media_pad input_pad[MAX_CX231XX_INPUT];
 642 #endif
 643
 644         struct vb2_queue vidq;
 645         struct vb2_queue vbiq;
 646
 647         unsigned char eedata[256];
 648
 649         struct cx231xx_video_mode video_mode;
 650         struct cx231xx_video_mode vbi_mode;
 651         struct cx231xx_video_mode sliced_cc_mode;
 652         struct cx231xx_video_mode ts1_mode;
 653
 654         atomic_t devlist_count;
 655
 656         struct usb_device *udev;        /* the usb device */
 657         char urb_buf[URB_MAX_CTRL_SIZE];        /* urb control msg buffer */
 658
 659         /* helper funcs that call usb_control_msg */
 660         int (*cx231xx_read_ctrl_reg) (struct cx231xx *dev, u8 req, u16 reg,
 661                                       char *buf, int len);
 662         int (*cx231xx_write_ctrl_reg) (struct cx231xx *dev, u8 req, u16 reg,
 663                                        char *buf, int len);
 664         int (*cx231xx_send_usb_command) (struct cx231xx_i2c *i2c_bus,
 665                                 struct cx231xx_i2c_xfer_data *req_data);
 666         int (*cx231xx_gpio_i2c_read) (struct cx231xx *dev, u8 dev_addr,
 667                                       u8 *buf, u8 len);
 668         int (*cx231xx_gpio_i2c_write) (struct cx231xx *dev, u8 dev_addr,
 669                                        u8 *buf, u8 len);
 670
 671         int (*cx231xx_set_analog_freq) (struct cx231xx *dev, u32 freq);
 672         int (*cx231xx_reset_analog_tuner) (struct cx231xx *dev);
 673
 674         enum cx231xx_mode mode;
 675
 676         struct cx231xx_dvb *dvb;
 677
 678         /* Cx231xx supported PCB config's */
 679         struct pcb_config current_pcb_config;
 680         u8 current_scenario_idx;
 681         u8 interface_count;
 682         u8 max_iad_interface_count;
 683
 684         /* GPIO related register direction and values */
 685         u32 gpio_dir;
 686         u32 gpio_val;
 687
 688         /* Power Modes */
 689         int power_mode;
 690
 691         /* afe parameters */
 692         enum AFE_MODE afe_mode;
 693         u32 afe_ref_count;
 694
 695         /* video related parameters */
 696         u32 video_input;
 697         u32 active_mode;
 698         u8 vbi_or_sliced_cc_mode;       /* 0 - vbi ; 1 - sliced cc mode */
 699         enum cx231xx_std_mode std_mode; /* 0 - Air; 1 - cable */
 700
 701         /*mode: digital=1 or analog=0*/
 702         u8 mode_tv;
 703
 704         u8 USE_ISO;
 705         struct cx231xx_tvnorm      encodernorm;
 706         struct cx231xx_tsport      ts1, ts2;
 707         struct vb2_queue           mpegq;
 708         struct video_device        v4l_device;
 709         atomic_t                   v4l_reader_count;
 710         u32                        freq;
 711         unsigned int               input;
 712         u32                        cx23417_mailbox;
 713         u32                        __iomem *lmmio;
 714         u8                         __iomem *bmmio;
 715 };
 716
 717 extern struct list_head cx231xx_devlist;
 718
 719 #define cx25840_call(cx231xx, o, f, args...) \
 720         v4l2_subdev_call(cx231xx->sd_cx25840, o, f, ##args)
 721 #define tuner_call(cx231xx, o, f, args...) \
 722         v4l2_subdev_call(cx231xx->sd_tuner, o, f, ##args)
 723 #define call_all(dev, o, f, args...) \
 724         v4l2_device_call_until_err(&dev->v4l2_dev, 0, o, f, ##args)
 725
 726 struct cx231xx_ops {
 727         struct list_head next;
 728         char *name;
 729         int id;
 730         int (*init) (struct cx231xx *);
 731         int (*fini) (struct cx231xx *);
 732 };
 733
 734 /* call back functions in dvb module */
 735 int cx231xx_set_analog_freq(struct cx231xx *dev, u32 freq);
 736 int cx231xx_reset_analog_tuner(struct cx231xx *dev);
 737
 738 /* Provided by cx231xx-i2c.c */
 739 void cx231xx_do_i2c_scan(struct cx231xx *dev, int i2c_port);
 740 int cx231xx_i2c_register(struct cx231xx_i2c *bus);
 741 void cx231xx_i2c_unregister(struct cx231xx_i2c *bus);
 742 int cx231xx_i2c_mux_create(struct cx231xx *dev);
 743 int cx231xx_i2c_mux_register(struct cx231xx *dev, int mux_no);
 744 void cx231xx_i2c_mux_unregister(struct cx231xx *dev);
 745 struct i2c_adapter *cx231xx_get_i2c_adap(struct cx231xx *dev, int i2c_port);
 746
 747 /* Internal block control functions */
 748 int cx231xx_read_i2c_master(struct cx231xx *dev, u8 dev_addr, u16 saddr,
 749                  u8 saddr_len, u32 *data, u8 data_len, int master);
 750 int cx231xx_write_i2c_master(struct cx231xx *dev, u8 dev_addr, u16 saddr,
 751                  u8 saddr_len, u32 data, u8 data_len, int master);
 752 int cx231xx_read_i2c_data(struct cx231xx *dev, u8 dev_addr,
 753                           u16 saddr, u8 saddr_len, u32 *data, u8 data_len);
 754 int cx231xx_write_i2c_data(struct cx231xx *dev, u8 dev_addr,
 755                            u16 saddr, u8 saddr_len, u32 data, u8 data_len);
 756 int cx231xx_reg_mask_write(struct cx231xx *dev, u8 dev_addr, u8 size,
 757                            u16 register_address, u8 bit_start, u8 bit_end,
 758                            u32 value);
 759 int cx231xx_read_modify_write_i2c_dword(struct cx231xx *dev, u8 dev_addr,
 760                                         u16 saddr, u32 mask, u32 value);
 761 u32 cx231xx_set_field(u32 field_mask, u32 data);
 762
 763 /*verve r/w*/
 764 void initGPIO(struct cx231xx *dev);
 765 void uninitGPIO(struct cx231xx *dev);
 766 /* afe related functions */
 767 int cx231xx_afe_init_super_block(struct cx231xx *dev, u32 ref_count);
 768 int cx231xx_afe_init_channels(struct cx231xx *dev);
 769 int cx231xx_afe_setup_AFE_for_baseband(struct cx231xx *dev);
 770 int cx231xx_afe_set_input_mux(struct cx231xx *dev, u32 input_mux);
 771 int cx231xx_afe_set_mode(struct cx231xx *dev, enum AFE_MODE mode);
 772 int cx231xx_afe_update_power_control(struct cx231xx *dev,
 773                                         enum AV_MODE avmode);
 774 int cx231xx_afe_adjust_ref_count(struct cx231xx *dev, u32 video_input);
 775
 776 /* i2s block related functions */
 777 int cx231xx_i2s_blk_initialize(struct cx231xx *dev);
 778 int cx231xx_i2s_blk_update_power_control(struct cx231xx *dev,
 779                                         enum AV_MODE avmode);
 780 int cx231xx_i2s_blk_set_audio_input(struct cx231xx *dev, u8 audio_input);
 781
 782 /* DIF related functions */
 783 int cx231xx_dif_configure_C2HH_for_low_IF(struct cx231xx *dev, u32 mode,
 784                                           u32 function_mode, u32 standard);
 785 void cx231xx_set_Colibri_For_LowIF(struct cx231xx *dev, u32 if_freq,
 786                                          u8 spectral_invert, u32 mode);
 787 u32 cx231xx_Get_Colibri_CarrierOffset(u32 mode, u32 standerd);
 788 void cx231xx_set_DIF_bandpass(struct cx231xx *dev, u32 if_freq,
 789                                          u8 spectral_invert, u32 mode);
 790 void cx231xx_Setup_AFE_for_LowIF(struct cx231xx *dev);
 791 void reset_s5h1432_demod(struct cx231xx *dev);
 792 void cx231xx_dump_HH_reg(struct cx231xx *dev);
 793 void update_HH_register_after_set_DIF(struct cx231xx *dev);
 794
 795
 796
 797 int cx231xx_dif_set_standard(struct cx231xx *dev, u32 standard);
 798 int cx231xx_tuner_pre_channel_change(struct cx231xx *dev);
 799 int cx231xx_tuner_post_channel_change(struct cx231xx *dev);
 800
 801 /* video parser functions */
 802 u8 cx231xx_find_next_SAV_EAV(u8 *p_buffer, u32 buffer_size,
 803                              u32 *p_bytes_used);
 804 u8 cx231xx_find_boundary_SAV_EAV(u8 *p_buffer, u8 *partial_buf,
 805                                  u32 *p_bytes_used);
 806 int cx231xx_do_copy(struct cx231xx *dev, struct cx231xx_dmaqueue *dma_q,
 807                     u8 *p_buffer, u32 bytes_to_copy);
 808 void cx231xx_reset_video_buffer(struct cx231xx *dev,
 809                                 struct cx231xx_dmaqueue *dma_q);
 810 u8 cx231xx_is_buffer_done(struct cx231xx *dev, struct cx231xx_dmaqueue *dma_q);
 811 u32 cx231xx_copy_video_line(struct cx231xx *dev, struct cx231xx_dmaqueue *dma_q,
 812                             u8 *p_line, u32 length, int field_number);
 813 u32 cx231xx_get_video_line(struct cx231xx *dev, struct cx231xx_dmaqueue *dma_q,
 814                            u8 sav_eav, u8 *p_buffer, u32 buffer_size);
 815 void cx231xx_swab(u16 *from, u16 *to, u16 len);
 816
 817 /* Provided by cx231xx-core.c */
 818
 819 u32 cx231xx_request_buffers(struct cx231xx *dev, u32 count);
 820 void cx231xx_queue_unusedframes(struct cx231xx *dev);
 821 void cx231xx_release_buffers(struct cx231xx *dev);
 822
 823 /* read from control pipe */
 824 int cx231xx_read_ctrl_reg(struct cx231xx *dev, u8 req, u16 reg,
 825                           char *buf, int len);
 826
 827 /* write to control pipe */
 828 int cx231xx_write_ctrl_reg(struct cx231xx *dev, u8 req, u16 reg,
 829                            char *buf, int len);
 830 int cx231xx_mode_register(struct cx231xx *dev, u16 address, u32 mode);
 831
 832 int cx231xx_send_vendor_cmd(struct cx231xx *dev,
 833                                 struct VENDOR_REQUEST_IN *ven_req);
 834 int cx231xx_send_usb_command(struct cx231xx_i2c *i2c_bus,
 835                                 struct cx231xx_i2c_xfer_data *req_data);
 836
 837 /* Gpio related functions */
 838 int cx231xx_send_gpio_cmd(struct cx231xx *dev, u32 gpio_bit, u8 *gpio_val,
 839                           u8 len, u8 request, u8 direction);
 840 int cx231xx_set_gpio_value(struct cx231xx *dev, int pin_number, int pin_value);
 841 int cx231xx_set_gpio_direction(struct cx231xx *dev, int pin_number,
 842                                int pin_value);
 843
 844 int cx231xx_gpio_i2c_start(struct cx231xx *dev);
 845 int cx231xx_gpio_i2c_end(struct cx231xx *dev);
 846 int cx231xx_gpio_i2c_write_byte(struct cx231xx *dev, u8 data);
 847 int cx231xx_gpio_i2c_read_byte(struct cx231xx *dev, u8 *buf);
 848 int cx231xx_gpio_i2c_read_ack(struct cx231xx *dev);
 849 int cx231xx_gpio_i2c_write_ack(struct cx231xx *dev);
 850 int cx231xx_gpio_i2c_write_nak(struct cx231xx *dev);
 851
 852 int cx231xx_gpio_i2c_read(struct cx231xx *dev, u8 dev_addr, u8 *buf, u8 len);
 853 int cx231xx_gpio_i2c_write(struct cx231xx *dev, u8 dev_addr, u8 *buf, u8 len);
 854
 855 /* audio related functions */
 856 int cx231xx_set_audio_decoder_input(struct cx231xx *dev,
 857                                     enum AUDIO_INPUT audio_input);
 858
 859 int cx231xx_capture_start(struct cx231xx *dev, int start, u8 media_type);
 860 int cx231xx_set_video_alternate(struct cx231xx *dev);
 861 int cx231xx_set_alt_setting(struct cx231xx *dev, u8 index, u8 alt);
 862 int is_fw_load(struct cx231xx *dev);
 863 int cx231xx_check_fw(struct cx231xx *dev);
 864 int cx231xx_init_isoc(struct cx231xx *dev, int max_packets,
 865                       int num_bufs, int max_pkt_size,
 866                       int (*isoc_copy) (struct cx231xx *dev,
 867                                         struct urb *urb));
 868 int cx231xx_init_bulk(struct cx231xx *dev, int max_packets,
 869                       int num_bufs, int max_pkt_size,
 870                       int (*bulk_copy) (struct cx231xx *dev,
 871                                         struct urb *urb));
 872 void cx231xx_stop_TS1(struct cx231xx *dev);
 873 void cx231xx_start_TS1(struct cx231xx *dev);
 874 void cx231xx_uninit_isoc(struct cx231xx *dev);
 875 void cx231xx_uninit_bulk(struct cx231xx *dev);
 876 int cx231xx_set_mode(struct cx231xx *dev, enum cx231xx_mode set_mode);
 877 int cx231xx_unmute_audio(struct cx231xx *dev);
 878 int cx231xx_ep5_bulkout(struct cx231xx *dev, u8 *firmware, u16 size);
 879 void cx231xx_disable656(struct cx231xx *dev);
 880 void cx231xx_enable656(struct cx231xx *dev);
 881 int cx231xx_demod_reset(struct cx231xx *dev);
 882 int cx231xx_gpio_set(struct cx231xx *dev, struct cx231xx_reg_seq *gpio);
 883
 884 /* Device list functions */
 885 void cx231xx_release_resources(struct cx231xx *dev);
 886 void cx231xx_release_analog_resources(struct cx231xx *dev);
 887 int cx231xx_register_analog_devices(struct cx231xx *dev);
 888 void cx231xx_remove_from_devlist(struct cx231xx *dev);
 889 void cx231xx_add_into_devlist(struct cx231xx *dev);
 890 void cx231xx_init_extension(struct cx231xx *dev);
 891 void cx231xx_close_extension(struct cx231xx *dev);
 892
 893 /* hardware init functions */
 894 int cx231xx_dev_init(struct cx231xx *dev);
 895 void cx231xx_dev_uninit(struct cx231xx *dev);
 896 void cx231xx_config_i2c(struct cx231xx *dev);
 897 int cx231xx_config(struct cx231xx *dev);
 898
 899 /* Stream control functions */
 900 int cx231xx_start_stream(struct cx231xx *dev, u32 ep_mask);
 901 int cx231xx_stop_stream(struct cx231xx *dev, u32 ep_mask);
 902
 903 int cx231xx_initialize_stream_xfer(struct cx231xx *dev, u32 media_type);
 904
 905 /* Power control functions */
 906 int cx231xx_set_power_mode(struct cx231xx *dev, enum AV_MODE mode);
 907 int cx231xx_power_suspend(struct cx231xx *dev);
 908
 909 /* chip specific control functions */
 910 int cx231xx_init_ctrl_pin_status(struct cx231xx *dev);
 911 int cx231xx_set_agc_analog_digital_mux_select(struct cx231xx *dev,
 912                                               u8 analog_or_digital);
 913 int cx231xx_enable_i2c_port_3(struct cx231xx *dev, bool is_port_3);
 914
 915 /* video audio decoder related functions */
 916 void video_mux(struct cx231xx *dev, int index);
 917 int cx231xx_set_video_input_mux(struct cx231xx *dev, u8 input);
 918 int cx231xx_set_decoder_video_input(struct cx231xx *dev, u8 pin_type, u8 input);
 919 int cx231xx_do_mode_ctrl_overrides(struct cx231xx *dev);
 920 int cx231xx_set_audio_input(struct cx231xx *dev, u8 input);
 921
 922 /* Provided by cx231xx-video.c */
 923 int cx231xx_register_extension(struct cx231xx_ops *dev);
 924 void cx231xx_unregister_extension(struct cx231xx_ops *dev);
 925 void cx231xx_init_extension(struct cx231xx *dev);
 926 void cx231xx_close_extension(struct cx231xx *dev);
 927 void cx231xx_v4l2_create_entities(struct cx231xx *dev);
 928 int cx231xx_querycap(struct file *file, void *priv,
 929                            struct v4l2_capability *cap);
 930 int cx231xx_g_tuner(struct file *file, void *priv, struct v4l2_tuner *t);
 931 int cx231xx_s_tuner(struct file *file, void *priv, const struct v4l2_tuner *t);
 932 int cx231xx_g_frequency(struct file *file, void *priv,
 933                               struct v4l2_frequency *f);
 934 int cx231xx_s_frequency(struct file *file, void *priv,
 935                               const struct v4l2_frequency *f);
 936 int cx231xx_enum_input(struct file *file, void *priv,
 937                              struct v4l2_input *i);
 938 int cx231xx_g_input(struct file *file, void *priv, unsigned int *i);
 939 int cx231xx_s_input(struct file *file, void *priv, unsigned int i);
 940 int cx231xx_g_chip_info(struct file *file, void *fh, struct v4l2_dbg_chip_info *chip);
 941 int cx231xx_g_register(struct file *file, void *priv,
 942                              struct v4l2_dbg_register *reg);
 943 int cx231xx_s_register(struct file *file, void *priv,
 944                              const struct v4l2_dbg_register *reg);
 945
 946 /* Provided by cx231xx-cards.c */
 947 extern void cx231xx_pre_card_setup(struct cx231xx *dev);
 948 extern void cx231xx_card_setup(struct cx231xx *dev);
 949 extern struct cx231xx_board cx231xx_boards[];
 950 extern struct usb_device_id cx231xx_id_table[];
 951 extern const unsigned int cx231xx_bcount;
 952 int cx231xx_tuner_callback(void *ptr, int component, int command, int arg);
 953
 954 /* cx23885-417.c                                               */
 955 extern int cx231xx_417_register(struct cx231xx *dev);
 956 extern void cx231xx_417_unregister(struct cx231xx *dev);
 957
 958 /* cx23885-input.c                                             */
 959
 960 #if defined(CONFIG_VIDEO_CX231XX_RC)
 961 int cx231xx_ir_init(struct cx231xx *dev);
 962 void cx231xx_ir_exit(struct cx231xx *dev);
 963 #else
 964 static inline int cx231xx_ir_init(struct cx231xx *dev)
 965 {
 966         return 0;
 967 }
 968 static inline void cx231xx_ir_exit(struct cx231xx *dev) {}
 969 #endif
 970
 971 static inline unsigned int norm_maxw(struct cx231xx *dev)
 972 {
 973         if (dev->board.max_range_640_480)
 974                 return 640;
 975         else
 976                 return 720;
 977 }
 978
 979 static inline unsigned int norm_maxh(struct cx231xx *dev)
 980 {
 981         if (dev->board.max_range_640_480)
 982                 return 480;
 983         else
 984                 return (dev->norm & V4L2_STD_625_50) ? 576 : 480;
 985 }
 986 #endif