2 * drivers/media/radio/si470x/radio-si470x-common.c
4 * Driver for radios with Silicon Labs Si470x FM Radio Receivers
6 * Copyright (c) 2009 Tobias Lorenz <tobias.lorenz@gmx.net>
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.
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.
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
26 * 2008-01-12 Tobias Lorenz <tobias.lorenz@gmx.net>
28 * - First working version
29 * 2008-01-13 Tobias Lorenz <tobias.lorenz@gmx.net>
31 * - Improved error handling, every function now returns errno
32 * - Improved multi user access (start/mute/stop)
33 * - Channel doesn't get lost anymore after start/mute/stop
34 * - RDS support added (polling mode via interrupt EP 1)
35 * - marked default module parameters with *value*
36 * - switched from bit structs to bit masks
37 * - header file cleaned and integrated
38 * 2008-01-14 Tobias Lorenz <tobias.lorenz@gmx.net>
40 * - hex values are now lower case
41 * - commented USB ID for ADS/Tech moved on todo list
42 * - blacklisted si470x in hid-quirks.c
43 * - rds buffer handling functions integrated into *_work, *_read
44 * - rds_command in si470x_poll exchanged against simple retval
45 * - check for firmware version 15
46 * - code order and prototypes still remain the same
47 * - spacing and bottom of band codes remain the same
48 * 2008-01-16 Tobias Lorenz <tobias.lorenz@gmx.net>
50 * - code reordered to avoid function prototypes
51 * - switch/case defaults are now more user-friendly
52 * - unified comment style
53 * - applied all checkpatch.pl v1.12 suggestions
54 * except the warning about the too long lines with bit comments
55 * - renamed FMRADIO to RADIO to cut line length (checkpatch.pl)
56 * 2008-01-22 Tobias Lorenz <tobias.lorenz@gmx.net>
58 * - avoid poss. locking when doing copy_to_user which may sleep
59 * - RDS is automatically activated on read now
60 * - code cleaned of unnecessary rds_commands
61 * - USB Vendor/Product ID for ADS/Tech FM Radio Receiver verified
62 * (thanks to Guillaume RAMOUSSE)
63 * 2008-01-27 Tobias Lorenz <tobias.lorenz@gmx.net>
65 * - number of seek_retries changed to tune_timeout
66 * - fixed problem with incomplete tune operations by own buffers
67 * - optimization of variables and printf types
68 * - improved error logging
69 * 2008-01-31 Tobias Lorenz <tobias.lorenz@gmx.net>
70 * Oliver Neukum <oliver@neukum.org>
72 * - fixed coverity checker warnings in *_usb_driver_disconnect
73 * - probe()/open() race by correct ordering in probe()
74 * - DMA coherency rules by separate allocation of all buffers
75 * - use of endianness macros
76 * - abuse of spinlock, replaced by mutex
77 * - racy handling of timer in disconnect,
78 * replaced by delayed_work
79 * - racy interruptible_sleep_on(),
80 * replaced with wait_event_interruptible()
81 * - handle signals in read()
82 * 2008-02-08 Tobias Lorenz <tobias.lorenz@gmx.net>
83 * Oliver Neukum <oliver@neukum.org>
85 * - usb autosuspend support
87 * 2008-05-07 Tobias Lorenz <tobias.lorenz@gmx.net>
89 * - hardware frequency seek support
91 * - more safety checks, let si470x_get_freq return errno
92 * - vidioc behavior corrected according to v4l2 spec
93 * 2008-10-20 Alexey Klimov <klimov.linux@gmail.com>
94 * - add support for KWorld USB FM Radio FM700
95 * - blacklisted KWorld radio in hid-core.c and hid-ids.h
96 * 2008-12-03 Mark Lord <mlord@pobox.com>
97 * - add support for DealExtreme USB Radio
98 * 2009-01-31 Bob Ross <pigiron@gmx.com>
99 * - correction of stereo detection/setting
100 * - correction of signal strength indicator scaling
101 * 2009-01-31 Rick Bronson <rick@efn.org>
102 * Tobias Lorenz <tobias.lorenz@gmx.net>
103 * - add LED status output
104 * - get HW/SW version from scratchpad
105 * 2009-06-16 Edouard Lafargue <edouard@lafargue.name>
107 * - add support for interrupt mode for RDS endpoint,
108 * instead of polling.
109 * Improves RDS reception significantly
113 /* kernel includes */
114 #include "radio-si470x.h"
118 /**************************************************************************
120 **************************************************************************/
123 /* 0: 200 kHz (USA, Australia) */
124 /* 1: 100 kHz (Europe, Japan) */
126 static unsigned short space = 2;
127 module_param(space, ushort, 0444);
128 MODULE_PARM_DESC(space, "Spacing: 0=200kHz 1=100kHz *2=50kHz*");
130 /* Bottom of Band (MHz) */
131 /* 0: 87.5 - 108 MHz (USA, Europe)*/
132 /* 1: 76 - 108 MHz (Japan wide band) */
133 /* 2: 76 - 90 MHz (Japan) */
134 static unsigned short band = 1;
135 module_param(band, ushort, 0444);
136 MODULE_PARM_DESC(band, "Band: 0=87.5..108MHz *1=76..108MHz* 2=76..90MHz");
140 /* 1: 50 us (Europe, Australia, Japan) */
141 static unsigned short de = 1;
142 module_param(de, ushort, 0444);
143 MODULE_PARM_DESC(de, "De-emphasis: 0=75us *1=50us*");
146 static unsigned int tune_timeout = 3000;
147 module_param(tune_timeout, uint, 0644);
148 MODULE_PARM_DESC(tune_timeout, "Tune timeout: *3000*");
151 static unsigned int seek_timeout = 5000;
152 module_param(seek_timeout, uint, 0644);
153 MODULE_PARM_DESC(seek_timeout, "Seek timeout: *5000*");
157 /**************************************************************************
159 **************************************************************************/
162 * si470x_set_chan - set the channel
164 static int si470x_set_chan(struct si470x_device *radio, unsigned short chan)
170 radio->registers[CHANNEL] &= ~CHANNEL_CHAN;
171 radio->registers[CHANNEL] |= CHANNEL_TUNE | chan;
172 retval = si470x_set_register(radio, CHANNEL);
176 /* wait till tune operation has completed */
177 INIT_COMPLETION(radio->completion);
178 retval = wait_for_completion_timeout(&radio->completion,
179 msecs_to_jiffies(tune_timeout));
183 if ((radio->registers[STATUSRSSI] & STATUSRSSI_STC) == 0)
184 dev_warn(&radio->videodev.dev, "tune does not complete\n");
186 dev_warn(&radio->videodev.dev,
187 "tune timed out after %u ms\n", tune_timeout);
190 radio->registers[CHANNEL] &= ~CHANNEL_TUNE;
191 retval = si470x_set_register(radio, CHANNEL);
199 * si470x_get_freq - get the frequency
201 static int si470x_get_freq(struct si470x_device *radio, unsigned int *freq)
203 unsigned int spacing, band_bottom;
208 switch ((radio->registers[SYSCONFIG2] & SYSCONFIG2_SPACE) >> 4) {
209 /* 0: 200 kHz (USA, Australia) */
211 spacing = 0.200 * FREQ_MUL; break;
212 /* 1: 100 kHz (Europe, Japan) */
214 spacing = 0.100 * FREQ_MUL; break;
217 spacing = 0.050 * FREQ_MUL; break;
220 /* Bottom of Band (MHz) */
221 switch ((radio->registers[SYSCONFIG2] & SYSCONFIG2_BAND) >> 6) {
222 /* 0: 87.5 - 108 MHz (USA, Europe) */
224 band_bottom = 87.5 * FREQ_MUL; break;
225 /* 1: 76 - 108 MHz (Japan wide band) */
227 band_bottom = 76 * FREQ_MUL; break;
228 /* 2: 76 - 90 MHz (Japan) */
230 band_bottom = 76 * FREQ_MUL; break;
234 retval = si470x_get_register(radio, READCHAN);
235 chan = radio->registers[READCHAN] & READCHAN_READCHAN;
237 /* Frequency (MHz) = Spacing (kHz) x Channel + Bottom of Band (MHz) */
238 *freq = chan * spacing + band_bottom;
245 * si470x_set_freq - set the frequency
247 int si470x_set_freq(struct si470x_device *radio, unsigned int freq)
249 unsigned int spacing, band_bottom, band_top;
253 switch ((radio->registers[SYSCONFIG2] & SYSCONFIG2_SPACE) >> 4) {
254 /* 0: 200 kHz (USA, Australia) */
256 spacing = 0.200 * FREQ_MUL; break;
257 /* 1: 100 kHz (Europe, Japan) */
259 spacing = 0.100 * FREQ_MUL; break;
262 spacing = 0.050 * FREQ_MUL; break;
265 /* Bottom/Top of Band (MHz) */
266 switch ((radio->registers[SYSCONFIG2] & SYSCONFIG2_BAND) >> 6) {
267 /* 0: 87.5 - 108 MHz (USA, Europe) */
269 band_bottom = 87.5 * FREQ_MUL;
270 band_top = 108 * FREQ_MUL;
272 /* 1: 76 - 108 MHz (Japan wide band) */
274 band_bottom = 76 * FREQ_MUL;
275 band_top = 108 * FREQ_MUL;
277 /* 2: 76 - 90 MHz (Japan) */
279 band_bottom = 76 * FREQ_MUL;
280 band_top = 90 * FREQ_MUL;
284 freq = clamp(freq, band_bottom, band_top);
285 /* Chan = [ Freq (Mhz) - Bottom of Band (MHz) ] / Spacing (kHz) */
286 chan = (freq - band_bottom) / spacing;
288 return si470x_set_chan(radio, chan);
293 * si470x_set_seek - set seek
295 static int si470x_set_seek(struct si470x_device *radio,
296 unsigned int wrap_around, unsigned int seek_upward)
302 radio->registers[POWERCFG] |= POWERCFG_SEEK;
303 if (wrap_around == 1)
304 radio->registers[POWERCFG] &= ~POWERCFG_SKMODE;
306 radio->registers[POWERCFG] |= POWERCFG_SKMODE;
307 if (seek_upward == 1)
308 radio->registers[POWERCFG] |= POWERCFG_SEEKUP;
310 radio->registers[POWERCFG] &= ~POWERCFG_SEEKUP;
311 retval = si470x_set_register(radio, POWERCFG);
315 /* wait till tune operation has completed */
316 INIT_COMPLETION(radio->completion);
317 retval = wait_for_completion_timeout(&radio->completion,
318 msecs_to_jiffies(seek_timeout));
322 if ((radio->registers[STATUSRSSI] & STATUSRSSI_STC) == 0)
323 dev_warn(&radio->videodev.dev, "seek does not complete\n");
324 if (radio->registers[STATUSRSSI] & STATUSRSSI_SF)
325 dev_warn(&radio->videodev.dev,
326 "seek failed / band limit reached\n");
329 radio->registers[POWERCFG] &= ~POWERCFG_SEEK;
330 retval = si470x_set_register(radio, POWERCFG);
332 /* try again, if timed out */
333 if (retval == 0 && timed_out)
340 * si470x_start - switch on radio
342 int si470x_start(struct si470x_device *radio)
347 radio->registers[POWERCFG] =
348 POWERCFG_DMUTE | POWERCFG_ENABLE | POWERCFG_RDSM;
349 retval = si470x_set_register(radio, POWERCFG);
354 radio->registers[SYSCONFIG1] =
355 (de << 11) & SYSCONFIG1_DE; /* DE*/
356 retval = si470x_set_register(radio, SYSCONFIG1);
361 radio->registers[SYSCONFIG2] =
362 (0x1f << 8) | /* SEEKTH */
363 ((band << 6) & SYSCONFIG2_BAND) | /* BAND */
364 ((space << 4) & SYSCONFIG2_SPACE) | /* SPACE */
365 15; /* VOLUME (max) */
366 retval = si470x_set_register(radio, SYSCONFIG2);
370 /* reset last channel */
371 retval = si470x_set_chan(radio,
372 radio->registers[CHANNEL] & CHANNEL_CHAN);
380 * si470x_stop - switch off radio
382 int si470x_stop(struct si470x_device *radio)
387 radio->registers[SYSCONFIG1] &= ~SYSCONFIG1_RDS;
388 retval = si470x_set_register(radio, SYSCONFIG1);
393 radio->registers[POWERCFG] &= ~POWERCFG_DMUTE;
394 /* POWERCFG_ENABLE has to automatically go low */
395 radio->registers[POWERCFG] |= POWERCFG_ENABLE | POWERCFG_DISABLE;
396 retval = si470x_set_register(radio, POWERCFG);
404 * si470x_rds_on - switch on rds reception
406 static int si470x_rds_on(struct si470x_device *radio)
411 radio->registers[SYSCONFIG1] |= SYSCONFIG1_RDS;
412 retval = si470x_set_register(radio, SYSCONFIG1);
414 radio->registers[SYSCONFIG1] &= ~SYSCONFIG1_RDS;
421 /**************************************************************************
422 * File Operations Interface
423 **************************************************************************/
426 * si470x_fops_read - read RDS data
428 static ssize_t si470x_fops_read(struct file *file, char __user *buf,
429 size_t count, loff_t *ppos)
431 struct si470x_device *radio = video_drvdata(file);
433 unsigned int block_count = 0;
435 /* switch on rds reception */
436 if ((radio->registers[SYSCONFIG1] & SYSCONFIG1_RDS) == 0)
437 si470x_rds_on(radio);
439 /* block if no new data available */
440 while (radio->wr_index == radio->rd_index) {
441 if (file->f_flags & O_NONBLOCK) {
442 retval = -EWOULDBLOCK;
445 if (wait_event_interruptible(radio->read_queue,
446 radio->wr_index != radio->rd_index) < 0) {
452 /* calculate block count from byte count */
455 /* copy RDS block out of internal buffer and to user buffer */
456 while (block_count < count) {
457 if (radio->rd_index == radio->wr_index)
460 /* always transfer rds complete blocks */
461 if (copy_to_user(buf, &radio->buffer[radio->rd_index], 3))
462 /* retval = -EFAULT; */
465 /* increment and wrap read pointer */
466 radio->rd_index += 3;
467 if (radio->rd_index >= radio->buf_size)
470 /* increment counters */
482 * si470x_fops_poll - poll RDS data
484 static unsigned int si470x_fops_poll(struct file *file,
485 struct poll_table_struct *pts)
487 struct si470x_device *radio = video_drvdata(file);
488 unsigned long req_events = poll_requested_events(pts);
489 int retval = v4l2_ctrl_poll(file, pts);
491 if (req_events & (POLLIN | POLLRDNORM)) {
492 /* switch on rds reception */
493 if ((radio->registers[SYSCONFIG1] & SYSCONFIG1_RDS) == 0)
494 si470x_rds_on(radio);
496 poll_wait(file, &radio->read_queue, pts);
498 if (radio->rd_index != radio->wr_index)
499 retval |= POLLIN | POLLRDNORM;
507 * si470x_fops - file operations interface
509 static const struct v4l2_file_operations si470x_fops = {
510 .owner = THIS_MODULE,
511 .read = si470x_fops_read,
512 .poll = si470x_fops_poll,
513 .unlocked_ioctl = video_ioctl2,
514 .open = si470x_fops_open,
515 .release = si470x_fops_release,
520 /**************************************************************************
521 * Video4Linux Interface
522 **************************************************************************/
525 static int si470x_s_ctrl(struct v4l2_ctrl *ctrl)
527 struct si470x_device *radio =
528 container_of(ctrl->handler, struct si470x_device, hdl);
531 case V4L2_CID_AUDIO_VOLUME:
532 radio->registers[SYSCONFIG2] &= ~SYSCONFIG2_VOLUME;
533 radio->registers[SYSCONFIG2] |= ctrl->val;
534 return si470x_set_register(radio, SYSCONFIG2);
535 case V4L2_CID_AUDIO_MUTE:
537 radio->registers[POWERCFG] &= ~POWERCFG_DMUTE;
539 radio->registers[POWERCFG] |= POWERCFG_DMUTE;
540 return si470x_set_register(radio, POWERCFG);
548 * si470x_vidioc_g_tuner - get tuner attributes
550 static int si470x_vidioc_g_tuner(struct file *file, void *priv,
551 struct v4l2_tuner *tuner)
553 struct si470x_device *radio = video_drvdata(file);
556 if (tuner->index != 0)
559 if (!radio->status_rssi_auto_update) {
560 retval = si470x_get_register(radio, STATUSRSSI);
565 /* driver constants */
566 strcpy(tuner->name, "FM");
567 tuner->type = V4L2_TUNER_RADIO;
568 tuner->capability = V4L2_TUNER_CAP_LOW | V4L2_TUNER_CAP_STEREO |
569 V4L2_TUNER_CAP_RDS | V4L2_TUNER_CAP_RDS_BLOCK_IO |
570 V4L2_TUNER_CAP_HWSEEK_BOUNDED |
571 V4L2_TUNER_CAP_HWSEEK_WRAP;
574 switch ((radio->registers[SYSCONFIG2] & SYSCONFIG2_BAND) >> 6) {
575 /* 0: 87.5 - 108 MHz (USA, Europe, default) */
577 tuner->rangelow = 87.5 * FREQ_MUL;
578 tuner->rangehigh = 108 * FREQ_MUL;
580 /* 1: 76 - 108 MHz (Japan wide band) */
582 tuner->rangelow = 76 * FREQ_MUL;
583 tuner->rangehigh = 108 * FREQ_MUL;
585 /* 2: 76 - 90 MHz (Japan) */
587 tuner->rangelow = 76 * FREQ_MUL;
588 tuner->rangehigh = 90 * FREQ_MUL;
592 /* stereo indicator == stereo (instead of mono) */
593 if ((radio->registers[STATUSRSSI] & STATUSRSSI_ST) == 0)
594 tuner->rxsubchans = V4L2_TUNER_SUB_MONO;
596 tuner->rxsubchans = V4L2_TUNER_SUB_STEREO;
597 /* If there is a reliable method of detecting an RDS channel,
598 then this code should check for that before setting this
600 tuner->rxsubchans |= V4L2_TUNER_SUB_RDS;
602 /* mono/stereo selector */
603 if ((radio->registers[POWERCFG] & POWERCFG_MONO) == 0)
604 tuner->audmode = V4L2_TUNER_MODE_STEREO;
606 tuner->audmode = V4L2_TUNER_MODE_MONO;
608 /* min is worst, max is best; signal:0..0xffff; rssi: 0..0xff */
609 /* measured in units of dbµV in 1 db increments (max at ~75 dbµV) */
610 tuner->signal = (radio->registers[STATUSRSSI] & STATUSRSSI_RSSI);
611 /* the ideal factor is 0xffff/75 = 873,8 */
612 tuner->signal = (tuner->signal * 873) + (8 * tuner->signal / 10);
613 if (tuner->signal > 0xffff)
614 tuner->signal = 0xffff;
616 /* automatic frequency control: -1: freq to low, 1 freq to high */
617 /* AFCRL does only indicate that freq. differs, not if too low/high */
618 tuner->afc = (radio->registers[STATUSRSSI] & STATUSRSSI_AFCRL) ? 1 : 0;
625 * si470x_vidioc_s_tuner - set tuner attributes
627 static int si470x_vidioc_s_tuner(struct file *file, void *priv,
628 struct v4l2_tuner *tuner)
630 struct si470x_device *radio = video_drvdata(file);
632 if (tuner->index != 0)
635 /* mono/stereo selector */
636 switch (tuner->audmode) {
637 case V4L2_TUNER_MODE_MONO:
638 radio->registers[POWERCFG] |= POWERCFG_MONO; /* force mono */
640 case V4L2_TUNER_MODE_STEREO:
642 radio->registers[POWERCFG] &= ~POWERCFG_MONO; /* try stereo */
646 return si470x_set_register(radio, POWERCFG);
651 * si470x_vidioc_g_frequency - get tuner or modulator radio frequency
653 static int si470x_vidioc_g_frequency(struct file *file, void *priv,
654 struct v4l2_frequency *freq)
656 struct si470x_device *radio = video_drvdata(file);
658 if (freq->tuner != 0)
661 freq->type = V4L2_TUNER_RADIO;
662 return si470x_get_freq(radio, &freq->frequency);
667 * si470x_vidioc_s_frequency - set tuner or modulator radio frequency
669 static int si470x_vidioc_s_frequency(struct file *file, void *priv,
670 struct v4l2_frequency *freq)
672 struct si470x_device *radio = video_drvdata(file);
674 if (freq->tuner != 0)
677 return si470x_set_freq(radio, freq->frequency);
682 * si470x_vidioc_s_hw_freq_seek - set hardware frequency seek
684 static int si470x_vidioc_s_hw_freq_seek(struct file *file, void *priv,
685 struct v4l2_hw_freq_seek *seek)
687 struct si470x_device *radio = video_drvdata(file);
689 if (seek->tuner != 0)
692 return si470x_set_seek(radio, seek->wrap_around, seek->seek_upward);
695 const struct v4l2_ctrl_ops si470x_ctrl_ops = {
696 .s_ctrl = si470x_s_ctrl,
700 * si470x_ioctl_ops - video device ioctl operations
702 static const struct v4l2_ioctl_ops si470x_ioctl_ops = {
703 .vidioc_querycap = si470x_vidioc_querycap,
704 .vidioc_g_tuner = si470x_vidioc_g_tuner,
705 .vidioc_s_tuner = si470x_vidioc_s_tuner,
706 .vidioc_g_frequency = si470x_vidioc_g_frequency,
707 .vidioc_s_frequency = si470x_vidioc_s_frequency,
708 .vidioc_s_hw_freq_seek = si470x_vidioc_s_hw_freq_seek,
709 .vidioc_subscribe_event = v4l2_ctrl_subscribe_event,
710 .vidioc_unsubscribe_event = v4l2_event_unsubscribe,
715 * si470x_viddev_template - video device interface
717 struct video_device si470x_viddev_template = {
718 .fops = &si470x_fops,
720 .release = video_device_release_empty,
721 .ioctl_ops = &si470x_ioctl_ops,