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
101 #define EM2883_BOARD_HAUPPAUGE_WINTV_HVR_850 60
102 #define EM2820_BOARD_PROLINK_PLAYTV_BOX4_USB2 61
104 /* Limits minimum and default number of buffers */
105 #define EM28XX_MIN_BUF 4
106 #define EM28XX_DEF_BUF 8
108 /*Limits the max URB message size */
109 #define URB_MAX_CTRL_SIZE 80
111 /* Params for validated field */
112 #define EM28XX_BOARD_NOT_VALIDATED 1
113 #define EM28XX_BOARD_VALIDATED 0
115 /* maximum number of em28xx boards */
116 #define EM28XX_MAXBOARDS 4 /*FIXME: should be bigger */
118 /* maximum number of frames that can be queued */
119 #define EM28XX_NUM_FRAMES 5
120 /* number of frames that get used for v4l2_read() */
121 #define EM28XX_NUM_READ_FRAMES 2
123 /* number of buffers for isoc transfers */
124 #define EM28XX_NUM_BUFS 5
126 /* number of packets for each buffer
127 windows requests only 40 packets .. so we better do the same
128 this is what I found out for all alternate numbers there!
130 #define EM28XX_NUM_PACKETS 40
132 /* default alternate; 0 means choose the best */
133 #define EM28XX_PINOUT 0
135 #define EM28XX_INTERLACED_DEFAULT 1
138 #define (use usbview if you want to get the other alternate number infos)
140 #define alternate number 2
141 #define Endpoint Address: 82
145 Max Packet Size: 1448
154 Max Packet Size: 3072
158 /* time to wait when stopping the isoc transfer */
159 #define EM28XX_URB_TIMEOUT msecs_to_jiffies(EM28XX_NUM_BUFS * EM28XX_NUM_PACKETS)
161 /* time in msecs to wait for i2c writes to finish */
162 #define EM2800_I2C_WRITE_TIMEOUT 20
170 enum em28xx_stream_state {
178 struct em28xx_usb_isoc_ctl {
179 /* max packet size of isoc transaction */
182 /* number of allocated urbs */
185 /* urb for isoc transfers */
188 /* transfer buffers for isoc transfer */
189 char **transfer_buffer;
191 /* Last buffer command and region */
193 int pos, size, pktsize;
195 /* Last field: ODD or EVEN? */
198 /* Stores incomplete commands */
202 /* Stores already requested buffers */
203 struct em28xx_buffer *buf;
205 /* Stores the number of received fields */
208 /* isoc urb callback */
209 int (*isoc_copy) (struct em28xx *dev, struct urb *urb);
213 /* Struct to enumberate video formats */
216 u32 fourcc; /* v4l2 format id */
221 /* buffer for one video frame */
222 struct em28xx_buffer {
223 /* common v4l buffer stuff -- must be first */
224 struct videobuf_buffer vb;
226 struct list_head frame;
231 struct em28xx_dmaqueue {
232 struct list_head active;
233 struct list_head queued;
235 wait_queue_head_t wq;
237 /* Counters to control buffer fill */
242 enum em28xx_io_method {
250 #define MAX_EM28XX_INPUT 4
251 enum enum28xx_itype {
252 EM28XX_VMUX_COMPOSITE1 = 1,
253 EM28XX_VMUX_COMPOSITE2,
254 EM28XX_VMUX_COMPOSITE3,
255 EM28XX_VMUX_COMPOSITE4,
257 EM28XX_VMUX_TELEVISION,
264 enum em28xx_ac97_mode {
267 EM28XX_AC97_SIGMATEL,
271 struct em28xx_audio_mode {
272 enum em28xx_ac97_mode ac97;
277 unsigned int has_audio:1;
279 unsigned int i2s_3rates:1;
280 unsigned int i2s_5rates:1;
283 /* em28xx has two audio inputs: tuner and line in.
284 However, on most devices, an auxiliary AC97 codec device is used.
285 The AC97 device may have several different inputs and outputs,
286 depending on their model. So, it is possible to use AC97 mixer to
287 address more than two different entries.
290 /* This is the only entry for em28xx tuner input */
291 EM28XX_AMUX_VIDEO, /* em28xx tuner, AC97 mixer Video */
293 EM28XX_AMUX_LINE_IN, /* AC97 mixer Line In */
295 /* Some less-common mixer setups */
296 EM28XX_AMUX_VIDEO2, /* em28xx Line in, AC97 mixer Video */
305 EM28XX_AOUT_MASTER = 1 << 0,
306 EM28XX_AOUT_LINE = 1 << 1,
307 EM28XX_AOUT_MONO = 1 << 2,
308 EM28XX_AOUT_LFE = 1 << 3,
309 EM28XX_AOUT_SURR = 1 << 4,
312 struct em28xx_reg_seq {
314 unsigned char val, mask;
318 struct em28xx_input {
319 enum enum28xx_itype type;
321 enum em28xx_amux amux;
322 enum em28xx_aout aout;
323 struct em28xx_reg_seq *gpio;
326 #define INPUT(nr) (&em28xx_boards[dev->model].input[nr])
328 enum em28xx_decoder {
334 struct em28xx_board {
341 unsigned int tda9887_conf;
344 struct em28xx_reg_seq *dvb_gpio;
345 struct em28xx_reg_seq *suspend_gpio;
346 struct em28xx_reg_seq *tuner_gpio;
348 unsigned int is_em2800:1;
349 unsigned int has_msp34xx:1;
350 unsigned int mts_firmware:1;
351 unsigned int max_range_640_480:1;
352 unsigned int has_dvb:1;
353 unsigned int has_snapshot_button:1;
354 unsigned int valid:1;
356 unsigned char xclk, i2c_speed;
358 enum em28xx_decoder decoder;
360 struct em28xx_input input[MAX_EM28XX_INPUT];
361 struct em28xx_input radio;
362 IR_KEYTAB_TYPE *ir_codes;
365 struct em28xx_eeprom {
366 u32 id; /* 0x9567eb1a */
374 u16 string1, string2, string3;
380 enum em28xx_dev_state {
381 DEV_INITIALIZED = 0x01,
382 DEV_DISCONNECTED = 0x02,
383 DEV_MISCONFIGURED = 0x04,
386 #define EM28XX_AUDIO_BUFS 5
387 #define EM28XX_NUM_AUDIO_PACKETS 64
388 #define EM28XX_AUDIO_MAX_PACKET_SIZE 196 /* static value */
389 #define EM28XX_CAPTURE_STREAM_EN 1
391 /* em28xx extensions */
392 #define EM28XX_AUDIO 0x10
393 #define EM28XX_DVB 0x20
395 struct em28xx_audio {
397 char *transfer_buffer[EM28XX_AUDIO_BUFS];
398 struct urb *urb[EM28XX_AUDIO_BUFS];
399 struct usb_device *udev;
400 unsigned int capture_transfer_done;
401 struct snd_pcm_substream *capture_pcm_substream;
403 unsigned int hwptr_done_capture;
404 struct snd_card *sndcard;
407 enum em28xx_stream_state capture_stream;
415 unsigned int stream_on:1; /* Locks streams */
418 struct videobuf_queue vb_vidq;
420 enum v4l2_buf_type type;
423 /* main device struct */
425 /* generic device properties */
426 char name[30]; /* name (including minor) of the device */
427 int model; /* index in the device_data struct */
428 int devno; /* marks the number of this device */
429 enum em28xx_chip_id chip_id;
431 struct em28xx_board board;
433 unsigned int stream_on:1; /* Locks streams */
434 unsigned int has_audio_class:1;
435 unsigned int has_alsa_audio:1;
437 struct em28xx_fmt *format;
439 struct em28xx_IR *ir;
441 /* Some older em28xx chips needs a waiting time after writing */
442 unsigned int wait_after_write;
444 struct list_head devlist;
446 u32 i2s_speed; /* I2S speed for audio digital stream */
448 struct em28xx_audio_mode audio_mode;
450 int tuner_type; /* type of the tuner */
451 int tuner_addr; /* tuner address */
454 struct i2c_adapter i2c_adap;
455 struct i2c_client i2c_client;
456 /* video for linux */
457 int users; /* user count for exclusive use */
458 struct video_device *vdev; /* video for linux device struct */
459 v4l2_std_id norm; /* selected tv norm */
460 int ctl_freq; /* selected frequency */
461 unsigned int ctl_input; /* selected input */
462 unsigned int ctl_ainput;/* selected audio input */
463 unsigned int ctl_aoutput;/* selected audio output */
466 /* frame properties */
467 int width; /* current frame width */
468 int height; /* current frame height */
469 unsigned hscale; /* horizontal scale factor (see datasheet) */
470 unsigned vscale; /* vertical scale factor (see datasheet) */
471 int interlaced; /* 1=interlace fileds, 0=just top fileds */
472 unsigned int video_bytesread; /* Number of bytes read */
474 unsigned long hash; /* eeprom hash - for boards with generic ID */
475 unsigned long i2c_hash; /* i2c devicelist hash -
476 for boards with generic ID */
478 struct em28xx_audio *adev;
481 enum em28xx_dev_state state;
482 enum em28xx_io_method io;
484 struct work_struct request_module_wk;
488 struct mutex ctrl_urb_lock; /* protects urb_buf */
489 /* spinlock_t queue_lock; */
490 struct list_head inqueue, outqueue;
491 wait_queue_head_t open, wait_frame, wait_stream;
492 struct video_device *vbi_dev;
493 struct video_device *radio_dev;
495 unsigned char eedata[256];
497 /* Isoc control struct */
498 struct em28xx_dmaqueue vidq;
499 struct em28xx_usb_isoc_ctl isoc_ctl;
503 struct usb_device *udev; /* the usb device */
504 int alt; /* alternate */
505 int max_pkt_size; /* max packet size of isoc transaction */
506 int num_alt; /* Number of alternative settings */
507 unsigned int *alt_max_pkt_size; /* array of wMaxPacketSize */
508 struct urb *urb[EM28XX_NUM_BUFS]; /* urb for isoc transfers */
509 char *transfer_buffer[EM28XX_NUM_BUFS]; /* transfer buffers for isoc transfer */
510 char urb_buf[URB_MAX_CTRL_SIZE]; /* urb control msg buffer */
512 /* helper funcs that call usb_control_msg */
513 int (*em28xx_write_regs) (struct em28xx *dev, u16 reg,
515 int (*em28xx_read_reg) (struct em28xx *dev, u16 reg);
516 int (*em28xx_read_reg_req_len) (struct em28xx *dev, u8 req, u16 reg,
518 int (*em28xx_write_regs_req) (struct em28xx *dev, u8 req, u16 reg,
520 int (*em28xx_read_reg_req) (struct em28xx *dev, u8 req, u16 reg);
522 enum em28xx_mode mode;
524 /* register numbers for GPO/GPIO registers */
525 u16 reg_gpo_num, reg_gpio_num;
527 /* Caches GPO and GPIO registers */
528 unsigned char reg_gpo, reg_gpio;
530 /* Snapshot button */
531 char snapshot_button_path[30]; /* path of the input dev */
532 struct input_dev *sbutton_input_dev;
533 struct delayed_work sbutton_query_work;
535 struct em28xx_dvb *dvb;
539 struct list_head next;
542 int (*init)(struct em28xx *);
543 int (*fini)(struct em28xx *);
546 /* Provided by em28xx-i2c.c */
548 void em28xx_i2c_call_clients(struct em28xx *dev, unsigned int cmd, void *arg);
549 void em28xx_do_i2c_scan(struct em28xx *dev);
550 int em28xx_i2c_register(struct em28xx *dev);
551 int em28xx_i2c_unregister(struct em28xx *dev);
553 /* Provided by em28xx-core.c */
555 u32 em28xx_request_buffers(struct em28xx *dev, u32 count);
556 void em28xx_queue_unusedframes(struct em28xx *dev);
557 void em28xx_release_buffers(struct em28xx *dev);
559 int em28xx_read_reg_req_len(struct em28xx *dev, u8 req, u16 reg,
561 int em28xx_read_reg_req(struct em28xx *dev, u8 req, u16 reg);
562 int em28xx_read_reg(struct em28xx *dev, u16 reg);
563 int em28xx_write_regs_req(struct em28xx *dev, u8 req, u16 reg, char *buf,
565 int em28xx_write_regs(struct em28xx *dev, u16 reg, char *buf, int len);
566 int em28xx_write_reg(struct em28xx *dev, u16 reg, u8 val);
568 int em28xx_read_ac97(struct em28xx *dev, u8 reg);
569 int em28xx_write_ac97(struct em28xx *dev, u8 reg, u16 val);
571 int em28xx_audio_analog_set(struct em28xx *dev);
572 int em28xx_audio_setup(struct em28xx *dev);
574 int em28xx_colorlevels_set_default(struct em28xx *dev);
575 int em28xx_capture_start(struct em28xx *dev, int start);
576 int em28xx_set_outfmt(struct em28xx *dev);
577 int em28xx_resolution_set(struct em28xx *dev);
578 int em28xx_set_alternate(struct em28xx *dev);
579 int em28xx_init_isoc(struct em28xx *dev, int max_packets,
580 int num_bufs, int max_pkt_size,
581 int (*isoc_copy) (struct em28xx *dev, struct urb *urb));
582 void em28xx_uninit_isoc(struct em28xx *dev);
583 int em28xx_set_mode(struct em28xx *dev, enum em28xx_mode set_mode);
584 int em28xx_gpio_set(struct em28xx *dev, struct em28xx_reg_seq *gpio);
585 void em28xx_wake_i2c(struct em28xx *dev);
586 void em28xx_remove_from_devlist(struct em28xx *dev);
587 void em28xx_add_into_devlist(struct em28xx *dev);
588 struct em28xx *em28xx_get_device(struct inode *inode,
589 enum v4l2_buf_type *fh_type,
591 int em28xx_register_extension(struct em28xx_ops *dev);
592 void em28xx_unregister_extension(struct em28xx_ops *dev);
593 void em28xx_init_extension(struct em28xx *dev);
594 void em28xx_close_extension(struct em28xx *dev);
596 /* Provided by em28xx-video.c */
597 int em28xx_register_analog_devices(struct em28xx *dev);
598 void em28xx_release_analog_resources(struct em28xx *dev);
600 /* Provided by em28xx-cards.c */
601 extern int em2800_variant_detect(struct usb_device *udev, int model);
602 extern void em28xx_pre_card_setup(struct em28xx *dev);
603 extern void em28xx_card_setup(struct em28xx *dev);
604 extern struct em28xx_board em28xx_boards[];
605 extern struct usb_device_id em28xx_id_table[];
606 extern const unsigned int em28xx_bcount;
607 void em28xx_set_ir(struct em28xx *dev, struct IR_i2c *ir);
608 int em28xx_tuner_callback(void *ptr, int component, int command, int arg);
609 void em28xx_release_resources(struct em28xx *dev);
611 /* Provided by em28xx-input.c */
612 int em28xx_get_key_terratec(struct IR_i2c *ir, u32 *ir_key, u32 *ir_raw);
613 int em28xx_get_key_em_haup(struct IR_i2c *ir, u32 *ir_key, u32 *ir_raw);
614 int em28xx_get_key_pinnacle_usb_grey(struct IR_i2c *ir, u32 *ir_key,
616 void em28xx_register_snapshot_button(struct em28xx *dev);
617 void em28xx_deregister_snapshot_button(struct em28xx *dev);
619 int em28xx_ir_init(struct em28xx *dev);
620 int em28xx_ir_fini(struct em28xx *dev);
624 #define em28xx_err(fmt, arg...) do {\
625 printk(KERN_ERR fmt , ##arg); } while (0)
627 #define em28xx_errdev(fmt, arg...) do {\
628 printk(KERN_ERR "%s: "fmt,\
629 dev->name , ##arg); } while (0)
631 #define em28xx_info(fmt, arg...) do {\
632 printk(KERN_INFO "%s: "fmt,\
633 dev->name , ##arg); } while (0)
634 #define em28xx_warn(fmt, arg...) do {\
635 printk(KERN_WARNING "%s: "fmt,\
636 dev->name , ##arg); } while (0)
638 static inline int em28xx_compression_disable(struct em28xx *dev)
640 /* side effect of disabling scaler and mixer */
641 return em28xx_write_reg(dev, EM28XX_R26_COMPR, 0x00);
644 static inline int em28xx_contrast_get(struct em28xx *dev)
646 return em28xx_read_reg(dev, EM28XX_R20_YGAIN) & 0x1f;
649 static inline int em28xx_brightness_get(struct em28xx *dev)
651 return em28xx_read_reg(dev, EM28XX_R21_YOFFSET);
654 static inline int em28xx_saturation_get(struct em28xx *dev)
656 return em28xx_read_reg(dev, EM28XX_R22_UVGAIN) & 0x1f;
659 static inline int em28xx_u_balance_get(struct em28xx *dev)
661 return em28xx_read_reg(dev, EM28XX_R23_UOFFSET);
664 static inline int em28xx_v_balance_get(struct em28xx *dev)
666 return em28xx_read_reg(dev, EM28XX_R24_VOFFSET);
669 static inline int em28xx_gamma_get(struct em28xx *dev)
671 return em28xx_read_reg(dev, EM28XX_R14_GAMMA) & 0x3f;
674 static inline int em28xx_contrast_set(struct em28xx *dev, s32 val)
677 return em28xx_write_regs(dev, EM28XX_R20_YGAIN, &tmp, 1);
680 static inline int em28xx_brightness_set(struct em28xx *dev, s32 val)
683 return em28xx_write_regs(dev, EM28XX_R21_YOFFSET, &tmp, 1);
686 static inline int em28xx_saturation_set(struct em28xx *dev, s32 val)
689 return em28xx_write_regs(dev, EM28XX_R22_UVGAIN, &tmp, 1);
692 static inline int em28xx_u_balance_set(struct em28xx *dev, s32 val)
695 return em28xx_write_regs(dev, EM28XX_R23_UOFFSET, &tmp, 1);
698 static inline int em28xx_v_balance_set(struct em28xx *dev, s32 val)
701 return em28xx_write_regs(dev, EM28XX_R24_VOFFSET, &tmp, 1);
704 static inline int em28xx_gamma_set(struct em28xx *dev, s32 val)
707 return em28xx_write_regs(dev, EM28XX_R14_GAMMA, &tmp, 1);
710 /*FIXME: maxw should be dependent of alt mode */
711 static inline unsigned int norm_maxw(struct em28xx *dev)
713 if (dev->board.max_range_640_480)
719 static inline unsigned int norm_maxh(struct em28xx *dev)
721 if (dev->board.max_range_640_480)
724 return (dev->norm & V4L2_STD_625_50) ? 576 : 480;