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