[mirror_ubuntu-artful-kernel.git] / drivers / media / video / au0828 / au0828.h

/*
 *  Driver for the Auvitek AU0828 USB bridge
 *
 *  Copyright (c) 2008 Steven Toth <stoth@linuxtv.org>
 *
 *  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.
 */

#include <linux/usb.h>
#include <linux/i2c.h>
#include <linux/i2c-algo-bit.h>
#include <media/tveeprom.h>

/* Analog */
#include <linux/videodev2.h>
#include <media/videobuf-vmalloc.h>
#include <media/v4l2-device.h>

/* DVB */
#include "demux.h"
#include "dmxdev.h"
#include "dvb_demux.h"
#include "dvb_frontend.h"
#include "dvb_net.h"
#include "dvbdev.h"

#include "au0828-reg.h"
#include "au0828-cards.h"

#define DRIVER_NAME "au0828"
#define URB_COUNT   16
#define URB_BUFSIZE (0xe522)

/* Analog constants */
#define NTSC_STD_W      720
#define NTSC_STD_H      480

#define AU0828_INTERLACED_DEFAULT       1
#define V4L2_CID_PRIVATE_SHARPNESS  (V4L2_CID_PRIVATE_BASE + 0)

/* Defination for AU0828 USB transfer */
#define AU0828_MAX_ISO_BUFS    12  /* maybe resize this value in the future */
#define AU0828_ISO_PACKETS_PER_URB      128

#define AU0828_MIN_BUF 4
#define AU0828_DEF_BUF 8

#define AU0828_MAX_INPUT        4

/* au0828 resource types (used for res_get/res_lock etc */
#define AU0828_RESOURCE_VIDEO 0x01
#define AU0828_RESOURCE_VBI   0x02

enum au0828_itype {
	AU0828_VMUX_UNDEFINED = 0,
	AU0828_VMUX_COMPOSITE,
	AU0828_VMUX_SVIDEO,
	AU0828_VMUX_CABLE,
	AU0828_VMUX_TELEVISION,
	AU0828_VMUX_DVB,
	AU0828_VMUX_DEBUG
};

struct au0828_input {
	enum au0828_itype type;
	unsigned int vmux;
	unsigned int amux;
	void (*audio_setup) (void *priv, int enable);
};

struct au0828_board {
	char *name;
	unsigned int tuner_type;
	unsigned char tuner_addr;
	unsigned char i2c_clk_divider;
	struct au0828_input input[AU0828_MAX_INPUT];

};

struct au0828_dvb {
	struct mutex lock;
	struct dvb_adapter adapter;
	struct dvb_frontend *frontend;
	struct dvb_demux demux;
	struct dmxdev dmxdev;
	struct dmx_frontend fe_hw;
	struct dmx_frontend fe_mem;
	struct dvb_net net;
	int feeding;
};

enum au0828_stream_state {
	STREAM_OFF,
	STREAM_INTERRUPT,
	STREAM_ON
};

#define AUVI_INPUT(nr) (dev->board.input[nr])

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

struct au0828_fh {
	struct au0828_dev *dev;
	unsigned int  resources;

	struct videobuf_queue        vb_vidq;
	struct videobuf_queue        vb_vbiq;
	enum v4l2_buf_type           type;
};

struct au0828_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 au0828_buffer		*buf;
	struct au0828_buffer		*vbi_buf;

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

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

};

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

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

struct au0828_dmaqueue {
	struct list_head       active;
	struct list_head       queued;

	wait_queue_head_t          wq;

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

struct au0828_dev {
	struct mutex mutex;
	struct usb_device	*usbdev;
	int			boardnr;
	struct au0828_board	board;
	u8			ctrlmsg[64];

	/* I2C */
	struct i2c_adapter		i2c_adap;
	struct i2c_algorithm		i2c_algo;
	struct i2c_client		i2c_client;
	u32 				i2c_rc;

	/* Digital */
	struct au0828_dvb		dvb;

