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/videodev.h>
29 #include <linux/i2c.h>
30 #include <linux/mutex.h>
31 #include <media/ir-kbd-i2c.h>
33 /* Boards supported by driver */
35 #define EM2800_BOARD_UNKNOWN 0
36 #define EM2820_BOARD_UNKNOWN 1
37 #define EM2820_BOARD_TERRATEC_CINERGY_250 2
38 #define EM2820_BOARD_PINNACLE_USB_2 3
39 #define EM2820_BOARD_HAUPPAUGE_WINTV_USB_2 4
40 #define EM2820_BOARD_MSI_VOX_USB_2 5
41 #define EM2800_BOARD_TERRATEC_CINERGY_200 6
42 #define EM2800_BOARD_LEADTEK_WINFAST_USBII 7
43 #define EM2800_BOARD_KWORLD_USB2800 8
44 #define EM2820_BOARD_PINNACLE_DVC_90 9
45 #define EM2880_BOARD_HAUPPAUGE_WINTV_HVR_900 10
46 #define EM2880_BOARD_TERRATEC_HYBRID_XS 11
47 #define EM2820_BOARD_KWORLD_PVRTV2800RF 12
48 #define EM2880_BOARD_TERRATEC_PRODIGY_XS 13
49 #define EM2820_BOARD_PROLINK_PLAYTV_USB2 14
50 #define EM2800_BOARD_VGEAR_POCKETTV 15
54 /* maximum number of em28xx boards */
55 #define EM28XX_MAXBOARDS 1 /*FIXME: should be bigger */
57 /* maximum number of frames that can be queued */
58 #define EM28XX_NUM_FRAMES 5
59 /* number of frames that get used for v4l2_read() */
60 #define EM28XX_NUM_READ_FRAMES 2
62 /* number of buffers for isoc transfers */
63 #define EM28XX_NUM_BUFS 5
65 /* number of packets for each buffer
66 windows requests only 40 packets .. so we better do the same
67 this is what I found out for all alternate numbers there!
69 #define EM28XX_NUM_PACKETS 40
71 /* default alternate; 0 means choose the best */
72 #define EM28XX_PINOUT 0
74 #define EM28XX_INTERLACED_DEFAULT 1
77 #define (use usbview if you want to get the other alternate number infos)
79 #define alternate number 2
80 #define Endpoint Address: 82
97 /* time to wait when stopping the isoc transfer */
98 #define EM28XX_URB_TIMEOUT msecs_to_jiffies(EM28XX_NUM_BUFS * EM28XX_NUM_PACKETS)
100 /* time in msecs to wait for i2c writes to finish */
101 #define EM2800_I2C_WRITE_TIMEOUT 20
103 /* the various frame states */
104 enum em28xx_frame_state {
113 enum em28xx_stream_state {
120 struct em28xx_frame_t {
122 struct v4l2_buffer buf;
123 enum em28xx_frame_state state;
124 struct list_head frame;
125 unsigned long vma_use_count;
131 enum em28xx_io_method {
139 #define MAX_EM28XX_INPUT 4
140 enum enum28xx_itype {
141 EM28XX_VMUX_COMPOSITE1 = 1,
142 EM28XX_VMUX_COMPOSITE2,
143 EM28XX_VMUX_COMPOSITE3,
144 EM28XX_VMUX_COMPOSITE4,
146 EM28XX_VMUX_TELEVISION,
153 struct em28xx_input {
154 enum enum28xx_itype type;
159 #define INPUT(nr) (&em28xx_boards[dev->model].input[nr])
161 enum em28xx_decoder {
167 struct em28xx_board {
174 unsigned int is_em2800;
175 unsigned int tda9887_conf;
177 unsigned int has_tuner:1;
178 unsigned int has_msp34xx:1;
180 enum em28xx_decoder decoder;
182 struct em28xx_input input[MAX_EM28XX_INPUT];
185 struct em28xx_eeprom {
186 u32 id; /* 0x9567eb1a */
194 u16 string1, string2, string3;
200 enum em28xx_dev_state {
201 DEV_INITIALIZED = 0x01,
202 DEV_DISCONNECTED = 0x02,
203 DEV_MISCONFIGURED = 0x04,
207 struct em28xx_tvnorm {
210 /* mode for saa7113h */
214 /* main device struct */
216 /* generic device properties */
217 char name[30]; /* name (including minor) of the device */
218 int model; /* index in the device_data struct */
219 int devno; /* marks the number of this device */
220 unsigned int is_em2800;
221 int video_inputs; /* number of video inputs */
222 struct list_head devlist;
223 unsigned int has_tuner:1;
224 unsigned int has_msp34xx:1;
225 unsigned int has_tda9887:1;
227 u32 i2s_speed; /* I2S speed for audio digital stream */
229 enum em28xx_decoder decoder;
231 int tuner_type; /* type of the tuner */
232 int tuner_addr; /* tuner address */
235 struct i2c_adapter i2c_adap;
236 struct i2c_client i2c_client;
237 /* video for linux */
238 int users; /* user count for exclusive use */
239 struct video_device *vdev; /* video for linux device struct */
240 struct video_picture vpic; /* picture settings only used to init saa7113h */
241 struct em28xx_tvnorm *tvnorm; /* selected tv norm */
242 int ctl_freq; /* selected frequency */
243 unsigned int ctl_input; /* selected input */
244 unsigned int ctl_ainput; /* slected audio input */
247 /* frame properties */
248 struct em28xx_frame_t frame[EM28XX_NUM_FRAMES]; /* list of frames */
249 int num_frames; /* number of frames currently in use */
250 unsigned int frame_count; /* total number of transfered frames */
251 struct em28xx_frame_t *frame_current; /* the frame that is being filled */
252 int width; /* current frame width */
253 int height; /* current frame height */
254 int frame_size; /* current frame size */
255 int field_size; /* current field size */
257 int hscale; /* horizontal scale factor (see datasheet) */
258 int vscale; /* vertical scale factor (see datasheet) */
259 int interlaced; /* 1=interlace fileds, 0=just top fileds */
261 unsigned int reader:1;
263 unsigned long hash; /* eeprom hash - for boards with generic ID */
264 unsigned long i2c_hash; /* i2c devicelist hash - for boards with generic ID */
267 enum em28xx_dev_state state;
268 enum em28xx_stream_state stream;
269 enum em28xx_io_method io;
272 spinlock_t queue_lock;
273 struct list_head inqueue, outqueue;
274 wait_queue_head_t open, wait_frame, wait_stream;
275 struct video_device *vbi_dev;
277 unsigned char eedata[256];
280 struct usb_device *udev; /* the usb device */
281 int alt; /* alternate */
282 int max_pkt_size; /* max packet size of isoc transaction */
283 int num_alt; /* Number of alternative settings */
284 unsigned int *alt_max_pkt_size; /* array of wMaxPacketSize */
285 struct urb *urb[EM28XX_NUM_BUFS]; /* urb for isoc transfers */
286 char *transfer_buffer[EM28XX_NUM_BUFS]; /* transfer buffers for isoc transfer */
287 /* helper funcs that call usb_control_msg */
288 int (*em28xx_write_regs) (struct em28xx * dev, u16 reg, char *buf,
290 int (*em28xx_read_reg) (struct em28xx * dev, u16 reg);
291 int (*em28xx_read_reg_req_len) (struct em28xx * dev, u8 req, u16 reg,
293 int (*em28xx_write_regs_req) (struct em28xx * dev, u8 req, u16 reg,
295 int (*em28xx_read_reg_req) (struct em28xx * dev, u8 req, u16 reg);
300 unsigned int reader:1;
303 /* Provided by em28xx-i2c.c */
305 void em28xx_i2c_call_clients(struct em28xx *dev, unsigned int cmd, void *arg);
306 void em28xx_do_i2c_scan(struct em28xx *dev);
307 int em28xx_i2c_register(struct em28xx *dev);
308 int em28xx_i2c_unregister(struct em28xx *dev);
310 /* Provided by em28xx-input.c */
312 void em28xx_set_ir(struct em28xx * dev,struct IR_i2c *ir);
314 /* Provided by em28xx-core.c */
316 u32 em28xx_request_buffers(struct em28xx *dev, u32 count);
317 void em28xx_queue_unusedframes(struct em28xx *dev);
318 void em28xx_release_buffers(struct em28xx *dev);
320 int em28xx_read_reg_req_len(struct em28xx *dev, u8 req, u16 reg,
322 int em28xx_read_reg_req(struct em28xx *dev, u8 req, u16 reg);
323 int em28xx_read_reg(struct em28xx *dev, u16 reg);
324 int em28xx_write_regs_req(struct em28xx *dev, u8 req, u16 reg, char *buf,
326 int em28xx_write_regs(struct em28xx *dev, u16 reg, char *buf, int len);
327 int em28xx_write_reg_bits(struct em28xx *dev, u16 reg, u8 val,
329 int em28xx_write_ac97(struct em28xx *dev, u8 reg, u8 * val);
330 int em28xx_audio_analog_set(struct em28xx *dev);
331 int em28xx_colorlevels_set_default(struct em28xx *dev);
332 int em28xx_capture_start(struct em28xx *dev, int start);
333 int em28xx_outfmt_set_yuv422(struct em28xx *dev);
334 int em28xx_resolution_set(struct em28xx *dev);
335 int em28xx_init_isoc(struct em28xx *dev);
336 void em28xx_uninit_isoc(struct em28xx *dev);
337 int em28xx_set_alternate(struct em28xx *dev);
339 /* Provided by em28xx-cards.c */
340 extern int em2800_variant_detect(struct usb_device* udev,int model);
341 extern void em28xx_pre_card_setup(struct em28xx *dev);
342 extern void em28xx_card_setup(struct em28xx *dev);
343 extern struct em28xx_board em28xx_boards[];
344 extern struct usb_device_id em28xx_id_table[];
345 extern const unsigned int em28xx_bcount;
347 /* em2800 registers */
348 #define EM2800_AUDIOSRC_REG 0x08
350 /* em28xx registers */
351 #define CHIPID_REG 0x0a
352 #define USBSUSP_REG 0x0c /* */
354 #define AUDIOSRC_REG 0x0e
355 #define XCLK_REG 0x0f
357 #define VINMODE_REG 0x10
358 #define VINCTRL_REG 0x11
359 #define VINENABLE_REG 0x12 /* */
361 #define GAMMA_REG 0x14
362 #define RGAIN_REG 0x15
363 #define GGAIN_REG 0x16
364 #define BGAIN_REG 0x17
365 #define ROFFSET_REG 0x18
366 #define GOFFSET_REG 0x19
367 #define BOFFSET_REG 0x1a
369 #define OFLOW_REG 0x1b
370 #define HSTART_REG 0x1c
371 #define VSTART_REG 0x1d
372 #define CWIDTH_REG 0x1e
373 #define CHEIGHT_REG 0x1f
375 #define YGAIN_REG 0x20
376 #define YOFFSET_REG 0x21
377 #define UVGAIN_REG 0x22
378 #define UOFFSET_REG 0x23
379 #define VOFFSET_REG 0x24
380 #define SHARPNESS_REG 0x25
382 #define COMPR_REG 0x26
383 #define OUTFMT_REG 0x27
385 #define XMIN_REG 0x28
386 #define XMAX_REG 0x29
387 #define YMIN_REG 0x2a
388 #define YMAX_REG 0x2b
390 #define HSCALELOW_REG 0x30
391 #define HSCALEHIGH_REG 0x31
392 #define VSCALELOW_REG 0x32
393 #define VSCALEHIGH_REG 0x33
395 #define AC97LSB_REG 0x40
396 #define AC97MSB_REG 0x41
397 #define AC97ADDR_REG 0x42
398 #define AC97BUSY_REG 0x43
400 /* em202 registers */
401 #define MASTER_AC97 0x02
402 #define VIDEO_AC97 0x14
404 /* register settings */
405 #define EM2800_AUDIO_SRC_TUNER 0x0d
406 #define EM2800_AUDIO_SRC_LINE 0x0c
407 #define EM28XX_AUDIO_SRC_TUNER 0xc0
408 #define EM28XX_AUDIO_SRC_LINE 0x80
412 #define em28xx_err(fmt, arg...) do {\
413 printk(KERN_ERR fmt , ##arg); } while (0)
415 #define em28xx_errdev(fmt, arg...) do {\
416 printk(KERN_ERR "%s: "fmt,\
417 dev->name , ##arg); } while (0)
419 #define em28xx_info(fmt, arg...) do {\
420 printk(KERN_INFO "%s: "fmt,\
421 dev->name , ##arg); } while (0)
422 #define em28xx_warn(fmt, arg...) do {\
423 printk(KERN_WARNING "%s: "fmt,\
424 dev->name , ##arg); } while (0)
426 inline static int em28xx_audio_source(struct em28xx *dev, int input)
429 u8 tmp = EM2800_AUDIO_SRC_TUNER;
430 if(input == EM28XX_AUDIO_SRC_LINE)
431 tmp = EM2800_AUDIO_SRC_LINE;
432 em28xx_write_regs(dev, EM2800_AUDIOSRC_REG, &tmp, 1);
434 return em28xx_write_reg_bits(dev, AUDIOSRC_REG, input, 0xc0);
437 inline static int em28xx_audio_usb_mute(struct em28xx *dev, int mute)
439 return em28xx_write_reg_bits(dev, XCLK_REG, mute ? 0x00 : 0x80, 0x80);
442 inline static int em28xx_audio_analog_setup(struct em28xx *dev)
444 /* unmute video mixer with default volume level */
445 return em28xx_write_ac97(dev, VIDEO_AC97, "\x08\x08");
448 inline static int em28xx_compression_disable(struct em28xx *dev)
450 /* side effect of disabling scaler and mixer */
451 return em28xx_write_regs(dev, COMPR_REG, "\x00", 1);
454 inline static int em28xx_contrast_get(struct em28xx *dev)
456 return em28xx_read_reg(dev, YGAIN_REG) & 0x1f;
459 inline static int em28xx_brightness_get(struct em28xx *dev)
461 return em28xx_read_reg(dev, YOFFSET_REG);
464 inline static int em28xx_saturation_get(struct em28xx *dev)
466 return em28xx_read_reg(dev, UVGAIN_REG) & 0x1f;
469 inline static int em28xx_u_balance_get(struct em28xx *dev)
471 return em28xx_read_reg(dev, UOFFSET_REG);
474 inline static int em28xx_v_balance_get(struct em28xx *dev)
476 return em28xx_read_reg(dev, VOFFSET_REG);
479 inline static int em28xx_gamma_get(struct em28xx *dev)
481 return em28xx_read_reg(dev, GAMMA_REG) & 0x3f;
484 inline static int em28xx_contrast_set(struct em28xx *dev, s32 val)
487 return em28xx_write_regs(dev, YGAIN_REG, &tmp, 1);
490 inline static int em28xx_brightness_set(struct em28xx *dev, s32 val)
493 return em28xx_write_regs(dev, YOFFSET_REG, &tmp, 1);
496 inline static int em28xx_saturation_set(struct em28xx *dev, s32 val)
499 return em28xx_write_regs(dev, UVGAIN_REG, &tmp, 1);
502 inline static int em28xx_u_balance_set(struct em28xx *dev, s32 val)
505 return em28xx_write_regs(dev, UOFFSET_REG, &tmp, 1);
508 inline static int em28xx_v_balance_set(struct em28xx *dev, s32 val)
511 return em28xx_write_regs(dev, VOFFSET_REG, &tmp, 1);
514 inline static int em28xx_gamma_set(struct em28xx *dev, s32 val)
517 return em28xx_write_regs(dev, GAMMA_REG, &tmp, 1);
520 /*FIXME: maxw should be dependent of alt mode */
521 inline static unsigned int norm_maxw(struct em28xx *dev)
524 case (EM2820_BOARD_MSI_VOX_USB_2): return(640);
525 default: return(720);
529 inline static unsigned int norm_maxh(struct em28xx *dev)
532 case (EM2820_BOARD_MSI_VOX_USB_2): return(480);
533 default: return (dev->tvnorm->id & V4L2_STD_625_50) ? 576 : 480;