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