em28xx.h 24.6 KB
Newer Older
1
/* SPDX-License-Identifier: GPL-2.0+ */
2
/*
3 4 5 6
 * em28xx.h - driver for Empia EM2800/EM2820/2840 USB video capture devices
 *
 * Copyright (C) 2005 Markus Rechberger <mrechberger@gmail.com>
 *		      Ludovico Cavedon <cavedon@sssup.it>
7
 *		      Mauro Carvalho Chehab <mchehab@kernel.org>
8 9 10 11 12 13 14 15 16 17 18 19 20
 * Copyright (C) 2012 Frank Schäfer <fschaefer.oss@googlemail.com>
 *
 * Based on the em2800 driver from Sascha Sommer <saschasommer@freenet.de>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
21 22
 */

23 24
#ifndef _EM28XX_H
#define _EM28XX_H
25

26 27
#include <linux/bitfield.h>

28
#define EM28XX_VERSION "0.2.2"
29
#define DRIVER_DESC    "Empia em28xx device driver"
30

31 32 33
#include <linux/workqueue.h>
#include <linux/i2c.h>
#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 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70
#define EM2800_BOARD_UNKNOWN			  0
#define EM2820_BOARD_UNKNOWN			  1
#define EM2820_BOARD_TERRATEC_CINERGY_250	  2
#define EM2820_BOARD_PINNACLE_USB_2		  3
#define EM2820_BOARD_HAUPPAUGE_WINTV_USB_2	  4
#define EM2820_BOARD_MSI_VOX_USB_2		  5
#define EM2800_BOARD_TERRATEC_CINERGY_200	  6
#define EM2800_BOARD_LEADTEK_WINFAST_USBII	  7
#define EM2800_BOARD_KWORLD_USB2800		  8
#define EM2820_BOARD_PINNACLE_DVC_90		  9
#define EM2880_BOARD_HAUPPAUGE_WINTV_HVR_900	  10
#define EM2880_BOARD_TERRATEC_HYBRID_XS		  11
#define EM2820_BOARD_KWORLD_PVRTV2800RF		  12
#define EM2880_BOARD_TERRATEC_PRODIGY_XS	  13
#define EM2820_BOARD_PROLINK_PLAYTV_USB2	  14
#define EM2800_BOARD_VGEAR_POCKETTV		  15
#define EM2883_BOARD_HAUPPAUGE_WINTV_HVR_950	  16
#define EM2880_BOARD_PINNACLE_PCTV_HD_PRO	  17
#define EM2880_BOARD_HAUPPAUGE_WINTV_HVR_900_R2	  18
#define EM2860_BOARD_SAA711X_REFERENCE_DESIGN	  19
#define EM2880_BOARD_AMD_ATI_TV_WONDER_HD_600	  20
#define EM2800_BOARD_GRABBEEX_USB2800		  21
71 72 73 74 75 76 77
#define EM2750_BOARD_UNKNOWN			  22
#define EM2750_BOARD_DLCW_130			  23
#define EM2820_BOARD_DLINK_USB_TV		  24
#define EM2820_BOARD_GADMEI_UTV310		  25
#define EM2820_BOARD_HERCULES_SMART_TV_USB2	  26
#define EM2820_BOARD_PINNACLE_USB_2_FM1216ME	  27
#define EM2820_BOARD_LEADTEK_WINFAST_USBII_DELUXE 28
78
#define EM2860_BOARD_TVP5150_REFERENCE_DESIGN	  29
79 80 81
#define EM2820_BOARD_VIDEOLOGY_20K14XUSB	  30
#define EM2821_BOARD_USBGEAR_VD204		  31
#define EM2821_BOARD_SUPERCOMP_USB_2		  32
82
#define EM2860_BOARD_ELGATO_VIDEO_CAPTURE	  33
83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104
#define EM2860_BOARD_TERRATEC_HYBRID_XS		  34
#define EM2860_BOARD_TYPHOON_DVD_MAKER		  35
#define EM2860_BOARD_NETGMBH_CAM		  36
#define EM2860_BOARD_GADMEI_UTV330		  37
#define EM2861_BOARD_YAKUMO_MOVIE_MIXER		  38
#define EM2861_BOARD_KWORLD_PVRTV_300U		  39
#define EM2861_BOARD_PLEXTOR_PX_TV100U		  40
#define EM2870_BOARD_KWORLD_350U		  41
#define EM2870_BOARD_KWORLD_355U		  42
#define EM2870_BOARD_TERRATEC_XS		  43
#define EM2870_BOARD_TERRATEC_XS_MT2060		  44
#define EM2870_BOARD_PINNACLE_PCTV_DVB		  45
#define EM2870_BOARD_COMPRO_VIDEOMATE		  46
#define EM2880_BOARD_KWORLD_DVB_305U		  47
#define EM2880_BOARD_KWORLD_DVB_310U		  48
#define EM2880_BOARD_MSI_DIGIVOX_AD		  49
#define EM2880_BOARD_MSI_DIGIVOX_AD_II		  50
#define EM2880_BOARD_TERRATEC_HYBRID_XS_FR	  51
#define EM2881_BOARD_DNT_DA2_HYBRID		  52
#define EM2881_BOARD_PINNACLE_HYBRID_PRO	  53
#define EM2882_BOARD_KWORLD_VS_DVBT		  54
#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 113
#define EM2860_BOARD_KAIOMY_TVNPC_U2		  63
#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 121 122
#define EM2820_BOARD_SILVERCREST_WEBCAM		  71
#define EM2861_BOARD_GADMEI_UTV330PLUS		  72
#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 133 134 135
#define EM2860_BOARD_HT_VIDBOX_NW03		  83
#define EM2874_BOARD_MAXMEDIA_UB425_TC		  84
#define EM2884_BOARD_PCTV_510E			  85
#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 153 154

