V4L/DVB (7599): em28xx-dvb: videobuf callbacks are waiting for em28xx_fh
[linux-2.6/x86.git] / drivers / media / video / em28xx / em28xx.h
blob3786dd819bbdaedd4ae76232592d3a11b4ba62e2
1 /*
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.
25 #ifndef _EM28XX_H
26 #define _EM28XX_H
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>
36 #endif
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)
86 #define
87 #define alternate number 2
88 #define Endpoint Address: 82
89 Direction: in
90 Attribute: 1
91 Type: Isoc
92 Max Packet Size: 1448
93 Interval: 125us
95 alternate number 7
97 Endpoint Address: 82
98 Direction: in
99 Attribute: 1
100 Type: Isoc
101 Max Packet Size: 3072
102 Interval: 125us
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
111 enum em28xx_mode {
112 EM28XX_ANALOG_MODE,
113 EM28XX_DIGITAL_MODE,
116 enum em28xx_stream_state {
117 STREAM_OFF,
118 STREAM_INTERRUPT,
119 STREAM_ON,
122 struct em28xx_usb_isoc_ctl {
123 /* max packet size of isoc transaction */
124 int max_pkt_size;
126 /* number of allocated urbs */
127 int num_bufs;
129 /* urb for isoc transfers */
130 struct urb **urb;
132 /* transfer buffers for isoc transfer */
133 char **transfer_buffer;
135 /* Last buffer command and region */
136 u8 cmd;
137 int pos, size, pktsize;
139 /* Last field: ODD or EVEN? */
140 int field;
142 /* Stores incomplete commands */
143 u32 tmp_buf;
144 int tmp_buf_len;
146 /* Stores already requested buffers */
147 struct em28xx_buffer *buf;
149 /* Stores the number of received fields */
150 int nfields;
153 struct em28xx_fmt {
154 char *name;
155 u32 fourcc; /* v4l2 format id */
158 /* buffer for one video frame */
159 struct em28xx_buffer {
160 /* common v4l buffer stuff -- must be first */
161 struct videobuf_buffer vb;
163 struct list_head frame;
164 int top_field;
165 int receiving;
168 struct em28xx_dmaqueue {
169 struct list_head active;
170 struct list_head queued;
172 wait_queue_head_t wq;
174 /* Counters to control buffer fill */
175 int pos;
178 /* io methods */
179 enum em28xx_io_method {
180 IO_NONE,
181 IO_READ,
182 IO_MMAP,
185 /* inputs */
187 #define MAX_EM28XX_INPUT 4
188 enum enum28xx_itype {
189 EM28XX_VMUX_COMPOSITE1 = 1,
190 EM28XX_VMUX_COMPOSITE2,
191 EM28XX_VMUX_COMPOSITE3,
192 EM28XX_VMUX_COMPOSITE4,
193 EM28XX_VMUX_SVIDEO,
194 EM28XX_VMUX_TELEVISION,
195 EM28XX_VMUX_CABLE,
196 EM28XX_VMUX_DVB,
197 EM28XX_VMUX_DEBUG,
198 EM28XX_RADIO,
201 enum em28xx_amux {
202 EM28XX_AMUX_VIDEO,
203 EM28XX_AMUX_LINE_IN,
204 EM28XX_AMUX_AC97_VIDEO,
205 EM28XX_AMUX_AC97_LINE_IN,
208 struct em28xx_input {
209 enum enum28xx_itype type;
210 unsigned int vmux;
211 enum em28xx_amux amux;
214 #define INPUT(nr) (&em28xx_boards[dev->model].input[nr])
216 enum em28xx_decoder {
217 EM28XX_TVP5150,
218 EM28XX_SAA7113,
219 EM28XX_SAA7114
222 #define MAX_GPIO 2
223 struct gpio_ctl {
224 /* Register to be set */
225 unsigned char reg;
226 /* Initial/final value */
227 unsigned char val;
228 /* reset value - if set, it will do:
229 val1 - val2 - val1
231 unsigned char rst;
232 /* Sleep times
234 unsigned int t1, t2, t3;
237 struct em28xx_board {
238 char *name;
239 int vchannels;
240 int tuner_type;
242 /* i2c flags */
243 unsigned int tda9887_conf;
245 unsigned int is_em2800:1;
246 unsigned int has_msp34xx:1;
247 unsigned int mts_firmware:1;
248 unsigned int has_12mhz_i2s:1;
249 unsigned int max_range_640_480:1;
250 unsigned int has_dvb:1;
252 struct gpio_ctl analog_gpio[MAX_GPIO];
253 struct gpio_ctl digital_gpio[MAX_GPIO];
255 enum em28xx_decoder decoder;
257 struct em28xx_input input[MAX_EM28XX_INPUT];
258 struct em28xx_input radio;
261 struct em28xx_eeprom {
262 u32 id; /* 0x9567eb1a */
263 u16 vendor_ID;
264 u16 product_ID;
266 u16 chip_conf;
268 u16 board_conf;
270 u16 string1, string2, string3;
272 u8 string_idx_table;
275 /* device states */
276 enum em28xx_dev_state {
277 DEV_INITIALIZED = 0x01,
278 DEV_DISCONNECTED = 0x02,
279 DEV_MISCONFIGURED = 0x04,
282 #define EM28XX_AUDIO_BUFS 5
283 #define EM28XX_NUM_AUDIO_PACKETS 64
284 #define EM28XX_AUDIO_MAX_PACKET_SIZE 196 /* static value */
285 #define EM28XX_CAPTURE_STREAM_EN 1
287 /* em28xx extensions */
288 #define EM28XX_AUDIO 0x10
289 #define EM28XX_DVB 0x20
291 struct em28xx_audio {
292 char name[50];
293 char *transfer_buffer[EM28XX_AUDIO_BUFS];
294 struct urb *urb[EM28XX_AUDIO_BUFS];
295 struct usb_device *udev;
296 unsigned int capture_transfer_done;
297 struct snd_pcm_substream *capture_pcm_substream;
299 unsigned int hwptr_done_capture;
300 struct snd_card *sndcard;
302 int users, shutdown;
303 enum em28xx_stream_state capture_stream;
304 spinlock_t slock;
307 struct em28xx;
309 struct em28xx_fh {
310 struct em28xx *dev;
311 unsigned int stream_on:1; /* Locks streams */
312 int radio;
314 struct videobuf_queue vb_vidq;
316 enum v4l2_buf_type type;
319 /* main device struct */
320 struct em28xx {
321 /* generic device properties */
322 char name[30]; /* name (including minor) of the device */
323 int model; /* index in the device_data struct */
324 int devno; /* marks the number of this device */
325 unsigned int is_em2800:1;
326 unsigned int has_msp34xx:1;
327 unsigned int has_tda9887:1;
328 unsigned int stream_on:1; /* Locks streams */
329 unsigned int has_audio_class:1;
330 unsigned int has_12mhz_i2s:1;
331 unsigned int max_range_640_480:1;
332 unsigned int has_dvb:1;
334 struct gpio_ctl *analog_gpio;
335 struct gpio_ctl *digital_gpio;
337 int video_inputs; /* number of video inputs */
338 struct list_head devlist;
340 u32 i2s_speed; /* I2S speed for audio digital stream */
342 enum em28xx_decoder decoder;
344 int tuner_type; /* type of the tuner */
345 int tuner_addr; /* tuner address */
346 int tda9887_conf;
347 /* i2c i/o */
348 struct i2c_adapter i2c_adap;
349 struct i2c_client i2c_client;
350 /* video for linux */
351 int users; /* user count for exclusive use */
352 struct video_device *vdev; /* video for linux device struct */
353 v4l2_std_id norm; /* selected tv norm */
354 int ctl_freq; /* selected frequency */
355 unsigned int ctl_input; /* selected input */
356 unsigned int ctl_ainput; /* slected audio input */
357 int mute;
358 int volume;
359 /* frame properties */
360 int width; /* current frame width */
361 int height; /* current frame height */
362 int hscale; /* horizontal scale factor (see datasheet) */
363 int vscale; /* vertical scale factor (see datasheet) */
364 int interlaced; /* 1=interlace fileds, 0=just top fileds */
365 unsigned int video_bytesread; /* Number of bytes read */
367 unsigned long hash; /* eeprom hash - for boards with generic ID */
368 unsigned long i2c_hash; /* i2c devicelist hash - for boards with generic ID */
370 struct em28xx_audio *adev;
372 /* states */
373 enum em28xx_dev_state state;
374 enum em28xx_io_method io;
376 struct work_struct request_module_wk;
378 /* locks */
379 struct mutex lock;
380 /* spinlock_t queue_lock; */
381 struct list_head inqueue, outqueue;
382 wait_queue_head_t open, wait_frame, wait_stream;
383 struct video_device *vbi_dev;
384 struct video_device *radio_dev;
386 unsigned char eedata[256];
388 /* Isoc control struct */
389 struct em28xx_dmaqueue vidq;
390 struct em28xx_usb_isoc_ctl isoc_ctl;
391 spinlock_t slock;
393 /* usb transfer */
394 struct usb_device *udev; /* the usb device */
395 int alt; /* alternate */
396 int max_pkt_size; /* max packet size of isoc transaction */
397 int num_alt; /* Number of alternative settings */
398 unsigned int *alt_max_pkt_size; /* array of wMaxPacketSize */
399 struct urb *urb[EM28XX_NUM_BUFS]; /* urb for isoc transfers */
400 char *transfer_buffer[EM28XX_NUM_BUFS]; /* transfer buffers for isoc transfer */
401 /* helper funcs that call usb_control_msg */
402 int (*em28xx_write_regs) (struct em28xx * dev, u16 reg, char *buf,
403 int len);
404 int (*em28xx_read_reg) (struct em28xx * dev, u16 reg);
405 int (*em28xx_read_reg_req_len) (struct em28xx * dev, u8 req, u16 reg,
406 char *buf, int len);
407 int (*em28xx_write_regs_req) (struct em28xx * dev, u8 req, u16 reg,
408 char *buf, int len);
409 int (*em28xx_read_reg_req) (struct em28xx * dev, u8 req, u16 reg);
411 enum em28xx_mode mode;
413 #if defined(CONFIG_VIDEO_EM28XX_DVB) || defined(CONFIG_VIDEO_EM28XX_DVB_MODULE)
414 struct videobuf_dvb dvb;
415 struct videobuf_queue_ops *qops;
416 struct em28xx_fh dvb_fh;
417 #endif
420 struct em28xx_ops {
421 struct list_head next;
422 char *name;
423 int id;
424 int (*init)(struct em28xx *);
425 int (*fini)(struct em28xx *);
428 /* Provided by em28xx-i2c.c */
430 void em28xx_i2c_call_clients(struct em28xx *dev, unsigned int cmd, void *arg);
431 void em28xx_do_i2c_scan(struct em28xx *dev);
432 int em28xx_i2c_register(struct em28xx *dev);
433 int em28xx_i2c_unregister(struct em28xx *dev);
435 /* Provided by em28xx-core.c */
437 u32 em28xx_request_buffers(struct em28xx *dev, u32 count);
438 void em28xx_queue_unusedframes(struct em28xx *dev);
439 void em28xx_release_buffers(struct em28xx *dev);
441 int em28xx_read_reg_req_len(struct em28xx *dev, u8 req, u16 reg,
442 char *buf, int len);
443 int em28xx_read_reg_req(struct em28xx *dev, u8 req, u16 reg);
444 int em28xx_read_reg(struct em28xx *dev, u16 reg);
445 int em28xx_write_regs_req(struct em28xx *dev, u8 req, u16 reg, char *buf,
446 int len);
447 int em28xx_write_regs(struct em28xx *dev, u16 reg, char *buf, int len);
448 int em28xx_audio_analog_set(struct em28xx *dev);
450 int em28xx_colorlevels_set_default(struct em28xx *dev);
451 int em28xx_capture_start(struct em28xx *dev, int start);
452 int em28xx_outfmt_set_yuv422(struct em28xx *dev);
453 int em28xx_resolution_set(struct em28xx *dev);
454 int em28xx_set_alternate(struct em28xx *dev);
456 /* Provided by em28xx-video.c */
457 int em28xx_register_extension(struct em28xx_ops *dev);
458 void em28xx_unregister_extension(struct em28xx_ops *dev);
460 /* Provided by em28xx-cards.c */
461 extern int em2800_variant_detect(struct usb_device* udev,int model);
462 extern void em28xx_pre_card_setup(struct em28xx *dev);
463 extern void em28xx_card_setup(struct em28xx *dev);
464 extern struct em28xx_board em28xx_boards[];
465 extern struct usb_device_id em28xx_id_table[];
466 extern const unsigned int em28xx_bcount;
467 void em28xx_set_ir(struct em28xx *dev, struct IR_i2c *ir);
468 int em28xx_tuner_callback(void *ptr, int command, int arg);
469 void em28xx_setup_xc3028(struct em28xx *dev, struct xc2028_ctrl *ctl);
471 /* Provided by em28xx-input.c */
472 /* TODO: Check if the standard get_key handlers on ir-common can be used */
473 int em28xx_get_key_terratec(struct IR_i2c *ir, u32 *ir_key, u32 *ir_raw);
474 int em28xx_get_key_em_haup(struct IR_i2c *ir, u32 *ir_key, u32 *ir_raw);
475 int em28xx_get_key_pinnacle_usb_grey(struct IR_i2c *ir, u32 *ir_key,
476 u32 *ir_raw);
478 /* em2800 registers */
479 #define EM2800_AUDIOSRC_REG 0x08
481 /* em28xx registers */
482 #define I2C_CLK_REG 0x06
483 #define CHIPID_REG 0x0a
484 #define USBSUSP_REG 0x0c /* */
486 #define AUDIOSRC_REG 0x0e
487 #define XCLK_REG 0x0f
489 #define VINMODE_REG 0x10
490 #define VINCTRL_REG 0x11
491 #define VINENABLE_REG 0x12 /* */
493 #define GAMMA_REG 0x14
494 #define RGAIN_REG 0x15
495 #define GGAIN_REG 0x16
496 #define BGAIN_REG 0x17
497 #define ROFFSET_REG 0x18
498 #define GOFFSET_REG 0x19
499 #define BOFFSET_REG 0x1a
501 #define OFLOW_REG 0x1b
502 #define HSTART_REG 0x1c
503 #define VSTART_REG 0x1d
504 #define CWIDTH_REG 0x1e
505 #define CHEIGHT_REG 0x1f
507 #define YGAIN_REG 0x20
508 #define YOFFSET_REG 0x21
509 #define UVGAIN_REG 0x22
510 #define UOFFSET_REG 0x23
511 #define VOFFSET_REG 0x24
512 #define SHARPNESS_REG 0x25
514 #define COMPR_REG 0x26
515 #define OUTFMT_REG 0x27
517 #define XMIN_REG 0x28
518 #define XMAX_REG 0x29
519 #define YMIN_REG 0x2a
520 #define YMAX_REG 0x2b
522 #define HSCALELOW_REG 0x30
523 #define HSCALEHIGH_REG 0x31
524 #define VSCALELOW_REG 0x32
525 #define VSCALEHIGH_REG 0x33
527 #define AC97LSB_REG 0x40
528 #define AC97MSB_REG 0x41
529 #define AC97ADDR_REG 0x42
530 #define AC97BUSY_REG 0x43
532 /* em202 registers */
533 #define MASTER_AC97 0x02
534 #define LINE_IN_AC97 0x10
535 #define VIDEO_AC97 0x14
537 /* register settings */
538 #define EM2800_AUDIO_SRC_TUNER 0x0d
539 #define EM2800_AUDIO_SRC_LINE 0x0c
540 #define EM28XX_AUDIO_SRC_TUNER 0xc0
541 #define EM28XX_AUDIO_SRC_LINE 0x80
543 /* printk macros */
545 #define em28xx_err(fmt, arg...) do {\
546 printk(KERN_ERR fmt , ##arg); } while (0)
548 #define em28xx_errdev(fmt, arg...) do {\
549 printk(KERN_ERR "%s: "fmt,\
550 dev->name , ##arg); } while (0)
552 #define em28xx_info(fmt, arg...) do {\
553 printk(KERN_INFO "%s: "fmt,\
554 dev->name , ##arg); } while (0)
555 #define em28xx_warn(fmt, arg...) do {\
556 printk(KERN_WARNING "%s: "fmt,\
557 dev->name , ##arg); } while (0)
559 inline static int em28xx_compression_disable(struct em28xx *dev)
561 /* side effect of disabling scaler and mixer */
562 return em28xx_write_regs(dev, COMPR_REG, "\x00", 1);
565 inline static int em28xx_contrast_get(struct em28xx *dev)
567 return em28xx_read_reg(dev, YGAIN_REG) & 0x1f;
570 inline static int em28xx_brightness_get(struct em28xx *dev)
572 return em28xx_read_reg(dev, YOFFSET_REG);
575 inline static int em28xx_saturation_get(struct em28xx *dev)
577 return em28xx_read_reg(dev, UVGAIN_REG) & 0x1f;
580 inline static int em28xx_u_balance_get(struct em28xx *dev)
582 return em28xx_read_reg(dev, UOFFSET_REG);
585 inline static int em28xx_v_balance_get(struct em28xx *dev)
587 return em28xx_read_reg(dev, VOFFSET_REG);
590 inline static int em28xx_gamma_get(struct em28xx *dev)
592 return em28xx_read_reg(dev, GAMMA_REG) & 0x3f;
595 inline static int em28xx_contrast_set(struct em28xx *dev, s32 val)
597 u8 tmp = (u8) val;
598 return em28xx_write_regs(dev, YGAIN_REG, &tmp, 1);
601 inline static int em28xx_brightness_set(struct em28xx *dev, s32 val)
603 u8 tmp = (u8) val;
604 return em28xx_write_regs(dev, YOFFSET_REG, &tmp, 1);
607 inline static int em28xx_saturation_set(struct em28xx *dev, s32 val)
609 u8 tmp = (u8) val;
610 return em28xx_write_regs(dev, UVGAIN_REG, &tmp, 1);
613 inline static int em28xx_u_balance_set(struct em28xx *dev, s32 val)
615 u8 tmp = (u8) val;
616 return em28xx_write_regs(dev, UOFFSET_REG, &tmp, 1);
619 inline static int em28xx_v_balance_set(struct em28xx *dev, s32 val)
621 u8 tmp = (u8) val;
622 return em28xx_write_regs(dev, VOFFSET_REG, &tmp, 1);
625 inline static int em28xx_gamma_set(struct em28xx *dev, s32 val)
627 u8 tmp = (u8) val;
628 return em28xx_write_regs(dev, GAMMA_REG, &tmp, 1);
631 /*FIXME: maxw should be dependent of alt mode */
632 inline static unsigned int norm_maxw(struct em28xx *dev)
634 if (dev->max_range_640_480)
635 return 640;
636 else
637 return 720;
640 inline static unsigned int norm_maxh(struct em28xx *dev)
642 if (dev->max_range_640_480)
643 return 480;
644 else
645 return (dev->norm & V4L2_STD_625_50) ? 576 : 480;
647 #endif