[linux-block.git] / drivers / media / radio / radio-miropcm20.c

// SPDX-License-Identifier: GPL-2.0-only
/*
 * Miro PCM20 radio driver for Linux radio support
 * (c) 1998 Ruurd Reitsma <R.A.Reitsma@wbmt.tudelft.nl>
 * Thanks to Norberto Pellici for the ACI device interface specification
 * The API part is based on the radiotrack driver by M. Kirkwood
 * This driver relies on the aci mixer provided by the snd-miro
 * ALSA driver.
 * Look there for further info...
 *
 * From the original miro RDS sources:
 *
 *  (c) 2001 Robert Siemer <Robert.Siemer@gmx.de>
 *
 *  Many thanks to Fred Seidel <seidel@metabox.de>, the
 *  designer of the RDS decoder hardware. With his help
 *  I was able to code this driver.
 *  Thanks also to Norberto Pellicci, Dominic Mounteney
 *  <DMounteney@pinnaclesys.com> and www.teleauskunft.de
 *  for good hints on finding Fred. It was somewhat hard
 *  to locate him here in Germany... [:
 *
 * This code has been reintroduced and converted to use
 * the new V4L2 RDS API by:
 *
 * Hans Verkuil <hans.verkuil@cisco.com>
 */

#include <linux/module.h>
#include <linux/init.h>
#include <linux/io.h>
#include <linux/delay.h>
#include <linux/videodev2.h>
#include <linux/kthread.h>
#include <media/v4l2-device.h>
#include <media/v4l2-ioctl.h>
#include <media/v4l2-ctrls.h>
#include <media/v4l2-fh.h>
#include <media/v4l2-event.h>
#include <sound/aci.h>

#define RDS_DATASHIFT          2   /* Bit 2 */
#define RDS_DATAMASK        (1 << RDS_DATASHIFT)
#define RDS_BUSYMASK        0x10   /* Bit 4 */
#define RDS_CLOCKMASK       0x08   /* Bit 3 */
#define RDS_DATA(x)         (((x) >> RDS_DATASHIFT) & 1)

#define RDS_STATUS      0x01
#define RDS_STATIONNAME 0x02
#define RDS_TEXT        0x03
#define RDS_ALTFREQ     0x04
#define RDS_TIMEDATE    0x05
#define RDS_PI_CODE     0x06
#define RDS_PTYTATP     0x07
#define RDS_RESET       0x08
#define RDS_RXVALUE     0x09

static int radio_nr = -1;
module_param(radio_nr, int, 0);
MODULE_PARM_DESC(radio_nr, "Set radio device number (/dev/radioX).  Default: -1 (autodetect)");

struct pcm20 {
	struct v4l2_device v4l2_dev;
	struct video_device vdev;
	struct v4l2_ctrl_handler ctrl_handler;
	struct v4l2_ctrl *rds_pty;
	struct v4l2_ctrl *rds_ps_name;
	struct v4l2_ctrl *rds_radio_test;
	struct v4l2_ctrl *rds_ta;
	struct v4l2_ctrl *rds_tp;
	struct v4l2_ctrl *rds_ms;
	/* thread for periodic RDS status checking */
	struct task_struct *kthread;
	unsigned long freq;
	u32 audmode;
	struct snd_miro_aci *aci;
	struct mutex lock;
};

static struct pcm20 pcm20_card = {
	.freq = 87 * 16000,
	.audmode = V4L2_TUNER_MODE_STEREO,
};


static int rds_waitread(struct snd_miro_aci *aci)
{
	u8 byte;
	int i = 2000;

	do {
		byte = inb(aci->aci_port + ACI_REG_RDS);
		i--;
	} while ((byte & RDS_BUSYMASK) && i);

	/*
	 * It's magic, but without this the data that you read later on
	 * is unreliable and full of bit errors. With this 1 usec delay
	 * everything is fine.
	 */
	udelay(1);
	return i ? byte : -1;
}

static int rds_rawwrite(struct snd_miro_aci *aci, u8 byte)
{
	if (rds_waitread(aci) >= 0) {
		outb(byte, aci->aci_port + ACI_REG_RDS);
		return 0;
	}
	return -1;
}

static int rds_write(struct snd_miro_aci *aci, u8 byte)
{
	u8 sendbuffer[8];
	int i;

	for (i = 7; i >= 0; i--)
		sendbuffer[7 - i] = (byte & (1 << i)) ? RDS_DATAMASK : 0;
	sendbuffer[0] |= RDS_CLOCKMASK;

	for (i = 0; i < 8; i++)
		rds_rawwrite(aci, sendbuffer[i]);
	return 0;
}

static int rds_readcycle_nowait(struct snd_miro_aci *aci)
{
	outb(0, aci->aci_port + ACI_REG_RDS);
	return rds_waitread(aci);
}

static int rds_readcycle(struct snd_miro_aci *aci)
{
	if (rds_rawwrite(aci, 0) < 0)
		return -1;
	return rds_waitread(aci);
}

static int rds_ack(struct snd_miro_aci *aci)
{
	int i = rds_readcycle(aci);

	if (i < 0)
		return -1;
	if (i & RDS_DATAMASK)
		return 0;  /* ACK  */
	return 1;  /* NACK */
}

