2 tm6000-cards.c - driver for TM5600/TM6000/TM6010 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
50 #define TM6010_BOARD_TWINHAN_TU501 13
52 #define TM6000_MAXBOARDS 16
53 static unsigned int card[] = {[0 ... (TM6000_MAXBOARDS - 1)] = UNSET };
55 module_param_array(card, int, NULL, 0444);
57 static unsigned long tm6000_devused;
63 struct tm6000_capabilities caps;
65 enum tm6000_devtype type; /* variant of the chipset */
66 int tuner_type; /* type of the tuner */
67 int tuner_addr; /* tuner address */
68 int demod_addr; /* demodulator address */
70 struct tm6000_gpio gpio;
73 struct tm6000_board tm6000_boards[] = {
74 [TM6000_BOARD_UNKNOWN] = {
75 .name = "Unknown tm6000 video grabber",
80 .tuner_reset = TM6000_GPIO_1,
83 [TM5600_BOARD_GENERIC] = {
84 .name = "Generic tm5600 board",
86 .tuner_type = TUNER_XC2028,
87 .tuner_addr = 0xc2 >> 1,
92 .tuner_reset = TM6000_GPIO_1,
95 [TM6000_BOARD_GENERIC] = {
96 .name = "Generic tm6000 board",
97 .tuner_type = TUNER_XC2028,
98 .tuner_addr = 0xc2 >> 1,
104 .tuner_reset = TM6000_GPIO_1,
107 [TM6010_BOARD_GENERIC] = {
108 .name = "Generic tm6010 board",
110 .tuner_type = TUNER_XC2028,
111 .tuner_addr = 0xc2 >> 1,
117 .tuner_reset = TM6010_GPIO_4,
120 [TM5600_BOARD_10MOONS_UT821] = {
121 .name = "10Moons UT 821",
122 .tuner_type = TUNER_XC2028,
124 .tuner_addr = 0xc2 >> 1,
130 .tuner_reset = TM6000_GPIO_1,
133 [TM5600_BOARD_10MOONS_UT330] = {
134 .name = "10Moons UT 330",
135 .tuner_type = TUNER_PHILIPS_FQ1216AME_MK4,
136 .tuner_addr = 0xc8 >> 1,
144 [TM6000_BOARD_ADSTECH_DUAL_TV] = {
145 .name = "ADSTECH Dual TV USB",
146 .tuner_type = TUNER_XC2028,
147 .tuner_addr = 0xc8 >> 1,
156 [TM6000_BOARD_FREECOM_AND_SIMILAR] = {
157 .name = "Freecom Hybrid Stick / Moka DVB-T Receiver Dual",
158 .tuner_type = TUNER_XC2028, /* has a XC3028 */
159 .tuner_addr = 0xc2 >> 1,
160 .demod_addr = 0x1e >> 1,
169 .tuner_reset = TM6000_GPIO_4,
172 [TM6000_BOARD_ADSTECH_MINI_DUAL_TV] = {
173 .name = "ADSTECH Mini Dual TV USB",
174 .tuner_type = TUNER_XC2028, /* has a XC3028 */
175 .tuner_addr = 0xc8 >> 1,
176 .demod_addr = 0x1e >> 1,
184 .tuner_reset = TM6000_GPIO_4,
187 [TM6010_BOARD_HAUPPAUGE_900H] = {
188 .name = "Hauppauge WinTV HVR-900H / WinTV USB2-Stick",
189 .tuner_type = TUNER_XC2028, /* has a XC3028 */
190 .tuner_addr = 0xc2 >> 1,
191 .demod_addr = 0x1e >> 1,
200 .tuner_reset = TM6010_GPIO_2,
203 [TM6010_BOARD_BEHOLD_WANDER] = {
204 .name = "Beholder Wander DVB-T/TV/FM USB2.0",
205 .tuner_type = TUNER_XC5000,
206 .tuner_addr = 0xc2 >> 1,
207 .demod_addr = 0x1e >> 1,
217 .tuner_reset = TM6000_GPIO_2,
220 [TM6010_BOARD_BEHOLD_VOYAGER] = {
221 .name = "Beholder Voyager TV/FM USB2.0",
222 .tuner_type = TUNER_XC5000,
223 .tuner_addr = 0xc2 >> 1,
233 .tuner_reset = TM6000_GPIO_2,
236 [TM6010_BOARD_TERRATEC_CINERGY_HYBRID_XE] = {
237 .name = "Terratec Cinergy Hybrid XE / Cinergy Hybrid-Stick",
238 .tuner_type = TUNER_XC2028, /* has a XC3028 */
239 .tuner_addr = 0xc2 >> 1,
240 .demod_addr = 0x1e >> 1,
250 .tuner_reset = TM6010_GPIO_2,
253 [TM6010_BOARD_TWINHAN_TU501] = {
254 .name = "Twinhan TU501(704D1)",
255 .tuner_type = TUNER_XC2028, /* has a XC3028 */
256 .tuner_addr = 0xc2 >> 1,
257 .demod_addr = 0x1e >> 1,
267 .tuner_reset = TM6010_GPIO_2,
272 /* table of devices that work with this driver */
273 struct usb_device_id tm6000_id_table [] = {
274 { USB_DEVICE(0x6000, 0x0001), .driver_info = TM5600_BOARD_10MOONS_UT821 },
275 { USB_DEVICE(0x6000, 0x0002), .driver_info = TM6010_BOARD_GENERIC },
276 { USB_DEVICE(0x06e1, 0xf332), .driver_info = TM6000_BOARD_ADSTECH_DUAL_TV },
277 { USB_DEVICE(0x14aa, 0x0620), .driver_info = TM6000_BOARD_FREECOM_AND_SIMILAR },
278 { USB_DEVICE(0x06e1, 0xb339), .driver_info = TM6000_BOARD_ADSTECH_MINI_DUAL_TV },
279 { USB_DEVICE(0x2040, 0x6600), .driver_info = TM6010_BOARD_HAUPPAUGE_900H },
280 { USB_DEVICE(0x2040, 0x6601), .driver_info = TM6010_BOARD_HAUPPAUGE_900H },
281 { USB_DEVICE(0x2040, 0x6610), .driver_info = TM6010_BOARD_HAUPPAUGE_900H },
282 { USB_DEVICE(0x2040, 0x6611), .driver_info = TM6010_BOARD_HAUPPAUGE_900H },
283 { USB_DEVICE(0x6000, 0xdec0), .driver_info = TM6010_BOARD_BEHOLD_WANDER },
284 { USB_DEVICE(0x6000, 0xdec1), .driver_info = TM6010_BOARD_BEHOLD_VOYAGER },
285 { USB_DEVICE(0x0ccd, 0x0086), .driver_info = TM6010_BOARD_TERRATEC_CINERGY_HYBRID_XE },
286 { USB_DEVICE(0x0ccd, 0x00A5), .driver_info = TM6010_BOARD_TERRATEC_CINERGY_HYBRID_XE },
287 { USB_DEVICE(0x13d3, 0x3240), .driver_info = TM6010_BOARD_TWINHAN_TU501 },
288 { USB_DEVICE(0x13d3, 0x3241), .driver_info = TM6010_BOARD_TWINHAN_TU501 },
289 { USB_DEVICE(0x13d3, 0x3243), .driver_info = TM6010_BOARD_TWINHAN_TU501 },
290 { USB_DEVICE(0x13d3, 0x3264), .driver_info = TM6010_BOARD_TWINHAN_TU501 },
294 /* Tuner callback to provide the proper gpio changes needed for xc2028 */
296 int tm6000_tuner_callback(void *ptr, int component, int command, int arg)
299 struct tm6000_core *dev = ptr;
301 if (dev->tuner_type!=TUNER_XC2028)
305 case XC2028_RESET_CLK:
306 tm6000_set_reg (dev, REQ_04_EN_DISABLE_MCU_INT,
309 rc=tm6000_set_reg (dev, REQ_03_SET_GET_MCU_PIN,
314 rc=tm6000_set_reg (dev, REQ_03_SET_GET_MCU_PIN,
317 case XC2028_TUNER_RESET:
318 /* Reset codes during load firmware */
321 /* newer tuner can faster reset */
322 switch (dev->model) {
323 case TM6010_BOARD_HAUPPAUGE_900H:
324 case TM6010_BOARD_TERRATEC_CINERGY_HYBRID_XE:
325 case TM6010_BOARD_TWINHAN_TU501:
326 tm6000_set_reg(dev, REQ_03_SET_GET_MCU_PIN,
327 dev->gpio.tuner_reset, 0x01);
329 tm6000_set_reg(dev, REQ_03_SET_GET_MCU_PIN,
330 dev->gpio.tuner_reset, 0x00);
332 tm6000_set_reg(dev, REQ_03_SET_GET_MCU_PIN,
333 dev->gpio.tuner_reset, 0x01);
337 tm6000_set_reg(dev, REQ_03_SET_GET_MCU_PIN,
338 dev->gpio.tuner_reset, 0x00);
340 tm6000_set_reg(dev, REQ_03_SET_GET_MCU_PIN,
341 dev->gpio.tuner_reset, 0x01);
347 tm6000_set_reg (dev, REQ_04_EN_DISABLE_MCU_INT,
353 rc=tm6000_set_reg (dev, REQ_03_SET_GET_MCU_PIN,
358 rc=tm6000_set_reg (dev, REQ_03_SET_GET_MCU_PIN,
367 int tm6000_cards_setup(struct tm6000_core *dev)
372 * Board-specific initialization sequence. Handles all GPIO
373 * initialization sequences that are board-specific.
374 * Up to now, all found devices use GPIO1 and GPIO4 at the same way.
375 * Probably, they're all based on some reference device. Due to that,
376 * there's a common routine at the end to handle those GPIO's. Devices
377 * that use different pinups or init sequences can just return at
378 * the board-specific session.
380 switch (dev->model) {
381 case TM6010_BOARD_HAUPPAUGE_900H:
382 case TM6010_BOARD_TERRATEC_CINERGY_HYBRID_XE:
383 case TM6010_BOARD_TWINHAN_TU501:
384 /* Turn xceive 3028 on */
385 tm6000_set_reg(dev, REQ_03_SET_GET_MCU_PIN, TM6010_GPIO_3, 0x01);
387 /* Turn zarlink zl10353 on */
388 tm6000_set_reg(dev, REQ_03_SET_GET_MCU_PIN, TM6010_GPIO_4, 0x00);
390 /* Reset zarlink zl10353 */
391 tm6000_set_reg(dev, REQ_03_SET_GET_MCU_PIN, TM6010_GPIO_1, 0x00);
393 tm6000_set_reg(dev, REQ_03_SET_GET_MCU_PIN, TM6010_GPIO_1, 0x01);
395 /* Turn zarlink zl10353 off */
396 tm6000_set_reg(dev, REQ_03_SET_GET_MCU_PIN, TM6010_GPIO_4, 0x01);
399 tm6000_set_reg(dev, REQ_03_SET_GET_MCU_PIN, TM6010_GPIO_0, 0x01);
401 /* Power led on (blue) */
402 tm6000_set_reg(dev, REQ_03_SET_GET_MCU_PIN, TM6010_GPIO_7, 0x00);
404 /* DVB led off (orange) */
405 tm6000_set_reg(dev, REQ_03_SET_GET_MCU_PIN, TM6010_GPIO_5, 0x01);
407 /* Turn zarlink zl10353 on */
408 tm6000_set_reg(dev, REQ_03_SET_GET_MCU_PIN, TM6010_GPIO_4, 0x00);
416 * Default initialization. Most of the devices seem to use GPIO1
417 * and GPIO4.on the same way, so, this handles the common sequence
418 * used by most devices.
419 * If a device uses a different sequence or different GPIO pins for
420 * reset, just add the code at the board-specific part
422 for (i = 0; i < 2; i++) {
423 rc = tm6000_set_reg(dev, REQ_03_SET_GET_MCU_PIN,
424 dev->gpio.tuner_reset, 0x00);
426 printk(KERN_ERR "Error %i doing GPIO1 reset\n", rc);
430 msleep(10); /* Just to be conservative */
431 rc = tm6000_set_reg(dev, REQ_03_SET_GET_MCU_PIN,
432 dev->gpio.tuner_reset, 0x01);
434 printk(KERN_ERR "Error %i doing GPIO1 reset\n", rc);
439 rc = tm6000_set_reg(dev, REQ_03_SET_GET_MCU_PIN, TM6000_GPIO_4, 0);
441 printk(KERN_ERR "Error %i doing GPIO4 reset\n", rc);
446 rc = tm6000_set_reg(dev, REQ_03_SET_GET_MCU_PIN, TM6000_GPIO_4, 1);
448 printk(KERN_ERR "Error %i doing GPIO4 reset\n", rc);
453 rc = tm6000_get_reg16(dev, 0x40, 0, 0);
455 printk(KERN_DEBUG "board=%d\n", rc);
464 static void tm6000_config_tuner (struct tm6000_core *dev)
466 struct tuner_setup tun_setup;
468 /* Load tuner module */
469 v4l2_i2c_new_subdev(&dev->v4l2_dev, &dev->i2c_adap,
470 "tuner", "tuner",dev->tuner_addr, NULL);
472 memset(&tun_setup, 0, sizeof(tun_setup));
473 tun_setup.type = dev->tuner_type;
474 tun_setup.addr = dev->tuner_addr;
475 tun_setup.mode_mask = T_ANALOG_TV | T_RADIO | T_DIGITAL_TV;
476 tun_setup.tuner_callback = tm6000_tuner_callback;
478 v4l2_device_call_all(&dev->v4l2_dev, 0, tuner, s_type_addr, &tun_setup);
480 if (dev->tuner_type == TUNER_XC2028) {
481 struct v4l2_priv_tun_config xc2028_cfg;
482 struct xc2028_ctrl ctl;
484 memset(&xc2028_cfg, 0, sizeof(xc2028_cfg));
485 memset (&ctl,0,sizeof(ctl));
488 ctl.read_not_reliable = 0;
490 ctl.demod = XC3028_FE_ZARLINK456;
493 xc2028_cfg.tuner = TUNER_XC2028;
494 xc2028_cfg.priv = &ctl;
497 case TM6010_BOARD_HAUPPAUGE_900H:
498 case TM6010_BOARD_TERRATEC_CINERGY_HYBRID_XE:
499 case TM6010_BOARD_TWINHAN_TU501:
500 ctl.fname = "xc3028L-v36.fw";
503 if (dev->dev_type == TM6010)
504 ctl.fname = "xc3028-v27.fw";
506 ctl.fname = "tm6000-xc3028.fw";
509 printk(KERN_INFO "Setting firmware parameters for xc2028\n");
511 v4l2_device_call_all(&dev->v4l2_dev, 0, tuner, s_config,
516 static int tm6000_init_dev(struct tm6000_core *dev)
518 struct v4l2_frequency f;
521 mutex_init(&dev->lock);
523 mutex_lock(&dev->lock);
525 /* Initializa board-specific data */
526 dev->dev_type = tm6000_boards[dev->model].type;
527 dev->tuner_type = tm6000_boards[dev->model].tuner_type;
528 dev->tuner_addr = tm6000_boards[dev->model].tuner_addr;
530 dev->gpio = tm6000_boards[dev->model].gpio;
532 dev->demod_addr = tm6000_boards[dev->model].demod_addr;
534 dev->caps = tm6000_boards[dev->model].caps;
536 /* initialize hardware */
537 rc=tm6000_init (dev);
541 rc = v4l2_device_register(&dev->udev->dev, &dev->v4l2_dev);
545 /* register i2c bus */
546 rc=tm6000_i2c_register(dev);
550 /* Default values for STD and resolutions */
553 dev->norm = V4L2_STD_PAL_M;
555 /* Configure tuner */
556 tm6000_config_tuner (dev);
558 /* Set video standard */
559 v4l2_device_call_all(&dev->v4l2_dev, 0, core, s_std, dev->norm);
561 /* Set tuner frequency - also loads firmware on xc2028/xc3028 */
563 f.type = V4L2_TUNER_ANALOG_TV;
564 f.frequency = 3092; /* 193.25 MHz */
565 dev->freq = f.frequency;
566 v4l2_device_call_all(&dev->v4l2_dev, 0, tuner, s_frequency, &f);
568 if (dev->caps.has_tda9874)
569 v4l2_i2c_new_subdev(&dev->v4l2_dev, &dev->i2c_adap,
570 "tvaudio", "tvaudio", I2C_ADDR_TDA9874, NULL);
572 /* register and initialize V4L2 */
573 rc=tm6000_v4l2_register(dev);
577 if(dev->caps.has_dvb) {
578 dev->dvb = kzalloc(sizeof(*(dev->dvb)), GFP_KERNEL);
584 #ifdef CONFIG_VIDEO_TM6000_DVB
585 rc = tm6000_dvb_register(dev);
593 mutex_unlock(&dev->lock);
597 v4l2_device_unregister(&dev->v4l2_dev);
600 mutex_unlock(&dev->lock);
604 /* high bandwidth multiplier, as encoded in highspeed endpoint descriptors */
605 #define hb_mult(wMaxPacketSize) (1 + (((wMaxPacketSize) >> 11) & 0x03))
607 static void get_max_endpoint ( struct usb_device *usbdev,
609 struct usb_host_endpoint *curr_e,
610 unsigned int *maxsize,
611 struct usb_host_endpoint **ep )
613 u16 tmp = le16_to_cpu(curr_e->desc.wMaxPacketSize);
614 unsigned int size = tmp & 0x7ff;
616 if (usbdev->speed == USB_SPEED_HIGH)
617 size = size * hb_mult (tmp);
622 printk("tm6000: %s endpoint: 0x%02x (max size=%u bytes)\n",
623 msgtype, curr_e->desc.bEndpointAddress,
630 * checks for supported devices
632 static int tm6000_usb_probe(struct usb_interface *interface,
633 const struct usb_device_id *id)
635 struct usb_device *usbdev;
636 struct tm6000_core *dev = NULL;
642 usbdev=usb_get_dev(interface_to_usbdev(interface));
644 /* Selects the proper interface */
645 rc=usb_set_interface(usbdev,0,1);
649 /* Check to see next free device and mark as used */
650 nr=find_first_zero_bit(&tm6000_devused,TM6000_MAXBOARDS);
651 if (nr >= TM6000_MAXBOARDS) {
652 printk ("tm6000: Supports only %i tm60xx boards.\n",TM6000_MAXBOARDS);
657 /* Create and initialize dev struct */
658 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
660 printk ("tm6000" ": out of memory!\n");
664 spin_lock_init(&dev->slock);
666 /* Increment usage count */
667 tm6000_devused|=1<<nr;
668 snprintf(dev->name, 29, "tm6000 #%d", nr);
670 dev->model=id->driver_info;
671 if ((card[nr]>=0) && (card[nr]<ARRAY_SIZE(tm6000_boards))) {
675 INIT_LIST_HEAD(&dev->tm6000_corelist);
679 switch (usbdev->speed) {
683 case USB_SPEED_UNKNOWN:
697 for (i = 0; i < interface->num_altsetting; i++) {
700 for (ep = 0; ep < interface->altsetting[i].desc.bNumEndpoints; ep++) {
701 struct usb_host_endpoint *e;
704 e = &interface->altsetting[i].endpoint[ep];
706 dir_out = ((e->desc.bEndpointAddress &
707 USB_ENDPOINT_DIR_MASK) == USB_DIR_OUT);
709 printk("tm6000: alt %d, interface %i, class %i\n",
711 interface->altsetting[i].desc.bInterfaceNumber,
712 interface->altsetting[i].desc.bInterfaceClass);
714 switch (e->desc.bmAttributes) {
715 case USB_ENDPOINT_XFER_BULK:
717 get_max_endpoint (usbdev, "Bulk IN", e,
721 get_max_endpoint (usbdev, "Bulk OUT", e,
726 case USB_ENDPOINT_XFER_ISOC:
728 get_max_endpoint (usbdev, "ISOC IN", e,
732 get_max_endpoint (usbdev, "ISOC OUT", e,
742 printk("tm6000: New video device @ %s Mbps (%04x:%04x, ifnum %d)\n",
744 le16_to_cpu(dev->udev->descriptor.idVendor),
745 le16_to_cpu(dev->udev->descriptor.idProduct),
746 interface->altsetting->desc.bInterfaceNumber);
748 /* check if the the device has the iso in endpoint at the correct place */
750 printk("tm6000: probing error: no IN ISOC endpoint!\n");
756 /* save our data pointer in this interface device */
757 usb_set_intfdata(interface, dev);
759 printk("tm6000: Found %s\n", tm6000_boards[dev->model].name);
761 rc=tm6000_init_dev(dev);
769 printk("tm6000: Error %d while registering\n", rc);
771 tm6000_devused&=~(1<<nr);
779 * tm6000_usb_disconnect()
780 * called when the device gets diconencted
781 * video device will be unregistered on v4l2_close in case it is still open
783 static void tm6000_usb_disconnect(struct usb_interface *interface)
785 struct tm6000_core *dev = usb_get_intfdata(interface);
786 usb_set_intfdata(interface, NULL);
791 printk("tm6000: disconnecting %s\n", dev->name);
793 mutex_lock(&dev->lock);
795 #ifdef CONFIG_VIDEO_TM6000_DVB
797 tm6000_dvb_unregister(dev);
802 tm6000_v4l2_unregister(dev);
804 tm6000_i2c_unregister(dev);
806 v4l2_device_unregister(&dev->v4l2_dev);
808 // wake_up_interruptible_all(&dev->open);
810 dev->state |= DEV_DISCONNECTED;
812 usb_put_dev(dev->udev);
814 mutex_unlock(&dev->lock);
818 static struct usb_driver tm6000_usb_driver = {
820 .probe = tm6000_usb_probe,
821 .disconnect = tm6000_usb_disconnect,
822 .id_table = tm6000_id_table,
825 static int __init tm6000_module_init(void)
829 printk(KERN_INFO "tm6000" " v4l2 driver version %d.%d.%d loaded\n",
830 (TM6000_VERSION >> 16) & 0xff,
831 (TM6000_VERSION >> 8) & 0xff, TM6000_VERSION & 0xff);
833 /* register this driver with the USB subsystem */
834 result = usb_register(&tm6000_usb_driver);
837 " usb_register failed. Error number %d.\n", result);
842 static void __exit tm6000_module_exit(void)
844 /* deregister at USB subsystem */
845 usb_deregister(&tm6000_usb_driver);
848 module_init(tm6000_module_init);
849 module_exit(tm6000_module_exit);
851 MODULE_DESCRIPTION("Trident TVMaster TM5600/TM6000/TM6010 USB2 adapter");
852 MODULE_AUTHOR("Mauro Carvalho Chehab");
853 MODULE_LICENSE("GPL");