1 /*
2  *  Driver for the Auvitek 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 "au0828.h"
23 
24 #include <linux/module.h>
25 #include <linux/slab.h>
26 #include <linux/videodev2.h>
27 #include <media/v4l2-common.h>
28 #include <linux/mutex.h>
29 
30 /*
31  * 1 = General debug messages
32  * 2 = USB handling
33  * 4 = I2C related
34  * 8 = Bridge related
35  * 16 = IR related
36  */
37 int au0828_debug;
38 module_param_named(debug, au0828_debug, int, 0644);
39 MODULE_PARM_DESC(debug,
40 		 "set debug bitmask: 1=general, 2=USB, 4=I2C, 8=bridge, 16=IR");
41 
42 static unsigned int disable_usb_speed_check;
43 module_param(disable_usb_speed_check, int, 0444);
44 MODULE_PARM_DESC(disable_usb_speed_check,
45 		 "override min bandwidth requirement of 480M bps");
46 
47 #define _AU0828_BULKPIPE 0x03
48 #define _BULKPIPESIZE 0xffff
49 
50 static int send_control_msg(struct au0828_dev *dev, u16 request, u32 value,
51 			    u16 index);
52 static int recv_control_msg(struct au0828_dev *dev, u16 request, u32 value,
53 	u16 index, unsigned char *cp, u16 size);
54 
55 /* USB Direction */
56 #define CMD_REQUEST_IN		0x00
57 #define CMD_REQUEST_OUT		0x01
58 
59 u32 au0828_readreg(struct au0828_dev *dev, u16 reg)
60 {
61 	u8 result = 0;
62 
63 	recv_control_msg(dev, CMD_REQUEST_IN, 0, reg, &result, 1);
64 	dprintk(8, "%s(0x%04x) = 0x%02x\n", __func__, reg, result);
65 
66 	return result;
67 }
68 
69 u32 au0828_writereg(struct au0828_dev *dev, u16 reg, u32 val)
70 {
71 	dprintk(8, "%s(0x%04x, 0x%02x)\n", __func__, reg, val);
72 	return send_control_msg(dev, CMD_REQUEST_OUT, val, reg);
73 }
74 
75 static int send_control_msg(struct au0828_dev *dev, u16 request, u32 value,
76 	u16 index)
77 {
78 	int status = -ENODEV;
79 
80 	if (dev->usbdev) {
81 
82 		/* cp must be memory that has been allocated by kmalloc */
83 		status = usb_control_msg(dev->usbdev,
84 				usb_sndctrlpipe(dev->usbdev, 0),
85 				request,
86 				USB_DIR_OUT | USB_TYPE_VENDOR |
87 					USB_RECIP_DEVICE,
88 				value, index, NULL, 0, 1000);
89 
90 		status = min(status, 0);
91 
92 		if (status < 0) {
93 			pr_err("%s() Failed sending control message, error %d.\n",
94 				__func__, status);
95 		}
96 
97 	}
98 
99 	return status;
100 }
101 
102 static int recv_control_msg(struct au0828_dev *dev, u16 request, u32 value,
103 	u16 index, unsigned char *cp, u16 size)
104 {
105 	int status = -ENODEV;
106 	mutex_lock(&dev->mutex);
107 	if (dev->usbdev) {
108 		status = usb_control_msg(dev->usbdev,
109 				usb_rcvctrlpipe(dev->usbdev, 0),
110 				request,
111 				USB_DIR_IN | USB_TYPE_VENDOR | USB_RECIP_DEVICE,
112 				value, index,
113 				dev->ctrlmsg, size, 1000);
114 
115 		status = min(status, 0);
116 
117 		if (status < 0) {
118 			pr_err("%s() Failed receiving control message, error %d.\n",
119 				__func__, status);
120 		}
121 
122 		/* the host controller requires heap allocated memory, which
123 		   is why we didn't just pass "cp" into usb_control_msg */
124 		memcpy(cp, dev->ctrlmsg, size);
125 	}
126 	mutex_unlock(&dev->mutex);
127 	return status;
128 }
129 
130 static void au0828_usb_release(struct au0828_dev *dev)
131 {
132 	/* I2C */
133 	au0828_i2c_unregister(dev);
134 
135 	kfree(dev);
136 }
137 
138 #ifdef CONFIG_VIDEO_AU0828_V4L2
139 static void au0828_usb_v4l2_release(struct v4l2_device *v4l2_dev)
140 {
141 	struct au0828_dev *dev =
142 		container_of(v4l2_dev, struct au0828_dev, v4l2_dev);
143 
144 	v4l2_ctrl_handler_free(&dev->v4l2_ctrl_hdl);
145 	v4l2_device_unregister(&dev->v4l2_dev);
146 	au0828_usb_release(dev);
147 }
148 #endif
149 
150 static void au0828_usb_disconnect(struct usb_interface *interface)
151 {
152 	struct au0828_dev *dev = usb_get_intfdata(interface);
153 
154 	dprintk(1, "%s()\n", __func__);
155 
156 	au0828_rc_unregister(dev);
157 	/* Digital TV */
158 	au0828_dvb_unregister(dev);
159 
160 	usb_set_intfdata(interface, NULL);
161 	mutex_lock(&dev->mutex);
162 	dev->usbdev = NULL;
163 	mutex_unlock(&dev->mutex);
164 #ifdef CONFIG_VIDEO_AU0828_V4L2
165 	if (AUVI_INPUT(0).type != AU0828_VMUX_UNDEFINED) {
166 		au0828_analog_unregister(dev);
167 		v4l2_device_disconnect(&dev->v4l2_dev);
168 		v4l2_device_put(&dev->v4l2_dev);
169 		return;
170 	}
171 #endif
172 	au0828_usb_release(dev);
173 }
174 
175 static int au0828_usb_probe(struct usb_interface *interface,
176 	const struct usb_device_id *id)
177 {
178 	int ifnum;
179 	int retval = 0;
180 
181 	struct au0828_dev *dev;
182 	struct usb_device *usbdev = interface_to_usbdev(interface);
183 
184 	ifnum = interface->altsetting->desc.bInterfaceNumber;
185 
186 	if (ifnum != 0)
187 		return -ENODEV;
188 
189 	dprintk(1, "%s() vendor id 0x%x device id 0x%x ifnum:%d\n", __func__,
190 		le16_to_cpu(usbdev->descriptor.idVendor),
191 		le16_to_cpu(usbdev->descriptor.idProduct),
192 		ifnum);
193 
194 	/*
195 	 * Make sure we have 480 Mbps of bandwidth, otherwise things like
196 	 * video stream wouldn't likely work, since 12 Mbps is generally
197 	 * not enough even for most Digital TV streams.
198 	 */
199 	if (usbdev->speed != USB_SPEED_HIGH && disable_usb_speed_check == 0) {
200 		pr_err("au0828: Device initialization failed.\n");
201 		pr_err("au0828: Device must be connected to a high-speed USB 2.0 port.\n");
202 		return -ENODEV;
203 	}
204 
205 	dev = kzalloc(sizeof(*dev), GFP_KERNEL);
206 	if (dev == NULL) {
207 		pr_err("%s() Unable to allocate memory\n", __func__);
208 		return -ENOMEM;
209 	}
210 
211 	mutex_init(&dev->lock);
212 	mutex_lock(&dev->lock);
213 	mutex_init(&dev->mutex);
214 	mutex_init(&dev->dvb.lock);
215 	dev->usbdev = usbdev;
216 	dev->boardnr = id->driver_info;
217 
218 #ifdef CONFIG_VIDEO_AU0828_V4L2
219 	dev->v4l2_dev.release = au0828_usb_v4l2_release;
220 
221 	/* Create the v4l2_device */
222 	retval = v4l2_device_register(&interface->dev, &dev->v4l2_dev);
223 	if (retval) {
224 		pr_err("%s() v4l2_device_register failed\n",
225 		       __func__);
226 		mutex_unlock(&dev->lock);
227 		kfree(dev);
228 		return retval;
229 	}
230 	/* This control handler will inherit the controls from au8522 */
231 	retval = v4l2_ctrl_handler_init(&dev->v4l2_ctrl_hdl, 4);
232 	if (retval) {
233 		pr_err("%s() v4l2_ctrl_handler_init failed\n",
234 		       __func__);
235 		mutex_unlock(&dev->lock);
236 		kfree(dev);
237 		return retval;
238 	}
239 	dev->v4l2_dev.ctrl_handler = &dev->v4l2_ctrl_hdl;
240 #endif
241 
242 	/* Power Up the bridge */
243 	au0828_write(dev, REG_600, 1 << 4);
244 
245 	/* Bring up the GPIO's and supporting devices */
246 	au0828_gpio_setup(dev);
247 
248 	/* I2C */
249 	au0828_i2c_register(dev);
250 
251 	/* Setup */
252 	au0828_card_setup(dev);
253 
254 #ifdef CONFIG_VIDEO_AU0828_V4L2
255 	/* Analog TV */
256 	if (AUVI_INPUT(0).type != AU0828_VMUX_UNDEFINED)
257 		au0828_analog_register(dev, interface);
258 #endif
259 
260 	/* Digital TV */
261 	retval = au0828_dvb_register(dev);
262 	if (retval)
263 		pr_err("%s() au0282_dev_register failed\n",
264 		       __func__);
265 
266 	/* Remote controller */
267 	au0828_rc_register(dev);
268 
269 	/*
270 	 * Store the pointer to the au0828_dev so it can be accessed in
271 	 * au0828_usb_disconnect
272 	 */
273 	usb_set_intfdata(interface, dev);
274 
275 	pr_info("Registered device AU0828 [%s]\n",
276 		dev->board.name == NULL ? "Unset" : dev->board.name);
277 
278 	mutex_unlock(&dev->lock);
279 
280 	return retval;
281 }
282 
283 static int au0828_suspend(struct usb_interface *interface,
284 				pm_message_t message)
285 {
286 	struct au0828_dev *dev = usb_get_intfdata(interface);
287 
288 	if (!dev)
289 		return 0;
290 
291 	pr_info("Suspend\n");
292 
293 	au0828_rc_suspend(dev);
294 	au0828_v4l2_suspend(dev);
295 	au0828_dvb_suspend(dev);
296 
297 	/* FIXME: should suspend also ATV/DTV */
298 
299 	return 0;
300 }
301 
302 static int au0828_resume(struct usb_interface *interface)
303 {
304 	struct au0828_dev *dev = usb_get_intfdata(interface);
305 	if (!dev)
306 		return 0;
307 
308 	pr_info("Resume\n");
309 
310 	/* Power Up the bridge */
311 	au0828_write(dev, REG_600, 1 << 4);
312 
313 	/* Bring up the GPIO's and supporting devices */
314 	au0828_gpio_setup(dev);
315 
316 	au0828_rc_resume(dev);
317 	au0828_v4l2_resume(dev);
318 	au0828_dvb_resume(dev);
319 
320 	/* FIXME: should resume also ATV/DTV */
321 
322 	return 0;
323 }
324 
325 static struct usb_driver au0828_usb_driver = {
326 	.name		= KBUILD_MODNAME,
327 	.probe		= au0828_usb_probe,
328 	.disconnect	= au0828_usb_disconnect,
329 	.id_table	= au0828_usb_id_table,
330 	.suspend	= au0828_suspend,
331 	.resume		= au0828_resume,
332 	.reset_resume	= au0828_resume,
333 };
334 
335 static int __init au0828_init(void)
336 {
337 	int ret;
338 
339 	if (au0828_debug & 1)
340 		pr_info("%s() Debugging is enabled\n", __func__);
341 
342 	if (au0828_debug & 2)
343 		pr_info("%s() USB Debugging is enabled\n", __func__);
344 
345 	if (au0828_debug & 4)
346 		pr_info("%s() I2C Debugging is enabled\n", __func__);
347 
348 	if (au0828_debug & 8)
349 		pr_info("%s() Bridge Debugging is enabled\n",
350 		       __func__);
351 
352 	if (au0828_debug & 16)
353 		pr_info("%s() IR Debugging is enabled\n",
354 		       __func__);
355 
356 	pr_info("au0828 driver loaded\n");
357 
358 	ret = usb_register(&au0828_usb_driver);
359 	if (ret)
360 		pr_err("usb_register failed, error = %d\n", ret);
361 
362 	return ret;
363 }
364 
365 static void __exit au0828_exit(void)
366 {
367 	usb_deregister(&au0828_usb_driver);
368 }
369 
370 module_init(au0828_init);
371 module_exit(au0828_exit);
372 
373 MODULE_DESCRIPTION("Driver for Auvitek AU0828 based products");
374 MODULE_AUTHOR("Steven Toth <stoth@linuxtv.org>");
375 MODULE_LICENSE("GPL");
376 MODULE_VERSION("0.0.3");
377