1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31#define DRIVER_AUTHOR "Tobias Lorenz <tobias.lorenz@gmx.net>"
32#define DRIVER_CARD "Silicon Labs Si470x FM Radio Receiver"
33#define DRIVER_DESC "USB radio driver for Si470x FM Radio Receivers"
34#define DRIVER_VERSION "1.0.10"
35
36
37#include <linux/usb.h>
38#include <linux/hid.h>
39#include <linux/slab.h>
40
41#include "radio-si470x.h"
42
43
44
45static struct usb_device_id si470x_usb_driver_id_table[] = {
46
47 { USB_DEVICE_AND_INTERFACE_INFO(0x10c4, 0x818a, USB_CLASS_HID, 0, 0) },
48
49 { USB_DEVICE_AND_INTERFACE_INFO(0x06e1, 0xa155, USB_CLASS_HID, 0, 0) },
50
51 { USB_DEVICE_AND_INTERFACE_INFO(0x1b80, 0xd700, USB_CLASS_HID, 0, 0) },
52
53 { USB_DEVICE_AND_INTERFACE_INFO(0x10c5, 0x819a, USB_CLASS_HID, 0, 0) },
54
55 { }
56};
57MODULE_DEVICE_TABLE(usb, si470x_usb_driver_id_table);
58
59
60
61
62
63
64
65
66static int radio_nr = -1;
67module_param(radio_nr, int, 0444);
68MODULE_PARM_DESC(radio_nr, "Radio Nr");
69
70
71static unsigned int usb_timeout = 500;
72module_param(usb_timeout, uint, 0644);
73MODULE_PARM_DESC(usb_timeout, "USB timeout (ms): *500*");
74
75
76static unsigned int rds_buf = 100;
77module_param(rds_buf, uint, 0444);
78MODULE_PARM_DESC(rds_buf, "RDS buffer entries: *100*");
79
80
81static unsigned short max_rds_errors = 1;
82
83
84
85
86module_param(max_rds_errors, ushort, 0644);
87MODULE_PARM_DESC(max_rds_errors, "RDS maximum block errors: *1*");
88
89
90
91
92
93
94
95
96
97
98#define REGISTER_REPORT_SIZE (RADIO_REGISTER_SIZE + 1)
99#define REGISTER_REPORT(reg) ((reg) + 1)
100
101
102
103#define ENTIRE_REPORT_SIZE (RADIO_REGISTER_NUM * RADIO_REGISTER_SIZE + 1)
104#define ENTIRE_REPORT 17
105
106
107
108#define RDS_REPORT_SIZE (RDS_REGISTER_NUM * RADIO_REGISTER_SIZE + 1)
109#define RDS_REPORT 18
110
111
112#define LED_REPORT_SIZE 3
113#define LED_REPORT 19
114
115
116#define STREAM_REPORT_SIZE 3
117#define STREAM_REPORT 19
118
119
120#define SCRATCH_PAGE_SIZE 63
121#define SCRATCH_REPORT_SIZE (SCRATCH_PAGE_SIZE + 1)
122#define SCRATCH_REPORT 20
123
124
125#define WRITE_REPORT_SIZE 4
126#define WRITE_REPORT 19
127#define FLASH_REPORT_SIZE 64
128#define FLASH_REPORT 20
129#define CRC_REPORT_SIZE 3
130#define CRC_REPORT 21
131#define RESPONSE_REPORT_SIZE 2
132#define RESPONSE_REPORT 22
133
134
135
136#define UNUSED_REPORT 23
137
138
139
140
141
142
143#define RADIO_SW_VERSION_NOT_BOOTLOADABLE 6
144#define RADIO_SW_VERSION 7
145#define RADIO_HW_VERSION 1
146
147
148
149
150
151
152#define LED_COMMAND 0x35
153
154#define NO_CHANGE_LED 0x00
155#define ALL_COLOR_LED 0x01
156#define BLINK_GREEN_LED 0x02
157#define BLINK_RED_LED 0x04
158#define BLINK_ORANGE_LED 0x10
159#define SOLID_GREEN_LED 0x20
160#define SOLID_RED_LED 0x40
161#define SOLID_ORANGE_LED 0x80
162
163
164
165
166
167
168#define STREAM_COMMAND 0x36
169#define STREAM_VIDPID 0x00
170#define STREAM_AUDIO 0xff
171
172
173
174
175
176
177
178
179#define UNIQUE_BL_ID 0x34
180
181
182#define FLASH_DATA_MASK 0x55
183
184
185#define GET_SW_VERSION_COMMAND 0x00
186#define SET_PAGE_COMMAND 0x01
187#define ERASE_PAGE_COMMAND 0x02
188#define WRITE_PAGE_COMMAND 0x03
189#define CRC_ON_PAGE_COMMAND 0x04
190#define READ_FLASH_BYTE_COMMAND 0x05
191#define RESET_DEVICE_COMMAND 0x06
192#define GET_HW_VERSION_COMMAND 0x07
193#define BLANK 0xff
194
195
196#define COMMAND_OK 0x01
197#define COMMAND_FAILED 0x02
198#define COMMAND_PENDING 0x03
199
200
201
202
203
204
205
206
207
208
209static int si470x_get_report(struct si470x_device *radio, void *buf, int size)
210{
211 unsigned char *report = (unsigned char *) buf;
212 int retval;
213
214 retval = usb_control_msg(radio->usbdev,
215 usb_rcvctrlpipe(radio->usbdev, 0),
216 HID_REQ_GET_REPORT,
217 USB_TYPE_CLASS | USB_RECIP_INTERFACE | USB_DIR_IN,
218 report[0], 2,
219 buf, size, usb_timeout);
220
221 if (retval < 0)
222 dev_warn(&radio->intf->dev,
223 "si470x_get_report: usb_control_msg returned %d\n",
224 retval);
225 return retval;
226}
227
228
229
230
231
232static int si470x_set_report(struct si470x_device *radio, void *buf, int size)
233{
234 unsigned char *report = (unsigned char *) buf;
235 int retval;
236
237 retval = usb_control_msg(radio->usbdev,
238 usb_sndctrlpipe(radio->usbdev, 0),
239 HID_REQ_SET_REPORT,
240 USB_TYPE_CLASS | USB_RECIP_INTERFACE | USB_DIR_OUT,
241 report[0], 2,
242 buf, size, usb_timeout);
243
244 if (retval < 0)
245 dev_warn(&radio->intf->dev,
246 "si470x_set_report: usb_control_msg returned %d\n",
247 retval);
248 return retval;
249}
250
251
252
253
254
255int si470x_get_register(struct si470x_device *radio, int regnr)
256{
257 unsigned char buf[REGISTER_REPORT_SIZE];
258 int retval;
259
260 buf[0] = REGISTER_REPORT(regnr);
261
262 retval = si470x_get_report(radio, (void *) &buf, sizeof(buf));
263
264 if (retval >= 0)
265 radio->registers[regnr] = get_unaligned_be16(&buf[1]);
266
267 return (retval < 0) ? -EINVAL : 0;
268}
269
270
271
272
273
274int si470x_set_register(struct si470x_device *radio, int regnr)
275{
276 unsigned char buf[REGISTER_REPORT_SIZE];
277 int retval;
278
279 buf[0] = REGISTER_REPORT(regnr);
280 put_unaligned_be16(radio->registers[regnr], &buf[1]);
281
282 retval = si470x_set_report(radio, (void *) &buf, sizeof(buf));
283
284 return (retval < 0) ? -EINVAL : 0;
285}
286
287
288
289
290
291
292
293
294
295
296static int si470x_get_all_registers(struct si470x_device *radio)
297{
298 unsigned char buf[ENTIRE_REPORT_SIZE];
299 int retval;
300 unsigned char regnr;
301
302 buf[0] = ENTIRE_REPORT;
303
304 retval = si470x_get_report(radio, (void *) &buf, sizeof(buf));
305
306 if (retval >= 0)
307 for (regnr = 0; regnr < RADIO_REGISTER_NUM; regnr++)
308 radio->registers[regnr] = get_unaligned_be16(
309 &buf[regnr * RADIO_REGISTER_SIZE + 1]);
310
311 return (retval < 0) ? -EINVAL : 0;
312}
313
314
315
316
317
318
319
320
321
322
323static int si470x_set_led_state(struct si470x_device *radio,
324 unsigned char led_state)
325{
326 unsigned char buf[LED_REPORT_SIZE];
327 int retval;
328
329 buf[0] = LED_REPORT;
330 buf[1] = LED_COMMAND;
331 buf[2] = led_state;
332
333 retval = si470x_set_report(radio, (void *) &buf, sizeof(buf));
334
335 return (retval < 0) ? -EINVAL : 0;
336}
337
338
339
340
341
342
343
344
345
346
347static int si470x_get_scratch_page_versions(struct si470x_device *radio)
348{
349 unsigned char buf[SCRATCH_REPORT_SIZE];
350 int retval;
351
352 buf[0] = SCRATCH_REPORT;
353
354 retval = si470x_get_report(radio, (void *) &buf, sizeof(buf));
355
356 if (retval < 0)
357 dev_warn(&radio->intf->dev, "si470x_get_scratch: "
358 "si470x_get_report returned %d\n", retval);
359 else {
360 radio->software_version = buf[1];
361 radio->hardware_version = buf[2];
362 }
363
364 return (retval < 0) ? -EINVAL : 0;
365}
366
367
368
369
370
371
372
373
374
375
376int si470x_disconnect_check(struct si470x_device *radio)
377{
378 if (radio->disconnected)
379 return -EIO;
380 else
381 return 0;
382}
383
384
385
386
387
388
389
390
391
392
393
394
395static void si470x_int_in_callback(struct urb *urb)
396{
397 struct si470x_device *radio = urb->context;
398 int retval;
399 unsigned char regnr;
400 unsigned char blocknum;
401 unsigned short bler;
402 unsigned short rds;
403 unsigned char tmpbuf[3];
404
405 if (urb->status) {
406 if (urb->status == -ENOENT ||
407 urb->status == -ECONNRESET ||
408 urb->status == -ESHUTDOWN) {
409 return;
410 } else {
411 dev_warn(&radio->intf->dev,
412 "non-zero urb status (%d)\n", urb->status);
413 goto resubmit;
414 }
415 }
416
417
418 if (radio->disconnected)
419 return;
420 if ((radio->registers[SYSCONFIG1] & SYSCONFIG1_RDS) == 0)
421 goto resubmit;
422
423 if (urb->actual_length > 0) {
424
425 for (regnr = 0; regnr < RDS_REGISTER_NUM; regnr++)
426 radio->registers[STATUSRSSI + regnr] =
427 get_unaligned_be16(&radio->int_in_buffer[
428 regnr * RADIO_REGISTER_SIZE + 1]);
429
430 if ((radio->registers[STATUSRSSI] & STATUSRSSI_RDSR) == 0) {
431
432 goto resubmit;
433 }
434 if ((radio->registers[STATUSRSSI] & STATUSRSSI_RDSS) == 0) {
435
436 goto resubmit;
437 }
438 for (blocknum = 0; blocknum < 4; blocknum++) {
439 switch (blocknum) {
440 default:
441 bler = (radio->registers[STATUSRSSI] &
442 STATUSRSSI_BLERA) >> 9;
443 rds = radio->registers[RDSA];
444 break;
445 case 1:
446 bler = (radio->registers[READCHAN] &
447 READCHAN_BLERB) >> 14;
448 rds = radio->registers[RDSB];
449 break;
450 case 2:
451 bler = (radio->registers[READCHAN] &
452 READCHAN_BLERC) >> 12;
453 rds = radio->registers[RDSC];
454 break;
455 case 3:
456 bler = (radio->registers[READCHAN] &
457 READCHAN_BLERD) >> 10;
458 rds = radio->registers[RDSD];
459 break;
460 };
461
462
463 put_unaligned_le16(rds, &tmpbuf);
464 tmpbuf[2] = blocknum;
465 tmpbuf[2] |= blocknum << 3;
466 if (bler > max_rds_errors)
467 tmpbuf[2] |= 0x80;
468 else if (bler > 0)
469 tmpbuf[2] |= 0x40;
470
471
472 memcpy(&radio->buffer[radio->wr_index], &tmpbuf, 3);
473 radio->wr_index += 3;
474
475
476 if (radio->wr_index >= radio->buf_size)
477 radio->wr_index = 0;
478
479
480 if (radio->wr_index == radio->rd_index) {
481
482 radio->rd_index += 3;
483 if (radio->rd_index >= radio->buf_size)
484 radio->rd_index = 0;
485 }
486 }
487 if (radio->wr_index != radio->rd_index)
488 wake_up_interruptible(&radio->read_queue);
489 }
490
491resubmit:
492
493 if (radio->int_in_running && radio->usbdev) {
494 retval = usb_submit_urb(radio->int_in_urb, GFP_ATOMIC);
495 if (retval) {
496 dev_warn(&radio->intf->dev,
497 "resubmitting urb failed (%d)", retval);
498 radio->int_in_running = 0;
499 }
500 }
501}
502
503
504
505
506
507
508
509
510
511
512int si470x_fops_open(struct file *file)
513{
514 struct si470x_device *radio = video_drvdata(file);
515 int retval;
516
517 mutex_lock(&radio->lock);
518 radio->users++;
519
520 retval = usb_autopm_get_interface(radio->intf);
521 if (retval < 0) {
522 radio->users--;
523 retval = -EIO;
524 goto done;
525 }
526
527 if (radio->users == 1) {
528
529 retval = si470x_start(radio);
530 if (retval < 0) {
531 usb_autopm_put_interface(radio->intf);
532 goto done;
533 }
534
535
536 usb_fill_int_urb(radio->int_in_urb, radio->usbdev,
537 usb_rcvintpipe(radio->usbdev,
538 radio->int_in_endpoint->bEndpointAddress),
539 radio->int_in_buffer,
540 le16_to_cpu(radio->int_in_endpoint->wMaxPacketSize),
541 si470x_int_in_callback,
542 radio,
543 radio->int_in_endpoint->bInterval);
544
545 radio->int_in_running = 1;
546 mb();
547
548 retval = usb_submit_urb(radio->int_in_urb, GFP_KERNEL);
549 if (retval) {
550 dev_info(&radio->intf->dev,
551 "submitting int urb failed (%d)\n", retval);
552 radio->int_in_running = 0;
553 usb_autopm_put_interface(radio->intf);
554 }
555 }
556
557done:
558 mutex_unlock(&radio->lock);
559 return retval;
560}
561
562
563
564
565
566int si470x_fops_release(struct file *file)
567{
568 struct si470x_device *radio = video_drvdata(file);
569 int retval = 0;
570
571
572 if (!radio) {
573 retval = -ENODEV;
574 goto done;
575 }
576
577 mutex_lock(&radio->lock);
578 radio->users--;
579 if (radio->users == 0) {
580
581 if (radio->int_in_running) {
582 radio->int_in_running = 0;
583 if (radio->int_in_urb)
584 usb_kill_urb(radio->int_in_urb);
585 }
586
587 if (radio->disconnected) {
588 video_unregister_device(radio->videodev);
589 kfree(radio->int_in_buffer);
590 kfree(radio->buffer);
591 mutex_unlock(&radio->lock);
592 kfree(radio);
593 goto done;
594 }
595
596
597 wake_up_interruptible(&radio->read_queue);
598
599
600 retval = si470x_stop(radio);
601 usb_autopm_put_interface(radio->intf);
602 }
603 mutex_unlock(&radio->lock);
604done:
605 return retval;
606}
607
608
609
610
611
612
613
614
615
616
617int si470x_vidioc_querycap(struct file *file, void *priv,
618 struct v4l2_capability *capability)
619{
620 struct si470x_device *radio = video_drvdata(file);
621
622 strlcpy(capability->driver, DRIVER_NAME, sizeof(capability->driver));
623 strlcpy(capability->card, DRIVER_CARD, sizeof(capability->card));
624 usb_make_path(radio->usbdev, capability->bus_info,
625 sizeof(capability->bus_info));
626 capability->capabilities = V4L2_CAP_HW_FREQ_SEEK |
627 V4L2_CAP_TUNER | V4L2_CAP_RADIO | V4L2_CAP_RDS_CAPTURE;
628
629 return 0;
630}
631
632
633
634
635
636
637
638
639
640
641static int si470x_usb_driver_probe(struct usb_interface *intf,
642 const struct usb_device_id *id)
643{
644 struct si470x_device *radio;
645 struct usb_host_interface *iface_desc;
646 struct usb_endpoint_descriptor *endpoint;
647 int i, int_end_size, retval = 0;
648 unsigned char version_warning = 0;
649
650
651 radio = kzalloc(sizeof(struct si470x_device), GFP_KERNEL);
652 if (!radio) {
653 retval = -ENOMEM;
654 goto err_initial;
655 }
656 radio->users = 0;
657 radio->disconnected = 0;
658 radio->usbdev = interface_to_usbdev(intf);
659 radio->intf = intf;
660 mutex_init(&radio->lock);
661
662 iface_desc = intf->cur_altsetting;
663
664
665 for (i = 0; i < iface_desc->desc.bNumEndpoints; ++i) {
666 endpoint = &iface_desc->endpoint[i].desc;
667 if (((endpoint->bEndpointAddress & USB_ENDPOINT_DIR_MASK) ==
668 USB_DIR_IN) && ((endpoint->bmAttributes &
669 USB_ENDPOINT_XFERTYPE_MASK) == USB_ENDPOINT_XFER_INT))
670 radio->int_in_endpoint = endpoint;
671 }
672 if (!radio->int_in_endpoint) {
673 dev_info(&intf->dev, "could not find interrupt in endpoint\n");
674 retval = -EIO;
675 goto err_radio;
676 }
677
678 int_end_size = le16_to_cpu(radio->int_in_endpoint->wMaxPacketSize);
679
680 radio->int_in_buffer = kmalloc(int_end_size, GFP_KERNEL);
681 if (!radio->int_in_buffer) {
682 dev_info(&intf->dev, "could not allocate int_in_buffer");
683 retval = -ENOMEM;
684 goto err_radio;
685 }
686
687 radio->int_in_urb = usb_alloc_urb(0, GFP_KERNEL);
688 if (!radio->int_in_urb) {
689 dev_info(&intf->dev, "could not allocate int_in_urb");
690 retval = -ENOMEM;
691 goto err_intbuffer;
692 }
693
694
695 radio->videodev = video_device_alloc();
696 if (!radio->videodev) {
697 retval = -ENOMEM;
698 goto err_urb;
699 }
700 memcpy(radio->videodev, &si470x_viddev_template,
701 sizeof(si470x_viddev_template));
702 video_set_drvdata(radio->videodev, radio);
703
704
705 if (si470x_get_all_registers(radio) < 0) {
706 retval = -EIO;
707 goto err_video;
708 }
709 dev_info(&intf->dev, "DeviceID=0x%4.4hx ChipID=0x%4.4hx\n",
710 radio->registers[DEVICEID], radio->registers[CHIPID]);
711 if ((radio->registers[CHIPID] & CHIPID_FIRMWARE) < RADIO_FW_VERSION) {
712 dev_warn(&intf->dev,
713 "This driver is known to work with "
714 "firmware version %hu,\n", RADIO_FW_VERSION);
715 dev_warn(&intf->dev,
716 "but the device has firmware version %hu.\n",
717 radio->registers[CHIPID] & CHIPID_FIRMWARE);
718 version_warning = 1;
719 }
720
721
722 if (si470x_get_scratch_page_versions(radio) < 0) {
723 retval = -EIO;
724 goto err_video;
725 }
726 dev_info(&intf->dev, "software version %d, hardware version %d\n",
727 radio->software_version, radio->hardware_version);
728 if (radio->software_version < RADIO_SW_VERSION) {
729 dev_warn(&intf->dev,
730 "This driver is known to work with "
731 "software version %hu,\n", RADIO_SW_VERSION);
732 dev_warn(&intf->dev,
733 "but the device has software version %hu.\n",
734 radio->software_version);
735 version_warning = 1;
736 }
737 if (radio->hardware_version < RADIO_HW_VERSION) {
738 dev_warn(&intf->dev,
739 "This driver is known to work with "
740 "hardware version %hu,\n", RADIO_HW_VERSION);
741 dev_warn(&intf->dev,
742 "but the device has hardware version %hu.\n",
743 radio->hardware_version);
744 version_warning = 1;
745 }
746
747
748 if (version_warning == 1) {
749 dev_warn(&intf->dev,
750 "If you have some trouble using this driver,\n");
751 dev_warn(&intf->dev,
752 "please report to V4L ML at "
753 "linux-media@vger.kernel.org\n");
754 }
755
756
757 si470x_set_freq(radio, 87.5 * FREQ_MUL);
758
759
760 si470x_set_led_state(radio, BLINK_GREEN_LED);
761
762
763 radio->buf_size = rds_buf * 3;
764 radio->buffer = kmalloc(radio->buf_size, GFP_KERNEL);
765 if (!radio->buffer) {
766 retval = -EIO;
767 goto err_video;
768 }
769
770
771 radio->wr_index = 0;
772 radio->rd_index = 0;
773 init_waitqueue_head(&radio->read_queue);
774
775
776 retval = video_register_device(radio->videodev, VFL_TYPE_RADIO,
777 radio_nr);
778 if (retval) {
779 dev_warn(&intf->dev, "Could not register video device\n");
780 goto err_all;
781 }
782 usb_set_intfdata(intf, radio);
783
784 return 0;
785err_all:
786 kfree(radio->buffer);
787err_video:
788 video_device_release(radio->videodev);
789err_urb:
790 usb_free_urb(radio->int_in_urb);
791err_intbuffer:
792 kfree(radio->int_in_buffer);
793err_radio:
794 kfree(radio);
795err_initial:
796 return retval;
797}
798
799
800
801
802
803static int si470x_usb_driver_suspend(struct usb_interface *intf,
804 pm_message_t message)
805{
806 dev_info(&intf->dev, "suspending now...\n");
807
808 return 0;
809}
810
811
812
813
814
815static int si470x_usb_driver_resume(struct usb_interface *intf)
816{
817 dev_info(&intf->dev, "resuming now...\n");
818
819 return 0;
820}
821
822
823
824
825
826static void si470x_usb_driver_disconnect(struct usb_interface *intf)
827{
828 struct si470x_device *radio = usb_get_intfdata(intf);
829
830 mutex_lock(&radio->lock);
831 radio->disconnected = 1;
832 usb_set_intfdata(intf, NULL);
833 if (radio->users == 0) {
834
835 si470x_set_led_state(radio, BLINK_ORANGE_LED);
836
837
838 usb_free_urb(radio->int_in_urb);
839
840 kfree(radio->int_in_buffer);
841 video_unregister_device(radio->videodev);
842 kfree(radio->buffer);
843 mutex_unlock(&radio->lock);
844 kfree(radio);
845 } else {
846 mutex_unlock(&radio->lock);
847 }
848}
849
850
851
852
853
854static struct usb_driver si470x_usb_driver = {
855 .name = DRIVER_NAME,
856 .probe = si470x_usb_driver_probe,
857 .disconnect = si470x_usb_driver_disconnect,
858 .suspend = si470x_usb_driver_suspend,
859 .resume = si470x_usb_driver_resume,
860 .id_table = si470x_usb_driver_id_table,
861 .supports_autosuspend = 1,
862};
863
864
865
866
867
868
869
870
871
872
873static int __init si470x_module_init(void)
874{
875 printk(KERN_INFO DRIVER_DESC ", Version " DRIVER_VERSION "\n");
876 return usb_register(&si470x_usb_driver);
877}
878
879
880
881
882
883static void __exit si470x_module_exit(void)
884{
885 usb_deregister(&si470x_usb_driver);
886}
887
888
889module_init(si470x_module_init);
890module_exit(si470x_module_exit);
891
892MODULE_LICENSE("GPL");
893MODULE_AUTHOR(DRIVER_AUTHOR);
894MODULE_DESCRIPTION(DRIVER_DESC);
895MODULE_VERSION(DRIVER_VERSION);
896