/* Limits minimum and default number of buffers */
#define EM28XX_MIN_BUF 4
#define EM28XX_DEF_BUF 8
155

156 157 158
/*Limits the max URB message size */
#define URB_MAX_CTRL_SIZE 80

159 160 161 162
/* Params for validated field */
#define EM28XX_BOARD_NOT_VALIDATED 1
#define EM28XX_BOARD_VALIDATED	   0

163 164 165 166
/* Params for em28xx_cmd() audio */
#define EM28XX_START_AUDIO      1
#define EM28XX_STOP_AUDIO       0

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 180 181
/* max number of I2C buses on em28xx devices */
#define NUM_I2C_BUSES	2

182 183 184 185
/*
 * isoc transfers: number of packets for each buffer
 * windows requests only 64 packets .. so we better do the same
 * this is what I found out for all alternate numbers there!
186
 */
187 188
#define EM28XX_NUM_ISOC_PACKETS 64
#define EM28XX_DVB_NUM_ISOC_PACKETS 64
189

190 191 192
/*
 * bulk transfers: transfer buffer size = packet size * packet multiplier
 * 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 200 201
/* time in msecs to wait for AC97 xfers to finish */
#define EM28XX_AC97_XFER_TIMEOUT	100

202 203 204
/* max. number of button state polling addresses */
#define EM28XX_NUM_BUTTON_ADDRESSES_MAX		5

205 206 207
#define PRIMARY_TS	0
#define SECONDARY_TS	1

208
enum em28xx_mode {
209
	EM28XX_SUSPEND,
210 211 212 213
	EM28XX_ANALOG_MODE,
	EM28XX_DIGITAL_MODE,
};

214 215
struct em28xx;

216 217 218 219 220 221 222 223 224
/**
 * struct em28xx_usb_bufs - Contains URB-related buffer data
 *
 * @max_pkt_size:	max packet size of isoc transaction
 * @num_packets:	number of packets in each buffer
 * @num_bufs:		number of allocated urb
 * @urb:		urb for isoc/bulk transfers
 * @buf:		transfer buffers for isoc/bulk transfer
 */
225
struct em28xx_usb_bufs {
226
	int				max_pkt_size;
227
	int				num_packets;
228 229
	int				num_bufs;
	struct urb			**urb;
230
	char				**buf;
231 232
};

