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