[deliverable/linux.git] / drivers / media / video / em28xx / em28xx.h

/*
   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@infradead.org>

   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;

	unsigned long hash;	/* eeprom hash - for boards with generic ID */

	/* 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_resolution_set(struct em28xx *dev);
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
Commit	Line	Data
a6c2ba28	1	/*
0e7072ef	2	em28xx.h - driver for Empia EM2800/EM2820/2840 USB video capture devices
a6c2ba28	3
a6c2ba28	4	Copyright (C) 2005 Markus Rechberger <mrechberger@gmail.com>
4ac97914	5	Ludovico Cavedon <cavedon@sssup.it>
2e7c6dc3	6	Mauro Carvalho Chehab <mchehab@infradead.org>
a6c2ba28	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
3acf2809 MCC	25	#ifndef _EM28XX_H
3acf2809 MCC	26	#define _EM28XX_H
a6c2ba28	27
	28	#include <linux/videodev.h>
	29	#include <linux/i2c.h>
3593cab5	30	#include <linux/mutex.h>
d5e52653	31	#include <media/ir-kbd-i2c.h>
a6c2ba28	32
596d92d5 MCC	33	/* Boards supported by driver */
	34
	35	#define EM2800_BOARD_UNKNOWN 0
	36	#define EM2820_BOARD_UNKNOWN 1
	37	#define EM2820_BOARD_TERRATEC_CINERGY_250 2
	38	#define EM2820_BOARD_PINNACLE_USB_2 3
	39	#define EM2820_BOARD_HAUPPAUGE_WINTV_USB_2 4
	40	#define EM2820_BOARD_MSI_VOX_USB_2 5
	41	#define EM2800_BOARD_TERRATEC_CINERGY_200 6
	42	#define EM2800_BOARD_LEADTEK_WINFAST_USBII 7
	43	#define EM2800_BOARD_KWORLD_USB2800 8
45632c4f	44	#define EM2820_BOARD_PINNACLE_DVC_90 9
4d17d083 MR	45	#define EM2880_BOARD_HAUPPAUGE_WINTV_HVR_900 10
	46	#define EM2880_BOARD_TERRATEC_HYBRID_XS 11
	47	#define EM2820_BOARD_KWORLD_PVRTV2800RF 12
282b7cb3	48	#define EM2880_BOARD_TERRATEC_PRODIGY_XS 13
596d92d5 MCC	49
	50	#define UNSET -1
	51
	52	/* maximum number of em28xx boards */
3acf2809	53	#define EM28XX_MAXBOARDS 1 /FIXME: should be bigger /
596d92d5	54
a6c2ba28	55	/* maximum number of frames that can be queued */
3acf2809	56	#define EM28XX_NUM_FRAMES 5
a6c2ba28	57	/* number of frames that get used for v4l2_read() */
3acf2809	58	#define EM28XX_NUM_READ_FRAMES 2
a6c2ba28	59
a6c2ba28	60	/* number of buffers for isoc transfers */
3acf2809	61	#define EM28XX_NUM_BUFS 5
a6c2ba28	62
d5e52653 MCC	63	/* number of packets for each buffer
	64	windows requests only 40 packets .. so we better do the same
	65	this is what I found out for all alternate numbers there!
	66	*/
3acf2809	67	#define EM28XX_NUM_PACKETS 40
a6c2ba28	68
a6c2ba28	69	/* default alternate; 0 means choose the best */
3acf2809	70	#define EM28XX_PINOUT 0
a6c2ba28	71
3acf2809	72	#define EM28XX_INTERLACED_DEFAULT 1
a6c2ba28	73
	74	/*
	75	#define (use usbview if you want to get the other alternate number infos)
	76	#define
	77	#define alternate number 2
	78	#define Endpoint Address: 82
	79	Direction: in
	80	Attribute: 1
	81	Type: Isoc
	82	Max Packet Size: 1448
	83	Interval: 125us
	84
	85	alternate number 7
	86
	87	Endpoint Address: 82
	88	Direction: in
	89	Attribute: 1
	90	Type: Isoc
	91	Max Packet Size: 3072
	92	Interval: 125us
	93	*/
	94
	95	/* time to wait when stopping the isoc transfer */
