[net-next-2.6.git] / drivers / staging / tm6000 / tm6000.h

/*
   tm6000.h - driver for TM5600/TM6000/TM6010 USB video capture devices

   Copyright (C) 2006-2007 Mauro Carvalho Chehab <mchehab@infradead.org>

   Copyright (C) 2007 Michel Ludwig <michel.ludwig@gmail.com>
	- DVB-T support

   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 version 2

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

// Use the tm6000-hack, instead of the proper initialization code
//#define HACK 1

#include <linux/videodev2.h>
#include <media/v4l2-common.h>
#include <media/videobuf-vmalloc.h>
#include "tm6000-usb-isoc.h"
#include <linux/i2c.h>
#include <linux/mutex.h>
#include <media/v4l2-device.h>


#include <linux/dvb/frontend.h>
#include "dvb_demux.h"
#include "dvb_frontend.h"
#include "dmxdev.h"

#define TM6000_VERSION KERNEL_VERSION(0, 0, 2)

/* Inputs */

enum tm6000_itype {
	TM6000_INPUT_TV	= 0,
	TM6000_INPUT_COMPOSITE,
	TM6000_INPUT_SVIDEO,
};

enum tm6000_devtype {
	TM6000 = 0,
	TM5600,
	TM6010,
};

/* ------------------------------------------------------------------
	Basic structures
   ------------------------------------------------------------------*/

struct tm6000_fmt {
	char  *name;
	u32   fourcc;          /* v4l2 format id */
	int   depth;
};

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

	struct tm6000_fmt      *fmt;
};

struct tm6000_dmaqueue {
	struct list_head       active;
	struct list_head       queued;

	/* thread for generating video stream*/
	struct task_struct         *kthread;
	wait_queue_head_t          wq;
	/* Counters to control fps rate */
	int                        frame;
	int                        ini_jiffies;
};

/* device states */
enum tm6000_core_state {
	DEV_INITIALIZED   = 0x01,
	DEV_DISCONNECTED  = 0x02,
	DEV_MISCONFIGURED = 0x04,
};

/* io methods */
enum tm6000_io_method {
	IO_NONE,
	IO_READ,
	IO_MMAP,
};

enum tm6000_mode {
	TM6000_MODE_UNKNOWN=0,
	TM6000_MODE_ANALOG,
	TM6000_MODE_DIGITAL,
};

struct tm6000_gpio {
	int		tuner_reset;
	int		tuner_on;
	int		demod_reset;
	int		demod_on;
	int		power_led;
	int		dvb_led;
	int		ir;
};

struct tm6000_capabilities {
	unsigned int    has_tuner:1;
	unsigned int    has_tda9874:1;
	unsigned int    has_dvb:1;
	unsigned int    has_zl10353:1;
	unsigned int    has_eeprom:1;
	unsigned int    has_remote:1;
};

struct tm6000_dvb {
	struct dvb_adapter	adapter;
	struct dvb_demux	demux;
	struct dvb_frontend	*frontend;
	struct dmxdev		dmxdev;
	unsigned int		streams;
	struct urb 		*bulk_urb;
	struct mutex		mutex;
};

struct tm6000_endpoint {
	struct usb_host_endpoint	*endp;
	__u8				bInterfaceNumber;
	__u8				bAlternateSetting;
	unsigned			maxsize;
};

struct tm6000_core {
	/* 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 */
	enum tm6000_devtype		dev_type;	/* type of device */

	v4l2_std_id                     norm;           /* Current norm */
	int				width,height;	/* Selected resolution */

	enum tm6000_core_state		state;

	/* Device Capabilities*/
	struct tm6000_capabilities	caps;

	/* Tuner configuration */
	int				tuner_type;		/* type of the tuner */
	int				tuner_addr;		/* tuner address */

	struct tm6000_gpio		gpio;

	/* Demodulator configuration */
	int				demod_addr;	/* demodulator address */

	int				audio_bitrate;
	/* i2c i/o */
	struct i2c_adapter		i2c_adap;
	struct i2c_client		i2c_client;


