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