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.
27 #include <linux/export.h>
30 #include "fmdrv_v4l2.h"
31 #include "fmdrv_common.h"
35 static struct video_device gradio_dev
;
36 static u8 radio_disconnected
;
38 /* -- V4L2 RADIO (/dev/radioX) device file operation interfaces --- */
40 /* Read RX RDS data */
41 static ssize_t
fm_v4l2_fops_read(struct file
*file
, char __user
* buf
,
42 size_t count
, loff_t
*ppos
)
48 fmdev
= video_drvdata(file
);
50 if (!radio_disconnected
) {
51 fmerr("FM device is already disconnected\n");
55 if (mutex_lock_interruptible(&fmdev
->mutex
))
58 /* Turn on RDS mode if it is disabled */
59 ret
= fm_rx_get_rds_mode(fmdev
, &rds_mode
);
61 fmerr("Unable to read current rds mode\n");
65 if (rds_mode
== FM_RDS_DISABLE
) {
66 ret
= fmc_set_rds_mode(fmdev
, FM_RDS_ENABLE
);
68 fmerr("Failed to enable rds mode\n");
73 /* Copy RDS data from internal buffer to user buffer */
74 ret
= fmc_transfer_rds_from_internal_buff(fmdev
, file
, buf
, count
);
76 mutex_unlock(&fmdev
->mutex
);
80 /* Write TX RDS data */
81 static ssize_t
fm_v4l2_fops_write(struct file
*file
, const char __user
* buf
,
82 size_t count
, loff_t
*ppos
)
88 ret
= copy_from_user(&rds
, buf
, sizeof(rds
));
89 rds
.text
[sizeof(rds
.text
) - 1] = '\0';
90 fmdbg("(%d)type: %d, text %s, af %d\n",
91 ret
, rds
.text_type
, rds
.text
, rds
.af_freq
);
95 fmdev
= video_drvdata(file
);
96 if (mutex_lock_interruptible(&fmdev
->mutex
))
98 fm_tx_set_radio_text(fmdev
, rds
.text
, rds
.text_type
);
99 fm_tx_set_af(fmdev
, rds
.af_freq
);
100 mutex_unlock(&fmdev
->mutex
);
105 static __poll_t
fm_v4l2_fops_poll(struct file
*file
, struct poll_table_struct
*pts
)
110 fmdev
= video_drvdata(file
);
111 mutex_lock(&fmdev
->mutex
);
112 ret
= fmc_is_rds_data_available(fmdev
, file
, pts
);
113 mutex_unlock(&fmdev
->mutex
);
115 return EPOLLIN
| EPOLLRDNORM
;
121 * Handle open request for "/dev/radioX" device.
122 * Start with FM RX mode as default.
124 static int fm_v4l2_fops_open(struct file
*file
)
127 struct fmdev
*fmdev
= NULL
;
129 /* Don't allow multiple open */
130 if (radio_disconnected
) {
131 fmerr("FM device is already opened\n");
135 fmdev
= video_drvdata(file
);
137 if (mutex_lock_interruptible(&fmdev
->mutex
))
139 ret
= fmc_prepare(fmdev
);
141 fmerr("Unable to prepare FM CORE\n");
145 fmdbg("Load FM RX firmware..\n");
147 ret
= fmc_set_mode(fmdev
, FM_MODE_RX
);
149 fmerr("Unable to load FM RX firmware\n");
152 radio_disconnected
= 1;
155 mutex_unlock(&fmdev
->mutex
);
159 static int fm_v4l2_fops_release(struct file
*file
)
164 fmdev
= video_drvdata(file
);
165 if (!radio_disconnected
) {
166 fmdbg("FM device is already closed\n");
170 mutex_lock(&fmdev
->mutex
);
171 ret
= fmc_set_mode(fmdev
, FM_MODE_OFF
);
173 fmerr("Unable to turn off the chip\n");
177 ret
= fmc_release(fmdev
);
179 fmerr("FM CORE release failed\n");
182 radio_disconnected
= 0;
185 mutex_unlock(&fmdev
->mutex
);
189 /* V4L2 RADIO (/dev/radioX) device IOCTL interfaces */
190 static int fm_v4l2_vidioc_querycap(struct file
*file
, void *priv
,
191 struct v4l2_capability
*capability
)
193 strlcpy(capability
->driver
, FM_DRV_NAME
, sizeof(capability
->driver
));
194 strlcpy(capability
->card
, FM_DRV_CARD_SHORT_NAME
,
195 sizeof(capability
->card
));
196 sprintf(capability
->bus_info
, "UART");
197 capability
->device_caps
= V4L2_CAP_HW_FREQ_SEEK
| V4L2_CAP_TUNER
|
198 V4L2_CAP_RADIO
| V4L2_CAP_MODULATOR
|
199 V4L2_CAP_AUDIO
| V4L2_CAP_READWRITE
|
200 V4L2_CAP_RDS_CAPTURE
;
201 capability
->capabilities
= capability
->device_caps
|
202 V4L2_CAP_DEVICE_CAPS
;
207 static int fm_g_volatile_ctrl(struct v4l2_ctrl
*ctrl
)
209 struct fmdev
*fmdev
= container_of(ctrl
->handler
,
210 struct fmdev
, ctrl_handler
);
213 case V4L2_CID_TUNE_ANTENNA_CAPACITOR
:
214 ctrl
->val
= fm_tx_get_tune_cap_val(fmdev
);
217 fmwarn("%s: Unknown IOCTL: %d\n", __func__
, ctrl
->id
);
224 static int fm_v4l2_s_ctrl(struct v4l2_ctrl
*ctrl
)
226 struct fmdev
*fmdev
= container_of(ctrl
->handler
,
227 struct fmdev
, ctrl_handler
);
230 case V4L2_CID_AUDIO_VOLUME
: /* set volume */
231 return fm_rx_set_volume(fmdev
, (u16
)ctrl
->val
);
233 case V4L2_CID_AUDIO_MUTE
: /* set mute */
234 return fmc_set_mute_mode(fmdev
, (u8
)ctrl
->val
);
236 case V4L2_CID_TUNE_POWER_LEVEL
:
237 /* set TX power level - ext control */
238 return fm_tx_set_pwr_lvl(fmdev
, (u8
)ctrl
->val
);
240 case V4L2_CID_TUNE_PREEMPHASIS
:
241 return fm_tx_set_preemph_filter(fmdev
, (u8
) ctrl
->val
);
248 static int fm_v4l2_vidioc_g_audio(struct file
*file
, void *priv
,
249 struct v4l2_audio
*audio
)
251 memset(audio
, 0, sizeof(*audio
));
252 strcpy(audio
->name
, "Radio");
253 audio
->capability
= V4L2_AUDCAP_STEREO
;
258 static int fm_v4l2_vidioc_s_audio(struct file
*file
, void *priv
,
259 const struct v4l2_audio
*audio
)
261 if (audio
->index
!= 0)
267 /* Get tuner attributes. If current mode is NOT RX, return error */
268 static int fm_v4l2_vidioc_g_tuner(struct file
*file
, void *priv
,
269 struct v4l2_tuner
*tuner
)
271 struct fmdev
*fmdev
= video_drvdata(file
);
274 u16 stereo_mono_mode
;
278 if (tuner
->index
!= 0)
281 if (fmdev
->curr_fmmode
!= FM_MODE_RX
)
284 ret
= fm_rx_get_band_freq_range(fmdev
, &bottom_freq
, &top_freq
);
288 ret
= fm_rx_get_stereo_mono(fmdev
, &stereo_mono_mode
);
292 ret
= fm_rx_get_rssi_level(fmdev
, &rssilvl
);
296 strcpy(tuner
->name
, "FM");
297 tuner
->type
= V4L2_TUNER_RADIO
;
298 /* Store rangelow and rangehigh freq in unit of 62.5 Hz */
299 tuner
->rangelow
= bottom_freq
* 16;
300 tuner
->rangehigh
= top_freq
* 16;
301 tuner
->rxsubchans
= V4L2_TUNER_SUB_MONO
| V4L2_TUNER_SUB_STEREO
|
302 ((fmdev
->rx
.rds
.flag
== FM_RDS_ENABLE
) ? V4L2_TUNER_SUB_RDS
: 0);
303 tuner
->capability
= V4L2_TUNER_CAP_STEREO
| V4L2_TUNER_CAP_RDS
|
305 V4L2_TUNER_CAP_HWSEEK_BOUNDED
|
306 V4L2_TUNER_CAP_HWSEEK_WRAP
;
307 tuner
->audmode
= (stereo_mono_mode
?
308 V4L2_TUNER_MODE_MONO
: V4L2_TUNER_MODE_STEREO
);
311 * Actual rssi value lies in between -128 to +127.
312 * Convert this range from 0 to 255 by adding +128
317 * Return signal strength value should be within 0 to 65535.
318 * Find out correct signal radio by multiplying (65535/255) = 257
320 tuner
->signal
= rssilvl
* 257;
327 * Set tuner attributes. If current mode is NOT RX, set to RX.
328 * Currently, we set only audio mode (mono/stereo) and RDS state (on/off).
329 * Should we set other tuner attributes, too?
331 static int fm_v4l2_vidioc_s_tuner(struct file
*file
, void *priv
,
332 const struct v4l2_tuner
*tuner
)
334 struct fmdev
*fmdev
= video_drvdata(file
);
339 if (tuner
->index
!= 0)
342 aud_mode
= (tuner
->audmode
== V4L2_TUNER_MODE_STEREO
) ?
343 FM_STEREO_MODE
: FM_MONO_MODE
;
344 rds_mode
= (tuner
->rxsubchans
& V4L2_TUNER_SUB_RDS
) ?
345 FM_RDS_ENABLE
: FM_RDS_DISABLE
;
347 if (fmdev
->curr_fmmode
!= FM_MODE_RX
) {
348 ret
= fmc_set_mode(fmdev
, FM_MODE_RX
);
350 fmerr("Failed to set RX mode\n");
355 ret
= fmc_set_stereo_mono(fmdev
, aud_mode
);
357 fmerr("Failed to set RX stereo/mono mode\n");
361 ret
= fmc_set_rds_mode(fmdev
, rds_mode
);
363 fmerr("Failed to set RX RDS mode\n");
368 /* Get tuner or modulator radio frequency */
369 static int fm_v4l2_vidioc_g_freq(struct file
*file
, void *priv
,
370 struct v4l2_frequency
*freq
)
372 struct fmdev
*fmdev
= video_drvdata(file
);
375 ret
= fmc_get_freq(fmdev
, &freq
->frequency
);
377 fmerr("Failed to get frequency\n");
381 /* Frequency unit of 62.5 Hz*/
382 freq
->frequency
= (u32
) freq
->frequency
* 16;
387 /* Set tuner or modulator radio frequency */
388 static int fm_v4l2_vidioc_s_freq(struct file
*file
, void *priv
,
389 const struct v4l2_frequency
*freq
)
391 struct fmdev
*fmdev
= video_drvdata(file
);
394 * As V4L2_TUNER_CAP_LOW is set 1 user sends the frequency
395 * in units of 62.5 Hz.
397 return fmc_set_freq(fmdev
, freq
->frequency
/ 16);
400 /* Set hardware frequency seek. If current mode is NOT RX, set it RX. */
401 static int fm_v4l2_vidioc_s_hw_freq_seek(struct file
*file
, void *priv
,
402 const struct v4l2_hw_freq_seek
*seek
)
404 struct fmdev
*fmdev
= video_drvdata(file
);
407 if (file
->f_flags
& O_NONBLOCK
)
410 if (fmdev
->curr_fmmode
!= FM_MODE_RX
) {
411 ret
= fmc_set_mode(fmdev
, FM_MODE_RX
);
413 fmerr("Failed to set RX mode\n");
418 ret
= fm_rx_seek(fmdev
, seek
->seek_upward
, seek
->wrap_around
,
421 fmerr("RX seek failed - %d\n", ret
);
425 /* Get modulator attributes. If mode is not TX, return no attributes. */
426 static int fm_v4l2_vidioc_g_modulator(struct file
*file
, void *priv
,
427 struct v4l2_modulator
*mod
)
429 struct fmdev
*fmdev
= video_drvdata(file
);
434 if (fmdev
->curr_fmmode
!= FM_MODE_TX
)
437 mod
->txsubchans
= ((fmdev
->tx_data
.aud_mode
== FM_STEREO_MODE
) ?
438 V4L2_TUNER_SUB_STEREO
: V4L2_TUNER_SUB_MONO
) |
439 ((fmdev
->tx_data
.rds
.flag
== FM_RDS_ENABLE
) ?
440 V4L2_TUNER_SUB_RDS
: 0);
442 mod
->capability
= V4L2_TUNER_CAP_STEREO
| V4L2_TUNER_CAP_RDS
|
448 /* Set modulator attributes. If mode is not TX, set to TX. */
449 static int fm_v4l2_vidioc_s_modulator(struct file
*file
, void *priv
,
450 const struct v4l2_modulator
*mod
)
452 struct fmdev
*fmdev
= video_drvdata(file
);
460 if (fmdev
->curr_fmmode
!= FM_MODE_TX
) {
461 ret
= fmc_set_mode(fmdev
, FM_MODE_TX
);
463 fmerr("Failed to set TX mode\n");
468 aud_mode
= (mod
->txsubchans
& V4L2_TUNER_SUB_STEREO
) ?
469 FM_STEREO_MODE
: FM_MONO_MODE
;
470 rds_mode
= (mod
->txsubchans
& V4L2_TUNER_SUB_RDS
) ?
471 FM_RDS_ENABLE
: FM_RDS_DISABLE
;
472 ret
= fm_tx_set_stereo_mono(fmdev
, aud_mode
);
474 fmerr("Failed to set mono/stereo mode for TX\n");
477 ret
= fm_tx_set_rds_mode(fmdev
, rds_mode
);
479 fmerr("Failed to set rds mode for TX\n");
484 static const struct v4l2_file_operations fm_drv_fops
= {
485 .owner
= THIS_MODULE
,
486 .read
= fm_v4l2_fops_read
,
487 .write
= fm_v4l2_fops_write
,
488 .poll
= fm_v4l2_fops_poll
,
489 .unlocked_ioctl
= video_ioctl2
,
490 .open
= fm_v4l2_fops_open
,
491 .release
= fm_v4l2_fops_release
,
494 static const struct v4l2_ctrl_ops fm_ctrl_ops
= {
495 .s_ctrl
= fm_v4l2_s_ctrl
,
496 .g_volatile_ctrl
= fm_g_volatile_ctrl
,
498 static const struct v4l2_ioctl_ops fm_drv_ioctl_ops
= {
499 .vidioc_querycap
= fm_v4l2_vidioc_querycap
,
500 .vidioc_g_audio
= fm_v4l2_vidioc_g_audio
,
501 .vidioc_s_audio
= fm_v4l2_vidioc_s_audio
,
502 .vidioc_g_tuner
= fm_v4l2_vidioc_g_tuner
,
503 .vidioc_s_tuner
= fm_v4l2_vidioc_s_tuner
,
504 .vidioc_g_frequency
= fm_v4l2_vidioc_g_freq
,
505 .vidioc_s_frequency
= fm_v4l2_vidioc_s_freq
,
506 .vidioc_s_hw_freq_seek
= fm_v4l2_vidioc_s_hw_freq_seek
,
507 .vidioc_g_modulator
= fm_v4l2_vidioc_g_modulator
,
508 .vidioc_s_modulator
= fm_v4l2_vidioc_s_modulator
511 /* V4L2 RADIO device parent structure */
512 static const struct video_device fm_viddev_template
= {
513 .fops
= &fm_drv_fops
,
514 .ioctl_ops
= &fm_drv_ioctl_ops
,
516 .release
= video_device_release_empty
,
518 * To ensure both the tuner and modulator ioctls are accessible we
519 * set the vfl_dir to M2M to indicate this.
521 * It is not really a mem2mem device of course, but it can both receive
522 * and transmit using the same radio device. It's the only radio driver
523 * that does this and it should really be split in two radio devices,
524 * but that would affect applications using this driver.
526 .vfl_dir
= VFL_DIR_M2M
,
529 int fm_v4l2_init_video_device(struct fmdev
*fmdev
, int radio_nr
)
531 struct v4l2_ctrl
*ctrl
;
534 strlcpy(fmdev
->v4l2_dev
.name
, FM_DRV_NAME
, sizeof(fmdev
->v4l2_dev
.name
));
535 ret
= v4l2_device_register(NULL
, &fmdev
->v4l2_dev
);
539 /* Init mutex for core locking */
540 mutex_init(&fmdev
->mutex
);
542 /* Setup FM driver's V4L2 properties */
543 gradio_dev
= fm_viddev_template
;
545 video_set_drvdata(&gradio_dev
, fmdev
);
547 gradio_dev
.lock
= &fmdev
->mutex
;
548 gradio_dev
.v4l2_dev
= &fmdev
->v4l2_dev
;
550 /* Register with V4L2 subsystem as RADIO device */
551 if (video_register_device(&gradio_dev
, VFL_TYPE_RADIO
, radio_nr
)) {
552 v4l2_device_unregister(&fmdev
->v4l2_dev
);
553 fmerr("Could not register video device\n");
557 fmdev
->radio_dev
= &gradio_dev
;
559 /* Register to v4l2 ctrl handler framework */
560 fmdev
->radio_dev
->ctrl_handler
= &fmdev
->ctrl_handler
;
562 ret
= v4l2_ctrl_handler_init(&fmdev
->ctrl_handler
, 5);
564 fmerr("(fmdev): Can't init ctrl handler\n");
565 v4l2_ctrl_handler_free(&fmdev
->ctrl_handler
);
566 video_unregister_device(fmdev
->radio_dev
);
567 v4l2_device_unregister(&fmdev
->v4l2_dev
);
572 * Following controls are handled by V4L2 control framework.
573 * Added in ascending ID order.
575 v4l2_ctrl_new_std(&fmdev
->ctrl_handler
, &fm_ctrl_ops
,
576 V4L2_CID_AUDIO_VOLUME
, FM_RX_VOLUME_MIN
,
577 FM_RX_VOLUME_MAX
, 1, FM_RX_VOLUME_MAX
);
579 v4l2_ctrl_new_std(&fmdev
->ctrl_handler
, &fm_ctrl_ops
,
580 V4L2_CID_AUDIO_MUTE
, 0, 1, 1, 1);
582 v4l2_ctrl_new_std_menu(&fmdev
->ctrl_handler
, &fm_ctrl_ops
,
583 V4L2_CID_TUNE_PREEMPHASIS
, V4L2_PREEMPHASIS_75_uS
,
584 0, V4L2_PREEMPHASIS_75_uS
);
586 v4l2_ctrl_new_std(&fmdev
->ctrl_handler
, &fm_ctrl_ops
,
587 V4L2_CID_TUNE_POWER_LEVEL
, FM_PWR_LVL_LOW
,
588 FM_PWR_LVL_HIGH
, 1, FM_PWR_LVL_HIGH
);
590 ctrl
= v4l2_ctrl_new_std(&fmdev
->ctrl_handler
, &fm_ctrl_ops
,
591 V4L2_CID_TUNE_ANTENNA_CAPACITOR
, 0,
595 ctrl
->flags
|= V4L2_CTRL_FLAG_VOLATILE
;
600 void *fm_v4l2_deinit_video_device(void)
605 fmdev
= video_get_drvdata(&gradio_dev
);
607 /* Unregister to v4l2 ctrl handler framework*/
608 v4l2_ctrl_handler_free(&fmdev
->ctrl_handler
);
610 /* Unregister RADIO device from V4L2 subsystem */
611 video_unregister_device(&gradio_dev
);
613 v4l2_device_unregister(&fmdev
->v4l2_dev
);