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 */
37int au0828_debug;
38module_param_named(debug, au0828_debug, int, 0644);
39MODULE_PARM_DESC(debug,
40		 "set debug bitmask: 1=general, 2=USB, 4=I2C, 8=bridge, 16=IR");
41
42static unsigned int disable_usb_speed_check;
43module_param(disable_usb_speed_check, int, 0444);
44MODULE_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
50static int send_control_msg(struct au0828_dev *dev, u16 request, u32 value,
51			    u16 index);
52static 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
59u32 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
69u32 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
75static 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
102static 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
130static 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
139static 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
150static 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	/* there is a small window after disconnect, before
157	   dev->usbdev is NULL, for poll (e.g: IR) try to access
158	   the device and fill the dmesg with error messages.
159	   Set the status so poll routines can check and avoid
160	   access after disconnect.
161	*/
162	set_bit(DEV_DISCONNECTED, &dev->dev_state);
163
164	au0828_rc_unregister(dev);
165	/* Digital TV */
166	au0828_dvb_unregister(dev);
167
168	usb_set_intfdata(interface, NULL);
169	mutex_lock(&dev->mutex);
170	dev->usbdev = NULL;
171	mutex_unlock(&dev->mutex);
172#ifdef CONFIG_VIDEO_AU0828_V4L2
173	if (AUVI_INPUT(0).type != AU0828_VMUX_UNDEFINED) {
174		au0828_analog_unregister(dev);
175		v4l2_device_disconnect(&dev->v4l2_dev);
176		v4l2_device_put(&dev->v4l2_dev);
177		return;
178	}
179#endif
180	au0828_usb_release(dev);
181}
182
183static int au0828_usb_probe(struct usb_interface *interface,
184	const struct usb_device_id *id)
185{
186	int ifnum;
187	int retval = 0;
188
189	struct au0828_dev *dev;
190	struct usb_device *usbdev = interface_to_usbdev(interface);
191
192	ifnum = interface->altsetting->desc.bInterfaceNumber;
193
194	if (ifnum != 0)
195		return -ENODEV;
196
197	dprintk(1, "%s() vendor id 0x%x device id 0x%x ifnum:%d\n", __func__,
198		le16_to_cpu(usbdev->descriptor.idVendor),
199		le16_to_cpu(usbdev->descriptor.idProduct),
200		ifnum);
201
202	/*
203	 * Make sure we have 480 Mbps of bandwidth, otherwise things like
204	 * video stream wouldn't likely work, since 12 Mbps is generally
205	 * not enough even for most Digital TV streams.
206	 */
207	if (usbdev->speed != USB_SPEED_HIGH && disable_usb_speed_check == 0) {
208		pr_err("au0828: Device initialization failed.\n");
209		pr_err("au0828: Device must be connected to a high-speed USB 2.0 port.\n");
210		return -ENODEV;
211	}
212
213	dev = kzalloc(sizeof(*dev), GFP_KERNEL);
214	if (dev == NULL) {
215		pr_err("%s() Unable to allocate memory\n", __func__);
216		return -ENOMEM;
217	}
218
219	mutex_init(&dev->lock);
220	mutex_lock(&dev->lock);
221	mutex_init(&dev->mutex);
222	mutex_init(&dev->dvb.lock);
223	dev->usbdev = usbdev;
224	dev->boardnr = id->driver_info;
225
226#ifdef CONFIG_VIDEO_AU0828_V4L2
227	dev->v4l2_dev.release = au0828_usb_v4l2_release;
228
229	/* Create the v4l2_device */
230	retval = v4l2_device_register(&interface->dev, &dev->v4l2_dev);
231	if (retval) {
232		pr_err("%s() v4l2_device_register failed\n",
233		       __func__);
234		mutex_unlock(&dev->lock);
235		kfree(dev);
236		return retval;
237	}
238	/* This control handler will inherit the controls from au8522 */
239	retval = v4l2_ctrl_handler_init(&dev->v4l2_ctrl_hdl, 4);
240	if (retval) {
241		pr_err("%s() v4l2_ctrl_handler_init failed\n",
242		       __func__);
243		mutex_unlock(&dev->lock);
244		kfree(dev);
245		return retval;
246	}
247	dev->v4l2_dev.ctrl_handler = &dev->v4l2_ctrl_hdl;
248#endif
249
250	/* Power Up the bridge */
251	au0828_write(dev, REG_600, 1 << 4);
252
253	/* Bring up the GPIO's and supporting devices */
254	au0828_gpio_setup(dev);
255
256	/* I2C */
257	au0828_i2c_register(dev);
258
259	/* Setup */
260	au0828_card_setup(dev);
261
262#ifdef CONFIG_VIDEO_AU0828_V4L2
263	/* Analog TV */
264	if (AUVI_INPUT(0).type != AU0828_VMUX_UNDEFINED)
265		au0828_analog_register(dev, interface);
266#endif
267
268	/* Digital TV */
269	retval = au0828_dvb_register(dev);
270	if (retval)
271		pr_err("%s() au0282_dev_register failed\n",
272		       __func__);
273
274	/* Remote controller */
275	au0828_rc_register(dev);
276
277	/*
278	 * Store the pointer to the au0828_dev so it can be accessed in
279	 * au0828_usb_disconnect
280	 */
281	usb_set_intfdata(interface, dev);
282
283	pr_info("Registered device AU0828 [%s]\n",
284		dev->board.name == NULL ? "Unset" : dev->board.name);
285
286	mutex_unlock(&dev->lock);
287
288	return retval;
289}
290
291static int au0828_suspend(struct usb_interface *interface,
292				pm_message_t message)
293{
294	struct au0828_dev *dev = usb_get_intfdata(interface);
295
296	if (!dev)
297		return 0;
298
299	pr_info("Suspend\n");
300
301	au0828_rc_suspend(dev);
302	au0828_v4l2_suspend(dev);
303	au0828_dvb_suspend(dev);
304
305	/* FIXME: should suspend also ATV/DTV */
306
307	return 0;
308}
309
310static int au0828_resume(struct usb_interface *interface)
311{
312	struct au0828_dev *dev = usb_get_intfdata(interface);
313	if (!dev)
314		return 0;
315
316	pr_info("Resume\n");
317
318	/* Power Up the bridge */
319	au0828_write(dev, REG_600, 1 << 4);
320
321	/* Bring up the GPIO's and supporting devices */
322	au0828_gpio_setup(dev);
323
324	au0828_rc_resume(dev);
325	au0828_v4l2_resume(dev);
326	au0828_dvb_resume(dev);
327
328	/* FIXME: should resume also ATV/DTV */
329
330	return 0;
331}
332
333static struct usb_driver au0828_usb_driver = {
334	.name		= KBUILD_MODNAME,
335	.probe		= au0828_usb_probe,
336	.disconnect	= au0828_usb_disconnect,
337	.id_table	= au0828_usb_id_table,
338	.suspend	= au0828_suspend,
339	.resume		= au0828_resume,
340	.reset_resume	= au0828_resume,
341};
342
343static int __init au0828_init(void)
344{
345	int ret;
346
347	if (au0828_debug & 1)
348		pr_info("%s() Debugging is enabled\n", __func__);
349
350	if (au0828_debug & 2)
351		pr_info("%s() USB Debugging is enabled\n", __func__);
352
353	if (au0828_debug & 4)
354		pr_info("%s() I2C Debugging is enabled\n", __func__);
355
356	if (au0828_debug & 8)
357		pr_info("%s() Bridge Debugging is enabled\n",
358		       __func__);
359
360	if (au0828_debug & 16)
361		pr_info("%s() IR Debugging is enabled\n",
362		       __func__);
363
364	pr_info("au0828 driver loaded\n");
365
366	ret = usb_register(&au0828_usb_driver);
367	if (ret)
368		pr_err("usb_register failed, error = %d\n", ret);
369
370	return ret;
371}
372
373static void __exit au0828_exit(void)
374{
375	usb_deregister(&au0828_usb_driver);
376}
377
378module_init(au0828_init);
379module_exit(au0828_exit);
380
381MODULE_DESCRIPTION("Driver for Auvitek AU0828 based products");
382MODULE_AUTHOR("Steven Toth <stoth@linuxtv.org>");
383MODULE_LICENSE("GPL");
384MODULE_VERSION("0.0.3");
385