	/* extension */
	struct list_head		devlist;

	/* video for linux */
	int				users;

	/* various device info */
	unsigned int			resources;
	struct video_device		*vfd;
	struct tm6000_dmaqueue		vidq;
	struct v4l2_device		v4l2_dev;

	int				input;
	int				freq;
	unsigned int			fourcc;

	enum tm6000_mode		mode;

	/* DVB-T support */
	struct tm6000_dvb		*dvb;

	/* locks */
	struct mutex			lock;

	/* usb transfer */
	struct usb_device		*udev;		/* the usb device */

	struct tm6000_endpoint		bulk_in, bulk_out, isoc_in, isoc_out;

	/* scaler!=0 if scaler is active*/
	int				scaler;

		/* Isoc control struct */
	struct usb_isoc_ctl          isoc_ctl;

	spinlock_t                   slock;
};

#define TM6000_AUDIO 0x10

struct tm6000_ops {
	struct list_head	next;
	char			*name;
	int			id;
	int (*init)(struct tm6000_core *);
	int (*fini)(struct tm6000_core *);
};

struct tm6000_fh {
	struct tm6000_core           *dev;

	/* video capture */
	struct tm6000_fmt            *fmt;
	unsigned int                 width,height;
	struct videobuf_queue        vb_vidq;

	enum v4l2_buf_type           type;
};

#define TM6000_STD	V4L2_STD_PAL|V4L2_STD_PAL_N|V4L2_STD_PAL_Nc|    \
			V4L2_STD_PAL_M|V4L2_STD_PAL_60|V4L2_STD_NTSC_M| \
			V4L2_STD_NTSC_M_JP|V4L2_STD_SECAM

/* In tm6000-cards.c */

int tm6000_tuner_callback (void *ptr, int component, int command, int arg);
int tm6000_xc5000_callback (void *ptr, int component, int command, int arg);
int tm6000_cards_setup(struct tm6000_core *dev);

/* In tm6000-core.c */

int tm6000_read_write_usb (struct tm6000_core *dev, u8 reqtype, u8 req,
			   u16 value, u16 index, u8 *buf, u16 len);
int tm6000_get_reg (struct tm6000_core *dev, u8 req, u16 value, u16 index);
int tm6000_get_reg16(struct tm6000_core *dev, u8 req, u16 value, u16 index);
int tm6000_get_reg32(struct tm6000_core *dev, u8 req, u16 value, u16 index);
int tm6000_set_reg (struct tm6000_core *dev, u8 req, u16 value, u16 index);
int tm6000_i2c_reset(struct tm6000_core *dev, u16 tsleep);

int tm6000_init (struct tm6000_core *dev);

int tm6000_init_analog_mode (struct tm6000_core *dev);
int tm6000_init_digital_mode (struct tm6000_core *dev);
int tm6000_set_audio_bitrate (struct tm6000_core *dev, int bitrate);

int tm6000_dvb_register(struct tm6000_core *dev);
void tm6000_dvb_unregister(struct tm6000_core *dev);

int tm6000_v4l2_register(struct tm6000_core *dev);
int tm6000_v4l2_unregister(struct tm6000_core *dev);
int tm6000_v4l2_exit(void);
void tm6000_set_fourcc_format(struct tm6000_core *dev);

void tm6000_remove_from_devlist(struct tm6000_core *dev);
void tm6000_add_into_devlist(struct tm6000_core *dev);
int tm6000_register_extension(struct tm6000_ops *ops);
void tm6000_unregister_extension(struct tm6000_ops *ops);
void tm6000_init_extension(struct tm6000_core *dev);
void tm6000_close_extension(struct tm6000_core *dev);

/* In tm6000-stds.c */
void tm6000_get_std_res(struct tm6000_core *dev);
int tm6000_set_standard (struct tm6000_core *dev, v4l2_std_id *norm);

/* In tm6000-i2c.c */
int tm6000_i2c_register(struct tm6000_core *dev);
int tm6000_i2c_unregister(struct tm6000_core *dev);

