This commit was manufactured by cvs2svn to create branch 'vserver'.
[linux-2.6.git] / drivers / media / video / em28xx / em28xx.h
diff --git a/drivers/media/video/em28xx/em28xx.h b/drivers/media/video/em28xx/em28xx.h
new file mode 100644 (file)
index 0000000..e1ddc2f
--- /dev/null
@@ -0,0 +1,520 @@
+/*
+   em28xx.h - driver for Empia EM2800/EM2820/2840 USB video capture devices
+
+   Copyright (C) 2005 Markus Rechberger <mrechberger@gmail.com>
+                     Ludovico Cavedon <cavedon@sssup.it>
+                     Mauro Carvalho Chehab <mchehab@brturbo.com.br>
+
+   Based on the em2800 driver from Sascha Sommer <saschasommer@freenet.de>
+
+   This program is free software; you can redistribute it and/or modify
+   it under the terms of the GNU General Public License as published by
+   the Free Software Foundation; either version 2 of the License, or
+   (at your option) any later version.
+
+   This program is distributed in the hope that it will be useful,
+   but WITHOUT ANY WARRANTY; without even the implied warranty of
+   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+   GNU General Public License for more details.
+
+   You should have received a copy of the GNU General Public License
+   along with this program; if not, write to the Free Software
+   Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+ */
+
+#ifndef _EM28XX_H
+#define _EM28XX_H
+
+#include <linux/videodev.h>
+#include <linux/i2c.h>
+#include <linux/mutex.h>
+#include <media/ir-kbd-i2c.h>
+
+/* Boards supported by driver */
+
+#define EM2800_BOARD_UNKNOWN                   0
+#define EM2820_BOARD_UNKNOWN                   1
+#define EM2820_BOARD_TERRATEC_CINERGY_250      2
+#define EM2820_BOARD_PINNACLE_USB_2            3
+#define EM2820_BOARD_HAUPPAUGE_WINTV_USB_2      4
+#define EM2820_BOARD_MSI_VOX_USB_2              5
+#define EM2800_BOARD_TERRATEC_CINERGY_200       6
+#define EM2800_BOARD_LEADTEK_WINFAST_USBII      7
+#define EM2800_BOARD_KWORLD_USB2800             8
+#define EM2820_BOARD_PINNACLE_DVC_90           9
+#define EM2880_BOARD_HAUPPAUGE_WINTV_HVR_900   10
+#define EM2880_BOARD_TERRATEC_HYBRID_XS                11
+#define EM2820_BOARD_KWORLD_PVRTV2800RF                12
+#define EM2880_BOARD_TERRATEC_PRODIGY_XS       13
+
+#define UNSET -1
+
+/* maximum number of em28xx boards */
+#define EM28XX_MAXBOARDS 1 /*FIXME: should be bigger */
+
+/* maximum number of frames that can be queued */
+#define EM28XX_NUM_FRAMES 5
+/* number of frames that get used for v4l2_read() */
+#define EM28XX_NUM_READ_FRAMES 2
+
+/* number of buffers for isoc transfers */
+#define EM28XX_NUM_BUFS 5
+
+/* number of packets for each buffer
+   windows requests only 40 packets .. so we better do the same
+   this is what I found out for all alternate numbers there!
+ */
+#define EM28XX_NUM_PACKETS 40
+
+/* default alternate; 0 means choose the best */
+#define EM28XX_PINOUT 0
+
+#define EM28XX_INTERLACED_DEFAULT 1
+
+/*
+#define (use usbview if you want to get the other alternate number infos)
+#define
+#define alternate number 2
+#define                        Endpoint Address: 82
+                       Direction: in
+                       Attribute: 1
+                       Type: Isoc
+                       Max Packet Size: 1448
+                       Interval: 125us
+
+  alternate number 7
+
+                       Endpoint Address: 82
+                       Direction: in
+                       Attribute: 1
+                       Type: Isoc
+                       Max Packet Size: 3072
+                       Interval: 125us
+*/
+
+/* time to wait when stopping the isoc transfer */
+#define EM28XX_URB_TIMEOUT       msecs_to_jiffies(EM28XX_NUM_BUFS * EM28XX_NUM_PACKETS)
+
+/* time in msecs to wait for i2c writes to finish */
+#define EM2800_I2C_WRITE_TIMEOUT 20
+
+/* the various frame states */
+enum em28xx_frame_state {
+       F_UNUSED = 0,
+       F_QUEUED,
+       F_GRABBING,
+       F_DONE,
+       F_ERROR,
+};
+
+/* stream states */
+enum em28xx_stream_state {
+       STREAM_OFF,
+       STREAM_INTERRUPT,
+       STREAM_ON,
+};
+
+/* frames */
+struct em28xx_frame_t {
+       void *bufmem;
+       struct v4l2_buffer buf;
+       enum em28xx_frame_state state;
+       struct list_head frame;
+       unsigned long vma_use_count;
+       int top_field;
+       int fieldbytesused;
+};
+
+/* io methods */
+enum em28xx_io_method {
+       IO_NONE,
+       IO_READ,
+       IO_MMAP,
+};
+
+/* inputs */
+
+#define MAX_EM28XX_INPUT 4
+enum enum28xx_itype {
+       EM28XX_VMUX_COMPOSITE1 = 1,
+       EM28XX_VMUX_COMPOSITE2,
+       EM28XX_VMUX_COMPOSITE3,
+       EM28XX_VMUX_COMPOSITE4,
+       EM28XX_VMUX_SVIDEO,
+       EM28XX_VMUX_TELEVISION,
+       EM28XX_VMUX_CABLE,
+       EM28XX_VMUX_DVB,
+       EM28XX_VMUX_DEBUG,
+       EM28XX_RADIO,
+};
+
+struct em28xx_input {
+       enum enum28xx_itype type;
+       unsigned int vmux;
+       unsigned int amux;
+};
+
+#define INPUT(nr) (&em28xx_boards[dev->model].input[nr])
+
+enum em28xx_decoder {
+       EM28XX_TVP5150,
+       EM28XX_SAA7113,
+       EM28XX_SAA7114
+};
+
+struct em28xx_board {
+       char *name;
+       int vchannels;
+       int norm;
+       int tuner_type;
+
+       /* i2c flags */
+       unsigned int is_em2800;
+       unsigned int tda9887_conf;
+
+       unsigned int has_tuner:1;
+       unsigned int has_msp34xx:1;
+
+       enum em28xx_decoder decoder;
+
+       struct em28xx_input       input[MAX_EM28XX_INPUT];
+};
+
+struct em28xx_eeprom {
+       u32 id;                 /* 0x9567eb1a */
+       u16 vendor_ID;
+       u16 product_ID;
+
+       u16 chip_conf;
+
+       u16 board_conf;
+
+       u16 string1, string2, string3;
+
+       u8 string_idx_table;
+};
+
+/* device states */
+enum em28xx_dev_state {
+       DEV_INITIALIZED = 0x01,
+       DEV_DISCONNECTED = 0x02,
+       DEV_MISCONFIGURED = 0x04,
+};
+
+/* tvnorms */
+struct em28xx_tvnorm {
+       char *name;
+       v4l2_std_id id;
+       /* mode for saa7113h */
+       int mode;
+};
+
+/* main device struct */
+struct em28xx {
+       /* generic device properties */
+       char name[30];          /* name (including minor) of the device */
+       int model;              /* index in the device_data struct */
+       int devno;              /* marks the number of this device */
+       unsigned int is_em2800;
+       int video_inputs;       /* number of video inputs */
+       struct list_head        devlist;
+       unsigned int has_tuner:1;
+       unsigned int has_msp34xx:1;
+       unsigned int has_tda9887:1;
+
+       u32 i2s_speed;          /* I2S speed for audio digital stream */
+
+       enum em28xx_decoder decoder;
+
+       int tuner_type;         /* type of the tuner */
+       int tuner_addr;         /* tuner address */
+       int tda9887_conf;
+       /* i2c i/o */
+       struct i2c_adapter i2c_adap;
+       struct i2c_client i2c_client;
+       /* video for linux */
+       int users;              /* user count for exclusive use */
+       struct video_device *vdev;      /* video for linux device struct */
+       struct video_picture vpic;      /* picture settings only used to init saa7113h */
+       struct em28xx_tvnorm *tvnorm;   /* selected tv norm */
+       int ctl_freq;           /* selected frequency */
+       unsigned int ctl_input; /* selected input */
+       unsigned int ctl_ainput;        /* slected audio input */
+       int mute;
+       int volume;
+       /* frame properties */
+       struct em28xx_frame_t frame[EM28XX_NUM_FRAMES]; /* list of frames */
+       int num_frames;         /* number of frames currently in use */
+       unsigned int frame_count;       /* total number of transfered frames */
+       struct em28xx_frame_t *frame_current;   /* the frame that is being filled */
+       int width;              /* current frame width */
+       int height;             /* current frame height */
+       int frame_size;         /* current frame size */
+       int field_size;         /* current field size */
+       int bytesperline;
+       int hscale;             /* horizontal scale factor (see datasheet) */
+       int vscale;             /* vertical scale factor (see datasheet) */
+       int interlaced;         /* 1=interlace fileds, 0=just top fileds */
+       int type;
+
+       /* states */
+       enum em28xx_dev_state state;
+       enum em28xx_stream_state stream;
+       enum em28xx_io_method io;
+       /* locks */
+       struct mutex lock, fileop_lock;
+       spinlock_t queue_lock;
+       struct list_head inqueue, outqueue;
+       wait_queue_head_t open, wait_frame, wait_stream;
+       struct video_device *vbi_dev;
+
+       unsigned char eedata[256];
+
+       /* usb transfer */
+       struct usb_device *udev;        /* the usb device */
+       int alt;                /* alternate */
+       int max_pkt_size;       /* max packet size of isoc transaction */
+       int num_alt;            /* Number of alternative settings */
+       unsigned int *alt_max_pkt_size; /* array of wMaxPacketSize */
+       struct urb *urb[EM28XX_NUM_BUFS];       /* urb for isoc transfers */
+       char *transfer_buffer[EM28XX_NUM_BUFS]; /* transfer buffers for isoc transfer */
+       /* helper funcs that call usb_control_msg */
+       int (*em28xx_write_regs) (struct em28xx * dev, u16 reg, char *buf,
+                                 int len);
+       int (*em28xx_read_reg) (struct em28xx * dev, u16 reg);
+       int (*em28xx_read_reg_req_len) (struct em28xx * dev, u8 req, u16 reg,
+                                       char *buf, int len);
+       int (*em28xx_write_regs_req) (struct em28xx * dev, u8 req, u16 reg,
+                                     char *buf, int len);
+       int (*em28xx_read_reg_req) (struct em28xx * dev, u8 req, u16 reg);
+};
+
+/* Provided by em28xx-i2c.c */
+
+void em28xx_i2c_call_clients(struct em28xx *dev, unsigned int cmd, void *arg);
+int em28xx_i2c_register(struct em28xx *dev);
+int em28xx_i2c_unregister(struct em28xx *dev);
+
+/* Provided by em28xx-input.c */
+
+void em28xx_set_ir(struct em28xx * dev,struct IR_i2c *ir);
+
+/* Provided by em28xx-core.c */
+
+u32 em28xx_request_buffers(struct em28xx *dev, u32 count);
+void em28xx_queue_unusedframes(struct em28xx *dev);
+void em28xx_release_buffers(struct em28xx *dev);
+
+int em28xx_read_reg_req_len(struct em28xx *dev, u8 req, u16 reg,
+                           char *buf, int len);
+int em28xx_read_reg_req(struct em28xx *dev, u8 req, u16 reg);
+int em28xx_read_reg(struct em28xx *dev, u16 reg);
+int em28xx_write_regs_req(struct em28xx *dev, u8 req, u16 reg, char *buf,
+                         int len);
+int em28xx_write_regs(struct em28xx *dev, u16 reg, char *buf, int len);
+int em28xx_write_reg_bits(struct em28xx *dev, u16 reg, u8 val,
+                         u8 bitmask);
+int em28xx_write_ac97(struct em28xx *dev, u8 reg, u8 * val);
+int em28xx_audio_analog_set(struct em28xx *dev);
+int em28xx_colorlevels_set_default(struct em28xx *dev);
+int em28xx_capture_start(struct em28xx *dev, int start);
+int em28xx_outfmt_set_yuv422(struct em28xx *dev);
+int em28xx_accumulator_set(struct em28xx *dev, u8 xmin, u8 xmax, u8 ymin,
+                          u8 ymax);
+int em28xx_capture_area_set(struct em28xx *dev, u8 hstart, u8 vstart,
+                           u16 width, u16 height);
+int em28xx_scaler_set(struct em28xx *dev, u16 h, u16 v);
+int em28xx_resolution_set(struct em28xx *dev);
+void em28xx_isocIrq(struct urb *urb, struct pt_regs *regs);
+int em28xx_init_isoc(struct em28xx *dev);
+void em28xx_uninit_isoc(struct em28xx *dev);
+int em28xx_set_alternate(struct em28xx *dev);
+
+/* Provided by em28xx-cards.c */
+extern int em2800_variant_detect(struct usb_device* udev,int model);
+extern void em28xx_pre_card_setup(struct em28xx *dev);
+extern void em28xx_card_setup(struct em28xx *dev);
+extern struct em28xx_board em28xx_boards[];
+extern struct usb_device_id em28xx_id_table[];
+extern const unsigned int em28xx_bcount;
+
+/* em28xx registers */
+#define CHIPID_REG     0x0a
+#define USBSUSP_REG    0x0c    /* */
+
+#define AUDIOSRC_REG   0x0e
+#define XCLK_REG       0x0f
+
+#define VINMODE_REG    0x10
+#define VINCTRL_REG    0x11
+#define VINENABLE_REG  0x12    /* */
+
+#define GAMMA_REG      0x14
+#define RGAIN_REG      0x15
+#define GGAIN_REG      0x16
+#define BGAIN_REG      0x17
+#define ROFFSET_REG    0x18
+#define GOFFSET_REG    0x19
+#define BOFFSET_REG    0x1a
+
+#define OFLOW_REG      0x1b
+#define HSTART_REG     0x1c
+#define VSTART_REG     0x1d
+#define CWIDTH_REG     0x1e
+#define CHEIGHT_REG    0x1f
+
+#define YGAIN_REG      0x20
+#define YOFFSET_REG    0x21
+#define UVGAIN_REG     0x22
+#define UOFFSET_REG    0x23
+#define VOFFSET_REG    0x24
+#define SHARPNESS_REG  0x25
+
+#define COMPR_REG      0x26
+#define OUTFMT_REG     0x27
+
+#define XMIN_REG       0x28
+#define XMAX_REG       0x29
+#define YMIN_REG       0x2a
+#define YMAX_REG       0x2b
+
+#define HSCALELOW_REG  0x30
+#define HSCALEHIGH_REG 0x31
+#define VSCALELOW_REG  0x32
+#define VSCALEHIGH_REG 0x33
+
+#define AC97LSB_REG    0x40
+#define AC97MSB_REG    0x41
+#define AC97ADDR_REG   0x42
+#define AC97BUSY_REG   0x43
+
+/* em202 registers */
+#define MASTER_AC97    0x02
+#define VIDEO_AC97     0x14
+
+/* register settings */
+#define EM28XX_AUDIO_SRC_TUNER 0xc0
+#define EM28XX_AUDIO_SRC_LINE  0x80
+
+/* printk macros */
+
+#define em28xx_err(fmt, arg...) do {\
+       printk(KERN_ERR fmt , ##arg); } while (0)
+
+#define em28xx_errdev(fmt, arg...) do {\
+       printk(KERN_ERR "%s: "fmt,\
+                       dev->name , ##arg); } while (0)
+
+#define em28xx_info(fmt, arg...) do {\
+       printk(KERN_INFO "%s: "fmt,\
+                       dev->name , ##arg); } while (0)
+#define em28xx_warn(fmt, arg...) do {\
+       printk(KERN_WARNING "%s: "fmt,\
+                       dev->name , ##arg); } while (0)
+
+inline static int em28xx_audio_source(struct em28xx *dev, int input)
+{
+       return em28xx_write_reg_bits(dev, AUDIOSRC_REG, input, 0xc0);
+}
+
+inline static int em28xx_audio_usb_mute(struct em28xx *dev, int mute)
+{
+       return em28xx_write_reg_bits(dev, XCLK_REG, mute ? 0x00 : 0x80, 0x80);
+}
+
+inline static int em28xx_audio_analog_setup(struct em28xx *dev)
+{
+       /* unmute video mixer with default volume level */
+       return em28xx_write_ac97(dev, VIDEO_AC97, "\x08\x08");
+}
+
+inline static int em28xx_compression_disable(struct em28xx *dev)
+{
+       /* side effect of disabling scaler and mixer */
+       return em28xx_write_regs(dev, COMPR_REG, "\x00", 1);
+}
+
+inline static int em28xx_contrast_get(struct em28xx *dev)
+{
+       return em28xx_read_reg(dev, YGAIN_REG) & 0x1f;
+}
+
+inline static int em28xx_brightness_get(struct em28xx *dev)
+{
+       return em28xx_read_reg(dev, YOFFSET_REG);
+}
+
+inline static int em28xx_saturation_get(struct em28xx *dev)
+{
+       return em28xx_read_reg(dev, UVGAIN_REG) & 0x1f;
+}
+
+inline static int em28xx_u_balance_get(struct em28xx *dev)
+{
+       return em28xx_read_reg(dev, UOFFSET_REG);
+}
+
+inline static int em28xx_v_balance_get(struct em28xx *dev)
+{
+       return em28xx_read_reg(dev, VOFFSET_REG);
+}
+
+inline static int em28xx_gamma_get(struct em28xx *dev)
+{
+       return em28xx_read_reg(dev, GAMMA_REG) & 0x3f;
+}
+
+inline static int em28xx_contrast_set(struct em28xx *dev, s32 val)
+{
+       u8 tmp = (u8) val;
+       return em28xx_write_regs(dev, YGAIN_REG, &tmp, 1);
+}
+
+inline static int em28xx_brightness_set(struct em28xx *dev, s32 val)
+{
+       u8 tmp = (u8) val;
+       return em28xx_write_regs(dev, YOFFSET_REG, &tmp, 1);
+}
+
+inline static int em28xx_saturation_set(struct em28xx *dev, s32 val)
+{
+       u8 tmp = (u8) val;
+       return em28xx_write_regs(dev, UVGAIN_REG, &tmp, 1);
+}
+
+inline static int em28xx_u_balance_set(struct em28xx *dev, s32 val)
+{
+       u8 tmp = (u8) val;
+       return em28xx_write_regs(dev, UOFFSET_REG, &tmp, 1);
+}
+
+inline static int em28xx_v_balance_set(struct em28xx *dev, s32 val)
+{
+       u8 tmp = (u8) val;
+       return em28xx_write_regs(dev, VOFFSET_REG, &tmp, 1);
+}
+
+inline static int em28xx_gamma_set(struct em28xx *dev, s32 val)
+{
+       u8 tmp = (u8) val;
+       return em28xx_write_regs(dev, GAMMA_REG, &tmp, 1);
+}
+
+/*FIXME: maxw should be dependent of alt mode */
+inline static unsigned int norm_maxw(struct em28xx *dev)
+{
+       switch(dev->model){
+               case (EM2820_BOARD_MSI_VOX_USB_2): return(640);
+               default: return(720);
+       }
+}
+
+inline static unsigned int norm_maxh(struct em28xx *dev)
+{
+       switch(dev->model){
+               case (EM2820_BOARD_MSI_VOX_USB_2): return(480);
+               default: return (dev->tvnorm->id & V4L2_STD_625_50) ? 576 : 480;
+       }
+}
+
+#endif