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"
39 /* Boards supported by driver */
40 #define EM2800_BOARD_UNKNOWN 0
41 #define EM2820_BOARD_UNKNOWN 1
42 #define EM2820_BOARD_TERRATEC_CINERGY_250 2
43 #define EM2820_BOARD_PINNACLE_USB_2 3
44 #define EM2820_BOARD_HAUPPAUGE_WINTV_USB_2 4
45 #define EM2820_BOARD_MSI_VOX_USB_2 5
46 #define EM2800_BOARD_TERRATEC_CINERGY_200 6
47 #define EM2800_BOARD_LEADTEK_WINFAST_USBII 7
48 #define EM2800_BOARD_KWORLD_USB2800 8
49 #define EM2820_BOARD_PINNACLE_DVC_90 9
50 #define EM2880_BOARD_HAUPPAUGE_WINTV_HVR_900 10
51 #define EM2880_BOARD_TERRATEC_HYBRID_XS 11
52 #define EM2820_BOARD_KWORLD_PVRTV2800RF 12
53 #define EM2880_BOARD_TERRATEC_PRODIGY_XS 13
54 #define EM2820_BOARD_PROLINK_PLAYTV_USB2 14
55 #define EM2800_BOARD_VGEAR_POCKETTV 15
56 #define EM2880_BOARD_HAUPPAUGE_WINTV_HVR_950 16
58 /* Limits minimum and default number of buffers */
59 #define EM28XX_MIN_BUF 4
60 #define EM28XX_DEF_BUF 8
62 /* maximum number of em28xx boards */
63 #define EM28XX_MAXBOARDS 4 /*FIXME: should be bigger */
65 /* maximum number of frames that can be queued */
66 #define EM28XX_NUM_FRAMES 5
67 /* number of frames that get used for v4l2_read() */
68 #define EM28XX_NUM_READ_FRAMES 2
70 /* number of buffers for isoc transfers */
71 #define EM28XX_NUM_BUFS 5
73 /* number of packets for each buffer
74 windows requests only 40 packets .. so we better do the same
75 this is what I found out for all alternate numbers there!
77 #define EM28XX_NUM_PACKETS 40
79 /* default alternate; 0 means choose the best */
80 #define EM28XX_PINOUT 0
82 #define EM28XX_INTERLACED_DEFAULT 1
85 #define (use usbview if you want to get the other alternate number infos)
87 #define alternate number 2
88 #define Endpoint Address: 82
101 Max Packet Size: 3072
105 /* time to wait when stopping the isoc transfer */
106 #define EM28XX_URB_TIMEOUT msecs_to_jiffies(EM28XX_NUM_BUFS * EM28XX_NUM_PACKETS)
108 /* time in msecs to wait for i2c writes to finish */
109 #define EM2800_I2C_WRITE_TIMEOUT 20
116 enum em28xx_stream_state {
124 struct em28xx_usb_isoc_ctl {
125 /* max packet size of isoc transaction */
128 /* number of allocated urbs */
131 /* urb for isoc transfers */
134 /* transfer buffers for isoc transfer */
135 char **transfer_buffer;
137 /* Last buffer command and region */
139 int pos, size, pktsize;
141 /* Last field: ODD or EVEN? */
144 /* Stores incomplete commands */
148 /* Stores already requested buffers */
149 struct em28xx_buffer *buf;
151 /* Stores the number of received fields */
154 /* isoc urb callback */
155 int (*isoc_copy) (struct em28xx *dev, struct urb *urb);
161 u32 fourcc; /* v4l2 format id */
164 /* buffer for one video frame */
165 struct em28xx_buffer {
166 /* common v4l buffer stuff -- must be first */
167 struct videobuf_buffer vb;
169 struct list_head frame;
174 struct em28xx_dmaqueue {
175 struct list_head active;
176 struct list_head queued;
178 wait_queue_head_t wq;
180 /* Counters to control buffer fill */
185 enum em28xx_io_method {
193 #define MAX_EM28XX_INPUT 4
194 enum enum28xx_itype {
195 EM28XX_VMUX_COMPOSITE1 = 1,
196 EM28XX_VMUX_COMPOSITE2,
197 EM28XX_VMUX_COMPOSITE3,
198 EM28XX_VMUX_COMPOSITE4,
200 EM28XX_VMUX_TELEVISION,
210 EM28XX_AMUX_AC97_VIDEO,
211 EM28XX_AMUX_AC97_LINE_IN,
214 struct em28xx_input {
215 enum enum28xx_itype type;
217 enum em28xx_amux amux;
220 #define INPUT(nr) (&em28xx_boards[dev->model].input[nr])
222 enum em28xx_decoder {
230 /* Register to be set */
232 /* Initial/final value */
234 /* reset value - if set, it will do:
240 unsigned int t1, t2, t3;
243 struct em28xx_board {
249 unsigned int tda9887_conf;
251 unsigned int is_em2800:1;
252 unsigned int has_msp34xx:1;
253 unsigned int mts_firmware:1;
254 unsigned int has_12mhz_i2s:1;
255 unsigned int max_range_640_480:1;
256 unsigned int has_dvb:1;
258 struct gpio_ctl analog_gpio[MAX_GPIO];
259 struct gpio_ctl digital_gpio[MAX_GPIO];
261 enum em28xx_decoder decoder;
263 struct em28xx_input input[MAX_EM28XX_INPUT];
264 struct em28xx_input radio;
267 struct em28xx_eeprom {
268 u32 id; /* 0x9567eb1a */
276 u16 string1, string2, string3;
282 enum em28xx_dev_state {
283 DEV_INITIALIZED = 0x01,
284 DEV_DISCONNECTED = 0x02,
285 DEV_MISCONFIGURED = 0x04,
288 enum em28xx_capture_mode {
289 EM28XX_CAPTURE_OFF = 0,
290 EM28XX_ANALOG_CAPTURE,
291 EM28XX_DIGITAL_CAPTURE,
294 #define EM28XX_AUDIO_BUFS 5
295 #define EM28XX_NUM_AUDIO_PACKETS 64
296 #define EM28XX_AUDIO_MAX_PACKET_SIZE 196 /* static value */
297 #define EM28XX_CAPTURE_STREAM_EN 1
299 /* em28xx extensions */
300 #define EM28XX_AUDIO 0x10
301 #define EM28XX_DVB 0x20
303 struct em28xx_audio {
305 char *transfer_buffer[EM28XX_AUDIO_BUFS];
306 struct urb *urb[EM28XX_AUDIO_BUFS];
307 struct usb_device *udev;
308 unsigned int capture_transfer_done;
309 struct snd_pcm_substream *capture_pcm_substream;
311 unsigned int hwptr_done_capture;
312 struct snd_card *sndcard;
315 enum em28xx_stream_state capture_stream;
323 unsigned int stream_on:1; /* Locks streams */
326 struct videobuf_queue vb_vidq;
328 enum v4l2_buf_type type;
331 /* main device struct */
333 /* generic device properties */
334 char name[30]; /* name (including minor) of the device */
335 int model; /* index in the device_data struct */
336 int devno; /* marks the number of this device */
337 unsigned int is_em2800:1;
338 unsigned int has_msp34xx:1;
339 unsigned int has_tda9887:1;
340 unsigned int stream_on:1; /* Locks streams */
341 unsigned int has_audio_class:1;
342 unsigned int has_12mhz_i2s:1;
343 unsigned int max_range_640_480:1;
344 unsigned int has_dvb:1;
346 struct gpio_ctl *analog_gpio;
347 struct gpio_ctl *digital_gpio;
349 int video_inputs; /* number of video inputs */
350 struct list_head devlist;
352 u32 i2s_speed; /* I2S speed for audio digital stream */
354 enum em28xx_decoder decoder;
356 int tuner_type; /* type of the tuner */
357 int tuner_addr; /* tuner address */
360 struct i2c_adapter i2c_adap;
361 struct i2c_client i2c_client;
362 /* video for linux */
363 int users; /* user count for exclusive use */
364 struct video_device *vdev; /* video for linux device struct */
365 v4l2_std_id norm; /* selected tv norm */
366 int ctl_freq; /* selected frequency */
367 unsigned int ctl_input; /* selected input */
368 unsigned int ctl_ainput; /* slected audio input */
371 /* frame properties */
372 int width; /* current frame width */
373 int height; /* current frame height */
374 int hscale; /* horizontal scale factor (see datasheet) */
375 int vscale; /* vertical scale factor (see datasheet) */
376 int interlaced; /* 1=interlace fileds, 0=just top fileds */
377 unsigned int video_bytesread; /* Number of bytes read */
379 unsigned long hash; /* eeprom hash - for boards with generic ID */
380 unsigned long i2c_hash; /* i2c devicelist hash - for boards with generic ID */
382 struct em28xx_audio *adev;
385 enum em28xx_dev_state state;
386 enum em28xx_io_method io;
388 struct work_struct request_module_wk;
392 /* spinlock_t queue_lock; */
393 struct list_head inqueue, outqueue;
394 wait_queue_head_t open, wait_frame, wait_stream;
395 struct video_device *vbi_dev;
396 struct video_device *radio_dev;
398 unsigned char eedata[256];
400 /* Isoc control struct */
401 struct em28xx_dmaqueue vidq;
402 struct em28xx_usb_isoc_ctl isoc_ctl;
406 struct usb_device *udev; /* the usb device */
407 int alt; /* alternate */
408 int max_pkt_size; /* max packet size of isoc transaction */
409 int num_alt; /* Number of alternative settings */
410 unsigned int *alt_max_pkt_size; /* array of wMaxPacketSize */
411 struct urb *urb[EM28XX_NUM_BUFS]; /* urb for isoc transfers */
412 char *transfer_buffer[EM28XX_NUM_BUFS]; /* transfer buffers for isoc transfer */
413 /* helper funcs that call usb_control_msg */
414 int (*em28xx_write_regs) (struct em28xx * dev, u16 reg, char *buf,
416 int (*em28xx_read_reg) (struct em28xx * dev, u16 reg);
417 int (*em28xx_read_reg_req_len) (struct em28xx * dev, u8 req, u16 reg,
419 int (*em28xx_write_regs_req) (struct em28xx * dev, u8 req, u16 reg,
421 int (*em28xx_read_reg_req) (struct em28xx * dev, u8 req, u16 reg);
423 enum em28xx_mode mode;
425 struct em28xx_dvb *dvb;
429 struct list_head next;
432 int (*init)(struct em28xx *);
433 int (*fini)(struct em28xx *);
436 /* Provided by em28xx-i2c.c */
438 void em28xx_i2c_call_clients(struct em28xx *dev, unsigned int cmd, void *arg);
439 void em28xx_do_i2c_scan(struct em28xx *dev);
440 int em28xx_i2c_register(struct em28xx *dev);
441 int em28xx_i2c_unregister(struct em28xx *dev);
443 /* Provided by em28xx-core.c */
445 u32 em28xx_request_buffers(struct em28xx *dev, u32 count);
446 void em28xx_queue_unusedframes(struct em28xx *dev);
447 void em28xx_release_buffers(struct em28xx *dev);
449 int em28xx_read_reg_req_len(struct em28xx *dev, u8 req, u16 reg,
451 int em28xx_read_reg_req(struct em28xx *dev, u8 req, u16 reg);
452 int em28xx_read_reg(struct em28xx *dev, u16 reg);
453 int em28xx_write_regs_req(struct em28xx *dev, u8 req, u16 reg, char *buf,
455 int em28xx_write_regs(struct em28xx *dev, u16 reg, char *buf, int len);
456 int em28xx_audio_analog_set(struct em28xx *dev);
458 int em28xx_colorlevels_set_default(struct em28xx *dev);
459 int em28xx_capture_start(struct em28xx *dev, int start);
460 int em28xx_outfmt_set_yuv422(struct em28xx *dev);
461 int em28xx_resolution_set(struct em28xx *dev);
462 int em28xx_set_alternate(struct em28xx *dev);
463 int em28xx_init_isoc(struct em28xx *dev, int max_packets,
464 int num_bufs, int max_pkt_size,
465 int (*isoc_copy) (struct em28xx *dev, struct urb *urb),
467 void em28xx_uninit_isoc(struct em28xx *dev);
469 /* Provided by em28xx-video.c */
470 int em28xx_register_extension(struct em28xx_ops *dev);
471 void em28xx_unregister_extension(struct em28xx_ops *dev);
473 /* Provided by em28xx-cards.c */
474 extern int em2800_variant_detect(struct usb_device* udev,int model);
475 extern void em28xx_pre_card_setup(struct em28xx *dev);
476 extern void em28xx_card_setup(struct em28xx *dev);
477 extern struct em28xx_board em28xx_boards[];
478 extern struct usb_device_id em28xx_id_table[];
479 extern const unsigned int em28xx_bcount;
480 void em28xx_set_ir(struct em28xx *dev, struct IR_i2c *ir);
481 int em28xx_tuner_callback(void *ptr, int command, int arg);
482 void em28xx_setup_xc3028(struct em28xx *dev, struct xc2028_ctrl *ctl);
484 /* Provided by em28xx-input.c */
485 /* TODO: Check if the standard get_key handlers on ir-common can be used */
486 int em28xx_get_key_terratec(struct IR_i2c *ir, u32 *ir_key, u32 *ir_raw);
487 int em28xx_get_key_em_haup(struct IR_i2c *ir, u32 *ir_key, u32 *ir_raw);
488 int em28xx_get_key_pinnacle_usb_grey(struct IR_i2c *ir, u32 *ir_key,
491 /* em2800 registers */
492 #define EM2800_AUDIOSRC_REG 0x08
494 /* em28xx registers */
495 #define I2C_CLK_REG 0x06
496 #define CHIPID_REG 0x0a
497 #define USBSUSP_REG 0x0c /* */
499 #define AUDIOSRC_REG 0x0e
500 #define XCLK_REG 0x0f
502 #define VINMODE_REG 0x10
503 #define VINCTRL_REG 0x11
504 #define VINENABLE_REG 0x12 /* */
506 #define GAMMA_REG 0x14
507 #define RGAIN_REG 0x15
508 #define GGAIN_REG 0x16
509 #define BGAIN_REG 0x17
510 #define ROFFSET_REG 0x18
511 #define GOFFSET_REG 0x19
512 #define BOFFSET_REG 0x1a
514 #define OFLOW_REG 0x1b
515 #define HSTART_REG 0x1c
516 #define VSTART_REG 0x1d
517 #define CWIDTH_REG 0x1e
518 #define CHEIGHT_REG 0x1f
520 #define YGAIN_REG 0x20
521 #define YOFFSET_REG 0x21
522 #define UVGAIN_REG 0x22
523 #define UOFFSET_REG 0x23
524 #define VOFFSET_REG 0x24
525 #define SHARPNESS_REG 0x25
527 #define COMPR_REG 0x26
528 #define OUTFMT_REG 0x27
530 #define XMIN_REG 0x28
531 #define XMAX_REG 0x29
532 #define YMIN_REG 0x2a
533 #define YMAX_REG 0x2b
535 #define HSCALELOW_REG 0x30
536 #define HSCALEHIGH_REG 0x31
537 #define VSCALELOW_REG 0x32
538 #define VSCALEHIGH_REG 0x33
540 #define AC97LSB_REG 0x40
541 #define AC97MSB_REG 0x41
542 #define AC97ADDR_REG 0x42
543 #define AC97BUSY_REG 0x43
545 /* em202 registers */
546 #define MASTER_AC97 0x02
547 #define LINE_IN_AC97 0x10
548 #define VIDEO_AC97 0x14
550 /* register settings */
551 #define EM2800_AUDIO_SRC_TUNER 0x0d
552 #define EM2800_AUDIO_SRC_LINE 0x0c
553 #define EM28XX_AUDIO_SRC_TUNER 0xc0
554 #define EM28XX_AUDIO_SRC_LINE 0x80
558 #define em28xx_err(fmt, arg...) do {\
559 printk(KERN_ERR fmt , ##arg); } while (0)
561 #define em28xx_errdev(fmt, arg...) do {\
562 printk(KERN_ERR "%s: "fmt,\
563 dev->name , ##arg); } while (0)
565 #define em28xx_info(fmt, arg...) do {\
566 printk(KERN_INFO "%s: "fmt,\
567 dev->name , ##arg); } while (0)
568 #define em28xx_warn(fmt, arg...) do {\
569 printk(KERN_WARNING "%s: "fmt,\
570 dev->name , ##arg); } while (0)
572 inline static int em28xx_compression_disable(struct em28xx *dev)
574 /* side effect of disabling scaler and mixer */
575 return em28xx_write_regs(dev, COMPR_REG, "\x00", 1);
578 inline static int em28xx_contrast_get(struct em28xx *dev)
580 return em28xx_read_reg(dev, YGAIN_REG) & 0x1f;
583 inline static int em28xx_brightness_get(struct em28xx *dev)
585 return em28xx_read_reg(dev, YOFFSET_REG);
588 inline static int em28xx_saturation_get(struct em28xx *dev)
590 return em28xx_read_reg(dev, UVGAIN_REG) & 0x1f;
593 inline static int em28xx_u_balance_get(struct em28xx *dev)
595 return em28xx_read_reg(dev, UOFFSET_REG);
598 inline static int em28xx_v_balance_get(struct em28xx *dev)
600 return em28xx_read_reg(dev, VOFFSET_REG);
603 inline static int em28xx_gamma_get(struct em28xx *dev)
605 return em28xx_read_reg(dev, GAMMA_REG) & 0x3f;
608 inline static int em28xx_contrast_set(struct em28xx *dev, s32 val)
611 return em28xx_write_regs(dev, YGAIN_REG, &tmp, 1);
614 inline static int em28xx_brightness_set(struct em28xx *dev, s32 val)
617 return em28xx_write_regs(dev, YOFFSET_REG, &tmp, 1);
620 inline static int em28xx_saturation_set(struct em28xx *dev, s32 val)
623 return em28xx_write_regs(dev, UVGAIN_REG, &tmp, 1);
626 inline static int em28xx_u_balance_set(struct em28xx *dev, s32 val)
629 return em28xx_write_regs(dev, UOFFSET_REG, &tmp, 1);
632 inline static int em28xx_v_balance_set(struct em28xx *dev, s32 val)
635 return em28xx_write_regs(dev, VOFFSET_REG, &tmp, 1);
638 inline static int em28xx_gamma_set(struct em28xx *dev, s32 val)
641 return em28xx_write_regs(dev, GAMMA_REG, &tmp, 1);
644 /*FIXME: maxw should be dependent of alt mode */
645 inline static unsigned int norm_maxw(struct em28xx *dev)
647 if (dev->max_range_640_480)
653 inline static unsigned int norm_maxh(struct em28xx *dev)
655 if (dev->max_range_640_480)
658 return (dev->norm & V4L2_STD_625_50) ? 576 : 480;