/* In tm6000-queue.c */

int tm6000_v4l2_mmap(struct file *filp, struct vm_area_struct *vma);

int tm6000_vidioc_streamon(struct file *file, void *priv,
			   enum v4l2_buf_type i);
int tm6000_vidioc_streamoff(struct file *file, void *priv,
			    enum v4l2_buf_type i);
int tm6000_vidioc_reqbufs (struct file *file, void *priv,
			   struct v4l2_requestbuffers *rb);
int tm6000_vidioc_querybuf (struct file *file, void *priv,
			    struct v4l2_buffer *b);
int tm6000_vidioc_qbuf (struct file *file, void *priv, struct v4l2_buffer *b);
int tm6000_vidioc_dqbuf (struct file *file, void *priv, struct v4l2_buffer *b);
ssize_t tm6000_v4l2_read(struct file *filp, char __user * buf, size_t count,
			 loff_t * f_pos);
unsigned int tm6000_v4l2_poll(struct file *file,
			      struct poll_table_struct *wait);
int tm6000_queue_init(struct tm6000_core *dev);

/* In tm6000-alsa.c */
/*int tm6000_audio_init(struct tm6000_core *dev, int idx);*/


/* Debug stuff */

extern int tm6000_debug;

#define dprintk(dev, level, fmt, arg...) do {\
	if (tm6000_debug & level) \
		printk(KERN_INFO "(%lu) %s %s :"fmt, jiffies, 		\
			 dev->name, __FUNCTION__ , ##arg); } while (0)

#define V4L2_DEBUG_REG		0x0004
#define V4L2_DEBUG_I2C		0x0008
#define V4L2_DEBUG_QUEUE	0x0010
#define V4L2_DEBUG_ISOC		0x0020
#define V4L2_DEBUG_RES_LOCK	0x0040	/* Resource locking */
#define V4L2_DEBUG_OPEN		0x0080	/* video open/close debug */

#define tm6000_err(fmt, arg...) do {\
	printk(KERN_ERR "tm6000 %s :"fmt, \
		__FUNCTION__ , ##arg); } while (0)
Commit	Line	Data
9701dc94	1	/*
e28f49b0	2	tm6000.h - driver for TM5600/TM6000/TM6010 USB video capture devices
9701dc94 MCC	3
	4	Copyright (C) 2006-2007 Mauro Carvalho Chehab <mchehab@infradead.org>
	5
3169c9b2 ML	6	Copyright (C) 2007 Michel Ludwig <michel.ludwig@gmail.com>
	7	- DVB-T support
	8
9701dc94 MCC	9	This program is free software; you can redistribute it and/or modify
	10	it under the terms of the GNU General Public License as published by
	11	the Free Software Foundation version 2
	12
	13	This program is distributed in the hope that it will be useful,
	14	but WITHOUT ANY WARRANTY; without even the implied warranty of
	15	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	16	GNU General Public License for more details.
	17
	18	You should have received a copy of the GNU General Public License
	19	along with this program; if not, write to the Free Software
	20	Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
	21	*/
	22
	23	// Use the tm6000-hack, instead of the proper initialization code
	24	//#define HACK 1
	25
	26	#include <linux/videodev2.h>
	27	#include <media/v4l2-common.h>
	28	#include <media/videobuf-vmalloc.h>
	29	#include "tm6000-usb-isoc.h"
	30	#include <linux/i2c.h>
	31	#include <linux/mutex.h>
427f7fac MCC	32	#include <media/v4l2-device.h>
427f7fac MCC	33
9701dc94	34
3169c9b2 ML	35	#include <linux/dvb/frontend.h>
	36	#include "dvb_demux.h"
	37	#include "dvb_frontend.h"
	38	#include "dmxdev.h"
	39
49e5e03c	40	#define TM6000_VERSION KERNEL_VERSION(0, 0, 2)
9701dc94 MCC	41
9701dc94 MCC	42	/* Inputs */
c85cba3f MCC	43
	44	enum tm6000_itype {
	45	TM6000_INPUT_TV = 0,
	46	TM6000_INPUT_COMPOSITE,
	47	TM6000_INPUT_SVIDEO,
	48	};
	49
29c389be MCC	50	enum tm6000_devtype {
	51	TM6000 = 0,
	52	TM5600,
	53	TM6010,
	54	};
9701dc94 MCC	55
	56	/* ------------------------------------------------------------------
	57	Basic structures
	58	------------------------------------------------------------------*/
	59
	60	struct tm6000_fmt {
	61	char *name;
	62	u32 fourcc; /* v4l2 format id */
	63	int depth;
	64	};
	65
	66	/* buffer for one video frame */
	67	struct tm6000_buffer {
	68	/* common v4l buffer stuff -- must be first */
	69	struct videobuf_buffer vb;
	70
	71	struct tm6000_fmt *fmt;
	72	};
	73
	74	struct tm6000_dmaqueue {
	75	struct list_head active;
	76	struct list_head queued;
9701dc94 MCC	77
	78	/* thread for generating video stream*/
	79	struct task_struct *kthread;
	80	wait_queue_head_t wq;
	81	/* Counters to control fps rate */
	82	int frame;
	83	int ini_jiffies;
	84	};
	85
	86	/* device states */
	87	enum tm6000_core_state {
	88	DEV_INITIALIZED = 0x01,
	89	DEV_DISCONNECTED = 0x02,
	90	DEV_MISCONFIGURED = 0x04,
	91	};
	92
	93	/* io methods */
	94	enum tm6000_io_method {
	95	IO_NONE,
	96	IO_READ,
	97	IO_MMAP,
	98	};
	99
	100	enum tm6000_mode {
	101	TM6000_MODE_UNKNOWN=0,
	102	TM6000_MODE_ANALOG,
	103	TM6000_MODE_DIGITAL,
	104	};
	105
32a2232b SR	106	struct tm6000_gpio {
	107	int tuner_reset;
	108	int tuner_on;
	109	int demod_reset;
	110	int demod_on;
	111	int power_led;
	112	int dvb_led;
	113	int ir;
af9d9cfd	114	};
32a2232b	115
9701dc94 MCC	116	struct tm6000_capabilities {
	117	unsigned int has_tuner:1;
	118	unsigned int has_tda9874:1;
	119	unsigned int has_dvb:1;
	120	unsigned int has_zl10353:1;
	121	unsigned int has_eeprom:1;
4386136d	122	unsigned int has_remote:1;
9701dc94 MCC	123	};
9701dc94 MCC	124
3169c9b2 ML	125	struct tm6000_dvb {
	126	struct dvb_adapter adapter;
	127	struct dvb_demux demux;
	128	struct dvb_frontend *frontend;
	129	struct dmxdev dmxdev;
	130	unsigned int streams;
	131	struct urb *bulk_urb;
	132	struct mutex mutex;
	133	};
	134
6ae635c4 MCC	135	struct tm6000_endpoint {
	136	struct usb_host_endpoint *endp;
	137	__u8 bInterfaceNumber;
	138	__u8 bAlternateSetting;
	139	unsigned maxsize;
	140	};
	141
9701dc94 MCC	142	struct tm6000_core {
	143	/* generic device properties */
	144	char name[30]; /* name (including minor) of the device */
	145	int model; /* index in the device_data struct */
	146	int devno; /* marks the number of this device */
29c389be	147	enum tm6000_devtype dev_type; /* type of device */
3169c9b2 ML	148
3169c9b2 ML	149	v4l2_std_id norm; /* Current norm */
4475c044	150	int width,height; /* Selected resolution */
9701dc94 MCC	151
	152	enum tm6000_core_state state;
	153
	154	/* Device Capabilities*/
	155	struct tm6000_capabilities caps;
	156
	157	/* Tuner configuration */
95a83824 ML	158	int tuner_type; /* type of the tuner */
95a83824 ML	159	int tuner_addr; /* tuner address */
32a2232b SR	160
32a2232b SR	161	struct tm6000_gpio gpio;
95a83824 ML	162
	163	/* Demodulator configuration */
	164	int demod_addr; /* demodulator address */
9701dc94	165
c13dd704	166	int audio_bitrate;
9701dc94 MCC	167	/* i2c i/o */
	168	struct i2c_adapter i2c_adap;
	169	struct i2c_client i2c_client;
	170
0439db75 SR	171
	172	/* extension */
	173	struct list_head devlist;
	174
9701dc94	175	/* video for linux */
9701dc94 MCC	176	int users;
	177
	178	/* various device info */
	179	unsigned int resources;
7c3f53ec	180	struct video_device *vfd;
9701dc94	181	struct tm6000_dmaqueue vidq;
427f7fac	182	struct v4l2_device v4l2_dev;
9701dc94 MCC	183
	184	int input;
	185	int freq;
	186	unsigned int fourcc;
	187
	188	enum tm6000_mode mode;
	189
3169c9b2 ML	190	/* DVB-T support */
	191	struct tm6000_dvb *dvb;
	192
9701dc94 MCC	193	/* locks */
	194	struct mutex lock;
	195
	196	/* usb transfer */
	197	struct usb_device udev; / the usb device */
	198
6ae635c4	199	struct tm6000_endpoint bulk_in, bulk_out, isoc_in, isoc_out;
9701dc94 MCC	200
	201	/* scaler!=0 if scaler is active*/
	202	int scaler;
	203
	204	/* Isoc control struct */
	205	struct usb_isoc_ctl isoc_ctl;
	206
	207	spinlock_t slock;
	208	};
	209
0439db75 SR	210	#define TM6000_AUDIO 0x10
	211
	212	struct tm6000_ops {
	213	struct list_head next;
	214	char *name;
	215	int id;
	216	int (init)(struct tm6000_core );
	217	int (fini)(struct tm6000_core );
	218	};
	219
9701dc94 MCC	220	struct tm6000_fh {
	221	struct tm6000_core *dev;
	222
	223	/* video capture */
	224	struct tm6000_fmt *fmt;
	225	unsigned int width,height;
	226	struct videobuf_queue vb_vidq;
	227
	228	enum v4l2_buf_type type;
	229	};
	230
	231	#define TM6000_STD V4L2_STD_PAL\|V4L2_STD_PAL_N\|V4L2_STD_PAL_Nc\| \
	232	V4L2_STD_PAL_M\|V4L2_STD_PAL_60\|V4L2_STD_NTSC_M\| \
	233	V4L2_STD_NTSC_M_JP\|V4L2_STD_SECAM
	234
e78c8f22 SR	235	/* In tm6000-cards.c */
	236
	237	int tm6000_tuner_callback (void *ptr, int component, int command, int arg);
1b0e48ad	238	int tm6000_xc5000_callback (void *ptr, int component, int command, int arg);
e3ee9e5e MCC	239	int tm6000_cards_setup(struct tm6000_core *dev);
e3ee9e5e MCC	240
9701dc94	241	/* In tm6000-core.c */
9701dc94 MCC	242
	243	int tm6000_read_write_usb (struct tm6000_core *dev, u8 reqtype, u8 req,
	244	u16 value, u16 index, u8 *buf, u16 len);
	245	int tm6000_get_reg (struct tm6000_core *dev, u8 req, u16 value, u16 index);
e3ee9e5e	246	int tm6000_get_reg16(struct tm6000_core *dev, u8 req, u16 value, u16 index);
2f790884	247	int tm6000_get_reg32(struct tm6000_core *dev, u8 req, u16 value, u16 index);
9701dc94	248	int tm6000_set_reg (struct tm6000_core *dev, u8 req, u16 value, u16 index);
2a15ac7a DB	249	int tm6000_i2c_reset(struct tm6000_core *dev, u16 tsleep);
2a15ac7a DB	250
9701dc94	251	int tm6000_init (struct tm6000_core *dev);
9701dc94 MCC	252
9701dc94 MCC	253	int tm6000_init_analog_mode (struct tm6000_core *dev);
3169c9b2	254	int tm6000_init_digital_mode (struct tm6000_core *dev);
9701dc94 MCC	255	int tm6000_set_audio_bitrate (struct tm6000_core *dev, int bitrate);
9701dc94 MCC	256
3169c9b2 ML	257	int tm6000_dvb_register(struct tm6000_core *dev);
	258	void tm6000_dvb_unregister(struct tm6000_core *dev);
	259
9701dc94 MCC	260	int tm6000_v4l2_register(struct tm6000_core *dev);
	261	int tm6000_v4l2_unregister(struct tm6000_core *dev);
	262	int tm6000_v4l2_exit(void);
	263	void tm6000_set_fourcc_format(struct tm6000_core *dev);
	264
0439db75 SR	265	void tm6000_remove_from_devlist(struct tm6000_core *dev);
	266	void tm6000_add_into_devlist(struct tm6000_core *dev);
	267	int tm6000_register_extension(struct tm6000_ops *ops);
	268	void tm6000_unregister_extension(struct tm6000_ops *ops);
	269	void tm6000_init_extension(struct tm6000_core *dev);
	270	void tm6000_close_extension(struct tm6000_core *dev);
	271
5200401a MCC	272	/* In tm6000-stds.c */
	273	void tm6000_get_std_res(struct tm6000_core *dev);
	274	int tm6000_set_standard (struct tm6000_core dev, v4l2_std_id norm);
	275
9701dc94 MCC	276	/* In tm6000-i2c.c */
	277	int tm6000_i2c_register(struct tm6000_core *dev);
	278	int tm6000_i2c_unregister(struct tm6000_core *dev);
9701dc94 MCC	279
	280	/* In tm6000-queue.c */
	281
	282	int tm6000_v4l2_mmap(struct file filp, struct vm_area_struct vma);
	283
	284	int tm6000_vidioc_streamon(struct file file, void priv,
	285	enum v4l2_buf_type i);
	286	int tm6000_vidioc_streamoff(struct file file, void priv,
	287	enum v4l2_buf_type i);
	288	int tm6000_vidioc_reqbufs (struct file file, void priv,
	289	struct v4l2_requestbuffers *rb);
	290	int tm6000_vidioc_querybuf (struct file file, void priv,
	291	struct v4l2_buffer *b);
	292	int tm6000_vidioc_qbuf (struct file file, void priv, struct v4l2_buffer *b);
	293	int tm6000_vidioc_dqbuf (struct file file, void priv, struct v4l2_buffer *b);
	294	ssize_t tm6000_v4l2_read(struct file filp, char __user buf, size_t count,
	295	loff_t * f_pos);
	296	unsigned int tm6000_v4l2_poll(struct file *file,
	297	struct poll_table_struct *wait);
	298	int tm6000_queue_init(struct tm6000_core *dev);
	299
576d5739	300	/* In tm6000-alsa.c */
0439db75	301	/int tm6000_audio_init(struct tm6000_core dev, int idx);*/
576d5739 MCC	302
576d5739 MCC	303
9701dc94 MCC	304	/* Debug stuff */
	305
	306	extern int tm6000_debug;
	307
	308	#define dprintk(dev, level, fmt, arg...) do {\
	309	if (tm6000_debug & level) \
	310	printk(KERN_INFO "(%lu) %s %s :"fmt, jiffies, \
	311	dev->name, __FUNCTION__ , ##arg); } while (0)
	312
	313	#define V4L2_DEBUG_REG 0x0004
	314	#define V4L2_DEBUG_I2C 0x0008
	315	#define V4L2_DEBUG_QUEUE 0x0010
	316	#define V4L2_DEBUG_ISOC 0x0020
	317	#define V4L2_DEBUG_RES_LOCK 0x0040 /* Resource locking */
	318	#define V4L2_DEBUG_OPEN 0x0080 /* video open/close debug */
	319
	320	#define tm6000_err(fmt, arg...) do {\
	321	printk(KERN_ERR "tm6000 %s :"fmt, \
	322	__FUNCTION__ , ##arg); } while (0)
	323
	324