3acf2809	96	#define EM28XX_URB_TIMEOUT msecs_to_jiffies(EM28XX_NUM_BUFS * EM28XX_NUM_PACKETS)
a6c2ba28	97
596d92d5 MCC	98	/* time in msecs to wait for i2c writes to finish */
	99	#define EM2800_I2C_WRITE_TIMEOUT 20
	100
a6c2ba28	101	/* the various frame states */
3acf2809	102	enum em28xx_frame_state {
a6c2ba28	103	F_UNUSED = 0,
	104	F_QUEUED,
	105	F_GRABBING,
	106	F_DONE,
	107	F_ERROR,
	108	};
	109
	110	/* stream states */
3acf2809	111	enum em28xx_stream_state {
a6c2ba28	112	STREAM_OFF,
	113	STREAM_INTERRUPT,
	114	STREAM_ON,
	115	};
	116
	117	/* frames */
3acf2809	118	struct em28xx_frame_t {
a6c2ba28	119	void *bufmem;
a6c2ba28	120	struct v4l2_buffer buf;
3acf2809	121	enum em28xx_frame_state state;
a6c2ba28	122	struct list_head frame;
	123	unsigned long vma_use_count;
	124	int top_field;
	125	int fieldbytesused;
	126	};
	127
	128	/* io methods */
3acf2809	129	enum em28xx_io_method {
a6c2ba28	130	IO_NONE,
	131	IO_READ,
	132	IO_MMAP,
	133	};
	134
	135	/* inputs */
	136
3acf2809 MCC	137	#define MAX_EM28XX_INPUT 4
	138	enum enum28xx_itype {
	139	EM28XX_VMUX_COMPOSITE1 = 1,
	140	EM28XX_VMUX_COMPOSITE2,
	141	EM28XX_VMUX_COMPOSITE3,
	142	EM28XX_VMUX_COMPOSITE4,
	143	EM28XX_VMUX_SVIDEO,
	144	EM28XX_VMUX_TELEVISION,
	145	EM28XX_VMUX_CABLE,
	146	EM28XX_VMUX_DVB,
	147	EM28XX_VMUX_DEBUG,
	148	EM28XX_RADIO,
a6c2ba28	149	};
a6c2ba28	150
3acf2809 MCC	151	struct em28xx_input {
3acf2809 MCC	152	enum enum28xx_itype type;
a6c2ba28	153	unsigned int vmux;
	154	unsigned int amux;
	155	};
	156
3acf2809	157	#define INPUT(nr) (&em28xx_boards[dev->model].input[nr])
a6c2ba28	158
3acf2809 MCC	159	enum em28xx_decoder {
	160	EM28XX_TVP5150,
	161	EM28XX_SAA7113,
	162	EM28XX_SAA7114
a6c2ba28	163	};
a6c2ba28	164
3acf2809	165	struct em28xx_board {
a6c2ba28	166	char *name;
a6c2ba28	167	int vchannels;
	168	int norm;
	169	int tuner_type;
	170
	171	/* i2c flags */
596d92d5	172	unsigned int is_em2800;
a6c2ba28	173	unsigned int tda9887_conf;
	174
	175	unsigned int has_tuner:1;
	176	unsigned int has_msp34xx:1;
	177
3acf2809	178	enum em28xx_decoder decoder;
a6c2ba28	179
3acf2809	180	struct em28xx_input input[MAX_EM28XX_INPUT];
a6c2ba28	181	};
a6c2ba28	182
3acf2809	183	struct em28xx_eeprom {
a6c2ba28	184	u32 id; /* 0x9567eb1a */
	185	u16 vendor_ID;
	186	u16 product_ID;
	187
	188	u16 chip_conf;
	189
	190	u16 board_conf;
	191
	192	u16 string1, string2, string3;
	193
	194	u8 string_idx_table;
	195	};
	196
	197	/* device states */
3acf2809	198	enum em28xx_dev_state {
a6c2ba28	199	DEV_INITIALIZED = 0x01,
	200	DEV_DISCONNECTED = 0x02,
	201	DEV_MISCONFIGURED = 0x04,
	202	};
	203
	204	/* tvnorms */