	/* Analog */
	struct v4l2_device v4l2_dev;
	int users;
	unsigned int resources;	/* resources in use */
	struct video_device *vdev;
	struct video_device *vbi_dev;
	struct timer_list vid_timeout;
	struct timer_list vbi_timeout;
	int width;
	int height;
	int vbi_width;
	int vbi_height;
	u32 vbi_read;
	u32 field_size;
	u32 frame_size;
	u32 bytesperline;
	int type;
	u8 ctrl_ainput;
	__u8 isoc_in_endpointaddr;
	u8 isoc_init_ok;
	int greenscreen_detected;
	unsigned int frame_count;
	int ctrl_freq;
	int input_type;
	unsigned int ctrl_input;
	enum au0828_dev_state dev_state;
	enum au0828_stream_state stream_state;
	wait_queue_head_t open;

	struct mutex lock;

	/* Isoc control struct */
	struct au0828_dmaqueue vidq;
	struct au0828_dmaqueue vbiq;
	struct au0828_usb_isoc_ctl isoc_ctl;
	spinlock_t slock;

	/* usb transfer */
	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[AU0828_MAX_ISO_BUFS];	/* urb for isoc transfers */
	char *transfer_buffer[AU0828_MAX_ISO_BUFS];/* transfer buffers for isoc
						   transfer */

