[media] b2c2: fix driver's build due to the lack of pci DMA code
[linux-2.6-block.git] / drivers / media / video / stk1160 / stk1160-core.c
CommitLineData
9cb2173e
EG
1/*
2 * STK1160 driver
3 *
4 * Copyright (C) 2012 Ezequiel Garcia
5 * <elezegarcia--a.t--gmail.com>
6 *
7 * Based on Easycap driver by R.M. Thomas
8 * Copyright (C) 2010 R.M. Thomas
9 * <rmthomas--a.t--sciolus.org>
10 *
11 * This program is free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation; either version 2 of the License, or
14 * (at your option) any later version.
15 *
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
20 *
21 * TODO:
22 *
23 * 1. (Try to) detect if we must register ac97 mixer
24 * 2. Support stream at lower speed: lower frame rate or lower frame size.
25 *
26 */
27
28#include <linux/module.h>
29#include <linux/init.h>
30#include <linux/kernel.h>
31#include <linux/errno.h>
32#include <linux/slab.h>
33
34#include <linux/usb.h>
35#include <linux/mm.h>
36#include <linux/vmalloc.h>
37#include <media/saa7115.h>
38
39#include "stk1160.h"
40#include "stk1160-reg.h"
41
42static unsigned int input;
43module_param(input, int, 0644);
44MODULE_PARM_DESC(input, "Set default input");
45
46MODULE_LICENSE("GPL");
47MODULE_AUTHOR("Ezequiel Garcia");
48MODULE_DESCRIPTION("STK1160 driver");
49
50/* Devices supported by this driver */
51static struct usb_device_id stk1160_id_table[] = {
52 { USB_DEVICE(0x05e1, 0x0408) },
53 { }
54};
55MODULE_DEVICE_TABLE(usb, stk1160_id_table);
56
57/* saa7113 I2C address */
58static unsigned short saa7113_addrs[] = {
59 0x4a >> 1,
60 I2C_CLIENT_END
61};
62
63/*
64 * Read/Write stk registers
65 */
66int stk1160_read_reg(struct stk1160 *dev, u16 reg, u8 *value)
67{
68 int ret;
69 int pipe = usb_rcvctrlpipe(dev->udev, 0);
70
71 *value = 0;
72 ret = usb_control_msg(dev->udev, pipe, 0x00,
73 USB_DIR_IN | USB_TYPE_VENDOR | USB_RECIP_DEVICE,
74 0x00, reg, value, sizeof(u8), HZ);
75 if (ret < 0) {
76 stk1160_err("read failed on reg 0x%x (%d)\n",
77 reg, ret);
78 return ret;
79 }
80
81 return 0;
82}
83
84int stk1160_write_reg(struct stk1160 *dev, u16 reg, u16 value)
85{
86 int ret;
87 int pipe = usb_sndctrlpipe(dev->udev, 0);
88
89 ret = usb_control_msg(dev->udev, pipe, 0x01,
90 USB_DIR_OUT | USB_TYPE_VENDOR | USB_RECIP_DEVICE,
91 value, reg, NULL, 0, HZ);
92 if (ret < 0) {
93 stk1160_err("write failed on reg 0x%x (%d)\n",
94 reg, ret);
95 return ret;
96 }
97
98 return 0;
99}
100
101void stk1160_select_input(struct stk1160 *dev)
102{
103 static const u8 gctrl[] = {
104 0x98, 0x90, 0x88, 0x80
105 };
106
107 if (dev->ctl_input < ARRAY_SIZE(gctrl))
108 stk1160_write_reg(dev, STK1160_GCTRL, gctrl[dev->ctl_input]);
109}
110
111/* TODO: We should break this into pieces */
112static void stk1160_reg_reset(struct stk1160 *dev)
113{
114 int i;
115
116 static const struct regval ctl[] = {
117 {STK1160_GCTRL+2, 0x0078},
118
119 {STK1160_RMCTL+1, 0x0000},
120 {STK1160_RMCTL+3, 0x0002},
121
122 {STK1160_PLLSO, 0x0010},
123 {STK1160_PLLSO+1, 0x0000},
124 {STK1160_PLLSO+2, 0x0014},
125 {STK1160_PLLSO+3, 0x000E},
126
127 {STK1160_PLLFD, 0x0046},
128
129 /* Timing generator setup */
130 {STK1160_TIGEN, 0x0012},
131 {STK1160_TICTL, 0x002D},
132 {STK1160_TICTL+1, 0x0001},
133 {STK1160_TICTL+2, 0x0000},
134 {STK1160_TICTL+3, 0x0000},
135 {STK1160_TIGEN, 0x0080},
136
137 {0xffff, 0xffff}
138 };
139
140 for (i = 0; ctl[i].reg != 0xffff; i++)
141 stk1160_write_reg(dev, ctl[i].reg, ctl[i].val);
142}
143
144static void stk1160_release(struct v4l2_device *v4l2_dev)
145{
146 struct stk1160 *dev = container_of(v4l2_dev, struct stk1160, v4l2_dev);
147
148 stk1160_info("releasing all resources\n");
149
150 stk1160_i2c_unregister(dev);
151
152 v4l2_ctrl_handler_free(&dev->ctrl_handler);
153 v4l2_device_unregister(&dev->v4l2_dev);
154 kfree(dev->alt_max_pkt_size);
155 kfree(dev);
156}
157
158/* high bandwidth multiplier, as encoded in highspeed endpoint descriptors */
159#define hb_mult(wMaxPacketSize) (1 + (((wMaxPacketSize) >> 11) & 0x03))
160
161/*
162 * Scan usb interface and populate max_pkt_size array
163 * with information on each alternate setting.
164 * The array should be allocated by the caller.
165 */
166static int stk1160_scan_usb(struct usb_interface *intf, struct usb_device *udev,
167 unsigned int *max_pkt_size)
168{
169 int i, e, sizedescr, size, ifnum;
170 const struct usb_endpoint_descriptor *desc;
171
172 bool has_video = false, has_audio = false;
173 const char *speed;
174
175 ifnum = intf->altsetting[0].desc.bInterfaceNumber;
176
177 /* Get endpoints */
178 for (i = 0; i < intf->num_altsetting; i++) {
179
180 for (e = 0; e < intf->altsetting[i].desc.bNumEndpoints; e++) {
181
182 /* This isn't clear enough, at least to me */
183 desc = &intf->altsetting[i].endpoint[e].desc;
184 sizedescr = le16_to_cpu(desc->wMaxPacketSize);
185 size = sizedescr & 0x7ff;
186
187 if (udev->speed == USB_SPEED_HIGH)
188 size = size * hb_mult(sizedescr);
189
190 if (usb_endpoint_xfer_isoc(desc) &&
191 usb_endpoint_dir_in(desc)) {
192 switch (desc->bEndpointAddress) {
193 case STK1160_EP_AUDIO:
194 has_audio = true;
195 break;
196 case STK1160_EP_VIDEO:
197 has_video = true;
198 max_pkt_size[i] = size;
199 break;
200 }
201 }
202 }
203 }
204
205 /* Is this even possible? */
206 if (!(has_audio || has_video)) {
207 dev_err(&udev->dev, "no audio or video endpoints found\n");
208 return -ENODEV;
209 }
210
211 switch (udev->speed) {
212 case USB_SPEED_LOW:
213 speed = "1.5";
214 break;
215 case USB_SPEED_FULL:
216 speed = "12";
217 break;
218 case USB_SPEED_HIGH:
219 speed = "480";
220 break;
221 default:
222 speed = "unknown";
223 }
224
225 dev_info(&udev->dev, "New device %s %s @ %s Mbps (%04x:%04x, interface %d, class %d)\n",
226 udev->manufacturer ? udev->manufacturer : "",
227 udev->product ? udev->product : "",
228 speed,
229 le16_to_cpu(udev->descriptor.idVendor),
230 le16_to_cpu(udev->descriptor.idProduct),
231 ifnum,
232 intf->altsetting->desc.bInterfaceNumber);
233
234 /* This should never happen, since we rejected audio interfaces */
235 if (has_audio)
236 dev_warn(&udev->dev, "audio interface %d found.\n\
237 This is not implemented by this driver,\
238 you should use snd-usb-audio instead\n", ifnum);
239
240 if (has_video)
241 dev_info(&udev->dev, "video interface %d found\n",
242 ifnum);
243
244 /*
245 * Make sure we have 480 Mbps of bandwidth, otherwise things like
246 * video stream wouldn't likely work, since 12 Mbps is generally
247 * not enough even for most streams.
248 */
249 if (udev->speed != USB_SPEED_HIGH)
250 dev_warn(&udev->dev, "must be connected to a high-speed USB 2.0 port\n\
251 You may not be able to stream video smoothly\n");
252
253 return 0;
254}
255
256static int stk1160_probe(struct usb_interface *interface,
257 const struct usb_device_id *id)
258{
259 int ifnum;
260 int rc = 0;
261
262 unsigned int *alt_max_pkt_size; /* array of wMaxPacketSize */
263 struct usb_device *udev;
264 struct stk1160 *dev;
265
266 ifnum = interface->altsetting[0].desc.bInterfaceNumber;
267 udev = interface_to_usbdev(interface);
268
269 /*
270 * Since usb audio class is supported by snd-usb-audio,
271 * we reject audio interface.
272 */
273 if (interface->altsetting[0].desc.bInterfaceClass == USB_CLASS_AUDIO)
274 return -ENODEV;
275
276 /* Alloc an array for all possible max_pkt_size */
277 alt_max_pkt_size = kmalloc(sizeof(alt_max_pkt_size[0]) *
278 interface->num_altsetting, GFP_KERNEL);
279 if (alt_max_pkt_size == NULL)
280 return -ENOMEM;
281
282 /*
283 * Scan usb posibilities and populate alt_max_pkt_size array.
284 * Also, check if device speed is fast enough.
285 */
286 rc = stk1160_scan_usb(interface, udev, alt_max_pkt_size);
287 if (rc < 0) {
288 kfree(alt_max_pkt_size);
289 return rc;
290 }
291
292 dev = kzalloc(sizeof(struct stk1160), GFP_KERNEL);
293 if (dev == NULL) {
294 kfree(alt_max_pkt_size);
295 return -ENOMEM;
296 }
297
298 dev->alt_max_pkt_size = alt_max_pkt_size;
299 dev->udev = udev;
300 dev->num_alt = interface->num_altsetting;
301 dev->ctl_input = input;
302
303 /* We save struct device for debug purposes only */
304 dev->dev = &interface->dev;
305
306 usb_set_intfdata(interface, dev);
307
308 /* initialize videobuf2 stuff */
309 rc = stk1160_vb2_setup(dev);
310 if (rc < 0)
311 goto free_err;
312
313 /*
314 * There is no need to take any locks here in probe
315 * because we register the device node as the *last* thing.
316 */
317 spin_lock_init(&dev->buf_lock);
318 mutex_init(&dev->v4l_lock);
319 mutex_init(&dev->vb_queue_lock);
320
321 rc = v4l2_ctrl_handler_init(&dev->ctrl_handler, 0);
322 if (rc) {
323 stk1160_err("v4l2_ctrl_handler_init failed (%d)\n", rc);
324 goto free_err;
325 }
326
327 /*
328 * We obtain a v4l2_dev but defer
329 * registration of video device node as the last thing.
330 * There is no need to set the name if we give a device struct
331 */
332 dev->v4l2_dev.release = stk1160_release;
333 dev->v4l2_dev.ctrl_handler = &dev->ctrl_handler;
334 rc = v4l2_device_register(dev->dev, &dev->v4l2_dev);
335 if (rc) {
336 stk1160_err("v4l2_device_register failed (%d)\n", rc);
337 goto free_ctrl;
338 }
339
340 rc = stk1160_i2c_register(dev);
341 if (rc < 0)
342 goto unreg_v4l2;
343
344 /*
345 * To the best of my knowledge stk1160 boards only have
346 * saa7113, but it doesn't hurt to support them all.
347 */
348 dev->sd_saa7115 = v4l2_i2c_new_subdev(&dev->v4l2_dev, &dev->i2c_adap,
349 "saa7115_auto", 0, saa7113_addrs);
350
351 stk1160_info("driver ver %s successfully loaded\n",
352 STK1160_VERSION);
353
354 /* i2c reset saa711x */
355 v4l2_device_call_all(&dev->v4l2_dev, 0, core, reset, 0);
356 v4l2_device_call_all(&dev->v4l2_dev, 0, video, s_routing,
357 0, 0, 0);
358 v4l2_device_call_all(&dev->v4l2_dev, 0, video, s_stream, 0);
359
360 /* reset stk1160 to default values */
361 stk1160_reg_reset(dev);
362
363 /* select default input */
364 stk1160_select_input(dev);
365
366 stk1160_ac97_register(dev);
367
368 rc = stk1160_video_register(dev);
369 if (rc < 0)
370 goto unreg_i2c;
371
372 return 0;
373
374unreg_i2c:
375 stk1160_i2c_unregister(dev);
376unreg_v4l2:
377 v4l2_device_unregister(&dev->v4l2_dev);
378free_ctrl:
379 v4l2_ctrl_handler_free(&dev->ctrl_handler);
380free_err:
381 kfree(alt_max_pkt_size);
382 kfree(dev);
383
384 return rc;
385}
386
387static void stk1160_disconnect(struct usb_interface *interface)
388{
389 struct stk1160 *dev;
390
391 dev = usb_get_intfdata(interface);
392 usb_set_intfdata(interface, NULL);
393
394 /*
395 * Wait until all current v4l2 operation are finished
396 * then deallocate resources
397 */
398 mutex_lock(&dev->vb_queue_lock);
399 mutex_lock(&dev->v4l_lock);
400
401 /* Here is the only place where isoc get released */
402 stk1160_uninit_isoc(dev);
403
404 /* ac97 unregister needs to be done before usb_device is cleared */
405 stk1160_ac97_unregister(dev);
406
407 stk1160_clear_queue(dev);
408
409 video_unregister_device(&dev->vdev);
410 v4l2_device_disconnect(&dev->v4l2_dev);
411
412 /* This way current users can detect device is gone */
413 dev->udev = NULL;
414
415 mutex_unlock(&dev->v4l_lock);
416 mutex_unlock(&dev->vb_queue_lock);
417
418 /*
419 * This calls stk1160_release if it's the last reference.
420 * therwise, release is posponed until there are no users left.
421 */
422 v4l2_device_put(&dev->v4l2_dev);
423}
424
425static struct usb_driver stk1160_usb_driver = {
426 .name = "stk1160",
427 .id_table = stk1160_id_table,
428 .probe = stk1160_probe,
429 .disconnect = stk1160_disconnect,
430};
431
432module_usb_driver(stk1160_usb_driver);