[mirror_ubuntu-artful-kernel.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/videodev2.h>
#include <media/videobuf-vmalloc.h>

#include <linux/i2c.h>
#include <linux/mutex.h>
#include <media/ir-kbd-i2c.h>
#if defined(CONFIG_VIDEO_EM28XX_DVB) || defined(CONFIG_VIDEO_EM28XX_DVB_MODULE)
#include <media/videobuf-dvb.h>
#endif
#include "tuner-xc2028.h"
#include "em28xx-reg.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 EM2820_BOARD_PROLINK_PLAYTV_USB2	14
#define EM2800_BOARD_VGEAR_POCKETTV             15
#define EM2880_BOARD_HAUPPAUGE_WINTV_HVR_950	16

/* Limits minimum and default number of buffers */
#define EM28XX_MIN_BUF 4
#define EM28XX_DEF_BUF 8

/* maximum number of em28xx boards */
#define EM28XX_MAXBOARDS 4 /*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

enum em28xx_mode {
	EM28XX_ANALOG_MODE,
	EM28XX_DIGITAL_MODE,
};

enum em28xx_stream_state {
	STREAM_OFF,
	STREAM_INTERRUPT,
	STREAM_ON,
};

struct em28xx;

struct em28xx_usb_isoc_ctl {
		/* max packet size of isoc transaction */
	int				max_pkt_size;

		/* number of allocated urbs */
	int				num_bufs;

		/* urb for isoc transfers */
	struct urb			**urb;

		/* transfer buffers for isoc transfer */
	char				**transfer_buffer;

		/* Last buffer command and region */
	u8				cmd;
	int				pos, size, pktsize;

		/* Last field: ODD or EVEN? */
	int				field;

		/* Stores incomplete commands */
	u32				tmp_buf;
	int				tmp_buf_len;

		/* Stores already requested buffers */
	struct em28xx_buffer    	*buf;

		/* Stores the number of received fields */
	int				nfields;

		/* isoc urb callback */
	int (*isoc_copy) (struct em28xx *dev, struct urb *urb);

};

struct em28xx_fmt {
	char  *name;
	u32   fourcc;          /* v4l2 format id */
};

/* buffer for one video frame */
struct em28xx_buffer {
	/* common v4l buffer stuff -- must be first */
	struct videobuf_buffer vb;

	struct list_head frame;
	int top_field;
	int receiving;
};

struct em28xx_dmaqueue {
	struct list_head       active;
	struct list_head       queued;

	wait_queue_head_t          wq;

	/* Counters to control buffer fill */
	int                        pos;
};

/* 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,
};

enum em28xx_amux {
	EM28XX_AMUX_VIDEO,
	EM28XX_AMUX_LINE_IN,
	EM28XX_AMUX_AC97_VIDEO,
	EM28XX_AMUX_AC97_LINE_IN,
};

struct em28xx_input {
	enum enum28xx_itype type;
	unsigned int vmux;
	enum em28xx_amux amux;
};

#define INPUT(nr) (&em28xx_boards[dev->model].input[nr])

enum em28xx_decoder {
	EM28XX_TVP5150,
	EM28XX_SAA7113,
	EM28XX_SAA7114
};

struct em28xx_reg_seq {
	int reg;
	unsigned char val;
	int sleep;
};

struct em28xx_board {
	char *name;
	int vchannels;
	int tuner_type;

	/* i2c flags */
	unsigned int tda9887_conf;

	unsigned int is_em2800:1;
	unsigned int has_msp34xx:1;
	unsigned int mts_firmware:1;
	unsigned int has_12mhz_i2s:1;
	unsigned int max_range_640_480:1;
	unsigned int has_dvb:1;

	enum em28xx_decoder decoder;

	struct em28xx_input       input[MAX_EM28XX_INPUT];
	struct em28xx_input	  radio;
};

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,
};

enum em28xx_capture_mode {
	EM28XX_CAPTURE_OFF = 0,
	EM28XX_ANALOG_CAPTURE,
	EM28XX_DIGITAL_CAPTURE,
};

#define EM28XX_AUDIO_BUFS 5
#define EM28XX_NUM_AUDIO_PACKETS 64
#define EM28XX_AUDIO_MAX_PACKET_SIZE 196 /* static value */
#define EM28XX_CAPTURE_STREAM_EN 1

/* em28xx extensions */
#define EM28XX_AUDIO   0x10
#define EM28XX_DVB     0x20

struct em28xx_audio {
	char name[50];
	char *transfer_buffer[EM28XX_AUDIO_BUFS];
	struct urb *urb[EM28XX_AUDIO_BUFS];
	struct usb_device *udev;
	unsigned int capture_transfer_done;
	struct snd_pcm_substream   *capture_pcm_substream;

	unsigned int hwptr_done_capture;
	struct snd_card            *sndcard;

	int users, shutdown;
	enum em28xx_stream_state capture_stream;
	spinlock_t slock;
};

