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 /* Params for validated field */
106 #define EM28XX_BOARD_NOT_VALIDATED 1
107 #define EM28XX_BOARD_VALIDATED 0
109 /* maximum number of em28xx boards */
110 #define EM28XX_MAXBOARDS 4 /*FIXME: should be bigger */
112 /* maximum number of frames that can be queued */
113 #define EM28XX_NUM_FRAMES 5
114 /* number of frames that get used for v4l2_read() */
115 #define EM28XX_NUM_READ_FRAMES 2
117 /* number of buffers for isoc transfers */
118 #define EM28XX_NUM_BUFS 5
120 /* number of packets for each buffer
121 windows requests only 40 packets .. so we better do the same
122 this is what I found out for all alternate numbers there!
124 #define EM28XX_NUM_PACKETS 40
126 /* default alternate; 0 means choose the best */
127 #define EM28XX_PINOUT 0
129 #define EM28XX_INTERLACED_DEFAULT 1
132 #define (use usbview if you want to get the other alternate number infos)
134 #define alternate number 2
135 #define Endpoint Address: 82
139 Max Packet Size: 1448
148 Max Packet Size: 3072
152 /* time to wait when stopping the isoc transfer */
153 #define EM28XX_URB_TIMEOUT msecs_to_jiffies(EM28XX_NUM_BUFS * EM28XX_NUM_PACKETS)
155 /* time in msecs to wait for i2c writes to finish */
156 #define EM2800_I2C_WRITE_TIMEOUT 20
159 EM28XX_MODE_UNDEFINED,
164 enum em28xx_stream_state {
172 struct em28xx_usb_isoc_ctl {
173 /* max packet size of isoc transaction */
176 /* number of allocated urbs */
179 /* urb for isoc transfers */
182 /* transfer buffers for isoc transfer */
183 char **transfer_buffer;
185 /* Last buffer command and region */
187 int pos, size, pktsize;
189 /* Last field: ODD or EVEN? */
192 /* Stores incomplete commands */
196 /* Stores already requested buffers */
197 struct em28xx_buffer *buf;
199 /* Stores the number of received fields */
202 /* isoc urb callback */
203 int (*isoc_copy) (struct em28xx *dev, struct urb *urb);
209 u32 fourcc; /* v4l2 format id */
212 /* buffer for one video frame */
213 struct em28xx_buffer {
214 /* common v4l buffer stuff -- must be first */
215 struct videobuf_buffer vb;
217 struct list_head frame;
222 struct em28xx_dmaqueue {
223 struct list_head active;
224 struct list_head queued;
226 wait_queue_head_t wq;
228 /* Counters to control buffer fill */
233 enum em28xx_io_method {
241 #define MAX_EM28XX_INPUT 4
242 enum enum28xx_itype {
243 EM28XX_VMUX_COMPOSITE1 = 1,
244 EM28XX_VMUX_COMPOSITE2,
245 EM28XX_VMUX_COMPOSITE3,
246 EM28XX_VMUX_COMPOSITE4,
248 EM28XX_VMUX_TELEVISION,
258 EM28XX_AMUX_AC97_VIDEO,
259 EM28XX_AMUX_AC97_LINE_IN,
262 struct em28xx_input {
263 enum enum28xx_itype type;
265 enum em28xx_amux amux;
268 #define INPUT(nr) (&em28xx_boards[dev->model].input[nr])
270 enum em28xx_decoder {
276 struct em28xx_reg_seq {
278 unsigned char val, mask;
282 struct em28xx_board {
288 unsigned int tda9887_conf;
290 unsigned int is_em2800:1;
291 unsigned int has_msp34xx:1;
292 unsigned int mts_firmware:1;
293 unsigned int has_12mhz_i2s:1;
294 unsigned int max_range_640_480:1;
295 unsigned int has_dvb:1;
296 unsigned int has_snapshot_button:1;
297 unsigned int valid:1;
299 enum em28xx_decoder decoder;
301 struct em28xx_input input[MAX_EM28XX_INPUT];
302 struct em28xx_input radio;
305 struct em28xx_eeprom {
306 u32 id; /* 0x9567eb1a */
314 u16 string1, string2, string3;
320 enum em28xx_dev_state {
321 DEV_INITIALIZED = 0x01,
322 DEV_DISCONNECTED = 0x02,
323 DEV_MISCONFIGURED = 0x04,
326 #define EM28XX_AUDIO_BUFS 5
327 #define EM28XX_NUM_AUDIO_PACKETS 64
328 #define EM28XX_AUDIO_MAX_PACKET_SIZE 196 /* static value */
329 #define EM28XX_CAPTURE_STREAM_EN 1
331 /* em28xx extensions */
332 #define EM28XX_AUDIO 0x10
333 #define EM28XX_DVB 0x20
335 struct em28xx_audio {
337 char *transfer_buffer[EM28XX_AUDIO_BUFS];
338 struct urb *urb[EM28XX_AUDIO_BUFS];
339 struct usb_device *udev;
340 unsigned int capture_transfer_done;
341 struct snd_pcm_substream *capture_pcm_substream;
343 unsigned int hwptr_done_capture;
344 struct snd_card *sndcard;
347 enum em28xx_stream_state capture_stream;
355 unsigned int stream_on:1; /* Locks streams */
358 struct videobuf_queue vb_vidq;
360 enum v4l2_buf_type type;
363 /* main device struct */
365 /* generic device properties */
366 char name[30]; /* name (including minor) of the device */
367 int model; /* index in the device_data struct */
368 int devno; /* marks the number of this device */
369 unsigned int is_em2800:1;
370 unsigned int has_msp34xx:1;
371 unsigned int has_tda9887:1;
372 unsigned int stream_on:1; /* Locks streams */
373 unsigned int has_audio_class:1;
374 unsigned int has_12mhz_i2s:1;
375 unsigned int max_range_640_480:1;
376 unsigned int has_dvb:1;
377 unsigned int has_snapshot_button:1;
378 unsigned int valid:1; /* report for validated boards */
380 /* Some older em28xx chips needs a waiting time after writing */
381 unsigned int wait_after_write;
383 /* GPIO sequences for analog and digital mode */
384 struct em28xx_reg_seq *analog_gpio, *digital_gpio;
386 /* GPIO sequences for tuner callbacks */
387 struct em28xx_reg_seq *tun_analog_gpio, *tun_digital_gpio;
389 int video_inputs; /* number of video inputs */
390 struct list_head devlist;
392 u32 i2s_speed; /* I2S speed for audio digital stream */
394 enum em28xx_decoder decoder;
396 int tuner_type; /* type of the tuner */
397 int tuner_addr; /* tuner address */
400 struct i2c_adapter i2c_adap;
401 struct i2c_client i2c_client;
402 /* video for linux */
403 int users; /* user count for exclusive use */
404 struct video_device *vdev; /* video for linux device struct */
405 v4l2_std_id norm; /* selected tv norm */
406 int ctl_freq; /* selected frequency */
407 unsigned int ctl_input; /* selected input */
408 unsigned int ctl_ainput;/* selected audio input */
411 /* frame properties */
412 int width; /* current frame width */
413 int height; /* current frame height */
414 int hscale; /* horizontal scale factor (see datasheet) */
415 int vscale; /* vertical scale factor (see datasheet) */
416 int interlaced; /* 1=interlace fileds, 0=just top fileds */
417 unsigned int video_bytesread; /* Number of bytes read */
419 unsigned long hash; /* eeprom hash - for boards with generic ID */
420 unsigned long i2c_hash; /* i2c devicelist hash -
421 for boards with generic ID */
423 struct em28xx_audio *adev;
426 enum em28xx_dev_state state;
427 enum em28xx_io_method io;
429 struct work_struct request_module_wk;
433 /* spinlock_t queue_lock; */
434 struct list_head inqueue, outqueue;
435 wait_queue_head_t open, wait_frame, wait_stream;
436 struct video_device *vbi_dev;
437 struct video_device *radio_dev;
439 unsigned char eedata[256];
441 /* Isoc control struct */
442 struct em28xx_dmaqueue vidq;
443 struct em28xx_usb_isoc_ctl isoc_ctl;
447 struct usb_device *udev; /* the usb device */
448 int alt; /* alternate */
449 int max_pkt_size; /* max packet size of isoc transaction */
450 int num_alt; /* Number of alternative settings */
451 unsigned int *alt_max_pkt_size; /* array of wMaxPacketSize */
452 struct urb *urb[EM28XX_NUM_BUFS]; /* urb for isoc transfers */
453 char *transfer_buffer[EM28XX_NUM_BUFS]; /* transfer buffers for isoc transfer */
454 /* helper funcs that call usb_control_msg */
455 int (*em28xx_write_regs) (struct em28xx *dev, u16 reg,
457 int (*em28xx_read_reg) (struct em28xx *dev, u16 reg);
458 int (*em28xx_read_reg_req_len) (struct em28xx *dev, u8 req, u16 reg,
460 int (*em28xx_write_regs_req) (struct em28xx *dev, u8 req, u16 reg,
462 int (*em28xx_read_reg_req) (struct em28xx *dev, u8 req, u16 reg);
464 enum em28xx_mode mode;
466 /* Caches GPO and GPIO registers */
467 unsigned char reg_gpo, reg_gpio;
469 /* Snapshot button */
470 char snapshot_button_path[30]; /* path of the input dev */
471 struct input_dev *sbutton_input_dev;
472 struct delayed_work sbutton_query_work;
474 struct em28xx_dvb *dvb;
478 struct list_head next;
481 int (*init)(struct em28xx *);
482 int (*fini)(struct em28xx *);
485 /* Provided by em28xx-i2c.c */
487 void em28xx_i2c_call_clients(struct em28xx *dev, unsigned int cmd, void *arg);
488 void em28xx_do_i2c_scan(struct em28xx *dev);
489 int em28xx_i2c_register(struct em28xx *dev);
490 int em28xx_i2c_unregister(struct em28xx *dev);
492 /* Provided by em28xx-core.c */
494 u32 em28xx_request_buffers(struct em28xx *dev, u32 count);
495 void em28xx_queue_unusedframes(struct em28xx *dev);
496 void em28xx_release_buffers(struct em28xx *dev);
498 int em28xx_read_reg_req_len(struct em28xx *dev, u8 req, u16 reg,
500 int em28xx_read_reg_req(struct em28xx *dev, u8 req, u16 reg);
501 int em28xx_read_reg(struct em28xx *dev, u16 reg);
502 int em28xx_write_regs_req(struct em28xx *dev, u8 req, u16 reg, char *buf,
504 int em28xx_write_regs(struct em28xx *dev, u16 reg, char *buf, int len);
505 int em28xx_audio_analog_set(struct em28xx *dev);
507 int em28xx_colorlevels_set_default(struct em28xx *dev);
508 int em28xx_capture_start(struct em28xx *dev, int start);
509 int em28xx_outfmt_set_yuv422(struct em28xx *dev);
510 int em28xx_resolution_set(struct em28xx *dev);
511 int em28xx_set_alternate(struct em28xx *dev);
512 int em28xx_init_isoc(struct em28xx *dev, int max_packets,
513 int num_bufs, int max_pkt_size,
514 int (*isoc_copy) (struct em28xx *dev, struct urb *urb));
515 void em28xx_uninit_isoc(struct em28xx *dev);
516 int em28xx_set_mode(struct em28xx *dev, enum em28xx_mode set_mode);
517 int em28xx_gpio_set(struct em28xx *dev, struct em28xx_reg_seq *gpio);
519 /* Provided by em28xx-video.c */
520 int em28xx_register_extension(struct em28xx_ops *dev);
521 void em28xx_unregister_extension(struct em28xx_ops *dev);
523 /* Provided by em28xx-cards.c */
524 extern int em2800_variant_detect(struct usb_device *udev, int model);
525 extern void em28xx_pre_card_setup(struct em28xx *dev);
526 extern void em28xx_card_setup(struct em28xx *dev);
527 extern struct em28xx_board em28xx_boards[];
528 extern struct usb_device_id em28xx_id_table[];
529 extern const unsigned int em28xx_bcount;
530 void em28xx_set_ir(struct em28xx *dev, struct IR_i2c *ir);
531 int em28xx_tuner_callback(void *ptr, int command, int arg);
533 /* Provided by em28xx-input.c */
534 /* TODO: Check if the standard get_key handlers on ir-common can be used */
535 int em28xx_get_key_terratec(struct IR_i2c *ir, u32 *ir_key, u32 *ir_raw);
536 int em28xx_get_key_em_haup(struct IR_i2c *ir, u32 *ir_key, u32 *ir_raw);
537 int em28xx_get_key_pinnacle_usb_grey(struct IR_i2c *ir, u32 *ir_key,
539 void em28xx_register_snapshot_button(struct em28xx *dev);
540 void em28xx_deregister_snapshot_button(struct em28xx *dev);
544 #define em28xx_err(fmt, arg...) do {\
545 printk(KERN_ERR fmt , ##arg); } while (0)
547 #define em28xx_errdev(fmt, arg...) do {\
548 printk(KERN_ERR "%s: "fmt,\
549 dev->name , ##arg); } while (0)
551 #define em28xx_info(fmt, arg...) do {\
552 printk(KERN_INFO "%s: "fmt,\
553 dev->name , ##arg); } while (0)
554 #define em28xx_warn(fmt, arg...) do {\
555 printk(KERN_WARNING "%s: "fmt,\
556 dev->name , ##arg); } while (0)
558 static inline int em28xx_compression_disable(struct em28xx *dev)
560 /* side effect of disabling scaler and mixer */
561 return em28xx_write_regs(dev, EM28XX_R26_COMPR, "\x00", 1);
564 static inline int em28xx_contrast_get(struct em28xx *dev)
566 return em28xx_read_reg(dev, EM28XX_R20_YGAIN) & 0x1f;
569 static inline int em28xx_brightness_get(struct em28xx *dev)
571 return em28xx_read_reg(dev, EM28XX_R21_YOFFSET);
574 static inline int em28xx_saturation_get(struct em28xx *dev)
576 return em28xx_read_reg(dev, EM28XX_R22_UVGAIN) & 0x1f;
579 static inline int em28xx_u_balance_get(struct em28xx *dev)
581 return em28xx_read_reg(dev, EM28XX_R23_UOFFSET);
584 static inline int em28xx_v_balance_get(struct em28xx *dev)
586 return em28xx_read_reg(dev, EM28XX_R24_VOFFSET);
589 static inline int em28xx_gamma_get(struct em28xx *dev)
591 return em28xx_read_reg(dev, EM28XX_R14_GAMMA) & 0x3f;
594 static inline int em28xx_contrast_set(struct em28xx *dev, s32 val)
597 return em28xx_write_regs(dev, EM28XX_R20_YGAIN, &tmp, 1);
600 static inline int em28xx_brightness_set(struct em28xx *dev, s32 val)
603 return em28xx_write_regs(dev, EM28XX_R21_YOFFSET, &tmp, 1);
606 static inline int em28xx_saturation_set(struct em28xx *dev, s32 val)
609 return em28xx_write_regs(dev, EM28XX_R22_UVGAIN, &tmp, 1);
612 static inline int em28xx_u_balance_set(struct em28xx *dev, s32 val)
615 return em28xx_write_regs(dev, EM28XX_R23_UOFFSET, &tmp, 1);
618 static inline int em28xx_v_balance_set(struct em28xx *dev, s32 val)
621 return em28xx_write_regs(dev, EM28XX_R24_VOFFSET, &tmp, 1);
624 static inline int em28xx_gamma_set(struct em28xx *dev, s32 val)
627 return em28xx_write_regs(dev, EM28XX_R14_GAMMA, &tmp, 1);
630 /*FIXME: maxw should be dependent of alt mode */
631 static inline unsigned int norm_maxw(struct em28xx *dev)
633 if (dev->max_range_640_480)
639 static inline unsigned int norm_maxh(struct em28xx *dev)
641 if (dev->max_range_640_480)
644 return (dev->norm & V4L2_STD_625_50) ? 576 : 480;