projects / deliverable / linux.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
blame | history | raw | HEAD
Merge git://git.infradead.org/~dwmw2/iommu-2.6.31
[deliverable/linux.git] / drivers / media / radio / radio-si470x.c
1 /*
2 * drivers/media/radio/radio-si470x.c
3 *
4 * Driver for USB radios for the Silicon Labs Si470x FM Radio Receivers:
5 * - Silicon Labs USB FM Radio Reference Design
6 * - ADS/Tech FM Radio Receiver (formerly Instant FM Music) (RDX-155-EF)
7 * - KWorld USB FM Radio SnapMusic Mobile 700 (FM700)
8 * - Sanei Electric, Inc. FM USB Radio (sold as DealExtreme.com PCear)
9 *
10 * Copyright (c) 2009 Tobias Lorenz <tobias.lorenz@gmx.net>
11 *
12 * This program is free software; you can redistribute it and/or modify
13 * it under the terms of the GNU General Public License as published by
14 * the Free Software Foundation; either version 2 of the License, or
15 * (at your option) any later version.
16 *
17 * This program is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU General Public License for more details.
21 *
22 * You should have received a copy of the GNU General Public License
23 * along with this program; if not, write to the Free Software
24 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
25 */
26
27
28 /*
29 * History:
30 * 2008-01-12 Tobias Lorenz <tobias.lorenz@gmx.net>
31 * Version 1.0.0
32 * - First working version
33 * 2008-01-13 Tobias Lorenz <tobias.lorenz@gmx.net>
34 * Version 1.0.1
35 * - Improved error handling, every function now returns errno
36 * - Improved multi user access (start/mute/stop)
37 * - Channel doesn't get lost anymore after start/mute/stop
38 * - RDS support added (polling mode via interrupt EP 1)
39 * - marked default module parameters with *value*
40 * - switched from bit structs to bit masks
41 * - header file cleaned and integrated
42 * 2008-01-14 Tobias Lorenz <tobias.lorenz@gmx.net>
43 * Version 1.0.2
44 * - hex values are now lower case
45 * - commented USB ID for ADS/Tech moved on todo list
46 * - blacklisted si470x in hid-quirks.c
47 * - rds buffer handling functions integrated into *_work, *_read
48 * - rds_command in si470x_poll exchanged against simple retval
49 * - check for firmware version 15
50 * - code order and prototypes still remain the same
51 * - spacing and bottom of band codes remain the same
52 * 2008-01-16 Tobias Lorenz <tobias.lorenz@gmx.net>
53 * Version 1.0.3
54 * - code reordered to avoid function prototypes
55 * - switch/case defaults are now more user-friendly
56 * - unified comment style
57 * - applied all checkpatch.pl v1.12 suggestions
58 * except the warning about the too long lines with bit comments
59 * - renamed FMRADIO to RADIO to cut line length (checkpatch.pl)
60 * 2008-01-22 Tobias Lorenz <tobias.lorenz@gmx.net>
61 * Version 1.0.4
62 * - avoid poss. locking when doing copy_to_user which may sleep
63 * - RDS is automatically activated on read now
64 * - code cleaned of unnecessary rds_commands
65 * - USB Vendor/Product ID for ADS/Tech FM Radio Receiver verified
66 * (thanks to Guillaume RAMOUSSE)
67 * 2008-01-27 Tobias Lorenz <tobias.lorenz@gmx.net>
68 * Version 1.0.5
69 * - number of seek_retries changed to tune_timeout
70 * - fixed problem with incomplete tune operations by own buffers
71 * - optimization of variables and printf types
72 * - improved error logging
73 * 2008-01-31 Tobias Lorenz <tobias.lorenz@gmx.net>
74 * Oliver Neukum <oliver@neukum.org>
75 * Version 1.0.6
76 * - fixed coverity checker warnings in *_usb_driver_disconnect
77 * - probe()/open() race by correct ordering in probe()
78 * - DMA coherency rules by separate allocation of all buffers
79 * - use of endianness macros
80 * - abuse of spinlock, replaced by mutex
81 * - racy handling of timer in disconnect,
82 * replaced by delayed_work
83 * - racy interruptible_sleep_on(),
84 * replaced with wait_event_interruptible()
85 * - handle signals in read()
86 * 2008-02-08 Tobias Lorenz <tobias.lorenz@gmx.net>
87 * Oliver Neukum <oliver@neukum.org>
88 * Version 1.0.7
89 * - usb autosuspend support
90 * - unplugging fixed
91 * 2008-05-07 Tobias Lorenz <tobias.lorenz@gmx.net>
92 * Version 1.0.8
93 * - hardware frequency seek support
94 * - afc indication
95 * - more safety checks, let si470x_get_freq return errno
96 * - vidioc behavior corrected according to v4l2 spec
97 * 2008-10-20 Alexey Klimov <klimov.linux@gmail.com>
98 * - add support for KWorld USB FM Radio FM700
99 * - blacklisted KWorld radio in hid-core.c and hid-ids.h
100 * 2008-12-03 Mark Lord <mlord@pobox.com>
101 * - add support for DealExtreme USB Radio
102 * 2009-01-31 Bob Ross <pigiron@gmx.com>
103 * - correction of stereo detection/setting
104 * - correction of signal strength indicator scaling
105 * 2009-01-31 Rick Bronson <rick@efn.org>
106 * Tobias Lorenz <tobias.lorenz@gmx.net>
107 * - add LED status output
108 * - get HW/SW version from scratchpad
109 *
110 * ToDo:
111 * - add firmware download/update support
112 * - RDS support: interrupt mode, instead of polling
113 */
114
115
116 /* driver definitions */
117 #define DRIVER_AUTHOR "Tobias Lorenz <tobias.lorenz@gmx.net>"
118 #define DRIVER_NAME "radio-si470x"
119 #define DRIVER_KERNEL_VERSION KERNEL_VERSION(1, 0, 9)
120 #define DRIVER_CARD "Silicon Labs Si470x FM Radio Receiver"
121 #define DRIVER_DESC "USB radio driver for Si470x FM Radio Receivers"
122 #define DRIVER_VERSION "1.0.9"
123
124
125 /* kernel includes */
126 #include <linux/kernel.h>
127 #include <linux/module.h>
128 #include <linux/init.h>
129 #include <linux/slab.h>
130 #include <linux/input.h>
131 #include <linux/usb.h>
132 #include <linux/hid.h>
133 #include <linux/version.h>
134 #include <linux/videodev2.h>
135 #include <linux/mutex.h>
136 #include <media/v4l2-common.h>
137 #include <media/v4l2-ioctl.h>
138 #include <media/rds.h>
139 #include <asm/unaligned.h>
140
141
142 /* USB Device ID List */
143 static struct usb_device_id si470x_usb_driver_id_table[] = {
144 /* Silicon Labs USB FM Radio Reference Design */
145 { USB_DEVICE_AND_INTERFACE_INFO(0x10c4, 0x818a, USB_CLASS_HID, 0, 0) },
146 /* ADS/Tech FM Radio Receiver (formerly Instant FM Music) */
147 { USB_DEVICE_AND_INTERFACE_INFO(0x06e1, 0xa155, USB_CLASS_HID, 0, 0) },
148 /* KWorld USB FM Radio SnapMusic Mobile 700 (FM700) */
149 { USB_DEVICE_AND_INTERFACE_INFO(0x1b80, 0xd700, USB_CLASS_HID, 0, 0) },
150 /* Sanei Electric, Inc. FM USB Radio (sold as DealExtreme.com PCear) */
151 { USB_DEVICE_AND_INTERFACE_INFO(0x10c5, 0x819a, USB_CLASS_HID, 0, 0) },
152 /* Terminating entry */
153 { }
154 };
155 MODULE_DEVICE_TABLE(usb, si470x_usb_driver_id_table);
156
157
158
159 /**************************************************************************
160 * Module Parameters
161 **************************************************************************/
162
163 /* Radio Nr */
164 static int radio_nr = -1;
165 module_param(radio_nr, int, 0444);
166 MODULE_PARM_DESC(radio_nr, "Radio Nr");
167
168 /* Spacing (kHz) */
169 /* 0: 200 kHz (USA, Australia) */
170 /* 1: 100 kHz (Europe, Japan) */
171 /* 2: 50 kHz */
172 static unsigned short space = 2;
173 module_param(space, ushort, 0444);
174 MODULE_PARM_DESC(space, "Spacing: 0=200kHz 1=100kHz *2=50kHz*");
175
176 /* Bottom of Band (MHz) */
177 /* 0: 87.5 - 108 MHz (USA, Europe)*/
178 /* 1: 76 - 108 MHz (Japan wide band) */
179 /* 2: 76 - 90 MHz (Japan) */
180 static unsigned short band = 1;
181 module_param(band, ushort, 0444);
182 MODULE_PARM_DESC(band, "Band: 0=87.5..108MHz *1=76..108MHz* 2=76..90MHz");
183
184 /* De-emphasis */
185 /* 0: 75 us (USA) */
186 /* 1: 50 us (Europe, Australia, Japan) */
187 static unsigned short de = 1;
188 module_param(de, ushort, 0444);
189 MODULE_PARM_DESC(de, "De-emphasis: 0=75us *1=50us*");
190
191 /* USB timeout */
192 static unsigned int usb_timeout = 500;
193 module_param(usb_timeout, uint, 0644);
194 MODULE_PARM_DESC(usb_timeout, "USB timeout (ms): *500*");
195
196 /* Tune timeout */
197 static unsigned int tune_timeout = 3000;
198 module_param(tune_timeout, uint, 0644);
199 MODULE_PARM_DESC(tune_timeout, "Tune timeout: *3000*");
200
201 /* Seek timeout */
202 static unsigned int seek_timeout = 5000;
203 module_param(seek_timeout, uint, 0644);
204 MODULE_PARM_DESC(seek_timeout, "Seek timeout: *5000*");
205
206 /* RDS buffer blocks */
207 static unsigned int rds_buf = 100;
208 module_param(rds_buf, uint, 0444);
209 MODULE_PARM_DESC(rds_buf, "RDS buffer entries: *100*");
210
211 /* RDS maximum block errors */
212 static unsigned short max_rds_errors = 1;
213 /* 0 means 0 errors requiring correction */
214 /* 1 means 1-2 errors requiring correction (used by original USBRadio.exe) */
215 /* 2 means 3-5 errors requiring correction */
216 /* 3 means 6+ errors or errors in checkword, correction not possible */
217 module_param(max_rds_errors, ushort, 0644);
218 MODULE_PARM_DESC(max_rds_errors, "RDS maximum block errors: *1*");
219
220 /* RDS poll frequency */
221 static unsigned int rds_poll_time = 40;
222 /* 40 is used by the original USBRadio.exe */
223 /* 50 is used by radio-cadet */
224 /* 75 should be okay */
225 /* 80 is the usual RDS receive interval */
226 module_param(rds_poll_time, uint, 0644);
227 MODULE_PARM_DESC(rds_poll_time, "RDS poll time (ms): *40*");
228
229
230
231 /**************************************************************************
232 * Register Definitions
233 **************************************************************************/
234 #define RADIO_REGISTER_SIZE 2 /* 16 register bit width */
235 #define RADIO_REGISTER_NUM 16 /* DEVICEID ... RDSD */
236 #define RDS_REGISTER_NUM 6 /* STATUSRSSI ... RDSD */
237
238 #define DEVICEID 0 /* Device ID */
239 #define DEVICEID_PN 0xf000 /* bits 15..12: Part Number */
240 #define DEVICEID_MFGID 0x0fff /* bits 11..00: Manufacturer ID */
241
242 #define CHIPID 1 /* Chip ID */
243 #define CHIPID_REV 0xfc00 /* bits 15..10: Chip Version */
244 #define CHIPID_DEV 0x0200 /* bits 09..09: Device */
245 #define CHIPID_FIRMWARE 0x01ff /* bits 08..00: Firmware Version */
246
247 #define POWERCFG 2 /* Power Configuration */
248 #define POWERCFG_DSMUTE 0x8000 /* bits 15..15: Softmute Disable */
249 #define POWERCFG_DMUTE 0x4000 /* bits 14..14: Mute Disable */
250 #define POWERCFG_MONO 0x2000 /* bits 13..13: Mono Select */
251 #define POWERCFG_RDSM 0x0800 /* bits 11..11: RDS Mode (Si4701 only) */
252 #define POWERCFG_SKMODE 0x0400 /* bits 10..10: Seek Mode */
253 #define POWERCFG_SEEKUP 0x0200 /* bits 09..09: Seek Direction */
254 #define POWERCFG_SEEK 0x0100 /* bits 08..08: Seek */
255 #define POWERCFG_DISABLE 0x0040 /* bits 06..06: Powerup Disable */
256 #define POWERCFG_ENABLE 0x0001 /* bits 00..00: Powerup Enable */
257
258 #define CHANNEL 3 /* Channel */
259 #define CHANNEL_TUNE 0x8000 /* bits 15..15: Tune */
260 #define CHANNEL_CHAN 0x03ff /* bits 09..00: Channel Select */
261
262 #define SYSCONFIG1 4 /* System Configuration 1 */
263 #define SYSCONFIG1_RDSIEN 0x8000 /* bits 15..15: RDS Interrupt Enable (Si4701 only) */
264 #define SYSCONFIG1_STCIEN 0x4000 /* bits 14..14: Seek/Tune Complete Interrupt Enable */
265 #define SYSCONFIG1_RDS 0x1000 /* bits 12..12: RDS Enable (Si4701 only) */
266 #define SYSCONFIG1_DE 0x0800 /* bits 11..11: De-emphasis (0=75us 1=50us) */
267 #define SYSCONFIG1_AGCD 0x0400 /* bits 10..10: AGC Disable */
268 #define SYSCONFIG1_BLNDADJ 0x00c0 /* bits 07..06: Stereo/Mono Blend Level Adjustment */
269 #define SYSCONFIG1_GPIO3 0x0030 /* bits 05..04: General Purpose I/O 3 */
270 #define SYSCONFIG1_GPIO2 0x000c /* bits 03..02: General Purpose I/O 2 */
271 #define SYSCONFIG1_GPIO1 0x0003 /* bits 01..00: General Purpose I/O 1 */
272
273 #define SYSCONFIG2 5 /* System Configuration 2 */
274 #define SYSCONFIG2_SEEKTH 0xff00 /* bits 15..08: RSSI Seek Threshold */
275 #define SYSCONFIG2_BAND 0x0080 /* bits 07..06: Band Select */
276 #define SYSCONFIG2_SPACE 0x0030 /* bits 05..04: Channel Spacing */
277 #define SYSCONFIG2_VOLUME 0x000f /* bits 03..00: Volume */
278
279 #define SYSCONFIG3 6 /* System Configuration 3 */
280 #define SYSCONFIG3_SMUTER 0xc000 /* bits 15..14: Softmute Attack/Recover Rate */
281 #define SYSCONFIG3_SMUTEA 0x3000 /* bits 13..12: Softmute Attenuation */
282 #define SYSCONFIG3_SKSNR 0x00f0 /* bits 07..04: Seek SNR Threshold */
283 #define SYSCONFIG3_SKCNT 0x000f /* bits 03..00: Seek FM Impulse Detection Threshold */
284
285 #define TEST1 7 /* Test 1 */
286 #define TEST1_AHIZEN 0x4000 /* bits 14..14: Audio High-Z Enable */
287
288 #define TEST2 8 /* Test 2 */
289 /* TEST2 only contains reserved bits */
290
291 #define BOOTCONFIG 9 /* Boot Configuration */
292 /* BOOTCONFIG only contains reserved bits */
293
294 #define STATUSRSSI 10 /* Status RSSI */
295 #define STATUSRSSI_RDSR 0x8000 /* bits 15..15: RDS Ready (Si4701 only) */
296 #define STATUSRSSI_STC 0x4000 /* bits 14..14: Seek/Tune Complete */
297 #define STATUSRSSI_SF 0x2000 /* bits 13..13: Seek Fail/Band Limit */
298 #define STATUSRSSI_AFCRL 0x1000 /* bits 12..12: AFC Rail */
299 #define STATUSRSSI_RDSS 0x0800 /* bits 11..11: RDS Synchronized (Si4701 only) */
300 #define STATUSRSSI_BLERA 0x0600 /* bits 10..09: RDS Block A Errors (Si4701 only) */
301 #define STATUSRSSI_ST 0x0100 /* bits 08..08: Stereo Indicator */
302 #define STATUSRSSI_RSSI 0x00ff /* bits 07..00: RSSI (Received Signal Strength Indicator) */
303
304 #define READCHAN 11 /* Read Channel */
305 #define READCHAN_BLERB 0xc000 /* bits 15..14: RDS Block D Errors (Si4701 only) */
306 #define READCHAN_BLERC 0x3000 /* bits 13..12: RDS Block C Errors (Si4701 only) */
307 #define READCHAN_BLERD 0x0c00 /* bits 11..10: RDS Block B Errors (Si4701 only) */
308 #define READCHAN_READCHAN 0x03ff /* bits 09..00: Read Channel */
309
310 #define RDSA 12 /* RDSA */
311 #define RDSA_RDSA 0xffff /* bits 15..00: RDS Block A Data (Si4701 only) */
312
313 #define RDSB 13 /* RDSB */
314 #define RDSB_RDSB 0xffff /* bits 15..00: RDS Block B Data (Si4701 only) */
315
316 #define RDSC 14 /* RDSC */
317 #define RDSC_RDSC 0xffff /* bits 15..00: RDS Block C Data (Si4701 only) */
318
319 #define RDSD 15 /* RDSD */
320 #define RDSD_RDSD 0xffff /* bits 15..00: RDS Block D Data (Si4701 only) */
321
322
323
324 /**************************************************************************
325 * USB HID Reports
326 **************************************************************************/
327
328 /* Reports 1-16 give direct read/write access to the 16 Si470x registers */
329 /* with the (REPORT_ID - 1) corresponding to the register address across USB */
330 /* endpoint 0 using GET_REPORT and SET_REPORT */
331 #define REGISTER_REPORT_SIZE (RADIO_REGISTER_SIZE + 1)
332 #define REGISTER_REPORT(reg) ((reg) + 1)
333
334 /* Report 17 gives direct read/write access to the entire Si470x register */
335 /* map across endpoint 0 using GET_REPORT and SET_REPORT */
336 #define ENTIRE_REPORT_SIZE (RADIO_REGISTER_NUM * RADIO_REGISTER_SIZE + 1)
337 #define ENTIRE_REPORT 17
338
339 /* Report 18 is used to send the lowest 6 Si470x registers up the HID */
340 /* interrupt endpoint 1 to Windows every 20 milliseconds for status */
341 #define RDS_REPORT_SIZE (RDS_REGISTER_NUM * RADIO_REGISTER_SIZE + 1)
342 #define RDS_REPORT 18
343
344 /* Report 19: LED state */
345 #define LED_REPORT_SIZE 3
346 #define LED_REPORT 19
347
348 /* Report 19: stream */
349 #define STREAM_REPORT_SIZE 3
350 #define STREAM_REPORT 19
351
352 /* Report 20: scratch */
353 #define SCRATCH_PAGE_SIZE 63
354 #define SCRATCH_REPORT_SIZE (SCRATCH_PAGE_SIZE + 1)
355 #define SCRATCH_REPORT 20
356
357 /* Reports 19-22: flash upgrade of the C8051F321 */
358 #define WRITE_REPORT_SIZE 4
359 #define WRITE_REPORT 19
360 #define FLASH_REPORT_SIZE 64
361 #define FLASH_REPORT 20
362 #define CRC_REPORT_SIZE 3
363 #define CRC_REPORT 21
364 #define RESPONSE_REPORT_SIZE 2
365 #define RESPONSE_REPORT 22
366
367 /* Report 23: currently unused, but can accept 60 byte reports on the HID */
368 /* interrupt out endpoint 2 every 1 millisecond */
369 #define UNUSED_REPORT 23
370
371
372
373 /**************************************************************************
374 * Software/Hardware Versions
375 **************************************************************************/
376 #define RADIO_SW_VERSION_NOT_BOOTLOADABLE 6
377 #define RADIO_SW_VERSION 7
378 #define RADIO_SW_VERSION_CURRENT 15
379 #define RADIO_HW_VERSION 1
380
381 #define SCRATCH_PAGE_SW_VERSION 1
382 #define SCRATCH_PAGE_HW_VERSION 2
383
384
385
386 /**************************************************************************
387 * LED State Definitions
388 **************************************************************************/
389 #define LED_COMMAND 0x35
390
391 #define NO_CHANGE_LED 0x00
392 #define ALL_COLOR_LED 0x01 /* streaming state */
393 #define BLINK_GREEN_LED 0x02 /* connect state */
394 #define BLINK_RED_LED 0x04
395 #define BLINK_ORANGE_LED 0x10 /* disconnect state */
396 #define SOLID_GREEN_LED 0x20 /* tuning/seeking state */
397 #define SOLID_RED_LED 0x40 /* bootload state */
398 #define SOLID_ORANGE_LED 0x80
399
400
401
402 /**************************************************************************
403 * Stream State Definitions
404 **************************************************************************/
405 #define STREAM_COMMAND 0x36
406 #define STREAM_VIDPID 0x00
407 #define STREAM_AUDIO 0xff
408
409
410
411 /**************************************************************************
412 * Bootloader / Flash Commands
413 **************************************************************************/
414
415 /* unique id sent to bootloader and required to put into a bootload state */
416 #define UNIQUE_BL_ID 0x34
417
418 /* mask for the flash data */
419 #define FLASH_DATA_MASK 0x55
420
421 /* bootloader commands */
422 #define GET_SW_VERSION_COMMAND 0x00
423 #define SET_PAGE_COMMAND 0x01
424 #define ERASE_PAGE_COMMAND 0x02
425 #define WRITE_PAGE_COMMAND 0x03
426 #define CRC_ON_PAGE_COMMAND 0x04
427 #define READ_FLASH_BYTE_COMMAND 0x05
428 #define RESET_DEVICE_COMMAND 0x06
429 #define GET_HW_VERSION_COMMAND 0x07
430 #define BLANK 0xff
431
432 /* bootloader command responses */
433 #define COMMAND_OK 0x01
434 #define COMMAND_FAILED 0x02
435 #define COMMAND_PENDING 0x03
436
437
438
439 /**************************************************************************
440 * General Driver Definitions
441 **************************************************************************/
442
443 /*
444 * si470x_device - private data
445 */
446 struct si470x_device {
447 /* reference to USB and video device */
448 struct usb_device *usbdev;
449 struct usb_interface *intf;
450 struct video_device *videodev;
451
452 /* driver management */
453 unsigned int users;
454 unsigned char disconnected;
455 struct mutex disconnect_lock;
456
457 /* Silabs internal registers (0..15) */
458 unsigned short registers[RADIO_REGISTER_NUM];
459
460 /* RDS receive buffer */
461 struct delayed_work work;
462 wait_queue_head_t read_queue;
463 struct mutex lock; /* buffer locking */
464 unsigned char *buffer; /* size is always multiple of three */
465 unsigned int buf_size;
466 unsigned int rd_index;
467 unsigned int wr_index;
468
469 /* scratch page */
470 unsigned char software_version;
471 unsigned char hardware_version;
472 };
473
474
475 /*
476 * The frequency is set in units of 62.5 Hz when using V4L2_TUNER_CAP_LOW,
477 * 62.5 kHz otherwise.
478 * The tuner is able to have a channel spacing of 50, 100 or 200 kHz.
479 * tuner->capability is therefore set to V4L2_TUNER_CAP_LOW
480 * The FREQ_MUL is then: 1 MHz / 62.5 Hz = 16000
481 */
482 #define FREQ_MUL (1000000 / 62.5)
483
484
485
486 /**************************************************************************
487 * General Driver Functions - REGISTER_REPORTs
488 **************************************************************************/
489
490 /*
491 * si470x_get_report - receive a HID report
492 */
493 static int si470x_get_report(struct si470x_device *radio, void *buf, int size)
494 {
495 unsigned char *report = (unsigned char *) buf;
496 int retval;
497
498 retval = usb_control_msg(radio->usbdev,
499 usb_rcvctrlpipe(radio->usbdev, 0),
500 HID_REQ_GET_REPORT,
501 USB_TYPE_CLASS | USB_RECIP_INTERFACE | USB_DIR_IN,
502 report[0], 2,
503 buf, size, usb_timeout);
504
505 if (retval < 0)
506 printk(KERN_WARNING DRIVER_NAME
507 ": si470x_get_report: usb_control_msg returned %d\n",
508 retval);
509 return retval;
510 }
511
512
513 /*
514 * si470x_set_report - send a HID report
515 */
516 static int si470x_set_report(struct si470x_device *radio, void *buf, int size)
517 {
518 unsigned char *report = (unsigned char *) buf;
519 int retval;
520
521 retval = usb_control_msg(radio->usbdev,
522 usb_sndctrlpipe(radio->usbdev, 0),
523 HID_REQ_SET_REPORT,
524 USB_TYPE_CLASS | USB_RECIP_INTERFACE | USB_DIR_OUT,
525 report[0], 2,
526 buf, size, usb_timeout);
527
528 if (retval < 0)
529 printk(KERN_WARNING DRIVER_NAME
530 ": si470x_set_report: usb_control_msg returned %d\n",
531 retval);
532 return retval;
533 }
534
535
536 /*
537 * si470x_get_register - read register
538 */
539 static int si470x_get_register(struct si470x_device *radio, int regnr)
540 {
541 unsigned char buf[REGISTER_REPORT_SIZE];
542 int retval;
543
544 buf[0] = REGISTER_REPORT(regnr);
545
546 retval = si470x_get_report(radio, (void *) &buf, sizeof(buf));
547
548 if (retval >= 0)
549 radio->registers[regnr] = get_unaligned_be16(&buf[1]);
550
551 return (retval < 0) ? -EINVAL : 0;
552 }
553
554
555 /*
556 * si470x_set_register - write register
557 */
558 static int si470x_set_register(struct si470x_device *radio, int regnr)
559 {
560 unsigned char buf[REGISTER_REPORT_SIZE];
561 int retval;
562
563 buf[0] = REGISTER_REPORT(regnr);
564 put_unaligned_be16(radio->registers[regnr], &buf[1]);
565
566 retval = si470x_set_report(radio, (void *) &buf, sizeof(buf));
567
568 return (retval < 0) ? -EINVAL : 0;
569 }
570
571
572 /*
573 * si470x_set_chan - set the channel
574 */
575 static int si470x_set_chan(struct si470x_device *radio, unsigned short chan)
576 {
577 int retval;
578 unsigned long timeout;
579 bool timed_out = 0;
580
581 /* start tuning */
582 radio->registers[CHANNEL] &= ~CHANNEL_CHAN;
583 radio->registers[CHANNEL] |= CHANNEL_TUNE | chan;
584 retval = si470x_set_register(radio, CHANNEL);
585 if (retval < 0)
586 goto done;
587
588 /* wait till tune operation has completed */
589 timeout = jiffies + msecs_to_jiffies(tune_timeout);
590 do {
591 retval = si470x_get_register(radio, STATUSRSSI);
592 if (retval < 0)
593 goto stop;
594 timed_out = time_after(jiffies, timeout);
595 } while (((radio->registers[STATUSRSSI] & STATUSRSSI_STC) == 0) &&
596 (!timed_out));
597 if ((radio->registers[STATUSRSSI] & STATUSRSSI_STC) == 0)
598 printk(KERN_WARNING DRIVER_NAME ": tune does not complete\n");
599 if (timed_out)
600 printk(KERN_WARNING DRIVER_NAME
601 ": tune timed out after %u ms\n", tune_timeout);
602
603 stop:
604 /* stop tuning */
605 radio->registers[CHANNEL] &= ~CHANNEL_TUNE;
606 retval = si470x_set_register(radio, CHANNEL);
607
608 done:
609 return retval;
610 }
611
612
613 /*
614 * si470x_get_freq - get the frequency
615 */
616 static int si470x_get_freq(struct si470x_device *radio, unsigned int *freq)
617 {
618 unsigned int spacing, band_bottom;
619 unsigned short chan;
620 int retval;
621
622 /* Spacing (kHz) */
623 switch ((radio->registers[SYSCONFIG2] & SYSCONFIG2_SPACE) >> 4) {
624 /* 0: 200 kHz (USA, Australia) */
625 case 0:
626 spacing = 0.200 * FREQ_MUL; break;
627 /* 1: 100 kHz (Europe, Japan) */
628 case 1:
629 spacing = 0.100 * FREQ_MUL; break;
630 /* 2: 50 kHz */
631 default:
632 spacing = 0.050 * FREQ_MUL; break;
633 };
634
635 /* Bottom of Band (MHz) */
636 switch ((radio->registers[SYSCONFIG2] & SYSCONFIG2_BAND) >> 6) {
637 /* 0: 87.5 - 108 MHz (USA, Europe) */
638 case 0:
639 band_bottom = 87.5 * FREQ_MUL; break;
640 /* 1: 76 - 108 MHz (Japan wide band) */
641 default:
642 band_bottom = 76 * FREQ_MUL; break;
643 /* 2: 76 - 90 MHz (Japan) */
644 case 2:
645 band_bottom = 76 * FREQ_MUL; break;
646 };
647
648 /* read channel */
649 retval = si470x_get_register(radio, READCHAN);
650 chan = radio->registers[READCHAN] & READCHAN_READCHAN;
651
652 /* Frequency (MHz) = Spacing (kHz) x Channel + Bottom of Band (MHz) */
653 *freq = chan * spacing + band_bottom;
654
655 return retval;
656 }
657
658
659 /*
660 * si470x_set_freq - set the frequency
661 */
662 static int si470x_set_freq(struct si470x_device *radio, unsigned int freq)
663 {
664 unsigned int spacing, band_bottom;
665 unsigned short chan;
666
667 /* Spacing (kHz) */
668 switch ((radio->registers[SYSCONFIG2] & SYSCONFIG2_SPACE) >> 4) {
669 /* 0: 200 kHz (USA, Australia) */
670 case 0:
671 spacing = 0.200 * FREQ_MUL; break;
672 /* 1: 100 kHz (Europe, Japan) */
673 case 1:
674 spacing = 0.100 * FREQ_MUL; break;
675 /* 2: 50 kHz */
676 default:
677 spacing = 0.050 * FREQ_MUL; break;
678 };
679
680 /* Bottom of Band (MHz) */
681 switch ((radio->registers[SYSCONFIG2] & SYSCONFIG2_BAND) >> 6) {
682 /* 0: 87.5 - 108 MHz (USA, Europe) */
683 case 0:
684 band_bottom = 87.5 * FREQ_MUL; break;
685 /* 1: 76 - 108 MHz (Japan wide band) */
686 default:
687 band_bottom = 76 * FREQ_MUL; break;
688 /* 2: 76 - 90 MHz (Japan) */
689 case 2:
690 band_bottom = 76 * FREQ_MUL; break;
691 };
692
693 /* Chan = [ Freq (Mhz) - Bottom of Band (MHz) ] / Spacing (kHz) */
694 chan = (freq - band_bottom) / spacing;
695
696 return si470x_set_chan(radio, chan);
697 }
698
699
700 /*
701 * si470x_set_seek - set seek
702 */
703 static int si470x_set_seek(struct si470x_device *radio,
704 unsigned int wrap_around, unsigned int seek_upward)
705 {
706 int retval = 0;
707 unsigned long timeout;
708 bool timed_out = 0;
709
710 /* start seeking */
711 radio->registers[POWERCFG] |= POWERCFG_SEEK;
712 if (wrap_around == 1)
713 radio->registers[POWERCFG] &= ~POWERCFG_SKMODE;
714 else
715 radio->registers[POWERCFG] |= POWERCFG_SKMODE;
716 if (seek_upward == 1)
717 radio->registers[POWERCFG] |= POWERCFG_SEEKUP;
718 else
719 radio->registers[POWERCFG] &= ~POWERCFG_SEEKUP;
720 retval = si470x_set_register(radio, POWERCFG);
721 if (retval < 0)
722 goto done;
723
724 /* wait till seek operation has completed */
725 timeout = jiffies + msecs_to_jiffies(seek_timeout);
726 do {
727 retval = si470x_get_register(radio, STATUSRSSI);
728 if (retval < 0)
729 goto stop;
730 timed_out = time_after(jiffies, timeout);
731 } while (((radio->registers[STATUSRSSI] & STATUSRSSI_STC) == 0) &&
732 (!timed_out));
733 if ((radio->registers[STATUSRSSI] & STATUSRSSI_STC) == 0)
734 printk(KERN_WARNING DRIVER_NAME ": seek does not complete\n");
735 if (radio->registers[STATUSRSSI] & STATUSRSSI_SF)
736 printk(KERN_WARNING DRIVER_NAME
737 ": seek failed / band limit reached\n");
738 if (timed_out)
739 printk(KERN_WARNING DRIVER_NAME
740 ": seek timed out after %u ms\n", seek_timeout);
741
742 stop:
743 /* stop seeking */
744 radio->registers[POWERCFG] &= ~POWERCFG_SEEK;
745 retval = si470x_set_register(radio, POWERCFG);
746
747 done:
748 /* try again, if timed out */
749 if ((retval == 0) && timed_out)
750 retval = -EAGAIN;
751
752 return retval;
753 }
754
755
756 /*
757 * si470x_start - switch on radio
758 */
759 static int si470x_start(struct si470x_device *radio)
760 {
761 int retval;
762
763 /* powercfg */
764 radio->registers[POWERCFG] =
765 POWERCFG_DMUTE | POWERCFG_ENABLE | POWERCFG_RDSM;
766 retval = si470x_set_register(radio, POWERCFG);
767 if (retval < 0)
768 goto done;
769
770 /* sysconfig 1 */
771 radio->registers[SYSCONFIG1] = SYSCONFIG1_DE;
772 retval = si470x_set_register(radio, SYSCONFIG1);
773 if (retval < 0)
774 goto done;
775
776 /* sysconfig 2 */
777 radio->registers[SYSCONFIG2] =
778 (0x3f << 8) | /* SEEKTH */
779 ((band << 6) & SYSCONFIG2_BAND) | /* BAND */
780 ((space << 4) & SYSCONFIG2_SPACE) | /* SPACE */
781 15; /* VOLUME (max) */
782 retval = si470x_set_register(radio, SYSCONFIG2);
783 if (retval < 0)
784 goto done;
785
786 /* reset last channel */
787 retval = si470x_set_chan(radio,
788 radio->registers[CHANNEL] & CHANNEL_CHAN);
789
790 done:
791 return retval;
792 }
793
794
795 /*
796 * si470x_stop - switch off radio
797 */
798 static int si470x_stop(struct si470x_device *radio)
799 {
800 int retval;
801
802 /* sysconfig 1 */
803 radio->registers[SYSCONFIG1] &= ~SYSCONFIG1_RDS;
804 retval = si470x_set_register(radio, SYSCONFIG1);
805 if (retval < 0)
806 goto done;
807
808 /* powercfg */
809 radio->registers[POWERCFG] &= ~POWERCFG_DMUTE;
810 /* POWERCFG_ENABLE has to automatically go low */
811 radio->registers[POWERCFG] |= POWERCFG_ENABLE | POWERCFG_DISABLE;
812 retval = si470x_set_register(radio, POWERCFG);
813
814 done:
815 return retval;
816 }
817
818
819 /*
820 * si470x_rds_on - switch on rds reception
821 */
822 static int si470x_rds_on(struct si470x_device *radio)
823 {
824 int retval;
825
826 /* sysconfig 1 */
827 mutex_lock(&radio->lock);
828 radio->registers[SYSCONFIG1] |= SYSCONFIG1_RDS;
829 retval = si470x_set_register(radio, SYSCONFIG1);
830 if (retval < 0)
831 radio->registers[SYSCONFIG1] &= ~SYSCONFIG1_RDS;
832 mutex_unlock(&radio->lock);
833
834 return retval;
835 }
836
837
838
839 /**************************************************************************
840 * General Driver Functions - ENTIRE_REPORT
841 **************************************************************************/
842
843 /*
844 * si470x_get_all_registers - read entire registers
845 */
846 static int si470x_get_all_registers(struct si470x_device *radio)
847 {
848 unsigned char buf[ENTIRE_REPORT_SIZE];
849 int retval;
850 unsigned char regnr;
851
852 buf[0] = ENTIRE_REPORT;
853
854 retval = si470x_get_report(radio, (void *) &buf, sizeof(buf));
855
856 if (retval >= 0)
857 for (regnr = 0; regnr < RADIO_REGISTER_NUM; regnr++)
858 radio->registers[regnr] = get_unaligned_be16(
859 &buf[regnr * RADIO_REGISTER_SIZE + 1]);
860
861 return (retval < 0) ? -EINVAL : 0;
862 }
863
864
865
866 /**************************************************************************
867 * General Driver Functions - RDS_REPORT
868 **************************************************************************/
869
870 /*
871 * si470x_get_rds_registers - read rds registers
872 */
873 static int si470x_get_rds_registers(struct si470x_device *radio)
874 {
875 unsigned char buf[RDS_REPORT_SIZE];
876 int retval;
877 int size;
878 unsigned char regnr;
879
880 buf[0] = RDS_REPORT;
881
882 retval = usb_interrupt_msg(radio->usbdev,
883 usb_rcvintpipe(radio->usbdev, 1),
884 (void *) &buf, sizeof(buf), &size, usb_timeout);
885 if (size != sizeof(buf))
886 printk(KERN_WARNING DRIVER_NAME ": si470x_get_rds_registers: "
887 "return size differs: %d != %zu\n", size, sizeof(buf));
888 if (retval < 0)
889 printk(KERN_WARNING DRIVER_NAME ": si470x_get_rds_registers: "
890 "usb_interrupt_msg returned %d\n", retval);
891
892 if (retval >= 0)
893 for (regnr = 0; regnr < RDS_REGISTER_NUM; regnr++)
894 radio->registers[STATUSRSSI + regnr] =
895 get_unaligned_be16(
896 &buf[regnr * RADIO_REGISTER_SIZE + 1]);
897
898 return (retval < 0) ? -EINVAL : 0;
899 }
900
901
902
903 /**************************************************************************
904 * General Driver Functions - LED_REPORT
905 **************************************************************************/
906
907 /*
908 * si470x_set_led_state - sets the led state
909 */
910 static int si470x_set_led_state(struct si470x_device *radio,
911 unsigned char led_state)
912 {
913 unsigned char buf[LED_REPORT_SIZE];
914 int retval;
915
916 buf[0] = LED_REPORT;
917 buf[1] = LED_COMMAND;
918 buf[2] = led_state;
919
920 retval = si470x_set_report(radio, (void *) &buf, sizeof(buf));
921
922 return (retval < 0) ? -EINVAL : 0;
923 }
924
925
926
927 /**************************************************************************
928 * General Driver Functions - SCRATCH_REPORT
929 **************************************************************************/
930
931 /*
932 * si470x_get_scratch_versions - gets the scratch page and version infos
933 */
934 static int si470x_get_scratch_page_versions(struct si470x_device *radio)
935 {
936 unsigned char buf[SCRATCH_REPORT_SIZE];
937 int retval;
938
939 buf[0] = SCRATCH_REPORT;
940
941 retval = si470x_get_report(radio, (void *) &buf, sizeof(buf));
942
943 if (retval < 0)
944 printk(KERN_WARNING DRIVER_NAME ": si470x_get_scratch: "
945 "si470x_get_report returned %d\n", retval);
946 else {
947 radio->software_version = buf[1];
948 radio->hardware_version = buf[2];
949 }
950
951 return (retval < 0) ? -EINVAL : 0;
952 }
953
954
955
956 /**************************************************************************
957 * RDS Driver Functions
958 **************************************************************************/
959
960 /*
961 * si470x_rds - rds processing function
962 */
963 static void si470x_rds(struct si470x_device *radio)
964 {
965 unsigned char blocknum;
966 unsigned short bler; /* rds block errors */
967 unsigned short rds;
968 unsigned char tmpbuf[3];
969
970 /* get rds blocks */
971 if (si470x_get_rds_registers(radio) < 0)
972 return;
973 if ((radio->registers[STATUSRSSI] & STATUSRSSI_RDSR) == 0) {
974 /* No RDS group ready */
975 return;
976 }
977 if ((radio->registers[STATUSRSSI] & STATUSRSSI_RDSS) == 0) {
978 /* RDS decoder not synchronized */
979 return;
980 }
981
982 /* copy all four RDS blocks to internal buffer */
983 mutex_lock(&radio->lock);
984 for (blocknum = 0; blocknum < 4; blocknum++) {
985 switch (blocknum) {
986 default:
987 bler = (radio->registers[STATUSRSSI] &
988 STATUSRSSI_BLERA) >> 9;
989 rds = radio->registers[RDSA];
990 break;
991 case 1:
992 bler = (radio->registers[READCHAN] &
993 READCHAN_BLERB) >> 14;
994 rds = radio->registers[RDSB];
995 break;
996 case 2:
997 bler = (radio->registers[READCHAN] &
998 READCHAN_BLERC) >> 12;
999 rds = radio->registers[RDSC];
1000 break;
1001 case 3:
1002 bler = (radio->registers[READCHAN] &
1003 READCHAN_BLERD) >> 10;
1004 rds = radio->registers[RDSD];
1005 break;
1006 };
1007
1008 /* Fill the V4L2 RDS buffer */
1009 put_unaligned_le16(rds, &tmpbuf);
1010 tmpbuf[2] = blocknum; /* offset name */
1011 tmpbuf[2] |= blocknum << 3; /* received offset */
1012 if (bler > max_rds_errors)
1013 tmpbuf[2] |= 0x80; /* uncorrectable errors */
1014 else if (bler > 0)
1015 tmpbuf[2] |= 0x40; /* corrected error(s) */
1016
1017 /* copy RDS block to internal buffer */
1018 memcpy(&radio->buffer[radio->wr_index], &tmpbuf, 3);
1019 radio->wr_index += 3;
1020
1021 /* wrap write pointer */
1022 if (radio->wr_index >= radio->buf_size)
1023 radio->wr_index = 0;
1024
1025 /* check for overflow */
1026 if (radio->wr_index == radio->rd_index) {
1027 /* increment and wrap read pointer */
1028 radio->rd_index += 3;
1029 if (radio->rd_index >= radio->buf_size)
1030 radio->rd_index = 0;
1031 }
1032 }
1033 mutex_unlock(&radio->lock);
1034
1035 /* wake up read queue */
1036 if (radio->wr_index != radio->rd_index)
1037 wake_up_interruptible(&radio->read_queue);
1038 }
1039
1040
1041 /*
1042 * si470x_work - rds work function
1043 */
1044 static void si470x_work(struct work_struct *work)
1045 {
1046 struct si470x_device *radio = container_of(work, struct si470x_device,
1047 work.work);
1048
1049 /* safety checks */
1050 if (radio->disconnected)
1051 return;
1052 if ((radio->registers[SYSCONFIG1] & SYSCONFIG1_RDS) == 0)
1053 return;
1054
1055 si470x_rds(radio);
1056 schedule_delayed_work(&radio->work, msecs_to_jiffies(rds_poll_time));
1057 }
1058
1059
1060
1061 /**************************************************************************
1062 * File Operations Interface
1063 **************************************************************************/
1064
1065 /*
1066 * si470x_fops_read - read RDS data
1067 */
1068 static ssize_t si470x_fops_read(struct file *file, char __user *buf,
1069 size_t count, loff_t *ppos)
1070 {
1071 struct si470x_device *radio = video_drvdata(file);
1072 int retval = 0;
1073 unsigned int block_count = 0;
1074
1075 /* switch on rds reception */
1076 if ((radio->registers[SYSCONFIG1] & SYSCONFIG1_RDS) == 0) {
1077 si470x_rds_on(radio);
1078 schedule_delayed_work(&radio->work,
1079 msecs_to_jiffies(rds_poll_time));
1080 }
1081
1082 /* block if no new data available */
1083 while (radio->wr_index == radio->rd_index) {
1084 if (file->f_flags & O_NONBLOCK) {
1085 retval = -EWOULDBLOCK;
1086 goto done;
1087 }
1088 if (wait_event_interruptible(radio->read_queue,
1089 radio->wr_index != radio->rd_index) < 0) {
1090 retval = -EINTR;
1091 goto done;
1092 }
1093 }
1094
1095 /* calculate block count from byte count */
1096 count /= 3;
1097
1098 /* copy RDS block out of internal buffer and to user buffer */
1099 mutex_lock(&radio->lock);
1100 while (block_count < count) {
1101 if (radio->rd_index == radio->wr_index)
1102 break;
1103
1104 /* always transfer rds complete blocks */
1105 if (copy_to_user(buf, &radio->buffer[radio->rd_index], 3))
1106 /* retval = -EFAULT; */
1107 break;
1108
1109 /* increment and wrap read pointer */
1110 radio->rd_index += 3;
1111 if (radio->rd_index >= radio->buf_size)
1112 radio->rd_index = 0;
1113
1114 /* increment counters */
1115 block_count++;
1116 buf += 3;
1117 retval += 3;
1118 }
1119 mutex_unlock(&radio->lock);
1120
1121 done:
1122 return retval;
1123 }
1124
1125
1126 /*
1127 * si470x_fops_poll - poll RDS data
1128 */
1129 static unsigned int si470x_fops_poll(struct file *file,
1130 struct poll_table_struct *pts)
1131 {
1132 struct si470x_device *radio = video_drvdata(file);
1133 int retval = 0;
1134
1135 /* switch on rds reception */
1136 if ((radio->registers[SYSCONFIG1] & SYSCONFIG1_RDS) == 0) {
1137 si470x_rds_on(radio);
1138 schedule_delayed_work(&radio->work,
1139 msecs_to_jiffies(rds_poll_time));
1140 }
1141
1142 poll_wait(file, &radio->read_queue, pts);
1143
1144 if (radio->rd_index != radio->wr_index)
1145 retval = POLLIN | POLLRDNORM;
1146
1147 return retval;
1148 }
1149
1150
1151 /*
1152 * si470x_fops_open - file open
1153 */
1154 static int si470x_fops_open(struct file *file)
1155 {
1156 struct si470x_device *radio = video_drvdata(file);
1157 int retval;
1158
1159 lock_kernel();
1160 radio->users++;
1161
1162 retval = usb_autopm_get_interface(radio->intf);
1163 if (retval < 0) {
1164 radio->users--;
1165 retval = -EIO;
1166 goto done;
1167 }
1168
1169 if (radio->users == 1) {
1170 /* start radio */
1171 retval = si470x_start(radio);
1172 if (retval < 0)
1173 usb_autopm_put_interface(radio->intf);
1174 }
1175
1176 done:
1177 unlock_kernel();
1178 return retval;
1179 }
1180
1181
1182 /*
1183 * si470x_fops_release - file release
1184 */
1185 static int si470x_fops_release(struct file *file)
1186 {
1187 struct si470x_device *radio = video_drvdata(file);
1188 int retval = 0;
1189
1190 /* safety check */
1191 if (!radio) {
1192 retval = -ENODEV;
1193 goto done;
1194 }
1195
1196 mutex_lock(&radio->disconnect_lock);
1197 radio->users--;
1198 if (radio->users == 0) {
1199 if (radio->disconnected) {
1200 video_unregister_device(radio->videodev);
1201 kfree(radio->buffer);
1202 kfree(radio);
1203 goto done;
1204 }
1205
1206 /* stop rds reception */
1207 cancel_delayed_work_sync(&radio->work);
1208
1209 /* cancel read processes */
1210 wake_up_interruptible(&radio->read_queue);
1211
1212 /* stop radio */
1213 retval = si470x_stop(radio);
1214 usb_autopm_put_interface(radio->intf);
1215 }
1216
1217 mutex_unlock(&radio->disconnect_lock);
1218
1219 done:
1220 return retval;
1221 }
1222
1223
1224 /*
1225 * si470x_fops - file operations interface
1226 */
1227 static const struct v4l2_file_operations si470x_fops = {
1228 .owner = THIS_MODULE,
1229 .read = si470x_fops_read,
1230 .poll = si470x_fops_poll,
1231 .ioctl = video_ioctl2,
1232 .open = si470x_fops_open,
1233 .release = si470x_fops_release,
1234 };
1235
1236
1237
1238 /**************************************************************************
1239 * Video4Linux Interface
1240 **************************************************************************/
1241
1242 /*
1243 * si470x_v4l2_queryctrl - query control
1244 */
1245 static struct v4l2_queryctrl si470x_v4l2_queryctrl[] = {
1246 {
1247 .id = V4L2_CID_AUDIO_VOLUME,
1248 .type = V4L2_CTRL_TYPE_INTEGER,
1249 .name = "Volume",
1250 .minimum = 0,
1251 .maximum = 15,
1252 .step = 1,
1253 .default_value = 15,
1254 },
1255 {
1256 .id = V4L2_CID_AUDIO_MUTE,
1257 .type = V4L2_CTRL_TYPE_BOOLEAN,
1258 .name = "Mute",
1259 .minimum = 0,
1260 .maximum = 1,
1261 .step = 1,
1262 .default_value = 1,
1263 },
1264 };
1265
1266
1267 /*
1268 * si470x_vidioc_querycap - query device capabilities
1269 */
1270 static int si470x_vidioc_querycap(struct file *file, void *priv,
1271 struct v4l2_capability *capability)
1272 {
1273 struct si470x_device *radio = video_drvdata(file);
1274
1275 strlcpy(capability->driver, DRIVER_NAME, sizeof(capability->driver));
1276 strlcpy(capability->card, DRIVER_CARD, sizeof(capability->card));
1277 usb_make_path(radio->usbdev, capability->bus_info, sizeof(capability->bus_info));
1278 capability->version = DRIVER_KERNEL_VERSION;
1279 capability->capabilities = V4L2_CAP_HW_FREQ_SEEK |
1280 V4L2_CAP_TUNER | V4L2_CAP_RADIO;
1281
1282 return 0;
1283 }
1284
1285
1286 /*
1287 * si470x_vidioc_queryctrl - enumerate control items
1288 */
1289 static int si470x_vidioc_queryctrl(struct file *file, void *priv,
1290 struct v4l2_queryctrl *qc)
1291 {
1292 unsigned char i = 0;
1293 int retval = -EINVAL;
1294
1295 /* abort if qc->id is below V4L2_CID_BASE */
1296 if (qc->id < V4L2_CID_BASE)
1297 goto done;
1298
1299 /* search video control */
1300 for (i = 0; i < ARRAY_SIZE(si470x_v4l2_queryctrl); i++) {
1301 if (qc->id == si470x_v4l2_queryctrl[i].id) {
1302 memcpy(qc, &(si470x_v4l2_queryctrl[i]), sizeof(*qc));
1303 retval = 0; /* found */
1304 break;
1305 }
1306 }
1307
1308 /* disable unsupported base controls */
1309 /* to satisfy kradio and such apps */
1310 if ((retval == -EINVAL) && (qc->id < V4L2_CID_LASTP1)) {
1311 qc->flags = V4L2_CTRL_FLAG_DISABLED;
1312 retval = 0;
1313 }
1314
1315 done:
1316 if (retval < 0)
1317 printk(KERN_WARNING DRIVER_NAME
1318 ": query controls failed with %d\n", retval);
1319 return retval;
1320 }
1321
1322
1323 /*
1324 * si470x_vidioc_g_ctrl - get the value of a control
1325 */
1326 static int si470x_vidioc_g_ctrl(struct file *file, void *priv,
1327 struct v4l2_control *ctrl)
1328 {
1329 struct si470x_device *radio = video_drvdata(file);
1330 int retval = 0;
1331
1332 /* safety checks */
1333 if (radio->disconnected) {
1334 retval = -EIO;
1335 goto done;
1336 }
1337
1338 switch (ctrl->id) {
1339 case V4L2_CID_AUDIO_VOLUME:
1340 ctrl->value = radio->registers[SYSCONFIG2] &
1341 SYSCONFIG2_VOLUME;
1342 break;
1343 case V4L2_CID_AUDIO_MUTE:
1344 ctrl->value = ((radio->registers[POWERCFG] &
1345 POWERCFG_DMUTE) == 0) ? 1 : 0;
1346 break;
1347 default:
1348 retval = -EINVAL;
1349 }
1350
1351 done:
1352 if (retval < 0)
1353 printk(KERN_WARNING DRIVER_NAME
1354 ": get control failed with %d\n", retval);
1355 return retval;
1356 }
1357
1358
1359 /*
1360 * si470x_vidioc_s_ctrl - set the value of a control
1361 */
1362 static int si470x_vidioc_s_ctrl(struct file *file, void *priv,
1363 struct v4l2_control *ctrl)
1364 {
1365 struct si470x_device *radio = video_drvdata(file);
1366 int retval = 0;
1367
1368 /* safety checks */
1369 if (radio->disconnected) {
1370 retval = -EIO;
1371 goto done;
1372 }
1373
1374 switch (ctrl->id) {
1375 case V4L2_CID_AUDIO_VOLUME:
1376 radio->registers[SYSCONFIG2] &= ~SYSCONFIG2_VOLUME;
1377 radio->registers[SYSCONFIG2] |= ctrl->value;
1378 retval = si470x_set_register(radio, SYSCONFIG2);
1379 break;
1380 case V4L2_CID_AUDIO_MUTE:
1381 if (ctrl->value == 1)
1382 radio->registers[POWERCFG] &= ~POWERCFG_DMUTE;
1383 else
1384 radio->registers[POWERCFG] |= POWERCFG_DMUTE;
1385 retval = si470x_set_register(radio, POWERCFG);
1386 break;
1387 default:
1388 retval = -EINVAL;
1389 }
1390
1391 done:
1392 if (retval < 0)
1393 printk(KERN_WARNING DRIVER_NAME
1394 ": set control failed with %d\n", retval);
1395 return retval;
1396 }
1397
1398
1399 /*
1400 * si470x_vidioc_g_audio - get audio attributes
1401 */
1402 static int si470x_vidioc_g_audio(struct file *file, void *priv,
1403 struct v4l2_audio *audio)
1404 {
1405 /* driver constants */
1406 audio->index = 0;
1407 strcpy(audio->name, "Radio");
1408 audio->capability = V4L2_AUDCAP_STEREO;
1409 audio->mode = 0;
1410
1411 return 0;
1412 }
1413
1414
1415 /*
1416 * si470x_vidioc_g_tuner - get tuner attributes
1417 */
1418 static int si470x_vidioc_g_tuner(struct file *file, void *priv,
1419 struct v4l2_tuner *tuner)
1420 {
1421 struct si470x_device *radio = video_drvdata(file);
1422 int retval = 0;
1423
1424 /* safety checks */
1425 if (radio->disconnected) {
1426 retval = -EIO;
1427 goto done;
1428 }
1429 if (tuner->index != 0) {
1430 retval = -EINVAL;
1431 goto done;
1432 }
1433
1434 retval = si470x_get_register(radio, STATUSRSSI);
1435 if (retval < 0)
1436 goto done;
1437
1438 /* driver constants */
1439 strcpy(tuner->name, "FM");
1440 tuner->type = V4L2_TUNER_RADIO;
1441 tuner->capability = V4L2_TUNER_CAP_LOW | V4L2_TUNER_CAP_STEREO;
1442
1443 /* range limits */
1444 switch ((radio->registers[SYSCONFIG2] & SYSCONFIG2_BAND) >> 6) {
1445 /* 0: 87.5 - 108 MHz (USA, Europe, default) */
1446 default:
1447 tuner->rangelow = 87.5 * FREQ_MUL;
1448 tuner->rangehigh = 108 * FREQ_MUL;
1449 break;
1450 /* 1: 76 - 108 MHz (Japan wide band) */
1451 case 1 :
1452 tuner->rangelow = 76 * FREQ_MUL;
1453 tuner->rangehigh = 108 * FREQ_MUL;
1454 break;
1455 /* 2: 76 - 90 MHz (Japan) */
1456 case 2 :
1457 tuner->rangelow = 76 * FREQ_MUL;
1458 tuner->rangehigh = 90 * FREQ_MUL;
1459 break;
1460 };
1461
1462 /* stereo indicator == stereo (instead of mono) */
1463 if ((radio->registers[STATUSRSSI] & STATUSRSSI_ST) == 0)
1464 tuner->rxsubchans = V4L2_TUNER_SUB_MONO;
1465 else
1466 tuner->rxsubchans = V4L2_TUNER_SUB_MONO | V4L2_TUNER_SUB_STEREO;
1467
1468 /* mono/stereo selector */
1469 if ((radio->registers[POWERCFG] & POWERCFG_MONO) == 0)
1470 tuner->audmode = V4L2_TUNER_MODE_STEREO;
1471 else
1472 tuner->audmode = V4L2_TUNER_MODE_MONO;
1473
1474 /* min is worst, max is best; signal:0..0xffff; rssi: 0..0xff */
1475 /* measured in units of dbµV in 1 db increments (max at ~75 dbµV) */
1476 tuner->signal = (radio->registers[STATUSRSSI] & STATUSRSSI_RSSI);
1477 /* the ideal factor is 0xffff/75 = 873,8 */
1478 tuner->signal = (tuner->signal * 873) + (8 * tuner->signal / 10);
1479
1480 /* automatic frequency control: -1: freq to low, 1 freq to high */
1481 /* AFCRL does only indicate that freq. differs, not if too low/high */
1482 tuner->afc = (radio->registers[STATUSRSSI] & STATUSRSSI_AFCRL) ? 1 : 0;
1483
1484 done:
1485 if (retval < 0)
1486 printk(KERN_WARNING DRIVER_NAME
1487 ": get tuner failed with %d\n", retval);
1488 return retval;
1489 }
1490
1491
1492 /*
1493 * si470x_vidioc_s_tuner - set tuner attributes
1494 */
1495 static int si470x_vidioc_s_tuner(struct file *file, void *priv,
1496 struct v4l2_tuner *tuner)
1497 {
1498 struct si470x_device *radio = video_drvdata(file);
1499 int retval = -EINVAL;
1500
1501 /* safety checks */
1502 if (radio->disconnected) {
1503 retval = -EIO;
1504 goto done;
1505 }
1506 if (tuner->index != 0)
1507 goto done;
1508
1509 /* mono/stereo selector */
1510 switch (tuner->audmode) {
1511 case V4L2_TUNER_MODE_MONO:
1512 radio->registers[POWERCFG] |= POWERCFG_MONO; /* force mono */
1513 break;
1514 case V4L2_TUNER_MODE_STEREO:
1515 radio->registers[POWERCFG] &= ~POWERCFG_MONO; /* try stereo */
1516 break;
1517 default:
1518 goto done;
1519 }
1520
1521 retval = si470x_set_register(radio, POWERCFG);
1522
1523 done:
1524 if (retval < 0)
1525 printk(KERN_WARNING DRIVER_NAME
1526 ": set tuner failed with %d\n", retval);
1527 return retval;
1528 }
1529
1530
1531 /*
1532 * si470x_vidioc_g_frequency - get tuner or modulator radio frequency
1533 */
1534 static int si470x_vidioc_g_frequency(struct file *file, void *priv,
1535 struct v4l2_frequency *freq)
1536 {
1537 struct si470x_device *radio = video_drvdata(file);
1538 int retval = 0;
1539
1540 /* safety checks */
1541 if (radio->disconnected) {
1542 retval = -EIO;
1543 goto done;
1544 }
1545 if (freq->tuner != 0) {
1546 retval = -EINVAL;
1547 goto done;
1548 }
1549
1550 freq->type = V4L2_TUNER_RADIO;
1551 retval = si470x_get_freq(radio, &freq->frequency);
1552
1553 done:
1554 if (retval < 0)
1555 printk(KERN_WARNING DRIVER_NAME
1556 ": get frequency failed with %d\n", retval);
1557 return retval;
1558 }
1559
1560
1561 /*
1562 * si470x_vidioc_s_frequency - set tuner or modulator radio frequency
1563 */
1564 static int si470x_vidioc_s_frequency(struct file *file, void *priv,
1565 struct v4l2_frequency *freq)
1566 {
1567 struct si470x_device *radio = video_drvdata(file);
1568 int retval = 0;
1569
1570 /* safety checks */
1571 if (radio->disconnected) {
1572 retval = -EIO;
1573 goto done;
1574 }
1575 if (freq->tuner != 0) {
1576 retval = -EINVAL;
1577 goto done;
1578 }
1579
1580 retval = si470x_set_freq(radio, freq->frequency);
1581
1582 done:
1583 if (retval < 0)
1584 printk(KERN_WARNING DRIVER_NAME
1585 ": set frequency failed with %d\n", retval);
1586 return retval;
1587 }
1588
1589
1590 /*
1591 * si470x_vidioc_s_hw_freq_seek - set hardware frequency seek
1592 */
1593 static int si470x_vidioc_s_hw_freq_seek(struct file *file, void *priv,
1594 struct v4l2_hw_freq_seek *seek)
1595 {
1596 struct si470x_device *radio = video_drvdata(file);
1597 int retval = 0;
1598
1599 /* safety checks */
1600 if (radio->disconnected) {
1601 retval = -EIO;
1602 goto done;
1603 }
1604 if (seek->tuner != 0) {
1605 retval = -EINVAL;
1606 goto done;
1607 }
1608
1609 retval = si470x_set_seek(radio, seek->wrap_around, seek->seek_upward);
1610
1611 done:
1612 if (retval < 0)
1613 printk(KERN_WARNING DRIVER_NAME
1614 ": set hardware frequency seek failed with %d\n",
1615 retval);
1616 return retval;
1617 }
1618
1619
1620 /*
1621 * si470x_ioctl_ops - video device ioctl operations
1622 */
1623 static const struct v4l2_ioctl_ops si470x_ioctl_ops = {
1624 .vidioc_querycap = si470x_vidioc_querycap,
1625 .vidioc_queryctrl = si470x_vidioc_queryctrl,
1626 .vidioc_g_ctrl = si470x_vidioc_g_ctrl,
1627 .vidioc_s_ctrl = si470x_vidioc_s_ctrl,
1628 .vidioc_g_audio = si470x_vidioc_g_audio,
1629 .vidioc_g_tuner = si470x_vidioc_g_tuner,
1630 .vidioc_s_tuner = si470x_vidioc_s_tuner,
1631 .vidioc_g_frequency = si470x_vidioc_g_frequency,
1632 .vidioc_s_frequency = si470x_vidioc_s_frequency,
1633 .vidioc_s_hw_freq_seek = si470x_vidioc_s_hw_freq_seek,
1634 };
1635
1636
1637 /*
1638 * si470x_viddev_template - video device interface
1639 */
1640 static struct video_device si470x_viddev_template = {
1641 .fops = &si470x_fops,
1642 .name = DRIVER_NAME,
1643 .release = video_device_release,
1644 .ioctl_ops = &si470x_ioctl_ops,
1645 };
1646
1647
1648
1649 /**************************************************************************
1650 * USB Interface
1651 **************************************************************************/
1652
1653 /*
1654 * si470x_usb_driver_probe - probe for the device
1655 */
1656 static int si470x_usb_driver_probe(struct usb_interface *intf,
1657 const struct usb_device_id *id)
1658 {
1659 struct si470x_device *radio;
1660 int retval = 0;
1661
1662 /* private data allocation and initialization */
1663 radio = kzalloc(sizeof(struct si470x_device), GFP_KERNEL);
1664 if (!radio) {
1665 retval = -ENOMEM;
1666 goto err_initial;
1667 }
1668 radio->users = 0;
1669 radio->disconnected = 0;
1670 radio->usbdev = interface_to_usbdev(intf);
1671 radio->intf = intf;
1672 mutex_init(&radio->disconnect_lock);
1673 mutex_init(&radio->lock);
1674
1675 /* video device allocation and initialization */
1676 radio->videodev = video_device_alloc();
1677 if (!radio->videodev) {
1678 retval = -ENOMEM;
1679 goto err_radio;
1680 }
1681 memcpy(radio->videodev, &si470x_viddev_template,
1682 sizeof(si470x_viddev_template));
1683 video_set_drvdata(radio->videodev, radio);
1684
1685 /* show some infos about the specific si470x device */
1686 if (si470x_get_all_registers(radio) < 0) {
1687 retval = -EIO;
1688 goto err_video;
1689 }
1690 printk(KERN_INFO DRIVER_NAME ": DeviceID=0x%4.4hx ChipID=0x%4.4hx\n",
1691 radio->registers[DEVICEID], radio->registers[CHIPID]);
1692
1693 /* get software and hardware versions */
1694 if (si470x_get_scratch_page_versions(radio) < 0) {
1695 retval = -EIO;
1696 goto err_video;
1697 }
1698 printk(KERN_INFO DRIVER_NAME
1699 ": software version %d, hardware version %d\n",
1700 radio->software_version, radio->hardware_version);
1701
1702 /* check if device and firmware is current */
1703 if ((radio->registers[CHIPID] & CHIPID_FIRMWARE)
1704 < RADIO_SW_VERSION_CURRENT) {
1705 printk(KERN_WARNING DRIVER_NAME
1706 ": This driver is known to work with "
1707 "firmware version %hu,\n", RADIO_SW_VERSION_CURRENT);
1708 printk(KERN_WARNING DRIVER_NAME
1709 ": but the device has firmware version %hu.\n",
1710 radio->registers[CHIPID] & CHIPID_FIRMWARE);
1711 printk(KERN_WARNING DRIVER_NAME
1712 ": If you have some trouble using this driver,\n");
1713 printk(KERN_WARNING DRIVER_NAME
1714 ": please report to V4L ML at "
1715 "linux-media@vger.kernel.org\n");
1716 }
1717
1718 /* set initial frequency */
1719 si470x_set_freq(radio, 87.5 * FREQ_MUL); /* available in all regions */
1720
1721 /* set led to connect state */
1722 si470x_set_led_state(radio, BLINK_GREEN_LED);
1723
1724 /* rds buffer allocation */
1725 radio->buf_size = rds_buf * 3;
1726 radio->buffer = kmalloc(radio->buf_size, GFP_KERNEL);
1727 if (!radio->buffer) {
1728 retval = -EIO;
1729 goto err_video;
1730 }
1731
1732 /* rds buffer configuration */
1733 radio->wr_index = 0;
1734 radio->rd_index = 0;
1735 init_waitqueue_head(&radio->read_queue);
1736
1737 /* prepare rds work function */
1738 INIT_DELAYED_WORK(&radio->work, si470x_work);
1739
1740 /* register video device */
1741 retval = video_register_device(radio->videodev, VFL_TYPE_RADIO, radio_nr);
1742 if (retval) {
1743 printk(KERN_WARNING DRIVER_NAME
1744 ": Could not register video device\n");
1745 goto err_all;
1746 }
1747 usb_set_intfdata(intf, radio);
1748
1749 return 0;
1750 err_all:
1751 kfree(radio->buffer);
1752 err_video:
1753 video_device_release(radio->videodev);
1754 err_radio:
1755 kfree(radio);
1756 err_initial:
1757 return retval;
1758 }
1759
1760
1761 /*
1762 * si470x_usb_driver_suspend - suspend the device
1763 */
1764 static int si470x_usb_driver_suspend(struct usb_interface *intf,
1765 pm_message_t message)
1766 {
1767 struct si470x_device *radio = usb_get_intfdata(intf);
1768
1769 printk(KERN_INFO DRIVER_NAME ": suspending now...\n");
1770
1771 cancel_delayed_work_sync(&radio->work);
1772
1773 return 0;
1774 }
1775
1776
1777 /*
1778 * si470x_usb_driver_resume - resume the device
1779 */
1780 static int si470x_usb_driver_resume(struct usb_interface *intf)
1781 {
1782 struct si470x_device *radio = usb_get_intfdata(intf);
1783
1784 printk(KERN_INFO DRIVER_NAME ": resuming now...\n");
1785
1786 mutex_lock(&radio->lock);
1787 if (radio->users && radio->registers[SYSCONFIG1] & SYSCONFIG1_RDS)
1788 schedule_delayed_work(&radio->work,
1789 msecs_to_jiffies(rds_poll_time));
1790 mutex_unlock(&radio->lock);
1791
1792 return 0;
1793 }
1794
1795
1796 /*
1797 * si470x_usb_driver_disconnect - disconnect the device
1798 */
1799 static void si470x_usb_driver_disconnect(struct usb_interface *intf)
1800 {
1801 struct si470x_device *radio = usb_get_intfdata(intf);
1802
1803 mutex_lock(&radio->disconnect_lock);
1804 radio->disconnected = 1;
1805 cancel_delayed_work_sync(&radio->work);
1806 usb_set_intfdata(intf, NULL);
1807 if (radio->users == 0) {
1808 /* set led to disconnect state */
1809 si470x_set_led_state(radio, BLINK_ORANGE_LED);
1810
1811 video_unregister_device(radio->videodev);
1812 kfree(radio->buffer);
1813 kfree(radio);
1814 }
1815 mutex_unlock(&radio->disconnect_lock);
1816 }
1817
1818
1819 /*
1820 * si470x_usb_driver - usb driver interface
1821 */
1822 static struct usb_driver si470x_usb_driver = {
1823 .name = DRIVER_NAME,
1824 .probe = si470x_usb_driver_probe,
1825 .disconnect = si470x_usb_driver_disconnect,
1826 .suspend = si470x_usb_driver_suspend,
1827 .resume = si470x_usb_driver_resume,
1828 .id_table = si470x_usb_driver_id_table,
1829 .supports_autosuspend = 1,
1830 };
1831
1832
1833
1834 /**************************************************************************
1835 * Module Interface
1836 **************************************************************************/
1837
1838 /*
1839 * si470x_module_init - module init
1840 */
1841 static int __init si470x_module_init(void)
1842 {
1843 printk(KERN_INFO DRIVER_DESC ", Version " DRIVER_VERSION "\n");
1844 return usb_register(&si470x_usb_driver);
1845 }
1846
1847
1848 /*
1849 * si470x_module_exit - module exit
1850 */
1851 static void __exit si470x_module_exit(void)
1852 {
1853 usb_deregister(&si470x_usb_driver);
1854 }
1855
1856
1857 module_init(si470x_module_init);
1858 module_exit(si470x_module_exit);
1859
1860 MODULE_LICENSE("GPL");
1861 MODULE_AUTHOR(DRIVER_AUTHOR);
1862 MODULE_DESCRIPTION(DRIVER_DESC);
1863 MODULE_VERSION(DRIVER_VERSION);
Linux kernel - Deliverables
This page took 0.073784 seconds and 6 git commands to generate.