2 * FM Driver for Connectivity chip of Texas Instruments.
3 * This file provides interfaces to V4L2 subsystem.
5 * This module registers with V4L2 subsystem as Radio
6 * data system interface (/dev/radio). During the registration,
7 * it will expose two set of function pointers.
9 * 1) File operation related API (open, close, read, write, poll...etc).
10 * 2) Set of V4L2 IOCTL complaint API.
12 * Copyright (C) 2011 Texas Instruments
13 * Author: Raja Mani <raja_mani@ti.com>
14 * Author: Manjunatha Halli <manjunatha_halli@ti.com>
16 * This program is free software; you can redistribute it and/or modify
17 * it under the terms of the GNU General Public License version 2 as
18 * published by the Free Software Foundation.
20 * This program is distributed in the hope that it will be useful,
21 * but WITHOUT ANY WARRANTY; without even the implied warranty of
22 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
23 * GNU General Public License for more details.
25 * You should have received a copy of the GNU General Public License
26 * along with this program; if not, write to the Free Software
27 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
31 #include <linux/export.h>
34 #include "fmdrv_v4l2.h"
35 #include "fmdrv_common.h"
39 static struct video_device
*gradio_dev
;
40 static u8 radio_disconnected
;
42 /* -- V4L2 RADIO (/dev/radioX) device file operation interfaces --- */
44 /* Read RX RDS data */
45 static ssize_t
fm_v4l2_fops_read(struct file
*file
, char __user
* buf
,
46 size_t count
, loff_t
*ppos
)
52 fmdev
= video_drvdata(file
);
54 if (!radio_disconnected
) {
55 fmerr("FM device is already disconnected\n");
59 if (mutex_lock_interruptible(&fmdev
->mutex
))
62 /* Turn on RDS mode if it is disabled */
63 ret
= fm_rx_get_rds_mode(fmdev
, &rds_mode
);
65 fmerr("Unable to read current rds mode\n");
69 if (rds_mode
== FM_RDS_DISABLE
) {
70 ret
= fmc_set_rds_mode(fmdev
, FM_RDS_ENABLE
);
72 fmerr("Failed to enable rds mode\n");
77 /* Copy RDS data from internal buffer to user buffer */
78 ret
= fmc_transfer_rds_from_internal_buff(fmdev
, file
, buf
, count
);
80 mutex_unlock(&fmdev
->mutex
);
84 /* Write TX RDS data */
85 static ssize_t
fm_v4l2_fops_write(struct file
*file
, const char __user
* buf
,
86 size_t count
, loff_t
*ppos
)
92 ret
= copy_from_user(&rds
, buf
, sizeof(rds
));
93 rds
.text
[sizeof(rds
.text
) - 1] = '\0';
94 fmdbg("(%d)type: %d, text %s, af %d\n",
95 ret
, rds
.text_type
, rds
.text
, rds
.af_freq
);
99 fmdev
= video_drvdata(file
);
100 if (mutex_lock_interruptible(&fmdev
->mutex
))
102 fm_tx_set_radio_text(fmdev
, rds
.text
, rds
.text_type
);
103 fm_tx_set_af(fmdev
, rds
.af_freq
);
104 mutex_unlock(&fmdev
->mutex
);
109 static u32
fm_v4l2_fops_poll(struct file
*file
, struct poll_table_struct
*pts
)
114 fmdev
= video_drvdata(file
);
115 mutex_lock(&fmdev
->mutex
);
116 ret
= fmc_is_rds_data_available(fmdev
, file
, pts
);
117 mutex_unlock(&fmdev
->mutex
);
119 return POLLIN
| POLLRDNORM
;
125 * Handle open request for "/dev/radioX" device.
126 * Start with FM RX mode as default.
128 static int fm_v4l2_fops_open(struct file
*file
)
131 struct fmdev
*fmdev
= NULL
;
133 /* Don't allow multiple open */
134 if (radio_disconnected
) {
135 fmerr("FM device is already opened\n");
139 fmdev
= video_drvdata(file
);
141 if (mutex_lock_interruptible(&fmdev
->mutex
))
143 ret
= fmc_prepare(fmdev
);
145 fmerr("Unable to prepare FM CORE\n");
149 fmdbg("Load FM RX firmware..\n");
151 ret
= fmc_set_mode(fmdev
, FM_MODE_RX
);
153 fmerr("Unable to load FM RX firmware\n");
156 radio_disconnected
= 1;
159 mutex_unlock(&fmdev
->mutex
);
163 static int fm_v4l2_fops_release(struct file
*file
)
168 fmdev
= video_drvdata(file
);
169 if (!radio_disconnected
) {
170 fmdbg("FM device is already closed\n");
174 mutex_lock(&fmdev
->mutex
);
175 ret
= fmc_set_mode(fmdev
, FM_MODE_OFF
);
177 fmerr("Unable to turn off the chip\n");
181 ret
= fmc_release(fmdev
);
183 fmerr("FM CORE release failed\n");
186 radio_disconnected
= 0;
189 mutex_unlock(&fmdev
->mutex
);
193 /* V4L2 RADIO (/dev/radioX) device IOCTL interfaces */
194 static int fm_v4l2_vidioc_querycap(struct file
*file
, void *priv
,
195 struct v4l2_capability
*capability
)
197 strlcpy(capability
->driver
, FM_DRV_NAME
, sizeof(capability
->driver
));
198 strlcpy(capability
->card
, FM_DRV_CARD_SHORT_NAME
,
199 sizeof(capability
->card
));
200 sprintf(capability
->bus_info
, "UART");
201 capability
->capabilities
= V4L2_CAP_HW_FREQ_SEEK
| V4L2_CAP_TUNER
|
202 V4L2_CAP_RADIO
| V4L2_CAP_MODULATOR
|
203 V4L2_CAP_AUDIO
| V4L2_CAP_READWRITE
|
204 V4L2_CAP_RDS_CAPTURE
;
209 static int fm_g_volatile_ctrl(struct v4l2_ctrl
*ctrl
)
211 struct fmdev
*fmdev
= container_of(ctrl
->handler
,
212 struct fmdev
, ctrl_handler
);
215 case V4L2_CID_TUNE_ANTENNA_CAPACITOR
:
216 ctrl
->val
= fm_tx_get_tune_cap_val(fmdev
);
219 fmwarn("%s: Unknown IOCTL: %d\n", __func__
, ctrl
->id
);
226 static int fm_v4l2_s_ctrl(struct v4l2_ctrl
*ctrl
)
228 struct fmdev
*fmdev
= container_of(ctrl
->handler
,
229 struct fmdev
, ctrl_handler
);
232 case V4L2_CID_AUDIO_VOLUME
: /* set volume */
233 return fm_rx_set_volume(fmdev
, (u16
)ctrl
->val
);
235 case V4L2_CID_AUDIO_MUTE
: /* set mute */
236 return fmc_set_mute_mode(fmdev
, (u8
)ctrl
->val
);
238 case V4L2_CID_TUNE_POWER_LEVEL
:
239 /* set TX power level - ext control */
240 return fm_tx_set_pwr_lvl(fmdev
, (u8
)ctrl
->val
);
242 case V4L2_CID_TUNE_PREEMPHASIS
:
243 return fm_tx_set_preemph_filter(fmdev
, (u8
) ctrl
->val
);
250 static int fm_v4l2_vidioc_g_audio(struct file
*file
, void *priv
,
251 struct v4l2_audio
*audio
)
253 memset(audio
, 0, sizeof(*audio
));
254 strcpy(audio
->name
, "Radio");
255 audio
->capability
= V4L2_AUDCAP_STEREO
;
260 static int fm_v4l2_vidioc_s_audio(struct file
*file
, void *priv
,
261 const struct v4l2_audio
*audio
)
263 if (audio
->index
!= 0)
269 /* Get tuner attributes. If current mode is NOT RX, return error */
270 static int fm_v4l2_vidioc_g_tuner(struct file
*file
, void *priv
,
271 struct v4l2_tuner
*tuner
)
273 struct fmdev
*fmdev
= video_drvdata(file
);
276 u16 stereo_mono_mode
;
280 if (tuner
->index
!= 0)
283 if (fmdev
->curr_fmmode
!= FM_MODE_RX
)
286 ret
= fm_rx_get_band_freq_range(fmdev
, &bottom_freq
, &top_freq
);
290 ret
= fm_rx_get_stereo_mono(fmdev
, &stereo_mono_mode
);
294 ret
= fm_rx_get_rssi_level(fmdev
, &rssilvl
);
298 strcpy(tuner
->name
, "FM");
299 tuner
->type
= V4L2_TUNER_RADIO
;
300 /* Store rangelow and rangehigh freq in unit of 62.5 Hz */
301 tuner
->rangelow
= bottom_freq
* 16;
302 tuner
->rangehigh
= top_freq
* 16;
303 tuner
->rxsubchans
= V4L2_TUNER_SUB_MONO
| V4L2_TUNER_SUB_STEREO
|
304 ((fmdev
->rx
.rds
.flag
== FM_RDS_ENABLE
) ? V4L2_TUNER_SUB_RDS
: 0);
305 tuner
->capability
= V4L2_TUNER_CAP_STEREO
| V4L2_TUNER_CAP_RDS
|
307 V4L2_TUNER_CAP_HWSEEK_BOUNDED
|
308 V4L2_TUNER_CAP_HWSEEK_WRAP
;
309 tuner
->audmode
= (stereo_mono_mode
?
310 V4L2_TUNER_MODE_MONO
: V4L2_TUNER_MODE_STEREO
);
313 * Actual rssi value lies in between -128 to +127.
314 * Convert this range from 0 to 255 by adding +128
319 * Return signal strength value should be within 0 to 65535.
320 * Find out correct signal radio by multiplying (65535/255) = 257
322 tuner
->signal
= rssilvl
* 257;
329 * Set tuner attributes. If current mode is NOT RX, set to RX.
330 * Currently, we set only audio mode (mono/stereo) and RDS state (on/off).
331 * Should we set other tuner attributes, too?
333 static int fm_v4l2_vidioc_s_tuner(struct file
*file
, void *priv
,
334 const struct v4l2_tuner
*tuner
)
336 struct fmdev
*fmdev
= video_drvdata(file
);
341 if (tuner
->index
!= 0)
344 aud_mode
= (tuner
->audmode
== V4L2_TUNER_MODE_STEREO
) ?
345 FM_STEREO_MODE
: FM_MONO_MODE
;
346 rds_mode
= (tuner
->rxsubchans
& V4L2_TUNER_SUB_RDS
) ?
347 FM_RDS_ENABLE
: FM_RDS_DISABLE
;
349 if (fmdev
->curr_fmmode
!= FM_MODE_RX
) {
350 ret
= fmc_set_mode(fmdev
, FM_MODE_RX
);
352 fmerr("Failed to set RX mode\n");
357 ret
= fmc_set_stereo_mono(fmdev
, aud_mode
);
359 fmerr("Failed to set RX stereo/mono mode\n");
363 ret
= fmc_set_rds_mode(fmdev
, rds_mode
);
365 fmerr("Failed to set RX RDS mode\n");
370 /* Get tuner or modulator radio frequency */
371 static int fm_v4l2_vidioc_g_freq(struct file
*file
, void *priv
,
372 struct v4l2_frequency
*freq
)
374 struct fmdev
*fmdev
= video_drvdata(file
);
377 ret
= fmc_get_freq(fmdev
, &freq
->frequency
);
379 fmerr("Failed to get frequency\n");
383 /* Frequency unit of 62.5 Hz*/
384 freq
->frequency
= (u32
) freq
->frequency
* 16;
389 /* Set tuner or modulator radio frequency */
390 static int fm_v4l2_vidioc_s_freq(struct file
*file
, void *priv
,
391 const struct v4l2_frequency
*freq
)
393 struct fmdev
*fmdev
= video_drvdata(file
);
396 * As V4L2_TUNER_CAP_LOW is set 1 user sends the frequency
397 * in units of 62.5 Hz.
399 return fmc_set_freq(fmdev
, freq
->frequency
/ 16);
402 /* Set hardware frequency seek. If current mode is NOT RX, set it RX. */
403 static int fm_v4l2_vidioc_s_hw_freq_seek(struct file
*file
, void *priv
,
404 const struct v4l2_hw_freq_seek
*seek
)
406 struct fmdev
*fmdev
= video_drvdata(file
);
409 if (file
->f_flags
& O_NONBLOCK
)
412 if (fmdev
->curr_fmmode
!= FM_MODE_RX
) {
413 ret
= fmc_set_mode(fmdev
, FM_MODE_RX
);
415 fmerr("Failed to set RX mode\n");
420 ret
= fm_rx_seek(fmdev
, seek
->seek_upward
, seek
->wrap_around
,
423 fmerr("RX seek failed - %d\n", ret
);
427 /* Get modulator attributes. If mode is not TX, return no attributes. */
428 static int fm_v4l2_vidioc_g_modulator(struct file
*file
, void *priv
,
429 struct v4l2_modulator
*mod
)
431 struct fmdev
*fmdev
= video_drvdata(file
);
436 if (fmdev
->curr_fmmode
!= FM_MODE_TX
)
439 mod
->txsubchans
= ((fmdev
->tx_data
.aud_mode
== FM_STEREO_MODE
) ?
440 V4L2_TUNER_SUB_STEREO
: V4L2_TUNER_SUB_MONO
) |
441 ((fmdev
->tx_data
.rds
.flag
== FM_RDS_ENABLE
) ?
442 V4L2_TUNER_SUB_RDS
: 0);
444 mod
->capability
= V4L2_TUNER_CAP_STEREO
| V4L2_TUNER_CAP_RDS
|
450 /* Set modulator attributes. If mode is not TX, set to TX. */
451 static int fm_v4l2_vidioc_s_modulator(struct file
*file
, void *priv
,
452 const struct v4l2_modulator
*mod
)
454 struct fmdev
*fmdev
= video_drvdata(file
);
462 if (fmdev
->curr_fmmode
!= FM_MODE_TX
) {
463 ret
= fmc_set_mode(fmdev
, FM_MODE_TX
);
465 fmerr("Failed to set TX mode\n");
470 aud_mode
= (mod
->txsubchans
& V4L2_TUNER_SUB_STEREO
) ?
471 FM_STEREO_MODE
: FM_MONO_MODE
;
472 rds_mode
= (mod
->txsubchans
& V4L2_TUNER_SUB_RDS
) ?
473 FM_RDS_ENABLE
: FM_RDS_DISABLE
;
474 ret
= fm_tx_set_stereo_mono(fmdev
, aud_mode
);
476 fmerr("Failed to set mono/stereo mode for TX\n");
479 ret
= fm_tx_set_rds_mode(fmdev
, rds_mode
);
481 fmerr("Failed to set rds mode for TX\n");
486 static const struct v4l2_file_operations fm_drv_fops
= {
487 .owner
= THIS_MODULE
,
488 .read
= fm_v4l2_fops_read
,
489 .write
= fm_v4l2_fops_write
,
490 .poll
= fm_v4l2_fops_poll
,
491 .unlocked_ioctl
= video_ioctl2
,
492 .open
= fm_v4l2_fops_open
,
493 .release
= fm_v4l2_fops_release
,
496 static const struct v4l2_ctrl_ops fm_ctrl_ops
= {
497 .s_ctrl
= fm_v4l2_s_ctrl
,
498 .g_volatile_ctrl
= fm_g_volatile_ctrl
,
500 static const struct v4l2_ioctl_ops fm_drv_ioctl_ops
= {
501 .vidioc_querycap
= fm_v4l2_vidioc_querycap
,
502 .vidioc_g_audio
= fm_v4l2_vidioc_g_audio
,
503 .vidioc_s_audio
= fm_v4l2_vidioc_s_audio
,
504 .vidioc_g_tuner
= fm_v4l2_vidioc_g_tuner
,
505 .vidioc_s_tuner
= fm_v4l2_vidioc_s_tuner
,
506 .vidioc_g_frequency
= fm_v4l2_vidioc_g_freq
,
507 .vidioc_s_frequency
= fm_v4l2_vidioc_s_freq
,
508 .vidioc_s_hw_freq_seek
= fm_v4l2_vidioc_s_hw_freq_seek
,
509 .vidioc_g_modulator
= fm_v4l2_vidioc_g_modulator
,
510 .vidioc_s_modulator
= fm_v4l2_vidioc_s_modulator
513 /* V4L2 RADIO device parent structure */
514 static struct video_device fm_viddev_template
= {
515 .fops
= &fm_drv_fops
,
516 .ioctl_ops
= &fm_drv_ioctl_ops
,
518 .release
= video_device_release
,
520 * To ensure both the tuner and modulator ioctls are accessible we
521 * set the vfl_dir to M2M to indicate this.
523 * It is not really a mem2mem device of course, but it can both receive
524 * and transmit using the same radio device. It's the only radio driver
525 * that does this and it should really be split in two radio devices,
526 * but that would affect applications using this driver.
528 .vfl_dir
= VFL_DIR_M2M
,
531 int fm_v4l2_init_video_device(struct fmdev
*fmdev
, int radio_nr
)
533 struct v4l2_ctrl
*ctrl
;
536 strlcpy(fmdev
->v4l2_dev
.name
, FM_DRV_NAME
, sizeof(fmdev
->v4l2_dev
.name
));
537 ret
= v4l2_device_register(NULL
, &fmdev
->v4l2_dev
);
541 /* Init mutex for core locking */
542 mutex_init(&fmdev
->mutex
);
544 /* Allocate new video device */
545 gradio_dev
= video_device_alloc();
546 if (NULL
== gradio_dev
) {
547 fmerr("Can't allocate video device\n");
551 /* Setup FM driver's V4L2 properties */
552 memcpy(gradio_dev
, &fm_viddev_template
, sizeof(fm_viddev_template
));
554 video_set_drvdata(gradio_dev
, fmdev
);
556 gradio_dev
->lock
= &fmdev
->mutex
;
557 gradio_dev
->v4l2_dev
= &fmdev
->v4l2_dev
;
559 /* Register with V4L2 subsystem as RADIO device */
560 if (video_register_device(gradio_dev
, VFL_TYPE_RADIO
, radio_nr
)) {
561 video_device_release(gradio_dev
);
562 fmerr("Could not register video device\n");
566 fmdev
->radio_dev
= gradio_dev
;
568 /* Register to v4l2 ctrl handler framework */
569 fmdev
->radio_dev
->ctrl_handler
= &fmdev
->ctrl_handler
;
571 ret
= v4l2_ctrl_handler_init(&fmdev
->ctrl_handler
, 5);
573 fmerr("(fmdev): Can't init ctrl handler\n");
574 v4l2_ctrl_handler_free(&fmdev
->ctrl_handler
);
579 * Following controls are handled by V4L2 control framework.
580 * Added in ascending ID order.
582 v4l2_ctrl_new_std(&fmdev
->ctrl_handler
, &fm_ctrl_ops
,
583 V4L2_CID_AUDIO_VOLUME
, FM_RX_VOLUME_MIN
,
584 FM_RX_VOLUME_MAX
, 1, FM_RX_VOLUME_MAX
);
586 v4l2_ctrl_new_std(&fmdev
->ctrl_handler
, &fm_ctrl_ops
,
587 V4L2_CID_AUDIO_MUTE
, 0, 1, 1, 1);
589 v4l2_ctrl_new_std_menu(&fmdev
->ctrl_handler
, &fm_ctrl_ops
,
590 V4L2_CID_TUNE_PREEMPHASIS
, V4L2_PREEMPHASIS_75_uS
,
591 0, V4L2_PREEMPHASIS_75_uS
);
593 v4l2_ctrl_new_std(&fmdev
->ctrl_handler
, &fm_ctrl_ops
,
594 V4L2_CID_TUNE_POWER_LEVEL
, FM_PWR_LVL_LOW
,
595 FM_PWR_LVL_HIGH
, 1, FM_PWR_LVL_HIGH
);
597 ctrl
= v4l2_ctrl_new_std(&fmdev
->ctrl_handler
, &fm_ctrl_ops
,
598 V4L2_CID_TUNE_ANTENNA_CAPACITOR
, 0,
602 ctrl
->flags
|= V4L2_CTRL_FLAG_VOLATILE
;
607 void *fm_v4l2_deinit_video_device(void)
612 fmdev
= video_get_drvdata(gradio_dev
);
614 /* Unregister to v4l2 ctrl handler framework*/
615 v4l2_ctrl_handler_free(&fmdev
->ctrl_handler
);
617 /* Unregister RADIO device from V4L2 subsystem */
618 video_unregister_device(gradio_dev
);
620 v4l2_device_unregister(&fmdev
->v4l2_dev
);