1 /****************************************************************
3 Siano Mobile Silicon, Inc.
4 MDTV receiver kernel modules.
5 Copyright (C) 2005-2009, Uri Shkolnik, Anatoly Greenblat
7 This program is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 2 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program. If not, see <http://www.gnu.org/licenses/>.
20 ****************************************************************/
22 #include "smscoreapi.h"
24 #include <linux/kernel.h>
25 #include <linux/init.h>
26 #include <linux/usb.h>
27 #include <linux/firmware.h>
28 #include <linux/slab.h>
29 #include <linux/module.h>
31 #include "sms-cards.h"
32 #include "smsendian.h"
34 #define USB1_BUFFER_SIZE 0x1000
35 #define USB2_BUFFER_SIZE 0x2000
37 #define MAX_BUFFERS 50
40 struct smsusb_device_t;
49 struct list_head entry;
50 struct smscore_buffer_t *cb;
51 struct smsusb_device_t *dev;
56 struct smsusb_device_t {
57 struct usb_device *udev;
58 struct smscore_device_t *coredev;
60 struct smsusb_urb_t surbs[MAX_URBS];
62 int response_alignment;
67 enum smsusb_state state;
70 static int smsusb_submit_urb(struct smsusb_device_t *dev,
71 struct smsusb_urb_t *surb);
74 * Completing URB's callback handler - top half (interrupt context)
75 * adds completing sms urb to the global surbs list and activtes the worker
77 * IMPORTANT - blocking functions must not be called from here !!!
79 * @param urb pointer to a completing urb object
81 static void smsusb_onresponse(struct urb *urb)
83 struct smsusb_urb_t *surb = (struct smsusb_urb_t *) urb->context;
84 struct smsusb_device_t *dev = surb->dev;
86 if (urb->status == -ESHUTDOWN) {
87 pr_err("error, urb status %d (-ESHUTDOWN), %d bytes\n",
88 urb->status, urb->actual_length);
92 if ((urb->actual_length > 0) && (urb->status == 0)) {
93 struct sms_msg_hdr *phdr = (struct sms_msg_hdr *)surb->cb->p;
95 smsendian_handle_message_header(phdr);
96 if (urb->actual_length >= phdr->msg_length) {
97 surb->cb->size = phdr->msg_length;
99 if (dev->response_alignment &&
100 (phdr->msg_flags & MSG_HDR_FLAG_SPLIT_MSG)) {
103 dev->response_alignment +
104 ((phdr->msg_flags >> 8) & 3);
107 if (((int) phdr->msg_length +
108 surb->cb->offset) > urb->actual_length) {
109 pr_err("invalid response msglen %d offset %d size %d\n",
113 goto exit_and_resubmit;
116 /* move buffer pointer and
117 * copy header to its new location */
118 memcpy((char *) phdr + surb->cb->offset,
119 phdr, sizeof(struct sms_msg_hdr));
121 surb->cb->offset = 0;
123 pr_debug("received %s(%d) size: %d\n",
124 smscore_translate_msg(phdr->msg_type),
125 phdr->msg_type, phdr->msg_length);
127 smsendian_handle_rx_message((struct sms_msg_data *) phdr);
129 smscore_onresponse(dev->coredev, surb->cb);
132 pr_err("invalid response msglen %d actual %d\n",
133 phdr->msg_length, urb->actual_length);
136 pr_err("error, urb status %d, %d bytes\n",
137 urb->status, urb->actual_length);
141 smsusb_submit_urb(dev, surb);
144 static int smsusb_submit_urb(struct smsusb_device_t *dev,
145 struct smsusb_urb_t *surb)
148 surb->cb = smscore_getbuffer(dev->coredev);
150 pr_err("smscore_getbuffer(...) returned NULL\n");
158 usb_rcvbulkpipe(dev->udev, dev->in_ep),
164 surb->urb.transfer_dma = surb->cb->phys;
165 surb->urb.transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
167 return usb_submit_urb(&surb->urb, GFP_ATOMIC);
170 static void smsusb_stop_streaming(struct smsusb_device_t *dev)
174 for (i = 0; i < MAX_URBS; i++) {
175 usb_kill_urb(&dev->surbs[i].urb);
177 if (dev->surbs[i].cb) {
178 smscore_putbuffer(dev->coredev, dev->surbs[i].cb);
179 dev->surbs[i].cb = NULL;
184 static int smsusb_start_streaming(struct smsusb_device_t *dev)
188 for (i = 0; i < MAX_URBS; i++) {
189 rc = smsusb_submit_urb(dev, &dev->surbs[i]);
191 pr_err("smsusb_submit_urb(...) failed\n");
192 smsusb_stop_streaming(dev);
200 static int smsusb_sendrequest(void *context, void *buffer, size_t size)
202 struct smsusb_device_t *dev = (struct smsusb_device_t *) context;
203 struct sms_msg_hdr *phdr = (struct sms_msg_hdr *) buffer;
206 if (dev->state != SMSUSB_ACTIVE) {
207 pr_debug("Device not active yet\n");
211 pr_debug("sending %s(%d) size: %d\n",
212 smscore_translate_msg(phdr->msg_type), phdr->msg_type,
215 smsendian_handle_tx_message((struct sms_msg_data *) phdr);
216 smsendian_handle_message_header((struct sms_msg_hdr *)buffer);
217 return usb_bulk_msg(dev->udev, usb_sndbulkpipe(dev->udev, 2),
218 buffer, size, &dummy, 1000);
221 static char *smsusb1_fw_lkup[] = {
222 "dvbt_stellar_usb.inp",
223 "dvbh_stellar_usb.inp",
224 "tdmb_stellar_usb.inp",
226 "dvbt_bda_stellar_usb.inp",
229 static inline char *sms_get_fw_name(int mode, int board_id)
231 char **fw = sms_get_board(board_id)->fw;
232 return (fw && fw[mode]) ? fw[mode] : smsusb1_fw_lkup[mode];
235 static int smsusb1_load_firmware(struct usb_device *udev, int id, int board_id)
237 const struct firmware *fw;
243 id = sms_get_board(board_id)->default_mode;
245 if (id < DEVICE_MODE_DVBT || id > DEVICE_MODE_DVBT_BDA) {
246 pr_err("invalid firmware id specified %d\n", id);
250 fw_filename = sms_get_fw_name(id, board_id);
252 rc = request_firmware(&fw, fw_filename, &udev->dev);
254 pr_warn("failed to open '%s' mode %d, trying again with default firmware\n",
257 fw_filename = smsusb1_fw_lkup[id];
258 rc = request_firmware(&fw, fw_filename, &udev->dev);
260 pr_warn("failed to open '%s' mode %d\n",
267 fw_buffer = kmalloc(fw->size, GFP_KERNEL);
269 memcpy(fw_buffer, fw->data, fw->size);
271 rc = usb_bulk_msg(udev, usb_sndbulkpipe(udev, 2),
272 fw_buffer, fw->size, &dummy, 1000);
274 pr_debug("sent %zu(%d) bytes, rc %d\n", fw->size, dummy, rc);
278 pr_err("failed to allocate firmware buffer\n");
281 pr_debug("read FW %s, size=%zu\n", fw_filename, fw->size);
283 release_firmware(fw);
288 static void smsusb1_detectmode(void *context, int *mode)
290 char *product_string =
291 ((struct smsusb_device_t *) context)->udev->product;
293 *mode = DEVICE_MODE_NONE;
295 if (!product_string) {
296 product_string = "none";
297 pr_err("product string not found\n");
298 } else if (strstr(product_string, "DVBH"))
300 else if (strstr(product_string, "BDA"))
302 else if (strstr(product_string, "DVBT"))
304 else if (strstr(product_string, "TDMB"))
307 pr_debug("%d \"%s\"\n", *mode, product_string);
310 static int smsusb1_setmode(void *context, int mode)
312 struct sms_msg_hdr msg = { MSG_SW_RELOAD_REQ, 0, HIF_TASK,
313 sizeof(struct sms_msg_hdr), 0 };
315 if (mode < DEVICE_MODE_DVBT || mode > DEVICE_MODE_DVBT_BDA) {
316 pr_err("invalid firmware id specified %d\n", mode);
320 return smsusb_sendrequest(context, &msg, sizeof(msg));
323 static void smsusb_term_device(struct usb_interface *intf)
325 struct smsusb_device_t *dev = usb_get_intfdata(intf);
328 dev->state = SMSUSB_DISCONNECTED;
330 smsusb_stop_streaming(dev);
332 /* unregister from smscore */
334 smscore_unregister_device(dev->coredev);
336 pr_debug("device 0x%p destroyed\n", dev);
340 usb_set_intfdata(intf, NULL);
343 static void siano_media_device_register(struct smsusb_device_t *dev)
345 #ifdef CONFIG_MEDIA_CONTROLLER_DVB
346 struct media_device *mdev;
347 struct usb_device *udev = dev->udev;
348 int board_id = smscore_get_board_id(dev->coredev);
349 struct sms_board *board = sms_get_board(board_id);
352 mdev = kzalloc(sizeof(*mdev), GFP_KERNEL);
356 mdev->dev = &udev->dev;
357 strlcpy(mdev->model, board->name, sizeof(mdev->model));
359 strlcpy(mdev->serial, udev->serial, sizeof(mdev->serial));
360 strcpy(mdev->bus_info, udev->devpath);
361 mdev->hw_revision = le16_to_cpu(udev->descriptor.bcdDevice);
362 mdev->driver_version = LINUX_VERSION_CODE;
364 ret = media_device_register(mdev);
366 pr_err("Couldn't create a media device. Error: %d\n",
372 dev->coredev->media_dev = mdev;
374 pr_info("media controller created\n");
379 static int smsusb_init_device(struct usb_interface *intf, int board_id)
381 struct smsdevice_params_t params;
382 struct smsusb_device_t *dev;
385 /* create device object */
386 dev = kzalloc(sizeof(struct smsusb_device_t), GFP_KERNEL);
390 memset(¶ms, 0, sizeof(params));
391 usb_set_intfdata(intf, dev);
392 dev->udev = interface_to_usbdev(intf);
393 dev->state = SMSUSB_DISCONNECTED;
395 params.device_type = sms_get_board(board_id)->type;
397 switch (params.device_type) {
399 dev->buffer_size = USB1_BUFFER_SIZE;
401 params.setmode_handler = smsusb1_setmode;
402 params.detectmode_handler = smsusb1_detectmode;
404 case SMS_UNKNOWN_TYPE:
405 pr_err("Unspecified sms device type!\n");
408 dev->buffer_size = USB2_BUFFER_SIZE;
409 dev->response_alignment =
410 le16_to_cpu(dev->udev->ep_in[1]->desc.wMaxPacketSize) -
411 sizeof(struct sms_msg_hdr);
413 params.flags |= SMS_DEVICE_FAMILY2;
417 for (i = 0; i < intf->cur_altsetting->desc.bNumEndpoints; i++) {
418 if (intf->cur_altsetting->endpoint[i].desc. bEndpointAddress & USB_DIR_IN)
419 dev->in_ep = intf->cur_altsetting->endpoint[i].desc.bEndpointAddress;
421 dev->out_ep = intf->cur_altsetting->endpoint[i].desc.bEndpointAddress;
424 pr_debug("in_ep = %02x, out_ep = %02x\n",
425 dev->in_ep, dev->out_ep);
427 params.device = &dev->udev->dev;
428 params.buffer_size = dev->buffer_size;
429 params.num_buffers = MAX_BUFFERS;
430 params.sendrequest_handler = smsusb_sendrequest;
431 params.context = dev;
432 usb_make_path(dev->udev, params.devpath, sizeof(params.devpath));
434 /* register in smscore */
435 rc = smscore_register_device(¶ms, &dev->coredev);
437 pr_err("smscore_register_device(...) failed, rc %d\n", rc);
438 smsusb_term_device(intf);
442 smscore_set_board_id(dev->coredev, board_id);
444 dev->coredev->is_usb_device = true;
446 /* initialize urbs */
447 for (i = 0; i < MAX_URBS; i++) {
448 dev->surbs[i].dev = dev;
449 usb_init_urb(&dev->surbs[i].urb);
452 pr_debug("smsusb_start_streaming(...).\n");
453 rc = smsusb_start_streaming(dev);
455 pr_err("smsusb_start_streaming(...) failed\n");
456 smsusb_term_device(intf);
460 dev->state = SMSUSB_ACTIVE;
462 rc = smscore_start_device(dev->coredev);
464 pr_err("smscore_start_device(...) failed\n");
465 smsusb_term_device(intf);
469 pr_debug("device 0x%p created\n", dev);
470 siano_media_device_register(dev);
475 static int smsusb_probe(struct usb_interface *intf,
476 const struct usb_device_id *id)
478 struct usb_device *udev = interface_to_usbdev(intf);
482 pr_info("board id=%lu, interface number %d\n",
484 intf->cur_altsetting->desc.bInterfaceNumber);
486 if (sms_get_board(id->driver_info)->intf_num !=
487 intf->cur_altsetting->desc.bInterfaceNumber) {
488 pr_debug("interface %d won't be used. Expecting interface %d to popup\n",
489 intf->cur_altsetting->desc.bInterfaceNumber,
490 sms_get_board(id->driver_info)->intf_num);
494 if (intf->num_altsetting > 1) {
495 rc = usb_set_interface(udev,
496 intf->cur_altsetting->desc.bInterfaceNumber,
499 pr_err("usb_set_interface failed, rc %d\n", rc);
504 pr_debug("smsusb_probe %d\n",
505 intf->cur_altsetting->desc.bInterfaceNumber);
506 for (i = 0; i < intf->cur_altsetting->desc.bNumEndpoints; i++) {
507 pr_debug("endpoint %d %02x %02x %d\n", i,
508 intf->cur_altsetting->endpoint[i].desc.bEndpointAddress,
509 intf->cur_altsetting->endpoint[i].desc.bmAttributes,
510 intf->cur_altsetting->endpoint[i].desc.wMaxPacketSize);
511 if (intf->cur_altsetting->endpoint[i].desc.bEndpointAddress &
513 rc = usb_clear_halt(udev, usb_rcvbulkpipe(udev,
514 intf->cur_altsetting->endpoint[i].desc.bEndpointAddress));
516 rc = usb_clear_halt(udev, usb_sndbulkpipe(udev,
517 intf->cur_altsetting->endpoint[i].desc.bEndpointAddress));
519 if ((udev->actconfig->desc.bNumInterfaces == 2) &&
520 (intf->cur_altsetting->desc.bInterfaceNumber == 0)) {
521 pr_debug("rom interface 0 is not used\n");
525 if (id->driver_info == SMS1XXX_BOARD_SIANO_STELLAR_ROM) {
526 /* Detected a Siano Stellar uninitialized */
528 snprintf(devpath, sizeof(devpath), "usb\\%d-%s",
529 udev->bus->busnum, udev->devpath);
530 pr_info("stellar device in cold state was found at %s.\n",
532 rc = smsusb1_load_firmware(
533 udev, smscore_registry_getmode(devpath),
536 /* This device will reset and gain another USB ID */
538 pr_info("stellar device now in warm state\n");
540 pr_err("Failed to put stellar in warm state. Error: %d\n",
545 rc = smsusb_init_device(intf, id->driver_info);
548 pr_info("Device initialized with return code %d\n", rc);
549 sms_board_load_modules(id->driver_info);
553 static void smsusb_disconnect(struct usb_interface *intf)
555 smsusb_term_device(intf);
558 static int smsusb_suspend(struct usb_interface *intf, pm_message_t msg)
560 struct smsusb_device_t *dev = usb_get_intfdata(intf);
561 printk(KERN_INFO "%s Entering status %d.\n", __func__, msg.event);
562 dev->state = SMSUSB_SUSPENDED;
563 /*smscore_set_power_mode(dev, SMS_POWER_MODE_SUSPENDED);*/
564 smsusb_stop_streaming(dev);
568 static int smsusb_resume(struct usb_interface *intf)
571 struct smsusb_device_t *dev = usb_get_intfdata(intf);
572 struct usb_device *udev = interface_to_usbdev(intf);
574 printk(KERN_INFO "%s Entering.\n", __func__);
575 usb_clear_halt(udev, usb_rcvbulkpipe(udev, dev->in_ep));
576 usb_clear_halt(udev, usb_sndbulkpipe(udev, dev->out_ep));
578 for (i = 0; i < intf->cur_altsetting->desc.bNumEndpoints; i++)
579 printk(KERN_INFO "endpoint %d %02x %02x %d\n", i,
580 intf->cur_altsetting->endpoint[i].desc.bEndpointAddress,
581 intf->cur_altsetting->endpoint[i].desc.bmAttributes,
582 intf->cur_altsetting->endpoint[i].desc.wMaxPacketSize);
584 if (intf->num_altsetting > 0) {
585 rc = usb_set_interface(udev,
586 intf->cur_altsetting->desc.
587 bInterfaceNumber, 0);
589 printk(KERN_INFO "%s usb_set_interface failed, "
590 "rc %d\n", __func__, rc);
595 smsusb_start_streaming(dev);
599 static const struct usb_device_id smsusb_id_table[] = {
600 /* This device is only present before firmware load */
601 { USB_DEVICE(0x187f, 0x0010),
602 .driver_info = SMS1XXX_BOARD_SIANO_STELLAR_ROM },
603 /* This device pops up after firmware load */
604 { USB_DEVICE(0x187f, 0x0100),
605 .driver_info = SMS1XXX_BOARD_SIANO_STELLAR },
607 { USB_DEVICE(0x187f, 0x0200),
608 .driver_info = SMS1XXX_BOARD_SIANO_NOVA_A },
609 { USB_DEVICE(0x187f, 0x0201),
610 .driver_info = SMS1XXX_BOARD_SIANO_NOVA_B },
611 { USB_DEVICE(0x187f, 0x0300),
612 .driver_info = SMS1XXX_BOARD_SIANO_VEGA },
613 { USB_DEVICE(0x2040, 0x1700),
614 .driver_info = SMS1XXX_BOARD_HAUPPAUGE_CATAMOUNT },
615 { USB_DEVICE(0x2040, 0x1800),
616 .driver_info = SMS1XXX_BOARD_HAUPPAUGE_OKEMO_A },
617 { USB_DEVICE(0x2040, 0x1801),
618 .driver_info = SMS1XXX_BOARD_HAUPPAUGE_OKEMO_B },
619 { USB_DEVICE(0x2040, 0x2000),
620 .driver_info = SMS1XXX_BOARD_HAUPPAUGE_TIGER_MINICARD },
621 { USB_DEVICE(0x2040, 0x2009),
622 .driver_info = SMS1XXX_BOARD_HAUPPAUGE_TIGER_MINICARD_R2 },
623 { USB_DEVICE(0x2040, 0x200a),
624 .driver_info = SMS1XXX_BOARD_HAUPPAUGE_TIGER_MINICARD },
625 { USB_DEVICE(0x2040, 0x2010),
626 .driver_info = SMS1XXX_BOARD_HAUPPAUGE_TIGER_MINICARD },
627 { USB_DEVICE(0x2040, 0x2011),
628 .driver_info = SMS1XXX_BOARD_HAUPPAUGE_TIGER_MINICARD },
629 { USB_DEVICE(0x2040, 0x2019),
630 .driver_info = SMS1XXX_BOARD_HAUPPAUGE_TIGER_MINICARD },
631 { USB_DEVICE(0x2040, 0x5500),
632 .driver_info = SMS1XXX_BOARD_HAUPPAUGE_WINDHAM },
633 { USB_DEVICE(0x2040, 0x5510),
634 .driver_info = SMS1XXX_BOARD_HAUPPAUGE_WINDHAM },
635 { USB_DEVICE(0x2040, 0x5520),
636 .driver_info = SMS1XXX_BOARD_HAUPPAUGE_WINDHAM },
637 { USB_DEVICE(0x2040, 0x5530),
638 .driver_info = SMS1XXX_BOARD_HAUPPAUGE_WINDHAM },
639 { USB_DEVICE(0x2040, 0x5580),
640 .driver_info = SMS1XXX_BOARD_HAUPPAUGE_WINDHAM },
641 { USB_DEVICE(0x2040, 0x5590),
642 .driver_info = SMS1XXX_BOARD_HAUPPAUGE_WINDHAM },
643 { USB_DEVICE(0x187f, 0x0202),
644 .driver_info = SMS1XXX_BOARD_SIANO_NICE },
645 { USB_DEVICE(0x187f, 0x0301),
646 .driver_info = SMS1XXX_BOARD_SIANO_VENICE },
647 { USB_DEVICE(0x2040, 0xb900),
648 .driver_info = SMS1XXX_BOARD_HAUPPAUGE_WINDHAM },
649 { USB_DEVICE(0x2040, 0xb910),
650 .driver_info = SMS1XXX_BOARD_HAUPPAUGE_WINDHAM },
651 { USB_DEVICE(0x2040, 0xb980),
652 .driver_info = SMS1XXX_BOARD_HAUPPAUGE_WINDHAM },
653 { USB_DEVICE(0x2040, 0xb990),
654 .driver_info = SMS1XXX_BOARD_HAUPPAUGE_WINDHAM },
655 { USB_DEVICE(0x2040, 0xc000),
656 .driver_info = SMS1XXX_BOARD_HAUPPAUGE_WINDHAM },
657 { USB_DEVICE(0x2040, 0xc010),
658 .driver_info = SMS1XXX_BOARD_HAUPPAUGE_WINDHAM },
659 { USB_DEVICE(0x2040, 0xc080),
660 .driver_info = SMS1XXX_BOARD_HAUPPAUGE_WINDHAM },
661 { USB_DEVICE(0x2040, 0xc090),
662 .driver_info = SMS1XXX_BOARD_HAUPPAUGE_WINDHAM },
663 { USB_DEVICE(0x2040, 0xc0a0),
664 .driver_info = SMS1XXX_BOARD_HAUPPAUGE_WINDHAM },
665 { USB_DEVICE(0x2040, 0xf5a0),
666 .driver_info = SMS1XXX_BOARD_HAUPPAUGE_WINDHAM },
667 { USB_DEVICE(0x187f, 0x0202),
668 .driver_info = SMS1XXX_BOARD_SIANO_NICE },
669 { USB_DEVICE(0x187f, 0x0301),
670 .driver_info = SMS1XXX_BOARD_SIANO_VENICE },
671 { USB_DEVICE(0x187f, 0x0302),
672 .driver_info = SMS1XXX_BOARD_SIANO_VENICE },
673 { USB_DEVICE(0x187f, 0x0310),
674 .driver_info = SMS1XXX_BOARD_SIANO_MING },
675 { USB_DEVICE(0x187f, 0x0500),
676 .driver_info = SMS1XXX_BOARD_SIANO_PELE },
677 { USB_DEVICE(0x187f, 0x0600),
678 .driver_info = SMS1XXX_BOARD_SIANO_RIO },
679 { USB_DEVICE(0x187f, 0x0700),
680 .driver_info = SMS1XXX_BOARD_SIANO_DENVER_2160 },
681 { USB_DEVICE(0x187f, 0x0800),
682 .driver_info = SMS1XXX_BOARD_SIANO_DENVER_1530 },
683 { USB_DEVICE(0x19D2, 0x0086),
684 .driver_info = SMS1XXX_BOARD_ZTE_DVB_DATA_CARD },
685 { USB_DEVICE(0x19D2, 0x0078),
686 .driver_info = SMS1XXX_BOARD_ONDA_MDTV_DATA_CARD },
687 { USB_DEVICE(0x3275, 0x0080),
688 .driver_info = SMS1XXX_BOARD_SIANO_RIO },
689 { USB_DEVICE(0x2013, 0x0257),
690 .driver_info = SMS1XXX_BOARD_PCTV_77E },
691 { } /* Terminating entry */
694 MODULE_DEVICE_TABLE(usb, smsusb_id_table);
696 static struct usb_driver smsusb_driver = {
698 .probe = smsusb_probe,
699 .disconnect = smsusb_disconnect,
700 .id_table = smsusb_id_table,
702 .suspend = smsusb_suspend,
703 .resume = smsusb_resume,
706 module_usb_driver(smsusb_driver);
708 MODULE_DESCRIPTION("Driver for the Siano SMS1xxx USB dongle");
709 MODULE_AUTHOR("Siano Mobile Silicon, INC. (uris@siano-ms.com)");
710 MODULE_LICENSE("GPL");