static int rds_cmd(struct snd_miro_aci *aci, u8 cmd, u8 databuffer[], u8 datasize)
{
	int i, j;

	rds_write(aci, cmd);

	/* RDS_RESET doesn't need further processing */
	if (cmd == RDS_RESET)
		return 0;
	if (rds_ack(aci))
		return -EIO;
	if (datasize == 0)
		return 0;

	/* to be able to use rds_readcycle_nowait()
	   I have to waitread() here */
	if (rds_waitread(aci) < 0)
		return -1;

	memset(databuffer, 0, datasize);

	for (i = 0; i < 8 * datasize; i++) {
		j = rds_readcycle_nowait(aci);
		if (j < 0)
			return -EIO;
		databuffer[i / 8] |= RDS_DATA(j) << (7 - (i % 8));
	}
	return 0;
}

static int pcm20_setfreq(struct pcm20 *dev, unsigned long freq)
{
	unsigned char freql;
	unsigned char freqh;
	struct snd_miro_aci *aci = dev->aci;

	freq /= 160;
	if (!(aci->aci_version == 0x07 || aci->aci_version >= 0xb0))
		freq /= 10;  /* I don't know exactly which version
			      * needs this hack */
	freql = freq & 0xff;
	freqh = freq >> 8;

	rds_cmd(aci, RDS_RESET, NULL, 0);
	return snd_aci_cmd(aci, ACI_WRITE_TUNE, freql, freqh);
}

static int vidioc_querycap(struct file *file, void *priv,
				struct v4l2_capability *v)
{
	struct pcm20 *dev = video_drvdata(file);

	strscpy(v->driver, "Miro PCM20", sizeof(v->driver));
	strscpy(v->card, "Miro PCM20", sizeof(v->card));
	snprintf(v->bus_info, sizeof(v->bus_info), "ISA:%s", dev->v4l2_dev.name);
	v->device_caps = V4L2_CAP_TUNER | V4L2_CAP_RADIO | V4L2_CAP_RDS_CAPTURE;
	v->capabilities = v->device_caps | V4L2_CAP_DEVICE_CAPS;
	return 0;
}

static bool sanitize(char *p, int size)
{
	int i;
	bool ret = true;

	for (i = 0; i < size; i++) {
		if (p[i] < 32) {
			p[i] = ' ';
			ret = false;
		}
	}
	return ret;
}

static int vidioc_g_tuner(struct file *file, void *priv,
				struct v4l2_tuner *v)
{
	struct pcm20 *dev = video_drvdata(file);
	int res;
	u8 buf;

	if (v->index)
		return -EINVAL;
	strscpy(v->name, "FM", sizeof(v->name));
	v->type = V4L2_TUNER_RADIO;
	v->rangelow = 87*16000;
	v->rangehigh = 108*16000;
	res = snd_aci_cmd(dev->aci, ACI_READ_TUNERSTATION, -1, -1);
	v->signal = (res & 0x80) ? 0 : 0xffff;
	/* Note: stereo detection does not work if the audio is muted,
	   it will default to mono in that case. */
	res = snd_aci_cmd(dev->aci, ACI_READ_TUNERSTEREO, -1, -1);
	v->rxsubchans = (res & 0x40) ? V4L2_TUNER_SUB_MONO :
					V4L2_TUNER_SUB_STEREO;
	v->capability = V4L2_TUNER_CAP_LOW | V4L2_TUNER_CAP_STEREO |
			V4L2_TUNER_CAP_RDS | V4L2_TUNER_CAP_RDS_CONTROLS;
	v->audmode = dev->audmode;
	res = rds_cmd(dev->aci, RDS_RXVALUE, &buf, 1);
	if (res >= 0 && buf)
		v->rxsubchans |= V4L2_TUNER_SUB_RDS;
	return 0;
}

static int vidioc_s_tuner(struct file *file, void *priv,
				const struct v4l2_tuner *v)
{
	struct pcm20 *dev = video_drvdata(file);

	if (v->index)
		return -EINVAL;
	if (v->audmode > V4L2_TUNER_MODE_STEREO)
		dev->audmode = V4L2_TUNER_MODE_STEREO;
	else
		dev->audmode = v->audmode;
	snd_aci_cmd(dev->aci, ACI_SET_TUNERMONO,
			dev->audmode == V4L2_TUNER_MODE_MONO, -1);
	return 0;
}

static int vidioc_g_frequency(struct file *file, void *priv,
				struct v4l2_frequency *f)
{
	struct pcm20 *dev = video_drvdata(file);

	if (f->tuner != 0)
		return -EINVAL;

	f->type = V4L2_TUNER_RADIO;
	f->frequency = dev->freq;
	return 0;
}


static int vidioc_s_frequency(struct file *file, void *priv,
				const struct v4l2_frequency *f)
{
	struct pcm20 *dev = video_drvdata(file);

	if (f->tuner != 0 || f->type != V4L2_TUNER_RADIO)
		return -EINVAL;

	dev->freq = clamp_t(u32, f->frequency, 87 * 16000U, 108 * 16000U);
	pcm20_setfreq(dev, dev->freq);
	return 0;
}

static int pcm20_s_ctrl(struct v4l2_ctrl *ctrl)
{
	struct pcm20 *dev = container_of(ctrl->handler, struct pcm20, ctrl_handler);

	switch (ctrl->id) {
	case V4L2_CID_AUDIO_MUTE:
		snd_aci_cmd(dev->aci, ACI_SET_TUNERMUTE, ctrl->val, -1);
		return 0;
	}
	return -EINVAL;
}

