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