drivers/media/radio/radio-si470x.c

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