3acf2809	205	struct em28xx_tvnorm {
a6c2ba28	206	char *name;
	207	v4l2_std_id id;
	208	/* mode for saa7113h */
	209	int mode;
	210	};
	211
	212	/* main device struct */
3acf2809	213	struct em28xx {
a6c2ba28	214	/* generic device properties */
	215	char name[30]; /* name (including minor) of the device */
	216	int model; /* index in the device_data struct */
e5589bef	217	int devno; /* marks the number of this device */
596d92d5	218	unsigned int is_em2800;
a6c2ba28	219	int video_inputs; /* number of video inputs */
9c75541f	220	struct list_head devlist;
a6c2ba28	221	unsigned int has_tuner:1;
	222	unsigned int has_msp34xx:1;
	223	unsigned int has_tda9887:1;
	224
9bb13a6d MCC	225	u32 i2s_speed; /* I2S speed for audio digital stream */
9bb13a6d MCC	226
3acf2809	227	enum em28xx_decoder decoder;
a6c2ba28	228
	229	int tuner_type; /* type of the tuner */
	230	int tuner_addr; /* tuner address */
	231	int tda9887_conf;
	232	/* i2c i/o */
	233	struct i2c_adapter i2c_adap;
	234	struct i2c_client i2c_client;
	235	/* video for linux */
	236	int users; /* user count for exclusive use */
	237	struct video_device vdev; / video for linux device struct */
	238	struct video_picture vpic; /* picture settings only used to init saa7113h */
3acf2809	239	struct em28xx_tvnorm tvnorm; / selected tv norm */
a6c2ba28	240	int ctl_freq; /* selected frequency */
	241	unsigned int ctl_input; /* selected input */
	242	unsigned int ctl_ainput; /* slected audio input */
	243	int mute;
	244	int volume;
	245	/* frame properties */
3acf2809	246	struct em28xx_frame_t frame[EM28XX_NUM_FRAMES]; /* list of frames */
a6c2ba28	247	int num_frames; /* number of frames currently in use */
a6c2ba28	248	unsigned int frame_count; /* total number of transfered frames */
3acf2809	249	struct em28xx_frame_t frame_current; / the frame that is being filled */
a6c2ba28	250	int width; /* current frame width */
	251	int height; /* current frame height */
	252	int frame_size; /* current frame size */
	253	int field_size; /* current field size */
	254	int bytesperline;
	255	int hscale; /* horizontal scale factor (see datasheet) */
	256	int vscale; /* vertical scale factor (see datasheet) */
	257	int interlaced; /* 1=interlace fileds, 0=just top fileds */
	258	int type;
	259
03910cc3 MCC	260	unsigned long hash; /* eeprom hash - for boards with generic ID */
03910cc3 MCC	261
a6c2ba28	262	/* states */
3acf2809 MCC	263	enum em28xx_dev_state state;
	264	enum em28xx_stream_state stream;
	265	enum em28xx_io_method io;
a6c2ba28	266	/* locks */
3593cab5	267	struct mutex lock, fileop_lock;
a6c2ba28	268	spinlock_t queue_lock;
	269	struct list_head inqueue, outqueue;
	270	wait_queue_head_t open, wait_frame, wait_stream;
	271	struct video_device *vbi_dev;
	272
	273	unsigned char eedata[256];
	274
	275	/* usb transfer */
	276	struct usb_device udev; / the usb device */
	277	int alt; /* alternate */
	278	int max_pkt_size; /* max packet size of isoc transaction */
9d4d9c05 MCC	279	int num_alt; /* Number of alternative settings */
9d4d9c05 MCC	280	unsigned int alt_max_pkt_size; / array of wMaxPacketSize */
3acf2809 MCC	281	struct urb urb[EM28XX_NUM_BUFS]; / urb for isoc transfers */
3acf2809 MCC	282	char transfer_buffer[EM28XX_NUM_BUFS]; / transfer buffers for isoc transfer */
a6c2ba28	283	/* helper funcs that call usb_control_msg */
3acf2809	284	int (em28xx_write_regs) (struct em28xx dev, u16 reg, char *buf,
a6c2ba28	285	int len);
3acf2809 MCC	286	int (em28xx_read_reg) (struct em28xx dev, u16 reg);
3acf2809 MCC	287	int (em28xx_read_reg_req_len) (struct em28xx dev, u8 req, u16 reg,
a6c2ba28	288	char *buf, int len);
3acf2809	289	int (em28xx_write_regs_req) (struct em28xx dev, u8 req, u16 reg,
a6c2ba28	290	char *buf, int len);
3acf2809	291	int (em28xx_read_reg_req) (struct em28xx dev, u8 req, u16 reg);
a6c2ba28	292	};
a6c2ba28	293
3acf2809	294	/* Provided by em28xx-i2c.c */
a6c2ba28	295
3acf2809 MCC	296	void em28xx_i2c_call_clients(struct em28xx dev, unsigned int cmd, void arg);
	297	int em28xx_i2c_register(struct em28xx *dev);
	298	int em28xx_i2c_unregister(struct em28xx *dev);
