Linux Audio

Check our new training course

Loading...
  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 */
 45static 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};
 59MODULE_DEVICE_TABLE(usb, si470x_usb_driver_id_table);
 60
 61
 62
 63/**************************************************************************
 64 * Module Parameters
 65 **************************************************************************/
 66
 67/* Radio Nr */
 68static int radio_nr = -1;
 69module_param(radio_nr, int, 0444);
 70MODULE_PARM_DESC(radio_nr, "Radio Nr");
 71
 72/* USB timeout */
 73static unsigned int usb_timeout = 500;
 74module_param(usb_timeout, uint, 0644);
 75MODULE_PARM_DESC(usb_timeout, "USB timeout (ms): *500*");
 76
 77/* RDS buffer blocks */
 78static unsigned int rds_buf = 100;
 79module_param(rds_buf, uint, 0444);
 80MODULE_PARM_DESC(rds_buf, "RDS buffer entries: *100*");
 81
 82/* RDS maximum block errors */
 83static 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 */
 88module_param(max_rds_errors, ushort, 0644);
 89MODULE_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
141
142/**************************************************************************
143 * Software/Hardware Versions from Scratch Page
144 **************************************************************************/
145#define RADIO_SW_VERSION_NOT_BOOTLOADABLE	6
146#define RADIO_SW_VERSION			7
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 */
211static int si470x_get_report(struct si470x_device *radio, void *buf, int size)
212{
213	unsigned char *report = (unsigned char *) 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 */
234static int si470x_set_report(struct si470x_device *radio, void *buf, int size)
235{
236	unsigned char *report = (unsigned char *) 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 */
257int si470x_get_register(struct si470x_device *radio, int regnr)
258{
259	unsigned char buf[REGISTER_REPORT_SIZE];
260	int retval;
261
262	buf[0] = REGISTER_REPORT(regnr);
263
264	retval = si470x_get_report(radio, (void *) &buf, sizeof(buf));
265
266	if (retval >= 0)
267		radio->registers[regnr] = get_unaligned_be16(&buf[1]);
268
269	return (retval < 0) ? -EINVAL : 0;
270}
271
272
273/*
274 * si470x_set_register - write register
275 */
276int si470x_set_register(struct si470x_device *radio, int regnr)
277{
278	unsigned char buf[REGISTER_REPORT_SIZE];
279	int retval;
280
281	buf[0] = REGISTER_REPORT(regnr);
282	put_unaligned_be16(radio->registers[regnr], &buf[1]);
283
284	retval = si470x_set_report(radio, (void *) &buf, sizeof(buf));
285
286	return (retval < 0) ? -EINVAL : 0;
287}
288
289
290
291/**************************************************************************
292 * General Driver Functions - ENTIRE_REPORT
293 **************************************************************************/
294
295/*
296 * si470x_get_all_registers - read entire registers
297 */
298static int si470x_get_all_registers(struct si470x_device *radio)
299{
300	unsigned char buf[ENTIRE_REPORT_SIZE];
301	int retval;
302	unsigned char regnr;
303
304	buf[0] = ENTIRE_REPORT;
305
306	retval = si470x_get_report(radio, (void *) &buf, sizeof(buf));
307
308	if (retval >= 0)
309		for (regnr = 0; regnr < RADIO_REGISTER_NUM; regnr++)
310			radio->registers[regnr] = get_unaligned_be16(
311				&buf[regnr * RADIO_REGISTER_SIZE + 1]);
312
313	return (retval < 0) ? -EINVAL : 0;
314}
315
316
317
318/**************************************************************************
319 * General Driver Functions - LED_REPORT
320 **************************************************************************/
321
322/*
323 * si470x_set_led_state - sets the led state
324 */
325static int si470x_set_led_state(struct si470x_device *radio,
326		unsigned char led_state)
327{
328	unsigned char buf[LED_REPORT_SIZE];
329	int retval;
330
331	buf[0] = LED_REPORT;
332	buf[1] = LED_COMMAND;
333	buf[2] = led_state;
334
335	retval = si470x_set_report(radio, (void *) &buf, sizeof(buf));
336
337	return (retval < 0) ? -EINVAL : 0;
338}
339
340
341
342/**************************************************************************
343 * General Driver Functions - SCRATCH_REPORT
344 **************************************************************************/
345
346/*
347 * si470x_get_scratch_versions - gets the scratch page and version infos
348 */
349static int si470x_get_scratch_page_versions(struct si470x_device *radio)
350{
351	unsigned char buf[SCRATCH_REPORT_SIZE];
352	int retval;
353
354	buf[0] = SCRATCH_REPORT;
355
356	retval = si470x_get_report(radio, (void *) &buf, sizeof(buf));
357
358	if (retval < 0)
359		dev_warn(&radio->intf->dev, "si470x_get_scratch: "
360			"si470x_get_report returned %d\n", retval);
361	else {
362		radio->software_version = buf[1];
363		radio->hardware_version = buf[2];
364	}
365
366	return (retval < 0) ? -EINVAL : 0;
367}
368
369
370
371/**************************************************************************
372 * RDS Driver Functions
373 **************************************************************************/
374
375/*
376 * si470x_int_in_callback - rds callback and processing function
377 *
378 * TODO: do we need to use mutex locks in some sections?
379 */
380static void si470x_int_in_callback(struct urb *urb)
381{
382	struct si470x_device *radio = urb->context;
383	int retval;
384	unsigned char regnr;
385	unsigned char blocknum;
386	unsigned short bler; /* rds block errors */
387	unsigned short rds;
388	unsigned char tmpbuf[3];
389
390	if (urb->status) {
391		if (urb->status == -ENOENT ||
392				urb->status == -ECONNRESET ||
393				urb->status == -ESHUTDOWN) {
394			return;
395		} else {
396			dev_warn(&radio->intf->dev,
397			 "non-zero urb status (%d)\n", urb->status);
398			goto resubmit; /* Maybe we can recover. */
399		}
400	}
401
402	if ((radio->registers[SYSCONFIG1] & SYSCONFIG1_RDS) == 0)
403		goto resubmit;
404
405	if (urb->actual_length > 0) {
406		/* Update RDS registers with URB data */
407		for (regnr = 0; regnr < RDS_REGISTER_NUM; regnr++)
408			radio->registers[STATUSRSSI + regnr] =
409			    get_unaligned_be16(&radio->int_in_buffer[
410				regnr * RADIO_REGISTER_SIZE + 1]);
411		/* get rds blocks */
412		if ((radio->registers[STATUSRSSI] & STATUSRSSI_RDSR) == 0) {
413			/* No RDS group ready, better luck next time */
414			goto resubmit;
415		}
416		if ((radio->registers[STATUSRSSI] & STATUSRSSI_RDSS) == 0) {
417			/* RDS decoder not synchronized */
418			goto resubmit;
419		}
420		for (blocknum = 0; blocknum < 4; blocknum++) {
421			switch (blocknum) {
422			default:
423				bler = (radio->registers[STATUSRSSI] &
424						STATUSRSSI_BLERA) >> 9;
425				rds = radio->registers[RDSA];
426				break;
427			case 1:
428				bler = (radio->registers[READCHAN] &
429						READCHAN_BLERB) >> 14;
430				rds = radio->registers[RDSB];
431				break;
432			case 2:
433				bler = (radio->registers[READCHAN] &
434						READCHAN_BLERC) >> 12;
435				rds = radio->registers[RDSC];
436				break;
437			case 3:
438				bler = (radio->registers[READCHAN] &
439						READCHAN_BLERD) >> 10;
440				rds = radio->registers[RDSD];
441				break;
442			};
443
444			/* Fill the V4L2 RDS buffer */
445			put_unaligned_le16(rds, &tmpbuf);
446			tmpbuf[2] = blocknum;		/* offset name */
447			tmpbuf[2] |= blocknum << 3;	/* received offset */
448			if (bler > max_rds_errors)
449				tmpbuf[2] |= 0x80; /* uncorrectable errors */
450			else if (bler > 0)
451				tmpbuf[2] |= 0x40; /* corrected error(s) */
452
453			/* copy RDS block to internal buffer */
454			memcpy(&radio->buffer[radio->wr_index], &tmpbuf, 3);
455			radio->wr_index += 3;
456
457			/* wrap write pointer */
458			if (radio->wr_index >= radio->buf_size)
459				radio->wr_index = 0;
460
461			/* check for overflow */
462			if (radio->wr_index == radio->rd_index) {
463				/* increment and wrap read pointer */
464				radio->rd_index += 3;
465				if (radio->rd_index >= radio->buf_size)
466					radio->rd_index = 0;
467			}
468		}
469		if (radio->wr_index != radio->rd_index)
470			wake_up_interruptible(&radio->read_queue);
471	}
472
473resubmit:
474	/* Resubmit if we're still running. */
475	if (radio->int_in_running && radio->usbdev) {
476		retval = usb_submit_urb(radio->int_in_urb, GFP_ATOMIC);
477		if (retval) {
478			dev_warn(&radio->intf->dev,
479			       "resubmitting urb failed (%d)", retval);
480			radio->int_in_running = 0;
481		}
482	}
483}
484
485
486int si470x_fops_open(struct file *file)
487{
488	return v4l2_fh_open(file);
489}
490
491int si470x_fops_release(struct file *file)
492{
493	return v4l2_fh_release(file);
494}
495
496static void si470x_usb_release(struct v4l2_device *v4l2_dev)
497{
498	struct si470x_device *radio =
499		container_of(v4l2_dev, struct si470x_device, v4l2_dev);
500
501	usb_free_urb(radio->int_in_urb);
502	v4l2_ctrl_handler_free(&radio->hdl);
503	v4l2_device_unregister(&radio->v4l2_dev);
504	kfree(radio->int_in_buffer);
505	kfree(radio->buffer);
506	kfree(radio);
507}
508
509
510/**************************************************************************
511 * Video4Linux Interface
512 **************************************************************************/
513
514/*
515 * si470x_vidioc_querycap - query device capabilities
516 */
517int si470x_vidioc_querycap(struct file *file, void *priv,
518		struct v4l2_capability *capability)
519{
520	struct si470x_device *radio = video_drvdata(file);
521
522	strlcpy(capability->driver, DRIVER_NAME, sizeof(capability->driver));
523	strlcpy(capability->card, DRIVER_CARD, sizeof(capability->card));
524	usb_make_path(radio->usbdev, capability->bus_info,
525			sizeof(capability->bus_info));
526	capability->device_caps = V4L2_CAP_HW_FREQ_SEEK |
527		V4L2_CAP_TUNER | V4L2_CAP_RADIO | V4L2_CAP_RDS_CAPTURE;
528	capability->capabilities = capability->device_caps | V4L2_CAP_DEVICE_CAPS;
529	return 0;
530}
531
532
533static int si470x_start_usb(struct si470x_device *radio)
534{
535	int retval;
536
537	/* start radio */
538	retval = si470x_start(radio);
539	if (retval < 0)
540		return retval;
541
542	v4l2_ctrl_handler_setup(&radio->hdl);
543
544	/* initialize interrupt urb */
545	usb_fill_int_urb(radio->int_in_urb, radio->usbdev,
546			usb_rcvintpipe(radio->usbdev,
547				radio->int_in_endpoint->bEndpointAddress),
548			radio->int_in_buffer,
549			le16_to_cpu(radio->int_in_endpoint->wMaxPacketSize),
550			si470x_int_in_callback,
551			radio,
552			radio->int_in_endpoint->bInterval);
553
554	radio->int_in_running = 1;
555	mb();
556
557	retval = usb_submit_urb(radio->int_in_urb, GFP_KERNEL);
558	if (retval) {
559		dev_info(&radio->intf->dev,
560				"submitting int urb failed (%d)\n", retval);
561		radio->int_in_running = 0;
562	}
563	return retval;
564}
565
566/**************************************************************************
567 * USB Interface
568 **************************************************************************/
569
570/*
571 * si470x_usb_driver_probe - probe for the device
572 */
573static int si470x_usb_driver_probe(struct usb_interface *intf,
574		const struct usb_device_id *id)
575{
576	struct si470x_device *radio;
577	struct usb_host_interface *iface_desc;
578	struct usb_endpoint_descriptor *endpoint;
579	int i, int_end_size, retval = 0;
580	unsigned char version_warning = 0;
581
582	/* private data allocation and initialization */
583	radio = kzalloc(sizeof(struct si470x_device), GFP_KERNEL);
584	if (!radio) {
585		retval = -ENOMEM;
586		goto err_initial;
587	}
588	radio->usbdev = interface_to_usbdev(intf);
589	radio->intf = intf;
590	mutex_init(&radio->lock);
591
592	iface_desc = intf->cur_altsetting;
593
594	/* Set up interrupt endpoint information. */
595	for (i = 0; i < iface_desc->desc.bNumEndpoints; ++i) {
596		endpoint = &iface_desc->endpoint[i].desc;
597		if (((endpoint->bEndpointAddress & USB_ENDPOINT_DIR_MASK) ==
598		 USB_DIR_IN) && ((endpoint->bmAttributes &
599		 USB_ENDPOINT_XFERTYPE_MASK) == USB_ENDPOINT_XFER_INT))
600			radio->int_in_endpoint = endpoint;
601	}
602	if (!radio->int_in_endpoint) {
603		dev_info(&intf->dev, "could not find interrupt in endpoint\n");
604		retval = -EIO;
605		goto err_radio;
606	}
607
608	int_end_size = le16_to_cpu(radio->int_in_endpoint->wMaxPacketSize);
609
610	radio->int_in_buffer = kmalloc(int_end_size, GFP_KERNEL);
611	if (!radio->int_in_buffer) {
612		dev_info(&intf->dev, "could not allocate int_in_buffer");
613		retval = -ENOMEM;
614		goto err_radio;
615	}
616
617	radio->int_in_urb = usb_alloc_urb(0, GFP_KERNEL);
618	if (!radio->int_in_urb) {
619		dev_info(&intf->dev, "could not allocate int_in_urb");
620		retval = -ENOMEM;
621		goto err_intbuffer;
622	}
623
624	radio->v4l2_dev.release = si470x_usb_release;
625	retval = v4l2_device_register(&intf->dev, &radio->v4l2_dev);
626	if (retval < 0) {
627		dev_err(&intf->dev, "couldn't register v4l2_device\n");
628		goto err_urb;
629	}
630
631	v4l2_ctrl_handler_init(&radio->hdl, 2);
632	v4l2_ctrl_new_std(&radio->hdl, &si470x_ctrl_ops,
633			  V4L2_CID_AUDIO_MUTE, 0, 1, 1, 1);
634	v4l2_ctrl_new_std(&radio->hdl, &si470x_ctrl_ops,
635			  V4L2_CID_AUDIO_VOLUME, 0, 15, 1, 15);
636	if (radio->hdl.error) {
637		retval = radio->hdl.error;
638		dev_err(&intf->dev, "couldn't register control\n");
639		goto err_dev;
640	}
641	radio->videodev = si470x_viddev_template;
642	radio->videodev.ctrl_handler = &radio->hdl;
643	radio->videodev.lock = &radio->lock;
644	radio->videodev.v4l2_dev = &radio->v4l2_dev;
645	radio->videodev.release = video_device_release_empty;
646	set_bit(V4L2_FL_USE_FH_PRIO, &radio->videodev.flags);
647	video_set_drvdata(&radio->videodev, radio);
648
649	/* get device and chip versions */
650	if (si470x_get_all_registers(radio) < 0) {
651		retval = -EIO;
652		goto err_ctrl;
653	}
654	dev_info(&intf->dev, "DeviceID=0x%4.4hx ChipID=0x%4.4hx\n",
655			radio->registers[DEVICEID], radio->registers[CHIPID]);
656	if ((radio->registers[CHIPID] & CHIPID_FIRMWARE) < RADIO_FW_VERSION) {
657		dev_warn(&intf->dev,
658			"This driver is known to work with "
659			"firmware version %hu,\n", RADIO_FW_VERSION);
660		dev_warn(&intf->dev,
661			"but the device has firmware version %hu.\n",
662			radio->registers[CHIPID] & CHIPID_FIRMWARE);
663		version_warning = 1;
664	}
665
666	/* get software and hardware versions */
667	if (si470x_get_scratch_page_versions(radio) < 0) {
668		retval = -EIO;
669		goto err_ctrl;
670	}
671	dev_info(&intf->dev, "software version %d, hardware version %d\n",
672			radio->software_version, radio->hardware_version);
673	if (radio->software_version < RADIO_SW_VERSION) {
674		dev_warn(&intf->dev,
675			"This driver is known to work with "
676			"software version %hu,\n", RADIO_SW_VERSION);
677		dev_warn(&intf->dev,
678			"but the device has software version %hu.\n",
679			radio->software_version);
680		version_warning = 1;
681	}
682	if (radio->hardware_version < RADIO_HW_VERSION) {
683		dev_warn(&intf->dev,
684			"This driver is known to work with "
685			"hardware version %hu,\n", RADIO_HW_VERSION);
686		dev_warn(&intf->dev,
687			"but the device has hardware version %hu.\n",
688			radio->hardware_version);
689		version_warning = 1;
690	}
691
692	/* give out version warning */
693	if (version_warning == 1) {
694		dev_warn(&intf->dev,
695			"If you have some trouble using this driver,\n");
696		dev_warn(&intf->dev,
697			"please report to V4L ML at "
698			"linux-media@vger.kernel.org\n");
699	}
700
701	/* set initial frequency */
702	si470x_set_freq(radio, 87.5 * FREQ_MUL); /* available in all regions */
703
704	/* set led to connect state */
705	si470x_set_led_state(radio, BLINK_GREEN_LED);
706
707	/* rds buffer allocation */
708	radio->buf_size = rds_buf * 3;
709	radio->buffer = kmalloc(radio->buf_size, GFP_KERNEL);
710	if (!radio->buffer) {
711		retval = -EIO;
712		goto err_ctrl;
713	}
714
715	/* rds buffer configuration */
716	radio->wr_index = 0;
717	radio->rd_index = 0;
718	init_waitqueue_head(&radio->read_queue);
719	usb_set_intfdata(intf, radio);
720
721	/* start radio */
722	retval = si470x_start_usb(radio);
723	if (retval < 0)
724		goto err_all;
725
726	/* register video device */
727	retval = video_register_device(&radio->videodev, VFL_TYPE_RADIO,
728			radio_nr);
729	if (retval) {
730		dev_err(&intf->dev, "Could not register video device\n");
731		goto err_all;
732	}
733
734	return 0;
735err_all:
736	kfree(radio->buffer);
737err_ctrl:
738	v4l2_ctrl_handler_free(&radio->hdl);
739err_dev:
740	v4l2_device_unregister(&radio->v4l2_dev);
741err_urb:
742	usb_free_urb(radio->int_in_urb);
743err_intbuffer:
744	kfree(radio->int_in_buffer);
745err_radio:
746	kfree(radio);
747err_initial:
748	return retval;
749}
750
751
752/*
753 * si470x_usb_driver_suspend - suspend the device
754 */
755static int si470x_usb_driver_suspend(struct usb_interface *intf,
756		pm_message_t message)
757{
758	struct si470x_device *radio = usb_get_intfdata(intf);
759
760	dev_info(&intf->dev, "suspending now...\n");
761
762	/* shutdown interrupt handler */
763	if (radio->int_in_running) {
764		radio->int_in_running = 0;
765		if (radio->int_in_urb)
766			usb_kill_urb(radio->int_in_urb);
767	}
768
769	/* cancel read processes */
770	wake_up_interruptible(&radio->read_queue);
771
772	/* stop radio */
773	si470x_stop(radio);
774	return 0;
775}
776
777
778/*
779 * si470x_usb_driver_resume - resume the device
780 */
781static int si470x_usb_driver_resume(struct usb_interface *intf)
782{
783	struct si470x_device *radio = usb_get_intfdata(intf);
784
785	dev_info(&intf->dev, "resuming now...\n");
786
787	/* start radio */
788	return si470x_start_usb(radio);
789}
790
791
792/*
793 * si470x_usb_driver_disconnect - disconnect the device
794 */
795static void si470x_usb_driver_disconnect(struct usb_interface *intf)
796{
797	struct si470x_device *radio = usb_get_intfdata(intf);
798
799	mutex_lock(&radio->lock);
800	v4l2_device_disconnect(&radio->v4l2_dev);
801	video_unregister_device(&radio->videodev);
802	usb_set_intfdata(intf, NULL);
803	mutex_unlock(&radio->lock);
804	v4l2_device_put(&radio->v4l2_dev);
805}
806
807
808/*
809 * si470x_usb_driver - usb driver interface
810 *
811 * A note on suspend/resume: this driver had only empty suspend/resume
812 * functions, and when I tried to test suspend/resume it always disconnected
813 * instead of resuming (using my ADS InstantFM stick). So I've decided to
814 * remove these callbacks until someone else with better hardware can
815 * implement and test this.
816 */
817static struct usb_driver si470x_usb_driver = {
818	.name			= DRIVER_NAME,
819	.probe			= si470x_usb_driver_probe,
820	.disconnect		= si470x_usb_driver_disconnect,
821	.suspend		= si470x_usb_driver_suspend,
822	.resume			= si470x_usb_driver_resume,
823	.reset_resume		= si470x_usb_driver_resume,
824	.id_table		= si470x_usb_driver_id_table,
825};
826
827module_usb_driver(si470x_usb_driver);
828
829MODULE_LICENSE("GPL");
830MODULE_AUTHOR(DRIVER_AUTHOR);
831MODULE_DESCRIPTION(DRIVER_DESC);
832MODULE_VERSION(DRIVER_VERSION);