]> pilppa.org Git - linux-2.6-omap-h63xx.git/blob - drivers/media/video/em28xx/em28xx.h
V4L/DVB (7603): em28xx-dvb: don't use videobuf-dvb
[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 #define MAX_GPIO 2
229 struct gpio_ctl {
230                 /* Register to be set */
231         unsigned char reg;
232                 /* Initial/final value */
233         unsigned char val;
234                 /* reset value - if set, it will do:
235                    val1 - val2 - val1
236                  */
237         unsigned char rst;
238                 /* Sleep times
239                  */
240         unsigned int  t1, t2, t3;
241 };
242
243 struct em28xx_board {
244         char *name;
245         int vchannels;
246         int tuner_type;
247
248         /* i2c flags */
249         unsigned int tda9887_conf;
250
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;
257
258         struct gpio_ctl analog_gpio[MAX_GPIO];
259         struct gpio_ctl digital_gpio[MAX_GPIO];
260
261         enum em28xx_decoder decoder;
262
263         struct em28xx_input       input[MAX_EM28XX_INPUT];
264         struct em28xx_input       radio;
265 };
266
267 struct em28xx_eeprom {
268         u32 id;                 /* 0x9567eb1a */
269         u16 vendor_ID;
270         u16 product_ID;
271
272         u16 chip_conf;
273
274         u16 board_conf;
275
276         u16 string1, string2, string3;
277
278         u8 string_idx_table;
279 };
280
281 /* device states */
282 enum em28xx_dev_state {
283         DEV_INITIALIZED = 0x01,
284         DEV_DISCONNECTED = 0x02,
285         DEV_MISCONFIGURED = 0x04,
286 };
287
288 enum em28xx_capture_mode {
289         EM28XX_CAPTURE_OFF = 0,
290         EM28XX_ANALOG_CAPTURE,
291         EM28XX_DIGITAL_CAPTURE,
292 };
293
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
298
299 /* em28xx extensions */
300 #define EM28XX_AUDIO   0x10
301 #define EM28XX_DVB     0x20
302
303 struct em28xx_audio {
304         char name[50];
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;
310
311         unsigned int hwptr_done_capture;
312         struct snd_card            *sndcard;
313
314         int users, shutdown;
315         enum em28xx_stream_state capture_stream;
316         spinlock_t slock;
317 };
318
319 struct em28xx;
320
321 struct em28xx_fh {
322         struct em28xx *dev;
323         unsigned int  stream_on:1;      /* Locks streams */
324         int           radio;
325
326         struct videobuf_queue        vb_vidq;
327
328         enum v4l2_buf_type           type;
329 };
330
331 /* main device struct */
332 struct em28xx {
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;
345
346         struct gpio_ctl *analog_gpio;
347         struct gpio_ctl *digital_gpio;
348
349         int video_inputs;       /* number of video inputs */
350         struct list_head        devlist;
351
352         u32 i2s_speed;          /* I2S speed for audio digital stream */
353
354         enum em28xx_decoder decoder;
355
356         int tuner_type;         /* type of the tuner */
357         int tuner_addr;         /* tuner address */
358         int tda9887_conf;
359         /* i2c i/o */
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 */
369         int mute;
370         int volume;
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 */
378
379         unsigned long hash;     /* eeprom hash - for boards with generic ID */
380         unsigned long i2c_hash; /* i2c devicelist hash - for boards with generic ID */
381
382         struct em28xx_audio *adev;
383
384         /* states */
385         enum em28xx_dev_state state;
386         enum em28xx_io_method io;
387
388         struct work_struct         request_module_wk;
389
390         /* locks */
391         struct mutex lock;
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;
397
398         unsigned char eedata[256];
399
400         /* Isoc control struct */
401         struct em28xx_dmaqueue vidq;
402         struct em28xx_usb_isoc_ctl isoc_ctl;
403         spinlock_t slock;
404
405         /* usb transfer */
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,
415                                   int len);
416         int (*em28xx_read_reg) (struct em28xx * dev, u16 reg);
417         int (*em28xx_read_reg_req_len) (struct em28xx * dev, u8 req, u16 reg,
418                                         char *buf, int len);
419         int (*em28xx_write_regs_req) (struct em28xx * dev, u8 req, u16 reg,
420                                       char *buf, int len);
421         int (*em28xx_read_reg_req) (struct em28xx * dev, u8 req, u16 reg);
422
423         enum em28xx_mode mode;
424
425         struct em28xx_dvb *dvb;
426 };
427
428 struct em28xx_ops {
429         struct list_head next;
430         char *name;
431         int id;
432         int (*init)(struct em28xx *);
433         int (*fini)(struct em28xx *);
434 };
435
436 /* Provided by em28xx-i2c.c */
437
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);
442
443 /* Provided by em28xx-core.c */
444
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);
448
449 int em28xx_read_reg_req_len(struct em28xx *dev, u8 req, u16 reg,
450                             char *buf, int len);
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,
454                           int len);
455 int em28xx_write_regs(struct em28xx *dev, u16 reg, char *buf, int len);
456 int em28xx_audio_analog_set(struct em28xx *dev);
457
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),
466                      int cap_type);
467 void em28xx_uninit_isoc(struct em28xx *dev);
468
469 /* Provided by em28xx-video.c */
470 int em28xx_register_extension(struct em28xx_ops *dev);
471 void em28xx_unregister_extension(struct em28xx_ops *dev);
472
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);
483
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,
489                                      u32 *ir_raw);
490
491 /* em2800 registers */
492 #define EM2800_AUDIOSRC_REG 0x08
493
494 /* em28xx registers */
495 #define I2C_CLK_REG     0x06
496 #define CHIPID_REG      0x0a
497 #define USBSUSP_REG     0x0c    /* */
498
499 #define AUDIOSRC_REG    0x0e
500 #define XCLK_REG        0x0f
501
502 #define VINMODE_REG     0x10
503 #define VINCTRL_REG     0x11
504 #define VINENABLE_REG   0x12    /* */
505
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
513
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
519
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
526
527 #define COMPR_REG       0x26
528 #define OUTFMT_REG      0x27
529
530 #define XMIN_REG        0x28
531 #define XMAX_REG        0x29
532 #define YMIN_REG        0x2a
533 #define YMAX_REG        0x2b
534
535 #define HSCALELOW_REG   0x30
536 #define HSCALEHIGH_REG  0x31
537 #define VSCALELOW_REG   0x32
538 #define VSCALEHIGH_REG  0x33
539
540 #define AC97LSB_REG     0x40
541 #define AC97MSB_REG     0x41
542 #define AC97ADDR_REG    0x42
543 #define AC97BUSY_REG    0x43
544
545 /* em202 registers */
546 #define MASTER_AC97     0x02
547 #define LINE_IN_AC97    0x10
548 #define VIDEO_AC97      0x14
549
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
555
556 /* printk macros */
557
558 #define em28xx_err(fmt, arg...) do {\
559         printk(KERN_ERR fmt , ##arg); } while (0)
560
561 #define em28xx_errdev(fmt, arg...) do {\
562         printk(KERN_ERR "%s: "fmt,\
563                         dev->name , ##arg); } while (0)
564
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)
571
572 inline static int em28xx_compression_disable(struct em28xx *dev)
573 {
574         /* side effect of disabling scaler and mixer */
575         return em28xx_write_regs(dev, COMPR_REG, "\x00", 1);
576 }
577
578 inline static int em28xx_contrast_get(struct em28xx *dev)
579 {
580         return em28xx_read_reg(dev, YGAIN_REG) & 0x1f;
581 }
582
583 inline static int em28xx_brightness_get(struct em28xx *dev)
584 {
585         return em28xx_read_reg(dev, YOFFSET_REG);
586 }
587
588 inline static int em28xx_saturation_get(struct em28xx *dev)
589 {
590         return em28xx_read_reg(dev, UVGAIN_REG) & 0x1f;
591 }
592
593 inline static int em28xx_u_balance_get(struct em28xx *dev)
594 {
595         return em28xx_read_reg(dev, UOFFSET_REG);
596 }
597
598 inline static int em28xx_v_balance_get(struct em28xx *dev)
599 {
600         return em28xx_read_reg(dev, VOFFSET_REG);
601 }
602
603 inline static int em28xx_gamma_get(struct em28xx *dev)
604 {
605         return em28xx_read_reg(dev, GAMMA_REG) & 0x3f;
606 }
607
608 inline static int em28xx_contrast_set(struct em28xx *dev, s32 val)
609 {
610         u8 tmp = (u8) val;
611         return em28xx_write_regs(dev, YGAIN_REG, &tmp, 1);
612 }
613
614 inline static int em28xx_brightness_set(struct em28xx *dev, s32 val)
615 {
616         u8 tmp = (u8) val;
617         return em28xx_write_regs(dev, YOFFSET_REG, &tmp, 1);
618 }
619
620 inline static int em28xx_saturation_set(struct em28xx *dev, s32 val)
621 {
622         u8 tmp = (u8) val;
623         return em28xx_write_regs(dev, UVGAIN_REG, &tmp, 1);
624 }
625
626 inline static int em28xx_u_balance_set(struct em28xx *dev, s32 val)
627 {
628         u8 tmp = (u8) val;
629         return em28xx_write_regs(dev, UOFFSET_REG, &tmp, 1);
630 }
631
632 inline static int em28xx_v_balance_set(struct em28xx *dev, s32 val)
633 {
634         u8 tmp = (u8) val;
635         return em28xx_write_regs(dev, VOFFSET_REG, &tmp, 1);
636 }
637
638 inline static int em28xx_gamma_set(struct em28xx *dev, s32 val)
639 {
640         u8 tmp = (u8) val;
641         return em28xx_write_regs(dev, GAMMA_REG, &tmp, 1);
642 }
643
644 /*FIXME: maxw should be dependent of alt mode */
645 inline static unsigned int norm_maxw(struct em28xx *dev)
646 {
647         if (dev->max_range_640_480)
648                 return 640;
649         else
650                 return 720;
651 }
652
653 inline static unsigned int norm_maxh(struct em28xx *dev)
654 {
655         if (dev->max_range_640_480)
656                 return 480;
657         else
658                 return (dev->norm & V4L2_STD_625_50) ? 576 : 480;
659 }
660 #endif