1 // SPDX-License-Identifier: GPL-2.0-or-later
2 /****************************************************************
4 Siano Mobile Silicon, Inc.
5 MDTV receiver kernel modules.
6 Copyright (C) 2005-2009, Uri Shkolnik, Anatoly Greenblat
9 ****************************************************************/
11 #include "smscoreapi.h"
13 #include <linux/kernel.h>
14 #include <linux/init.h>
15 #include <linux/usb.h>
16 #include <linux/firmware.h>
17 #include <linux/slab.h>
18 #include <linux/module.h>
19 #include <media/media-device.h>
21 #include "sms-cards.h"
22 #include "smsendian.h"
24 #define USB1_BUFFER_SIZE 0x1000
25 #define USB2_BUFFER_SIZE 0x2000
27 #define MAX_BUFFERS 50
30 struct smsusb_device_t;
39 struct list_head entry;
40 struct smscore_buffer_t *cb;
41 struct smsusb_device_t *dev;
45 /* For the bottom half */
46 struct work_struct wq;
49 struct smsusb_device_t {
50 struct usb_device *udev;
51 struct smscore_device_t *coredev;
53 struct smsusb_urb_t surbs[MAX_URBS];
55 int response_alignment;
60 enum smsusb_state state;
63 static int smsusb_submit_urb(struct smsusb_device_t *dev,
64 struct smsusb_urb_t *surb);
67 * Completing URB's callback handler - bottom half (process context)
68 * submits the URB prepared on smsusb_onresponse()
70 static void do_submit_urb(struct work_struct *work)
72 struct smsusb_urb_t *surb = container_of(work, struct smsusb_urb_t, wq);
73 struct smsusb_device_t *dev = surb->dev;
75 smsusb_submit_urb(dev, surb);
79 * Completing URB's callback handler - top half (interrupt context)
80 * adds completing sms urb to the global surbs list and activtes the worker
82 * IMPORTANT - blocking functions must not be called from here !!!
84 * @param urb pointer to a completing urb object
86 static void smsusb_onresponse(struct urb *urb)
88 struct smsusb_urb_t *surb = (struct smsusb_urb_t *) urb->context;
89 struct smsusb_device_t *dev = surb->dev;
91 if (urb->status == -ESHUTDOWN) {
92 pr_err("error, urb status %d (-ESHUTDOWN), %d bytes\n",
93 urb->status, urb->actual_length);
97 if ((urb->actual_length > 0) && (urb->status == 0)) {
98 struct sms_msg_hdr *phdr = (struct sms_msg_hdr *)surb->cb->p;
100 smsendian_handle_message_header(phdr);
101 if (urb->actual_length >= phdr->msg_length) {
102 surb->cb->size = phdr->msg_length;
104 if (dev->response_alignment &&
105 (phdr->msg_flags & MSG_HDR_FLAG_SPLIT_MSG)) {
108 dev->response_alignment +
109 ((phdr->msg_flags >> 8) & 3);
112 if (((int) phdr->msg_length +
113 surb->cb->offset) > urb->actual_length) {
114 pr_err("invalid response msglen %d offset %d size %d\n",
118 goto exit_and_resubmit;
121 /* move buffer pointer and
122 * copy header to its new location */
123 memcpy((char *) phdr + surb->cb->offset,
124 phdr, sizeof(struct sms_msg_hdr));
126 surb->cb->offset = 0;
128 pr_debug("received %s(%d) size: %d\n",
129 smscore_translate_msg(phdr->msg_type),
130 phdr->msg_type, phdr->msg_length);
132 smsendian_handle_rx_message((struct sms_msg_data *) phdr);
134 smscore_onresponse(dev->coredev, surb->cb);
137 pr_err("invalid response msglen %d actual %d\n",
138 phdr->msg_length, urb->actual_length);
141 pr_err("error, urb status %d, %d bytes\n",
142 urb->status, urb->actual_length);
146 INIT_WORK(&surb->wq, do_submit_urb);
147 schedule_work(&surb->wq);
150 static int smsusb_submit_urb(struct smsusb_device_t *dev,
151 struct smsusb_urb_t *surb)
154 /* This function can sleep */
155 surb->cb = smscore_getbuffer(dev->coredev);
157 pr_err("smscore_getbuffer(...) returned NULL\n");
165 usb_rcvbulkpipe(dev->udev, dev->in_ep),
171 surb->urb.transfer_flags |= URB_FREE_BUFFER;
173 return usb_submit_urb(&surb->urb, GFP_ATOMIC);
176 static void smsusb_stop_streaming(struct smsusb_device_t *dev)
180 for (i = 0; i < MAX_URBS; i++) {
181 usb_kill_urb(&dev->surbs[i].urb);
182 cancel_work_sync(&dev->surbs[i].wq);
184 if (dev->surbs[i].cb) {
185 smscore_putbuffer(dev->coredev, dev->surbs[i].cb);
186 dev->surbs[i].cb = NULL;
191 static int smsusb_start_streaming(struct smsusb_device_t *dev)
195 for (i = 0; i < MAX_URBS; i++) {
196 rc = smsusb_submit_urb(dev, &dev->surbs[i]);
198 pr_err("smsusb_submit_urb(...) failed\n");
199 smsusb_stop_streaming(dev);
207 static int smsusb_sendrequest(void *context, void *buffer, size_t size)
209 struct smsusb_device_t *dev = (struct smsusb_device_t *) context;
210 struct sms_msg_hdr *phdr;
213 if (dev->state != SMSUSB_ACTIVE) {
214 pr_debug("Device not active yet\n");
218 phdr = kmemdup(buffer, size, GFP_KERNEL);
222 pr_debug("sending %s(%d) size: %d\n",
223 smscore_translate_msg(phdr->msg_type), phdr->msg_type,
226 smsendian_handle_tx_message((struct sms_msg_data *) phdr);
227 smsendian_handle_message_header((struct sms_msg_hdr *)phdr);
228 ret = usb_bulk_msg(dev->udev, usb_sndbulkpipe(dev->udev, 2),
229 phdr, size, &dummy, 1000);
235 static char *smsusb1_fw_lkup[] = {
236 "dvbt_stellar_usb.inp",
237 "dvbh_stellar_usb.inp",
238 "tdmb_stellar_usb.inp",
240 "dvbt_bda_stellar_usb.inp",
243 static inline char *sms_get_fw_name(int mode, int board_id)
245 char **fw = sms_get_board(board_id)->fw;
246 return (fw && fw[mode]) ? fw[mode] : smsusb1_fw_lkup[mode];
249 static int smsusb1_load_firmware(struct usb_device *udev, int id, int board_id)
251 const struct firmware *fw;
257 id = sms_get_board(board_id)->default_mode;
259 if (id < DEVICE_MODE_DVBT || id > DEVICE_MODE_DVBT_BDA) {
260 pr_err("invalid firmware id specified %d\n", id);
264 fw_filename = sms_get_fw_name(id, board_id);
266 rc = request_firmware(&fw, fw_filename, &udev->dev);
268 pr_warn("failed to open '%s' mode %d, trying again with default firmware\n",
271 fw_filename = smsusb1_fw_lkup[id];
272 rc = request_firmware(&fw, fw_filename, &udev->dev);
274 pr_warn("failed to open '%s' mode %d\n",
281 fw_buffer = kmalloc(fw->size, GFP_KERNEL);
283 memcpy(fw_buffer, fw->data, fw->size);
285 rc = usb_bulk_msg(udev, usb_sndbulkpipe(udev, 2),
286 fw_buffer, fw->size, &dummy, 1000);
288 pr_debug("sent %zu(%d) bytes, rc %d\n", fw->size, dummy, rc);
292 pr_err("failed to allocate firmware buffer\n");
295 pr_debug("read FW %s, size=%zu\n", fw_filename, fw->size);
297 release_firmware(fw);
302 static void smsusb1_detectmode(void *context, int *mode)
304 char *product_string =
305 ((struct smsusb_device_t *) context)->udev->product;
307 *mode = DEVICE_MODE_NONE;
309 if (!product_string) {
310 product_string = "none";
311 pr_err("product string not found\n");
312 } else if (strstr(product_string, "DVBH"))
314 else if (strstr(product_string, "BDA"))
316 else if (strstr(product_string, "DVBT"))
318 else if (strstr(product_string, "TDMB"))
321 pr_debug("%d \"%s\"\n", *mode, product_string);
324 static int smsusb1_setmode(void *context, int mode)
326 struct sms_msg_hdr msg = { MSG_SW_RELOAD_REQ, 0, HIF_TASK,
327 sizeof(struct sms_msg_hdr), 0 };
329 if (mode < DEVICE_MODE_DVBT || mode > DEVICE_MODE_DVBT_BDA) {
330 pr_err("invalid firmware id specified %d\n", mode);
334 return smsusb_sendrequest(context, &msg, sizeof(msg));
337 static void smsusb_term_device(struct usb_interface *intf)
339 struct smsusb_device_t *dev = usb_get_intfdata(intf);
342 dev->state = SMSUSB_DISCONNECTED;
344 smsusb_stop_streaming(dev);
346 /* unregister from smscore */
348 smscore_unregister_device(dev->coredev);
350 pr_debug("device 0x%p destroyed\n", dev);
354 usb_set_intfdata(intf, NULL);
357 static void *siano_media_device_register(struct smsusb_device_t *dev,
360 #ifdef CONFIG_MEDIA_CONTROLLER_DVB
361 struct media_device *mdev;
362 struct usb_device *udev = dev->udev;
363 struct sms_board *board = sms_get_board(board_id);
366 mdev = kzalloc(sizeof(*mdev), GFP_KERNEL);
370 media_device_usb_init(mdev, udev, board->name);
372 ret = media_device_register(mdev);
374 media_device_cleanup(mdev);
379 pr_info("media controller created\n");
387 static int smsusb_init_device(struct usb_interface *intf, int board_id)
389 struct smsdevice_params_t params;
390 struct smsusb_device_t *dev;
395 /* create device object */
396 dev = kzalloc(sizeof(struct smsusb_device_t), GFP_KERNEL);
400 memset(¶ms, 0, sizeof(params));
401 usb_set_intfdata(intf, dev);
402 dev->udev = interface_to_usbdev(intf);
403 dev->state = SMSUSB_DISCONNECTED;
405 for (i = 0; i < intf->cur_altsetting->desc.bNumEndpoints; i++) {
406 struct usb_endpoint_descriptor *desc =
407 &intf->cur_altsetting->endpoint[i].desc;
409 if (desc->bEndpointAddress & USB_DIR_IN) {
410 dev->in_ep = desc->bEndpointAddress;
411 align = usb_endpoint_maxp(desc) - sizeof(struct sms_msg_hdr);
413 dev->out_ep = desc->bEndpointAddress;
417 pr_debug("in_ep = %02x, out_ep = %02x\n", dev->in_ep, dev->out_ep);
418 if (!dev->in_ep || !dev->out_ep || align < 0) { /* Missing endpoints? */
419 smsusb_term_device(intf);
423 params.device_type = sms_get_board(board_id)->type;
425 switch (params.device_type) {
427 dev->buffer_size = USB1_BUFFER_SIZE;
429 params.setmode_handler = smsusb1_setmode;
430 params.detectmode_handler = smsusb1_detectmode;
432 case SMS_UNKNOWN_TYPE:
433 pr_err("Unspecified sms device type!\n");
436 dev->buffer_size = USB2_BUFFER_SIZE;
437 dev->response_alignment = align;
439 params.flags |= SMS_DEVICE_FAMILY2;
443 params.device = &dev->udev->dev;
444 params.usb_device = dev->udev;
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, 0, 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, rc %d\n",
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(0x2040, 0xb900),
666 .driver_info = SMS1XXX_BOARD_HAUPPAUGE_WINDHAM },
667 { USB_DEVICE(0x2040, 0xb910),
668 .driver_info = SMS1XXX_BOARD_HAUPPAUGE_WINDHAM },
669 { USB_DEVICE(0x2040, 0xb980),
670 .driver_info = SMS1XXX_BOARD_HAUPPAUGE_WINDHAM },
671 { USB_DEVICE(0x2040, 0xb990),
672 .driver_info = SMS1XXX_BOARD_HAUPPAUGE_WINDHAM },
673 { USB_DEVICE(0x2040, 0xc000),
674 .driver_info = SMS1XXX_BOARD_HAUPPAUGE_WINDHAM },
675 { USB_DEVICE(0x2040, 0xc010),
676 .driver_info = SMS1XXX_BOARD_HAUPPAUGE_WINDHAM },
677 { USB_DEVICE(0x2040, 0xc080),
678 .driver_info = SMS1XXX_BOARD_HAUPPAUGE_WINDHAM },
679 { USB_DEVICE(0x2040, 0xc090),
680 .driver_info = SMS1XXX_BOARD_HAUPPAUGE_WINDHAM },
681 { USB_DEVICE(0x2040, 0xc0a0),
682 .driver_info = SMS1XXX_BOARD_HAUPPAUGE_WINDHAM },
683 { USB_DEVICE(0x2040, 0xf5a0),
684 .driver_info = SMS1XXX_BOARD_HAUPPAUGE_WINDHAM },
685 { USB_DEVICE(0x187f, 0x0202),
686 .driver_info = SMS1XXX_BOARD_SIANO_NICE },
687 { USB_DEVICE(0x187f, 0x0301),
688 .driver_info = SMS1XXX_BOARD_SIANO_VENICE },
689 { USB_DEVICE(0x187f, 0x0302),
690 .driver_info = SMS1XXX_BOARD_SIANO_VENICE },
691 { USB_DEVICE(0x187f, 0x0310),
692 .driver_info = SMS1XXX_BOARD_SIANO_MING },
693 { USB_DEVICE(0x187f, 0x0500),
694 .driver_info = SMS1XXX_BOARD_SIANO_PELE },
695 { USB_DEVICE(0x187f, 0x0600),
696 .driver_info = SMS1XXX_BOARD_SIANO_RIO },
697 { USB_DEVICE(0x187f, 0x0700),
698 .driver_info = SMS1XXX_BOARD_SIANO_DENVER_2160 },
699 { USB_DEVICE(0x187f, 0x0800),
700 .driver_info = SMS1XXX_BOARD_SIANO_DENVER_1530 },
701 { USB_DEVICE(0x19D2, 0x0086),
702 .driver_info = SMS1XXX_BOARD_ZTE_DVB_DATA_CARD },
703 { USB_DEVICE(0x19D2, 0x0078),
704 .driver_info = SMS1XXX_BOARD_ONDA_MDTV_DATA_CARD },
705 { USB_DEVICE(0x3275, 0x0080),
706 .driver_info = SMS1XXX_BOARD_SIANO_RIO },
707 { USB_DEVICE(0x2013, 0x0257),
708 .driver_info = SMS1XXX_BOARD_PCTV_77E },
709 { } /* Terminating entry */
712 MODULE_DEVICE_TABLE(usb, smsusb_id_table);
714 static struct usb_driver smsusb_driver = {
716 .probe = smsusb_probe,
717 .disconnect = smsusb_disconnect,
718 .id_table = smsusb_id_table,
720 .suspend = smsusb_suspend,
721 .resume = smsusb_resume,
724 module_usb_driver(smsusb_driver);
726 MODULE_DESCRIPTION("Driver for the Siano SMS1xxx USB dongle");
728 MODULE_LICENSE("GPL");