2 tm6000-cards.c - driver for TM5600/TM6000 USB video capture devices
4 Copyright (C) 2006-2007 Mauro Carvalho Chehab <mchehab@infradead.org>
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 version 2
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with this program; if not, write to the Free Software
17 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
20 #include <linux/init.h>
21 #include <linux/module.h>
22 #include <linux/pci.h>
23 #include <linux/delay.h>
24 #include <linux/i2c.h>
25 #include <linux/usb.h>
26 #include <linux/version.h>
27 #include <media/v4l2-common.h>
28 #include <media/tuner.h>
29 #include <media/tvaudio.h>
30 #include <media/i2c-addr.h>
33 #include "tm6000-regs.h"
34 #include "tuner-xc2028.h"
37 #define TM6000_BOARD_UNKNOWN 0
38 #define TM5600_BOARD_GENERIC 1
39 #define TM6000_BOARD_GENERIC 2
40 #define TM6010_BOARD_GENERIC 3
41 #define TM5600_BOARD_10MOONS_UT821 4
42 #define TM5600_BOARD_10MOONS_UT330 5
43 #define TM6000_BOARD_ADSTECH_DUAL_TV 6
44 #define TM6000_BOARD_FREECOM_AND_SIMILAR 7
45 #define TM6000_BOARD_ADSTECH_MINI_DUAL_TV 8
46 #define TM6010_BOARD_HAUPPAUGE_900H 9
47 #define TM6010_BOARD_BEHOLD_WANDER 10
48 #define TM6010_BOARD_BEHOLD_VOYAGER 11
49 #define TM6010_BOARD_TERRATEC_CINERGY_HYBRID_XE 12
51 #define TM6000_MAXBOARDS 16
52 static unsigned int card[] = {[0 ... (TM6000_MAXBOARDS - 1)] = UNSET };
54 module_param_array(card, int, NULL, 0444);
56 static unsigned long tm6000_devused;
62 struct tm6000_capabilities caps;
64 enum tm6000_devtype type; /* variant of the chipset */
65 int tuner_type; /* type of the tuner */
66 int tuner_addr; /* tuner address */
67 int demod_addr; /* demodulator address */
68 int gpio_addr_tun_reset; /* GPIO used for tuner reset */
71 struct tm6000_board tm6000_boards[] = {
72 [TM6000_BOARD_UNKNOWN] = {
73 .name = "Unknown tm6000 video grabber",
77 .gpio_addr_tun_reset = TM6000_GPIO_1,
79 [TM5600_BOARD_GENERIC] = {
80 .name = "Generic tm5600 board",
82 .tuner_type = TUNER_XC2028,
83 .tuner_addr = 0xc2 >> 1,
87 .gpio_addr_tun_reset = TM6000_GPIO_1,
89 [TM6000_BOARD_GENERIC] = {
90 .name = "Generic tm6000 board",
91 .tuner_type = TUNER_XC2028,
92 .tuner_addr = 0xc2 >> 1,
97 .gpio_addr_tun_reset = TM6000_GPIO_1,
99 [TM6010_BOARD_GENERIC] = {
100 .name = "Generic tm6010 board",
102 .tuner_type = TUNER_XC2028,
103 .tuner_addr = 0xc2 >> 1,
108 .gpio_addr_tun_reset = TM6010_GPIO_4,
110 [TM5600_BOARD_10MOONS_UT821] = {
111 .name = "10Moons UT 821",
112 .tuner_type = TUNER_XC2028,
114 .tuner_addr = 0xc2 >> 1,
119 .gpio_addr_tun_reset = TM6000_GPIO_1,
121 [TM5600_BOARD_10MOONS_UT330] = {
122 .name = "10Moons UT 330",
123 .tuner_type = TUNER_PHILIPS_FQ1216AME_MK4,
124 .tuner_addr = 0xc8 >> 1,
132 [TM6000_BOARD_ADSTECH_DUAL_TV] = {
133 .name = "ADSTECH Dual TV USB",
134 .tuner_type = TUNER_XC2028,
135 .tuner_addr = 0xc8 >> 1,
144 [TM6000_BOARD_FREECOM_AND_SIMILAR] = {
145 .name = "Freecom Hybrid Stick / Moka DVB-T Receiver Dual",
146 .tuner_type = TUNER_XC2028, /* has a XC3028 */
147 .tuner_addr = 0xc2 >> 1,
148 .demod_addr = 0x1e >> 1,
156 .gpio_addr_tun_reset = TM6000_GPIO_4,
158 [TM6000_BOARD_ADSTECH_MINI_DUAL_TV] = {
159 .name = "ADSTECH Mini Dual TV USB",
160 .tuner_type = TUNER_XC2028, /* has a XC3028 */
161 .tuner_addr = 0xc8 >> 1,
162 .demod_addr = 0x1e >> 1,
169 .gpio_addr_tun_reset = TM6000_GPIO_4,
171 [TM6010_BOARD_HAUPPAUGE_900H] = {
172 .name = "Hauppauge HVR-900H",
173 .tuner_type = TUNER_XC2028, /* has a XC3028 */
174 .tuner_addr = 0xc2 >> 1,
175 .demod_addr = 0x1e >> 1,
183 .gpio_addr_tun_reset = TM6000_GPIO_2,
185 [TM6010_BOARD_BEHOLD_WANDER] = {
186 .name = "Beholder Wander DVB-T/TV/FM USB2.0",
187 .tuner_type = TUNER_XC5000,
188 .tuner_addr = 0xc2 >> 1,
189 .demod_addr = 0x1e >> 1,
198 .gpio_addr_tun_reset = TM6000_GPIO_2,
200 [TM6010_BOARD_BEHOLD_VOYAGER] = {
201 .name = "Beholder Voyager TV/FM USB2.0",
202 .tuner_type = TUNER_XC5000,
203 .tuner_addr = 0xc2 >> 1,
212 .gpio_addr_tun_reset = TM6000_GPIO_2,
214 [TM6010_BOARD_TERRATEC_CINERGY_HYBRID_XE] = {
215 .name = "Terratec Cinergy Hybrid XE",
216 .tuner_type = TUNER_XC2028, /* has a XC3028 */
217 .tuner_addr = 0xc2 >> 1,
218 .demod_addr = 0x1e >> 1,
227 .gpio_addr_tun_reset = TM6010_GPIO_2,
231 /* table of devices that work with this driver */
232 struct usb_device_id tm6000_id_table [] = {
233 { USB_DEVICE(0x6000, 0x0001), .driver_info = TM5600_BOARD_10MOONS_UT821 },
234 { USB_DEVICE(0x6000, 0x0002), .driver_info = TM6010_BOARD_GENERIC },
235 { USB_DEVICE(0x06e1, 0xf332), .driver_info = TM6000_BOARD_ADSTECH_DUAL_TV },
236 { USB_DEVICE(0x14aa, 0x0620), .driver_info = TM6000_BOARD_FREECOM_AND_SIMILAR },
237 { USB_DEVICE(0x06e1, 0xb339), .driver_info = TM6000_BOARD_ADSTECH_MINI_DUAL_TV },
238 { USB_DEVICE(0x2040, 0x6600), .driver_info = TM6010_BOARD_HAUPPAUGE_900H },
239 { USB_DEVICE(0x6000, 0xdec0), .driver_info = TM6010_BOARD_BEHOLD_WANDER },
240 { USB_DEVICE(0x6000, 0xdec1), .driver_info = TM6010_BOARD_BEHOLD_VOYAGER },
241 { USB_DEVICE(0x0ccd, 0x0086), .driver_info = TM6010_BOARD_TERRATEC_CINERGY_HYBRID_XE },
245 /* Tuner callback to provide the proper gpio changes needed for xc2028 */
247 int tm6000_tuner_callback(void *ptr, int component, int command, int arg)
250 struct tm6000_core *dev = ptr;
252 if (dev->tuner_type!=TUNER_XC2028)
256 case XC2028_RESET_CLK:
257 tm6000_set_reg (dev, REQ_04_EN_DISABLE_MCU_INT,
260 rc=tm6000_set_reg (dev, REQ_03_SET_GET_MCU_PIN,
265 rc=tm6000_set_reg (dev, REQ_03_SET_GET_MCU_PIN,
268 case XC2028_TUNER_RESET:
269 /* Reset codes during load firmware */
272 tm6000_set_reg (dev, REQ_03_SET_GET_MCU_PIN,
273 dev->tuner_reset_gpio, 0x00);
275 tm6000_set_reg (dev, REQ_03_SET_GET_MCU_PIN,
276 dev->tuner_reset_gpio, 0x01);
280 tm6000_set_reg (dev, REQ_04_EN_DISABLE_MCU_INT,
286 rc=tm6000_set_reg (dev, REQ_03_SET_GET_MCU_PIN,
291 rc=tm6000_set_reg (dev, REQ_03_SET_GET_MCU_PIN,
300 int tm6000_cards_setup(struct tm6000_core *dev)
305 * Board-specific initialization sequence. Handles all GPIO
306 * initialization sequences that are board-specific.
307 * Up to now, all found devices use GPIO1 and GPIO4 at the same way.
308 * Probably, they're all based on some reference device. Due to that,
309 * there's a common routine at the end to handle those GPIO's. Devices
310 * that use different pinups or init sequences can just return at
311 * the board-specific session.
313 switch (dev->model) {
314 case TM6010_BOARD_HAUPPAUGE_900H:
315 /* Turn xceive 3028 on */
316 tm6000_set_reg(dev, REQ_03_SET_GET_MCU_PIN, TM6010_GPIO_3, 0x01);
324 * Default initialization. Most of the devices seem to use GPIO1
325 * and GPIO4.on the same way, so, this handles the common sequence
326 * used by most devices.
327 * If a device uses a different sequence or different GPIO pins for
328 * reset, just add the code at the board-specific part
330 for (i = 0; i < 2; i++) {
331 rc = tm6000_set_reg(dev, REQ_03_SET_GET_MCU_PIN,
332 dev->tuner_reset_gpio, 0x00);
334 printk(KERN_ERR "Error %i doing GPIO1 reset\n", rc);
338 msleep(10); /* Just to be conservative */
339 rc = tm6000_set_reg(dev, REQ_03_SET_GET_MCU_PIN,
340 dev->tuner_reset_gpio, 0x01);
342 printk(KERN_ERR "Error %i doing GPIO1 reset\n", rc);
347 rc = tm6000_set_reg(dev, REQ_03_SET_GET_MCU_PIN, TM6000_GPIO_4, 0);
349 printk(KERN_ERR "Error %i doing GPIO4 reset\n", rc);
354 rc = tm6000_set_reg(dev, REQ_03_SET_GET_MCU_PIN, TM6000_GPIO_4, 1);
356 printk(KERN_ERR "Error %i doing GPIO4 reset\n", rc);
361 rc = tm6000_get_reg16(dev, 0x40, 0, 0);
363 printk(KERN_DEBUG "board=%d\n", rc);
372 static void tm6000_config_tuner (struct tm6000_core *dev)
374 struct tuner_setup tun_setup;
376 /* Load tuner module */
377 v4l2_i2c_new_subdev(&dev->v4l2_dev, &dev->i2c_adap,
378 "tuner", "tuner",dev->tuner_addr, NULL);
380 memset(&tun_setup, 0, sizeof(tun_setup));
381 tun_setup.type = dev->tuner_type;
382 tun_setup.addr = dev->tuner_addr;
383 tun_setup.mode_mask = T_ANALOG_TV | T_RADIO | T_DIGITAL_TV;
384 tun_setup.tuner_callback = tm6000_tuner_callback;
386 v4l2_device_call_all(&dev->v4l2_dev, 0, tuner, s_type_addr, &tun_setup);
388 if (dev->tuner_type == TUNER_XC2028) {
389 struct v4l2_priv_tun_config xc2028_cfg;
390 struct xc2028_ctrl ctl;
392 memset(&xc2028_cfg, 0, sizeof(xc2028_cfg));
393 memset (&ctl,0,sizeof(ctl));
396 ctl.read_not_reliable = 0;
398 ctl.demod = XC3028_FE_ZARLINK456;
401 xc2028_cfg.tuner = TUNER_XC2028;
402 xc2028_cfg.priv = &ctl;
405 case TM6010_BOARD_HAUPPAUGE_900H:
406 case TM6010_BOARD_TERRATEC_CINERGY_HYBRID_XE:
407 ctl.fname = "xc3028L-v36.fw";
410 if (dev->dev_type == TM6010)
411 ctl.fname = "xc3028-v27.fw";
413 ctl.fname = "tm6000-xc3028.fw";
416 printk(KERN_INFO "Setting firmware parameters for xc2028\n");
418 v4l2_device_call_all(&dev->v4l2_dev, 0, tuner, s_config,
423 static int tm6000_init_dev(struct tm6000_core *dev)
425 struct v4l2_frequency f;
428 mutex_init(&dev->lock);
430 mutex_lock(&dev->lock);
432 /* Initializa board-specific data */
433 dev->dev_type = tm6000_boards[dev->model].type;
434 dev->tuner_type = tm6000_boards[dev->model].tuner_type;
435 dev->tuner_addr = tm6000_boards[dev->model].tuner_addr;
436 dev->tuner_reset_gpio = tm6000_boards[dev->model].gpio_addr_tun_reset;
438 dev->demod_addr = tm6000_boards[dev->model].demod_addr;
440 dev->caps = tm6000_boards[dev->model].caps;
442 /* initialize hardware */
443 rc=tm6000_init (dev);
447 rc = v4l2_device_register(&dev->udev->dev, &dev->v4l2_dev);
451 /* register i2c bus */
452 rc=tm6000_i2c_register(dev);
456 /* register and initialize V4L2 */
457 rc=tm6000_v4l2_register(dev);
461 /* Default values for STD and resolutions */
464 dev->norm = V4L2_STD_PAL_M;
466 /* Configure tuner */
467 tm6000_config_tuner (dev);
469 /* Set video standard */
470 v4l2_device_call_all(&dev->v4l2_dev, 0, core, s_std, dev->norm);
472 /* Set tuner frequency - also loads firmware on xc2028/xc3028 */
474 f.type = V4L2_TUNER_ANALOG_TV;
475 f.frequency = 3092; /* 193.25 MHz */
476 dev->freq = f.frequency;
477 v4l2_device_call_all(&dev->v4l2_dev, 0, tuner, s_frequency, &f);
479 if (dev->caps.has_tda9874)
480 v4l2_i2c_new_subdev(&dev->v4l2_dev, &dev->i2c_adap,
481 "tvaudio", "tvaudio", I2C_ADDR_TDA9874, NULL);
483 if(dev->caps.has_dvb) {
484 dev->dvb = kzalloc(sizeof(*(dev->dvb)), GFP_KERNEL);
489 #ifdef CONFIG_VIDEO_TM6000_DVB
490 rc = tm6000_dvb_register(dev);
501 v4l2_device_unregister(&dev->v4l2_dev);
504 mutex_unlock(&dev->lock);
508 /* high bandwidth multiplier, as encoded in highspeed endpoint descriptors */
509 #define hb_mult(wMaxPacketSize) (1 + (((wMaxPacketSize) >> 11) & 0x03))
511 static void get_max_endpoint ( struct usb_device *usbdev,
513 struct usb_host_endpoint *curr_e,
514 unsigned int *maxsize,
515 struct usb_host_endpoint **ep )
517 u16 tmp = le16_to_cpu(curr_e->desc.wMaxPacketSize);
518 unsigned int size = tmp & 0x7ff;
520 if (usbdev->speed == USB_SPEED_HIGH)
521 size = size * hb_mult (tmp);
526 printk("tm6000: %s endpoint: 0x%02x (max size=%u bytes)\n",
527 msgtype, curr_e->desc.bEndpointAddress,
534 * checks for supported devices
536 static int tm6000_usb_probe(struct usb_interface *interface,
537 const struct usb_device_id *id)
539 struct usb_device *usbdev;
540 struct tm6000_core *dev = NULL;
546 usbdev=usb_get_dev(interface_to_usbdev(interface));
548 /* Selects the proper interface */
549 rc=usb_set_interface(usbdev,0,1);
553 /* Check to see next free device and mark as used */
554 nr=find_first_zero_bit(&tm6000_devused,TM6000_MAXBOARDS);
555 if (nr >= TM6000_MAXBOARDS) {
556 printk ("tm6000: Supports only %i tm60xx boards.\n",TM6000_MAXBOARDS);
561 /* Create and initialize dev struct */
562 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
564 printk ("tm6000" ": out of memory!\n");
568 spin_lock_init(&dev->slock);
570 /* Increment usage count */
571 tm6000_devused|=1<<nr;
572 snprintf(dev->name, 29, "tm6000 #%d", nr);
574 dev->model=id->driver_info;
575 if ((card[nr]>=0) && (card[nr]<ARRAY_SIZE(tm6000_boards))) {
579 INIT_LIST_HEAD(&dev->tm6000_corelist);
583 switch (usbdev->speed) {
587 case USB_SPEED_UNKNOWN:
601 for (i = 0; i < interface->num_altsetting; i++) {
604 for (ep = 0; ep < interface->altsetting[i].desc.bNumEndpoints; ep++) {
605 struct usb_host_endpoint *e;
608 e = &interface->altsetting[i].endpoint[ep];
610 dir_out = ((e->desc.bEndpointAddress &
611 USB_ENDPOINT_DIR_MASK) == USB_DIR_OUT);
613 printk("tm6000: alt %d, interface %i, class %i\n",
615 interface->altsetting[i].desc.bInterfaceNumber,
616 interface->altsetting[i].desc.bInterfaceClass);
618 switch (e->desc.bmAttributes) {
619 case USB_ENDPOINT_XFER_BULK:
621 get_max_endpoint (usbdev, "Bulk IN", e,
625 get_max_endpoint (usbdev, "Bulk OUT", e,
630 case USB_ENDPOINT_XFER_ISOC:
632 get_max_endpoint (usbdev, "ISOC IN", e,
636 get_max_endpoint (usbdev, "ISOC OUT", e,
646 printk("tm6000: New video device @ %s Mbps (%04x:%04x, ifnum %d)\n",
648 le16_to_cpu(dev->udev->descriptor.idVendor),
649 le16_to_cpu(dev->udev->descriptor.idProduct),
650 interface->altsetting->desc.bInterfaceNumber);
652 /* check if the the device has the iso in endpoint at the correct place */
654 printk("tm6000: probing error: no IN ISOC endpoint!\n");
660 /* save our data pointer in this interface device */
661 usb_set_intfdata(interface, dev);
663 printk("tm6000: Found %s\n", tm6000_boards[dev->model].name);
665 rc=tm6000_init_dev(dev);
673 printk("tm6000: Error %d while registering\n", rc);
675 tm6000_devused&=~(1<<nr);
683 * tm6000_usb_disconnect()
684 * called when the device gets diconencted
685 * video device will be unregistered on v4l2_close in case it is still open
687 static void tm6000_usb_disconnect(struct usb_interface *interface)
689 struct tm6000_core *dev = usb_get_intfdata(interface);
690 usb_set_intfdata(interface, NULL);
695 printk("tm6000: disconnecting %s\n", dev->name);
697 mutex_lock(&dev->lock);
699 #ifdef CONFIG_VIDEO_TM6000_DVB
701 tm6000_dvb_unregister(dev);
706 tm6000_v4l2_unregister(dev);
708 tm6000_i2c_unregister(dev);
710 v4l2_device_unregister(&dev->v4l2_dev);
712 // wake_up_interruptible_all(&dev->open);
714 dev->state |= DEV_DISCONNECTED;
716 usb_put_dev(dev->udev);
718 mutex_unlock(&dev->lock);
722 static struct usb_driver tm6000_usb_driver = {
724 .probe = tm6000_usb_probe,
725 .disconnect = tm6000_usb_disconnect,
726 .id_table = tm6000_id_table,
729 static int __init tm6000_module_init(void)
733 printk(KERN_INFO "tm6000" " v4l2 driver version %d.%d.%d loaded\n",
734 (TM6000_VERSION >> 16) & 0xff,
735 (TM6000_VERSION >> 8) & 0xff, TM6000_VERSION & 0xff);
737 /* register this driver with the USB subsystem */
738 result = usb_register(&tm6000_usb_driver);
741 " usb_register failed. Error number %d.\n", result);
746 static void __exit tm6000_module_exit(void)
748 /* deregister at USB subsystem */
749 usb_deregister(&tm6000_usb_driver);
752 module_init(tm6000_module_init);
753 module_exit(tm6000_module_exit);
755 MODULE_DESCRIPTION("Trident TVMaster TM5600/TM6000 USB2 adapter");
756 MODULE_AUTHOR("Mauro Carvalho Chehab");
757 MODULE_LICENSE("GPL");