a6c2ba28	299
3acf2809	300	/* Provided by em28xx-input.c */
d5e52653	301
3acf2809	302	void em28xx_set_ir(struct em28xx * dev,struct IR_i2c *ir);
d5e52653	303
3acf2809	304	/* Provided by em28xx-core.c */
a6c2ba28	305
3acf2809 MCC	306	u32 em28xx_request_buffers(struct em28xx *dev, u32 count);
	307	void em28xx_queue_unusedframes(struct em28xx *dev);
	308	void em28xx_release_buffers(struct em28xx *dev);
a6c2ba28	309
3acf2809	310	int em28xx_read_reg_req_len(struct em28xx *dev, u8 req, u16 reg,
a6c2ba28	311	char *buf, int len);
3acf2809 MCC	312	int em28xx_read_reg_req(struct em28xx *dev, u8 req, u16 reg);
	313	int em28xx_read_reg(struct em28xx *dev, u16 reg);
	314	int em28xx_write_regs_req(struct em28xx dev, u8 req, u16 reg, char buf,
a6c2ba28	315	int len);
3acf2809 MCC	316	int em28xx_write_regs(struct em28xx dev, u16 reg, char buf, int len);
3acf2809 MCC	317	int em28xx_write_reg_bits(struct em28xx *dev, u16 reg, u8 val,
a6c2ba28	318	u8 bitmask);
3acf2809 MCC	319	int em28xx_write_ac97(struct em28xx dev, u8 reg, u8 val);
	320	int em28xx_audio_analog_set(struct em28xx *dev);
	321	int em28xx_colorlevels_set_default(struct em28xx *dev);
	322	int em28xx_capture_start(struct em28xx *dev, int start);
	323	int em28xx_outfmt_set_yuv422(struct em28xx *dev);
3acf2809	324	int em28xx_resolution_set(struct em28xx *dev);
3acf2809 MCC	325	int em28xx_init_isoc(struct em28xx *dev);
	326	void em28xx_uninit_isoc(struct em28xx *dev);
	327	int em28xx_set_alternate(struct em28xx *dev);
	328
	329	/* Provided by em28xx-cards.c */
596d92d5	330	extern int em2800_variant_detect(struct usb_device* udev,int model);
a94e95b4	331	extern void em28xx_pre_card_setup(struct em28xx *dev);
3acf2809 MCC	332	extern void em28xx_card_setup(struct em28xx *dev);
	333	extern struct em28xx_board em28xx_boards[];
	334	extern struct usb_device_id em28xx_id_table[];
	335	extern const unsigned int em28xx_bcount;