233 234 235 236 237 238 239 240 241
/**
 * struct em28xx_usb_ctl - Contains URB-related buffer data
 *
 * @analog_bufs:	isoc/bulk transfer buffers for analog mode
 * @digital_bufs:	isoc/bulk transfer buffers for digital mode
 * @vid_buf:		Stores already requested video buffers
 * @vbi_buf:		Stores already requested VBI buffers
 * @urb_data_copy:	copy data from URB
 */
242
struct em28xx_usb_ctl {
243 244
	struct em28xx_usb_bufs		analog_bufs;
	struct em28xx_usb_bufs		digital_bufs;
245 246 247
	struct em28xx_buffer	*vid_buf;
	struct em28xx_buffer	*vbi_buf;
	int (*urb_data_copy)(struct em28xx *dev, struct urb *urb);
248 249
};

250 251 252 253 254 255 256 257
/**
 * struct em28xx_fmt - Struct to enumberate video formats
 *
 * @name:	Name for the video standard
 * @fourcc:	v4l2 format id
 * @depth:	mean number of bits to represent a pixel
 * @reg:	em28xx register value to set it
 */
258
struct em28xx_fmt {
259 260 261 262
	char	*name;
	u32	fourcc;
	int	depth;
	int	reg;
263 264
};

265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280
/**
 * struct em28xx_buffer- buffer for storing one video frame
 *
 * @vb:		common v4l buffer stuff
 * @list:	List to associate it with the other buffers
 * @mem:	pointer to the buffer, as returned by vb2_plane_vaddr()
 * @length:	length of the buffer, as returned by vb2_plane_size()
 * @top_field:	If non-zero, indicate that the buffer is the top field
 * @pos:	Indicate the next position of the buffer to be filled.
 * @vb_buf:	pointer to vmalloc memory address in vb
 *
 * .. note::
 *
 *    in interlaced mode, @pos is reset to zero at the start of each new
 *    field (not frame !)
 */
281
struct em28xx_buffer {
282 283 284
	struct vb2_v4l2_buffer	vb;		/* must be first */

	struct list_head	list;
285

286 287 288
	void			*mem;
	unsigned int		length;
	int			top_field;
289

290
	unsigned int		pos;
291

292
	char			*vb_buf;
293 294 295 296 297 298
};

struct em28xx_dmaqueue {
	struct list_head       active;

	wait_queue_head_t          wq;
299 300 301 302
};

/* inputs */

303 304
#define MAX_EM28XX_INPUT 4
enum enum28xx_itype {
305
	EM28XX_VMUX_COMPOSITE = 1,
306 307 308
	EM28XX_VMUX_SVIDEO,
	EM28XX_VMUX_TELEVISION,
	EM28XX_RADIO,
309 310
};

311 312 313
enum em28xx_ac97_mode {
	EM28XX_NO_AC97 = 0,
	EM28XX_AC97_EM202,
314
	EM28XX_AC97_SIGMATEL,
315 316 317 318 319
	EM28XX_AC97_OTHER,
};

struct em28xx_audio_mode {
	enum em28xx_ac97_mode ac97;
320
};
321

322 323 324 325
enum em28xx_int_audio_type {
	EM28XX_INT_AUDIO_NONE = 0,
	EM28XX_INT_AUDIO_AC97,
	EM28XX_INT_AUDIO_I2S,
326
};
327

328 329 330 331
enum em28xx_usb_audio_type {
	EM28XX_USB_AUDIO_NONE = 0,
	EM28XX_USB_AUDIO_CLASS,
	EM28XX_USB_AUDIO_VENDOR,
332 333
};

