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 <linux/module.h>
23 #include <linux/slab.h>
24 #include <linux/videodev2.h>
25 #include <media/v4l2-common.h>
26 #include <linux/mutex.h>
27 
28 #include "au0828.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 			printk(KERN_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 			printk(KERN_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 #ifdef CONFIG_VIDEO_AU0828_RC
157 	au0828_rc_unregister(dev);
158 #endif
159 	/* Digital TV */
160 	au0828_dvb_unregister(dev);
161 
162 	usb_set_intfdata(interface, NULL);
163 	mutex_lock(&dev->mutex);
164 	dev->usbdev = NULL;
165 	mutex_unlock(&dev->mutex);
166 #ifdef CONFIG_VIDEO_AU0828_V4L2
167 	if (AUVI_INPUT(0).type != AU0828_VMUX_UNDEFINED) {
168 		au0828_analog_unregister(dev);
169 		v4l2_device_disconnect(&dev->v4l2_dev);
170 		v4l2_device_put(&dev->v4l2_dev);
171 		return;
172 	}
173 #endif
174 	au0828_usb_release(dev);
175 }
176 
177 static int au0828_usb_probe(struct usb_interface *interface,
178 	const struct usb_device_id *id)
179 {
180 	int ifnum;
181 	int retval = 0;
182 
183 	struct au0828_dev *dev;
184 	struct usb_device *usbdev = interface_to_usbdev(interface);
185 
186 	ifnum = interface->altsetting->desc.bInterfaceNumber;
187 
188 	if (ifnum != 0)
189 		return -ENODEV;
190 
191 	dprintk(1, "%s() vendor id 0x%x device id 0x%x ifnum:%d\n", __func__,
192 		le16_to_cpu(usbdev->descriptor.idVendor),
193 		le16_to_cpu(usbdev->descriptor.idProduct),
194 		ifnum);
195 
196 	/*
197 	 * Make sure we have 480 Mbps of bandwidth, otherwise things like
198 	 * video stream wouldn't likely work, since 12 Mbps is generally
199 	 * not enough even for most Digital TV streams.
200 	 */
201 	if (usbdev->speed != USB_SPEED_HIGH && disable_usb_speed_check == 0) {
202 		printk(KERN_ERR "au0828: Device initialization failed.\n");
203 		printk(KERN_ERR "au0828: Device must be connected to a "
204 		       "high-speed USB 2.0 port.\n");
205 		return -ENODEV;
206 	}
207 
208 	dev = kzalloc(sizeof(*dev), GFP_KERNEL);
209 	if (dev == NULL) {
210 		printk(KERN_ERR "%s() Unable to allocate memory\n", __func__);
211 		return -ENOMEM;
212 	}
213 
214 	mutex_init(&dev->lock);
215 	mutex_lock(&dev->lock);
216 	mutex_init(&dev->mutex);
217 	mutex_init(&dev->dvb.lock);
218 	dev->usbdev = usbdev;
219 	dev->boardnr = id->driver_info;
220 
221 #ifdef CONFIG_VIDEO_AU0828_V4L2
222 	dev->v4l2_dev.release = au0828_usb_v4l2_release;
223 
224 	/* Create the v4l2_device */
225 	retval = v4l2_device_register(&interface->dev, &dev->v4l2_dev);
226 	if (retval) {
227 		pr_err("%s() v4l2_device_register failed\n",
228 		       __func__);
229 		mutex_unlock(&dev->lock);
230 		kfree(dev);
231 		return retval;
232 	}
233 	/* This control handler will inherit the controls from au8522 */
234 	retval = v4l2_ctrl_handler_init(&dev->v4l2_ctrl_hdl, 4);
235 	if (retval) {
236 		pr_err("%s() v4l2_ctrl_handler_init failed\n",
237 		       __func__);
238 		mutex_unlock(&dev->lock);
239 		kfree(dev);
240 		return retval;
241 	}
242 	dev->v4l2_dev.ctrl_handler = &dev->v4l2_ctrl_hdl;
243 #endif
244 
245 	/* Power Up the bridge */
246 	au0828_write(dev, REG_600, 1 << 4);
247 
248 	/* Bring up the GPIO's and supporting devices */
249 	au0828_gpio_setup(dev);
250 
251 	/* I2C */
252 	au0828_i2c_register(dev);
253 
254 	/* Setup */
255 	au0828_card_setup(dev);
256 
257 #ifdef CONFIG_VIDEO_AU0828_V4L2
258 	/* Analog TV */
259 	if (AUVI_INPUT(0).type != AU0828_VMUX_UNDEFINED)
260 		au0828_analog_register(dev, interface);
261 #endif
262 
263 	/* Digital TV */
264 	retval = au0828_dvb_register(dev);
265 	if (retval)
266 		pr_err("%s() au0282_dev_register failed\n",
267 		       __func__);
268 
269 #ifdef CONFIG_VIDEO_AU0828_RC
270 	/* Remote controller */
271 	au0828_rc_register(dev);
272 #endif
273 
274 	/*
275 	 * Store the pointer to the au0828_dev so it can be accessed in
276 	 * au0828_usb_disconnect
277 	 */
278 	usb_set_intfdata(interface, dev);
279 
280 	printk(KERN_INFO "Registered device AU0828 [%s]\n",
281 		dev->board.name == NULL ? "Unset" : dev->board.name);
282 
283 	mutex_unlock(&dev->lock);
284 
285 	return retval;
286 }
287 
288 static struct usb_driver au0828_usb_driver = {
289 	.name		= DRIVER_NAME,
290 	.probe		= au0828_usb_probe,
291 	.disconnect	= au0828_usb_disconnect,
292 	.id_table	= au0828_usb_id_table,
293 
294 	/* FIXME: Add suspend and resume functions */
295 };
296 
297 static int __init au0828_init(void)
298 {
299 	int ret;
300 
301 	if (au0828_debug & 1)
302 		printk(KERN_INFO "%s() Debugging is enabled\n", __func__);
303 
304 	if (au0828_debug & 2)
305 		printk(KERN_INFO "%s() USB Debugging is enabled\n", __func__);
306 
307 	if (au0828_debug & 4)
308 		printk(KERN_INFO "%s() I2C Debugging is enabled\n", __func__);
309 
310 	if (au0828_debug & 8)
311 		printk(KERN_INFO "%s() Bridge Debugging is enabled\n",
312 		       __func__);
313 
314 	if (au0828_debug & 16)
315 		printk(KERN_INFO "%s() IR Debugging is enabled\n",
316 		       __func__);
317 
318 	printk(KERN_INFO "au0828 driver loaded\n");
319 
320 	ret = usb_register(&au0828_usb_driver);
321 	if (ret)
322 		printk(KERN_ERR "usb_register failed, error = %d\n", ret);
323 
324 	return ret;
325 }
326 
327 static void __exit au0828_exit(void)
328 {
329 	usb_deregister(&au0828_usb_driver);
330 }
331 
332 module_init(au0828_init);
333 module_exit(au0828_exit);
334 
335 MODULE_DESCRIPTION("Driver for Auvitek AU0828 based products");
336 MODULE_AUTHOR("Steven Toth <stoth@linuxtv.org>");
337 MODULE_LICENSE("GPL");
338 MODULE_VERSION("0.0.3");
339