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_audio_mode {
261 EM28XX_I2S_3_SAMPLE_RATES,
262 EM28XX_I2S_5_SAMPLE_RATES,
269 EM28XX_AMUX_AC97_VIDEO,
270 EM28XX_AMUX_AC97_LINE_IN,
273 struct em28xx_input {
274 enum enum28xx_itype type;
276 enum em28xx_amux amux;
279 #define INPUT(nr) (&em28xx_boards[dev->model].input[nr])
281 enum em28xx_decoder {
288 struct em28xx_reg_seq {
290 unsigned char val, mask;
294 struct em28xx_board {
301 unsigned int tda9887_conf;
303 unsigned int is_em2800:1;
304 unsigned int has_msp34xx:1;
305 unsigned int mts_firmware:1;
306 unsigned int has_12mhz_i2s:1;
307 unsigned int max_range_640_480:1;
308 unsigned int has_dvb:1;
309 unsigned int has_snapshot_button:1;
310 unsigned int valid:1;
312 enum em28xx_decoder decoder;
314 struct em28xx_input input[MAX_EM28XX_INPUT];
315 struct em28xx_input radio;
316 IR_KEYTAB_TYPE *ir_codes;
319 struct em28xx_eeprom {
320 u32 id; /* 0x9567eb1a */
328 u16 string1, string2, string3;
334 enum em28xx_dev_state {
335 DEV_INITIALIZED = 0x01,
336 DEV_DISCONNECTED = 0x02,
337 DEV_MISCONFIGURED = 0x04,
340 #define EM28XX_AUDIO_BUFS 5
341 #define EM28XX_NUM_AUDIO_PACKETS 64
342 #define EM28XX_AUDIO_MAX_PACKET_SIZE 196 /* static value */
343 #define EM28XX_CAPTURE_STREAM_EN 1
345 /* em28xx extensions */
346 #define EM28XX_AUDIO 0x10
347 #define EM28XX_DVB 0x20
349 struct em28xx_audio {
351 char *transfer_buffer[EM28XX_AUDIO_BUFS];
352 struct urb *urb[EM28XX_AUDIO_BUFS];
353 struct usb_device *udev;
354 unsigned int capture_transfer_done;
355 struct snd_pcm_substream *capture_pcm_substream;
357 unsigned int hwptr_done_capture;
358 struct snd_card *sndcard;
361 enum em28xx_stream_state capture_stream;
369 unsigned int stream_on:1; /* Locks streams */
372 struct videobuf_queue vb_vidq;
374 enum v4l2_buf_type type;
377 /* main device struct */
379 /* generic device properties */
380 char name[30]; /* name (including minor) of the device */
381 int model; /* index in the device_data struct */
382 int devno; /* marks the number of this device */
383 enum em28xx_chip_id chip_id;
384 unsigned int is_em2800:1;
385 unsigned int has_msp34xx:1;
386 unsigned int has_tda9887:1;
387 unsigned int stream_on:1; /* Locks streams */
388 unsigned int has_audio_class:1;
389 unsigned int has_alsa_audio:1;
390 unsigned int has_12mhz_i2s:1;
391 unsigned int max_range_640_480:1;
392 unsigned int has_dvb:1;
393 unsigned int has_snapshot_button:1;
394 unsigned int valid:1; /* report for validated boards */
396 struct em28xx_IR *ir;
398 /* Some older em28xx chips needs a waiting time after writing */
399 unsigned int wait_after_write;
401 /* GPIO sequences for analog and digital mode */
402 struct em28xx_reg_seq *analog_gpio, *digital_gpio;
404 /* GPIO sequences for tuner callbacks */
405 struct em28xx_reg_seq *tun_analog_gpio, *tun_digital_gpio;
407 int video_inputs; /* number of video inputs */
408 struct list_head devlist;
410 u32 i2s_speed; /* I2S speed for audio digital stream */
412 enum em28xx_decoder decoder;
413 enum em28xx_audio_mode audio_mode;
415 int tuner_type; /* type of the tuner */
416 int tuner_addr; /* tuner address */
419 struct i2c_adapter i2c_adap;
420 struct i2c_client i2c_client;
421 /* video for linux */
422 int users; /* user count for exclusive use */
423 struct video_device *vdev; /* video for linux device struct */
424 v4l2_std_id norm; /* selected tv norm */
425 int ctl_freq; /* selected frequency */
426 unsigned int ctl_input; /* selected input */
427 unsigned int ctl_ainput;/* selected audio input */
430 /* frame properties */
431 int width; /* current frame width */
432 int height; /* current frame height */
433 unsigned hscale; /* horizontal scale factor (see datasheet) */
434 unsigned vscale; /* vertical scale factor (see datasheet) */
435 int interlaced; /* 1=interlace fileds, 0=just top fileds */
436 unsigned int video_bytesread; /* Number of bytes read */
438 unsigned long hash; /* eeprom hash - for boards with generic ID */
439 unsigned long i2c_hash; /* i2c devicelist hash -
440 for boards with generic ID */
442 struct em28xx_audio *adev;
445 enum em28xx_dev_state state;
446 enum em28xx_io_method io;
448 struct work_struct request_module_wk;
452 struct mutex ctrl_urb_lock; /* protects urb_buf */
453 /* spinlock_t queue_lock; */
454 struct list_head inqueue, outqueue;
455 wait_queue_head_t open, wait_frame, wait_stream;
456 struct video_device *vbi_dev;
457 struct video_device *radio_dev;
459 unsigned char eedata[256];
461 /* Isoc control struct */
462 struct em28xx_dmaqueue vidq;
463 struct em28xx_usb_isoc_ctl isoc_ctl;
467 struct usb_device *udev; /* the usb device */
468 int alt; /* alternate */
469 int max_pkt_size; /* max packet size of isoc transaction */
470 int num_alt; /* Number of alternative settings */
471 unsigned int *alt_max_pkt_size; /* array of wMaxPacketSize */
472 struct urb *urb[EM28XX_NUM_BUFS]; /* urb for isoc transfers */
473 char *transfer_buffer[EM28XX_NUM_BUFS]; /* transfer buffers for isoc transfer */
474 char urb_buf[URB_MAX_CTRL_SIZE]; /* urb control msg buffer */
476 /* helper funcs that call usb_control_msg */
477 int (*em28xx_write_regs) (struct em28xx *dev, u16 reg,
479 int (*em28xx_read_reg) (struct em28xx *dev, u16 reg);
480 int (*em28xx_read_reg_req_len) (struct em28xx *dev, u8 req, u16 reg,
482 int (*em28xx_write_regs_req) (struct em28xx *dev, u8 req, u16 reg,
484 int (*em28xx_read_reg_req) (struct em28xx *dev, u8 req, u16 reg);
486 enum em28xx_mode mode;
488 /* register numbers for GPO/GPIO registers */
489 u16 reg_gpo_num, reg_gpio_num;
491 /* Caches GPO and GPIO registers */
492 unsigned char reg_gpo, reg_gpio;
494 /* Infrared remote control support */
495 IR_KEYTAB_TYPE *ir_codes;
497 /* Snapshot button */
498 char snapshot_button_path[30]; /* path of the input dev */
499 struct input_dev *sbutton_input_dev;
500 struct delayed_work sbutton_query_work;
502 struct em28xx_dvb *dvb;
506 struct list_head next;
509 int (*init)(struct em28xx *);
510 int (*fini)(struct em28xx *);
513 /* Provided by em28xx-i2c.c */
515 void em28xx_i2c_call_clients(struct em28xx *dev, unsigned int cmd, void *arg);
516 void em28xx_do_i2c_scan(struct em28xx *dev);
517 int em28xx_i2c_register(struct em28xx *dev);
518 int em28xx_i2c_unregister(struct em28xx *dev);
520 /* Provided by em28xx-core.c */
522 u32 em28xx_request_buffers(struct em28xx *dev, u32 count);
523 void em28xx_queue_unusedframes(struct em28xx *dev);
524 void em28xx_release_buffers(struct em28xx *dev);
526 int em28xx_read_reg_req_len(struct em28xx *dev, u8 req, u16 reg,
528 int em28xx_read_reg_req(struct em28xx *dev, u8 req, u16 reg);
529 int em28xx_read_reg(struct em28xx *dev, u16 reg);
530 int em28xx_write_regs_req(struct em28xx *dev, u8 req, u16 reg, char *buf,
532 int em28xx_write_regs(struct em28xx *dev, u16 reg, char *buf, int len);
533 int em28xx_audio_analog_set(struct em28xx *dev);
535 int em28xx_colorlevels_set_default(struct em28xx *dev);
536 int em28xx_capture_start(struct em28xx *dev, int start);
537 int em28xx_outfmt_set_yuv422(struct em28xx *dev);
538 int em28xx_resolution_set(struct em28xx *dev);
539 int em28xx_set_alternate(struct em28xx *dev);
540 int em28xx_init_isoc(struct em28xx *dev, int max_packets,
541 int num_bufs, int max_pkt_size,
542 int (*isoc_copy) (struct em28xx *dev, struct urb *urb));
543 void em28xx_uninit_isoc(struct em28xx *dev);
544 int em28xx_set_mode(struct em28xx *dev, enum em28xx_mode set_mode);
545 int em28xx_gpio_set(struct em28xx *dev, struct em28xx_reg_seq *gpio);
547 /* Provided by em28xx-video.c */
548 int em28xx_register_extension(struct em28xx_ops *dev);
549 void em28xx_unregister_extension(struct em28xx_ops *dev);
551 /* Provided by em28xx-cards.c */
552 extern int em2800_variant_detect(struct usb_device *udev, int model);
553 extern void em28xx_pre_card_setup(struct em28xx *dev);
554 extern void em28xx_card_setup(struct em28xx *dev);
555 extern struct em28xx_board em28xx_boards[];
556 extern struct usb_device_id em28xx_id_table[];
557 extern const unsigned int em28xx_bcount;
558 void em28xx_set_ir(struct em28xx *dev, struct IR_i2c *ir);
559 int em28xx_tuner_callback(void *ptr, int component, int command, int arg);
561 /* Provided by em28xx-input.c */
562 int em28xx_get_key_terratec(struct IR_i2c *ir, u32 *ir_key, u32 *ir_raw);
563 int em28xx_get_key_em_haup(struct IR_i2c *ir, u32 *ir_key, u32 *ir_raw);
564 int em28xx_get_key_pinnacle_usb_grey(struct IR_i2c *ir, u32 *ir_key,
566 void em28xx_register_snapshot_button(struct em28xx *dev);
567 void em28xx_deregister_snapshot_button(struct em28xx *dev);
569 int em28xx_ir_init(struct em28xx *dev);
570 int em28xx_ir_fini(struct em28xx *dev);
574 #define em28xx_err(fmt, arg...) do {\
575 printk(KERN_ERR fmt , ##arg); } while (0)
577 #define em28xx_errdev(fmt, arg...) do {\
578 printk(KERN_ERR "%s: "fmt,\
579 dev->name , ##arg); } while (0)
581 #define em28xx_info(fmt, arg...) do {\
582 printk(KERN_INFO "%s: "fmt,\
583 dev->name , ##arg); } while (0)
584 #define em28xx_warn(fmt, arg...) do {\
585 printk(KERN_WARNING "%s: "fmt,\
586 dev->name , ##arg); } while (0)
588 static inline int em28xx_compression_disable(struct em28xx *dev)
590 /* side effect of disabling scaler and mixer */
591 return em28xx_write_regs(dev, EM28XX_R26_COMPR, "\x00", 1);
594 static inline int em28xx_contrast_get(struct em28xx *dev)
596 return em28xx_read_reg(dev, EM28XX_R20_YGAIN) & 0x1f;
599 static inline int em28xx_brightness_get(struct em28xx *dev)
601 return em28xx_read_reg(dev, EM28XX_R21_YOFFSET);
604 static inline int em28xx_saturation_get(struct em28xx *dev)
606 return em28xx_read_reg(dev, EM28XX_R22_UVGAIN) & 0x1f;
609 static inline int em28xx_u_balance_get(struct em28xx *dev)
611 return em28xx_read_reg(dev, EM28XX_R23_UOFFSET);
614 static inline int em28xx_v_balance_get(struct em28xx *dev)
616 return em28xx_read_reg(dev, EM28XX_R24_VOFFSET);
619 static inline int em28xx_gamma_get(struct em28xx *dev)
621 return em28xx_read_reg(dev, EM28XX_R14_GAMMA) & 0x3f;
624 static inline int em28xx_contrast_set(struct em28xx *dev, s32 val)
627 return em28xx_write_regs(dev, EM28XX_R20_YGAIN, &tmp, 1);
630 static inline int em28xx_brightness_set(struct em28xx *dev, s32 val)
633 return em28xx_write_regs(dev, EM28XX_R21_YOFFSET, &tmp, 1);
636 static inline int em28xx_saturation_set(struct em28xx *dev, s32 val)
639 return em28xx_write_regs(dev, EM28XX_R22_UVGAIN, &tmp, 1);
642 static inline int em28xx_u_balance_set(struct em28xx *dev, s32 val)
645 return em28xx_write_regs(dev, EM28XX_R23_UOFFSET, &tmp, 1);
648 static inline int em28xx_v_balance_set(struct em28xx *dev, s32 val)
651 return em28xx_write_regs(dev, EM28XX_R24_VOFFSET, &tmp, 1);
654 static inline int em28xx_gamma_set(struct em28xx *dev, s32 val)
657 return em28xx_write_regs(dev, EM28XX_R14_GAMMA, &tmp, 1);
660 /*FIXME: maxw should be dependent of alt mode */
661 static inline unsigned int norm_maxw(struct em28xx *dev)
663 if (dev->max_range_640_480)
669 static inline unsigned int norm_maxh(struct em28xx *dev)
671 if (dev->max_range_640_480)
674 return (dev->norm & V4L2_STD_625_50) ? 576 : 480;