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 	/* Axentia ALERT FM USB Receiver */
55 	{ USB_DEVICE_AND_INTERFACE_INFO(0x12cf, 0x7111, USB_CLASS_HID, 0, 0) },
56 	/* Terminating entry */
57 	{ }
58 };
59 MODULE_DEVICE_TABLE(usb, si470x_usb_driver_id_table);
60 
61 
62 
63 /**************************************************************************
64  * Module Parameters
65  **************************************************************************/
66 
67 /* Radio Nr */
68 static int radio_nr = -1;
69 module_param(radio_nr, int, 0444);
70 MODULE_PARM_DESC(radio_nr, "Radio Nr");
71 
72 /* USB timeout */
73 static unsigned int usb_timeout = 500;
74 module_param(usb_timeout, uint, 0644);
75 MODULE_PARM_DESC(usb_timeout, "USB timeout (ms): *500*");
76 
77 /* RDS buffer blocks */
78 static unsigned int rds_buf = 100;
79 module_param(rds_buf, uint, 0444);
80 MODULE_PARM_DESC(rds_buf, "RDS buffer entries: *100*");
81 
82 /* RDS maximum block errors */
83 static unsigned short max_rds_errors = 1;
84 /* 0 means   0  errors requiring correction */
85 /* 1 means 1-2  errors requiring correction (used by original USBRadio.exe) */
86 /* 2 means 3-5  errors requiring correction */
87 /* 3 means   6+ errors or errors in checkword, correction not possible */
88 module_param(max_rds_errors, ushort, 0644);
89 MODULE_PARM_DESC(max_rds_errors, "RDS maximum block errors: *1*");
90 
91 
92 
93 /**************************************************************************
94  * USB HID Reports
95  **************************************************************************/
96 
97 /* Reports 1-16 give direct read/write access to the 16 Si470x registers */
98 /* with the (REPORT_ID - 1) corresponding to the register address across USB */
99 /* endpoint 0 using GET_REPORT and SET_REPORT */
100 #define REGISTER_REPORT_SIZE	(RADIO_REGISTER_SIZE + 1)
101 #define REGISTER_REPORT(reg)	((reg) + 1)
102 
103 /* Report 17 gives direct read/write access to the entire Si470x register */
104 /* map across endpoint 0 using GET_REPORT and SET_REPORT */
105 #define ENTIRE_REPORT_SIZE	(RADIO_REGISTER_NUM * RADIO_REGISTER_SIZE + 1)
106 #define ENTIRE_REPORT		17
107 
108 /* Report 18 is used to send the lowest 6 Si470x registers up the HID */
109 /* interrupt endpoint 1 to Windows every 20 milliseconds for status */
110 #define RDS_REPORT_SIZE		(RDS_REGISTER_NUM * RADIO_REGISTER_SIZE + 1)
111 #define RDS_REPORT		18
112 
113 /* Report 19: LED state */
114 #define LED_REPORT_SIZE		3
115 #define LED_REPORT		19
116 
117 /* Report 19: stream */
118 #define STREAM_REPORT_SIZE	3
119 #define STREAM_REPORT		19
120 
121 /* Report 20: scratch */
122 #define SCRATCH_PAGE_SIZE	63
123 #define SCRATCH_REPORT_SIZE	(SCRATCH_PAGE_SIZE + 1)
124 #define SCRATCH_REPORT		20
125 
126 /* Reports 19-22: flash upgrade of the C8051F321 */
127 #define WRITE_REPORT_SIZE	4
128 #define WRITE_REPORT		19
129 #define FLASH_REPORT_SIZE	64
130 #define FLASH_REPORT		20
131 #define CRC_REPORT_SIZE		3
132 #define CRC_REPORT		21
133 #define RESPONSE_REPORT_SIZE	2
134 #define RESPONSE_REPORT		22
135 
136 /* Report 23: currently unused, but can accept 60 byte reports on the HID */
137 /* interrupt out endpoint 2 every 1 millisecond */
138 #define UNUSED_REPORT		23
139 
140 #define MAX_REPORT_SIZE		64
141 
142 
143 
144 /**************************************************************************
145  * Software/Hardware Versions from Scratch Page
146  **************************************************************************/
147 #define RADIO_HW_VERSION			1
148 
149 
150 
151 /**************************************************************************
152  * LED State Definitions
153  **************************************************************************/
154 #define LED_COMMAND		0x35
155 
156 #define NO_CHANGE_LED		0x00
157 #define ALL_COLOR_LED		0x01	/* streaming state */
158 #define BLINK_GREEN_LED		0x02	/* connect state */
159 #define BLINK_RED_LED		0x04
160 #define BLINK_ORANGE_LED	0x10	/* disconnect state */
161 #define SOLID_GREEN_LED		0x20	/* tuning/seeking state */
162 #define SOLID_RED_LED		0x40	/* bootload state */
163 #define SOLID_ORANGE_LED	0x80
164 
165 
166 
167 /**************************************************************************
168  * Stream State Definitions
169  **************************************************************************/
170 #define STREAM_COMMAND	0x36
171 #define STREAM_VIDPID	0x00
172 #define STREAM_AUDIO	0xff
173 
174 
175 
176 /**************************************************************************
177  * Bootloader / Flash Commands
178  **************************************************************************/
179 
180 /* unique id sent to bootloader and required to put into a bootload state */
181 #define UNIQUE_BL_ID		0x34
182 
183 /* mask for the flash data */
184 #define FLASH_DATA_MASK		0x55
185 
186 /* bootloader commands */
187 #define GET_SW_VERSION_COMMAND	0x00
188 #define SET_PAGE_COMMAND	0x01
189 #define ERASE_PAGE_COMMAND	0x02
190 #define WRITE_PAGE_COMMAND	0x03
191 #define CRC_ON_PAGE_COMMAND	0x04
192 #define READ_FLASH_BYTE_COMMAND	0x05
193 #define RESET_DEVICE_COMMAND	0x06
194 #define GET_HW_VERSION_COMMAND	0x07
195 #define BLANK			0xff
196 
197 /* bootloader command responses */
198 #define COMMAND_OK		0x01
199 #define COMMAND_FAILED		0x02
200 #define COMMAND_PENDING		0x03
201 
202 
203 
204 /**************************************************************************
205  * General Driver Functions - REGISTER_REPORTs
206  **************************************************************************/
207 
208 /*
209  * si470x_get_report - receive a HID report
210  */
211 static int si470x_get_report(struct si470x_device *radio, void *buf, int size)
212 {
213 	unsigned char *report = buf;
214 	int retval;
215 
216 	retval = usb_control_msg(radio->usbdev,
217 		usb_rcvctrlpipe(radio->usbdev, 0),
218 		HID_REQ_GET_REPORT,
219 		USB_TYPE_CLASS | USB_RECIP_INTERFACE | USB_DIR_IN,
220 		report[0], 2,
221 		buf, size, usb_timeout);
222 
223 	if (retval < 0)
224 		dev_warn(&radio->intf->dev,
225 			"si470x_get_report: usb_control_msg returned %d\n",
226 			retval);
227 	return retval;
228 }
229 
230 
231 /*
232  * si470x_set_report - send a HID report
233  */
234 static int si470x_set_report(struct si470x_device *radio, void *buf, int size)
235 {
236 	unsigned char *report = buf;
237 	int retval;
238 
239 	retval = usb_control_msg(radio->usbdev,
240 		usb_sndctrlpipe(radio->usbdev, 0),
241 		HID_REQ_SET_REPORT,
242 		USB_TYPE_CLASS | USB_RECIP_INTERFACE | USB_DIR_OUT,
243 		report[0], 2,
244 		buf, size, usb_timeout);
245 
246 	if (retval < 0)
247 		dev_warn(&radio->intf->dev,
248 			"si470x_set_report: usb_control_msg returned %d\n",
249 			retval);
250 	return retval;
251 }
252 
253 
254 /*
255  * si470x_get_register - read register
256  */
257 int si470x_get_register(struct si470x_device *radio, int regnr)
258 {
259 	int retval;
260 
261 	radio->usb_buf[0] = REGISTER_REPORT(regnr);
262 
263 	retval = si470x_get_report(radio, radio->usb_buf, REGISTER_REPORT_SIZE);
264 
265 	if (retval >= 0)
266 		radio->registers[regnr] = get_unaligned_be16(&radio->usb_buf[1]);
267 
268 	return (retval < 0) ? -EINVAL : 0;
269 }
270 
271 
272 /*
273  * si470x_set_register - write register
274  */
275 int si470x_set_register(struct si470x_device *radio, int regnr)
276 {
277 	int retval;
278 
279 	radio->usb_buf[0] = REGISTER_REPORT(regnr);
280 	put_unaligned_be16(radio->registers[regnr], &radio->usb_buf[1]);
281 
282 	retval = si470x_set_report(radio, radio->usb_buf, REGISTER_REPORT_SIZE);
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  */
296 static int si470x_get_all_registers(struct si470x_device *radio)
297 {
298 	int retval;
299 	unsigned char regnr;
300 
301 	radio->usb_buf[0] = ENTIRE_REPORT;
302 
303 	retval = si470x_get_report(radio, radio->usb_buf, ENTIRE_REPORT_SIZE);
304 
305 	if (retval >= 0)
306 		for (regnr = 0; regnr < RADIO_REGISTER_NUM; regnr++)
307 			radio->registers[regnr] = get_unaligned_be16(
308 				&radio->usb_buf[regnr * RADIO_REGISTER_SIZE + 1]);
309 
310 	return (retval < 0) ? -EINVAL : 0;
311 }
312 
313 
314 
315 /**************************************************************************
316  * General Driver Functions - LED_REPORT
317  **************************************************************************/
318 
319 /*
320  * si470x_set_led_state - sets the led state
321  */
322 static int si470x_set_led_state(struct si470x_device *radio,
323 		unsigned char led_state)
324 {
325 	int retval;
326 
327 	radio->usb_buf[0] = LED_REPORT;
328 	radio->usb_buf[1] = LED_COMMAND;
329 	radio->usb_buf[2] = led_state;
330 
331 	retval = si470x_set_report(radio, radio->usb_buf, LED_REPORT_SIZE);
332 
333 	return (retval < 0) ? -EINVAL : 0;
334 }
335 
336 
337 
338 /**************************************************************************
339  * General Driver Functions - SCRATCH_REPORT
340  **************************************************************************/
341 
342 /*
343  * si470x_get_scratch_versions - gets the scratch page and version infos
344  */
345 static int si470x_get_scratch_page_versions(struct si470x_device *radio)
346 {
347 	int retval;
348 
349 	radio->usb_buf[0] = SCRATCH_REPORT;
350 
351 	retval = si470x_get_report(radio, radio->usb_buf, SCRATCH_REPORT_SIZE);
352 
353 	if (retval < 0)
354 		dev_warn(&radio->intf->dev, "si470x_get_scratch: "
355 			"si470x_get_report returned %d\n", retval);
356 	else {
357 		radio->software_version = radio->usb_buf[1];
358 		radio->hardware_version = radio->usb_buf[2];
359 	}
360 
361 	return (retval < 0) ? -EINVAL : 0;
362 }
363 
364 
365 
366 /**************************************************************************
367  * RDS Driver Functions
368  **************************************************************************/
369 
370 /*
371  * si470x_int_in_callback - rds callback and processing function
372  *
373  * TODO: do we need to use mutex locks in some sections?
374  */
375 static void si470x_int_in_callback(struct urb *urb)
376 {
377 	struct si470x_device *radio = urb->context;
378 	int retval;
379 	unsigned char regnr;
380 	unsigned char blocknum;
381 	unsigned short bler; /* rds block errors */
382 	unsigned short rds;
383 	unsigned char tmpbuf[3];
384 
385 	if (urb->status) {
386 		if (urb->status == -ENOENT ||
387 				urb->status == -ECONNRESET ||
388 				urb->status == -ESHUTDOWN) {
389 			return;
390 		} else {
391 			dev_warn(&radio->intf->dev,
392 			 "non-zero urb status (%d)\n", urb->status);
393 			goto resubmit; /* Maybe we can recover. */
394 		}
395 	}
396 
397 	/* Sometimes the device returns len 0 packets */
398 	if (urb->actual_length != RDS_REPORT_SIZE)
399 		goto resubmit;
400 
401 	radio->registers[STATUSRSSI] =
402 		get_unaligned_be16(&radio->int_in_buffer[1]);
403 
404 	if (radio->registers[STATUSRSSI] & STATUSRSSI_STC)
405 		complete(&radio->completion);
406 
407 	if ((radio->registers[SYSCONFIG1] & SYSCONFIG1_RDS)) {
408 		/* Update RDS registers with URB data */
409 		for (regnr = 1; regnr < RDS_REGISTER_NUM; regnr++)
410 			radio->registers[STATUSRSSI + regnr] =
411 			    get_unaligned_be16(&radio->int_in_buffer[
412 				regnr * RADIO_REGISTER_SIZE + 1]);
413 		/* get rds blocks */
414 		if ((radio->registers[STATUSRSSI] & STATUSRSSI_RDSR) == 0) {
415 			/* No RDS group ready, better luck next time */
416 			goto resubmit;
417 		}
418 		if ((radio->registers[STATUSRSSI] & STATUSRSSI_RDSS) == 0) {
419 			/* RDS decoder not synchronized */
420 			goto resubmit;
421 		}
422 		for (blocknum = 0; blocknum < 4; blocknum++) {
423 			switch (blocknum) {
424 			default:
425 				bler = (radio->registers[STATUSRSSI] &
426 						STATUSRSSI_BLERA) >> 9;
427 				rds = radio->registers[RDSA];
428 				break;
429 			case 1:
430 				bler = (radio->registers[READCHAN] &
431 						READCHAN_BLERB) >> 14;
432 				rds = radio->registers[RDSB];
433 				break;
434 			case 2:
435 				bler = (radio->registers[READCHAN] &
436 						READCHAN_BLERC) >> 12;
437 				rds = radio->registers[RDSC];
438 				break;
439 			case 3:
440 				bler = (radio->registers[READCHAN] &
441 						READCHAN_BLERD) >> 10;
442 				rds = radio->registers[RDSD];
443 				break;
444 			}
445 
446 			/* Fill the V4L2 RDS buffer */
447 			put_unaligned_le16(rds, &tmpbuf);
448 			tmpbuf[2] = blocknum;		/* offset name */
449 			tmpbuf[2] |= blocknum << 3;	/* received offset */
450 			if (bler > max_rds_errors)
451 				tmpbuf[2] |= 0x80; /* uncorrectable errors */
452 			else if (bler > 0)
453 				tmpbuf[2] |= 0x40; /* corrected error(s) */
454 
455 			/* copy RDS block to internal buffer */
456 			memcpy(&radio->buffer[radio->wr_index], &tmpbuf, 3);
457 			radio->wr_index += 3;
458 
459 			/* wrap write pointer */
460 			if (radio->wr_index >= radio->buf_size)
461 				radio->wr_index = 0;
462 
463 			/* check for overflow */
464 			if (radio->wr_index == radio->rd_index) {
465 				/* increment and wrap read pointer */
466 				radio->rd_index += 3;
467 				if (radio->rd_index >= radio->buf_size)
468 					radio->rd_index = 0;
469 			}
470 		}
471 		if (radio->wr_index != radio->rd_index)
472 			wake_up_interruptible(&radio->read_queue);
473 	}
474 
475 resubmit:
476 	/* Resubmit if we're still running. */
477 	if (radio->int_in_running && radio->usbdev) {
478 		retval = usb_submit_urb(radio->int_in_urb, GFP_ATOMIC);
479 		if (retval) {
480 			dev_warn(&radio->intf->dev,
481 			       "resubmitting urb failed (%d)", retval);
482 			radio->int_in_running = 0;
483 		}
484 	}
485 	radio->status_rssi_auto_update = radio->int_in_running;
486 }
487 
488 
489 int si470x_fops_open(struct file *file)
490 {
491 	return v4l2_fh_open(file);
492 }
493 
494 int si470x_fops_release(struct file *file)
495 {
496 	return v4l2_fh_release(file);
497 }
498 
499 static void si470x_usb_release(struct v4l2_device *v4l2_dev)
500 {
501 	struct si470x_device *radio =
502 		container_of(v4l2_dev, struct si470x_device, v4l2_dev);
503 
504 	usb_free_urb(radio->int_in_urb);
505 	v4l2_ctrl_handler_free(&radio->hdl);
506 	v4l2_device_unregister(&radio->v4l2_dev);
507 	kfree(radio->int_in_buffer);
508 	kfree(radio->buffer);
509 	kfree(radio->usb_buf);
510 	kfree(radio);
511 }
512 
513 
514 /**************************************************************************
515  * Video4Linux Interface
516  **************************************************************************/
517 
518 /*
519  * si470x_vidioc_querycap - query device capabilities
520  */
521 int si470x_vidioc_querycap(struct file *file, void *priv,
522 		struct v4l2_capability *capability)
523 {
524 	struct si470x_device *radio = video_drvdata(file);
525 
526 	strlcpy(capability->driver, DRIVER_NAME, sizeof(capability->driver));
527 	strlcpy(capability->card, DRIVER_CARD, sizeof(capability->card));
528 	usb_make_path(radio->usbdev, capability->bus_info,
529 			sizeof(capability->bus_info));
530 	capability->device_caps = V4L2_CAP_HW_FREQ_SEEK | V4L2_CAP_READWRITE |
531 		V4L2_CAP_TUNER | V4L2_CAP_RADIO | V4L2_CAP_RDS_CAPTURE;
532 	capability->capabilities = capability->device_caps | V4L2_CAP_DEVICE_CAPS;
533 	return 0;
534 }
535 
536 
537 static int si470x_start_usb(struct si470x_device *radio)
538 {
539 	int retval;
540 
541 	/* initialize interrupt urb */
542 	usb_fill_int_urb(radio->int_in_urb, radio->usbdev,
543 			usb_rcvintpipe(radio->usbdev,
544 				radio->int_in_endpoint->bEndpointAddress),
545 			radio->int_in_buffer,
546 			le16_to_cpu(radio->int_in_endpoint->wMaxPacketSize),
547 			si470x_int_in_callback,
548 			radio,
549 			radio->int_in_endpoint->bInterval);
550 
551 	radio->int_in_running = 1;
552 	mb();
553 
554 	retval = usb_submit_urb(radio->int_in_urb, GFP_KERNEL);
555 	if (retval) {
556 		dev_info(&radio->intf->dev,
557 				"submitting int urb failed (%d)\n", retval);
558 		radio->int_in_running = 0;
559 	}
560 	radio->status_rssi_auto_update = radio->int_in_running;
561 
562 	/* start radio */
563 	retval = si470x_start(radio);
564 	if (retval < 0)
565 		return retval;
566 
567 	v4l2_ctrl_handler_setup(&radio->hdl);
568 
569 	return retval;
570 }
571 
572 /**************************************************************************
573  * USB Interface
574  **************************************************************************/
575 
576 /*
577  * si470x_usb_driver_probe - probe for the device
578  */
579 static int si470x_usb_driver_probe(struct usb_interface *intf,
580 		const struct usb_device_id *id)
581 {
582 	struct si470x_device *radio;
583 	struct usb_host_interface *iface_desc;
584 	struct usb_endpoint_descriptor *endpoint;
585 	int i, int_end_size, retval = 0;
586 	unsigned char version_warning = 0;
587 
588 	/* private data allocation and initialization */
589 	radio = kzalloc(sizeof(struct si470x_device), GFP_KERNEL);
590 	if (!radio) {
591 		retval = -ENOMEM;
592 		goto err_initial;
593 	}
594 	radio->usb_buf = kmalloc(MAX_REPORT_SIZE, GFP_KERNEL);
595 	if (radio->usb_buf == NULL) {
596 		retval = -ENOMEM;
597 		goto err_radio;
598 	}
599 	radio->usbdev = interface_to_usbdev(intf);
600 	radio->intf = intf;
601 	radio->band = 1; /* Default to 76 - 108 MHz */
602 	mutex_init(&radio->lock);
603 	init_completion(&radio->completion);
604 
605 	iface_desc = intf->cur_altsetting;
606 
607 	/* Set up interrupt endpoint information. */
608 	for (i = 0; i < iface_desc->desc.bNumEndpoints; ++i) {
609 		endpoint = &iface_desc->endpoint[i].desc;
610 		if (((endpoint->bEndpointAddress & USB_ENDPOINT_DIR_MASK) ==
611 		 USB_DIR_IN) && ((endpoint->bmAttributes &
612 		 USB_ENDPOINT_XFERTYPE_MASK) == USB_ENDPOINT_XFER_INT))
613 			radio->int_in_endpoint = endpoint;
614 	}
615 	if (!radio->int_in_endpoint) {
616 		dev_info(&intf->dev, "could not find interrupt in endpoint\n");
617 		retval = -EIO;
618 		goto err_usbbuf;
619 	}
620 
621 	int_end_size = le16_to_cpu(radio->int_in_endpoint->wMaxPacketSize);
622 
623 	radio->int_in_buffer = kmalloc(int_end_size, GFP_KERNEL);
624 	if (!radio->int_in_buffer) {
625 		dev_info(&intf->dev, "could not allocate int_in_buffer");
626 		retval = -ENOMEM;
627 		goto err_usbbuf;
628 	}
629 
630 	radio->int_in_urb = usb_alloc_urb(0, GFP_KERNEL);
631 	if (!radio->int_in_urb) {
632 		dev_info(&intf->dev, "could not allocate int_in_urb");
633 		retval = -ENOMEM;
634 		goto err_intbuffer;
635 	}
636 
637 	radio->v4l2_dev.release = si470x_usb_release;
638 
639 	/*
640 	 * The si470x SiLabs reference design uses the same USB IDs as
641 	 * 'Thanko's Raremono' si4734 based receiver. So check here which we
642 	 * have: attempt to read the device ID from the si470x: the lower 12
643 	 * bits should be 0x0242 for the si470x.
644 	 *
645 	 * We use this check to determine which device we are dealing with.
646 	 */
647 	if (id->idVendor == 0x10c4 && id->idProduct == 0x818a) {
648 		retval = usb_control_msg(radio->usbdev,
649 				usb_rcvctrlpipe(radio->usbdev, 0),
650 				HID_REQ_GET_REPORT,
651 				USB_TYPE_CLASS | USB_RECIP_INTERFACE | USB_DIR_IN,
652 				1, 2,
653 				radio->usb_buf, 3, 500);
654 		if (retval != 3 ||
655 		    (get_unaligned_be16(&radio->usb_buf[1]) & 0xfff) != 0x0242) {
656 			dev_info(&intf->dev, "this is not a si470x device.\n");
657 			retval = -ENODEV;
658 			goto err_urb;
659 		}
660 	}
661 
662 	retval = v4l2_device_register(&intf->dev, &radio->v4l2_dev);
663 	if (retval < 0) {
664 		dev_err(&intf->dev, "couldn't register v4l2_device\n");
665 		goto err_urb;
666 	}
667 
668 	v4l2_ctrl_handler_init(&radio->hdl, 2);
669 	v4l2_ctrl_new_std(&radio->hdl, &si470x_ctrl_ops,
670 			  V4L2_CID_AUDIO_MUTE, 0, 1, 1, 1);
671 	v4l2_ctrl_new_std(&radio->hdl, &si470x_ctrl_ops,
672 			  V4L2_CID_AUDIO_VOLUME, 0, 15, 1, 15);
673 	if (radio->hdl.error) {
674 		retval = radio->hdl.error;
675 		dev_err(&intf->dev, "couldn't register control\n");
676 		goto err_dev;
677 	}
678 	radio->videodev = si470x_viddev_template;
679 	radio->videodev.ctrl_handler = &radio->hdl;
680 	radio->videodev.lock = &radio->lock;
681 	radio->videodev.v4l2_dev = &radio->v4l2_dev;
682 	radio->videodev.release = video_device_release_empty;
683 	set_bit(V4L2_FL_USE_FH_PRIO, &radio->videodev.flags);
684 	video_set_drvdata(&radio->videodev, radio);
685 
686 	/* get device and chip versions */
687 	if (si470x_get_all_registers(radio) < 0) {
688 		retval = -EIO;
689 		goto err_ctrl;
690 	}
691 	dev_info(&intf->dev, "DeviceID=0x%4.4hx ChipID=0x%4.4hx\n",
692 			radio->registers[DEVICEID], radio->registers[CHIPID]);
693 	if ((radio->registers[CHIPID] & CHIPID_FIRMWARE) < RADIO_FW_VERSION) {
694 		dev_warn(&intf->dev,
695 			"This driver is known to work with "
696 			"firmware version %hu,\n", RADIO_FW_VERSION);
697 		dev_warn(&intf->dev,
698 			"but the device has firmware version %hu.\n",
699 			radio->registers[CHIPID] & CHIPID_FIRMWARE);
700 		version_warning = 1;
701 	}
702 
703 	/* get software and hardware versions */
704 	if (si470x_get_scratch_page_versions(radio) < 0) {
705 		retval = -EIO;
706 		goto err_ctrl;
707 	}
708 	dev_info(&intf->dev, "software version %d, hardware version %d\n",
709 			radio->software_version, radio->hardware_version);
710 	if (radio->hardware_version < RADIO_HW_VERSION) {
711 		dev_warn(&intf->dev,
712 			"This driver is known to work with "
713 			"hardware version %hu,\n", RADIO_HW_VERSION);
714 		dev_warn(&intf->dev,
715 			"but the device has hardware version %hu.\n",
716 			radio->hardware_version);
717 		version_warning = 1;
718 	}
719 
720 	/* give out version warning */
721 	if (version_warning == 1) {
722 		dev_warn(&intf->dev,
723 			"If you have some trouble using this driver,\n");
724 		dev_warn(&intf->dev,
725 			"please report to V4L ML at "
726 			"linux-media@vger.kernel.org\n");
727 	}
728 
729 	/* set led to connect state */
730 	si470x_set_led_state(radio, BLINK_GREEN_LED);
731 
732 	/* rds buffer allocation */
733 	radio->buf_size = rds_buf * 3;
734 	radio->buffer = kmalloc(radio->buf_size, GFP_KERNEL);
735 	if (!radio->buffer) {
736 		retval = -EIO;
737 		goto err_ctrl;
738 	}
739 
740 	/* rds buffer configuration */
741 	radio->wr_index = 0;
742 	radio->rd_index = 0;
743 	init_waitqueue_head(&radio->read_queue);
744 	usb_set_intfdata(intf, radio);
745 
746 	/* start radio */
747 	retval = si470x_start_usb(radio);
748 	if (retval < 0)
749 		goto err_all;
750 
751 	/* set initial frequency */
752 	si470x_set_freq(radio, 87.5 * FREQ_MUL); /* available in all regions */
753 
754 	/* register video device */
755 	retval = video_register_device(&radio->videodev, VFL_TYPE_RADIO,
756 			radio_nr);
757 	if (retval) {
758 		dev_err(&intf->dev, "Could not register video device\n");
759 		goto err_all;
760 	}
761 
762 	return 0;
763 err_all:
764 	kfree(radio->buffer);
765 err_ctrl:
766 	v4l2_ctrl_handler_free(&radio->hdl);
767 err_dev:
768 	v4l2_device_unregister(&radio->v4l2_dev);
769 err_urb:
770 	usb_free_urb(radio->int_in_urb);
771 err_intbuffer:
772 	kfree(radio->int_in_buffer);
773 err_usbbuf:
774 	kfree(radio->usb_buf);
775 err_radio:
776 	kfree(radio);
777 err_initial:
778 	return retval;
779 }
780 
781 
782 /*
783  * si470x_usb_driver_suspend - suspend the device
784  */
785 static int si470x_usb_driver_suspend(struct usb_interface *intf,
786 		pm_message_t message)
787 {
788 	struct si470x_device *radio = usb_get_intfdata(intf);
789 
790 	dev_info(&intf->dev, "suspending now...\n");
791 
792 	/* shutdown interrupt handler */
793 	if (radio->int_in_running) {
794 		radio->int_in_running = 0;
795 		if (radio->int_in_urb)
796 			usb_kill_urb(radio->int_in_urb);
797 	}
798 
799 	/* cancel read processes */
800 	wake_up_interruptible(&radio->read_queue);
801 
802 	/* stop radio */
803 	si470x_stop(radio);
804 	return 0;
805 }
806 
807 
808 /*
809  * si470x_usb_driver_resume - resume the device
810  */
811 static int si470x_usb_driver_resume(struct usb_interface *intf)
812 {
813 	struct si470x_device *radio = usb_get_intfdata(intf);
814 	int ret;
815 
816 	dev_info(&intf->dev, "resuming now...\n");
817 
818 	/* start radio */
819 	ret = si470x_start_usb(radio);
820 	if (ret == 0)
821 		v4l2_ctrl_handler_setup(&radio->hdl);
822 
823 	return ret;
824 }
825 
826 
827 /*
828  * si470x_usb_driver_disconnect - disconnect the device
829  */
830 static void si470x_usb_driver_disconnect(struct usb_interface *intf)
831 {
832 	struct si470x_device *radio = usb_get_intfdata(intf);
833 
834 	mutex_lock(&radio->lock);
835 	v4l2_device_disconnect(&radio->v4l2_dev);
836 	video_unregister_device(&radio->videodev);
837 	usb_set_intfdata(intf, NULL);
838 	mutex_unlock(&radio->lock);
839 	v4l2_device_put(&radio->v4l2_dev);
840 }
841 
842 
843 /*
844  * si470x_usb_driver - usb driver interface
845  *
846  * A note on suspend/resume: this driver had only empty suspend/resume
847  * functions, and when I tried to test suspend/resume it always disconnected
848  * instead of resuming (using my ADS InstantFM stick). So I've decided to
849  * remove these callbacks until someone else with better hardware can
850  * implement and test this.
851  */
852 static struct usb_driver si470x_usb_driver = {
853 	.name			= DRIVER_NAME,
854 	.probe			= si470x_usb_driver_probe,
855 	.disconnect		= si470x_usb_driver_disconnect,
856 	.suspend		= si470x_usb_driver_suspend,
857 	.resume			= si470x_usb_driver_resume,
858 	.reset_resume		= si470x_usb_driver_resume,
859 	.id_table		= si470x_usb_driver_id_table,
860 };
861 
862 module_usb_driver(si470x_usb_driver);
863 
864 MODULE_LICENSE("GPL");
865 MODULE_AUTHOR(DRIVER_AUTHOR);
866 MODULE_DESCRIPTION(DRIVER_DESC);
867 MODULE_VERSION(DRIVER_VERSION);
868