static int pcm20_thread(void *data)
{
	struct pcm20 *dev = data;
	const unsigned no_rds_start_counter = 5;
	const unsigned sleep_msecs = 2000;
	unsigned no_rds_counter = no_rds_start_counter;

	for (;;) {
		char text_buffer[66];
		u8 buf;
		int res;

		msleep_interruptible(sleep_msecs);

		if (kthread_should_stop())
			break;

		res = rds_cmd(dev->aci, RDS_RXVALUE, &buf, 1);
		if (res)
			continue;
		if (buf == 0) {
			if (no_rds_counter == 0)
				continue;
			no_rds_counter--;
			if (no_rds_counter)
				continue;

			/*
			 * No RDS seen for no_rds_start_counter * sleep_msecs
			 * milliseconds, clear all RDS controls to their
			 * default values.
			 */
			v4l2_ctrl_s_ctrl_string(dev->rds_ps_name, "");
			v4l2_ctrl_s_ctrl(dev->rds_ms, 1);
			v4l2_ctrl_s_ctrl(dev->rds_ta, 0);
			v4l2_ctrl_s_ctrl(dev->rds_tp, 0);
			v4l2_ctrl_s_ctrl(dev->rds_pty, 0);
			v4l2_ctrl_s_ctrl_string(dev->rds_radio_test, "");
			continue;
		}
		no_rds_counter = no_rds_start_counter;

		res = rds_cmd(dev->aci, RDS_STATUS, &buf, 1);
		if (res)
			continue;
		if ((buf >> 3) & 1) {
			res = rds_cmd(dev->aci, RDS_STATIONNAME, text_buffer, 8);
			text_buffer[8] = 0;
			if (!res && sanitize(text_buffer, 8))
				v4l2_ctrl_s_ctrl_string(dev->rds_ps_name, text_buffer);
		}
		if ((buf >> 6) & 1) {
			u8 pty;

			res = rds_cmd(dev->aci, RDS_PTYTATP, &pty, 1);
			if (!res) {
				v4l2_ctrl_s_ctrl(dev->rds_ms, !!(pty & 0x01));
				v4l2_ctrl_s_ctrl(dev->rds_ta, !!(pty & 0x02));
				v4l2_ctrl_s_ctrl(dev->rds_tp, !!(pty & 0x80));
				v4l2_ctrl_s_ctrl(dev->rds_pty, (pty >> 2) & 0x1f);
			}
		}
		if ((buf >> 4) & 1) {
			res = rds_cmd(dev->aci, RDS_TEXT, text_buffer, 65);
			text_buffer[65] = 0;
			if (!res && sanitize(text_buffer + 1, 64))
				v4l2_ctrl_s_ctrl_string(dev->rds_radio_test, text_buffer + 1);
		}
	}
	return 0;
}

static int pcm20_open(struct file *file)
{
	struct pcm20 *dev = video_drvdata(file);
	int res = v4l2_fh_open(file);

	if (!res && v4l2_fh_is_singular_file(file) &&
	    IS_ERR_OR_NULL(dev->kthread)) {
		dev->kthread = kthread_run(pcm20_thread, dev, "%s",
					   dev->v4l2_dev.name);
		if (IS_ERR(dev->kthread)) {
			v4l2_err(&dev->v4l2_dev, "kernel_thread() failed\n");
			v4l2_fh_release(file);
			return PTR_ERR(dev->kthread);
		}
	}
	return res;
}

static int pcm20_release(struct file *file)
{
	struct pcm20 *dev = video_drvdata(file);

	if (v4l2_fh_is_singular_file(file) && !IS_ERR_OR_NULL(dev->kthread)) {
		kthread_stop(dev->kthread);
		dev->kthread = NULL;
	}
	return v4l2_fh_release(file);
}

static const struct v4l2_file_operations pcm20_fops = {
	.owner		= THIS_MODULE,
	.open		= pcm20_open,
	.poll		= v4l2_ctrl_poll,
	.release	= pcm20_release,
	.unlocked_ioctl	= video_ioctl2,
};

static const struct v4l2_ioctl_ops pcm20_ioctl_ops = {
	.vidioc_querycap    = vidioc_querycap,
	.vidioc_g_tuner     = vidioc_g_tuner,
	.vidioc_s_tuner     = vidioc_s_tuner,
	.vidioc_g_frequency = vidioc_g_frequency,
	.vidioc_s_frequency = vidioc_s_frequency,
	.vidioc_log_status  = v4l2_ctrl_log_status,
	.vidioc_subscribe_event = v4l2_ctrl_subscribe_event,
	.vidioc_unsubscribe_event = v4l2_event_unsubscribe,
};

static const struct v4l2_ctrl_ops pcm20_ctrl_ops = {
	.s_ctrl = pcm20_s_ctrl,
};

