]> www.pilppa.org Git - linux-2.6-omap-h63xx.git/blob - drivers/media/video/em28xx/em28xx.h
91dce95cd19c06c5cc1cf95aa256991b08f79d5c
[linux-2.6-omap-h63xx.git] / drivers / media / video / em28xx / em28xx.h
1 /*
2    em28xx.h - driver for Empia EM2800/EM2820/2840 USB video capture devices
3
4    Copyright (C) 2005 Markus Rechberger <mrechberger@gmail.com>
5                       Ludovico Cavedon <cavedon@sssup.it>
6                       Mauro Carvalho Chehab <mchehab@infradead.org>
7
8    Based on the em2800 driver from Sascha Sommer <saschasommer@freenet.de>
9
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.
14
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.
19
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.
23  */
24
25 #ifndef _EM28XX_H
26 #define _EM28XX_H
27
28 #include <linux/videodev2.h>
29 #include <media/videobuf-vmalloc.h>
30
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"
38
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
57
58 /* Limits minimum and default number of buffers */
59 #define EM28XX_MIN_BUF 4
60 #define EM28XX_DEF_BUF 8
61
62 /* maximum number of em28xx boards */
63 #define EM28XX_MAXBOARDS 4 /*FIXME: should be bigger */
64
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
69
70 /* number of buffers for isoc transfers */
71 #define EM28XX_NUM_BUFS 5
72
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!
76  */
77 #define EM28XX_NUM_PACKETS 40
78
79 /* default alternate; 0 means choose the best */
80 #define EM28XX_PINOUT 0
81
82 #define EM28XX_INTERLACED_DEFAULT 1
83
84 /*
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
94
95   alternate number 7
96
97                         Endpoint Address: 82
98                         Direction: in
99                         Attribute: 1
100                         Type: Isoc
101                         Max Packet Size: 3072
102                         Interval: 125us
103 */
104
105 /* time to wait when stopping the isoc transfer */
106 #define EM28XX_URB_TIMEOUT       msecs_to_jiffies(EM28XX_NUM_BUFS * EM28XX_NUM_PACKETS)
107
108 /* time in msecs to wait for i2c writes to finish */
109 #define EM2800_I2C_WRITE_TIMEOUT 20
110
111 enum em28xx_mode {
112         EM28XX_ANALOG_MODE,
113         EM28XX_DIGITAL_MODE,
114 };
115
116 enum em28xx_stream_state {
117         STREAM_OFF,
118         STREAM_INTERRUPT,
119         STREAM_ON,
120 };
121
122 struct em28xx;
123
124 struct em28xx_usb_isoc_ctl {
125                 /* max packet size of isoc transaction */
126         int                             max_pkt_size;
127
128                 /* number of allocated urbs */
129         int                             num_bufs;
130
131                 /* urb for isoc transfers */
132         struct urb                      **urb;
133
134                 /* transfer buffers for isoc transfer */
135         char                            **transfer_buffer;
136
137                 /* Last buffer command and region */
138         u8                              cmd;
139         int                             pos, size, pktsize;
140
141                 /* Last field: ODD or EVEN? */
142         int                             field;
143
144                 /* Stores incomplete commands */
145         u32                             tmp_buf;
146         int                             tmp_buf_len;
147
148                 /* Stores already requested buffers */
149         struct em28xx_buffer            *buf;
150
151                 /* Stores the number of received fields */
152         int                             nfields;
153
154                 /* isoc urb callback */
155         int (*isoc_copy) (struct em28xx *dev, struct urb *urb);
156
157 };
158
159 struct em28xx_fmt {
160         char  *name;
161         u32   fourcc;          /* v4l2 format id */
162 };
163
164 /* buffer for one video frame */
165 struct em28xx_buffer {
166         /* common v4l buffer stuff -- must be first */
167         struct videobuf_buffer vb;
168
169         struct list_head frame;
170         int top_field;
171         int receiving;
172 };
173
174 struct em28xx_dmaqueue {
175         struct list_head       active;
176         struct list_head       queued;
177
178         wait_queue_head_t          wq;
179
180         /* Counters to control buffer fill */
181         int                        pos;
182 };
183
184 /* io methods */
185 enum em28xx_io_method {
186         IO_NONE,
187         IO_READ,
188         IO_MMAP,
189 };
190
191 /* inputs */
192
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,
199         EM28XX_VMUX_SVIDEO,
200         EM28XX_VMUX_TELEVISION,
201         EM28XX_VMUX_CABLE,
202         EM28XX_VMUX_DVB,
203         EM28XX_VMUX_DEBUG,
204         EM28XX_RADIO,
205 };
206
207 enum em28xx_amux {
208         EM28XX_AMUX_VIDEO,
209         EM28XX_AMUX_LINE_IN,
210         EM28XX_AMUX_AC97_VIDEO,
211         EM28XX_AMUX_AC97_LINE_IN,
212 };
213
214 struct em28xx_input {
215         enum enum28xx_itype type;
216         unsigned int vmux;
217         enum em28xx_amux amux;
218 };
219
220 #define INPUT(nr) (&em28xx_boards[dev->model].input[nr])
221
222 enum em28xx_decoder {
223         EM28XX_TVP5150,
224         EM28XX_SAA7113,
225         EM28XX_SAA7114
226 };
227
228 struct em28xx_reg_seq {
229         int reg;
230         unsigned char val;
231         int sleep;
232 };
233
234 struct em28xx_board {
235         char *name;
236         int vchannels;
237         int tuner_type;
238
239         /* i2c flags */
240         unsigned int tda9887_conf;
241
242         unsigned int is_em2800:1;
243         unsigned int has_msp34xx:1;
244         unsigned int mts_firmware:1;
245         unsigned int has_12mhz_i2s:1;
246         unsigned int max_range_640_480:1;
247         unsigned int has_dvb:1;
248
249         enum em28xx_decoder decoder;
250
251         struct em28xx_input       input[MAX_EM28XX_INPUT];
252         struct em28xx_input       radio;
253 };
254
255 struct em28xx_eeprom {
256         u32 id;                 /* 0x9567eb1a */
257         u16 vendor_ID;
258         u16 product_ID;
259
260         u16 chip_conf;
261
262         u16 board_conf;
263
264         u16 string1, string2, string3;
265
266         u8 string_idx_table;
267 };
268
269 /* device states */
270 enum em28xx_dev_state {
271         DEV_INITIALIZED = 0x01,
272         DEV_DISCONNECTED = 0x02,
273         DEV_MISCONFIGURED = 0x04,
274 };
275
276 enum em28xx_capture_mode {
277         EM28XX_CAPTURE_OFF = 0,
278         EM28XX_ANALOG_CAPTURE,
279         EM28XX_DIGITAL_CAPTURE,
280 };
281
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
286
287 /* em28xx extensions */
288 #define EM28XX_AUDIO   0x10
289 #define EM28XX_DVB     0x20
290
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;
298
299         unsigned int hwptr_done_capture;
300         struct snd_card            *sndcard;
301
302         int users, shutdown;
303         enum em28xx_stream_state capture_stream;
304         spinlock_t slock;
305 };
306
307 struct em28xx;
308
309 struct em28xx_fh {
310         struct em28xx *dev;
311         unsigned int  stream_on:1;      /* Locks streams */
312         int           radio;
313
314         struct videobuf_queue        vb_vidq;
315
316         enum v4l2_buf_type           type;
317 };
318
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;
333
334         /* GPIO sequences for tuner callback */
335         struct em28xx_reg_seq *analog_gpio, *digital_gpio;
336
337         int video_inputs;       /* number of video inputs */
338         struct list_head        devlist;
339
340         u32 i2s_speed;          /* I2S speed for audio digital stream */
341
342         enum em28xx_decoder decoder;
343
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 */
366
367         unsigned long hash;     /* eeprom hash - for boards with generic ID */
368         unsigned long i2c_hash; /* i2c devicelist hash - for boards with generic ID */
369
370         struct em28xx_audio *adev;
371
372         /* states */
373         enum em28xx_dev_state state;
374         enum em28xx_io_method io;
375
376         struct work_struct         request_module_wk;
377
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;
385
386         unsigned char eedata[256];
387
388         /* Isoc control struct */
389         struct em28xx_dmaqueue vidq;
390         struct em28xx_usb_isoc_ctl isoc_ctl;
391         spinlock_t slock;
392
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);
410
411         enum em28xx_mode mode;
412
413         struct em28xx_dvb *dvb;
414 };
415
416 struct em28xx_ops {
417         struct list_head next;
418         char *name;
419         int id;
420         int (*init)(struct em28xx *);
421         int (*fini)(struct em28xx *);
422 };
423
424 /* Provided by em28xx-i2c.c */
425
426 void em28xx_i2c_call_clients(struct em28xx *dev, unsigned int cmd, void *arg);
427 void em28xx_do_i2c_scan(struct em28xx *dev);
428 int em28xx_i2c_register(struct em28xx *dev);
429 int em28xx_i2c_unregister(struct em28xx *dev);
430
431 /* Provided by em28xx-core.c */
432
433 u32 em28xx_request_buffers(struct em28xx *dev, u32 count);
434 void em28xx_queue_unusedframes(struct em28xx *dev);
435 void em28xx_release_buffers(struct em28xx *dev);
436
437 int em28xx_read_reg_req_len(struct em28xx *dev, u8 req, u16 reg,
438                             char *buf, int len);
439 int em28xx_read_reg_req(struct em28xx *dev, u8 req, u16 reg);
440 int em28xx_read_reg(struct em28xx *dev, u16 reg);
441 int em28xx_write_regs_req(struct em28xx *dev, u8 req, u16 reg, char *buf,
442                           int len);
443 int em28xx_write_regs(struct em28xx *dev, u16 reg, char *buf, int len);
444 int em28xx_audio_analog_set(struct em28xx *dev);
445
446 int em28xx_colorlevels_set_default(struct em28xx *dev);
447 int em28xx_capture_start(struct em28xx *dev, int start);
448 int em28xx_outfmt_set_yuv422(struct em28xx *dev);
449 int em28xx_resolution_set(struct em28xx *dev);
450 int em28xx_set_alternate(struct em28xx *dev);
451 int em28xx_init_isoc(struct em28xx *dev, int max_packets,
452                      int num_bufs, int max_pkt_size,
453                      int (*isoc_copy) (struct em28xx *dev, struct urb *urb),
454                      int cap_type);
455 void em28xx_uninit_isoc(struct em28xx *dev);
456
457 /* Provided by em28xx-video.c */
458 int em28xx_register_extension(struct em28xx_ops *dev);
459 void em28xx_unregister_extension(struct em28xx_ops *dev);
460
461 /* Provided by em28xx-cards.c */
462 extern int em2800_variant_detect(struct usb_device* udev,int model);
463 extern void em28xx_pre_card_setup(struct em28xx *dev);
464 extern void em28xx_card_setup(struct em28xx *dev);
465 extern struct em28xx_board em28xx_boards[];
466 extern struct usb_device_id em28xx_id_table[];
467 extern const unsigned int em28xx_bcount;
468 void em28xx_set_ir(struct em28xx *dev, struct IR_i2c *ir);
469 int em28xx_tuner_callback(void *ptr, int command, int arg);
470 void em28xx_setup_xc3028(struct em28xx *dev, struct xc2028_ctrl *ctl);
471
472 /* Provided by em28xx-input.c */
473 /* TODO: Check if the standard get_key handlers on ir-common can be used */
474 int em28xx_get_key_terratec(struct IR_i2c *ir, u32 *ir_key, u32 *ir_raw);
475 int em28xx_get_key_em_haup(struct IR_i2c *ir, u32 *ir_key, u32 *ir_raw);
476 int em28xx_get_key_pinnacle_usb_grey(struct IR_i2c *ir, u32 *ir_key,
477                                      u32 *ir_raw);
478
479 /* em2800 registers */
480 #define EM2800_AUDIOSRC_REG 0x08
481
482 /* em28xx registers */
483 #define I2C_CLK_REG     0x06
484 #define CHIPID_REG      0x0a
485 #define USBSUSP_REG     0x0c    /* */
486
487 #define AUDIOSRC_REG    0x0e
488 #define XCLK_REG        0x0f
489
490 #define VINMODE_REG     0x10
491 #define VINCTRL_REG     0x11
492 #define VINENABLE_REG   0x12    /* */
493
494 #define GAMMA_REG       0x14
495 #define RGAIN_REG       0x15
496 #define GGAIN_REG       0x16
497 #define BGAIN_REG       0x17
498 #define ROFFSET_REG     0x18
499 #define GOFFSET_REG     0x19
500 #define BOFFSET_REG     0x1a
501
502 #define OFLOW_REG       0x1b
503 #define HSTART_REG      0x1c
504 #define VSTART_REG      0x1d
505 #define CWIDTH_REG      0x1e
506 #define CHEIGHT_REG     0x1f
507
508 #define YGAIN_REG       0x20
509 #define YOFFSET_REG     0x21
510 #define UVGAIN_REG      0x22
511 #define UOFFSET_REG     0x23
512 #define VOFFSET_REG     0x24
513 #define SHARPNESS_REG   0x25
514
515 #define COMPR_REG       0x26
516 #define OUTFMT_REG      0x27
517
518 #define XMIN_REG        0x28
519 #define XMAX_REG        0x29
520 #define YMIN_REG        0x2a
521 #define YMAX_REG        0x2b
522
523 #define HSCALELOW_REG   0x30
524 #define HSCALEHIGH_REG  0x31
525 #define VSCALELOW_REG   0x32
526 #define VSCALEHIGH_REG  0x33
527
528 #define AC97LSB_REG     0x40
529 #define AC97MSB_REG     0x41
530 #define AC97ADDR_REG    0x42
531 #define AC97BUSY_REG    0x43
532
533 /* em202 registers */
534 #define MASTER_AC97     0x02
535 #define LINE_IN_AC97    0x10
536 #define VIDEO_AC97      0x14
537
538 /* register settings */
539 #define EM2800_AUDIO_SRC_TUNER  0x0d
540 #define EM2800_AUDIO_SRC_LINE   0x0c
541 #define EM28XX_AUDIO_SRC_TUNER  0xc0
542 #define EM28XX_AUDIO_SRC_LINE   0x80
543
544 /* printk macros */
545
546 #define em28xx_err(fmt, arg...) do {\
547         printk(KERN_ERR fmt , ##arg); } while (0)
548
549 #define em28xx_errdev(fmt, arg...) do {\
550         printk(KERN_ERR "%s: "fmt,\
551                         dev->name , ##arg); } while (0)
552
553 #define em28xx_info(fmt, arg...) do {\
554         printk(KERN_INFO "%s: "fmt,\
555                         dev->name , ##arg); } while (0)
556 #define em28xx_warn(fmt, arg...) do {\
557         printk(KERN_WARNING "%s: "fmt,\
558                         dev->name , ##arg); } while (0)
559
560 inline static int em28xx_compression_disable(struct em28xx *dev)
561 {
562         /* side effect of disabling scaler and mixer */
563         return em28xx_write_regs(dev, COMPR_REG, "\x00", 1);
564 }
565
566 inline static int em28xx_contrast_get(struct em28xx *dev)
567 {
568         return em28xx_read_reg(dev, YGAIN_REG) & 0x1f;
569 }
570
571 inline static int em28xx_brightness_get(struct em28xx *dev)
572 {
573         return em28xx_read_reg(dev, YOFFSET_REG);
574 }
575
576 inline static int em28xx_saturation_get(struct em28xx *dev)
577 {
578         return em28xx_read_reg(dev, UVGAIN_REG) & 0x1f;
579 }
580
581 inline static int em28xx_u_balance_get(struct em28xx *dev)
582 {
583         return em28xx_read_reg(dev, UOFFSET_REG);
584 }
585
586 inline static int em28xx_v_balance_get(struct em28xx *dev)
587 {
588         return em28xx_read_reg(dev, VOFFSET_REG);
589 }
590
591 inline static int em28xx_gamma_get(struct em28xx *dev)
592 {
593         return em28xx_read_reg(dev, GAMMA_REG) & 0x3f;
594 }
595
596 inline static int em28xx_contrast_set(struct em28xx *dev, s32 val)
597 {
598         u8 tmp = (u8) val;
599         return em28xx_write_regs(dev, YGAIN_REG, &tmp, 1);
600 }
601
602 inline static int em28xx_brightness_set(struct em28xx *dev, s32 val)
603 {
604         u8 tmp = (u8) val;
605         return em28xx_write_regs(dev, YOFFSET_REG, &tmp, 1);
606 }
607
608 inline static int em28xx_saturation_set(struct em28xx *dev, s32 val)
609 {
610         u8 tmp = (u8) val;
611         return em28xx_write_regs(dev, UVGAIN_REG, &tmp, 1);
612 }
613
614 inline static int em28xx_u_balance_set(struct em28xx *dev, s32 val)
615 {
616         u8 tmp = (u8) val;
617         return em28xx_write_regs(dev, UOFFSET_REG, &tmp, 1);
618 }
619
620 inline static int em28xx_v_balance_set(struct em28xx *dev, s32 val)
621 {
622         u8 tmp = (u8) val;
623         return em28xx_write_regs(dev, VOFFSET_REG, &tmp, 1);
624 }
625
626 inline static int em28xx_gamma_set(struct em28xx *dev, s32 val)
627 {
628         u8 tmp = (u8) val;
629         return em28xx_write_regs(dev, GAMMA_REG, &tmp, 1);
630 }
631
632 /*FIXME: maxw should be dependent of alt mode */
633 inline static unsigned int norm_maxw(struct em28xx *dev)
634 {
635         if (dev->max_range_640_480)
636                 return 640;
637         else
638                 return 720;
639 }
640
641 inline static unsigned int norm_maxh(struct em28xx *dev)
642 {
643         if (dev->max_range_640_480)
644                 return 480;
645         else
646                 return (dev->norm & V4L2_STD_625_50) ? 576 : 480;
647 }
648 #endif