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
100 #define EM2874_BOARD_PINNACLE_PCTV_80E 59
102 /* Limits minimum and default number of buffers */
103 #define EM28XX_MIN_BUF 4
104 #define EM28XX_DEF_BUF 8
106 /*Limits the max URB message size */
107 #define URB_MAX_CTRL_SIZE 80
109 /* Params for validated field */
110 #define EM28XX_BOARD_NOT_VALIDATED 1
111 #define EM28XX_BOARD_VALIDATED 0
113 /* maximum number of em28xx boards */
114 #define EM28XX_MAXBOARDS 4 /*FIXME: should be bigger */
116 /* maximum number of frames that can be queued */
117 #define EM28XX_NUM_FRAMES 5
118 /* number of frames that get used for v4l2_read() */
119 #define EM28XX_NUM_READ_FRAMES 2
121 /* number of buffers for isoc transfers */
122 #define EM28XX_NUM_BUFS 5
124 /* number of packets for each buffer
125 windows requests only 40 packets .. so we better do the same
126 this is what I found out for all alternate numbers there!
128 #define EM28XX_NUM_PACKETS 40
130 /* default alternate; 0 means choose the best */
131 #define EM28XX_PINOUT 0
133 #define EM28XX_INTERLACED_DEFAULT 1
136 #define (use usbview if you want to get the other alternate number infos)
138 #define alternate number 2
139 #define Endpoint Address: 82
143 Max Packet Size: 1448
152 Max Packet Size: 3072
156 /* time to wait when stopping the isoc transfer */
157 #define EM28XX_URB_TIMEOUT msecs_to_jiffies(EM28XX_NUM_BUFS * EM28XX_NUM_PACKETS)
159 /* time in msecs to wait for i2c writes to finish */
160 #define EM2800_I2C_WRITE_TIMEOUT 20
163 EM28XX_MODE_UNDEFINED,
168 enum em28xx_stream_state {
176 struct em28xx_usb_isoc_ctl {
177 /* max packet size of isoc transaction */
180 /* number of allocated urbs */
183 /* urb for isoc transfers */
186 /* transfer buffers for isoc transfer */
187 char **transfer_buffer;
189 /* Last buffer command and region */
191 int pos, size, pktsize;
193 /* Last field: ODD or EVEN? */
196 /* Stores incomplete commands */
200 /* Stores already requested buffers */
201 struct em28xx_buffer *buf;
203 /* Stores the number of received fields */
206 /* isoc urb callback */
207 int (*isoc_copy) (struct em28xx *dev, struct urb *urb);
213 u32 fourcc; /* v4l2 format id */
216 /* buffer for one video frame */
217 struct em28xx_buffer {
218 /* common v4l buffer stuff -- must be first */
219 struct videobuf_buffer vb;
221 struct list_head frame;
226 struct em28xx_dmaqueue {
227 struct list_head active;
228 struct list_head queued;
230 wait_queue_head_t wq;
232 /* Counters to control buffer fill */
237 enum em28xx_io_method {
245 #define MAX_EM28XX_INPUT 4
246 enum enum28xx_itype {
247 EM28XX_VMUX_COMPOSITE1 = 1,
248 EM28XX_VMUX_COMPOSITE2,
249 EM28XX_VMUX_COMPOSITE3,
250 EM28XX_VMUX_COMPOSITE4,
252 EM28XX_VMUX_TELEVISION,
259 enum em28xx_ac97_mode {
265 struct em28xx_audio_mode {
266 enum em28xx_ac97_mode ac97;
271 unsigned int has_audio:1;
273 unsigned int i2s_3rates:1;
274 unsigned int i2s_5rates:1;
277 /* em28xx has two audio inputs: tuner and line in.
278 However, on most devices, an auxiliary AC97 codec device is used.
279 The AC97 device may have several different inputs and outputs,
280 depending on their model. So, it is possible to use AC97 mixer to
281 address more than two different entries.
284 /* This is the only entry for em28xx tuner input */
285 EM28XX_AMUX_VIDEO, /* em28xx tuner, AC97 mixer Video */
287 EM28XX_AMUX_LINE_IN, /* AC97 mixer Line In */
289 /* Some less-common mixer setups */
290 EM28XX_AMUX_VIDEO2, /* em28xx Line in, AC97 mixer Video */
298 struct em28xx_input {
299 enum enum28xx_itype type;
301 enum em28xx_amux amux;
304 #define INPUT(nr) (&em28xx_boards[dev->model].input[nr])
306 enum em28xx_decoder {
313 struct em28xx_reg_seq {
315 unsigned char val, mask;
319 struct em28xx_board {
326 unsigned int tda9887_conf;
328 unsigned int is_em2800:1;
329 unsigned int has_msp34xx:1;
330 unsigned int mts_firmware:1;
331 unsigned int has_12mhz_i2s:1;
332 unsigned int max_range_640_480:1;
333 unsigned int has_dvb:1;
334 unsigned int has_snapshot_button:1;
335 unsigned int valid:1;
337 enum em28xx_decoder decoder;
339 struct em28xx_input input[MAX_EM28XX_INPUT];
340 struct em28xx_input radio;
341 IR_KEYTAB_TYPE *ir_codes;
344 struct em28xx_eeprom {
345 u32 id; /* 0x9567eb1a */
353 u16 string1, string2, string3;
359 enum em28xx_dev_state {
360 DEV_INITIALIZED = 0x01,
361 DEV_DISCONNECTED = 0x02,
362 DEV_MISCONFIGURED = 0x04,
365 #define EM28XX_AUDIO_BUFS 5
366 #define EM28XX_NUM_AUDIO_PACKETS 64
367 #define EM28XX_AUDIO_MAX_PACKET_SIZE 196 /* static value */
368 #define EM28XX_CAPTURE_STREAM_EN 1
370 /* em28xx extensions */
371 #define EM28XX_AUDIO 0x10
372 #define EM28XX_DVB 0x20
374 struct em28xx_audio {
376 char *transfer_buffer[EM28XX_AUDIO_BUFS];
377 struct urb *urb[EM28XX_AUDIO_BUFS];
378 struct usb_device *udev;
379 unsigned int capture_transfer_done;
380 struct snd_pcm_substream *capture_pcm_substream;
382 unsigned int hwptr_done_capture;
383 struct snd_card *sndcard;
386 enum em28xx_stream_state capture_stream;
394 unsigned int stream_on:1; /* Locks streams */
397 struct videobuf_queue vb_vidq;
399 enum v4l2_buf_type type;
402 /* main device struct */
404 /* generic device properties */
405 char name[30]; /* name (including minor) of the device */
406 int model; /* index in the device_data struct */
407 int devno; /* marks the number of this device */
408 enum em28xx_chip_id chip_id;
409 unsigned int is_em2800:1;
410 unsigned int has_msp34xx:1;
411 unsigned int has_tda9887:1;
412 unsigned int stream_on:1; /* Locks streams */
413 unsigned int has_audio_class:1;
414 unsigned int has_alsa_audio:1;
415 unsigned int has_12mhz_i2s:1;
416 unsigned int max_range_640_480:1;
417 unsigned int has_dvb:1;
418 unsigned int has_snapshot_button:1;
419 unsigned int valid:1; /* report for validated boards */
421 struct em28xx_IR *ir;
423 /* Some older em28xx chips needs a waiting time after writing */
424 unsigned int wait_after_write;
426 /* GPIO sequences for analog and digital mode */
427 struct em28xx_reg_seq *analog_gpio, *digital_gpio;
429 /* GPIO sequences for tuner callbacks */
430 struct em28xx_reg_seq *tun_analog_gpio, *tun_digital_gpio;
432 int video_inputs; /* number of video inputs */
433 struct list_head devlist;
435 u32 i2s_speed; /* I2S speed for audio digital stream */
437 enum em28xx_decoder decoder;
438 struct em28xx_audio_mode audio_mode;
440 int tuner_type; /* type of the tuner */
441 int tuner_addr; /* tuner address */
444 struct i2c_adapter i2c_adap;
445 struct i2c_client i2c_client;
446 /* video for linux */
447 int users; /* user count for exclusive use */
448 struct video_device *vdev; /* video for linux device struct */
449 v4l2_std_id norm; /* selected tv norm */
450 int ctl_freq; /* selected frequency */
451 unsigned int ctl_input; /* selected input */
452 unsigned int ctl_ainput;/* selected audio input */
455 /* frame properties */
456 int width; /* current frame width */
457 int height; /* current frame height */
458 unsigned hscale; /* horizontal scale factor (see datasheet) */
459 unsigned vscale; /* vertical scale factor (see datasheet) */
460 int interlaced; /* 1=interlace fileds, 0=just top fileds */
461 unsigned int video_bytesread; /* Number of bytes read */
463 unsigned long hash; /* eeprom hash - for boards with generic ID */
464 unsigned long i2c_hash; /* i2c devicelist hash -
465 for boards with generic ID */
467 struct em28xx_audio *adev;
470 enum em28xx_dev_state state;
471 enum em28xx_io_method io;
473 struct work_struct request_module_wk;
477 struct mutex ctrl_urb_lock; /* protects urb_buf */
478 /* spinlock_t queue_lock; */
479 struct list_head inqueue, outqueue;
480 wait_queue_head_t open, wait_frame, wait_stream;
481 struct video_device *vbi_dev;
482 struct video_device *radio_dev;
484 unsigned char eedata[256];
486 /* Isoc control struct */
487 struct em28xx_dmaqueue vidq;
488 struct em28xx_usb_isoc_ctl isoc_ctl;
492 struct usb_device *udev; /* the usb device */
493 int alt; /* alternate */
494 int max_pkt_size; /* max packet size of isoc transaction */
495 int num_alt; /* Number of alternative settings */
496 unsigned int *alt_max_pkt_size; /* array of wMaxPacketSize */
497 struct urb *urb[EM28XX_NUM_BUFS]; /* urb for isoc transfers */
498 char *transfer_buffer[EM28XX_NUM_BUFS]; /* transfer buffers for isoc transfer */
499 char urb_buf[URB_MAX_CTRL_SIZE]; /* urb control msg buffer */
501 /* helper funcs that call usb_control_msg */
502 int (*em28xx_write_regs) (struct em28xx *dev, u16 reg,
504 int (*em28xx_read_reg) (struct em28xx *dev, u16 reg);
505 int (*em28xx_read_reg_req_len) (struct em28xx *dev, u8 req, u16 reg,
507 int (*em28xx_write_regs_req) (struct em28xx *dev, u8 req, u16 reg,
509 int (*em28xx_read_reg_req) (struct em28xx *dev, u8 req, u16 reg);
511 enum em28xx_mode mode;
513 /* register numbers for GPO/GPIO registers */
514 u16 reg_gpo_num, reg_gpio_num;
516 /* Caches GPO and GPIO registers */
517 unsigned char reg_gpo, reg_gpio;
519 /* Infrared remote control support */
520 IR_KEYTAB_TYPE *ir_codes;
522 /* Snapshot button */
523 char snapshot_button_path[30]; /* path of the input dev */
524 struct input_dev *sbutton_input_dev;
525 struct delayed_work sbutton_query_work;
527 struct em28xx_dvb *dvb;
531 struct list_head next;
534 int (*init)(struct em28xx *);
535 int (*fini)(struct em28xx *);
538 /* Provided by em28xx-i2c.c */
540 void em28xx_i2c_call_clients(struct em28xx *dev, unsigned int cmd, void *arg);
541 void em28xx_do_i2c_scan(struct em28xx *dev);
542 int em28xx_i2c_register(struct em28xx *dev);
543 int em28xx_i2c_unregister(struct em28xx *dev);
545 /* Provided by em28xx-core.c */
547 u32 em28xx_request_buffers(struct em28xx *dev, u32 count);
548 void em28xx_queue_unusedframes(struct em28xx *dev);
549 void em28xx_release_buffers(struct em28xx *dev);
551 int em28xx_read_reg_req_len(struct em28xx *dev, u8 req, u16 reg,
553 int em28xx_read_reg_req(struct em28xx *dev, u8 req, u16 reg);
554 int em28xx_read_reg(struct em28xx *dev, u16 reg);
555 int em28xx_write_regs_req(struct em28xx *dev, u8 req, u16 reg, char *buf,
557 int em28xx_write_regs(struct em28xx *dev, u16 reg, char *buf, int len);
558 int em28xx_write_reg(struct em28xx *dev, u16 reg, u8 val);
560 int em28xx_audio_analog_set(struct em28xx *dev);
561 int em28xx_audio_setup(struct em28xx *dev);
563 int em28xx_colorlevels_set_default(struct em28xx *dev);
564 int em28xx_capture_start(struct em28xx *dev, int start);
565 int em28xx_outfmt_set_yuv422(struct em28xx *dev);
566 int em28xx_resolution_set(struct em28xx *dev);
567 int em28xx_set_alternate(struct em28xx *dev);
568 int em28xx_init_isoc(struct em28xx *dev, int max_packets,
569 int num_bufs, int max_pkt_size,
570 int (*isoc_copy) (struct em28xx *dev, struct urb *urb));
571 void em28xx_uninit_isoc(struct em28xx *dev);
572 int em28xx_set_mode(struct em28xx *dev, enum em28xx_mode set_mode);
573 int em28xx_gpio_set(struct em28xx *dev, struct em28xx_reg_seq *gpio);
575 /* Provided by em28xx-video.c */
576 int em28xx_register_extension(struct em28xx_ops *dev);
577 void em28xx_unregister_extension(struct em28xx_ops *dev);
579 /* Provided by em28xx-cards.c */
580 extern int em2800_variant_detect(struct usb_device *udev, int model);
581 extern void em28xx_pre_card_setup(struct em28xx *dev);
582 extern void em28xx_card_setup(struct em28xx *dev);
583 extern struct em28xx_board em28xx_boards[];
584 extern struct usb_device_id em28xx_id_table[];
585 extern const unsigned int em28xx_bcount;
586 void em28xx_set_ir(struct em28xx *dev, struct IR_i2c *ir);
587 int em28xx_tuner_callback(void *ptr, int component, int command, int arg);
589 /* Provided by em28xx-input.c */
590 int em28xx_get_key_terratec(struct IR_i2c *ir, u32 *ir_key, u32 *ir_raw);
591 int em28xx_get_key_em_haup(struct IR_i2c *ir, u32 *ir_key, u32 *ir_raw);
592 int em28xx_get_key_pinnacle_usb_grey(struct IR_i2c *ir, u32 *ir_key,
594 void em28xx_register_snapshot_button(struct em28xx *dev);
595 void em28xx_deregister_snapshot_button(struct em28xx *dev);
597 int em28xx_ir_init(struct em28xx *dev);
598 int em28xx_ir_fini(struct em28xx *dev);
602 #define em28xx_err(fmt, arg...) do {\
603 printk(KERN_ERR fmt , ##arg); } while (0)
605 #define em28xx_errdev(fmt, arg...) do {\
606 printk(KERN_ERR "%s: "fmt,\
607 dev->name , ##arg); } while (0)
609 #define em28xx_info(fmt, arg...) do {\
610 printk(KERN_INFO "%s: "fmt,\
611 dev->name , ##arg); } while (0)
612 #define em28xx_warn(fmt, arg...) do {\
613 printk(KERN_WARNING "%s: "fmt,\
614 dev->name , ##arg); } while (0)
616 static inline int em28xx_compression_disable(struct em28xx *dev)
618 /* side effect of disabling scaler and mixer */
619 return em28xx_write_regs(dev, EM28XX_R26_COMPR, "\x00", 1);
622 static inline int em28xx_contrast_get(struct em28xx *dev)
624 return em28xx_read_reg(dev, EM28XX_R20_YGAIN) & 0x1f;
627 static inline int em28xx_brightness_get(struct em28xx *dev)
629 return em28xx_read_reg(dev, EM28XX_R21_YOFFSET);
632 static inline int em28xx_saturation_get(struct em28xx *dev)
634 return em28xx_read_reg(dev, EM28XX_R22_UVGAIN) & 0x1f;
637 static inline int em28xx_u_balance_get(struct em28xx *dev)
639 return em28xx_read_reg(dev, EM28XX_R23_UOFFSET);
642 static inline int em28xx_v_balance_get(struct em28xx *dev)
644 return em28xx_read_reg(dev, EM28XX_R24_VOFFSET);
647 static inline int em28xx_gamma_get(struct em28xx *dev)
649 return em28xx_read_reg(dev, EM28XX_R14_GAMMA) & 0x3f;
652 static inline int em28xx_contrast_set(struct em28xx *dev, s32 val)
655 return em28xx_write_regs(dev, EM28XX_R20_YGAIN, &tmp, 1);
658 static inline int em28xx_brightness_set(struct em28xx *dev, s32 val)
661 return em28xx_write_regs(dev, EM28XX_R21_YOFFSET, &tmp, 1);
664 static inline int em28xx_saturation_set(struct em28xx *dev, s32 val)
667 return em28xx_write_regs(dev, EM28XX_R22_UVGAIN, &tmp, 1);
670 static inline int em28xx_u_balance_set(struct em28xx *dev, s32 val)
673 return em28xx_write_regs(dev, EM28XX_R23_UOFFSET, &tmp, 1);
676 static inline int em28xx_v_balance_set(struct em28xx *dev, s32 val)
679 return em28xx_write_regs(dev, EM28XX_R24_VOFFSET, &tmp, 1);
682 static inline int em28xx_gamma_set(struct em28xx *dev, s32 val)
685 return em28xx_write_regs(dev, EM28XX_R14_GAMMA, &tmp, 1);
688 /*FIXME: maxw should be dependent of alt mode */
689 static inline unsigned int norm_maxw(struct em28xx *dev)
691 if (dev->max_range_640_480)
697 static inline unsigned int norm_maxh(struct em28xx *dev)
699 if (dev->max_range_640_480)
702 return (dev->norm & V4L2_STD_625_50) ? 576 : 480;