struct em28xx;

struct em28xx_fh {
	struct em28xx *dev;
	unsigned int  stream_on:1;	/* Locks streams */
	int           radio;

	struct videobuf_queue        vb_vidq;

	enum v4l2_buf_type           type;
};

/* 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:1;
	unsigned int has_msp34xx:1;
	unsigned int has_tda9887:1;
	unsigned int stream_on:1;	/* Locks streams */
	unsigned int has_audio_class:1;
	unsigned int has_12mhz_i2s:1;
	unsigned int max_range_640_480:1;
	unsigned int has_dvb:1;

	/* Some older em28xx chips needs a waiting time after writing */
	unsigned int wait_after_write;

	/* GPIO sequences for tuner callback */
	struct em28xx_reg_seq *analog_gpio, *digital_gpio;

	int video_inputs;	/* number of video inputs */
	struct list_head	devlist;

	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 */
	v4l2_std_id norm;	/* 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 */
	int width;		/* current frame width */
	int height;		/* current frame height */
	int hscale;		/* horizontal scale factor (see datasheet) */
	int vscale;		/* vertical scale factor (see datasheet) */
	int interlaced;		/* 1=interlace fileds, 0=just top fileds */
	unsigned int video_bytesread;	/* Number of bytes read */

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

	struct em28xx_audio *adev;

	/* states */
	enum em28xx_dev_state state;
	enum em28xx_io_method io;

	struct work_struct         request_module_wk;

	/* locks */
	struct mutex lock;
	/* spinlock_t queue_lock; */
	struct list_head inqueue, outqueue;
	wait_queue_head_t open, wait_frame, wait_stream;
	struct video_device *vbi_dev;
	struct video_device *radio_dev;

	unsigned char eedata[256];

	/* Isoc control struct */
	struct em28xx_dmaqueue vidq;
	struct em28xx_usb_isoc_ctl isoc_ctl;
	spinlock_t slock;

	/* 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);

	enum em28xx_mode mode;

	struct em28xx_dvb *dvb;
};

struct em28xx_ops {
	struct list_head next;
	char *name;
	int id;
	int (*init)(struct em28xx *);
	int (*fini)(struct em28xx *);
};

/* Provided by em28xx-i2c.c */

void em28xx_i2c_call_clients(struct em28xx *dev, unsigned int cmd, void *arg);
void em28xx_do_i2c_scan(struct em28xx *dev);
int em28xx_i2c_register(struct em28xx *dev);
int em28xx_i2c_unregister(struct em28xx *dev);

/* 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_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_set_alternate(struct em28xx *dev);
int em28xx_init_isoc(struct em28xx *dev, int max_packets,
		     int num_bufs, int max_pkt_size,
		     int (*isoc_copy) (struct em28xx *dev, struct urb *urb),
		     int cap_type);
void em28xx_uninit_isoc(struct em28xx *dev);

/* Provided by em28xx-video.c */
int em28xx_register_extension(struct em28xx_ops *dev);
void em28xx_unregister_extension(struct em28xx_ops *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;
void em28xx_set_ir(struct em28xx *dev, struct IR_i2c *ir);
int em28xx_tuner_callback(void *ptr, int command, int arg);
void em28xx_setup_xc3028(struct em28xx *dev, struct xc2028_ctrl *ctl);

/* Provided by em28xx-input.c */
/* TODO: Check if the standard get_key handlers on ir-common can be used */
int em28xx_get_key_terratec(struct IR_i2c *ir, u32 *ir_key, u32 *ir_raw);
int em28xx_get_key_em_haup(struct IR_i2c *ir, u32 *ir_key, u32 *ir_raw);
int em28xx_get_key_pinnacle_usb_grey(struct IR_i2c *ir, u32 *ir_key,
				     u32 *ir_raw);

/* 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)

static inline int em28xx_compression_disable(struct em28xx *dev)
{
	/* side effect of disabling scaler and mixer */
	return em28xx_write_regs(dev, EM28XX_R26_COMPR, "\x00", 1);
}

static inline int em28xx_contrast_get(struct em28xx *dev)
{
	return em28xx_read_reg(dev, EM28XX_R20_YGAIN) & 0x1f;
}

static inline int em28xx_brightness_get(struct em28xx *dev)
{
	return em28xx_read_reg(dev, EM28XX_R21_YOFFSET);
}

static inline int em28xx_saturation_get(struct em28xx *dev)
{
	return em28xx_read_reg(dev, EM28XX_R22_UVGAIN) & 0x1f;
}

static inline int em28xx_u_balance_get(struct em28xx *dev)
{
	return em28xx_read_reg(dev, EM28XX_R23_UOFFSET);
}

static inline int em28xx_v_balance_get(struct em28xx *dev)
{
	return em28xx_read_reg(dev, EM28XX_R24_VOFFSET);
}

static inline int em28xx_gamma_get(struct em28xx *dev)
{
	return em28xx_read_reg(dev, EM28XX_R14_GAMMA) & 0x3f;
}

