1 // SPDX-License-Identifier: GPL-2.0-only
3 * FM Driver for Connectivity chip of Texas Instruments.
4 * This file provides interfaces to V4L2 subsystem.
6 * This module registers with V4L2 subsystem as Radio
7 * data system interface (/dev/radio). During the registration,
8 * it will expose two set of function pointers.
10 * 1) File operation related API (open, close, read, write, poll...etc).
11 * 2) Set of V4L2 IOCTL complaint API.
13 * Copyright (C) 2011 Texas Instruments
14 * Author: Raja Mani <raja_mani@ti.com>
15 * Author: Manjunatha Halli <manjunatha_halli@ti.com>
18 #include <linux/export.h>
21 #include "fmdrv_v4l2.h"
22 #include "fmdrv_common.h"
26 static struct video_device gradio_dev;
27 static u8 radio_disconnected;
29 /* -- V4L2 RADIO (/dev/radioX) device file operation interfaces --- */
31 /* Read RX RDS data */
32 static ssize_t fm_v4l2_fops_read(struct file *file, char __user * buf,
33 size_t count, loff_t *ppos)
39 fmdev = video_drvdata(file);
41 if (!radio_disconnected) {
42 fmerr("FM device is already disconnected\n");
46 if (mutex_lock_interruptible(&fmdev->mutex))
49 /* Turn on RDS mode if it is disabled */
50 ret = fm_rx_get_rds_mode(fmdev, &rds_mode);
52 fmerr("Unable to read current rds mode\n");
56 if (rds_mode == FM_RDS_DISABLE) {
57 ret = fmc_set_rds_mode(fmdev, FM_RDS_ENABLE);
59 fmerr("Failed to enable rds mode\n");
64 /* Copy RDS data from internal buffer to user buffer */
65 ret = fmc_transfer_rds_from_internal_buff(fmdev, file, buf, count);
67 mutex_unlock(&fmdev->mutex);
71 /* Write TX RDS data */
72 static ssize_t fm_v4l2_fops_write(struct file *file, const char __user * buf,
73 size_t count, loff_t *ppos)
79 ret = copy_from_user(&rds, buf, sizeof(rds));
80 rds.text[sizeof(rds.text) - 1] = '\0';
81 fmdbg("(%d)type: %d, text %s, af %d\n",
82 ret, rds.text_type, rds.text, rds.af_freq);
86 fmdev = video_drvdata(file);
87 if (mutex_lock_interruptible(&fmdev->mutex))
89 fm_tx_set_radio_text(fmdev, rds.text, rds.text_type);
90 fm_tx_set_af(fmdev, rds.af_freq);
91 mutex_unlock(&fmdev->mutex);
96 static __poll_t fm_v4l2_fops_poll(struct file *file, struct poll_table_struct *pts)
101 fmdev = video_drvdata(file);
102 mutex_lock(&fmdev->mutex);
103 ret = fmc_is_rds_data_available(fmdev, file, pts);
104 mutex_unlock(&fmdev->mutex);
106 return EPOLLIN | EPOLLRDNORM;
112 * Handle open request for "/dev/radioX" device.
113 * Start with FM RX mode as default.
115 static int fm_v4l2_fops_open(struct file *file)
118 struct fmdev *fmdev = NULL;
120 /* Don't allow multiple open */
121 if (radio_disconnected) {
122 fmerr("FM device is already opened\n");
126 fmdev = video_drvdata(file);
128 if (mutex_lock_interruptible(&fmdev->mutex))
130 ret = fmc_prepare(fmdev);
132 fmerr("Unable to prepare FM CORE\n");
136 fmdbg("Load FM RX firmware..\n");
138 ret = fmc_set_mode(fmdev, FM_MODE_RX);
140 fmerr("Unable to load FM RX firmware\n");
143 radio_disconnected = 1;
146 mutex_unlock(&fmdev->mutex);
150 static int fm_v4l2_fops_release(struct file *file)
155 fmdev = video_drvdata(file);
156 if (!radio_disconnected) {
157 fmdbg("FM device is already closed\n");
161 mutex_lock(&fmdev->mutex);
162 ret = fmc_set_mode(fmdev, FM_MODE_OFF);
164 fmerr("Unable to turn off the chip\n");
168 ret = fmc_release(fmdev);
170 fmerr("FM CORE release failed\n");
173 radio_disconnected = 0;
176 mutex_unlock(&fmdev->mutex);
180 /* V4L2 RADIO (/dev/radioX) device IOCTL interfaces */
181 static int fm_v4l2_vidioc_querycap(struct file *file, void *priv,
182 struct v4l2_capability *capability)
184 strscpy(capability->driver, FM_DRV_NAME, sizeof(capability->driver));
185 strscpy(capability->card, FM_DRV_CARD_SHORT_NAME,
186 sizeof(capability->card));
187 sprintf(capability->bus_info, "UART");
191 static int fm_g_volatile_ctrl(struct v4l2_ctrl *ctrl)
193 struct fmdev *fmdev = container_of(ctrl->handler,
194 struct fmdev, ctrl_handler);
197 case V4L2_CID_TUNE_ANTENNA_CAPACITOR:
198 ctrl->val = fm_tx_get_tune_cap_val(fmdev);
201 fmwarn("%s: Unknown IOCTL: %d\n", __func__, ctrl->id);
208 static int fm_v4l2_s_ctrl(struct v4l2_ctrl *ctrl)
210 struct fmdev *fmdev = container_of(ctrl->handler,
211 struct fmdev, ctrl_handler);
214 case V4L2_CID_AUDIO_VOLUME: /* set volume */
215 return fm_rx_set_volume(fmdev, (u16)ctrl->val);
217 case V4L2_CID_AUDIO_MUTE: /* set mute */
218 return fmc_set_mute_mode(fmdev, (u8)ctrl->val);
220 case V4L2_CID_TUNE_POWER_LEVEL:
221 /* set TX power level - ext control */
222 return fm_tx_set_pwr_lvl(fmdev, (u8)ctrl->val);
224 case V4L2_CID_TUNE_PREEMPHASIS:
225 return fm_tx_set_preemph_filter(fmdev, (u8) ctrl->val);
232 static int fm_v4l2_vidioc_g_audio(struct file *file, void *priv,
233 struct v4l2_audio *audio)
235 memset(audio, 0, sizeof(*audio));
236 strscpy(audio->name, "Radio", sizeof(audio->name));
237 audio->capability = V4L2_AUDCAP_STEREO;
242 static int fm_v4l2_vidioc_s_audio(struct file *file, void *priv,
243 const struct v4l2_audio *audio)
245 if (audio->index != 0)
251 /* Get tuner attributes. If current mode is NOT RX, return error */
252 static int fm_v4l2_vidioc_g_tuner(struct file *file, void *priv,
253 struct v4l2_tuner *tuner)
255 struct fmdev *fmdev = video_drvdata(file);
258 u16 stereo_mono_mode;
262 if (tuner->index != 0)
265 if (fmdev->curr_fmmode != FM_MODE_RX)
268 ret = fm_rx_get_band_freq_range(fmdev, &bottom_freq, &top_freq);
272 ret = fm_rx_get_stereo_mono(fmdev, &stereo_mono_mode);
276 ret = fm_rx_get_rssi_level(fmdev, &rssilvl);
280 strscpy(tuner->name, "FM", sizeof(tuner->name));
281 tuner->type = V4L2_TUNER_RADIO;
282 /* Store rangelow and rangehigh freq in unit of 62.5 Hz */
283 tuner->rangelow = bottom_freq * 16;
284 tuner->rangehigh = top_freq * 16;
285 tuner->rxsubchans = V4L2_TUNER_SUB_MONO | V4L2_TUNER_SUB_STEREO |
286 ((fmdev->rx.rds.flag == FM_RDS_ENABLE) ? V4L2_TUNER_SUB_RDS : 0);
287 tuner->capability = V4L2_TUNER_CAP_STEREO | V4L2_TUNER_CAP_RDS |
289 V4L2_TUNER_CAP_HWSEEK_BOUNDED |
290 V4L2_TUNER_CAP_HWSEEK_WRAP;
291 tuner->audmode = (stereo_mono_mode ?
292 V4L2_TUNER_MODE_MONO : V4L2_TUNER_MODE_STEREO);
295 * Actual rssi value lies in between -128 to +127.
296 * Convert this range from 0 to 255 by adding +128
301 * Return signal strength value should be within 0 to 65535.
302 * Find out correct signal radio by multiplying (65535/255) = 257
304 tuner->signal = rssilvl * 257;
311 * Set tuner attributes. If current mode is NOT RX, set to RX.
312 * Currently, we set only audio mode (mono/stereo) and RDS state (on/off).
313 * Should we set other tuner attributes, too?
315 static int fm_v4l2_vidioc_s_tuner(struct file *file, void *priv,
316 const struct v4l2_tuner *tuner)
318 struct fmdev *fmdev = video_drvdata(file);
323 if (tuner->index != 0)
326 aud_mode = (tuner->audmode == V4L2_TUNER_MODE_STEREO) ?
327 FM_STEREO_MODE : FM_MONO_MODE;
328 rds_mode = (tuner->rxsubchans & V4L2_TUNER_SUB_RDS) ?
329 FM_RDS_ENABLE : FM_RDS_DISABLE;
331 if (fmdev->curr_fmmode != FM_MODE_RX) {
332 ret = fmc_set_mode(fmdev, FM_MODE_RX);
334 fmerr("Failed to set RX mode\n");
339 ret = fmc_set_stereo_mono(fmdev, aud_mode);
341 fmerr("Failed to set RX stereo/mono mode\n");
345 ret = fmc_set_rds_mode(fmdev, rds_mode);
347 fmerr("Failed to set RX RDS mode\n");
352 /* Get tuner or modulator radio frequency */
353 static int fm_v4l2_vidioc_g_freq(struct file *file, void *priv,
354 struct v4l2_frequency *freq)
356 struct fmdev *fmdev = video_drvdata(file);
359 ret = fmc_get_freq(fmdev, &freq->frequency);
361 fmerr("Failed to get frequency\n");
365 /* Frequency unit of 62.5 Hz*/
366 freq->frequency = (u32) freq->frequency * 16;
371 /* Set tuner or modulator radio frequency */
372 static int fm_v4l2_vidioc_s_freq(struct file *file, void *priv,
373 const struct v4l2_frequency *freq)
375 struct fmdev *fmdev = video_drvdata(file);
378 * As V4L2_TUNER_CAP_LOW is set 1 user sends the frequency
379 * in units of 62.5 Hz.
381 return fmc_set_freq(fmdev, freq->frequency / 16);
384 /* Set hardware frequency seek. If current mode is NOT RX, set it RX. */
385 static int fm_v4l2_vidioc_s_hw_freq_seek(struct file *file, void *priv,
386 const struct v4l2_hw_freq_seek *seek)
388 struct fmdev *fmdev = video_drvdata(file);
391 if (file->f_flags & O_NONBLOCK)
394 if (fmdev->curr_fmmode != FM_MODE_RX) {
395 ret = fmc_set_mode(fmdev, FM_MODE_RX);
397 fmerr("Failed to set RX mode\n");
402 ret = fm_rx_seek(fmdev, seek->seek_upward, seek->wrap_around,
405 fmerr("RX seek failed - %d\n", ret);
409 /* Get modulator attributes. If mode is not TX, return no attributes. */
410 static int fm_v4l2_vidioc_g_modulator(struct file *file, void *priv,
411 struct v4l2_modulator *mod)
413 struct fmdev *fmdev = video_drvdata(file);
418 if (fmdev->curr_fmmode != FM_MODE_TX)
421 mod->txsubchans = ((fmdev->tx_data.aud_mode == FM_STEREO_MODE) ?
422 V4L2_TUNER_SUB_STEREO : V4L2_TUNER_SUB_MONO) |
423 ((fmdev->tx_data.rds.flag == FM_RDS_ENABLE) ?
424 V4L2_TUNER_SUB_RDS : 0);
426 mod->capability = V4L2_TUNER_CAP_STEREO | V4L2_TUNER_CAP_RDS |
432 /* Set modulator attributes. If mode is not TX, set to TX. */
433 static int fm_v4l2_vidioc_s_modulator(struct file *file, void *priv,
434 const struct v4l2_modulator *mod)
436 struct fmdev *fmdev = video_drvdata(file);
444 if (fmdev->curr_fmmode != FM_MODE_TX) {
445 ret = fmc_set_mode(fmdev, FM_MODE_TX);
447 fmerr("Failed to set TX mode\n");
452 aud_mode = (mod->txsubchans & V4L2_TUNER_SUB_STEREO) ?
453 FM_STEREO_MODE : FM_MONO_MODE;
454 rds_mode = (mod->txsubchans & V4L2_TUNER_SUB_RDS) ?
455 FM_RDS_ENABLE : FM_RDS_DISABLE;
456 ret = fm_tx_set_stereo_mono(fmdev, aud_mode);
458 fmerr("Failed to set mono/stereo mode for TX\n");
461 ret = fm_tx_set_rds_mode(fmdev, rds_mode);
463 fmerr("Failed to set rds mode for TX\n");
468 static const struct v4l2_file_operations fm_drv_fops = {
469 .owner = THIS_MODULE,
470 .read = fm_v4l2_fops_read,
471 .write = fm_v4l2_fops_write,
472 .poll = fm_v4l2_fops_poll,
473 .unlocked_ioctl = video_ioctl2,
474 .open = fm_v4l2_fops_open,
475 .release = fm_v4l2_fops_release,
478 static const struct v4l2_ctrl_ops fm_ctrl_ops = {
479 .s_ctrl = fm_v4l2_s_ctrl,
480 .g_volatile_ctrl = fm_g_volatile_ctrl,
482 static const struct v4l2_ioctl_ops fm_drv_ioctl_ops = {
483 .vidioc_querycap = fm_v4l2_vidioc_querycap,
484 .vidioc_g_audio = fm_v4l2_vidioc_g_audio,
485 .vidioc_s_audio = fm_v4l2_vidioc_s_audio,
486 .vidioc_g_tuner = fm_v4l2_vidioc_g_tuner,
487 .vidioc_s_tuner = fm_v4l2_vidioc_s_tuner,
488 .vidioc_g_frequency = fm_v4l2_vidioc_g_freq,
489 .vidioc_s_frequency = fm_v4l2_vidioc_s_freq,
490 .vidioc_s_hw_freq_seek = fm_v4l2_vidioc_s_hw_freq_seek,
491 .vidioc_g_modulator = fm_v4l2_vidioc_g_modulator,
492 .vidioc_s_modulator = fm_v4l2_vidioc_s_modulator
495 /* V4L2 RADIO device parent structure */
496 static const struct video_device fm_viddev_template = {
497 .fops = &fm_drv_fops,
498 .ioctl_ops = &fm_drv_ioctl_ops,
500 .release = video_device_release_empty,
502 * To ensure both the tuner and modulator ioctls are accessible we
503 * set the vfl_dir to M2M to indicate this.
505 * It is not really a mem2mem device of course, but it can both receive
506 * and transmit using the same radio device. It's the only radio driver
507 * that does this and it should really be split in two radio devices,
508 * but that would affect applications using this driver.
510 .vfl_dir = VFL_DIR_M2M,
511 .device_caps = V4L2_CAP_HW_FREQ_SEEK | V4L2_CAP_TUNER | V4L2_CAP_RADIO |
512 V4L2_CAP_MODULATOR | V4L2_CAP_AUDIO |
513 V4L2_CAP_READWRITE | V4L2_CAP_RDS_CAPTURE,
516 int fm_v4l2_init_video_device(struct fmdev *fmdev, int radio_nr)
518 struct v4l2_ctrl *ctrl;
521 strscpy(fmdev->v4l2_dev.name, FM_DRV_NAME,
522 sizeof(fmdev->v4l2_dev.name));
523 ret = v4l2_device_register(NULL, &fmdev->v4l2_dev);
527 /* Init mutex for core locking */
528 mutex_init(&fmdev->mutex);
530 /* Setup FM driver's V4L2 properties */
531 gradio_dev = fm_viddev_template;
533 video_set_drvdata(&gradio_dev, fmdev);
535 gradio_dev.lock = &fmdev->mutex;
536 gradio_dev.v4l2_dev = &fmdev->v4l2_dev;
538 /* Register with V4L2 subsystem as RADIO device */
539 if (video_register_device(&gradio_dev, VFL_TYPE_RADIO, radio_nr)) {
540 v4l2_device_unregister(&fmdev->v4l2_dev);
541 fmerr("Could not register video device\n");
545 fmdev->radio_dev = &gradio_dev;
547 /* Register to v4l2 ctrl handler framework */
548 fmdev->radio_dev->ctrl_handler = &fmdev->ctrl_handler;
550 ret = v4l2_ctrl_handler_init(&fmdev->ctrl_handler, 5);
552 fmerr("(fmdev): Can't init ctrl handler\n");
553 v4l2_ctrl_handler_free(&fmdev->ctrl_handler);
554 video_unregister_device(fmdev->radio_dev);
555 v4l2_device_unregister(&fmdev->v4l2_dev);
560 * Following controls are handled by V4L2 control framework.
561 * Added in ascending ID order.
563 v4l2_ctrl_new_std(&fmdev->ctrl_handler, &fm_ctrl_ops,
564 V4L2_CID_AUDIO_VOLUME, FM_RX_VOLUME_MIN,
565 FM_RX_VOLUME_MAX, 1, FM_RX_VOLUME_MAX);
567 v4l2_ctrl_new_std(&fmdev->ctrl_handler, &fm_ctrl_ops,
568 V4L2_CID_AUDIO_MUTE, 0, 1, 1, 1);
570 v4l2_ctrl_new_std_menu(&fmdev->ctrl_handler, &fm_ctrl_ops,
571 V4L2_CID_TUNE_PREEMPHASIS, V4L2_PREEMPHASIS_75_uS,
572 0, V4L2_PREEMPHASIS_75_uS);
574 v4l2_ctrl_new_std(&fmdev->ctrl_handler, &fm_ctrl_ops,
575 V4L2_CID_TUNE_POWER_LEVEL, FM_PWR_LVL_LOW,
576 FM_PWR_LVL_HIGH, 1, FM_PWR_LVL_HIGH);
578 ctrl = v4l2_ctrl_new_std(&fmdev->ctrl_handler, &fm_ctrl_ops,
579 V4L2_CID_TUNE_ANTENNA_CAPACITOR, 0,
583 ctrl->flags |= V4L2_CTRL_FLAG_VOLATILE;
588 void *fm_v4l2_deinit_video_device(void)
593 fmdev = video_get_drvdata(&gradio_dev);
595 /* Unregister to v4l2 ctrl handler framework*/
596 v4l2_ctrl_handler_free(&fmdev->ctrl_handler);
598 /* Unregister RADIO device from V4L2 subsystem */
599 video_unregister_device(&gradio_dev);
601 v4l2_device_unregister(&fmdev->v4l2_dev);