	/* USB / URB Related */
	int		urb_streaming;
	struct urb	*urbs[URB_COUNT];
};

/* ----------------------------------------------------------- */
#define au0828_read(dev, reg) au0828_readreg(dev, reg)
#define au0828_write(dev, reg, value) au0828_writereg(dev, reg, value)
#define au0828_andor(dev, reg, mask, value) 				\
	 au0828_writereg(dev, reg, 					\
	(au0828_readreg(dev, reg) & ~(mask)) | ((value) & (mask)))

#define au0828_set(dev, reg, bit) au0828_andor(dev, (reg), (bit), (bit))
#define au0828_clear(dev, reg, bit) au0828_andor(dev, (reg), (bit), 0)

/* ----------------------------------------------------------- */
/* au0828-core.c */
extern u32 au0828_read(struct au0828_dev *dev, u16 reg);
extern u32 au0828_write(struct au0828_dev *dev, u16 reg, u32 val);
extern int au0828_debug;

/* ----------------------------------------------------------- */
/* au0828-cards.c */
extern struct au0828_board au0828_boards[];
extern struct usb_device_id au0828_usb_id_table[];
extern void au0828_gpio_setup(struct au0828_dev *dev);
extern int au0828_tuner_callback(void *priv, int component,
				 int command, int arg);
extern void au0828_card_setup(struct au0828_dev *dev);

/* ----------------------------------------------------------- */
/* au0828-i2c.c */
extern int au0828_i2c_register(struct au0828_dev *dev);
extern int au0828_i2c_unregister(struct au0828_dev *dev);

/* ----------------------------------------------------------- */
/* au0828-video.c */
int au0828_analog_register(struct au0828_dev *dev,
			   struct usb_interface *interface);
int au0828_analog_stream_disable(struct au0828_dev *d);
void au0828_analog_unregister(struct au0828_dev *dev);

/* ----------------------------------------------------------- */
/* au0828-dvb.c */
extern int au0828_dvb_register(struct au0828_dev *dev);
extern void au0828_dvb_unregister(struct au0828_dev *dev);

/* au0828-vbi.c */
extern struct videobuf_queue_ops au0828_vbi_qops;

#define dprintk(level, fmt, arg...)\
	do { if (au0828_debug & level)\
		printk(KERN_DEBUG DRIVER_NAME "/0: " fmt, ## arg);\
	} while (0)
Commit	Line	Data
265a6510 ST	1	/*
	2	* Driver for the Auvitek AU0828 USB bridge
	3	*
6d897616	4	* Copyright (c) 2008 Steven Toth <stoth@linuxtv.org>
265a6510 ST	5	*
	6	* This program is free software; you can redistribute it and/or modify
	7	* it under the terms of the GNU General Public License as published by
	8	* the Free Software Foundation; either version 2 of the License, or
	9	* (at your option) any later version.
	10	*
	11	* This program is distributed in the hope that it will be useful,
	12	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	13	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	14	*
	15	* GNU General Public License for more details.
	16	*
	17	* You should have received a copy of the GNU General Public License
	18	* along with this program; if not, write to the Free Software
	19	* Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
	20	*/
	21
	22	#include <linux/usb.h>
	23	#include <linux/i2c.h>
	24	#include <linux/i2c-algo-bit.h>
28930fa9	25	#include <media/tveeprom.h>
265a6510	26
8b2f0795 DH	27	/* Analog */
	28	#include <linux/videodev2.h>
	29	#include <media/videobuf-vmalloc.h>
b14667f3	30	#include <media/v4l2-device.h>
8b2f0795	31
265a6510 ST	32	/* DVB */
	33	#include "demux.h"
	34	#include "dmxdev.h"
	35	#include "dvb_demux.h"
	36	#include "dvb_frontend.h"
	37	#include "dvb_net.h"
	38	#include "dvbdev.h"
	39
	40	#include "au0828-reg.h"
	41	#include "au0828-cards.h"
	42
	43	#define DRIVER_NAME "au0828"
	44	#define URB_COUNT 16
265a6510 ST	45	#define URB_BUFSIZE (0xe522)
265a6510 ST	46
8b2f0795 DH	47	/* Analog constants */
	48	#define NTSC_STD_W 720
	49	#define NTSC_STD_H 480
	50
	51	#define AU0828_INTERLACED_DEFAULT 1
	52	#define V4L2_CID_PRIVATE_SHARPNESS (V4L2_CID_PRIVATE_BASE + 0)
	53
	54	/* Defination for AU0828 USB transfer */
	55	#define AU0828_MAX_ISO_BUFS 12 /* maybe resize this value in the future */
83f859c5	56	#define AU0828_ISO_PACKETS_PER_URB 128
8b2f0795 DH	57
	58	#define AU0828_MIN_BUF 4
	59	#define AU0828_DEF_BUF 8
	60
8b2f0795 DH	61	#define AU0828_MAX_INPUT 4
8b2f0795 DH	62
7f8eacd2 DH	63	/* au0828 resource types (used for res_get/res_lock etc */
	64	#define AU0828_RESOURCE_VIDEO 0x01
	65	#define AU0828_RESOURCE_VBI 0x02
	66
8b2f0795	67	enum au0828_itype {
220be77c DH	68	AU0828_VMUX_UNDEFINED = 0,
220be77c DH	69	AU0828_VMUX_COMPOSITE,
8b2f0795 DH	70	AU0828_VMUX_SVIDEO,
	71	AU0828_VMUX_CABLE,
	72	AU0828_VMUX_TELEVISION,
	73	AU0828_VMUX_DVB,
	74	AU0828_VMUX_DEBUG
	75	};
	76
	77	struct au0828_input {
	78	enum au0828_itype type;
	79	unsigned int vmux;
	80	unsigned int amux;
	81	void (audio_setup) (void priv, int enable);
	82	};
	83
265a6510 ST	84	struct au0828_board {
265a6510 ST	85	char *name;
f1add5b5 DH	86	unsigned int tuner_type;
f1add5b5 DH	87	unsigned char tuner_addr;
16af6f5a	88	unsigned char i2c_clk_divider;
8b2f0795 DH	89	struct au0828_input input[AU0828_MAX_INPUT];
8b2f0795 DH	90
265a6510 ST	91	};
	92
	93	struct au0828_dvb {
	94	struct mutex lock;
	95	struct dvb_adapter adapter;
	96	struct dvb_frontend *frontend;
	97	struct dvb_demux demux;
	98	struct dmxdev dmxdev;
	99	struct dmx_frontend fe_hw;
	100	struct dmx_frontend fe_mem;
	101	struct dvb_net net;
	102	int feeding;
	103	};
	104
8b2f0795 DH	105	enum au0828_stream_state {
	106	STREAM_OFF,
	107	STREAM_INTERRUPT,
	108	STREAM_ON
	109	};
	110
f1add5b5	111	#define AUVI_INPUT(nr) (dev->board.input[nr])
8b2f0795 DH	112
	113	/* device state */
	114	enum au0828_dev_state {
	115	DEV_INITIALIZED = 0x01,
	116	DEV_DISCONNECTED = 0x02,
	117	DEV_MISCONFIGURED = 0x04
	118	};
	119
	120	struct au0828_fh {
	121	struct au0828_dev *dev;
7f8eacd2 DH	122	unsigned int resources;
7f8eacd2 DH	123
8b2f0795	124	struct videobuf_queue vb_vidq;
7f8eacd2	125	struct videobuf_queue vb_vbiq;
8b2f0795 DH	126	enum v4l2_buf_type type;
	127	};
	128
	129	struct au0828_usb_isoc_ctl {
	130	/* max packet size of isoc transaction */
	131	int max_pkt_size;
	132
	133	/* number of allocated urbs */
	134	int num_bufs;
	135
	136	/* urb for isoc transfers */
	137	struct urb **urb;
	138
	139	/* transfer buffers for isoc transfer */
	140	char **transfer_buffer;
	141
	142	/* Last buffer command and region */
	143	u8 cmd;
	144	int pos, size, pktsize;
	145
	146	/* Last field: ODD or EVEN? */
	147	int field;
	148
	149	/* Stores incomplete commands */
	150	u32 tmp_buf;
	151	int tmp_buf_len;
	152
	153	/* Stores already requested buffers */
7f8eacd2 DH	154	struct au0828_buffer *buf;
7f8eacd2 DH	155	struct au0828_buffer *vbi_buf;
8b2f0795 DH	156
	157	/* Stores the number of received fields */
	158	int nfields;
	159
	160	/* isoc urb callback */
	161	int (isoc_copy) (struct au0828_dev dev, struct urb *urb);
	162
	163	};
	164
	165	/* buffer for one video frame */
	166	struct au0828_buffer {
	167	/* common v4l buffer stuff -- must be first */
	168	struct videobuf_buffer vb;
	169
	170	struct list_head frame;
	171	int top_field;
	172	int receiving;
	173	};
	174
	175	struct au0828_dmaqueue {
	176	struct list_head active;
	177	struct list_head queued;
	178
	179	wait_queue_head_t wq;
	180
	181	/* Counters to control buffer fill */
	182	int pos;
	183	};
	184
265a6510 ST	185	struct au0828_dev {
	186	struct mutex mutex;
	187	struct usb_device *usbdev;
f1add5b5 DH	188	int boardnr;
f1add5b5 DH	189	struct au0828_board board;
265a6510 ST	190	u8 ctrlmsg[64];
	191
	192	/* I2C */
	193	struct i2c_adapter i2c_adap;
b14667f3	194	struct i2c_algorithm i2c_algo;
265a6510 ST	195	struct i2c_client i2c_client;
	196	u32 i2c_rc;
	197
	198	/* Digital */
	199	struct au0828_dvb dvb;
	200
8b2f0795	201	/* Analog */
b14667f3	202	struct v4l2_device v4l2_dev;
8b2f0795	203	int users;
7f8eacd2	204	unsigned int resources; /* resources in use */
8b2f0795 DH	205	struct video_device *vdev;
8b2f0795 DH	206	struct video_device *vbi_dev;
6e04b7b9 DH	207	struct timer_list vid_timeout;
6e04b7b9 DH	208	struct timer_list vbi_timeout;
8b2f0795 DH	209	int width;
8b2f0795 DH	210	int height;
7f8eacd2 DH	211	int vbi_width;
	212	int vbi_height;
	213	u32 vbi_read;
8b2f0795 DH	214	u32 field_size;
	215	u32 frame_size;
	216	u32 bytesperline;
	217	int type;
	218	u8 ctrl_ainput;
	219	__u8 isoc_in_endpointaddr;
	220	u8 isoc_init_ok;
	221	int greenscreen_detected;
	222	unsigned int frame_count;
	223	int ctrl_freq;
	224	int input_type;
	225	unsigned int ctrl_input;
	226	enum au0828_dev_state dev_state;
	227	enum au0828_stream_state stream_state;
	228	wait_queue_head_t open;
	229
	230	struct mutex lock;
	231
	232	/* Isoc control struct */
	233	struct au0828_dmaqueue vidq;
7f8eacd2	234	struct au0828_dmaqueue vbiq;
8b2f0795 DH	235	struct au0828_usb_isoc_ctl isoc_ctl;
	236	spinlock_t slock;
	237
	238	/* usb transfer */
	239	int alt; /* alternate */
	240	int max_pkt_size; /* max packet size of isoc transaction */
	241	int num_alt; /* Number of alternative settings */
	242	unsigned int alt_max_pkt_size; / array of wMaxPacketSize */
	243	struct urb urb[AU0828_MAX_ISO_BUFS]; / urb for isoc transfers */
	244	char transfer_buffer[AU0828_MAX_ISO_BUFS];/ transfer buffers for isoc
	245	transfer */
	246
265a6510 ST	247	/* USB / URB Related */
	248	int urb_streaming;
	249	struct urb *urbs[URB_COUNT];
265a6510 ST	250	};
	251
	252	/* ----------------------------------------------------------- */
18d73c58 MCC	253	#define au0828_read(dev, reg) au0828_readreg(dev, reg)
	254	#define au0828_write(dev, reg, value) au0828_writereg(dev, reg, value)
	255	#define au0828_andor(dev, reg, mask, value) \
	256	au0828_writereg(dev, reg, \
	257	(au0828_readreg(dev, reg) & ~(mask)) \| ((value) & (mask)))
	258
	259	#define au0828_set(dev, reg, bit) au0828_andor(dev, (reg), (bit), (bit))
	260	#define au0828_clear(dev, reg, bit) au0828_andor(dev, (reg), (bit), 0)
265a6510 ST	261
	262	/* ----------------------------------------------------------- */
	263	/* au0828-core.c */
	264	extern u32 au0828_read(struct au0828_dev *dev, u16 reg);
	265	extern u32 au0828_write(struct au0828_dev *dev, u16 reg, u32 val);
b33d24c4	266	extern int au0828_debug;
265a6510 ST	267
	268	/* ----------------------------------------------------------- */
	269	/* au0828-cards.c */
	270	extern struct au0828_board au0828_boards[];
	271	extern struct usb_device_id au0828_usb_id_table[];
265a6510	272	extern void au0828_gpio_setup(struct au0828_dev *dev);
d7cba043 MK	273	extern int au0828_tuner_callback(void *priv, int component,
d7cba043 MK	274	int command, int arg);
28930fa9	275	extern void au0828_card_setup(struct au0828_dev *dev);
265a6510 ST	276
	277	/* ----------------------------------------------------------- */
	278	/* au0828-i2c.c */
	279	extern int au0828_i2c_register(struct au0828_dev *dev);
	280	extern int au0828_i2c_unregister(struct au0828_dev *dev);
265a6510	281
8b2f0795 DH	282	/* ----------------------------------------------------------- */
8b2f0795 DH	283	/* au0828-video.c */
fc4ce6cd DH	284	int au0828_analog_register(struct au0828_dev *dev,
fc4ce6cd DH	285	struct usb_interface *interface);
8b2f0795 DH	286	int au0828_analog_stream_disable(struct au0828_dev *d);
	287	void au0828_analog_unregister(struct au0828_dev *dev);
	288
265a6510 ST	289	/* ----------------------------------------------------------- */
	290	/* au0828-dvb.c */
	291	extern int au0828_dvb_register(struct au0828_dev *dev);
	292	extern void au0828_dvb_unregister(struct au0828_dev *dev);
bc3c613c	293
7f8eacd2 DH	294	/* au0828-vbi.c */
	295	extern struct videobuf_queue_ops au0828_vbi_qops;
	296
bc3c613c	297	#define dprintk(level, fmt, arg...)\
b33d24c4	298	do { if (au0828_debug & level)\
bc3c613c ST	299	printk(KERN_DEBUG DRIVER_NAME "/0: " fmt, ## arg);\
bc3c613c ST	300	} while (0)