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