334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368
/**
 * em28xx_amux - describes the type of audio input used by em28xx
 *
 * @EM28XX_AMUX_VIDEO:
 *	On devices without AC97, this is the only value that it is currently
 *	allowed.
 *	On devices with AC97, it corresponds to the AC97 mixer "Video" control.
 * @EM28XX_AMUX_LINE_IN:
 *	Only for devices with AC97. Corresponds to AC97 mixer "Line In".
 * @EM28XX_AMUX_VIDEO2:
 *	Only for devices with AC97. It means that em28xx should use "Line In"
 *	And AC97 should use the "Video" mixer control.
 * @EM28XX_AMUX_PHONE:
 *	Only for devices with AC97. Corresponds to AC97 mixer "Phone".
 * @EM28XX_AMUX_MIC:
 *	Only for devices with AC97. Corresponds to AC97 mixer "Mic".
 * @EM28XX_AMUX_CD:
 *	Only for devices with AC97. Corresponds to AC97 mixer "CD".
 * @EM28XX_AMUX_AUX:
 *	Only for devices with AC97. Corresponds to AC97 mixer "Aux".
 * @EM28XX_AMUX_PCM_OUT:
 *	Only for devices with AC97. Corresponds to AC97 mixer "PCM out".
 *
 * The em28xx chip itself has only two audio inputs: tuner and line in.
 * On almost all devices, only the tuner input is used.
 *
 * However, on most devices, an auxiliary AC97 codec device is used,
 * usually connected to the em28xx tuner input (except for
 * @EM28XX_AMUX_LINE_IN).
 *
 * The AC97 device typically have several different inputs and outputs.
 * The exact number and description depends on their model.
 *
 * It is possible to AC97 to mixer more than one different entries at the
 * same time, via the alsa mux.
369
 */
370
enum em28xx_amux {
371 372
	EM28XX_AMUX_VIDEO,
	EM28XX_AMUX_LINE_IN,
373 374

	/* Some less-common mixer setups */
375
	EM28XX_AMUX_VIDEO2,
376 377 378 379 380
	EM28XX_AMUX_PHONE,
	EM28XX_AMUX_MIC,
	EM28XX_AMUX_CD,
	EM28XX_AMUX_AUX,
	EM28XX_AMUX_PCM_OUT,
381 382
};

383
enum em28xx_aout {
384
	/* AC97 outputs */
385 386 387 388 389
	EM28XX_AOUT_MASTER = BIT(0),
	EM28XX_AOUT_LINE   = BIT(1),
	EM28XX_AOUT_MONO   = BIT(2),
	EM28XX_AOUT_LFE    = BIT(3),
	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 395 396 397 398 399 400 401 402

	/* Bits 10-8 are used to indicate the PCM IN record select */
	EM28XX_AOUT_PCM_MIC_PCM = 0 << 8,
	EM28XX_AOUT_PCM_CD	= 1 << 8,
	EM28XX_AOUT_PCM_VIDEO	= 2 << 8,
	EM28XX_AOUT_PCM_AUX	= 3 << 8,
	EM28XX_AOUT_PCM_LINE	= 4 << 8,
	EM28XX_AOUT_PCM_STEREO	= 5 << 8,
	EM28XX_AOUT_PCM_MONO	= 6 << 8,
	EM28XX_AOUT_PCM_PHONE	= 7 << 8,
403 404
};

405
static inline int ac97_return_record_select(int a_out)
406 407 408 409
{
	return (a_out & 0x700) >> 8;
}

410 411 412 413 414 415
struct em28xx_reg_seq {
	int reg;
	unsigned char val, mask;
	int sleep;
};

416 417
struct em28xx_input {
	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 433
};

enum em28xx_sensor {
	EM28XX_NOSENSOR = 0,
434
	EM28XX_MT9V011,
435
	EM28XX_MT9M001,
436
	EM28XX_MT9M111,
437
	EM28XX_OV2640,
438 439
};

440 441 442 443 444
enum em28xx_adecoder {
	EM28XX_NOADECODER = 0,
	EM28XX_TVAUDIO,
};

445 446
enum em28xx_led_role {
	EM28XX_LED_ANALOG_CAPTURING = 0,
447
	EM28XX_LED_DIGITAL_CAPTURING,
448
	EM28XX_LED_DIGITAL_CAPTURING_TS2,
449
	EM28XX_LED_ILLUMINATION,
450 451 452
	EM28XX_NUM_LED_ROLES, /* must be the last */
};

453
struct em28xx_led {
454
	enum em28xx_led_role role;
455 456 457 458 459
	u8 gpio_reg;
	u8 gpio_mask;
	bool inverted;
};