static int __init pcm20_init(void)
{
	struct pcm20 *dev = &pcm20_card;
	struct v4l2_device *v4l2_dev = &dev->v4l2_dev;
	struct v4l2_ctrl_handler *hdl;
	int res;

	dev->aci = snd_aci_get_aci();
	if (dev->aci == NULL) {
		v4l2_err(v4l2_dev,
			 "you must load the snd-miro driver first!\n");
		return -ENODEV;
	}
	strscpy(v4l2_dev->name, "radio-miropcm20", sizeof(v4l2_dev->name));
	mutex_init(&dev->lock);

	res = v4l2_device_register(NULL, v4l2_dev);
	if (res < 0) {
		v4l2_err(v4l2_dev, "could not register v4l2_device\n");
		return -EINVAL;
	}

	hdl = &dev->ctrl_handler;
	v4l2_ctrl_handler_init(hdl, 7);
	v4l2_ctrl_new_std(hdl, &pcm20_ctrl_ops,
			V4L2_CID_AUDIO_MUTE, 0, 1, 1, 1);
	dev->rds_pty = v4l2_ctrl_new_std(hdl, NULL,
			V4L2_CID_RDS_RX_PTY, 0, 0x1f, 1, 0);
	dev->rds_ps_name = v4l2_ctrl_new_std(hdl, NULL,
			V4L2_CID_RDS_RX_PS_NAME, 0, 8, 8, 0);
	dev->rds_radio_test = v4l2_ctrl_new_std(hdl, NULL,
			V4L2_CID_RDS_RX_RADIO_TEXT, 0, 64, 64, 0);
	dev->rds_ta = v4l2_ctrl_new_std(hdl, NULL,
			V4L2_CID_RDS_RX_TRAFFIC_ANNOUNCEMENT, 0, 1, 1, 0);
	dev->rds_tp = v4l2_ctrl_new_std(hdl, NULL,
			V4L2_CID_RDS_RX_TRAFFIC_PROGRAM, 0, 1, 1, 0);
	dev->rds_ms = v4l2_ctrl_new_std(hdl, NULL,
			V4L2_CID_RDS_RX_MUSIC_SPEECH, 0, 1, 1, 1);
	v4l2_dev->ctrl_handler = hdl;
	if (hdl->error) {
		res = hdl->error;
		v4l2_err(v4l2_dev, "Could not register control\n");
		goto err_hdl;
	}
	strscpy(dev->vdev.name, v4l2_dev->name, sizeof(dev->vdev.name));
	dev->vdev.v4l2_dev = v4l2_dev;
	dev->vdev.fops = &pcm20_fops;
	dev->vdev.ioctl_ops = &pcm20_ioctl_ops;
	dev->vdev.release = video_device_release_empty;
	dev->vdev.lock = &dev->lock;
	video_set_drvdata(&dev->vdev, dev);
	snd_aci_cmd(dev->aci, ACI_SET_TUNERMONO,
			dev->audmode == V4L2_TUNER_MODE_MONO, -1);
	pcm20_setfreq(dev, dev->freq);

	if (video_register_device(&dev->vdev, VFL_TYPE_RADIO, radio_nr) < 0)
		goto err_hdl;

	v4l2_info(v4l2_dev, "Mirosound PCM20 Radio tuner\n");
	return 0;
err_hdl:
	v4l2_ctrl_handler_free(hdl);
	v4l2_device_unregister(v4l2_dev);
	return -EINVAL;
}

MODULE_AUTHOR("Ruurd Reitsma, Krzysztof Helt");
MODULE_DESCRIPTION("A driver for the Miro PCM20 radio card.");
MODULE_LICENSE("GPL");

static void __exit pcm20_cleanup(void)
{
	struct pcm20 *dev = &pcm20_card;

	video_unregister_device(&dev->vdev);
	snd_aci_cmd(dev->aci, ACI_SET_TUNERMUTE, 1, -1);
	v4l2_ctrl_handler_free(&dev->ctrl_handler);
	v4l2_device_unregister(&dev->v4l2_dev);
}

module_init(pcm20_init);
module_exit(pcm20_cleanup);
Commit	Line	Data
09c434b8	1	// SPDX-License-Identifier: GPL-2.0-only
fdcfd4e7 HV	2	/*
fdcfd4e7 HV	3	* Miro PCM20 radio driver for Linux radio support
8366fc39 KH	4	* (c) 1998 Ruurd Reitsma <R.A.Reitsma@wbmt.tudelft.nl>
	5	* Thanks to Norberto Pellici for the ACI device interface specification
	6	* The API part is based on the radiotrack driver by M. Kirkwood
	7	* This driver relies on the aci mixer provided by the snd-miro
	8	* ALSA driver.
	9	* Look there for further info...
fdcfd4e7 HV	10	*
	11	* From the original miro RDS sources:
	12	*
	13	* (c) 2001 Robert Siemer <Robert.Siemer@gmx.de>
	14	*
	15	* Many thanks to Fred Seidel <seidel@metabox.de>, the
	16	* designer of the RDS decoder hardware. With his help
	17	* I was able to code this driver.
	18	* Thanks also to Norberto Pellicci, Dominic Mounteney
	19	* <DMounteney@pinnaclesys.com> and www.teleauskunft.de
	20	* for good hints on finding Fred. It was somewhat hard
	21	* to locate him here in Germany... [:
	22	*
	23	* This code has been reintroduced and converted to use
	24	* the new V4L2 RDS API by:
	25	*
	26	* Hans Verkuil <hans.verkuil@cisco.com>
8366fc39 KH	27	*/
	28
	29	#include <linux/module.h>
	30	#include <linux/init.h>
7102076c	31	#include <linux/io.h>
fdcfd4e7	32	#include <linux/delay.h>
8366fc39	33	#include <linux/videodev2.h>
fdcfd4e7	34	#include <linux/kthread.h>
8366fc39 KH	35	#include <media/v4l2-device.h>
8366fc39 KH	36	#include <media/v4l2-ioctl.h>
7f51a610	37	#include <media/v4l2-ctrls.h>
f7c096f7 HV	38	#include <media/v4l2-fh.h>
f7c096f7 HV	39	#include <media/v4l2-event.h>
8366fc39 KH	40	#include <sound/aci.h>
8366fc39 KH	41
fdcfd4e7 HV	42	#define RDS_DATASHIFT 2 /* Bit 2 */
	43	#define RDS_DATAMASK (1 << RDS_DATASHIFT)
	44	#define RDS_BUSYMASK 0x10 /* Bit 4 */
	45	#define RDS_CLOCKMASK 0x08 /* Bit 3 */
	46	#define RDS_DATA(x) (((x) >> RDS_DATASHIFT) & 1)
	47
	48	#define RDS_STATUS 0x01
	49	#define RDS_STATIONNAME 0x02
	50	#define RDS_TEXT 0x03
	51	#define RDS_ALTFREQ 0x04
	52	#define RDS_TIMEDATE 0x05
	53	#define RDS_PI_CODE 0x06
	54	#define RDS_PTYTATP 0x07
	55	#define RDS_RESET 0x08
	56	#define RDS_RXVALUE 0x09
	57