static inline int em28xx_contrast_set(struct em28xx *dev, s32 val)
{
	u8 tmp = (u8) val;
	return em28xx_write_regs(dev, EM28XX_R20_YGAIN, &tmp, 1);
}

static inline int em28xx_brightness_set(struct em28xx *dev, s32 val)
{
	u8 tmp = (u8) val;
	return em28xx_write_regs(dev, EM28XX_R21_YOFFSET, &tmp, 1);
}

static inline int em28xx_saturation_set(struct em28xx *dev, s32 val)
{
	u8 tmp = (u8) val;
	return em28xx_write_regs(dev, EM28XX_R22_UVGAIN, &tmp, 1);
}

static inline int em28xx_u_balance_set(struct em28xx *dev, s32 val)
{
	u8 tmp = (u8) val;
	return em28xx_write_regs(dev, EM28XX_R23_UOFFSET, &tmp, 1);
}

static inline int em28xx_v_balance_set(struct em28xx *dev, s32 val)
{
	u8 tmp = (u8) val;
	return em28xx_write_regs(dev, EM28XX_R24_VOFFSET, &tmp, 1);
}

static inline int em28xx_gamma_set(struct em28xx *dev, s32 val)
{
	u8 tmp = (u8) val;
	return em28xx_write_regs(dev, EM28XX_R14_GAMMA, &tmp, 1);
}

/*FIXME: maxw should be dependent of alt mode */
static inline unsigned int norm_maxw(struct em28xx *dev)
{
	if (dev->max_range_640_480)
		return 640;
	else
		return 720;
}

