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 <linux/i2c.h>
30 #include <linux/mutex.h>
31 #include <media/ir-kbd-i2c.h>
35 /* maximum number of em28xx boards */
36 #define EM28XX_MAXBOARDS 1 /*FIXME: should be bigger */
38 /* maximum number of frames that can be queued */
39 #define EM28XX_NUM_FRAMES 5
40 /* number of frames that get used for v4l2_read() */
41 #define EM28XX_NUM_READ_FRAMES 2
43 /* number of buffers for isoc transfers */
44 #define EM28XX_NUM_BUFS 5
46 /* number of packets for each buffer
47 windows requests only 40 packets .. so we better do the same
48 this is what I found out for all alternate numbers there!
50 #define EM28XX_NUM_PACKETS 40
52 /* default alternate; 0 means choose the best */
53 #define EM28XX_PINOUT 0
55 #define EM28XX_INTERLACED_DEFAULT 1
58 #define (use usbview if you want to get the other alternate number infos)
60 #define alternate number 2
61 #define Endpoint Address: 82
78 /* time to wait when stopping the isoc transfer */
79 #define EM28XX_URB_TIMEOUT msecs_to_jiffies(EM28XX_NUM_BUFS * EM28XX_NUM_PACKETS)
81 /* time in msecs to wait for i2c writes to finish */
82 #define EM2800_I2C_WRITE_TIMEOUT 20
84 /* the various frame states */
85 enum em28xx_frame_state {
94 enum em28xx_stream_state {
101 struct em28xx_frame_t {
103 struct v4l2_buffer buf;
104 enum em28xx_frame_state state;
105 struct list_head frame;
106 unsigned long vma_use_count;
112 enum em28xx_io_method {
120 #define MAX_EM28XX_INPUT 4
121 enum enum28xx_itype {
122 EM28XX_VMUX_COMPOSITE1 = 1,
123 EM28XX_VMUX_COMPOSITE2,
124 EM28XX_VMUX_COMPOSITE3,
125 EM28XX_VMUX_COMPOSITE4,
127 EM28XX_VMUX_TELEVISION,
137 EM28XX_AMUX_AC97_VIDEO,
138 EM28XX_AMUX_AC97_LINE_IN,
141 struct em28xx_input {
142 enum enum28xx_itype type;
144 enum em28xx_amux amux;
147 #define INPUT(nr) (&em28xx_boards[dev->model].input[nr])
149 enum em28xx_decoder {
155 struct em28xx_board {
161 unsigned int tda9887_conf;
163 unsigned int is_em2800:1;
164 unsigned int has_msp34xx:1;
165 unsigned int mts_firmware:1;
166 unsigned int has_12mhz_i2s:1;
167 unsigned int max_range_640_480:1;
169 unsigned int analog_gpio;
171 enum em28xx_decoder decoder;
173 struct em28xx_input input[MAX_EM28XX_INPUT];
174 struct em28xx_input radio;
177 struct em28xx_eeprom {
178 u32 id; /* 0x9567eb1a */
186 u16 string1, string2, string3;
192 enum em28xx_dev_state {
193 DEV_INITIALIZED = 0x01,
194 DEV_DISCONNECTED = 0x02,
195 DEV_MISCONFIGURED = 0x04,
198 #define EM28XX_AUDIO_BUFS 5
199 #define EM28XX_NUM_AUDIO_PACKETS 64
200 #define EM28XX_AUDIO_MAX_PACKET_SIZE 196 /* static value */
201 #define EM28XX_CAPTURE_STREAM_EN 1
202 #define EM28XX_AUDIO 0x10
204 struct em28xx_audio {
206 char *transfer_buffer[EM28XX_AUDIO_BUFS];
207 struct urb *urb[EM28XX_AUDIO_BUFS];
208 struct usb_device *udev;
209 unsigned int capture_transfer_done;
210 struct snd_pcm_substream *capture_pcm_substream;
212 unsigned int hwptr_done_capture;
213 struct snd_card *sndcard;
216 enum em28xx_stream_state capture_stream;
220 /* main device struct */
222 /* generic device properties */
223 char name[30]; /* name (including minor) of the device */
224 int model; /* index in the device_data struct */
225 int devno; /* marks the number of this device */
226 unsigned int analog_gpio;
227 unsigned int is_em2800:1;
228 unsigned int has_msp34xx:1;
229 unsigned int has_tda9887:1;
230 unsigned int stream_on:1; /* Locks streams */
231 unsigned int has_audio_class:1;
232 unsigned int has_12mhz_i2s:1;
233 unsigned int max_range_640_480:1;
235 int video_inputs; /* number of video inputs */
236 struct list_head devlist;
238 u32 i2s_speed; /* I2S speed for audio digital stream */
240 enum em28xx_decoder decoder;
242 int tuner_type; /* type of the tuner */
243 int tuner_addr; /* tuner address */
246 struct i2c_adapter i2c_adap;
247 struct i2c_client i2c_client;
248 /* video for linux */
249 int users; /* user count for exclusive use */
250 struct video_device *vdev; /* video for linux device struct */
251 v4l2_std_id norm; /* selected tv norm */
252 int ctl_freq; /* selected frequency */
253 unsigned int ctl_input; /* selected input */
254 unsigned int ctl_ainput; /* slected audio input */
257 /* frame properties */
258 struct em28xx_frame_t frame[EM28XX_NUM_FRAMES]; /* list of frames */
259 int num_frames; /* number of frames currently in use */
260 unsigned int frame_count; /* total number of transfered frames */
261 struct em28xx_frame_t *frame_current; /* the frame that is being filled */
262 int width; /* current frame width */
263 int height; /* current frame height */
264 int frame_size; /* current frame size */
265 int field_size; /* current field size */
267 int hscale; /* horizontal scale factor (see datasheet) */
268 int vscale; /* vertical scale factor (see datasheet) */
269 int interlaced; /* 1=interlace fileds, 0=just top fileds */
271 unsigned int video_bytesread; /* Number of bytes read */
273 unsigned long hash; /* eeprom hash - for boards with generic ID */
274 unsigned long i2c_hash; /* i2c devicelist hash - for boards with generic ID */
276 struct em28xx_audio *adev;
279 enum em28xx_dev_state state;
280 enum em28xx_stream_state stream;
281 enum em28xx_io_method io;
283 struct work_struct request_module_wk;
287 spinlock_t queue_lock;
288 struct list_head inqueue, outqueue;
289 wait_queue_head_t open, wait_frame, wait_stream;
290 struct video_device *vbi_dev;
291 struct video_device *radio_dev;
293 unsigned char eedata[256];
296 struct usb_device *udev; /* the usb device */
297 int alt; /* alternate */
298 int max_pkt_size; /* max packet size of isoc transaction */
299 int num_alt; /* Number of alternative settings */
300 unsigned int *alt_max_pkt_size; /* array of wMaxPacketSize */
301 struct urb *urb[EM28XX_NUM_BUFS]; /* urb for isoc transfers */
302 char *transfer_buffer[EM28XX_NUM_BUFS]; /* transfer buffers for isoc transfer */
303 /* helper funcs that call usb_control_msg */
304 int (*em28xx_write_regs) (struct em28xx * dev, u16 reg, char *buf,
306 int (*em28xx_read_reg) (struct em28xx * dev, u16 reg);
307 int (*em28xx_read_reg_req_len) (struct em28xx * dev, u8 req, u16 reg,
309 int (*em28xx_write_regs_req) (struct em28xx * dev, u8 req, u16 reg,
311 int (*em28xx_read_reg_req) (struct em28xx * dev, u8 req, u16 reg);
316 unsigned int stream_on:1; /* Locks streams */
321 struct list_head next;
324 int (*init)(struct em28xx *);
325 int (*fini)(struct em28xx *);
328 /* Provided by em28xx-i2c.c */
330 void em28xx_i2c_call_clients(struct em28xx *dev, unsigned int cmd, void *arg);
331 void em28xx_do_i2c_scan(struct em28xx *dev);
332 int em28xx_i2c_register(struct em28xx *dev);
333 int em28xx_i2c_unregister(struct em28xx *dev);
335 /* Provided by em28xx-core.c */
337 u32 em28xx_request_buffers(struct em28xx *dev, u32 count);
338 void em28xx_queue_unusedframes(struct em28xx *dev);
339 void em28xx_release_buffers(struct em28xx *dev);
341 int em28xx_read_reg_req_len(struct em28xx *dev, u8 req, u16 reg,
343 int em28xx_read_reg_req(struct em28xx *dev, u8 req, u16 reg);
344 int em28xx_read_reg(struct em28xx *dev, u16 reg);
345 int em28xx_write_regs_req(struct em28xx *dev, u8 req, u16 reg, char *buf,
347 int em28xx_write_regs(struct em28xx *dev, u16 reg, char *buf, int len);
348 int em28xx_set_audio_source(struct em28xx *dev);
349 int em28xx_audio_analog_set(struct em28xx *dev);
351 int em28xx_colorlevels_set_default(struct em28xx *dev);
352 int em28xx_capture_start(struct em28xx *dev, int start);
353 int em28xx_outfmt_set_yuv422(struct em28xx *dev);
354 int em28xx_resolution_set(struct em28xx *dev);
355 int em28xx_init_isoc(struct em28xx *dev);
356 void em28xx_uninit_isoc(struct em28xx *dev);
357 int em28xx_set_alternate(struct em28xx *dev);
359 /* Provided by em28xx-video.c */
360 int em28xx_register_extension(struct em28xx_ops *dev);
361 void em28xx_unregister_extension(struct em28xx_ops *dev);
363 /* Provided by em28xx-cards.c */
364 extern int em2800_variant_detect(struct usb_device* udev,int model);
365 extern void em28xx_pre_card_setup(struct em28xx *dev);
366 extern void em28xx_card_setup(struct em28xx *dev);
367 extern struct em28xx_board em28xx_boards[];
368 extern struct usb_device_id em28xx_id_table[];
369 extern const unsigned int em28xx_bcount;
370 void em28xx_set_ir(struct em28xx *dev, struct IR_i2c *ir);
372 /* Provided by em28xx-input.c */
373 /* TODO: Check if the standard get_key handlers on ir-common can be used */
374 int em28xx_get_key_terratec(struct IR_i2c *ir, u32 *ir_key, u32 *ir_raw);
375 int em28xx_get_key_em_haup(struct IR_i2c *ir, u32 *ir_key, u32 *ir_raw);
376 int em28xx_get_key_pinnacle_usb_grey(struct IR_i2c *ir, u32 *ir_key,
379 /* em2800 registers */
380 #define EM2800_AUDIOSRC_REG 0x08
382 /* em28xx registers */
383 #define I2C_CLK_REG 0x06
384 #define CHIPID_REG 0x0a
385 #define USBSUSP_REG 0x0c /* */
387 #define AUDIOSRC_REG 0x0e
388 #define XCLK_REG 0x0f
390 #define VINMODE_REG 0x10
391 #define VINCTRL_REG 0x11
392 #define VINENABLE_REG 0x12 /* */
394 #define GAMMA_REG 0x14
395 #define RGAIN_REG 0x15
396 #define GGAIN_REG 0x16
397 #define BGAIN_REG 0x17
398 #define ROFFSET_REG 0x18
399 #define GOFFSET_REG 0x19
400 #define BOFFSET_REG 0x1a
402 #define OFLOW_REG 0x1b
403 #define HSTART_REG 0x1c
404 #define VSTART_REG 0x1d
405 #define CWIDTH_REG 0x1e
406 #define CHEIGHT_REG 0x1f
408 #define YGAIN_REG 0x20
409 #define YOFFSET_REG 0x21
410 #define UVGAIN_REG 0x22
411 #define UOFFSET_REG 0x23
412 #define VOFFSET_REG 0x24
413 #define SHARPNESS_REG 0x25
415 #define COMPR_REG 0x26
416 #define OUTFMT_REG 0x27
418 #define XMIN_REG 0x28
419 #define XMAX_REG 0x29
420 #define YMIN_REG 0x2a
421 #define YMAX_REG 0x2b
423 #define HSCALELOW_REG 0x30
424 #define HSCALEHIGH_REG 0x31
425 #define VSCALELOW_REG 0x32
426 #define VSCALEHIGH_REG 0x33
428 #define AC97LSB_REG 0x40
429 #define AC97MSB_REG 0x41
430 #define AC97ADDR_REG 0x42
431 #define AC97BUSY_REG 0x43
433 /* em202 registers */
434 #define MASTER_AC97 0x02
435 #define LINE_IN_AC97 0x10
436 #define VIDEO_AC97 0x14
438 /* register settings */
439 #define EM2800_AUDIO_SRC_TUNER 0x0d
440 #define EM2800_AUDIO_SRC_LINE 0x0c
441 #define EM28XX_AUDIO_SRC_TUNER 0xc0
442 #define EM28XX_AUDIO_SRC_LINE 0x80
446 #define em28xx_err(fmt, arg...) do {\
447 printk(KERN_ERR fmt , ##arg); } while (0)
449 #define em28xx_errdev(fmt, arg...) do {\
450 printk(KERN_ERR "%s: "fmt,\
451 dev->name , ##arg); } while (0)
453 #define em28xx_info(fmt, arg...) do {\
454 printk(KERN_INFO "%s: "fmt,\
455 dev->name , ##arg); } while (0)
456 #define em28xx_warn(fmt, arg...) do {\
457 printk(KERN_WARNING "%s: "fmt,\
458 dev->name , ##arg); } while (0)
460 inline static int em28xx_compression_disable(struct em28xx *dev)
462 /* side effect of disabling scaler and mixer */
463 return em28xx_write_regs(dev, COMPR_REG, "\x00", 1);
466 inline static int em28xx_contrast_get(struct em28xx *dev)
468 return em28xx_read_reg(dev, YGAIN_REG) & 0x1f;
471 inline static int em28xx_brightness_get(struct em28xx *dev)
473 return em28xx_read_reg(dev, YOFFSET_REG);
476 inline static int em28xx_saturation_get(struct em28xx *dev)
478 return em28xx_read_reg(dev, UVGAIN_REG) & 0x1f;
481 inline static int em28xx_u_balance_get(struct em28xx *dev)
483 return em28xx_read_reg(dev, UOFFSET_REG);
486 inline static int em28xx_v_balance_get(struct em28xx *dev)
488 return em28xx_read_reg(dev, VOFFSET_REG);
491 inline static int em28xx_gamma_get(struct em28xx *dev)
493 return em28xx_read_reg(dev, GAMMA_REG) & 0x3f;
496 inline static int em28xx_contrast_set(struct em28xx *dev, s32 val)
499 return em28xx_write_regs(dev, YGAIN_REG, &tmp, 1);
502 inline static int em28xx_brightness_set(struct em28xx *dev, s32 val)
505 return em28xx_write_regs(dev, YOFFSET_REG, &tmp, 1);
508 inline static int em28xx_saturation_set(struct em28xx *dev, s32 val)
511 return em28xx_write_regs(dev, UVGAIN_REG, &tmp, 1);
514 inline static int em28xx_u_balance_set(struct em28xx *dev, s32 val)
517 return em28xx_write_regs(dev, UOFFSET_REG, &tmp, 1);
520 inline static int em28xx_v_balance_set(struct em28xx *dev, s32 val)
523 return em28xx_write_regs(dev, VOFFSET_REG, &tmp, 1);
526 inline static int em28xx_gamma_set(struct em28xx *dev, s32 val)
529 return em28xx_write_regs(dev, GAMMA_REG, &tmp, 1);
532 /*FIXME: maxw should be dependent of alt mode */
533 inline static unsigned int norm_maxw(struct em28xx *dev)
535 if (dev->max_range_640_480)
541 inline static unsigned int norm_maxh(struct em28xx *dev)
543 if (dev->max_range_640_480)
546 return (dev->norm & V4L2_STD_625_50) ? 576 : 480;