a6c2ba28	336
3acf2809	337	/* em28xx registers */
596d92d5	338	#define CHIPID_REG 0x0a
a6c2ba28	339	#define USBSUSP_REG 0x0c /* */
	340
	341	#define AUDIOSRC_REG 0x0e
	342	#define XCLK_REG 0x0f
	343
	344	#define VINMODE_REG 0x10
	345	#define VINCTRL_REG 0x11
	346	#define VINENABLE_REG 0x12 /* */
	347
	348	#define GAMMA_REG 0x14
	349	#define RGAIN_REG 0x15
	350	#define GGAIN_REG 0x16
	351	#define BGAIN_REG 0x17
	352	#define ROFFSET_REG 0x18
	353	#define GOFFSET_REG 0x19
	354	#define BOFFSET_REG 0x1a
	355
	356	#define OFLOW_REG 0x1b
	357	#define HSTART_REG 0x1c
	358	#define VSTART_REG 0x1d
	359	#define CWIDTH_REG 0x1e
	360	#define CHEIGHT_REG 0x1f
	361
	362	#define YGAIN_REG 0x20
	363	#define YOFFSET_REG 0x21
	364	#define UVGAIN_REG 0x22
	365	#define UOFFSET_REG 0x23
	366	#define VOFFSET_REG 0x24
	367	#define SHARPNESS_REG 0x25
	368
	369	#define COMPR_REG 0x26
	370	#define OUTFMT_REG 0x27
	371
	372	#define XMIN_REG 0x28
	373	#define XMAX_REG 0x29
	374	#define YMIN_REG 0x2a
	375	#define YMAX_REG 0x2b
	376
	377	#define HSCALELOW_REG 0x30
	378	#define HSCALEHIGH_REG 0x31
	379	#define VSCALELOW_REG 0x32
	380	#define VSCALEHIGH_REG 0x33
	381
	382	#define AC97LSB_REG 0x40
	383	#define AC97MSB_REG 0x41
	384	#define AC97ADDR_REG 0x42
	385	#define AC97BUSY_REG 0x43
	386
	387	/* em202 registers */
	388	#define MASTER_AC97 0x02
	389	#define VIDEO_AC97 0x14
	390
	391	/* register settings */
3acf2809 MCC	392	#define EM28XX_AUDIO_SRC_TUNER 0xc0
3acf2809 MCC	393	#define EM28XX_AUDIO_SRC_LINE 0x80
a6c2ba28	394
	395	/* printk macros */
	396