static inline unsigned int norm_maxh(struct em28xx *dev)
{
	if (dev->max_range_640_480)
		return 480;
	else
		return (dev->norm & 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
cb77d010	28	#include <linux/videodev2.h>
ad0ebb96 MCC	29	#include <media/videobuf-vmalloc.h>
ad0ebb96 MCC	30
a6c2ba28	31	#include <linux/i2c.h>
3593cab5	32	#include <linux/mutex.h>
d5e52653	33	#include <media/ir-kbd-i2c.h>
3aefb79a MCC	34	#if defined(CONFIG_VIDEO_EM28XX_DVB) \|\| defined(CONFIG_VIDEO_EM28XX_DVB_MODULE)
	35	#include <media/videobuf-dvb.h>
	36	#endif
3ca9c093	37	#include "tuner-xc2028.h"
2ba890ec	38	#include "em28xx-reg.h"
3aefb79a MCC	39
	40	/* Boards supported by driver */
	41	#define EM2800_BOARD_UNKNOWN 0
	42	#define EM2820_BOARD_UNKNOWN 1
	43	#define EM2820_BOARD_TERRATEC_CINERGY_250 2
	44	#define EM2820_BOARD_PINNACLE_USB_2 3
	45	#define EM2820_BOARD_HAUPPAUGE_WINTV_USB_2 4
	46	#define EM2820_BOARD_MSI_VOX_USB_2 5
	47	#define EM2800_BOARD_TERRATEC_CINERGY_200 6
	48	#define EM2800_BOARD_LEADTEK_WINFAST_USBII 7
	49	#define EM2800_BOARD_KWORLD_USB2800 8
	50	#define EM2820_BOARD_PINNACLE_DVC_90 9
	51	#define EM2880_BOARD_HAUPPAUGE_WINTV_HVR_900 10
	52	#define EM2880_BOARD_TERRATEC_HYBRID_XS 11
	53	#define EM2820_BOARD_KWORLD_PVRTV2800RF 12
	54	#define EM2880_BOARD_TERRATEC_PRODIGY_XS 13
	55	#define EM2820_BOARD_PROLINK_PLAYTV_USB2 14
	56	#define EM2800_BOARD_VGEAR_POCKETTV 15
	57	#define EM2880_BOARD_HAUPPAUGE_WINTV_HVR_950 16
	58
	59	/* Limits minimum and default number of buffers */
	60	#define EM28XX_MIN_BUF 4
	61	#define EM28XX_DEF_BUF 8
a6c2ba28	62
596d92d5	63	/* maximum number of em28xx boards */
3687e1e6	64	#define EM28XX_MAXBOARDS 4 /FIXME: should be bigger /
596d92d5	65
a6c2ba28	66	/* maximum number of frames that can be queued */
3acf2809	67	#define EM28XX_NUM_FRAMES 5
a6c2ba28	68	/* number of frames that get used for v4l2_read() */
3acf2809	69	#define EM28XX_NUM_READ_FRAMES 2
a6c2ba28	70
a6c2ba28	71	/* number of buffers for isoc transfers */
3acf2809	72	#define EM28XX_NUM_BUFS 5
a6c2ba28	73
d5e52653 MCC	74	/* number of packets for each buffer
	75	windows requests only 40 packets .. so we better do the same
	76	this is what I found out for all alternate numbers there!
	77	*/
3acf2809	78	#define EM28XX_NUM_PACKETS 40
a6c2ba28	79
a6c2ba28	80	/* default alternate; 0 means choose the best */
3acf2809	81	#define EM28XX_PINOUT 0
a6c2ba28	82
3acf2809	83	#define EM28XX_INTERLACED_DEFAULT 1
a6c2ba28	84
	85	/*
	86	#define (use usbview if you want to get the other alternate number infos)
	87	#define
	88	#define alternate number 2
	89	#define Endpoint Address: 82
	90	Direction: in
	91	Attribute: 1
	92	Type: Isoc
	93	Max Packet Size: 1448
	94	Interval: 125us
	95
	96	alternate number 7
	97
	98	Endpoint Address: 82
	99	Direction: in
	100	Attribute: 1
	101	Type: Isoc
	102	Max Packet Size: 3072
	103	Interval: 125us
	104	*/
	105
	106	/* time to wait when stopping the isoc transfer */
3acf2809	107	#define EM28XX_URB_TIMEOUT msecs_to_jiffies(EM28XX_NUM_BUFS * EM28XX_NUM_PACKETS)
a6c2ba28	108
596d92d5 MCC	109	/* time in msecs to wait for i2c writes to finish */
	110	#define EM2800_I2C_WRITE_TIMEOUT 20
	111
3aefb79a MCC	112	enum em28xx_mode {
	113	EM28XX_ANALOG_MODE,
	114	EM28XX_DIGITAL_MODE,
	115	};
	116
3acf2809	117	enum em28xx_stream_state {
a6c2ba28	118	STREAM_OFF,
	119	STREAM_INTERRUPT,
	120	STREAM_ON,
	121	};
	122
579f72e4 AT	123	struct em28xx;
579f72e4 AT	124
ad0ebb96 MCC	125	struct em28xx_usb_isoc_ctl {
	126	/* max packet size of isoc transaction */
	127	int max_pkt_size;
	128
	129	/* number of allocated urbs */
	130	int num_bufs;
	131
	132	/* urb for isoc transfers */
	133	struct urb **urb;
	134
	135	/* transfer buffers for isoc transfer */
	136	char **transfer_buffer;
	137
	138	/* Last buffer command and region */
	139	u8 cmd;
	140	int pos, size, pktsize;
	141
	142	/* Last field: ODD or EVEN? */
	143	int field;
	144
	145	/* Stores incomplete commands */
	146	u32 tmp_buf;
	147	int tmp_buf_len;
	148
	149	/* Stores already requested buffers */
	150	struct em28xx_buffer *buf;
	151
	152	/* Stores the number of received fields */
	153	int nfields;
579f72e4 AT	154
	155	/* isoc urb callback */
	156	int (isoc_copy) (struct em28xx dev, struct urb *urb);
	157
ad0ebb96 MCC	158	};
	159
	160	struct em28xx_fmt {
	161	char *name;
	162	u32 fourcc; /* v4l2 format id */
	163	};
	164
	165	/* buffer for one video frame */
	166	struct em28xx_buffer {
	167	/* common v4l buffer stuff -- must be first */
	168	struct videobuf_buffer vb;
	169
a6c2ba28	170	struct list_head frame;
a6c2ba28	171	int top_field;
ad0ebb96 MCC	172	int receiving;
	173	};
	174
	175	struct em28xx_dmaqueue {
	176	struct list_head active;
	177	struct list_head queued;
ad0ebb96 MCC	178
	179	wait_queue_head_t wq;
	180
	181	/* Counters to control buffer fill */
	182	int pos;
a6c2ba28	183	};
	184
	185	/* io methods */
3acf2809	186	enum em28xx_io_method {
a6c2ba28	187	IO_NONE,
	188	IO_READ,
	189	IO_MMAP,
	190	};
	191
	192	/* inputs */
	193
3acf2809 MCC	194	#define MAX_EM28XX_INPUT 4
	195	enum enum28xx_itype {
	196	EM28XX_VMUX_COMPOSITE1 = 1,
	197	EM28XX_VMUX_COMPOSITE2,
	198	EM28XX_VMUX_COMPOSITE3,
	199	EM28XX_VMUX_COMPOSITE4,
	200	EM28XX_VMUX_SVIDEO,
	201	EM28XX_VMUX_TELEVISION,
	202	EM28XX_VMUX_CABLE,
	203	EM28XX_VMUX_DVB,
	204	EM28XX_VMUX_DEBUG,
	205	EM28XX_RADIO,
a6c2ba28	206	};
a6c2ba28	207
539c96d0 MCC	208	enum em28xx_amux {
	209	EM28XX_AMUX_VIDEO,
	210	EM28XX_AMUX_LINE_IN,
	211	EM28XX_AMUX_AC97_VIDEO,
	212	EM28XX_AMUX_AC97_LINE_IN,
	213	};
	214
3acf2809 MCC	215	struct em28xx_input {
3acf2809 MCC	216	enum enum28xx_itype type;
a6c2ba28	217	unsigned int vmux;
539c96d0	218	enum em28xx_amux amux;
a6c2ba28	219	};
a6c2ba28	220
3acf2809	221	#define INPUT(nr) (&em28xx_boards[dev->model].input[nr])
a6c2ba28	222
3acf2809 MCC	223	enum em28xx_decoder {
	224	EM28XX_TVP5150,
	225	EM28XX_SAA7113,
	226	EM28XX_SAA7114
a6c2ba28	227	};
a6c2ba28	228
102a0b08 MCC	229	struct em28xx_reg_seq {
102a0b08 MCC	230	int reg;
ee6e3a86	231	unsigned char val;
102a0b08	232	int sleep;
ee6e3a86 MCC	233	};
ee6e3a86 MCC	234
3acf2809	235	struct em28xx_board {
a6c2ba28	236	char *name;
a6c2ba28	237	int vchannels;
a6c2ba28	238	int tuner_type;
	239
	240	/* i2c flags */
	241	unsigned int tda9887_conf;
	242
74f38a82	243	unsigned int is_em2800:1;
a6c2ba28	244	unsigned int has_msp34xx:1;
5add9a6f	245	unsigned int mts_firmware:1;
3abee53e	246	unsigned int has_12mhz_i2s:1;
c8793b03	247	unsigned int max_range_640_480:1;
3aefb79a	248	unsigned int has_dvb:1;
3abee53e	249
3acf2809	250	enum em28xx_decoder decoder;
a6c2ba28	251
3acf2809	252	struct em28xx_input input[MAX_EM28XX_INPUT];
0be43754	253	struct em28xx_input radio;
a6c2ba28	254	};
a6c2ba28	255
3acf2809	256	struct em28xx_eeprom {
a6c2ba28	257	u32 id; /* 0x9567eb1a */
	258	u16 vendor_ID;
	259	u16 product_ID;
	260
	261	u16 chip_conf;
	262
	263	u16 board_conf;
	264
	265	u16 string1, string2, string3;
	266
	267	u8 string_idx_table;
	268	};
	269
	270	/* device states */
3acf2809	271	enum em28xx_dev_state {
a6c2ba28	272	DEV_INITIALIZED = 0x01,
	273	DEV_DISCONNECTED = 0x02,
	274	DEV_MISCONFIGURED = 0x04,
	275	};
	276
579f72e4 AT	277	enum em28xx_capture_mode {
	278	EM28XX_CAPTURE_OFF = 0,
	279	EM28XX_ANALOG_CAPTURE,
	280	EM28XX_DIGITAL_CAPTURE,
	281	};
	282
6d79468d MCC	283	#define EM28XX_AUDIO_BUFS 5
	284	#define EM28XX_NUM_AUDIO_PACKETS 64
	285	#define EM28XX_AUDIO_MAX_PACKET_SIZE 196 /* static value */
	286	#define EM28XX_CAPTURE_STREAM_EN 1
3aefb79a MCC	287
3aefb79a MCC	288	/* em28xx extensions */
6d79468d	289	#define EM28XX_AUDIO 0x10
3aefb79a	290	#define EM28XX_DVB 0x20
6d79468d MCC	291
	292	struct em28xx_audio {
	293	char name[50];
	294	char *transfer_buffer[EM28XX_AUDIO_BUFS];
	295	struct urb *urb[EM28XX_AUDIO_BUFS];
	296	struct usb_device *udev;
	297	unsigned int capture_transfer_done;
	298	struct snd_pcm_substream *capture_pcm_substream;
	299
	300	unsigned int hwptr_done_capture;
	301	struct snd_card *sndcard;
	302
	303	int users, shutdown;
	304	enum em28xx_stream_state capture_stream;
	305	spinlock_t slock;
	306	};
	307
52284c3e MCC	308	struct em28xx;
	309
	310	struct em28xx_fh {
	311	struct em28xx *dev;
	312	unsigned int stream_on:1; /* Locks streams */
	313	int radio;
	314
	315	struct videobuf_queue vb_vidq;
	316
	317	enum v4l2_buf_type type;
	318	};
	319
a6c2ba28	320	/* main device struct */
3acf2809	321	struct em28xx {
a6c2ba28	322	/* generic device properties */
	323	char name[30]; /* name (including minor) of the device */
	324	int model; /* index in the device_data struct */
e5589bef	325	int devno; /* marks the number of this device */
74f38a82	326	unsigned int is_em2800:1;
a6c2ba28	327	unsigned int has_msp34xx:1;
a6c2ba28	328	unsigned int has_tda9887:1;
a225452e	329	unsigned int stream_on:1; /* Locks streams */
d7448a8d	330	unsigned int has_audio_class:1;
3abee53e	331	unsigned int has_12mhz_i2s:1;
c8793b03	332	unsigned int max_range_640_480:1;
3aefb79a	333	unsigned int has_dvb:1;
a225452e	334
89b329ef MCC	335	/* Some older em28xx chips needs a waiting time after writing */
	336	unsigned int wait_after_write;
	337
102a0b08 MCC	338	/* GPIO sequences for tuner callback */
102a0b08 MCC	339	struct em28xx_reg_seq analog_gpio, digital_gpio;
ee6e3a86	340
74f38a82 MCC	341	int video_inputs; /* number of video inputs */
	342	struct list_head devlist;
	343
9bb13a6d MCC	344	u32 i2s_speed; /* I2S speed for audio digital stream */
9bb13a6d MCC	345
3acf2809	346	enum em28xx_decoder decoder;
a6c2ba28	347
	348	int tuner_type; /* type of the tuner */
	349	int tuner_addr; /* tuner address */
	350	int tda9887_conf;
	351	/* i2c i/o */
	352	struct i2c_adapter i2c_adap;
	353	struct i2c_client i2c_client;
	354	/* video for linux */
	355	int users; /* user count for exclusive use */
	356	struct video_device vdev; / video for linux device struct */
7d497f8a	357	v4l2_std_id norm; /* selected tv norm */
a6c2ba28	358	int ctl_freq; /* selected frequency */
	359	unsigned int ctl_input; /* selected input */
	360	unsigned int ctl_ainput; /* slected audio input */
	361	int mute;
	362	int volume;
	363	/* frame properties */
a6c2ba28	364	int width; /* current frame width */
a6c2ba28	365	int height; /* current frame height */
a6c2ba28	366	int hscale; /* horizontal scale factor (see datasheet) */
	367	int vscale; /* vertical scale factor (see datasheet) */
	368	int interlaced; /* 1=interlace fileds, 0=just top fileds */
9e31ced8	369	unsigned int video_bytesread; /* Number of bytes read */
a6c2ba28	370
03910cc3	371	unsigned long hash; /* eeprom hash - for boards with generic ID */
6ea54d93 DSL	372	unsigned long i2c_hash; /* i2c devicelist hash -
6ea54d93 DSL	373	for boards with generic ID */
03910cc3	374
6d79468d MCC	375	struct em28xx_audio *adev;
6d79468d MCC	376
a6c2ba28	377	/* states */
3acf2809	378	enum em28xx_dev_state state;
3acf2809	379	enum em28xx_io_method io;
9e31ced8	380
d7448a8d MCC	381	struct work_struct request_module_wk;
d7448a8d MCC	382
a6c2ba28	383	/* locks */
5a80415b	384	struct mutex lock;
d7aa8020	385	/* spinlock_t queue_lock; */
a6c2ba28	386	struct list_head inqueue, outqueue;
	387	wait_queue_head_t open, wait_frame, wait_stream;
	388	struct video_device *vbi_dev;
0be43754	389	struct video_device *radio_dev;
a6c2ba28	390
	391	unsigned char eedata[256];
	392
ad0ebb96 MCC	393	/* Isoc control struct */
	394	struct em28xx_dmaqueue vidq;
	395	struct em28xx_usb_isoc_ctl isoc_ctl;
	396	spinlock_t slock;
	397
a6c2ba28	398	/* usb transfer */
	399	struct usb_device udev; / the usb device */
	400	int alt; /* alternate */
	401	int max_pkt_size; /* max packet size of isoc transaction */
9d4d9c05 MCC	402	int num_alt; /* Number of alternative settings */
9d4d9c05 MCC	403	unsigned int alt_max_pkt_size; / array of wMaxPacketSize */
3acf2809 MCC	404	struct urb urb[EM28XX_NUM_BUFS]; / urb for isoc transfers */
3acf2809 MCC	405	char transfer_buffer[EM28XX_NUM_BUFS]; / transfer buffers for isoc transfer */
a6c2ba28	406	/* helper funcs that call usb_control_msg */
6ea54d93	407	int (em28xx_write_regs) (struct em28xx dev, u16 reg,
a6c2ba28	408	char *buf, int len);
6ea54d93 DSL	409	int (em28xx_read_reg) (struct em28xx dev, u16 reg);
	410	int (em28xx_read_reg_req_len) (struct em28xx dev, u8 req, u16 reg,
	411	char *buf, int len);
	412	int (em28xx_write_regs_req) (struct em28xx dev, u8 req, u16 reg,
a6c2ba28	413	char *buf, int len);
6ea54d93	414	int (em28xx_read_reg_req) (struct em28xx dev, u8 req, u16 reg);
3aefb79a MCC	415
	416	enum em28xx_mode mode;
	417
3421b778	418	struct em28xx_dvb *dvb;
a6c2ba28	419	};
a6c2ba28	420
6d79468d MCC	421	struct em28xx_ops {
	422	struct list_head next;
	423	char *name;
	424	int id;
	425	int (init)(struct em28xx );
	426	int (fini)(struct em28xx );
a3a048ce MCC	427	};
a3a048ce MCC	428
3acf2809	429	/* Provided by em28xx-i2c.c */
a6c2ba28	430
3acf2809	431	void em28xx_i2c_call_clients(struct em28xx dev, unsigned int cmd, void arg);
fad7b958	432	void em28xx_do_i2c_scan(struct em28xx *dev);
3acf2809 MCC	433	int em28xx_i2c_register(struct em28xx *dev);
3acf2809 MCC	434	int em28xx_i2c_unregister(struct em28xx *dev);
a6c2ba28	435
3acf2809	436	/* Provided by em28xx-core.c */
a6c2ba28	437
3acf2809 MCC	438	u32 em28xx_request_buffers(struct em28xx *dev, u32 count);
	439	void em28xx_queue_unusedframes(struct em28xx *dev);
	440	void em28xx_release_buffers(struct em28xx *dev);
a6c2ba28	441
3acf2809	442	int em28xx_read_reg_req_len(struct em28xx *dev, u8 req, u16 reg,
a6c2ba28	443	char *buf, int len);
3acf2809 MCC	444	int em28xx_read_reg_req(struct em28xx *dev, u8 req, u16 reg);
	445	int em28xx_read_reg(struct em28xx *dev, u16 reg);
	446	int em28xx_write_regs_req(struct em28xx dev, u8 req, u16 reg, char buf,
a6c2ba28	447	int len);
3acf2809	448	int em28xx_write_regs(struct em28xx dev, u16 reg, char buf, int len);
3acf2809	449	int em28xx_audio_analog_set(struct em28xx *dev);
539c96d0	450
3acf2809 MCC	451	int em28xx_colorlevels_set_default(struct em28xx *dev);
	452	int em28xx_capture_start(struct em28xx *dev, int start);
	453	int em28xx_outfmt_set_yuv422(struct em28xx *dev);
3acf2809	454	int em28xx_resolution_set(struct em28xx *dev);
3acf2809	455	int em28xx_set_alternate(struct em28xx *dev);
579f72e4 AT	456	int em28xx_init_isoc(struct em28xx *dev, int max_packets,
	457	int num_bufs, int max_pkt_size,
	458	int (isoc_copy) (struct em28xx dev, struct urb *urb),
	459	int cap_type);
	460	void em28xx_uninit_isoc(struct em28xx *dev);
3acf2809	461
6d79468d MCC	462	/* Provided by em28xx-video.c */
	463	int em28xx_register_extension(struct em28xx_ops *dev);
	464	void em28xx_unregister_extension(struct em28xx_ops *dev);
	465
3acf2809	466	/* Provided by em28xx-cards.c */
6ea54d93	467	extern int em2800_variant_detect(struct usb_device *udev, int model);
a94e95b4	468	extern void em28xx_pre_card_setup(struct em28xx *dev);
3acf2809 MCC	469	extern void em28xx_card_setup(struct em28xx *dev);
	470	extern struct em28xx_board em28xx_boards[];
	471	extern struct usb_device_id em28xx_id_table[];
	472	extern const unsigned int em28xx_bcount;
c8793b03	473	void em28xx_set_ir(struct em28xx dev, struct IR_i2c ir);
ee6e3a86	474	int em28xx_tuner_callback(void *ptr, int command, int arg);
3ca9c093	475	void em28xx_setup_xc3028(struct em28xx dev, struct xc2028_ctrl ctl);
c8793b03 MCC	476
	477	/* Provided by em28xx-input.c */
	478	/* TODO: Check if the standard get_key handlers on ir-common can be used */
	479	int em28xx_get_key_terratec(struct IR_i2c ir, u32 ir_key, u32 *ir_raw);
	480	int em28xx_get_key_em_haup(struct IR_i2c ir, u32 ir_key, u32 *ir_raw);
	481	int em28xx_get_key_pinnacle_usb_grey(struct IR_i2c ir, u32 ir_key,
	482	u32 *ir_raw);
a6c2ba28	483
a6c2ba28	484	/* printk macros */
a6c2ba28	485
3acf2809	486	#define em28xx_err(fmt, arg...) do {\
f85c657f	487	printk(KERN_ERR fmt , ##arg); } while (0)
a6c2ba28	488
3acf2809	489	#define em28xx_errdev(fmt, arg...) do {\
4ac97914	490	printk(KERN_ERR "%s: "fmt,\
f85c657f	491	dev->name , ##arg); } while (0)
a6c2ba28	492
3acf2809	493	#define em28xx_info(fmt, arg...) do {\
4ac97914	494	printk(KERN_INFO "%s: "fmt,\
f85c657f	495	dev->name , ##arg); } while (0)
3acf2809	496	#define em28xx_warn(fmt, arg...) do {\
4ac97914	497	printk(KERN_WARNING "%s: "fmt,\
f85c657f	498	dev->name , ##arg); } while (0)
a6c2ba28	499
6ea54d93	500	static inline int em28xx_compression_disable(struct em28xx *dev)
a6c2ba28	501	{
a6c2ba28	502	/* side effect of disabling scaler and mixer */
41facaa4	503	return em28xx_write_regs(dev, EM28XX_R26_COMPR, "\x00", 1);
a6c2ba28	504	}
a6c2ba28	505
6ea54d93	506	static inline int em28xx_contrast_get(struct em28xx *dev)
a6c2ba28	507	{
41facaa4	508	return em28xx_read_reg(dev, EM28XX_R20_YGAIN) & 0x1f;
a6c2ba28	509	}
a6c2ba28	510
6ea54d93	511	static inline int em28xx_brightness_get(struct em28xx *dev)
a6c2ba28	512	{
41facaa4	513	return em28xx_read_reg(dev, EM28XX_R21_YOFFSET);
a6c2ba28	514	}
a6c2ba28	515
6ea54d93	516	static inline int em28xx_saturation_get(struct em28xx *dev)
a6c2ba28	517	{
41facaa4	518	return em28xx_read_reg(dev, EM28XX_R22_UVGAIN) & 0x1f;
a6c2ba28	519	}
a6c2ba28	520
6ea54d93	521	static inline int em28xx_u_balance_get(struct em28xx *dev)
a6c2ba28	522	{
41facaa4	523	return em28xx_read_reg(dev, EM28XX_R23_UOFFSET);
a6c2ba28	524	}
a6c2ba28	525
6ea54d93	526	static inline int em28xx_v_balance_get(struct em28xx *dev)
a6c2ba28	527	{
41facaa4	528	return em28xx_read_reg(dev, EM28XX_R24_VOFFSET);
a6c2ba28	529	}
a6c2ba28	530
6ea54d93	531	static inline int em28xx_gamma_get(struct em28xx *dev)
a6c2ba28	532	{
41facaa4	533	return em28xx_read_reg(dev, EM28XX_R14_GAMMA) & 0x3f;
a6c2ba28	534	}
a6c2ba28	535
6ea54d93	536	static inline int em28xx_contrast_set(struct em28xx *dev, s32 val)
a6c2ba28	537	{
a6c2ba28	538	u8 tmp = (u8) val;
41facaa4	539	return em28xx_write_regs(dev, EM28XX_R20_YGAIN, &tmp, 1);
a6c2ba28	540	}
a6c2ba28	541
6ea54d93	542	static inline int em28xx_brightness_set(struct em28xx *dev, s32 val)
a6c2ba28	543	{
a6c2ba28	544	u8 tmp = (u8) val;
41facaa4	545	return em28xx_write_regs(dev, EM28XX_R21_YOFFSET, &tmp, 1);
a6c2ba28	546	}
a6c2ba28	547
6ea54d93	548	static inline int em28xx_saturation_set(struct em28xx *dev, s32 val)
a6c2ba28	549	{
a6c2ba28	550	u8 tmp = (u8) val;
41facaa4	551	return em28xx_write_regs(dev, EM28XX_R22_UVGAIN, &tmp, 1);
a6c2ba28	552	}
a6c2ba28	553
6ea54d93	554	static inline int em28xx_u_balance_set(struct em28xx *dev, s32 val)
a6c2ba28	555	{
a6c2ba28	556	u8 tmp = (u8) val;
41facaa4	557	return em28xx_write_regs(dev, EM28XX_R23_UOFFSET, &tmp, 1);
a6c2ba28	558	}
a6c2ba28	559
6ea54d93	560	static inline int em28xx_v_balance_set(struct em28xx *dev, s32 val)
a6c2ba28	561	{
a6c2ba28	562	u8 tmp = (u8) val;
41facaa4	563	return em28xx_write_regs(dev, EM28XX_R24_VOFFSET, &tmp, 1);
a6c2ba28	564	}
a6c2ba28	565
6ea54d93	566	static inline int em28xx_gamma_set(struct em28xx *dev, s32 val)
a6c2ba28	567	{
a6c2ba28	568	u8 tmp = (u8) val;
41facaa4	569	return em28xx_write_regs(dev, EM28XX_R14_GAMMA, &tmp, 1);
a6c2ba28	570	}
	571
	572	/FIXME: maxw should be dependent of alt mode /
6ea54d93	573	static inline unsigned int norm_maxw(struct em28xx *dev)
30556b23	574	{
c8793b03	575	if (dev->max_range_640_480)
7d497f8a	576	return 640;
c8793b03	577	else
7d497f8a	578	return 720;
30556b23 MR	579	}
30556b23 MR	580
6ea54d93	581	static inline unsigned int norm_maxh(struct em28xx *dev)
a6c2ba28	582	{
c8793b03	583	if (dev->max_range_640_480)
7d497f8a	584	return 480;
c8793b03	585	else
7d497f8a	586	return (dev->norm & V4L2_STD_625_50) ? 576 : 480;
a6c2ba28	587	}
a6c2ba28	588	#endif