1 /*
2  *  drivers/media/radio/si470x/radio-si470x-usb.c
3  *
4  *  USB driver for radios with Silicon Labs Si470x FM Radio Receivers
5  *
6  *  Copyright (c) 2009 Tobias Lorenz <tobias.lorenz@gmx.net>
7  *
8  * This program is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License as published by
10  * the Free Software Foundation; either version 2 of the License, or
11  * (at your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, write to the Free Software
20  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
21  */
22 
23 
24 /*
25  * ToDo:
26  * - add firmware download/update support
27  */
28 
29 
30 /* driver definitions */
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 /* kernel includes */
37 #include <linux/usb.h>
38 #include <linux/hid.h>
39 #include <linux/slab.h>
40 
41 #include "radio-si470x.h"
42 
43 
44 /* USB Device ID List */
45 static struct usb_device_id si470x_usb_driver_id_table[] = {
46 	/* Silicon Labs USB FM Radio Reference Design */
47 	{ USB_DEVICE_AND_INTERFACE_INFO(0x10c4, 0x818a, USB_CLASS_HID, 0, 0) },
48 	/* ADS/Tech FM Radio Receiver (formerly Instant FM Music) */
49 	{ USB_DEVICE_AND_INTERFACE_INFO(0x06e1, 0xa155, USB_CLASS_HID, 0, 0) },
50 	/* KWorld USB FM Radio SnapMusic Mobile 700 (FM700) */
51 	{ USB_DEVICE_AND_INTERFACE_INFO(0x1b80, 0xd700, USB_CLASS_HID, 0, 0) },
52 	/* Sanei Electric, Inc. FM USB Radio (sold as DealExtreme.com PCear) */
53 	{ USB_DEVICE_AND_INTERFACE_INFO(0x10c5, 0x819a, USB_CLASS_HID, 0, 0) },
54 	/* Terminating entry */
55 	{ }
56 };
57 MODULE_DEVICE_TABLE(usb, si470x_usb_driver_id_table);
58 
59 
60 
61 /**************************************************************************
62  * Module Parameters
63  **************************************************************************/
64 
65 /* Radio Nr */
66 static int radio_nr = -1;
67 module_param(radio_nr, int, 0444);
68 MODULE_PARM_DESC(radio_nr, "Radio Nr");
69 
70 /* USB timeout */
71 static unsigned int usb_timeout = 500;
72 module_param(usb_timeout, uint, 0644);
73 MODULE_PARM_DESC(usb_timeout, "USB timeout (ms): *500*");
74 
75 /* RDS buffer blocks */
76 static unsigned int rds_buf = 100;
77 module_param(rds_buf, uint, 0444);
78 MODULE_PARM_DESC(rds_buf, "RDS buffer entries: *100*");
79 
80 /* RDS maximum block errors */
81 static unsigned short max_rds_errors = 1;
82 /* 0 means   0  errors requiring correction */
83 /* 1 means 1-2  errors requiring correction (used by original USBRadio.exe) */
84 /* 2 means 3-5  errors requiring correction */
85 /* 3 means   6+ errors or errors in checkword, correction not possible */
86 module_param(max_rds_errors, ushort, 0644);
87 MODULE_PARM_DESC(max_rds_errors, "RDS maximum block errors: *1*");
88 
89 
90 
91 /**************************************************************************
92  * USB HID Reports
93  **************************************************************************/
94 
95 /* Reports 1-16 give direct read/write access to the 16 Si470x registers */
96 /* with the (REPORT_ID - 1) corresponding to the register address across USB */
97 /* endpoint 0 using GET_REPORT and SET_REPORT */
98 #define REGISTER_REPORT_SIZE	(RADIO_REGISTER_SIZE + 1)
99 #define REGISTER_REPORT(reg)	((reg) + 1)
100 
101 /* Report 17 gives direct read/write access to the entire Si470x register */
102 /* map across endpoint 0 using GET_REPORT and SET_REPORT */
103 #define ENTIRE_REPORT_SIZE	(RADIO_REGISTER_NUM * RADIO_REGISTER_SIZE + 1)
104 #define ENTIRE_REPORT		17
105 
106 /* Report 18 is used to send the lowest 6 Si470x registers up the HID */
107 /* interrupt endpoint 1 to Windows every 20 milliseconds for status */
108 #define RDS_REPORT_SIZE		(RDS_REGISTER_NUM * RADIO_REGISTER_SIZE + 1)
109 #define RDS_REPORT		18
110 
111 /* Report 19: LED state */
112 #define LED_REPORT_SIZE		3
113 #define LED_REPORT		19
114 
115 /* Report 19: stream */
116 #define STREAM_REPORT_SIZE	3
117 #define STREAM_REPORT		19
118 
119 /* Report 20: scratch */
120 #define SCRATCH_PAGE_SIZE	63
121 #define SCRATCH_REPORT_SIZE	(SCRATCH_PAGE_SIZE + 1)
122 #define SCRATCH_REPORT		20
123 
124 /* Reports 19-22: flash upgrade of the C8051F321 */
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 /* Report 23: currently unused, but can accept 60 byte reports on the HID */
135 /* interrupt out endpoint 2 every 1 millisecond */
136 #define UNUSED_REPORT		23
137 
138 
139 
140 /**************************************************************************
141  * Software/Hardware Versions from Scratch Page
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  * LED State Definitions
151  **************************************************************************/
152 #define LED_COMMAND		0x35
153 
154 #define NO_CHANGE_LED		0x00
155 #define ALL_COLOR_LED		0x01	/* streaming state */
156 #define BLINK_GREEN_LED		0x02	/* connect state */
157 #define BLINK_RED_LED		0x04
158 #define BLINK_ORANGE_LED	0x10	/* disconnect state */
159 #define SOLID_GREEN_LED		0x20	/* tuning/seeking state */
160 #define SOLID_RED_LED		0x40	/* bootload state */
161 #define SOLID_ORANGE_LED	0x80
162 
163 
164 
165 /**************************************************************************
166  * Stream State Definitions
167  **************************************************************************/
168 #define STREAM_COMMAND	0x36
169 #define STREAM_VIDPID	0x00
170 #define STREAM_AUDIO	0xff
171 
172 
173 
174 /**************************************************************************
175  * Bootloader / Flash Commands
176  **************************************************************************/
177 
178 /* unique id sent to bootloader and required to put into a bootload state */
179 #define UNIQUE_BL_ID		0x34
180 
181 /* mask for the flash data */
182 #define FLASH_DATA_MASK		0x55
183 
184 /* bootloader commands */
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 /* bootloader command responses */
196 #define COMMAND_OK		0x01
197 #define COMMAND_FAILED		0x02
198 #define COMMAND_PENDING		0x03
199 
200 
201 
202 /**************************************************************************
203  * General Driver Functions - REGISTER_REPORTs
204  **************************************************************************/
205 
206 /*
207  * si470x_get_report - receive a HID report
208  */
si470x_get_report(struct si470x_device * radio,void * buf,int size)209 static 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  * si470x_set_report - send a HID report
231  */
si470x_set_report(struct si470x_device * radio,void * buf,int size)232 static 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  * si470x_get_register - read register
254  */
si470x_get_register(struct si470x_device * radio,int regnr)255 int 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  * si470x_set_register - write register
273  */
si470x_set_register(struct si470x_device * radio,int regnr)274 int 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  * General Driver Functions - ENTIRE_REPORT
291  **************************************************************************/
292 
293 /*
294  * si470x_get_all_registers - read entire registers
295  */
si470x_get_all_registers(struct si470x_device * radio)296 static 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  * General Driver Functions - LED_REPORT
318  **************************************************************************/
319 
320 /*
321  * si470x_set_led_state - sets the led state
322  */
si470x_set_led_state(struct si470x_device * radio,unsigned char led_state)323 static 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  * General Driver Functions - SCRATCH_REPORT
342  **************************************************************************/
343 
344 /*
345  * si470x_get_scratch_versions - gets the scratch page and version infos
346  */
si470x_get_scratch_page_versions(struct si470x_device * radio)347 static 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  * General Driver Functions - DISCONNECT_CHECK
371  **************************************************************************/
372 
373 /*
374  * si470x_disconnect_check - check whether radio disconnects
375  */
si470x_disconnect_check(struct si470x_device * radio)376 int 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  * RDS Driver Functions
388  **************************************************************************/
389 
390 /*
391  * si470x_int_in_callback - rds callback and processing function
392  *
393  * TODO: do we need to use mutex locks in some sections?
394  */
si470x_int_in_callback(struct urb * urb)395 static 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; /* rds block errors */
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; /* Maybe we can recover. */
414 		}
415 	}
416 
417 	/* safety checks */
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 		/* Update RDS registers with URB data */
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 		/* get rds blocks */
430 		if ((radio->registers[STATUSRSSI] & STATUSRSSI_RDSR) == 0) {
431 			/* No RDS group ready, better luck next time */
432 			goto resubmit;
433 		}
434 		if ((radio->registers[STATUSRSSI] & STATUSRSSI_RDSS) == 0) {
435 			/* RDS decoder not synchronized */
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 			/* Fill the V4L2 RDS buffer */
463 			put_unaligned_le16(rds, &tmpbuf);
464 			tmpbuf[2] = blocknum;		/* offset name */
465 			tmpbuf[2] |= blocknum << 3;	/* received offset */
466 			if (bler > max_rds_errors)
467 				tmpbuf[2] |= 0x80; /* uncorrectable errors */
468 			else if (bler > 0)
469 				tmpbuf[2] |= 0x40; /* corrected error(s) */
470 
471 			/* copy RDS block to internal buffer */
472 			memcpy(&radio->buffer[radio->wr_index], &tmpbuf, 3);
473 			radio->wr_index += 3;
474 
475 			/* wrap write pointer */
476 			if (radio->wr_index >= radio->buf_size)
477 				radio->wr_index = 0;
478 
479 			/* check for overflow */
480 			if (radio->wr_index == radio->rd_index) {
481 				/* increment and wrap read pointer */
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 
491 resubmit:
492 	/* Resubmit if we're still running. */
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  * File Operations Interface
507  **************************************************************************/
508 
509 /*
510  * si470x_fops_open - file open
511  */
si470x_fops_open(struct file * file)512 int 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 		/* start radio */
529 		retval = si470x_start(radio);
530 		if (retval < 0) {
531 			usb_autopm_put_interface(radio->intf);
532 			goto done;
533 		}
534 
535 		/* initialize interrupt urb */
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 
557 done:
558 	mutex_unlock(&radio->lock);
559 	return retval;
560 }
561 
562 
563 /*
564  * si470x_fops_release - file release
565  */
si470x_fops_release(struct file * file)566 int si470x_fops_release(struct file *file)
567 {
568 	struct si470x_device *radio = video_drvdata(file);
569 	int retval = 0;
570 
571 	/* safety check */
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 		/* shutdown interrupt handler */
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 		/* cancel read processes */
597 		wake_up_interruptible(&radio->read_queue);
598 
599 		/* stop radio */
600 		retval = si470x_stop(radio);
601 		usb_autopm_put_interface(radio->intf);
602 	}
603 	mutex_unlock(&radio->lock);
604 done:
605 	return retval;
606 }
607 
608 
609 
610 /**************************************************************************
611  * Video4Linux Interface
612  **************************************************************************/
613 
614 /*
615  * si470x_vidioc_querycap - query device capabilities
616  */
si470x_vidioc_querycap(struct file * file,void * priv,struct v4l2_capability * capability)617 int 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  * USB Interface
636  **************************************************************************/
637 
638 /*
639  * si470x_usb_driver_probe - probe for the device
640  */
si470x_usb_driver_probe(struct usb_interface * intf,const struct usb_device_id * id)641 static 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 	/* private data allocation and initialization */
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 	/* Set up interrupt endpoint information. */
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 	/* video device allocation and initialization */
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 	/* get device and chip versions */
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 	/* get software and hardware versions */
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 	/* give out version warning */
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 	/* set initial frequency */
757 	si470x_set_freq(radio, 87.5 * FREQ_MUL); /* available in all regions */
758 
759 	/* set led to connect state */
760 	si470x_set_led_state(radio, BLINK_GREEN_LED);
761 
762 	/* rds buffer allocation */
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 	/* rds buffer configuration */
771 	radio->wr_index = 0;
772 	radio->rd_index = 0;
773 	init_waitqueue_head(&radio->read_queue);
774 
775 	/* register video device */
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;
785 err_all:
786 	kfree(radio->buffer);
787 err_video:
788 	video_device_release(radio->videodev);
789 err_urb:
790 	usb_free_urb(radio->int_in_urb);
791 err_intbuffer:
792 	kfree(radio->int_in_buffer);
793 err_radio:
794 	kfree(radio);
795 err_initial:
796 	return retval;
797 }
798 
799 
800 /*
801  * si470x_usb_driver_suspend - suspend the device
802  */
si470x_usb_driver_suspend(struct usb_interface * intf,pm_message_t message)803 static 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  * si470x_usb_driver_resume - resume the device
814  */
si470x_usb_driver_resume(struct usb_interface * intf)815 static 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  * si470x_usb_driver_disconnect - disconnect the device
825  */
si470x_usb_driver_disconnect(struct usb_interface * intf)826 static 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 		/* set led to disconnect state */
835 		si470x_set_led_state(radio, BLINK_ORANGE_LED);
836 
837 		/* Free data structures. */
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  * si470x_usb_driver - usb driver interface
853  */
854 static 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 module_usb_driver(si470x_usb_driver);
865 
866 MODULE_LICENSE("GPL");
867 MODULE_AUTHOR(DRIVER_AUTHOR);
868 MODULE_DESCRIPTION(DRIVER_DESC);
869 MODULE_VERSION(DRIVER_VERSION);
870