1 /* 2 * FM Driver for Connectivity chip of Texas Instruments. 3 * This file provides interfaces to V4L2 subsystem. 4 * 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. 8 * 9 * 1) File operation related API (open, close, read, write, poll...etc). 10 * 2) Set of V4L2 IOCTL complaint API. 11 * 12 * Copyright (C) 2011 Texas Instruments 13 * Author: Raja Mani <raja_mani@ti.com> 14 * Author: Manjunatha Halli <manjunatha_halli@ti.com> 15 * 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. 19 * 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. 24 * 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 28 * 29 */ 30 31 #include <linux/export.h> 32 33 #include "fmdrv.h" 34 #include "fmdrv_v4l2.h" 35 #include "fmdrv_common.h" 36 #include "fmdrv_rx.h" 37 #include "fmdrv_tx.h" 38 39 static struct video_device *gradio_dev; 40 static u8 radio_disconnected; 41 42 /* -- V4L2 RADIO (/dev/radioX) device file operation interfaces --- */ 43 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) 47 { 48 u8 rds_mode; 49 int ret; 50 struct fmdev *fmdev; 51 52 fmdev = video_drvdata(file); 53 54 if (!radio_disconnected) { 55 fmerr("FM device is already disconnected\n"); 56 return -EIO; 57 } 58 59 if (mutex_lock_interruptible(&fmdev->mutex)) 60 return -ERESTARTSYS; 61 62 /* Turn on RDS mode if it is disabled */ 63 ret = fm_rx_get_rds_mode(fmdev, &rds_mode); 64 if (ret < 0) { 65 fmerr("Unable to read current rds mode\n"); 66 goto read_unlock; 67 } 68 69 if (rds_mode == FM_RDS_DISABLE) { 70 ret = fmc_set_rds_mode(fmdev, FM_RDS_ENABLE); 71 if (ret < 0) { 72 fmerr("Failed to enable rds mode\n"); 73 goto read_unlock; 74 } 75 } 76 77 /* Copy RDS data from internal buffer to user buffer */ 78 ret = fmc_transfer_rds_from_internal_buff(fmdev, file, buf, count); 79 read_unlock: 80 mutex_unlock(&fmdev->mutex); 81 return ret; 82 } 83 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) 87 { 88 struct tx_rds rds; 89 int ret; 90 struct fmdev *fmdev; 91 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); 96 if (ret) 97 return -EFAULT; 98 99 fmdev = video_drvdata(file); 100 if (mutex_lock_interruptible(&fmdev->mutex)) 101 return -ERESTARTSYS; 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); 105 106 return sizeof(rds); 107 } 108 109 static u32 fm_v4l2_fops_poll(struct file *file, struct poll_table_struct *pts) 110 { 111 int ret; 112 struct fmdev *fmdev; 113 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); 118 if (ret < 0) 119 return POLLIN | POLLRDNORM; 120 121 return 0; 122 } 123 124 /* 125 * Handle open request for "/dev/radioX" device. 126 * Start with FM RX mode as default. 127 */ 128 static int fm_v4l2_fops_open(struct file *file) 129 { 130 int ret; 131 struct fmdev *fmdev = NULL; 132 133 /* Don't allow multiple open */ 134 if (radio_disconnected) { 135 fmerr("FM device is already opened\n"); 136 return -EBUSY; 137 } 138 139 fmdev = video_drvdata(file); 140 141 if (mutex_lock_interruptible(&fmdev->mutex)) 142 return -ERESTARTSYS; 143 ret = fmc_prepare(fmdev); 144 if (ret < 0) { 145 fmerr("Unable to prepare FM CORE\n"); 146 goto open_unlock; 147 } 148 149 fmdbg("Load FM RX firmware..\n"); 150 151 ret = fmc_set_mode(fmdev, FM_MODE_RX); 152 if (ret < 0) { 153 fmerr("Unable to load FM RX firmware\n"); 154 goto open_unlock; 155 } 156 radio_disconnected = 1; 157 158 open_unlock: 159 mutex_unlock(&fmdev->mutex); 160 return ret; 161 } 162 163 static int fm_v4l2_fops_release(struct file *file) 164 { 165 int ret; 166 struct fmdev *fmdev; 167 168 fmdev = video_drvdata(file); 169 if (!radio_disconnected) { 170 fmdbg("FM device is already closed\n"); 171 return 0; 172 } 173 174 mutex_lock(&fmdev->mutex); 175 ret = fmc_set_mode(fmdev, FM_MODE_OFF); 176 if (ret < 0) { 177 fmerr("Unable to turn off the chip\n"); 178 goto release_unlock; 179 } 180 181 ret = fmc_release(fmdev); 182 if (ret < 0) { 183 fmerr("FM CORE release failed\n"); 184 goto release_unlock; 185 } 186 radio_disconnected = 0; 187 188 release_unlock: 189 mutex_unlock(&fmdev->mutex); 190 return ret; 191 } 192 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) 196 { 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->device_caps = 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; 205 capability->capabilities = capability->device_caps | 206 V4L2_CAP_DEVICE_CAPS; 207 208 return 0; 209 } 210 211 static int fm_g_volatile_ctrl(struct v4l2_ctrl *ctrl) 212 { 213 struct fmdev *fmdev = container_of(ctrl->handler, 214 struct fmdev, ctrl_handler); 215 216 switch (ctrl->id) { 217 case V4L2_CID_TUNE_ANTENNA_CAPACITOR: 218 ctrl->val = fm_tx_get_tune_cap_val(fmdev); 219 break; 220 default: 221 fmwarn("%s: Unknown IOCTL: %d\n", __func__, ctrl->id); 222 break; 223 } 224 225 return 0; 226 } 227 228 static int fm_v4l2_s_ctrl(struct v4l2_ctrl *ctrl) 229 { 230 struct fmdev *fmdev = container_of(ctrl->handler, 231 struct fmdev, ctrl_handler); 232 233 switch (ctrl->id) { 234 case V4L2_CID_AUDIO_VOLUME: /* set volume */ 235 return fm_rx_set_volume(fmdev, (u16)ctrl->val); 236 237 case V4L2_CID_AUDIO_MUTE: /* set mute */ 238 return fmc_set_mute_mode(fmdev, (u8)ctrl->val); 239 240 case V4L2_CID_TUNE_POWER_LEVEL: 241 /* set TX power level - ext control */ 242 return fm_tx_set_pwr_lvl(fmdev, (u8)ctrl->val); 243 244 case V4L2_CID_TUNE_PREEMPHASIS: 245 return fm_tx_set_preemph_filter(fmdev, (u8) ctrl->val); 246 247 default: 248 return -EINVAL; 249 } 250 } 251 252 static int fm_v4l2_vidioc_g_audio(struct file *file, void *priv, 253 struct v4l2_audio *audio) 254 { 255 memset(audio, 0, sizeof(*audio)); 256 strcpy(audio->name, "Radio"); 257 audio->capability = V4L2_AUDCAP_STEREO; 258 259 return 0; 260 } 261 262 static int fm_v4l2_vidioc_s_audio(struct file *file, void *priv, 263 const struct v4l2_audio *audio) 264 { 265 if (audio->index != 0) 266 return -EINVAL; 267 268 return 0; 269 } 270 271 /* Get tuner attributes. If current mode is NOT RX, return error */ 272 static int fm_v4l2_vidioc_g_tuner(struct file *file, void *priv, 273 struct v4l2_tuner *tuner) 274 { 275 struct fmdev *fmdev = video_drvdata(file); 276 u32 bottom_freq; 277 u32 top_freq; 278 u16 stereo_mono_mode; 279 u16 rssilvl; 280 int ret; 281 282 if (tuner->index != 0) 283 return -EINVAL; 284 285 if (fmdev->curr_fmmode != FM_MODE_RX) 286 return -EPERM; 287 288 ret = fm_rx_get_band_freq_range(fmdev, &bottom_freq, &top_freq); 289 if (ret != 0) 290 return ret; 291 292 ret = fm_rx_get_stereo_mono(fmdev, &stereo_mono_mode); 293 if (ret != 0) 294 return ret; 295 296 ret = fm_rx_get_rssi_level(fmdev, &rssilvl); 297 if (ret != 0) 298 return ret; 299 300 strcpy(tuner->name, "FM"); 301 tuner->type = V4L2_TUNER_RADIO; 302 /* Store rangelow and rangehigh freq in unit of 62.5 Hz */ 303 tuner->rangelow = bottom_freq * 16; 304 tuner->rangehigh = top_freq * 16; 305 tuner->rxsubchans = V4L2_TUNER_SUB_MONO | V4L2_TUNER_SUB_STEREO | 306 ((fmdev->rx.rds.flag == FM_RDS_ENABLE) ? V4L2_TUNER_SUB_RDS : 0); 307 tuner->capability = V4L2_TUNER_CAP_STEREO | V4L2_TUNER_CAP_RDS | 308 V4L2_TUNER_CAP_LOW | 309 V4L2_TUNER_CAP_HWSEEK_BOUNDED | 310 V4L2_TUNER_CAP_HWSEEK_WRAP; 311 tuner->audmode = (stereo_mono_mode ? 312 V4L2_TUNER_MODE_MONO : V4L2_TUNER_MODE_STEREO); 313 314 /* 315 * Actual rssi value lies in between -128 to +127. 316 * Convert this range from 0 to 255 by adding +128 317 */ 318 rssilvl += 128; 319 320 /* 321 * Return signal strength value should be within 0 to 65535. 322 * Find out correct signal radio by multiplying (65535/255) = 257 323 */ 324 tuner->signal = rssilvl * 257; 325 tuner->afc = 0; 326 327 return ret; 328 } 329 330 /* 331 * Set tuner attributes. If current mode is NOT RX, set to RX. 332 * Currently, we set only audio mode (mono/stereo) and RDS state (on/off). 333 * Should we set other tuner attributes, too? 334 */ 335 static int fm_v4l2_vidioc_s_tuner(struct file *file, void *priv, 336 const struct v4l2_tuner *tuner) 337 { 338 struct fmdev *fmdev = video_drvdata(file); 339 u16 aud_mode; 340 u8 rds_mode; 341 int ret; 342 343 if (tuner->index != 0) 344 return -EINVAL; 345 346 aud_mode = (tuner->audmode == V4L2_TUNER_MODE_STEREO) ? 347 FM_STEREO_MODE : FM_MONO_MODE; 348 rds_mode = (tuner->rxsubchans & V4L2_TUNER_SUB_RDS) ? 349 FM_RDS_ENABLE : FM_RDS_DISABLE; 350 351 if (fmdev->curr_fmmode != FM_MODE_RX) { 352 ret = fmc_set_mode(fmdev, FM_MODE_RX); 353 if (ret < 0) { 354 fmerr("Failed to set RX mode\n"); 355 return ret; 356 } 357 } 358 359 ret = fmc_set_stereo_mono(fmdev, aud_mode); 360 if (ret < 0) { 361 fmerr("Failed to set RX stereo/mono mode\n"); 362 return ret; 363 } 364 365 ret = fmc_set_rds_mode(fmdev, rds_mode); 366 if (ret < 0) 367 fmerr("Failed to set RX RDS mode\n"); 368 369 return ret; 370 } 371 372 /* Get tuner or modulator radio frequency */ 373 static int fm_v4l2_vidioc_g_freq(struct file *file, void *priv, 374 struct v4l2_frequency *freq) 375 { 376 struct fmdev *fmdev = video_drvdata(file); 377 int ret; 378 379 ret = fmc_get_freq(fmdev, &freq->frequency); 380 if (ret < 0) { 381 fmerr("Failed to get frequency\n"); 382 return ret; 383 } 384 385 /* Frequency unit of 62.5 Hz*/ 386 freq->frequency = (u32) freq->frequency * 16; 387 388 return 0; 389 } 390 391 /* Set tuner or modulator radio frequency */ 392 static int fm_v4l2_vidioc_s_freq(struct file *file, void *priv, 393 const struct v4l2_frequency *freq) 394 { 395 struct fmdev *fmdev = video_drvdata(file); 396 397 /* 398 * As V4L2_TUNER_CAP_LOW is set 1 user sends the frequency 399 * in units of 62.5 Hz. 400 */ 401 return fmc_set_freq(fmdev, freq->frequency / 16); 402 } 403 404 /* Set hardware frequency seek. If current mode is NOT RX, set it RX. */ 405 static int fm_v4l2_vidioc_s_hw_freq_seek(struct file *file, void *priv, 406 const struct v4l2_hw_freq_seek *seek) 407 { 408 struct fmdev *fmdev = video_drvdata(file); 409 int ret; 410 411 if (file->f_flags & O_NONBLOCK) 412 return -EWOULDBLOCK; 413 414 if (fmdev->curr_fmmode != FM_MODE_RX) { 415 ret = fmc_set_mode(fmdev, FM_MODE_RX); 416 if (ret != 0) { 417 fmerr("Failed to set RX mode\n"); 418 return ret; 419 } 420 } 421 422 ret = fm_rx_seek(fmdev, seek->seek_upward, seek->wrap_around, 423 seek->spacing); 424 if (ret < 0) 425 fmerr("RX seek failed - %d\n", ret); 426 427 return ret; 428 } 429 /* Get modulator attributes. If mode is not TX, return no attributes. */ 430 static int fm_v4l2_vidioc_g_modulator(struct file *file, void *priv, 431 struct v4l2_modulator *mod) 432 { 433 struct fmdev *fmdev = video_drvdata(file); 434 435 if (mod->index != 0) 436 return -EINVAL; 437 438 if (fmdev->curr_fmmode != FM_MODE_TX) 439 return -EPERM; 440 441 mod->txsubchans = ((fmdev->tx_data.aud_mode == FM_STEREO_MODE) ? 442 V4L2_TUNER_SUB_STEREO : V4L2_TUNER_SUB_MONO) | 443 ((fmdev->tx_data.rds.flag == FM_RDS_ENABLE) ? 444 V4L2_TUNER_SUB_RDS : 0); 445 446 mod->capability = V4L2_TUNER_CAP_STEREO | V4L2_TUNER_CAP_RDS | 447 V4L2_TUNER_CAP_LOW; 448 449 return 0; 450 } 451 452 /* Set modulator attributes. If mode is not TX, set to TX. */ 453 static int fm_v4l2_vidioc_s_modulator(struct file *file, void *priv, 454 const struct v4l2_modulator *mod) 455 { 456 struct fmdev *fmdev = video_drvdata(file); 457 u8 rds_mode; 458 u16 aud_mode; 459 int ret; 460 461 if (mod->index != 0) 462 return -EINVAL; 463 464 if (fmdev->curr_fmmode != FM_MODE_TX) { 465 ret = fmc_set_mode(fmdev, FM_MODE_TX); 466 if (ret != 0) { 467 fmerr("Failed to set TX mode\n"); 468 return ret; 469 } 470 } 471 472 aud_mode = (mod->txsubchans & V4L2_TUNER_SUB_STEREO) ? 473 FM_STEREO_MODE : FM_MONO_MODE; 474 rds_mode = (mod->txsubchans & V4L2_TUNER_SUB_RDS) ? 475 FM_RDS_ENABLE : FM_RDS_DISABLE; 476 ret = fm_tx_set_stereo_mono(fmdev, aud_mode); 477 if (ret < 0) { 478 fmerr("Failed to set mono/stereo mode for TX\n"); 479 return ret; 480 } 481 ret = fm_tx_set_rds_mode(fmdev, rds_mode); 482 if (ret < 0) 483 fmerr("Failed to set rds mode for TX\n"); 484 485 return ret; 486 } 487 488 static const struct v4l2_file_operations fm_drv_fops = { 489 .owner = THIS_MODULE, 490 .read = fm_v4l2_fops_read, 491 .write = fm_v4l2_fops_write, 492 .poll = fm_v4l2_fops_poll, 493 .unlocked_ioctl = video_ioctl2, 494 .open = fm_v4l2_fops_open, 495 .release = fm_v4l2_fops_release, 496 }; 497 498 static const struct v4l2_ctrl_ops fm_ctrl_ops = { 499 .s_ctrl = fm_v4l2_s_ctrl, 500 .g_volatile_ctrl = fm_g_volatile_ctrl, 501 }; 502 static const struct v4l2_ioctl_ops fm_drv_ioctl_ops = { 503 .vidioc_querycap = fm_v4l2_vidioc_querycap, 504 .vidioc_g_audio = fm_v4l2_vidioc_g_audio, 505 .vidioc_s_audio = fm_v4l2_vidioc_s_audio, 506 .vidioc_g_tuner = fm_v4l2_vidioc_g_tuner, 507 .vidioc_s_tuner = fm_v4l2_vidioc_s_tuner, 508 .vidioc_g_frequency = fm_v4l2_vidioc_g_freq, 509 .vidioc_s_frequency = fm_v4l2_vidioc_s_freq, 510 .vidioc_s_hw_freq_seek = fm_v4l2_vidioc_s_hw_freq_seek, 511 .vidioc_g_modulator = fm_v4l2_vidioc_g_modulator, 512 .vidioc_s_modulator = fm_v4l2_vidioc_s_modulator 513 }; 514 515 /* V4L2 RADIO device parent structure */ 516 static struct video_device fm_viddev_template = { 517 .fops = &fm_drv_fops, 518 .ioctl_ops = &fm_drv_ioctl_ops, 519 .name = FM_DRV_NAME, 520 .release = video_device_release, 521 /* 522 * To ensure both the tuner and modulator ioctls are accessible we 523 * set the vfl_dir to M2M to indicate this. 524 * 525 * It is not really a mem2mem device of course, but it can both receive 526 * and transmit using the same radio device. It's the only radio driver 527 * that does this and it should really be split in two radio devices, 528 * but that would affect applications using this driver. 529 */ 530 .vfl_dir = VFL_DIR_M2M, 531 }; 532 533 int fm_v4l2_init_video_device(struct fmdev *fmdev, int radio_nr) 534 { 535 struct v4l2_ctrl *ctrl; 536 int ret; 537 538 strlcpy(fmdev->v4l2_dev.name, FM_DRV_NAME, sizeof(fmdev->v4l2_dev.name)); 539 ret = v4l2_device_register(NULL, &fmdev->v4l2_dev); 540 if (ret < 0) 541 return ret; 542 543 /* Init mutex for core locking */ 544 mutex_init(&fmdev->mutex); 545 546 /* Allocate new video device */ 547 gradio_dev = video_device_alloc(); 548 if (NULL == gradio_dev) { 549 fmerr("Can't allocate video device\n"); 550 return -ENOMEM; 551 } 552 553 /* Setup FM driver's V4L2 properties */ 554 memcpy(gradio_dev, &fm_viddev_template, sizeof(fm_viddev_template)); 555 556 video_set_drvdata(gradio_dev, fmdev); 557 558 gradio_dev->lock = &fmdev->mutex; 559 gradio_dev->v4l2_dev = &fmdev->v4l2_dev; 560 561 /* Register with V4L2 subsystem as RADIO device */ 562 if (video_register_device(gradio_dev, VFL_TYPE_RADIO, radio_nr)) { 563 video_device_release(gradio_dev); 564 fmerr("Could not register video device\n"); 565 return -ENOMEM; 566 } 567 568 fmdev->radio_dev = gradio_dev; 569 570 /* Register to v4l2 ctrl handler framework */ 571 fmdev->radio_dev->ctrl_handler = &fmdev->ctrl_handler; 572 573 ret = v4l2_ctrl_handler_init(&fmdev->ctrl_handler, 5); 574 if (ret < 0) { 575 fmerr("(fmdev): Can't init ctrl handler\n"); 576 v4l2_ctrl_handler_free(&fmdev->ctrl_handler); 577 return -EBUSY; 578 } 579 580 /* 581 * Following controls are handled by V4L2 control framework. 582 * Added in ascending ID order. 583 */ 584 v4l2_ctrl_new_std(&fmdev->ctrl_handler, &fm_ctrl_ops, 585 V4L2_CID_AUDIO_VOLUME, FM_RX_VOLUME_MIN, 586 FM_RX_VOLUME_MAX, 1, FM_RX_VOLUME_MAX); 587 588 v4l2_ctrl_new_std(&fmdev->ctrl_handler, &fm_ctrl_ops, 589 V4L2_CID_AUDIO_MUTE, 0, 1, 1, 1); 590 591 v4l2_ctrl_new_std_menu(&fmdev->ctrl_handler, &fm_ctrl_ops, 592 V4L2_CID_TUNE_PREEMPHASIS, V4L2_PREEMPHASIS_75_uS, 593 0, V4L2_PREEMPHASIS_75_uS); 594 595 v4l2_ctrl_new_std(&fmdev->ctrl_handler, &fm_ctrl_ops, 596 V4L2_CID_TUNE_POWER_LEVEL, FM_PWR_LVL_LOW, 597 FM_PWR_LVL_HIGH, 1, FM_PWR_LVL_HIGH); 598 599 ctrl = v4l2_ctrl_new_std(&fmdev->ctrl_handler, &fm_ctrl_ops, 600 V4L2_CID_TUNE_ANTENNA_CAPACITOR, 0, 601 255, 1, 255); 602 603 if (ctrl) 604 ctrl->flags |= V4L2_CTRL_FLAG_VOLATILE; 605 606 return 0; 607 } 608 609 void *fm_v4l2_deinit_video_device(void) 610 { 611 struct fmdev *fmdev; 612 613 614 fmdev = video_get_drvdata(gradio_dev); 615 616 /* Unregister to v4l2 ctrl handler framework*/ 617 v4l2_ctrl_handler_free(&fmdev->ctrl_handler); 618 619 /* Unregister RADIO device from V4L2 subsystem */ 620 video_unregister_device(gradio_dev); 621 622 v4l2_device_unregister(&fmdev->v4l2_dev); 623 624 return fmdev; 625 } 626