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
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
{
262 EM28XX_AC97_SIGMATEL
,
266 struct em28xx_audio_mode
{
267 enum em28xx_ac97_mode ac97
;
272 unsigned int has_audio
:1;
274 unsigned int i2s_3rates
:1;
275 unsigned int i2s_5rates
:1;
278 /* em28xx has two audio inputs: tuner and line in.
279 However, on most devices, an auxiliary AC97 codec device is used.
280 The AC97 device may have several different inputs and outputs,
281 depending on their model. So, it is possible to use AC97 mixer to
282 address more than two different entries.
285 /* This is the only entry for em28xx tuner input */
286 EM28XX_AMUX_VIDEO
, /* em28xx tuner, AC97 mixer Video */
288 EM28XX_AMUX_LINE_IN
, /* AC97 mixer Line In */
290 /* Some less-common mixer setups */
291 EM28XX_AMUX_VIDEO2
, /* em28xx Line in, AC97 mixer Video */
300 EM28XX_AOUT_MASTER
= 1 << 0,
301 EM28XX_AOUT_LINE
= 1 << 1,
302 EM28XX_AOUT_MONO
= 1 << 2,
303 EM28XX_AOUT_LFE
= 1 << 3,
304 EM28XX_AOUT_SURR
= 1 << 4,
307 struct em28xx_reg_seq
{
309 unsigned char val
, mask
;
313 struct em28xx_input
{
314 enum enum28xx_itype type
;
316 enum em28xx_amux amux
;
317 enum em28xx_aout aout
;
318 struct em28xx_reg_seq
*gpio
;
321 #define INPUT(nr) (&em28xx_boards[dev->model].input[nr])
323 enum em28xx_decoder
{
329 struct em28xx_board
{
336 unsigned int tda9887_conf
;
338 struct em28xx_reg_seq
*dvb_gpio
;
339 struct em28xx_reg_seq
*suspend_gpio
;
341 unsigned int is_em2800
:1;
342 unsigned int has_msp34xx
:1;
343 unsigned int mts_firmware
:1;
344 unsigned int max_range_640_480
:1;
345 unsigned int has_dvb
:1;
346 unsigned int has_snapshot_button
:1;
347 unsigned int valid
:1;
349 unsigned char xclk
, i2c_speed
;
351 enum em28xx_decoder decoder
;
353 struct em28xx_input input
[MAX_EM28XX_INPUT
];
354 struct em28xx_input radio
;
355 IR_KEYTAB_TYPE
*ir_codes
;
358 struct em28xx_eeprom
{
359 u32 id
; /* 0x9567eb1a */
367 u16 string1
, string2
, string3
;
373 enum em28xx_dev_state
{
374 DEV_INITIALIZED
= 0x01,
375 DEV_DISCONNECTED
= 0x02,
376 DEV_MISCONFIGURED
= 0x04,
379 #define EM28XX_AUDIO_BUFS 5
380 #define EM28XX_NUM_AUDIO_PACKETS 64
381 #define EM28XX_AUDIO_MAX_PACKET_SIZE 196 /* static value */
382 #define EM28XX_CAPTURE_STREAM_EN 1
384 /* em28xx extensions */
385 #define EM28XX_AUDIO 0x10
386 #define EM28XX_DVB 0x20
388 struct em28xx_audio
{
390 char *transfer_buffer
[EM28XX_AUDIO_BUFS
];
391 struct urb
*urb
[EM28XX_AUDIO_BUFS
];
392 struct usb_device
*udev
;
393 unsigned int capture_transfer_done
;
394 struct snd_pcm_substream
*capture_pcm_substream
;
396 unsigned int hwptr_done_capture
;
397 struct snd_card
*sndcard
;
400 enum em28xx_stream_state capture_stream
;
408 unsigned int stream_on
:1; /* Locks streams */
411 struct videobuf_queue vb_vidq
;
413 enum v4l2_buf_type type
;
416 /* main device struct */
418 /* generic device properties */
419 char name
[30]; /* name (including minor) of the device */
420 int model
; /* index in the device_data struct */
421 int devno
; /* marks the number of this device */
422 enum em28xx_chip_id chip_id
;
424 struct em28xx_board board
;
426 unsigned int stream_on
:1; /* Locks streams */
427 unsigned int has_audio_class
:1;
428 unsigned int has_alsa_audio
:1;
430 struct em28xx_IR
*ir
;
432 /* Some older em28xx chips needs a waiting time after writing */
433 unsigned int wait_after_write
;
435 /* GPIO sequences for tuner callbacks */
436 struct em28xx_reg_seq
*tuner_gpio
;
438 struct list_head devlist
;
440 u32 i2s_speed
; /* I2S speed for audio digital stream */
442 struct em28xx_audio_mode audio_mode
;
444 int tuner_type
; /* type of the tuner */
445 int tuner_addr
; /* tuner address */
448 struct i2c_adapter i2c_adap
;
449 struct i2c_client i2c_client
;
450 /* video for linux */
451 int users
; /* user count for exclusive use */
452 struct video_device
*vdev
; /* video for linux device struct */
453 v4l2_std_id norm
; /* selected tv norm */
454 int ctl_freq
; /* selected frequency */
455 unsigned int ctl_input
; /* selected input */
456 unsigned int ctl_ainput
;/* selected audio input */
457 unsigned int ctl_aoutput
;/* selected audio output */
460 /* frame properties */
461 int width
; /* current frame width */
462 int height
; /* current frame height */
463 unsigned hscale
; /* horizontal scale factor (see datasheet) */
464 unsigned vscale
; /* vertical scale factor (see datasheet) */
465 int interlaced
; /* 1=interlace fileds, 0=just top fileds */
466 unsigned int video_bytesread
; /* Number of bytes read */
468 unsigned long hash
; /* eeprom hash - for boards with generic ID */
469 unsigned long i2c_hash
; /* i2c devicelist hash -
470 for boards with generic ID */
472 struct em28xx_audio
*adev
;
475 enum em28xx_dev_state state
;
476 enum em28xx_io_method io
;
478 struct work_struct request_module_wk
;
482 struct mutex ctrl_urb_lock
; /* protects urb_buf */
483 /* spinlock_t queue_lock; */
484 struct list_head inqueue
, outqueue
;
485 wait_queue_head_t open
, wait_frame
, wait_stream
;
486 struct video_device
*vbi_dev
;
487 struct video_device
*radio_dev
;
489 unsigned char eedata
[256];
491 /* Isoc control struct */
492 struct em28xx_dmaqueue vidq
;
493 struct em28xx_usb_isoc_ctl isoc_ctl
;
497 struct usb_device
*udev
; /* the usb device */
498 int alt
; /* alternate */
499 int max_pkt_size
; /* max packet size of isoc transaction */
500 int num_alt
; /* Number of alternative settings */
501 unsigned int *alt_max_pkt_size
; /* array of wMaxPacketSize */
502 struct urb
*urb
[EM28XX_NUM_BUFS
]; /* urb for isoc transfers */
503 char *transfer_buffer
[EM28XX_NUM_BUFS
]; /* transfer buffers for isoc transfer */
504 char urb_buf
[URB_MAX_CTRL_SIZE
]; /* urb control msg buffer */
506 /* helper funcs that call usb_control_msg */
507 int (*em28xx_write_regs
) (struct em28xx
*dev
, u16 reg
,
509 int (*em28xx_read_reg
) (struct em28xx
*dev
, u16 reg
);
510 int (*em28xx_read_reg_req_len
) (struct em28xx
*dev
, u8 req
, u16 reg
,
512 int (*em28xx_write_regs_req
) (struct em28xx
*dev
, u8 req
, u16 reg
,
514 int (*em28xx_read_reg_req
) (struct em28xx
*dev
, u8 req
, u16 reg
);
516 enum em28xx_mode mode
;
518 /* register numbers for GPO/GPIO registers */
519 u16 reg_gpo_num
, reg_gpio_num
;
521 /* Caches GPO and GPIO registers */
522 unsigned char reg_gpo
, reg_gpio
;
524 /* Snapshot button */
525 char snapshot_button_path
[30]; /* path of the input dev */
526 struct input_dev
*sbutton_input_dev
;
527 struct delayed_work sbutton_query_work
;
529 struct em28xx_dvb
*dvb
;
533 struct list_head next
;
536 int (*init
)(struct em28xx
*);
537 int (*fini
)(struct em28xx
*);
540 /* Provided by em28xx-i2c.c */
542 void em28xx_i2c_call_clients(struct em28xx
*dev
, unsigned int cmd
, void *arg
);
543 void em28xx_do_i2c_scan(struct em28xx
*dev
);
544 int em28xx_i2c_register(struct em28xx
*dev
);
545 int em28xx_i2c_unregister(struct em28xx
*dev
);
547 /* Provided by em28xx-core.c */
549 u32
em28xx_request_buffers(struct em28xx
*dev
, u32 count
);
550 void em28xx_queue_unusedframes(struct em28xx
*dev
);
551 void em28xx_release_buffers(struct em28xx
*dev
);
553 int em28xx_read_reg_req_len(struct em28xx
*dev
, u8 req
, u16 reg
,
555 int em28xx_read_reg_req(struct em28xx
*dev
, u8 req
, u16 reg
);
556 int em28xx_read_reg(struct em28xx
*dev
, u16 reg
);
557 int em28xx_write_regs_req(struct em28xx
*dev
, u8 req
, u16 reg
, char *buf
,
559 int em28xx_write_regs(struct em28xx
*dev
, u16 reg
, char *buf
, int len
);
560 int em28xx_write_reg(struct em28xx
*dev
, u16 reg
, u8 val
);
562 int em28xx_audio_analog_set(struct em28xx
*dev
);
563 int em28xx_audio_setup(struct em28xx
*dev
);
565 int em28xx_colorlevels_set_default(struct em28xx
*dev
);
566 int em28xx_capture_start(struct em28xx
*dev
, int start
);
567 int em28xx_outfmt_set_yuv422(struct em28xx
*dev
);
568 int em28xx_resolution_set(struct em28xx
*dev
);
569 int em28xx_set_alternate(struct em28xx
*dev
);
570 int em28xx_init_isoc(struct em28xx
*dev
, int max_packets
,
571 int num_bufs
, int max_pkt_size
,
572 int (*isoc_copy
) (struct em28xx
*dev
, struct urb
*urb
));
573 void em28xx_uninit_isoc(struct em28xx
*dev
);
574 int em28xx_set_mode(struct em28xx
*dev
, enum em28xx_mode set_mode
);
575 int em28xx_gpio_set(struct em28xx
*dev
, struct em28xx_reg_seq
*gpio
);
577 /* Provided by em28xx-video.c */
578 int em28xx_register_extension(struct em28xx_ops
*dev
);
579 void em28xx_unregister_extension(struct em28xx_ops
*dev
);
581 /* Provided by em28xx-cards.c */
582 extern int em2800_variant_detect(struct usb_device
*udev
, int model
);
583 extern void em28xx_pre_card_setup(struct em28xx
*dev
);
584 extern void em28xx_card_setup(struct em28xx
*dev
);
585 extern struct em28xx_board em28xx_boards
[];
586 extern struct usb_device_id em28xx_id_table
[];
587 extern const unsigned int em28xx_bcount
;
588 void em28xx_set_ir(struct em28xx
*dev
, struct IR_i2c
*ir
);
589 int em28xx_tuner_callback(void *ptr
, int component
, int command
, int arg
);
591 /* Provided by em28xx-input.c */
592 int em28xx_get_key_terratec(struct IR_i2c
*ir
, u32
*ir_key
, u32
*ir_raw
);
593 int em28xx_get_key_em_haup(struct IR_i2c
*ir
, u32
*ir_key
, u32
*ir_raw
);
594 int em28xx_get_key_pinnacle_usb_grey(struct IR_i2c
*ir
, u32
*ir_key
,
596 void em28xx_register_snapshot_button(struct em28xx
*dev
);
597 void em28xx_deregister_snapshot_button(struct em28xx
*dev
);
599 int em28xx_ir_init(struct em28xx
*dev
);
600 int em28xx_ir_fini(struct em28xx
*dev
);
604 #define em28xx_err(fmt, arg...) do {\
605 printk(KERN_ERR fmt , ##arg); } while (0)
607 #define em28xx_errdev(fmt, arg...) do {\
608 printk(KERN_ERR "%s: "fmt,\
609 dev->name , ##arg); } while (0)
611 #define em28xx_info(fmt, arg...) do {\
612 printk(KERN_INFO "%s: "fmt,\
613 dev->name , ##arg); } while (0)
614 #define em28xx_warn(fmt, arg...) do {\
615 printk(KERN_WARNING "%s: "fmt,\
616 dev->name , ##arg); } while (0)
618 static inline int em28xx_compression_disable(struct em28xx
*dev
)
620 /* side effect of disabling scaler and mixer */
621 return em28xx_write_reg(dev
, EM28XX_R26_COMPR
, 0x00);
624 static inline int em28xx_contrast_get(struct em28xx
*dev
)
626 return em28xx_read_reg(dev
, EM28XX_R20_YGAIN
) & 0x1f;
629 static inline int em28xx_brightness_get(struct em28xx
*dev
)
631 return em28xx_read_reg(dev
, EM28XX_R21_YOFFSET
);
634 static inline int em28xx_saturation_get(struct em28xx
*dev
)
636 return em28xx_read_reg(dev
, EM28XX_R22_UVGAIN
) & 0x1f;
639 static inline int em28xx_u_balance_get(struct em28xx
*dev
)
641 return em28xx_read_reg(dev
, EM28XX_R23_UOFFSET
);
644 static inline int em28xx_v_balance_get(struct em28xx
*dev
)
646 return em28xx_read_reg(dev
, EM28XX_R24_VOFFSET
);
649 static inline int em28xx_gamma_get(struct em28xx
*dev
)
651 return em28xx_read_reg(dev
, EM28XX_R14_GAMMA
) & 0x3f;
654 static inline int em28xx_contrast_set(struct em28xx
*dev
, s32 val
)
657 return em28xx_write_regs(dev
, EM28XX_R20_YGAIN
, &tmp
, 1);
660 static inline int em28xx_brightness_set(struct em28xx
*dev
, s32 val
)
663 return em28xx_write_regs(dev
, EM28XX_R21_YOFFSET
, &tmp
, 1);
666 static inline int em28xx_saturation_set(struct em28xx
*dev
, s32 val
)
669 return em28xx_write_regs(dev
, EM28XX_R22_UVGAIN
, &tmp
, 1);
672 static inline int em28xx_u_balance_set(struct em28xx
*dev
, s32 val
)
675 return em28xx_write_regs(dev
, EM28XX_R23_UOFFSET
, &tmp
, 1);
678 static inline int em28xx_v_balance_set(struct em28xx
*dev
, s32 val
)
681 return em28xx_write_regs(dev
, EM28XX_R24_VOFFSET
, &tmp
, 1);
684 static inline int em28xx_gamma_set(struct em28xx
*dev
, s32 val
)
687 return em28xx_write_regs(dev
, EM28XX_R14_GAMMA
, &tmp
, 1);
690 /*FIXME: maxw should be dependent of alt mode */
691 static inline unsigned int norm_maxw(struct em28xx
*dev
)
693 if (dev
->board
.max_range_640_480
)
699 static inline unsigned int norm_maxh(struct em28xx
*dev
)
701 if (dev
->board
.max_range_640_480
)
704 return (dev
->norm
& V4L2_STD_625_50
) ? 576 : 480;