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