8366fc39 KH	58	static int radio_nr = -1;
	59	module_param(radio_nr, int, 0);
	60	MODULE_PARM_DESC(radio_nr, "Set radio device number (/dev/radioX). Default: -1 (autodetect)");
	61
8366fc39 KH	62	struct pcm20 {
	63	struct v4l2_device v4l2_dev;
	64	struct video_device vdev;
7f51a610	65	struct v4l2_ctrl_handler ctrl_handler;
fdcfd4e7 HV	66	struct v4l2_ctrl *rds_pty;
	67	struct v4l2_ctrl *rds_ps_name;
	68	struct v4l2_ctrl *rds_radio_test;
	69	struct v4l2_ctrl *rds_ta;
	70	struct v4l2_ctrl *rds_tp;
	71	struct v4l2_ctrl *rds_ms;
	72	/* thread for periodic RDS status checking */
	73	struct task_struct *kthread;
8366fc39	74	unsigned long freq;
f5e7cc4a	75	u32 audmode;
8366fc39	76	struct snd_miro_aci *aci;
32958fdd	77	struct mutex lock;
8366fc39 KH	78	};
	79
	80	static struct pcm20 pcm20_card = {
f5e7cc4a HV	81	.freq = 87 * 16000,
f5e7cc4a HV	82	.audmode = V4L2_TUNER_MODE_STEREO,
8366fc39 KH	83	};
8366fc39 KH	84
fdcfd4e7 HV	85
	86	static int rds_waitread(struct snd_miro_aci *aci)
	87	{
	88	u8 byte;
	89	int i = 2000;
	90
	91	do {
	92	byte = inb(aci->aci_port + ACI_REG_RDS);
	93	i--;
	94	} while ((byte & RDS_BUSYMASK) && i);
	95
	96	/*
	97	* It's magic, but without this the data that you read later on
	98	* is unreliable and full of bit errors. With this 1 usec delay
	99	* everything is fine.
	100	*/
	101	udelay(1);
	102	return i ? byte : -1;
	103	}
	104
	105	static int rds_rawwrite(struct snd_miro_aci *aci, u8 byte)
	106	{
	107	if (rds_waitread(aci) >= 0) {
	108	outb(byte, aci->aci_port + ACI_REG_RDS);
	109	return 0;
	110	}
	111	return -1;
	112	}
	113
	114	static int rds_write(struct snd_miro_aci *aci, u8 byte)
	115	{
	116	u8 sendbuffer[8];
	117	int i;
	118
	119	for (i = 7; i >= 0; i--)
	120	sendbuffer[7 - i] = (byte & (1 << i)) ? RDS_DATAMASK : 0;
	121	sendbuffer[0] \|= RDS_CLOCKMASK;
	122
	123	for (i = 0; i < 8; i++)
	124	rds_rawwrite(aci, sendbuffer[i]);
	125	return 0;
	126	}
	127
	128	static int rds_readcycle_nowait(struct snd_miro_aci *aci)
	129	{
	130	outb(0, aci->aci_port + ACI_REG_RDS);
	131	return rds_waitread(aci);
	132	}
	133
	134	static int rds_readcycle(struct snd_miro_aci *aci)
	135	{
	136	if (rds_rawwrite(aci, 0) < 0)
	137	return -1;
	138	return rds_waitread(aci);
	139	}
	140
	141	static int rds_ack(struct snd_miro_aci *aci)
	142	{
	143	int i = rds_readcycle(aci);
	144
	145	if (i < 0)
	146	return -1;
	147	if (i & RDS_DATAMASK)
	148	return 0; /* ACK */
149	return 1; /* NACK */
150	}
151
152	static int rds_cmd(struct snd_miro_aci *aci, u8 cmd, u8 databuffer[], u8 datasize)
153	{
154	int i, j;
155
156	rds_write(aci, cmd);
157
158	/* RDS_RESET doesn't need further processing */
159	if (cmd == RDS_RESET)
160	return 0;
161	if (rds_ack(aci))
162	return -EIO;
163	if (datasize == 0)
164	return 0;
165
166	/* to be able to use rds_readcycle_nowait()
167	I have to waitread() here */
168	if (rds_waitread(aci) < 0)
169	return -1;
170
171	memset(databuffer, 0, datasize);
172
173	for (i = 0; i < 8 * datasize; i++) {
174	j = rds_readcycle_nowait(aci);
175	if (j < 0)
176	return -EIO;
177	databuffer[i / 8] \|= RDS_DATA(j) << (7 - (i % 8));
178	}
179	return 0;
180	}
181
8366fc39 KH	182	static int pcm20_setfreq(struct pcm20 *dev, unsigned long freq)
	183	{
	184	unsigned char freql;
	185	unsigned char freqh;
	186	struct snd_miro_aci *aci = dev->aci;
	187
8366fc39 KH	188	freq /= 160;
	189	if (!(aci->aci_version == 0x07 \|\| aci->aci_version >= 0xb0))
	190	freq /= 10; /* I don't know exactly which version
	191	* needs this hack */
	192	freql = freq & 0xff;
	193	freqh = freq >> 8;
	194
27dcb00d	195	rds_cmd(aci, RDS_RESET, NULL, 0);
8366fc39 KH	196	return snd_aci_cmd(aci, ACI_WRITE_TUNE, freql, freqh);
	197	}
	198
