2 em28xx.h - driver for Empia EM2800/EM2820/2840 USB video capture devices
4 Copyright (C) 2005 Markus Rechberger <mrechberger@gmail.com>
5 Ludovico Cavedon <cavedon@sssup.it>
6 Mauro Carvalho Chehab <mchehab@infradead.org>
8 Based on the em2800 driver from Sascha Sommer <saschasommer@freenet.de>
10 This program is free software; you can redistribute it and/or modify
11 it under the terms of the GNU General Public License as published by
12 the Free Software Foundation; either version 2 of the License, or
13 (at your option) any later version.
15 This program is distributed in the hope that it will be useful,
16 but WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 GNU General Public License for more details.
20 You should have received a copy of the GNU General Public License
21 along with this program; if not, write to the Free Software
22 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
28 #include <linux/videodev2.h>
29 #include <media/videobuf-vmalloc.h>
31 #include <linux/i2c.h>
32 #include <linux/mutex.h>
33 #include <media/ir-kbd-i2c.h>
34 #if defined(CONFIG_VIDEO_EM28XX_DVB) || defined(CONFIG_VIDEO_EM28XX_DVB_MODULE)
35 #include <media/videobuf-dvb.h>
37 #include "tuner-xc2028.h"
38 #include "em28xx-reg.h"
40 /* Boards supported by driver */
41 #define EM2800_BOARD_UNKNOWN 0
42 #define EM2820_BOARD_UNKNOWN 1
43 #define EM2820_BOARD_TERRATEC_CINERGY_250 2
44 #define EM2820_BOARD_PINNACLE_USB_2 3
45 #define EM2820_BOARD_HAUPPAUGE_WINTV_USB_2 4
46 #define EM2820_BOARD_MSI_VOX_USB_2 5
47 #define EM2800_BOARD_TERRATEC_CINERGY_200 6
48 #define EM2800_BOARD_LEADTEK_WINFAST_USBII 7
49 #define EM2800_BOARD_KWORLD_USB2800 8
50 #define EM2820_BOARD_PINNACLE_DVC_90 9
51 #define EM2880_BOARD_HAUPPAUGE_WINTV_HVR_900 10
52 #define EM2880_BOARD_TERRATEC_HYBRID_XS 11
53 #define EM2820_BOARD_KWORLD_PVRTV2800RF 12
54 #define EM2880_BOARD_TERRATEC_PRODIGY_XS 13
55 #define EM2820_BOARD_PROLINK_PLAYTV_USB2 14
56 #define EM2800_BOARD_VGEAR_POCKETTV 15
57 #define EM2883_BOARD_HAUPPAUGE_WINTV_HVR_950 16
58 #define EM2880_BOARD_PINNACLE_PCTV_HD_PRO 17
59 #define EM2880_BOARD_HAUPPAUGE_WINTV_HVR_900_R2 18
60 #define EM2860_BOARD_POINTNIX_INTRAORAL_CAMERA 19
61 #define EM2880_BOARD_AMD_ATI_TV_WONDER_HD_600 20
62 #define EM2800_BOARD_GRABBEEX_USB2800 21
63 #define EM2750_BOARD_UNKNOWN 22
64 #define EM2750_BOARD_DLCW_130 23
65 #define EM2820_BOARD_DLINK_USB_TV 24
66 #define EM2820_BOARD_GADMEI_UTV310 25
67 #define EM2820_BOARD_HERCULES_SMART_TV_USB2 26
68 #define EM2820_BOARD_PINNACLE_USB_2_FM1216ME 27
69 #define EM2820_BOARD_LEADTEK_WINFAST_USBII_DELUXE 28
70 #define EM2820_BOARD_PINNACLE_DVC_100 29
71 #define EM2820_BOARD_VIDEOLOGY_20K14XUSB 30
72 #define EM2821_BOARD_USBGEAR_VD204 31
73 #define EM2821_BOARD_SUPERCOMP_USB_2 32
74 #define EM2821_BOARD_PROLINK_PLAYTV_USB2 33
75 #define EM2860_BOARD_TERRATEC_HYBRID_XS 34
76 #define EM2860_BOARD_TYPHOON_DVD_MAKER 35
77 #define EM2860_BOARD_NETGMBH_CAM 36
78 #define EM2860_BOARD_GADMEI_UTV330 37
79 #define EM2861_BOARD_YAKUMO_MOVIE_MIXER 38
80 #define EM2861_BOARD_KWORLD_PVRTV_300U 39
81 #define EM2861_BOARD_PLEXTOR_PX_TV100U 40
82 #define EM2870_BOARD_KWORLD_350U 41
83 #define EM2870_BOARD_KWORLD_355U 42
84 #define EM2870_BOARD_TERRATEC_XS 43
85 #define EM2870_BOARD_TERRATEC_XS_MT2060 44
86 #define EM2870_BOARD_PINNACLE_PCTV_DVB 45
87 #define EM2870_BOARD_COMPRO_VIDEOMATE 46
88 #define EM2880_BOARD_KWORLD_DVB_305U 47
89 #define EM2880_BOARD_KWORLD_DVB_310U 48
90 #define EM2880_BOARD_MSI_DIGIVOX_AD 49
91 #define EM2880_BOARD_MSI_DIGIVOX_AD_II 50
92 #define EM2880_BOARD_TERRATEC_HYBRID_XS_FR 51
93 #define EM2881_BOARD_DNT_DA2_HYBRID 52
94 #define EM2881_BOARD_PINNACLE_HYBRID_PRO 53
95 #define EM2882_BOARD_KWORLD_VS_DVBT 54
96 #define EM2882_BOARD_TERRATEC_HYBRID_XS 55
97 #define EM2882_BOARD_PINNACLE_HYBRID_PRO 56
98 #define EM2883_BOARD_KWORLD_HYBRID_A316 57
99 #define EM2820_BOARD_COMPRO_VIDEOMATE_FORYOU 58
101 /* Limits minimum and default number of buffers */
102 #define EM28XX_MIN_BUF 4
103 #define EM28XX_DEF_BUF 8
105 /*Limits the max URB message size */
106 #define URB_MAX_CTRL_SIZE 80
108 /* Params for validated field */
109 #define EM28XX_BOARD_NOT_VALIDATED 1
110 #define EM28XX_BOARD_VALIDATED 0
112 /* maximum number of em28xx boards */
113 #define EM28XX_MAXBOARDS 4 /*FIXME: should be bigger */
115 /* maximum number of frames that can be queued */
116 #define EM28XX_NUM_FRAMES 5
117 /* number of frames that get used for v4l2_read() */
118 #define EM28XX_NUM_READ_FRAMES 2
120 /* number of buffers for isoc transfers */
121 #define EM28XX_NUM_BUFS 5
123 /* number of packets for each buffer
124 windows requests only 40 packets .. so we better do the same
125 this is what I found out for all alternate numbers there!
127 #define EM28XX_NUM_PACKETS 40
129 /* default alternate; 0 means choose the best */
130 #define EM28XX_PINOUT 0
132 #define EM28XX_INTERLACED_DEFAULT 1
135 #define (use usbview if you want to get the other alternate number infos)
137 #define alternate number 2
138 #define Endpoint Address: 82
142 Max Packet Size: 1448
151 Max Packet Size: 3072
155 /* time to wait when stopping the isoc transfer */
156 #define EM28XX_URB_TIMEOUT msecs_to_jiffies(EM28XX_NUM_BUFS * EM28XX_NUM_PACKETS)
158 /* time in msecs to wait for i2c writes to finish */
159 #define EM2800_I2C_WRITE_TIMEOUT 20
162 EM28XX_MODE_UNDEFINED,
167 enum em28xx_stream_state {
175 struct em28xx_usb_isoc_ctl {
176 /* max packet size of isoc transaction */
179 /* number of allocated urbs */
182 /* urb for isoc transfers */
185 /* transfer buffers for isoc transfer */
186 char **transfer_buffer;
188 /* Last buffer command and region */
190 int pos, size, pktsize;
192 /* Last field: ODD or EVEN? */
195 /* Stores incomplete commands */
199 /* Stores already requested buffers */
200 struct em28xx_buffer *buf;
202 /* Stores the number of received fields */
205 /* isoc urb callback */
206 int (*isoc_copy) (struct em28xx *dev, struct urb *urb);
212 u32 fourcc; /* v4l2 format id */
215 /* buffer for one video frame */
216 struct em28xx_buffer {
217 /* common v4l buffer stuff -- must be first */
218 struct videobuf_buffer vb;
220 struct list_head frame;
225 struct em28xx_dmaqueue {
226 struct list_head active;
227 struct list_head queued;
229 wait_queue_head_t wq;
231 /* Counters to control buffer fill */
236 enum em28xx_io_method {
244 #define MAX_EM28XX_INPUT 4
245 enum enum28xx_itype {
246 EM28XX_VMUX_COMPOSITE1 = 1,
247 EM28XX_VMUX_COMPOSITE2,
248 EM28XX_VMUX_COMPOSITE3,
249 EM28XX_VMUX_COMPOSITE4,
251 EM28XX_VMUX_TELEVISION,
261 EM28XX_AMUX_AC97_VIDEO,
262 EM28XX_AMUX_AC97_LINE_IN,
265 struct em28xx_input {
266 enum enum28xx_itype type;
268 enum em28xx_amux amux;
271 #define INPUT(nr) (&em28xx_boards[dev->model].input[nr])
273 enum em28xx_decoder {
279 struct em28xx_reg_seq {
281 unsigned char val, mask;
285 struct em28xx_board {
291 unsigned int tda9887_conf;
293 unsigned int is_em2800:1;
294 unsigned int has_msp34xx:1;
295 unsigned int mts_firmware:1;
296 unsigned int has_12mhz_i2s:1;
297 unsigned int max_range_640_480:1;
298 unsigned int has_dvb:1;
299 unsigned int has_snapshot_button:1;
300 unsigned int valid:1;
302 enum em28xx_decoder decoder;
304 struct em28xx_input input[MAX_EM28XX_INPUT];
305 struct em28xx_input radio;
308 struct em28xx_eeprom {
309 u32 id; /* 0x9567eb1a */
317 u16 string1, string2, string3;
323 enum em28xx_dev_state {
324 DEV_INITIALIZED = 0x01,
325 DEV_DISCONNECTED = 0x02,
326 DEV_MISCONFIGURED = 0x04,
329 #define EM28XX_AUDIO_BUFS 5
330 #define EM28XX_NUM_AUDIO_PACKETS 64
331 #define EM28XX_AUDIO_MAX_PACKET_SIZE 196 /* static value */
332 #define EM28XX_CAPTURE_STREAM_EN 1
334 /* em28xx extensions */
335 #define EM28XX_AUDIO 0x10
336 #define EM28XX_DVB 0x20
338 struct em28xx_audio {
340 char *transfer_buffer[EM28XX_AUDIO_BUFS];
341 struct urb *urb[EM28XX_AUDIO_BUFS];
342 struct usb_device *udev;
343 unsigned int capture_transfer_done;
344 struct snd_pcm_substream *capture_pcm_substream;
346 unsigned int hwptr_done_capture;
347 struct snd_card *sndcard;
350 enum em28xx_stream_state capture_stream;
358 unsigned int stream_on:1; /* Locks streams */
361 struct videobuf_queue vb_vidq;
363 enum v4l2_buf_type type;
366 /* main device struct */
368 /* generic device properties */
369 char name[30]; /* name (including minor) of the device */
370 int model; /* index in the device_data struct */
371 int devno; /* marks the number of this device */
372 unsigned int is_em2800:1;
373 unsigned int has_msp34xx:1;
374 unsigned int has_tda9887:1;
375 unsigned int stream_on:1; /* Locks streams */
376 unsigned int has_audio_class:1;
377 unsigned int has_12mhz_i2s:1;
378 unsigned int max_range_640_480:1;
379 unsigned int has_dvb:1;
380 unsigned int has_snapshot_button:1;
381 unsigned int valid:1; /* report for validated boards */
383 /* Some older em28xx chips needs a waiting time after writing */
384 unsigned int wait_after_write;
386 /* GPIO sequences for analog and digital mode */
387 struct em28xx_reg_seq *analog_gpio, *digital_gpio;
389 /* GPIO sequences for tuner callbacks */
390 struct em28xx_reg_seq *tun_analog_gpio, *tun_digital_gpio;
392 int video_inputs; /* number of video inputs */
393 struct list_head devlist;
395 u32 i2s_speed; /* I2S speed for audio digital stream */
397 enum em28xx_decoder decoder;
399 int tuner_type; /* type of the tuner */
400 int tuner_addr; /* tuner address */
403 struct i2c_adapter i2c_adap;
404 struct i2c_client i2c_client;
405 /* video for linux */
406 int users; /* user count for exclusive use */
407 struct video_device *vdev; /* video for linux device struct */
408 v4l2_std_id norm; /* selected tv norm */
409 int ctl_freq; /* selected frequency */
410 unsigned int ctl_input; /* selected input */
411 unsigned int ctl_ainput;/* selected audio input */
414 /* frame properties */
415 int width; /* current frame width */
416 int height; /* current frame height */
417 unsigned hscale; /* horizontal scale factor (see datasheet) */
418 unsigned vscale; /* vertical scale factor (see datasheet) */
419 int interlaced; /* 1=interlace fileds, 0=just top fileds */
420 unsigned int video_bytesread; /* Number of bytes read */
422 unsigned long hash; /* eeprom hash - for boards with generic ID */
423 unsigned long i2c_hash; /* i2c devicelist hash -
424 for boards with generic ID */
426 struct em28xx_audio *adev;
429 enum em28xx_dev_state state;
430 enum em28xx_io_method io;
432 struct work_struct request_module_wk;
436 struct mutex ctrl_urb_lock; /* protects urb_buf */
437 /* spinlock_t queue_lock; */
438 struct list_head inqueue, outqueue;
439 wait_queue_head_t open, wait_frame, wait_stream;
440 struct video_device *vbi_dev;
441 struct video_device *radio_dev;
443 unsigned char eedata[256];
445 /* Isoc control struct */
446 struct em28xx_dmaqueue vidq;
447 struct em28xx_usb_isoc_ctl isoc_ctl;
451 struct usb_device *udev; /* the usb device */
452 int alt; /* alternate */
453 int max_pkt_size; /* max packet size of isoc transaction */
454 int num_alt; /* Number of alternative settings */
455 unsigned int *alt_max_pkt_size; /* array of wMaxPacketSize */
456 struct urb *urb[EM28XX_NUM_BUFS]; /* urb for isoc transfers */
457 char *transfer_buffer[EM28XX_NUM_BUFS]; /* transfer buffers for isoc transfer */
458 char urb_buf[URB_MAX_CTRL_SIZE]; /* urb control msg buffer */
460 /* helper funcs that call usb_control_msg */
461 int (*em28xx_write_regs) (struct em28xx *dev, u16 reg,
463 int (*em28xx_read_reg) (struct em28xx *dev, u16 reg);
464 int (*em28xx_read_reg_req_len) (struct em28xx *dev, u8 req, u16 reg,
466 int (*em28xx_write_regs_req) (struct em28xx *dev, u8 req, u16 reg,
468 int (*em28xx_read_reg_req) (struct em28xx *dev, u8 req, u16 reg);
470 enum em28xx_mode mode;
472 /* Caches GPO and GPIO registers */
473 unsigned char reg_gpo, reg_gpio;
475 /* Snapshot button */
476 char snapshot_button_path[30]; /* path of the input dev */
477 struct input_dev *sbutton_input_dev;
478 struct delayed_work sbutton_query_work;
480 struct em28xx_dvb *dvb;
484 struct list_head next;
487 int (*init)(struct em28xx *);
488 int (*fini)(struct em28xx *);
491 /* Provided by em28xx-i2c.c */
493 void em28xx_i2c_call_clients(struct em28xx *dev, unsigned int cmd, void *arg);
494 void em28xx_do_i2c_scan(struct em28xx *dev);
495 int em28xx_i2c_register(struct em28xx *dev);
496 int em28xx_i2c_unregister(struct em28xx *dev);
498 /* Provided by em28xx-core.c */
500 u32 em28xx_request_buffers(struct em28xx *dev, u32 count);
501 void em28xx_queue_unusedframes(struct em28xx *dev);
502 void em28xx_release_buffers(struct em28xx *dev);
504 int em28xx_read_reg_req_len(struct em28xx *dev, u8 req, u16 reg,
506 int em28xx_read_reg_req(struct em28xx *dev, u8 req, u16 reg);
507 int em28xx_read_reg(struct em28xx *dev, u16 reg);
508 int em28xx_write_regs_req(struct em28xx *dev, u8 req, u16 reg, char *buf,
510 int em28xx_write_regs(struct em28xx *dev, u16 reg, char *buf, int len);
511 int em28xx_audio_analog_set(struct em28xx *dev);
513 int em28xx_colorlevels_set_default(struct em28xx *dev);
514 int em28xx_capture_start(struct em28xx *dev, int start);
515 int em28xx_outfmt_set_yuv422(struct em28xx *dev);
516 int em28xx_resolution_set(struct em28xx *dev);
517 int em28xx_set_alternate(struct em28xx *dev);
518 int em28xx_init_isoc(struct em28xx *dev, int max_packets,
519 int num_bufs, int max_pkt_size,
520 int (*isoc_copy) (struct em28xx *dev, struct urb *urb));
521 void em28xx_uninit_isoc(struct em28xx *dev);
522 int em28xx_set_mode(struct em28xx *dev, enum em28xx_mode set_mode);
523 int em28xx_gpio_set(struct em28xx *dev, struct em28xx_reg_seq *gpio);
525 /* Provided by em28xx-video.c */
526 int em28xx_register_extension(struct em28xx_ops *dev);
527 void em28xx_unregister_extension(struct em28xx_ops *dev);
529 /* Provided by em28xx-cards.c */
530 extern int em2800_variant_detect(struct usb_device *udev, int model);
531 extern void em28xx_pre_card_setup(struct em28xx *dev);
532 extern void em28xx_card_setup(struct em28xx *dev);
533 extern struct em28xx_board em28xx_boards[];
534 extern struct usb_device_id em28xx_id_table[];
535 extern const unsigned int em28xx_bcount;
536 void em28xx_set_ir(struct em28xx *dev, struct IR_i2c *ir);
537 int em28xx_tuner_callback(void *ptr, int component, int command, int arg);
539 /* Provided by em28xx-input.c */
540 /* TODO: Check if the standard get_key handlers on ir-common can be used */
541 int em28xx_get_key_terratec(struct IR_i2c *ir, u32 *ir_key, u32 *ir_raw);
542 int em28xx_get_key_em_haup(struct IR_i2c *ir, u32 *ir_key, u32 *ir_raw);
543 int em28xx_get_key_pinnacle_usb_grey(struct IR_i2c *ir, u32 *ir_key,
545 void em28xx_register_snapshot_button(struct em28xx *dev);
546 void em28xx_deregister_snapshot_button(struct em28xx *dev);
550 #define em28xx_err(fmt, arg...) do {\
551 printk(KERN_ERR fmt , ##arg); } while (0)
553 #define em28xx_errdev(fmt, arg...) do {\
554 printk(KERN_ERR "%s: "fmt,\
555 dev->name , ##arg); } while (0)
557 #define em28xx_info(fmt, arg...) do {\
558 printk(KERN_INFO "%s: "fmt,\
559 dev->name , ##arg); } while (0)
560 #define em28xx_warn(fmt, arg...) do {\
561 printk(KERN_WARNING "%s: "fmt,\
562 dev->name , ##arg); } while (0)
564 static inline int em28xx_compression_disable(struct em28xx *dev)
566 /* side effect of disabling scaler and mixer */
567 return em28xx_write_regs(dev, EM28XX_R26_COMPR, "\x00", 1);
570 static inline int em28xx_contrast_get(struct em28xx *dev)
572 return em28xx_read_reg(dev, EM28XX_R20_YGAIN) & 0x1f;
575 static inline int em28xx_brightness_get(struct em28xx *dev)
577 return em28xx_read_reg(dev, EM28XX_R21_YOFFSET);
580 static inline int em28xx_saturation_get(struct em28xx *dev)
582 return em28xx_read_reg(dev, EM28XX_R22_UVGAIN) & 0x1f;
585 static inline int em28xx_u_balance_get(struct em28xx *dev)
587 return em28xx_read_reg(dev, EM28XX_R23_UOFFSET);
590 static inline int em28xx_v_balance_get(struct em28xx *dev)
592 return em28xx_read_reg(dev, EM28XX_R24_VOFFSET);
595 static inline int em28xx_gamma_get(struct em28xx *dev)
597 return em28xx_read_reg(dev, EM28XX_R14_GAMMA) & 0x3f;
600 static inline int em28xx_contrast_set(struct em28xx *dev, s32 val)
603 return em28xx_write_regs(dev, EM28XX_R20_YGAIN, &tmp, 1);
606 static inline int em28xx_brightness_set(struct em28xx *dev, s32 val)
609 return em28xx_write_regs(dev, EM28XX_R21_YOFFSET, &tmp, 1);
612 static inline int em28xx_saturation_set(struct em28xx *dev, s32 val)
615 return em28xx_write_regs(dev, EM28XX_R22_UVGAIN, &tmp, 1);
618 static inline int em28xx_u_balance_set(struct em28xx *dev, s32 val)
621 return em28xx_write_regs(dev, EM28XX_R23_UOFFSET, &tmp, 1);
624 static inline int em28xx_v_balance_set(struct em28xx *dev, s32 val)
627 return em28xx_write_regs(dev, EM28XX_R24_VOFFSET, &tmp, 1);
630 static inline int em28xx_gamma_set(struct em28xx *dev, s32 val)
633 return em28xx_write_regs(dev, EM28XX_R14_GAMMA, &tmp, 1);
636 /*FIXME: maxw should be dependent of alt mode */
637 static inline unsigned int norm_maxw(struct em28xx *dev)
639 if (dev->max_range_640_480)
645 static inline unsigned int norm_maxh(struct em28xx *dev)
647 if (dev->max_range_640_480)
650 return (dev->norm & V4L2_STD_625_50) ? 576 : 480;