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