8366fc39 KH	199	static int vidioc_querycap(struct file file, void priv,
	200	struct v4l2_capability *v)
	201	{
f122d9a8 HV	202	struct pcm20 *dev = video_drvdata(file);
f122d9a8 HV	203
c0decac1 MCC	204	strscpy(v->driver, "Miro PCM20", sizeof(v->driver));
c0decac1 MCC	205	strscpy(v->card, "Miro PCM20", sizeof(v->card));
f122d9a8	206	snprintf(v->bus_info, sizeof(v->bus_info), "ISA:%s", dev->v4l2_dev.name);
fdcfd4e7	207	v->device_caps = V4L2_CAP_TUNER \| V4L2_CAP_RADIO \| V4L2_CAP_RDS_CAPTURE;
f122d9a8	208	v->capabilities = v->device_caps \| V4L2_CAP_DEVICE_CAPS;
8366fc39 KH	209	return 0;
	210	}
	211
fdcfd4e7 HV	212	static bool sanitize(char *p, int size)
	213	{
	214	int i;
	215	bool ret = true;
	216
	217	for (i = 0; i < size; i++) {
9c46c7fa	218	if (p[i] < 32) {
fdcfd4e7 HV	219	p[i] = ' ';
	220	ret = false;
	221	}
	222	}
	223	return ret;
	224	}
	225
8366fc39 KH	226	static int vidioc_g_tuner(struct file file, void priv,
	227	struct v4l2_tuner *v)
	228	{
f5e7cc4a	229	struct pcm20 *dev = video_drvdata(file);
9bbc5820	230	int res;
fdcfd4e7	231	u8 buf;
f5e7cc4a HV	232
f5e7cc4a HV	233	if (v->index)
8366fc39	234	return -EINVAL;
c0decac1	235	strscpy(v->name, "FM", sizeof(v->name));
8366fc39 KH	236	v->type = V4L2_TUNER_RADIO;
	237	v->rangelow = 87*16000;
	238	v->rangehigh = 108*16000;
9bbc5820 HV	239	res = snd_aci_cmd(dev->aci, ACI_READ_TUNERSTATION, -1, -1);
	240	v->signal = (res & 0x80) ? 0 : 0xffff;
	241	/* Note: stereo detection does not work if the audio is muted,
	242	it will default to mono in that case. */
	243	res = snd_aci_cmd(dev->aci, ACI_READ_TUNERSTEREO, -1, -1);
	244	v->rxsubchans = (res & 0x40) ? V4L2_TUNER_SUB_MONO :
	245	V4L2_TUNER_SUB_STEREO;
fdcfd4e7 HV	246	v->capability = V4L2_TUNER_CAP_LOW \| V4L2_TUNER_CAP_STEREO \|
fdcfd4e7 HV	247	V4L2_TUNER_CAP_RDS \| V4L2_TUNER_CAP_RDS_CONTROLS;
f5e7cc4a	248	v->audmode = dev->audmode;
fdcfd4e7 HV	249	res = rds_cmd(dev->aci, RDS_RXVALUE, &buf, 1);
	250	if (res >= 0 && buf)
	251	v->rxsubchans \|= V4L2_TUNER_SUB_RDS;
8366fc39 KH	252	return 0;
	253	}
	254
	255	static int vidioc_s_tuner(struct file file, void priv,
2f73c7c5	256	const struct v4l2_tuner *v)
8366fc39	257	{
f5e7cc4a HV	258	struct pcm20 *dev = video_drvdata(file);
	259
	260	if (v->index)
	261	return -EINVAL;
	262	if (v->audmode > V4L2_TUNER_MODE_STEREO)
2f73c7c5 HV	263	dev->audmode = V4L2_TUNER_MODE_STEREO;
	264	else
	265	dev->audmode = v->audmode;
f5e7cc4a	266	snd_aci_cmd(dev->aci, ACI_SET_TUNERMONO,
2f73c7c5	267	dev->audmode == V4L2_TUNER_MODE_MONO, -1);
f5e7cc4a	268	return 0;
8366fc39 KH	269	}
	270
	271	static int vidioc_g_frequency(struct file file, void priv,
	272	struct v4l2_frequency *f)
	273	{
	274	struct pcm20 *dev = video_drvdata(file);
	275
	276	if (f->tuner != 0)
	277	return -EINVAL;
	278
	279	f->type = V4L2_TUNER_RADIO;
	280	f->frequency = dev->freq;
	281	return 0;
	282	}
	283
	284
	285	static int vidioc_s_frequency(struct file file, void priv,
b530a447	286	const struct v4l2_frequency *f)
8366fc39 KH	287	{
	288	struct pcm20 *dev = video_drvdata(file);
	289
	290	if (f->tuner != 0 \|\| f->type != V4L2_TUNER_RADIO)
	291	return -EINVAL;
	292
b530a447	293	dev->freq = clamp_t(u32, f->frequency, 87 * 16000U, 108 * 16000U);
f5e7cc4a	294	pcm20_setfreq(dev, dev->freq);
8366fc39 KH	295	return 0;
	296	}
	297