460 461
enum em28xx_button_role {
	EM28XX_BUTTON_SNAPSHOT = 0,
462
	EM28XX_BUTTON_ILLUMINATION,
463 464 465 466 467 468 469 470 471 472 473
	EM28XX_NUM_BUTTON_ROLES, /* must be the last */
};

struct em28xx_button {
	enum em28xx_button_role role;
	u8 reg_r;
	u8 reg_clearing;
	u8 mask;
	bool inverted;
};

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 482 483

	/* i2c flags */
	unsigned int tda9887_conf;

484
	/* GPIO sequences */
485 486 487 488
	const struct em28xx_reg_seq *dvb_gpio;
	const struct em28xx_reg_seq *suspend_gpio;
	const struct em28xx_reg_seq *tuner_gpio;
	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 502
	unsigned char radio_addr;
	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 520 521
	u8 id[4];			/* 1a eb 67 95 */
	__le16 vendor_ID;
	__le16 product_ID;
522

523
	__le16 chip_conf;
524

525
	__le16 board_conf;
526

527
	__le16 string1, string2, string3;
528 529 530 531

	u8 string_idx_table;
};

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 541 542 543
/* em28xx resource types (used for res_get/res_lock etc */
#define EM28XX_RESOURCE_VIDEO 0x01
#define EM28XX_RESOURCE_VBI   0x02

544 545
struct em28xx_v4l2 {
	struct kref ref;
546
	struct em28xx *dev;
547 548

	struct v4l2_device v4l2_dev;
549
	struct v4l2_ctrl_handler ctrl_handler;
550

551 552 553
	struct video_device vdev;
	struct video_device vbi_dev;
	struct video_device radio_dev;
554 555 556 557

	/* Videobuf2 */
	struct vb2_queue vb_vidq;
	struct vb2_queue vb_vbiq;
558 559
	struct mutex vb_queue_lock;	/* Protects vb_vidq */
	struct mutex vb_vbi_queue_lock;	/* Protects vb_vbiq */
560

561 562 563
	u8 vinmode;
	u8 vinctl;

564 565 566 567 568
	/* Camera specific fields */
	int sensor_xres;
	int sensor_yres;
	int sensor_xtal;

569
	int users;		/* user count for exclusive use */
570 571
	int streaming_users;    /* number of actively streaming users */

572 573
	u32 frequency;		/* selected tuner frequency */

574
	struct em28xx_fmt *format;
575 576
	v4l2_std_id norm;	/* selected tv norm */

577 578 579 580 581
	/* Progressive/interlaced mode */
	bool progressive;
	int interlaced_fieldmode; /* 1=interlaced fields, 0=just top fields */
	/* FIXME: everything else than interlaced_fieldmode=1 doesn't work */

582 583 584
	/* Frame properties */
	int width;		/* current frame width */
	int height;		/* current frame height */
585 586
	unsigned int hscale;	/* horizontal scale factor (see datasheet) */
	unsigned int vscale;	/* vertical scale factor (see datasheet) */
587 588
	unsigned int vbi_width;
	unsigned int vbi_height; /* lines per field */
589 590 591 592 593 594

	/* Capture state tracking */
	int capture_type;
	bool top_field;
	int vbi_read;
	unsigned int field_count;
595 596 597 598 599

#ifdef CONFIG_MEDIA_CONTROLLER
	struct media_pad video_pad, vbi_pad;
	struct media_entity *decoder;
#endif
600 601
};

602 603
struct em28xx_audio {
	char name[50];
604
	unsigned int num_urb;
605 606
	char **transfer_buffer;
	struct urb **urb;
607 608 609 610 611 612 613
	struct usb_device *udev;
	unsigned int capture_transfer_done;
	struct snd_pcm_substream   *capture_pcm_substream;

	unsigned int hwptr_done_capture;
	struct snd_card            *sndcard;

614 615
	size_t period;

616
	int users;
617
	spinlock_t slock;		/* Protects struct em28xx_audio */
618 619 620 621

	/* Controls streaming */
	struct work_struct wq_trigger;	/* trigger to start/stop audio */
	atomic_t       stream_started;	/* stream should be running if true */
622 623
};

