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;
206 if (dev->state != SMSUSB_ACTIVE) {
207 pr_debug("Device not active yet\n");
211 phdr = kmalloc(size, GFP_KERNEL);
214 memcpy(phdr, buffer, size);
216 pr_debug("sending %s(%d) size: %d\n",
217 smscore_translate_msg(phdr->msg_type), phdr->msg_type,
220 smsendian_handle_tx_message((struct sms_msg_data *) phdr);
221 smsendian_handle_message_header((struct sms_msg_hdr *)phdr);
222 ret = usb_bulk_msg(dev->udev, usb_sndbulkpipe(dev->udev, 2),
223 phdr, size, &dummy, 1000);
229 static char *smsusb1_fw_lkup[] = {
237 static inline char *sms_get_fw_name(int mode, int board_id)
239 char **fw = sms_get_board(board_id)->fw;
240 return (fw && fw[mode]) ? fw[mode] : smsusb1_fw_lkup[mode];
243 static int smsusb1_load_firmware(struct usb_device *udev, int id, int board_id)
245 const struct firmware *fw;
251 id = sms_get_board(board_id)->default_mode;
253 if (id < DEVICE_MODE_DVBT || id > DEVICE_MODE_DVBT_BDA) {
254 pr_err("invalid firmware id specified %d\n", id);
258 fw_filename = sms_get_fw_name(id, board_id);
260 rc = reject_firmware(&fw, fw_filename, &udev->dev);
262 pr_warn("failed to open '%s' mode %d, trying again with default firmware\n",
265 fw_filename = smsusb1_fw_lkup[id];
266 rc = reject_firmware(&fw, fw_filename, &udev->dev);
268 pr_warn("failed to open '%s' mode %d\n",
275 fw_buffer = kmalloc(fw->size, GFP_KERNEL);
277 memcpy(fw_buffer, fw->data, fw->size);
279 rc = usb_bulk_msg(udev, usb_sndbulkpipe(udev, 2),
280 fw_buffer, fw->size, &dummy, 1000);
282 pr_debug("sent %zu(%d) bytes, rc %d\n", fw->size, dummy, rc);
286 pr_err("failed to allocate firmware buffer\n");
289 pr_debug("read FW %s, size=%zu\n", fw_filename, fw->size);
291 release_firmware(fw);
296 static void smsusb1_detectmode(void *context, int *mode)
298 char *product_string =
299 ((struct smsusb_device_t *) context)->udev->product;
301 *mode = DEVICE_MODE_NONE;
303 if (!product_string) {
304 product_string = "none";
305 pr_err("product string not found\n");
306 } else if (strstr(product_string, "DVBH"))
308 else if (strstr(product_string, "BDA"))
310 else if (strstr(product_string, "DVBT"))
312 else if (strstr(product_string, "TDMB"))
315 pr_debug("%d \"%s\"\n", *mode, product_string);
318 static int smsusb1_setmode(void *context, int mode)
320 struct sms_msg_hdr msg = { MSG_SW_RELOAD_REQ, 0, HIF_TASK,
321 sizeof(struct sms_msg_hdr), 0 };
323 if (mode < DEVICE_MODE_DVBT || mode > DEVICE_MODE_DVBT_BDA) {
324 pr_err("invalid firmware id specified %d\n", mode);
328 return smsusb_sendrequest(context, &msg, sizeof(msg));
331 static void smsusb_term_device(struct usb_interface *intf)
333 struct smsusb_device_t *dev = usb_get_intfdata(intf);
336 dev->state = SMSUSB_DISCONNECTED;
338 smsusb_stop_streaming(dev);
340 /* unregister from smscore */
342 smscore_unregister_device(dev->coredev);
344 pr_debug("device 0x%p destroyed\n", dev);
348 usb_set_intfdata(intf, NULL);
351 static void *siano_media_device_register(struct smsusb_device_t *dev,
354 #ifdef CONFIG_MEDIA_CONTROLLER_DVB
355 struct media_device *mdev;
356 struct usb_device *udev = dev->udev;
357 struct sms_board *board = sms_get_board(board_id);
360 mdev = kzalloc(sizeof(*mdev), GFP_KERNEL);
364 mdev->dev = &udev->dev;
365 strlcpy(mdev->model, board->name, sizeof(mdev->model));
367 strlcpy(mdev->serial, udev->serial, sizeof(mdev->serial));
368 strcpy(mdev->bus_info, udev->devpath);
369 mdev->hw_revision = le16_to_cpu(udev->descriptor.bcdDevice);
370 mdev->driver_version = LINUX_VERSION_CODE;
372 ret = media_device_register(mdev);
374 pr_err("Couldn't create a media device. Error: %d\n",
380 pr_info("media controller created\n");
388 static int smsusb_init_device(struct usb_interface *intf, int board_id)
390 struct smsdevice_params_t params;
391 struct smsusb_device_t *dev;
396 /* create device object */
397 dev = kzalloc(sizeof(struct smsusb_device_t), GFP_KERNEL);
401 memset(¶ms, 0, sizeof(params));
402 usb_set_intfdata(intf, dev);
403 dev->udev = interface_to_usbdev(intf);
404 dev->state = SMSUSB_DISCONNECTED;
406 for (i = 0; i < intf->cur_altsetting->desc.bNumEndpoints; i++) {
407 struct usb_endpoint_descriptor *desc =
408 &intf->cur_altsetting->endpoint[i].desc;
410 if (desc->bEndpointAddress & USB_DIR_IN) {
411 dev->in_ep = desc->bEndpointAddress;
412 align = usb_endpoint_maxp(desc) - sizeof(struct sms_msg_hdr);
414 dev->out_ep = desc->bEndpointAddress;
418 pr_debug("in_ep = %02x, out_ep = %02x\n", dev->in_ep, dev->out_ep);
419 if (!dev->in_ep || !dev->out_ep || align < 0) { /* Missing endpoints? */
420 smsusb_term_device(intf);
424 params.device_type = sms_get_board(board_id)->type;
426 switch (params.device_type) {
428 dev->buffer_size = USB1_BUFFER_SIZE;
430 params.setmode_handler = smsusb1_setmode;
431 params.detectmode_handler = smsusb1_detectmode;
433 case SMS_UNKNOWN_TYPE:
434 pr_err("Unspecified sms device type!\n");
437 dev->buffer_size = USB2_BUFFER_SIZE;
438 dev->response_alignment = align;
440 params.flags |= SMS_DEVICE_FAMILY2;
444 params.device = &dev->udev->dev;
445 params.buffer_size = dev->buffer_size;
446 params.num_buffers = MAX_BUFFERS;
447 params.sendrequest_handler = smsusb_sendrequest;
448 params.context = dev;
449 usb_make_path(dev->udev, params.devpath, sizeof(params.devpath));
451 mdev = siano_media_device_register(dev, board_id);
453 /* register in smscore */
454 rc = smscore_register_device(¶ms, &dev->coredev, mdev);
456 pr_err("smscore_register_device(...) failed, rc %d\n", rc);
457 smsusb_term_device(intf);
458 #ifdef CONFIG_MEDIA_CONTROLLER_DVB
459 media_device_unregister(mdev);
465 smscore_set_board_id(dev->coredev, board_id);
467 dev->coredev->is_usb_device = true;
469 /* initialize urbs */
470 for (i = 0; i < MAX_URBS; i++) {
471 dev->surbs[i].dev = dev;
472 usb_init_urb(&dev->surbs[i].urb);
475 pr_debug("smsusb_start_streaming(...).\n");
476 rc = smsusb_start_streaming(dev);
478 pr_err("smsusb_start_streaming(...) failed\n");
479 smsusb_term_device(intf);
483 dev->state = SMSUSB_ACTIVE;
485 rc = smscore_start_device(dev->coredev);
487 pr_err("smscore_start_device(...) failed\n");
488 smsusb_term_device(intf);
492 pr_debug("device 0x%p created\n", dev);
497 static int smsusb_probe(struct usb_interface *intf,
498 const struct usb_device_id *id)
500 struct usb_device *udev = interface_to_usbdev(intf);
504 pr_info("board id=%lu, interface number %d\n",
506 intf->cur_altsetting->desc.bInterfaceNumber);
508 if (sms_get_board(id->driver_info)->intf_num !=
509 intf->cur_altsetting->desc.bInterfaceNumber) {
510 pr_debug("interface %d won't be used. Expecting interface %d to popup\n",
511 intf->cur_altsetting->desc.bInterfaceNumber,
512 sms_get_board(id->driver_info)->intf_num);
516 if (intf->num_altsetting > 1) {
517 rc = usb_set_interface(udev,
518 intf->cur_altsetting->desc.bInterfaceNumber,
521 pr_err("usb_set_interface failed, rc %d\n", rc);
526 pr_debug("smsusb_probe %d\n",
527 intf->cur_altsetting->desc.bInterfaceNumber);
528 for (i = 0; i < intf->cur_altsetting->desc.bNumEndpoints; i++) {
529 pr_debug("endpoint %d %02x %02x %d\n", i,
530 intf->cur_altsetting->endpoint[i].desc.bEndpointAddress,
531 intf->cur_altsetting->endpoint[i].desc.bmAttributes,
532 intf->cur_altsetting->endpoint[i].desc.wMaxPacketSize);
533 if (intf->cur_altsetting->endpoint[i].desc.bEndpointAddress &
535 rc = usb_clear_halt(udev, usb_rcvbulkpipe(udev,
536 intf->cur_altsetting->endpoint[i].desc.bEndpointAddress));
538 rc = usb_clear_halt(udev, usb_sndbulkpipe(udev,
539 intf->cur_altsetting->endpoint[i].desc.bEndpointAddress));
541 if ((udev->actconfig->desc.bNumInterfaces == 2) &&
542 (intf->cur_altsetting->desc.bInterfaceNumber == 0)) {
543 pr_debug("rom interface 0 is not used\n");
547 if (id->driver_info == SMS1XXX_BOARD_SIANO_STELLAR_ROM) {
548 /* Detected a Siano Stellar uninitialized */
550 snprintf(devpath, sizeof(devpath), "usb\\%d-%s",
551 udev->bus->busnum, udev->devpath);
552 pr_info("stellar device in cold state was found at %s.\n",
554 rc = smsusb1_load_firmware(
555 udev, smscore_registry_getmode(devpath),
558 /* This device will reset and gain another USB ID */
560 pr_info("stellar device now in warm state\n");
562 pr_err("Failed to put stellar in warm state. Error: %d\n",
567 rc = smsusb_init_device(intf, id->driver_info);
570 pr_info("Device initialized with return code %d\n", rc);
571 sms_board_load_modules(id->driver_info);
575 static void smsusb_disconnect(struct usb_interface *intf)
577 smsusb_term_device(intf);
580 static int smsusb_suspend(struct usb_interface *intf, pm_message_t msg)
582 struct smsusb_device_t *dev = usb_get_intfdata(intf);
583 printk(KERN_INFO "%s Entering status %d.\n", __func__, msg.event);
584 dev->state = SMSUSB_SUSPENDED;
585 /*smscore_set_power_mode(dev, SMS_POWER_MODE_SUSPENDED);*/
586 smsusb_stop_streaming(dev);
590 static int smsusb_resume(struct usb_interface *intf)
593 struct smsusb_device_t *dev = usb_get_intfdata(intf);
594 struct usb_device *udev = interface_to_usbdev(intf);
596 printk(KERN_INFO "%s Entering.\n", __func__);
597 usb_clear_halt(udev, usb_rcvbulkpipe(udev, dev->in_ep));
598 usb_clear_halt(udev, usb_sndbulkpipe(udev, dev->out_ep));
600 for (i = 0; i < intf->cur_altsetting->desc.bNumEndpoints; i++)
601 printk(KERN_INFO "endpoint %d %02x %02x %d\n", i,
602 intf->cur_altsetting->endpoint[i].desc.bEndpointAddress,
603 intf->cur_altsetting->endpoint[i].desc.bmAttributes,
604 intf->cur_altsetting->endpoint[i].desc.wMaxPacketSize);
606 if (intf->num_altsetting > 0) {
607 rc = usb_set_interface(udev,
608 intf->cur_altsetting->desc.
609 bInterfaceNumber, 0);
611 printk(KERN_INFO "%s usb_set_interface failed, "
612 "rc %d\n", __func__, rc);
617 smsusb_start_streaming(dev);
621 static const struct usb_device_id smsusb_id_table[] = {
622 /* This device is only present before firmware load */
623 { USB_DEVICE(0x187f, 0x0010),
624 .driver_info = SMS1XXX_BOARD_SIANO_STELLAR_ROM },
625 /* This device pops up after firmware load */
626 { USB_DEVICE(0x187f, 0x0100),
627 .driver_info = SMS1XXX_BOARD_SIANO_STELLAR },
629 { USB_DEVICE(0x187f, 0x0200),
630 .driver_info = SMS1XXX_BOARD_SIANO_NOVA_A },
631 { USB_DEVICE(0x187f, 0x0201),
632 .driver_info = SMS1XXX_BOARD_SIANO_NOVA_B },
633 { USB_DEVICE(0x187f, 0x0300),
634 .driver_info = SMS1XXX_BOARD_SIANO_VEGA },
635 { USB_DEVICE(0x2040, 0x1700),
636 .driver_info = SMS1XXX_BOARD_HAUPPAUGE_CATAMOUNT },
637 { USB_DEVICE(0x2040, 0x1800),
638 .driver_info = SMS1XXX_BOARD_HAUPPAUGE_OKEMO_A },
639 { USB_DEVICE(0x2040, 0x1801),
640 .driver_info = SMS1XXX_BOARD_HAUPPAUGE_OKEMO_B },
641 { USB_DEVICE(0x2040, 0x2000),
642 .driver_info = SMS1XXX_BOARD_HAUPPAUGE_TIGER_MINICARD },
643 { USB_DEVICE(0x2040, 0x2009),
644 .driver_info = SMS1XXX_BOARD_HAUPPAUGE_TIGER_MINICARD_R2 },
645 { USB_DEVICE(0x2040, 0x200a),
646 .driver_info = SMS1XXX_BOARD_HAUPPAUGE_TIGER_MINICARD },
647 { USB_DEVICE(0x2040, 0x2010),
648 .driver_info = SMS1XXX_BOARD_HAUPPAUGE_TIGER_MINICARD },
649 { USB_DEVICE(0x2040, 0x2011),
650 .driver_info = SMS1XXX_BOARD_HAUPPAUGE_TIGER_MINICARD },
651 { USB_DEVICE(0x2040, 0x2019),
652 .driver_info = SMS1XXX_BOARD_HAUPPAUGE_TIGER_MINICARD },
653 { USB_DEVICE(0x2040, 0x5500),
654 .driver_info = SMS1XXX_BOARD_HAUPPAUGE_WINDHAM },
655 { USB_DEVICE(0x2040, 0x5510),
656 .driver_info = SMS1XXX_BOARD_HAUPPAUGE_WINDHAM },
657 { USB_DEVICE(0x2040, 0x5520),
658 .driver_info = SMS1XXX_BOARD_HAUPPAUGE_WINDHAM },
659 { USB_DEVICE(0x2040, 0x5530),
660 .driver_info = SMS1XXX_BOARD_HAUPPAUGE_WINDHAM },
661 { USB_DEVICE(0x2040, 0x5580),
662 .driver_info = SMS1XXX_BOARD_HAUPPAUGE_WINDHAM },
663 { USB_DEVICE(0x2040, 0x5590),
664 .driver_info = SMS1XXX_BOARD_HAUPPAUGE_WINDHAM },
665 { USB_DEVICE(0x187f, 0x0202),
666 .driver_info = SMS1XXX_BOARD_SIANO_NICE },
667 { USB_DEVICE(0x187f, 0x0301),
668 .driver_info = SMS1XXX_BOARD_SIANO_VENICE },
669 { USB_DEVICE(0x2040, 0xb900),
670 .driver_info = SMS1XXX_BOARD_HAUPPAUGE_WINDHAM },
671 { USB_DEVICE(0x2040, 0xb910),
672 .driver_info = SMS1XXX_BOARD_HAUPPAUGE_WINDHAM },
673 { USB_DEVICE(0x2040, 0xb980),
674 .driver_info = SMS1XXX_BOARD_HAUPPAUGE_WINDHAM },
675 { USB_DEVICE(0x2040, 0xb990),
676 .driver_info = SMS1XXX_BOARD_HAUPPAUGE_WINDHAM },
677 { USB_DEVICE(0x2040, 0xc000),
678 .driver_info = SMS1XXX_BOARD_HAUPPAUGE_WINDHAM },
679 { USB_DEVICE(0x2040, 0xc010),
680 .driver_info = SMS1XXX_BOARD_HAUPPAUGE_WINDHAM },
681 { USB_DEVICE(0x2040, 0xc080),
682 .driver_info = SMS1XXX_BOARD_HAUPPAUGE_WINDHAM },
683 { USB_DEVICE(0x2040, 0xc090),
684 .driver_info = SMS1XXX_BOARD_HAUPPAUGE_WINDHAM },
685 { USB_DEVICE(0x2040, 0xc0a0),
686 .driver_info = SMS1XXX_BOARD_HAUPPAUGE_WINDHAM },
687 { USB_DEVICE(0x2040, 0xf5a0),
688 .driver_info = SMS1XXX_BOARD_HAUPPAUGE_WINDHAM },
689 { USB_DEVICE(0x187f, 0x0202),
690 .driver_info = SMS1XXX_BOARD_SIANO_NICE },
691 { USB_DEVICE(0x187f, 0x0301),
692 .driver_info = SMS1XXX_BOARD_SIANO_VENICE },
693 { USB_DEVICE(0x187f, 0x0302),
694 .driver_info = SMS1XXX_BOARD_SIANO_VENICE },
695 { USB_DEVICE(0x187f, 0x0310),
696 .driver_info = SMS1XXX_BOARD_SIANO_MING },
697 { USB_DEVICE(0x187f, 0x0500),
698 .driver_info = SMS1XXX_BOARD_SIANO_PELE },
699 { USB_DEVICE(0x187f, 0x0600),
700 .driver_info = SMS1XXX_BOARD_SIANO_RIO },
701 { USB_DEVICE(0x187f, 0x0700),
702 .driver_info = SMS1XXX_BOARD_SIANO_DENVER_2160 },
703 { USB_DEVICE(0x187f, 0x0800),
704 .driver_info = SMS1XXX_BOARD_SIANO_DENVER_1530 },
705 { USB_DEVICE(0x19D2, 0x0086),
706 .driver_info = SMS1XXX_BOARD_ZTE_DVB_DATA_CARD },
707 { USB_DEVICE(0x19D2, 0x0078),
708 .driver_info = SMS1XXX_BOARD_ONDA_MDTV_DATA_CARD },
709 { USB_DEVICE(0x3275, 0x0080),
710 .driver_info = SMS1XXX_BOARD_SIANO_RIO },
711 { USB_DEVICE(0x2013, 0x0257),
712 .driver_info = SMS1XXX_BOARD_PCTV_77E },
713 { } /* Terminating entry */
716 MODULE_DEVICE_TABLE(usb, smsusb_id_table);
718 static struct usb_driver smsusb_driver = {
720 .probe = smsusb_probe,
721 .disconnect = smsusb_disconnect,
722 .id_table = smsusb_id_table,
724 .suspend = smsusb_suspend,
725 .resume = smsusb_resume,
728 module_usb_driver(smsusb_driver);
730 MODULE_DESCRIPTION("Driver for the Siano SMS1xxx USB dongle");
731 MODULE_AUTHOR("Siano Mobile Silicon, INC. (uris@siano-ms.com)");
732 MODULE_LICENSE("GPL");