drivers/media/usb/em28xx/em28xx.h

   1 /* SPDX-License-Identifier: GPL-2.0+ */
   2 /*
   3  * em28xx.h - driver for Empia EM2800/EM2820/2840 USB video capture devices
   4  *
   5  * Copyright (C) 2005 Markus Rechberger <mrechberger@gmail.com>
   6  *                    Ludovico Cavedon <cavedon@sssup.it>
   7  *                    Mauro Carvalho Chehab <mchehab@infradead.org>
   8  * Copyright (C) 2012 Frank Schäfer <fschaefer.oss@googlemail.com>
   9  *
  10  * Based on the em2800 driver from Sascha Sommer <saschasommer@freenet.de>
  11  *
  12  * This program is free software; you can redistribute it and/or modify
  13  * it under the terms of the GNU General Public License as published by
  14  * the Free Software Foundation; either version 2 of the License, or
  15  * (at your option) any later version.
  16  *
  17  * This program is distributed in the hope that it will be useful,
  18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20  * GNU General Public License for more details.
  21  */
  22
  23 #ifndef _EM28XX_H
  24 #define _EM28XX_H
  25
  26 #include <linux/bitfield.h>
  27
  28 #define EM28XX_VERSION "0.2.2"
  29 #define DRIVER_DESC    "Empia em28xx device driver"
  30
  31 #include <linux/workqueue.h>
  32 #include <linux/i2c.h>
  33 #include <linux/mutex.h>
  34 #include <linux/kref.h>
  35 #include <linux/videodev2.h>
  36
  37 #include <media/videobuf2-v4l2.h>
  38 #include <media/videobuf2-vmalloc.h>
  39 #include <media/v4l2-device.h>
  40 #include <media/v4l2-ctrls.h>
  41 #include <media/v4l2-fh.h>
  42 #include <media/i2c/ir-kbd-i2c.h>
  43 #include <media/rc-core.h>
  44 #include "tuner-xc2028.h"
  45 #include "xc5000.h"
  46 #include "em28xx-reg.h"
  47
  48 /* Boards supported by driver */
  49 #define EM2800_BOARD_UNKNOWN                      0
  50 #define EM2820_BOARD_UNKNOWN                      1
  51 #define EM2820_BOARD_TERRATEC_CINERGY_250         2
  52 #define EM2820_BOARD_PINNACLE_USB_2               3
  53 #define EM2820_BOARD_HAUPPAUGE_WINTV_USB_2        4
  54 #define EM2820_BOARD_MSI_VOX_USB_2                5
  55 #define EM2800_BOARD_TERRATEC_CINERGY_200         6
  56 #define EM2800_BOARD_LEADTEK_WINFAST_USBII        7
  57 #define EM2800_BOARD_KWORLD_USB2800               8
  58 #define EM2820_BOARD_PINNACLE_DVC_90              9
  59 #define EM2880_BOARD_HAUPPAUGE_WINTV_HVR_900      10
  60 #define EM2880_BOARD_TERRATEC_HYBRID_XS           11
  61 #define EM2820_BOARD_KWORLD_PVRTV2800RF           12
  62 #define EM2880_BOARD_TERRATEC_PRODIGY_XS          13
  63 #define EM2820_BOARD_PROLINK_PLAYTV_USB2          14
  64 #define EM2800_BOARD_VGEAR_POCKETTV               15
  65 #define EM2883_BOARD_HAUPPAUGE_WINTV_HVR_950      16
  66 #define EM2880_BOARD_PINNACLE_PCTV_HD_PRO         17
  67 #define EM2880_BOARD_HAUPPAUGE_WINTV_HVR_900_R2   18
  68 #define EM2860_BOARD_SAA711X_REFERENCE_DESIGN     19
  69 #define EM2880_BOARD_AMD_ATI_TV_WONDER_HD_600     20
  70 #define EM2800_BOARD_GRABBEEX_USB2800             21
  71 #define EM2750_BOARD_UNKNOWN                      22
  72 #define EM2750_BOARD_DLCW_130                     23
  73 #define EM2820_BOARD_DLINK_USB_TV                 24
  74 #define EM2820_BOARD_GADMEI_UTV310                25
  75 #define EM2820_BOARD_HERCULES_SMART_TV_USB2       26
  76 #define EM2820_BOARD_PINNACLE_USB_2_FM1216ME      27
  77 #define EM2820_BOARD_LEADTEK_WINFAST_USBII_DELUXE 28
  78 #define EM2860_BOARD_TVP5150_REFERENCE_DESIGN     29
  79 #define EM2820_BOARD_VIDEOLOGY_20K14XUSB          30
  80 #define EM2821_BOARD_USBGEAR_VD204                31
  81 #define EM2821_BOARD_SUPERCOMP_USB_2              32
  82 #define EM2860_BOARD_ELGATO_VIDEO_CAPTURE         33
  83 #define EM2860_BOARD_TERRATEC_HYBRID_XS           34
  84 #define EM2860_BOARD_TYPHOON_DVD_MAKER            35
  85 #define EM2860_BOARD_NETGMBH_CAM                  36
  86 #define EM2860_BOARD_GADMEI_UTV330                37
  87 #define EM2861_BOARD_YAKUMO_MOVIE_MIXER           38
  88 #define EM2861_BOARD_KWORLD_PVRTV_300U            39
  89 #define EM2861_BOARD_PLEXTOR_PX_TV100U            40
  90 #define EM2870_BOARD_KWORLD_350U                  41
  91 #define EM2870_BOARD_KWORLD_355U                  42
  92 #define EM2870_BOARD_TERRATEC_XS                  43
  93 #define EM2870_BOARD_TERRATEC_XS_MT2060           44
  94 #define EM2870_BOARD_PINNACLE_PCTV_DVB            45
  95 #define EM2870_BOARD_COMPRO_VIDEOMATE             46
  96 #define EM2880_BOARD_KWORLD_DVB_305U              47
  97 #define EM2880_BOARD_KWORLD_DVB_310U              48
  98 #define EM2880_BOARD_MSI_DIGIVOX_AD               49
  99 #define EM2880_BOARD_MSI_DIGIVOX_AD_II            50
 100 #define EM2880_BOARD_TERRATEC_HYBRID_XS_FR        51
 101 #define EM2881_BOARD_DNT_DA2_HYBRID               52
 102 #define EM2881_BOARD_PINNACLE_HYBRID_PRO          53
 103 #define EM2882_BOARD_KWORLD_VS_DVBT               54
 104 #define EM2882_BOARD_TERRATEC_HYBRID_XS           55
 105 #define EM2882_BOARD_PINNACLE_HYBRID_PRO_330E     56
 106 #define EM2883_BOARD_KWORLD_HYBRID_330U           57
 107 #define EM2820_BOARD_COMPRO_VIDEOMATE_FORYOU      58
 108 #define EM2874_BOARD_PCTV_HD_MINI_80E             59
 109 #define EM2883_BOARD_HAUPPAUGE_WINTV_HVR_850      60
 110 #define EM2820_BOARD_PROLINK_PLAYTV_BOX4_USB2     61
 111 #define EM2820_BOARD_GADMEI_TVR200                62
 112 #define EM2860_BOARD_KAIOMY_TVNPC_U2              63
 113 #define EM2860_BOARD_EASYCAP                      64
 114 #define EM2820_BOARD_IODATA_GVMVP_SZ              65
 115 #define EM2880_BOARD_EMPIRE_DUAL_TV               66
 116 #define EM2860_BOARD_TERRATEC_GRABBY              67
 117 #define EM2860_BOARD_TERRATEC_AV350               68
 118 #define EM2882_BOARD_KWORLD_ATSC_315U             69
 119 #define EM2882_BOARD_EVGA_INDTUBE                 70
 120 #define EM2820_BOARD_SILVERCREST_WEBCAM           71
 121 #define EM2861_BOARD_GADMEI_UTV330PLUS            72
 122 #define EM2870_BOARD_REDDO_DVB_C_USB_BOX          73
 123 #define EM2800_BOARD_VC211A                       74
 124 #define EM2882_BOARD_DIKOM_DK300                  75
 125 #define EM2870_BOARD_KWORLD_A340                  76
 126 #define EM2874_BOARD_LEADERSHIP_ISDBT             77
 127 #define EM28174_BOARD_PCTV_290E                   78
 128 #define EM2884_BOARD_TERRATEC_H5                  79
 129 #define EM28174_BOARD_PCTV_460E                   80
 130 #define EM2884_BOARD_HAUPPAUGE_WINTV_HVR_930C     81
 131 #define EM2884_BOARD_CINERGY_HTC_STICK            82
 132 #define EM2860_BOARD_HT_VIDBOX_NW03               83
 133 #define EM2874_BOARD_MAXMEDIA_UB425_TC            84
 134 #define EM2884_BOARD_PCTV_510E                    85
 135 #define EM2884_BOARD_PCTV_520E                    86
 136 #define EM2884_BOARD_TERRATEC_HTC_USB_XS          87
 137 #define EM2884_BOARD_C3TECH_DIGITAL_DUO           88
 138 #define EM2874_BOARD_DELOCK_61959                 89
 139 #define EM2874_BOARD_KWORLD_UB435Q_V2             90
 140 #define EM2765_BOARD_SPEEDLINK_VAD_LAPLACE        91
 141 #define EM28178_BOARD_PCTV_461E                   92
 142 #define EM2874_BOARD_KWORLD_UB435Q_V3             93
 143 #define EM28178_BOARD_PCTV_292E                   94
 144 #define EM2861_BOARD_LEADTEK_VC100                95
 145 #define EM28178_BOARD_TERRATEC_T2_STICK_HD        96
 146 #define EM2884_BOARD_ELGATO_EYETV_HYBRID_2008     97
 147 #define EM28178_BOARD_PLEX_PX_BCUD                98
 148 #define EM28174_BOARD_HAUPPAUGE_WINTV_DUALHD_DVB  99
 149 #define EM28174_BOARD_HAUPPAUGE_WINTV_DUALHD_01595 100
 150 #define EM2884_BOARD_TERRATEC_H6                  101
 151
 152 /* Limits minimum and default number of buffers */
 153 #define EM28XX_MIN_BUF 4
 154 #define EM28XX_DEF_BUF 8
 155
 156 /*Limits the max URB message size */
 157 #define URB_MAX_CTRL_SIZE 80
 158
 159 /* Params for validated field */
 160 #define EM28XX_BOARD_NOT_VALIDATED 1
 161 #define EM28XX_BOARD_VALIDATED     0
 162
 163 /* Params for em28xx_cmd() audio */
 164 #define EM28XX_START_AUDIO      1
 165 #define EM28XX_STOP_AUDIO       0
 166
 167 /* maximum number of em28xx boards */
 168 #define EM28XX_MAXBOARDS DVB_MAX_ADAPTERS /* All adapters could be em28xx */
 169
 170 /* maximum number of frames that can be queued */
 171 #define EM28XX_NUM_FRAMES 5
 172 /* number of frames that get used for v4l2_read() */
 173 #define EM28XX_NUM_READ_FRAMES 2
 174
 175 /* number of buffers for isoc transfers */
 176 #define EM28XX_NUM_BUFS 5
 177 #define EM28XX_DVB_NUM_BUFS 5
 178
 179 /* max number of I2C buses on em28xx devices */
 180 #define NUM_I2C_BUSES   2
 181
 182 /*
 183  * isoc transfers: number of packets for each buffer
 184  * windows requests only 64 packets .. so we better do the same
 185  * this is what I found out for all alternate numbers there!
 186  */
 187 #define EM28XX_NUM_ISOC_PACKETS 64
 188 #define EM28XX_DVB_NUM_ISOC_PACKETS 64
 189
 190 /*
 191  * bulk transfers: transfer buffer size = packet size * packet multiplier
 192  * USB 2.0 spec says bulk packet size is always 512 bytes
 193  */
 194 #define EM28XX_BULK_PACKET_MULTIPLIER 384
 195 #define EM28XX_DVB_BULK_PACKET_MULTIPLIER 94
 196
 197 #define EM28XX_INTERLACED_DEFAULT 1
 198
 199 /* time in msecs to wait for AC97 xfers to finish */
 200 #define EM28XX_AC97_XFER_TIMEOUT        100
 201
 202 /* max. number of button state polling addresses */
 203 #define EM28XX_NUM_BUTTON_ADDRESSES_MAX         5
 204
 205 #define PRIMARY_TS      0
 206 #define SECONDARY_TS    1
 207
 208 enum em28xx_mode {
 209         EM28XX_SUSPEND,
 210         EM28XX_ANALOG_MODE,
 211         EM28XX_DIGITAL_MODE,
 212 };
 213
 214 struct em28xx;
 215
 216 /**
 217  * struct em28xx_usb_bufs - Contains URB-related buffer data
 218  *
 219  * @max_pkt_size:       max packet size of isoc transaction
 220  * @num_packets:        number of packets in each buffer
 221  * @num_bufs:           number of allocated urb
 222  * @urb:                urb for isoc/bulk transfers
 223  * @buf:                transfer buffers for isoc/bulk transfer
 224  */
 225 struct em28xx_usb_bufs {
 226         int                             max_pkt_size;
 227         int                             num_packets;
 228         int                             num_bufs;
 229         struct urb                      **urb;
 230         char                            **buf;
 231 };
 232
 233 /**
 234  * struct em28xx_usb_ctl - Contains URB-related buffer data
 235  *
 236  * @analog_bufs:        isoc/bulk transfer buffers for analog mode
 237  * @digital_bufs:       isoc/bulk transfer buffers for digital mode
 238  * @vid_buf:            Stores already requested video buffers
 239  * @vbi_buf:            Stores already requested VBI buffers
 240  * @urb_data_copy:      copy data from URB
 241  */
 242 struct em28xx_usb_ctl {
 243         struct em28xx_usb_bufs          analog_bufs;
 244         struct em28xx_usb_bufs          digital_bufs;
 245         struct em28xx_buffer    *vid_buf;
 246         struct em28xx_buffer    *vbi_buf;
 247         int (*urb_data_copy)(struct em28xx *dev, struct urb *urb);
 248 };
 249
 250 /**
 251  * struct em28xx_fmt - Struct to enumberate video formats
 252  *
 253  * @name:       Name for the video standard
 254  * @fourcc:     v4l2 format id
 255  * @depth:      mean number of bits to represent a pixel
 256  * @reg:        em28xx register value to set it
 257  */
 258 struct em28xx_fmt {
 259         char    *name;
 260         u32     fourcc;
 261         int     depth;
 262         int     reg;
 263 };
 264
 265 /**
 266  * struct em28xx_buffer- buffer for storing one video frame
 267  *
 268  * @vb:         common v4l buffer stuff
 269  * @list:       List to associate it with the other buffers
 270  * @mem:        pointer to the buffer, as returned by vb2_plane_vaddr()
 271  * @length:     length of the buffer, as returned by vb2_plane_size()
 272  * @top_field:  If non-zero, indicate that the buffer is the top field
 273  * @pos:        Indicate the next position of the buffer to be filled.
 274  * @vb_buf:     pointer to vmalloc memory address in vb
 275  *
 276  * .. note::
 277  *
 278  *    in interlaced mode, @pos is reset to zero at the start of each new
 279  *    field (not frame !)
 280  */
 281 struct em28xx_buffer {
 282         struct vb2_v4l2_buffer  vb;             /* must be first */
 283
 284         struct list_head        list;
 285
 286         void                    *mem;
 287         unsigned int            length;
 288         int                     top_field;
 289
 290         unsigned int            pos;
 291
 292         char                    *vb_buf;
 293 };
 294
 295 struct em28xx_dmaqueue {
 296         struct list_head       active;
 297
 298         wait_queue_head_t          wq;
 299 };
 300
 301 /* inputs */
 302
 303 #define MAX_EM28XX_INPUT 4
 304 enum enum28xx_itype {
 305         EM28XX_VMUX_COMPOSITE = 1,
 306         EM28XX_VMUX_SVIDEO,
 307         EM28XX_VMUX_TELEVISION,
 308         EM28XX_RADIO,
 309 };
 310
 311 enum em28xx_ac97_mode {
 312         EM28XX_NO_AC97 = 0,
 313         EM28XX_AC97_EM202,
 314         EM28XX_AC97_SIGMATEL,
 315         EM28XX_AC97_OTHER,
 316 };
 317
 318 struct em28xx_audio_mode {
 319         enum em28xx_ac97_mode ac97;
 320 };
 321
 322 enum em28xx_int_audio_type {
 323         EM28XX_INT_AUDIO_NONE = 0,
 324         EM28XX_INT_AUDIO_AC97,
 325         EM28XX_INT_AUDIO_I2S,
 326 };
 327
 328 enum em28xx_usb_audio_type {
 329         EM28XX_USB_AUDIO_NONE = 0,
 330         EM28XX_USB_AUDIO_CLASS,
 331         EM28XX_USB_AUDIO_VENDOR,
 332 };
 333
 334 /**
 335  * em28xx_amux - describes the type of audio input used by em28xx
 336  *
 337  * @EM28XX_AMUX_VIDEO:
 338  *      On devices without AC97, this is the only value that it is currently
 339  *      allowed.
 340  *      On devices with AC97, it corresponds to the AC97 mixer "Video" control.
 341  * @EM28XX_AMUX_LINE_IN:
 342  *      Only for devices with AC97. Corresponds to AC97 mixer "Line In".
 343  * @EM28XX_AMUX_VIDEO2:
 344  *      Only for devices with AC97. It means that em28xx should use "Line In"
 345  *      And AC97 should use the "Video" mixer control.
 346  * @EM28XX_AMUX_PHONE:
 347  *      Only for devices with AC97. Corresponds to AC97 mixer "Phone".
 348  * @EM28XX_AMUX_MIC:
 349  *      Only for devices with AC97. Corresponds to AC97 mixer "Mic".
 350  * @EM28XX_AMUX_CD:
 351  *      Only for devices with AC97. Corresponds to AC97 mixer "CD".
 352  * @EM28XX_AMUX_AUX:
 353  *      Only for devices with AC97. Corresponds to AC97 mixer "Aux".
 354  * @EM28XX_AMUX_PCM_OUT:
 355  *      Only for devices with AC97. Corresponds to AC97 mixer "PCM out".
 356  *
 357  * The em28xx chip itself has only two audio inputs: tuner and line in.
 358  * On almost all devices, only the tuner input is used.
 359  *
 360  * However, on most devices, an auxiliary AC97 codec device is used,
 361  * usually connected to the em28xx tuner input (except for
 362  * @EM28XX_AMUX_LINE_IN).
 363  *
 364  * The AC97 device typically have several different inputs and outputs.
 365  * The exact number and description depends on their model.
 366  *
 367  * It is possible to AC97 to mixer more than one different entries at the
 368  * same time, via the alsa mux.
 369  */
 370 enum em28xx_amux {
 371         EM28XX_AMUX_VIDEO,
 372         EM28XX_AMUX_LINE_IN,
 373
 374         /* Some less-common mixer setups */
 375         EM28XX_AMUX_VIDEO2,
 376         EM28XX_AMUX_PHONE,
 377         EM28XX_AMUX_MIC,
 378         EM28XX_AMUX_CD,
 379         EM28XX_AMUX_AUX,
 380         EM28XX_AMUX_PCM_OUT,
 381 };
 382
 383 enum em28xx_aout {
 384         /* AC97 outputs */
 385         EM28XX_AOUT_MASTER = BIT(0),
 386         EM28XX_AOUT_LINE   = BIT(1),
 387         EM28XX_AOUT_MONO   = BIT(2),
 388         EM28XX_AOUT_LFE    = BIT(3),
 389         EM28XX_AOUT_SURR   = BIT(4),
 390
 391         /* PCM IN Mixer - used by AC97_RECORD_SELECT register */
 392         EM28XX_AOUT_PCM_IN = BIT(7),
 393
 394         /* Bits 10-8 are used to indicate the PCM IN record select */
 395         EM28XX_AOUT_PCM_MIC_PCM = 0 << 8,
 396         EM28XX_AOUT_PCM_CD      = 1 << 8,
 397         EM28XX_AOUT_PCM_VIDEO   = 2 << 8,
 398         EM28XX_AOUT_PCM_AUX     = 3 << 8,
 399         EM28XX_AOUT_PCM_LINE    = 4 << 8,
 400         EM28XX_AOUT_PCM_STEREO  = 5 << 8,
 401         EM28XX_AOUT_PCM_MONO    = 6 << 8,
 402         EM28XX_AOUT_PCM_PHONE   = 7 << 8,
 403 };
 404
 405 static inline int ac97_return_record_select(int a_out)
 406 {
 407         return (a_out & 0x700) >> 8;
 408 }
 409
 410 struct em28xx_reg_seq {
 411         int reg;
 412         unsigned char val, mask;
 413         int sleep;
 414 };
 415
 416 struct em28xx_input {
 417         enum enum28xx_itype type;
 418         unsigned int vmux;
 419         enum em28xx_amux amux;
 420         enum em28xx_aout aout;
 421         const struct em28xx_reg_seq *gpio;
 422 };
 423
 424 #define INPUT(nr) (&em28xx_boards[dev->model].input[nr])
 425
 426 enum em28xx_decoder {
 427         EM28XX_NODECODER = 0,
 428         EM28XX_TVP5150,
 429         EM28XX_SAA711X,
 430 };
 431
 432 enum em28xx_sensor {
 433         EM28XX_NOSENSOR = 0,
 434         EM28XX_MT9V011,
 435         EM28XX_MT9M001,
 436         EM28XX_MT9M111,
 437         EM28XX_OV2640,
 438 };
 439
 440 enum em28xx_adecoder {
 441         EM28XX_NOADECODER = 0,
 442         EM28XX_TVAUDIO,
 443 };
 444
 445 enum em28xx_led_role {
 446         EM28XX_LED_ANALOG_CAPTURING = 0,
 447         EM28XX_LED_DIGITAL_CAPTURING,
 448         EM28XX_LED_DIGITAL_CAPTURING_TS2,
 449         EM28XX_LED_ILLUMINATION,
 450         EM28XX_NUM_LED_ROLES, /* must be the last */
 451 };
 452
 453 struct em28xx_led {
 454         enum em28xx_led_role role;
 455         u8 gpio_reg;
 456         u8 gpio_mask;
 457         bool inverted;
 458 };
 459
 460 enum em28xx_button_role {
 461         EM28XX_BUTTON_SNAPSHOT = 0,
 462         EM28XX_BUTTON_ILLUMINATION,
 463         EM28XX_NUM_BUTTON_ROLES, /* must be the last */
 464 };
 465
 466 struct em28xx_button {
 467         enum em28xx_button_role role;
 468         u8 reg_r;
 469         u8 reg_clearing;
 470         u8 mask;
 471         bool inverted;
 472 };
 473
 474 struct em28xx_board {
 475         char *name;
 476         int vchannels;
 477         int tuner_type;
 478         int tuner_addr;
 479         unsigned int def_i2c_bus;       /* Default I2C bus */
 480
 481         /* i2c flags */
 482         unsigned int tda9887_conf;
 483
 484         /* GPIO sequences */
 485         const struct em28xx_reg_seq *dvb_gpio;
 486         const struct em28xx_reg_seq *suspend_gpio;
 487         const struct em28xx_reg_seq *tuner_gpio;
 488         const struct em28xx_reg_seq *mute_gpio;
 489
 490         unsigned int is_em2800:1;
 491         unsigned int has_msp34xx:1;
 492         unsigned int mts_firmware:1;
 493         unsigned int max_range_640_480:1;
 494         unsigned int has_dvb:1;
 495         unsigned int has_dual_ts:1;
 496         unsigned int is_webcam:1;
 497         unsigned int valid:1;
 498         unsigned int has_ir_i2c:1;
 499
 500         unsigned char xclk, i2c_speed;
 501         unsigned char radio_addr;
 502         unsigned short tvaudio_addr;
 503
 504         enum em28xx_decoder decoder;
 505         enum em28xx_adecoder adecoder;
 506
 507         struct em28xx_input       input[MAX_EM28XX_INPUT];
 508         struct em28xx_input       radio;
 509         char                      *ir_codes;
 510
 511         /* LEDs that need to be controlled explicitly */
 512         struct em28xx_led         *leds;
 513
 514         /* Buttons */
 515         const struct em28xx_button *buttons;
 516 };
 517
 518 struct em28xx_eeprom {
 519         u8 id[4];                       /* 1a eb 67 95 */
 520         __le16 vendor_ID;
 521         __le16 product_ID;
 522
 523         __le16 chip_conf;
 524
 525         __le16 board_conf;
 526
 527         __le16 string1, string2, string3;
 528
 529         u8 string_idx_table;
 530 };
 531
 532 #define EM28XX_CAPTURE_STREAM_EN 1
 533
 534 /* em28xx extensions */
 535 #define EM28XX_AUDIO   0x10
 536 #define EM28XX_DVB     0x20
 537 #define EM28XX_RC      0x30
 538 #define EM28XX_V4L2    0x40
 539
 540 /* em28xx resource types (used for res_get/res_lock etc */
 541 #define EM28XX_RESOURCE_VIDEO 0x01
 542 #define EM28XX_RESOURCE_VBI   0x02
 543
 544 struct em28xx_v4l2 {
 545         struct kref ref;
 546         struct em28xx *dev;
 547
 548         struct v4l2_device v4l2_dev;
 549         struct v4l2_ctrl_handler ctrl_handler;
 550
 551         struct video_device vdev;
 552         struct video_device vbi_dev;
 553         struct video_device radio_dev;
 554
 555         /* Videobuf2 */
 556         struct vb2_queue vb_vidq;
 557         struct vb2_queue vb_vbiq;
 558         struct mutex vb_queue_lock;     /* Protects vb_vidq */
 559         struct mutex vb_vbi_queue_lock; /* Protects vb_vbiq */
 560
 561         u8 vinmode;
 562         u8 vinctl;
 563
 564         /* Camera specific fields */
 565         int sensor_xres;
 566         int sensor_yres;
 567         int sensor_xtal;
 568
 569         int users;              /* user count for exclusive use */
 570         int streaming_users;    /* number of actively streaming users */
 571
 572         u32 frequency;          /* selected tuner frequency */
 573
 574         struct em28xx_fmt *format;
 575         v4l2_std_id norm;       /* selected tv norm */
 576
 577         /* Progressive/interlaced mode */
 578         bool progressive;
 579         int interlaced_fieldmode; /* 1=interlaced fields, 0=just top fields */
 580         /* FIXME: everything else than interlaced_fieldmode=1 doesn't work */
 581
 582         /* Frame properties */
 583         int width;              /* current frame width */
 584         int height;             /* current frame height */
 585         unsigned int hscale;    /* horizontal scale factor (see datasheet) */
 586         unsigned int vscale;    /* vertical scale factor (see datasheet) */
 587         unsigned int vbi_width;
 588         unsigned int vbi_height; /* lines per field */
 589
 590         /* Capture state tracking */
 591         int capture_type;
 592         bool top_field;
 593         int vbi_read;
 594         unsigned int field_count;
 595
 596 #ifdef CONFIG_MEDIA_CONTROLLER
 597         struct media_pad video_pad, vbi_pad;
 598         struct media_entity *decoder;
 599 #endif
 600 };
 601
 602 struct em28xx_audio {
 603         char name[50];
 604         unsigned int num_urb;
 605         char **transfer_buffer;
 606         struct urb **urb;
 607         struct usb_device *udev;
 608         unsigned int capture_transfer_done;
 609         struct snd_pcm_substream   *capture_pcm_substream;
 610
 611         unsigned int hwptr_done_capture;
 612         struct snd_card            *sndcard;
 613
 614         size_t period;
 615
 616         int users;
 617         spinlock_t slock;               /* Protects struct em28xx_audio */
 618
 619         /* Controls streaming */
 620         struct work_struct wq_trigger;  /* trigger to start/stop audio */
 621         atomic_t       stream_started;  /* stream should be running if true */
 622 };
 623
 624 struct em28xx;
 625
 626 enum em28xx_i2c_algo_type {
 627         EM28XX_I2C_ALGO_EM28XX = 0,
 628         EM28XX_I2C_ALGO_EM2800,
 629         EM28XX_I2C_ALGO_EM25XX_BUS_B,
 630 };
 631
 632 struct em28xx_i2c_bus {
 633         struct em28xx *dev;
 634
 635         unsigned int bus;
 636         enum em28xx_i2c_algo_type algo_type;
 637 };
 638
 639 /* main device struct */
 640 struct em28xx {
 641         struct kref ref;
 642
 643         // Sub-module data
 644         struct em28xx_v4l2 *v4l2;
 645         struct em28xx_dvb *dvb;
 646         struct em28xx_audio adev;
 647         struct em28xx_IR *ir;
 648
 649         // generic device properties
 650         int model;              // index in the device_data struct
 651         int devno;              // marks the number of this device
 652         enum em28xx_chip_id chip_id;
 653
 654         unsigned int is_em25xx:1;       // em25xx/em276x/7x/8x family bridge
 655         unsigned int disconnected:1;    // device has been diconnected
 656         unsigned int has_video:1;
 657         unsigned int is_audio_only:1;
 658         unsigned int is_webcam:1;
 659         unsigned int has_msp34xx:1;
 660         unsigned int i2c_speed:2;
 661         enum em28xx_int_audio_type int_audio_type;
 662         enum em28xx_usb_audio_type usb_audio_type;
 663         unsigned char name[32];
 664
 665         struct em28xx_board board;
 666
 667         enum em28xx_sensor em28xx_sensor;       // camera specific
 668
 669         // Some older em28xx chips needs a waiting time after writing
 670         unsigned int wait_after_write;
 671
 672         struct list_head        devlist;
 673
 674         u32 i2s_speed;          // I2S speed for audio digital stream
 675
 676         struct em28xx_audio_mode audio_mode;
 677
 678         int tuner_type;         // type of the tuner
 679
 680         // i2c i/o
 681         struct i2c_adapter i2c_adap[NUM_I2C_BUSES];
 682         struct i2c_client i2c_client[NUM_I2C_BUSES];
 683         struct em28xx_i2c_bus i2c_bus[NUM_I2C_BUSES];
 684
 685         unsigned char eeprom_addrwidth_16bit:1;
 686         unsigned int def_i2c_bus;       // Default I2C bus
 687         unsigned int cur_i2c_bus;       // Current I2C bus
 688         struct rt_mutex i2c_bus_lock;
 689
 690         // video for linux
 691         unsigned int ctl_input; // selected input
 692         unsigned int ctl_ainput;// selected audio input
 693         unsigned int ctl_aoutput;// selected audio output
 694         int mute;
 695         int volume;
 696
 697         unsigned long hash;     // eeprom hash - for boards with generic ID
 698         unsigned long i2c_hash; // i2c devicelist hash -
 699                                 // for boards with generic ID
 700
 701         struct work_struct         request_module_wk;
 702
 703         // locks
 704         struct mutex lock;              /* protects em28xx struct */
 705         struct mutex ctrl_urb_lock;     /* protects urb_buf */
 706
 707         // resources in use
 708         unsigned int resources;
 709
 710         // eeprom content
 711         u8 *eedata;
 712         u16 eedata_len;
 713
 714         // Isoc control struct
 715         struct em28xx_dmaqueue vidq;
 716         struct em28xx_dmaqueue vbiq;
 717         struct em28xx_usb_ctl usb_ctl;
 718
 719         spinlock_t slock; /* Protects em28xx video/vbi/dvb IRQ stream data */
 720
 721         // usb transfer
 722         struct usb_interface *intf;     // the usb interface
 723         u8 ifnum;               // number of the assigned usb interface
 724         u8 analog_ep_isoc;      // address of isoc endpoint for analog
 725         u8 analog_ep_bulk;      // address of bulk endpoint for analog
 726         u8 dvb_ep_isoc_ts2;     // address of isoc endpoint for DVB TS2
 727         u8 dvb_ep_bulk_ts2;     // address of bulk endpoint for DVB TS2
 728         u8 dvb_ep_isoc;         // address of isoc endpoint for DVB
 729         u8 dvb_ep_bulk;         // address of bulk endpoint for DVB
 730         int alt;                // alternate setting
 731         int max_pkt_size;       // max packet size of the selected ep at alt
 732         int packet_multiplier;  // multiplier for wMaxPacketSize, used for
 733                                 // URB buffer size definition
 734         int num_alt;            // number of alternative settings
 735         unsigned int *alt_max_pkt_size_isoc; // array of isoc wMaxPacketSize
 736         unsigned int analog_xfer_bulk:1;        // use bulk instead of isoc
 737                                                 // transfers for analog
 738         int dvb_alt_isoc;       // alternate setting for DVB isoc transfers
 739         unsigned int dvb_max_pkt_size_isoc;     // isoc max packet size of the
 740                                                 // selected DVB ep at dvb_alt
 741         unsigned int dvb_max_pkt_size_isoc_ts2; // isoc max packet size of the
 742                                                 // selected DVB ep at dvb_alt
 743         unsigned int dvb_xfer_bulk:1;           // use bulk instead of isoc
 744                                                 // transfers for DVB
 745         char urb_buf[URB_MAX_CTRL_SIZE];        // urb control msg buffer
 746
 747         // helper funcs that call usb_control_msg
 748         int (*em28xx_write_regs)(struct em28xx *dev, u16 reg,
 749                                  char *buf, int len);
 750         int (*em28xx_read_reg)(struct em28xx *dev, u16 reg);
 751         int (*em28xx_read_reg_req_len)(struct em28xx *dev, u8 req, u16 reg,
 752                                        char *buf, int len);
 753         int (*em28xx_write_regs_req)(struct em28xx *dev, u8 req, u16 reg,
 754                                      char *buf, int len);
 755         int (*em28xx_read_reg_req)(struct em28xx *dev, u8 req, u16 reg);
 756
 757         enum em28xx_mode mode;
 758
 759         // Button state polling
 760         struct delayed_work buttons_query_work;
 761         u8 button_polling_addresses[EM28XX_NUM_BUTTON_ADDRESSES_MAX];
 762         u8 button_polling_last_values[EM28XX_NUM_BUTTON_ADDRESSES_MAX];
 763         u8 num_button_polling_addresses;
 764         u16 button_polling_interval; // [ms]
 765         // Snapshot button input device
 766         char snapshot_button_path[30];  // path of the input dev
 767         struct input_dev *sbutton_input_dev;
 768
 769 #ifdef CONFIG_MEDIA_CONTROLLER
 770         struct media_device *media_dev;
 771         struct media_entity input_ent[MAX_EM28XX_INPUT];
 772         struct media_pad input_pad[MAX_EM28XX_INPUT];
 773 #endif
 774
 775         struct em28xx   *dev_next;
 776         int ts;
 777 };
 778
 779 #define kref_to_dev(d) container_of(d, struct em28xx, ref)
 780
 781 struct em28xx_ops {
 782         struct list_head next;
 783         char *name;
 784         int id;
 785         int (*init)(struct em28xx *dev);
 786         int (*fini)(struct em28xx *dev);
 787         int (*suspend)(struct em28xx *dev);
 788         int (*resume)(struct em28xx *dev);
 789 };
 790
 791 /* Provided by em28xx-i2c.c */
 792 void em28xx_do_i2c_scan(struct em28xx *dev, unsigned int bus);
 793 int  em28xx_i2c_register(struct em28xx *dev, unsigned int bus,
 794                          enum em28xx_i2c_algo_type algo_type);
 795 int  em28xx_i2c_unregister(struct em28xx *dev, unsigned int bus);
 796
 797 /* Provided by em28xx-core.c */
 798 int em28xx_read_reg_req_len(struct em28xx *dev, u8 req, u16 reg,
 799                             char *buf, int len);
 800 int em28xx_read_reg_req(struct em28xx *dev, u8 req, u16 reg);
 801 int em28xx_read_reg(struct em28xx *dev, u16 reg);
 802 int em28xx_write_regs_req(struct em28xx *dev, u8 req, u16 reg, char *buf,
 803                           int len);
 804 int em28xx_write_regs(struct em28xx *dev, u16 reg, char *buf, int len);
 805 int em28xx_write_reg(struct em28xx *dev, u16 reg, u8 val);
 806 int em28xx_write_reg_bits(struct em28xx *dev, u16 reg, u8 val,
 807                           u8 bitmask);
 808 int em28xx_toggle_reg_bits(struct em28xx *dev, u16 reg, u8 bitmask);
 809
 810 int em28xx_read_ac97(struct em28xx *dev, u8 reg);
 811 int em28xx_write_ac97(struct em28xx *dev, u8 reg, u16 val);
 812
 813 int em28xx_audio_analog_set(struct em28xx *dev);
 814 int em28xx_audio_setup(struct em28xx *dev);
 815
 816 const struct em28xx_led *em28xx_find_led(struct em28xx *dev,
 817                                          enum em28xx_led_role role);
 818 int em28xx_capture_start(struct em28xx *dev, int start);
 819 int em28xx_alloc_urbs(struct em28xx *dev, enum em28xx_mode mode, int xfer_bulk,
 820                       int num_bufs, int max_pkt_size, int packet_multiplier);
 821 int em28xx_init_usb_xfer(struct em28xx *dev, enum em28xx_mode mode,
 822                          int xfer_bulk,
 823                          int num_bufs, int max_pkt_size, int packet_multiplier,
 824                          int (*urb_data_copy)
 825                                         (struct em28xx *dev, struct urb *urb));
 826 void em28xx_uninit_usb_xfer(struct em28xx *dev, enum em28xx_mode mode);
 827 void em28xx_stop_urbs(struct em28xx *dev);
 828 int em28xx_set_mode(struct em28xx *dev, enum em28xx_mode set_mode);
 829 int em28xx_gpio_set(struct em28xx *dev, const struct em28xx_reg_seq *gpio);
 830 int em28xx_register_extension(struct em28xx_ops *dev);
 831 void em28xx_unregister_extension(struct em28xx_ops *dev);
 832 void em28xx_init_extension(struct em28xx *dev);
 833 void em28xx_close_extension(struct em28xx *dev);
 834 int em28xx_suspend_extension(struct em28xx *dev);
 835 int em28xx_resume_extension(struct em28xx *dev);
 836
 837 /* Provided by em28xx-cards.c */
 838 extern const struct em28xx_board em28xx_boards[];
 839 extern struct usb_device_id em28xx_id_table[];
 840 int em28xx_tuner_callback(void *ptr, int component, int command, int arg);
 841 void em28xx_setup_xc3028(struct em28xx *dev, struct xc2028_ctrl *ctl);
 842 void em28xx_free_device(struct kref *ref);
 843
 844 /* Provided by em28xx-camera.c */
 845 int em28xx_detect_sensor(struct em28xx *dev);
 846 int em28xx_init_camera(struct em28xx *dev);
 847
 848 #endif