624 625
struct em28xx;

626 627 628 629 630 631
enum em28xx_i2c_algo_type {
	EM28XX_I2C_ALGO_EM28XX = 0,
	EM28XX_I2C_ALGO_EM2800,
	EM28XX_I2C_ALGO_EM25XX_BUS_B,
};

632 633 634
struct em28xx_i2c_bus {
	struct em28xx *dev;

635
	unsigned int bus;
636
	enum em28xx_i2c_algo_type algo_type;
637 638
};

639
/* main device struct */
640
struct em28xx {
641 642
	struct kref ref;

643
	// Sub-module data
644
	struct em28xx_v4l2 *v4l2;
645 646 647 648
	struct em28xx_dvb *dvb;
	struct em28xx_audio adev;
	struct em28xx_IR *ir;

649 650 651
	// generic device properties
	int model;		// index in the device_data struct
	int devno;		// marks the number of this device
652
	enum em28xx_chip_id chip_id;
653

654 655
	unsigned int is_em25xx:1;	// em25xx/em276x/7x/8x family bridge
	unsigned int disconnected:1;	// device has been diconnected
656
	unsigned int has_video:1;
657
	unsigned int is_audio_only:1;
658 659
	unsigned int is_webcam:1;
	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 666
	struct em28xx_board board;

667
	enum em28xx_sensor em28xx_sensor;	// camera specific
668

669
	// Some older em28xx chips needs a waiting time after writing
670 671
	unsigned int wait_after_write;

672 673
	struct list_head	devlist;

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 682
	struct i2c_adapter i2c_adap[NUM_I2C_BUSES];
	struct i2c_client i2c_client[NUM_I2C_BUSES];
683 684
	struct em28xx_i2c_bus i2c_bus[NUM_I2C_BUSES];

685
	unsigned char eeprom_addrwidth_16bit:1;
686 687
	unsigned int def_i2c_bus;	// Default I2C bus
	unsigned int cur_i2c_bus;	// Current I2C bus
688
	struct rt_mutex i2c_bus_lock;
689

690 691 692 693
	// video for linux
	unsigned int ctl_input;	// selected input
	unsigned int ctl_ainput;// selected audio input
	unsigned int ctl_aoutput;// selected audio output
694 695
	int mute;
	int volume;
696

697 698 699
	unsigned long hash;	// eeprom hash - for boards with generic ID
	unsigned long i2c_hash;	// i2c devicelist hash -
				// for boards with generic ID
700

701 702
	struct work_struct         request_module_wk;

703 704
	// locks
	struct mutex lock;		/* protects em28xx struct */
705
	struct mutex ctrl_urb_lock;	/* protects urb_buf */
706

707
	// resources in use
708 709
	unsigned int resources;

710
	// eeprom content
711 712
	u8 *eedata;
	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 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747

	spinlock_t slock; /* Protects em28xx video/vbi/dvb IRQ stream data */

	// usb transfer
	struct usb_interface *intf;	// the usb interface
	u8 ifnum;		// number of the assigned usb interface
	u8 analog_ep_isoc;	// address of isoc endpoint for analog
	u8 analog_ep_bulk;	// address of bulk endpoint for analog
	u8 dvb_ep_isoc_ts2;	// address of isoc endpoint for DVB TS2
	u8 dvb_ep_bulk_ts2;	// address of bulk endpoint for DVB TS2
	u8 dvb_ep_isoc;		// address of isoc endpoint for DVB
	u8 dvb_ep_bulk;		// address of bulk endpoint for DVB
	int alt;		// alternate setting
	int max_pkt_size;	// max packet size of the selected ep at alt
	int packet_multiplier;	// multiplier for wMaxPacketSize, used for
				// URB buffer size definition
	int num_alt;		// number of alternative settings
	unsigned int *alt_max_pkt_size_isoc; // array of isoc wMaxPacketSize
	unsigned int analog_xfer_bulk:1;	// use bulk instead of isoc
						// transfers for analog
	int dvb_alt_isoc;	// alternate setting for DVB isoc transfers
	unsigned int dvb_max_pkt_size_isoc;	// isoc max packet size of the
						// selected DVB ep at dvb_alt
	unsigned int dvb_max_pkt_size_isoc_ts2;	// isoc max packet size of the
						// selected DVB ep at dvb_alt
	unsigned int dvb_xfer_bulk:1;		// use bulk instead of isoc
						// transfers for DVB
	char urb_buf[URB_MAX_CTRL_SIZE];	// urb control msg buffer

