drivers/media/radio/radio-si470x.c

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