7f51a610	298	static int pcm20_s_ctrl(struct v4l2_ctrl *ctrl)
8366fc39	299	{
7f51a610	300	struct pcm20 *dev = container_of(ctrl->handler, struct pcm20, ctrl_handler);
8366fc39 KH	301
	302	switch (ctrl->id) {
	303	case V4L2_CID_AUDIO_MUTE:
f5e7cc4a	304	snd_aci_cmd(dev->aci, ACI_SET_TUNERMUTE, ctrl->val, -1);
7f51a610	305	return 0;
8366fc39	306	}
7f51a610	307	return -EINVAL;
8366fc39 KH	308	}
8366fc39 KH	309
fdcfd4e7 HV	310	static int pcm20_thread(void *data)
	311	{
	312	struct pcm20 *dev = data;
	313	const unsigned no_rds_start_counter = 5;
	314	const unsigned sleep_msecs = 2000;
	315	unsigned no_rds_counter = no_rds_start_counter;
	316
	317	for (;;) {
	318	char text_buffer[66];
	319	u8 buf;
	320	int res;
	321
	322	msleep_interruptible(sleep_msecs);
	323
	324	if (kthread_should_stop())
	325	break;
	326
	327	res = rds_cmd(dev->aci, RDS_RXVALUE, &buf, 1);
	328	if (res)
	329	continue;
	330	if (buf == 0) {
	331	if (no_rds_counter == 0)
	332	continue;
	333	no_rds_counter--;
	334	if (no_rds_counter)
	335	continue;
	336
	337	/*
	338	* No RDS seen for no_rds_start_counter * sleep_msecs
	339	* milliseconds, clear all RDS controls to their
	340	* default values.
	341	*/
	342	v4l2_ctrl_s_ctrl_string(dev->rds_ps_name, "");
	343	v4l2_ctrl_s_ctrl(dev->rds_ms, 1);
	344	v4l2_ctrl_s_ctrl(dev->rds_ta, 0);
	345	v4l2_ctrl_s_ctrl(dev->rds_tp, 0);
	346	v4l2_ctrl_s_ctrl(dev->rds_pty, 0);
	347	v4l2_ctrl_s_ctrl_string(dev->rds_radio_test, "");
	348	continue;
	349	}
	350	no_rds_counter = no_rds_start_counter;
	351
	352	res = rds_cmd(dev->aci, RDS_STATUS, &buf, 1);
	353	if (res)
	354	continue;
	355	if ((buf >> 3) & 1) {
	356	res = rds_cmd(dev->aci, RDS_STATIONNAME, text_buffer, 8);
	357	text_buffer[8] = 0;
	358	if (!res && sanitize(text_buffer, 8))
	359	v4l2_ctrl_s_ctrl_string(dev->rds_ps_name, text_buffer);
	360	}
	361	if ((buf >> 6) & 1) {
	362	u8 pty;
	363
	364	res = rds_cmd(dev->aci, RDS_PTYTATP, &pty, 1);
	365	if (!res) {
	366	v4l2_ctrl_s_ctrl(dev->rds_ms, !!(pty & 0x01));
	367	v4l2_ctrl_s_ctrl(dev->rds_ta, !!(pty & 0x02));
	368	v4l2_ctrl_s_ctrl(dev->rds_tp, !!(pty & 0x80));
	369	v4l2_ctrl_s_ctrl(dev->rds_pty, (pty >> 2) & 0x1f);
	370	}
	371	}
	372	if ((buf >> 4) & 1) {
	373	res = rds_cmd(dev->aci, RDS_TEXT, text_buffer, 65);
374	text_buffer[65] = 0;
375	if (!res && sanitize(text_buffer + 1, 64))
376	v4l2_ctrl_s_ctrl_string(dev->rds_radio_test, text_buffer + 1);
377	}
378	}
379	return 0;
380	}
381
382	static int pcm20_open(struct file *file)
383	{
384	struct pcm20 *dev = video_drvdata(file);
385	int res = v4l2_fh_open(file);
386
387	if (!res && v4l2_fh_is_singular_file(file) &&
388	IS_ERR_OR_NULL(dev->kthread)) {
389	dev->kthread = kthread_run(pcm20_thread, dev, "%s",
390	dev->v4l2_dev.name);
391	if (IS_ERR(dev->kthread)) {
392	v4l2_err(&dev->v4l2_dev, "kernel_thread() failed\n");
393	v4l2_fh_release(file);
394	return PTR_ERR(dev->kthread);
395	}
396	}
397	return res;
398	}
399
400	static int pcm20_release(struct file *file)
401	{
402	struct pcm20 *dev = video_drvdata(file);
403
404	if (v4l2_fh_is_singular_file(file) && !IS_ERR_OR_NULL(dev->kthread)) {
405	kthread_stop(dev->kthread);
406	dev->kthread = NULL;
407	}
408	return v4l2_fh_release(file);
409	}
410
411	static const struct v4l2_file_operations pcm20_fops = {
412	.owner = THIS_MODULE,
413	.open = pcm20_open,
414	.poll = v4l2_ctrl_poll,
415	.release = pcm20_release,
416	.unlocked_ioctl = video_ioctl2,
417	};
418
8366fc39 KH	419	static const struct v4l2_ioctl_ops pcm20_ioctl_ops = {
	420	.vidioc_querycap = vidioc_querycap,
	421	.vidioc_g_tuner = vidioc_g_tuner,
	422	.vidioc_s_tuner = vidioc_s_tuner,
	423	.vidioc_g_frequency = vidioc_g_frequency,
	424	.vidioc_s_frequency = vidioc_s_frequency,
f7c096f7 HV	425	.vidioc_log_status = v4l2_ctrl_log_status,
	426	.vidioc_subscribe_event = v4l2_ctrl_subscribe_event,
	427	.vidioc_unsubscribe_event = v4l2_event_unsubscribe,
7f51a610 HV	428	};
	429
	430	static const struct v4l2_ctrl_ops pcm20_ctrl_ops = {
	431	.s_ctrl = pcm20_s_ctrl,
8366fc39 KH	432	};
	433
	434	static int __init pcm20_init(void)
	435	{
	436	struct pcm20 *dev = &pcm20_card;
	437	struct v4l2_device *v4l2_dev = &dev->v4l2_dev;
7f51a610	438	struct v4l2_ctrl_handler *hdl;
8366fc39 KH	439	int res;
	440
	441	dev->aci = snd_aci_get_aci();
	442	if (dev->aci == NULL) {
	443	v4l2_err(v4l2_dev,
	444	"you must load the snd-miro driver first!\n");
	445	return -ENODEV;
	446	}
c0decac1	447	strscpy(v4l2_dev->name, "radio-miropcm20", sizeof(v4l2_dev->name));
32958fdd	448	mutex_init(&dev->lock);
8366fc39 KH	449
	450	res = v4l2_device_register(NULL, v4l2_dev);
	451	if (res < 0) {
	452	v4l2_err(v4l2_dev, "could not register v4l2_device\n");
	453	return -EINVAL;
	454	}
	455
7f51a610	456	hdl = &dev->ctrl_handler;
fdcfd4e7	457	v4l2_ctrl_handler_init(hdl, 7);
7f51a610 HV	458	v4l2_ctrl_new_std(hdl, &pcm20_ctrl_ops,
7f51a610 HV	459	V4L2_CID_AUDIO_MUTE, 0, 1, 1, 1);
fdcfd4e7 HV	460	dev->rds_pty = v4l2_ctrl_new_std(hdl, NULL,
	461	V4L2_CID_RDS_RX_PTY, 0, 0x1f, 1, 0);
	462	dev->rds_ps_name = v4l2_ctrl_new_std(hdl, NULL,
	463	V4L2_CID_RDS_RX_PS_NAME, 0, 8, 8, 0);
	464	dev->rds_radio_test = v4l2_ctrl_new_std(hdl, NULL,
	465	V4L2_CID_RDS_RX_RADIO_TEXT, 0, 64, 64, 0);
	466	dev->rds_ta = v4l2_ctrl_new_std(hdl, NULL,
	467	V4L2_CID_RDS_RX_TRAFFIC_ANNOUNCEMENT, 0, 1, 1, 0);
	468	dev->rds_tp = v4l2_ctrl_new_std(hdl, NULL,
	469	V4L2_CID_RDS_RX_TRAFFIC_PROGRAM, 0, 1, 1, 0);
	470	dev->rds_ms = v4l2_ctrl_new_std(hdl, NULL,
	471	V4L2_CID_RDS_RX_MUSIC_SPEECH, 0, 1, 1, 1);
7f51a610 HV	472	v4l2_dev->ctrl_handler = hdl;
	473	if (hdl->error) {
	474	res = hdl->error;
	475	v4l2_err(v4l2_dev, "Could not register control\n");
	476	goto err_hdl;
	477	}
c0decac1	478	strscpy(dev->vdev.name, v4l2_dev->name, sizeof(dev->vdev.name));
8366fc39 KH	479	dev->vdev.v4l2_dev = v4l2_dev;
	480	dev->vdev.fops = &pcm20_fops;
	481	dev->vdev.ioctl_ops = &pcm20_ioctl_ops;
	482	dev->vdev.release = video_device_release_empty;
32958fdd	483	dev->vdev.lock = &dev->lock;
8366fc39	484	video_set_drvdata(&dev->vdev, dev);
f5e7cc4a HV	485	snd_aci_cmd(dev->aci, ACI_SET_TUNERMONO,
	486	dev->audmode == V4L2_TUNER_MODE_MONO, -1);
	487	pcm20_setfreq(dev, dev->freq);
8366fc39 KH	488
8366fc39 KH	489	if (video_register_device(&dev->vdev, VFL_TYPE_RADIO, radio_nr) < 0)
7f51a610	490	goto err_hdl;
8366fc39 KH	491
	492	v4l2_info(v4l2_dev, "Mirosound PCM20 Radio tuner\n");
	493	return 0;
7f51a610 HV	494	err_hdl:
7f51a610 HV	495	v4l2_ctrl_handler_free(hdl);
8366fc39 KH	496	v4l2_device_unregister(v4l2_dev);
	497	return -EINVAL;
	498	}
	499
	500	MODULE_AUTHOR("Ruurd Reitsma, Krzysztof Helt");
	501	MODULE_DESCRIPTION("A driver for the Miro PCM20 radio card.");
	502	MODULE_LICENSE("GPL");
	503
	504	static void __exit pcm20_cleanup(void)
	505	{
	506	struct pcm20 *dev = &pcm20_card;
	507
	508	video_unregister_device(&dev->vdev);
f5e7cc4a	509	snd_aci_cmd(dev->aci, ACI_SET_TUNERMUTE, 1, -1);
7f51a610	510	v4l2_ctrl_handler_free(&dev->ctrl_handler);
8366fc39 KH	511	v4l2_device_unregister(&dev->v4l2_dev);
	512	}
	513
	514	module_init(pcm20_init);
	515	module_exit(pcm20_cleanup);