3acf2809	397	#define em28xx_err(fmt, arg...) do {\
f85c657f	398	printk(KERN_ERR fmt , ##arg); } while (0)
a6c2ba28	399
3acf2809	400	#define em28xx_errdev(fmt, arg...) do {\
4ac97914	401	printk(KERN_ERR "%s: "fmt,\
f85c657f	402	dev->name , ##arg); } while (0)
a6c2ba28	403
3acf2809	404	#define em28xx_info(fmt, arg...) do {\
4ac97914	405	printk(KERN_INFO "%s: "fmt,\
f85c657f	406	dev->name , ##arg); } while (0)
3acf2809	407	#define em28xx_warn(fmt, arg...) do {\
4ac97914	408	printk(KERN_WARNING "%s: "fmt,\
f85c657f	409	dev->name , ##arg); } while (0)
a6c2ba28	410
3acf2809	411	inline static int em28xx_audio_source(struct em28xx *dev, int input)
a6c2ba28	412	{
3acf2809	413	return em28xx_write_reg_bits(dev, AUDIOSRC_REG, input, 0xc0);
a6c2ba28	414	}
a6c2ba28	415
3acf2809	416	inline static int em28xx_audio_usb_mute(struct em28xx *dev, int mute)
a6c2ba28	417	{
3acf2809	418	return em28xx_write_reg_bits(dev, XCLK_REG, mute ? 0x00 : 0x80, 0x80);
a6c2ba28	419	}
a6c2ba28	420
3acf2809	421	inline static int em28xx_audio_analog_setup(struct em28xx *dev)
a6c2ba28	422	{
a6c2ba28	423	/* unmute video mixer with default volume level */
3acf2809	424	return em28xx_write_ac97(dev, VIDEO_AC97, "\x08\x08");
a6c2ba28	425	}
a6c2ba28	426
3acf2809	427	inline static int em28xx_compression_disable(struct em28xx *dev)
a6c2ba28	428	{
a6c2ba28	429	/* side effect of disabling scaler and mixer */
3acf2809	430	return em28xx_write_regs(dev, COMPR_REG, "\x00", 1);
a6c2ba28	431	}
a6c2ba28	432
3acf2809	433	inline static int em28xx_contrast_get(struct em28xx *dev)
a6c2ba28	434	{
3acf2809	435	return em28xx_read_reg(dev, YGAIN_REG) & 0x1f;
a6c2ba28	436	}
a6c2ba28	437
3acf2809	438	inline static int em28xx_brightness_get(struct em28xx *dev)
a6c2ba28	439	{
3acf2809	440	return em28xx_read_reg(dev, YOFFSET_REG);
a6c2ba28	441	}
a6c2ba28	442
3acf2809	443	inline static int em28xx_saturation_get(struct em28xx *dev)
a6c2ba28	444	{
3acf2809	445	return em28xx_read_reg(dev, UVGAIN_REG) & 0x1f;
a6c2ba28	446	}
a6c2ba28	447
3acf2809	448	inline static int em28xx_u_balance_get(struct em28xx *dev)
a6c2ba28	449	{
3acf2809	450	return em28xx_read_reg(dev, UOFFSET_REG);
a6c2ba28	451	}
a6c2ba28	452
3acf2809	453	inline static int em28xx_v_balance_get(struct em28xx *dev)
a6c2ba28	454	{
3acf2809	455	return em28xx_read_reg(dev, VOFFSET_REG);
a6c2ba28	456	}
a6c2ba28	457
3acf2809	458	inline static int em28xx_gamma_get(struct em28xx *dev)
a6c2ba28	459	{
3acf2809	460	return em28xx_read_reg(dev, GAMMA_REG) & 0x3f;
a6c2ba28	461	}
a6c2ba28	462
3acf2809	463	inline static int em28xx_contrast_set(struct em28xx *dev, s32 val)
a6c2ba28	464	{
a6c2ba28	465	u8 tmp = (u8) val;
3acf2809	466	return em28xx_write_regs(dev, YGAIN_REG, &tmp, 1);
a6c2ba28	467	}
a6c2ba28	468
3acf2809	469	inline static int em28xx_brightness_set(struct em28xx *dev, s32 val)
a6c2ba28	470	{
a6c2ba28	471	u8 tmp = (u8) val;
3acf2809	472	return em28xx_write_regs(dev, YOFFSET_REG, &tmp, 1);
a6c2ba28	473	}
a6c2ba28	474
3acf2809	475	inline static int em28xx_saturation_set(struct em28xx *dev, s32 val)
a6c2ba28	476	{
a6c2ba28	477	u8 tmp = (u8) val;
3acf2809	478	return em28xx_write_regs(dev, UVGAIN_REG, &tmp, 1);
a6c2ba28	479	}
a6c2ba28	480
3acf2809	481	inline static int em28xx_u_balance_set(struct em28xx *dev, s32 val)
a6c2ba28	482	{
a6c2ba28	483	u8 tmp = (u8) val;
3acf2809	484	return em28xx_write_regs(dev, UOFFSET_REG, &tmp, 1);
a6c2ba28	485	}
a6c2ba28	486
3acf2809	487	inline static int em28xx_v_balance_set(struct em28xx *dev, s32 val)
a6c2ba28	488	{
a6c2ba28	489	u8 tmp = (u8) val;
3acf2809	490	return em28xx_write_regs(dev, VOFFSET_REG, &tmp, 1);
a6c2ba28	491	}
a6c2ba28	492
3acf2809	493	inline static int em28xx_gamma_set(struct em28xx *dev, s32 val)
a6c2ba28	494	{
a6c2ba28	495	u8 tmp = (u8) val;
3acf2809	496	return em28xx_write_regs(dev, GAMMA_REG, &tmp, 1);
a6c2ba28	497	}
	498
	499	/FIXME: maxw should be dependent of alt mode /
3acf2809	500	inline static unsigned int norm_maxw(struct em28xx *dev)
30556b23 MR	501	{
	502	switch(dev->model){
	503	case (EM2820_BOARD_MSI_VOX_USB_2): return(640);
	504	default: return(720);
	505	}
	506	}
	507
3acf2809	508	inline static unsigned int norm_maxh(struct em28xx *dev)
a6c2ba28	509	{
30556b23 MR	510	switch(dev->model){
	511	case (EM2820_BOARD_MSI_VOX_USB_2): return(480);
	512	default: return (dev->tvnorm->id & V4L2_STD_625_50) ? 576 : 480;
	513	}
a6c2ba28	514	}
	515
	516	#endif