	// helper funcs that call usb_control_msg
748 749 750 751 752 753 754 755
	int (*em28xx_write_regs)(struct em28xx *dev, u16 reg,
				 char *buf, int len);
	int (*em28xx_read_reg)(struct em28xx *dev, u16 reg);
	int (*em28xx_read_reg_req_len)(struct em28xx *dev, u8 req, u16 reg,
				       char *buf, int len);
	int (*em28xx_write_regs_req)(struct em28xx *dev, u8 req, u16 reg,
				     char *buf, int len);
	int (*em28xx_read_reg_req)(struct em28xx *dev, u8 req, u16 reg);
756 757 758

	enum em28xx_mode mode;

759
	// Button state polling
760 761
	struct delayed_work buttons_query_work;
	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 765 766
	u16 button_polling_interval; // [ms]
	// Snapshot button input device
	char snapshot_button_path[30];	// path of the input dev
767
	struct input_dev *sbutton_input_dev;
768 769 770 771 772 773

#ifdef CONFIG_MEDIA_CONTROLLER
	struct media_device *media_dev;
	struct media_entity input_ent[MAX_EM28XX_INPUT];
	struct media_pad input_pad[MAX_EM28XX_INPUT];
#endif
774 775 776

	struct em28xx	*dev_next;
	int ts;
777 778
};

779 780
#define kref_to_dev(d) container_of(d, struct em28xx, ref)

781 782 783 784
struct em28xx_ops {
	struct list_head next;
	char *name;
	int id;
785 786 787 788
	int (*init)(struct em28xx *dev);
	int (*fini)(struct em28xx *dev);
	int (*suspend)(struct em28xx *dev);
	int (*resume)(struct em28xx *dev);
789 790
};

791
/* Provided by em28xx-i2c.c */
792 793
void em28xx_do_i2c_scan(struct em28xx *dev, unsigned int bus);
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 798
/* Provided by em28xx-core.c */
int em28xx_read_reg_req_len(struct em28xx *dev, u8 req, u16 reg,
799
			    char *buf, int len);
800 801 802
int em28xx_read_reg_req(struct em28xx *dev, u8 req, u16 reg);
int em28xx_read_reg(struct em28xx *dev, u16 reg);
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 811 812
int em28xx_read_ac97(struct em28xx *dev, u8 reg);
int em28xx_write_ac97(struct em28xx *dev, u8 reg, u16 val);

813
int em28xx_audio_analog_set(struct em28xx *dev);
814
int em28xx_audio_setup(struct em28xx *dev);
815

816 817
const struct em28xx_led *em28xx_find_led(struct em28xx *dev,
					 enum em28xx_led_role role);
818
int em28xx_capture_start(struct em28xx *dev, int start);
819 820
int em28xx_alloc_urbs(struct em28xx *dev, enum em28xx_mode mode, int xfer_bulk,
		      int num_bufs, int max_pkt_size, int packet_multiplier);
821 822 823 824 825
int em28xx_init_usb_xfer(struct em28xx *dev, enum em28xx_mode mode,
			 int xfer_bulk,
			 int num_bufs, int max_pkt_size, int packet_multiplier,
			 int (*urb_data_copy)
					(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 831
int em28xx_register_extension(struct em28xx_ops *dev);
void em28xx_unregister_extension(struct em28xx_ops *dev);
832 833
void em28xx_init_extension(struct em28xx *dev);
void em28xx_close_extension(struct em28xx *dev);
834 835
int em28xx_suspend_extension(struct em28xx *dev);
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 845 846 847
/* Provided by em28xx-camera.c */
int em28xx_detect_sensor(struct em28xx *dev);
int em28xx_init_camera(struct em28xx *dev);

848
#endif