[mirror_ubuntu-jammy-kernel.git] / drivers / media / radio / radio-tea5764.c

// SPDX-License-Identifier: GPL-2.0-or-later
/*
 * driver/media/radio/radio-tea5764.c
 *
 * Driver for TEA5764 radio chip for linux 2.6.
 * This driver is for TEA5764 chip from NXP, used in EZX phones from Motorola.
 * The I2C protocol is used for communicate with chip.
 *
 * Based in radio-tea5761.c Copyright (C) 2005 Nokia Corporation
 *
 *  Copyright (c) 2008 Fabio Belavenuto <belavenuto@gmail.com>
 *
 * History:
 * 2008-12-06   Fabio Belavenuto <belavenuto@gmail.com>
 *              initial code
 *
 * TODO:
 *  add platform_data support for IRQs platform dependencies
 *  add RDS support
 */
#include <linux/kernel.h>
#include <linux/slab.h>
#include <linux/module.h>
#include <linux/init.h>			/* Initdata			*/
#include <linux/videodev2.h>		/* kernel radio structs		*/
#include <linux/i2c.h>			/* I2C				*/
#include <media/v4l2-common.h>
#include <media/v4l2-ioctl.h>
#include <media/v4l2-device.h>
#include <media/v4l2-ctrls.h>
#include <media/v4l2-event.h>

#define DRIVER_VERSION	"0.0.2"

#define DRIVER_AUTHOR	"Fabio Belavenuto <belavenuto@gmail.com>"
#define DRIVER_DESC	"A driver for the TEA5764 radio chip for EZX Phones."

#define PINFO(format, ...)\
	printk(KERN_INFO KBUILD_MODNAME ": "\
		DRIVER_VERSION ": " format "\n", ## __VA_ARGS__)
#define PWARN(format, ...)\
	printk(KERN_WARNING KBUILD_MODNAME ": "\
		DRIVER_VERSION ": " format "\n", ## __VA_ARGS__)
# define PDEBUG(format, ...)\
	printk(KERN_DEBUG KBUILD_MODNAME ": "\
		DRIVER_VERSION ": " format "\n", ## __VA_ARGS__)

/* Frequency limits in MHz -- these are European values.  For Japanese
devices, that would be 76000 and 91000.  */
#define FREQ_MIN  87500U
#define FREQ_MAX 108000U
#define FREQ_MUL 16

/* TEA5764 registers */
#define TEA5764_MANID		0x002b
#define TEA5764_CHIPID		0x5764

#define TEA5764_INTREG_BLMSK	0x0001
#define TEA5764_INTREG_FRRMSK	0x0002
#define TEA5764_INTREG_LEVMSK	0x0008
#define TEA5764_INTREG_IFMSK	0x0010
#define TEA5764_INTREG_BLMFLAG	0x0100
#define TEA5764_INTREG_FRRFLAG	0x0200
#define TEA5764_INTREG_LEVFLAG	0x0800
#define TEA5764_INTREG_IFFLAG	0x1000

#define TEA5764_FRQSET_SUD	0x8000
#define TEA5764_FRQSET_SM	0x4000

#define TEA5764_TNCTRL_PUPD1	0x8000
#define TEA5764_TNCTRL_PUPD0	0x4000
#define TEA5764_TNCTRL_BLIM	0x2000
#define TEA5764_TNCTRL_SWPM	0x1000
#define TEA5764_TNCTRL_IFCTC	0x0800
#define TEA5764_TNCTRL_AFM	0x0400
#define TEA5764_TNCTRL_SMUTE	0x0200
#define TEA5764_TNCTRL_SNC	0x0100
#define TEA5764_TNCTRL_MU	0x0080
#define TEA5764_TNCTRL_SSL1	0x0040
#define TEA5764_TNCTRL_SSL0	0x0020
#define TEA5764_TNCTRL_HLSI	0x0010
#define TEA5764_TNCTRL_MST	0x0008
#define TEA5764_TNCTRL_SWP	0x0004
#define TEA5764_TNCTRL_DTC	0x0002
#define TEA5764_TNCTRL_AHLSI	0x0001

#define TEA5764_TUNCHK_LEVEL(x)	(((x) & 0x00F0) >> 4)
#define TEA5764_TUNCHK_IFCNT(x) (((x) & 0xFE00) >> 9)
#define TEA5764_TUNCHK_TUNTO	0x0100
#define TEA5764_TUNCHK_LD	0x0008
#define TEA5764_TUNCHK_STEREO	0x0004

#define TEA5764_TESTREG_TRIGFR	0x0800

struct tea5764_regs {
	u16 intreg;				/* INTFLAG & INTMSK */
	u16 frqset;				/* FRQSETMSB & FRQSETLSB */
	u16 tnctrl;				/* TNCTRL1 & TNCTRL2 */
	u16 frqchk;				/* FRQCHKMSB & FRQCHKLSB */
	u16 tunchk;				/* IFCHK & LEVCHK */
	u16 testreg;				/* TESTBITS & TESTMODE */
	u16 rdsstat;				/* RDSSTAT1 & RDSSTAT2 */
	u16 rdslb;				/* RDSLBMSB & RDSLBLSB */
	u16 rdspb;				/* RDSPBMSB & RDSPBLSB */
	u16 rdsbc;				/* RDSBBC & RDSGBC */
	u16 rdsctrl;				/* RDSCTRL1 & RDSCTRL2 */
	u16 rdsbbl;				/* PAUSEDET & RDSBBL */
	u16 manid;				/* MANID1 & MANID2 */
	u16 chipid;				/* CHIPID1 & CHIPID2 */
} __attribute__ ((packed));

struct tea5764_write_regs {
	u8 intreg;				/* INTMSK */
	__be16 frqset;				/* FRQSETMSB & FRQSETLSB */
	__be16 tnctrl;				/* TNCTRL1 & TNCTRL2 */
	__be16 testreg;				/* TESTBITS & TESTMODE */
	__be16 rdsctrl;				/* RDSCTRL1 & RDSCTRL2 */
	__be16 rdsbbl;				/* PAUSEDET & RDSBBL */
} __attribute__ ((packed));

#ifdef CONFIG_RADIO_TEA5764_XTAL
#define RADIO_TEA5764_XTAL 1
#else
#define RADIO_TEA5764_XTAL 0
#endif

static int radio_nr = -1;
static int use_xtal = RADIO_TEA5764_XTAL;

struct tea5764_device {
	struct v4l2_device		v4l2_dev;
	struct v4l2_ctrl_handler	ctrl_handler;
	struct i2c_client		*i2c_client;
	struct video_device		vdev;
	struct tea5764_regs		regs;
	struct mutex			mutex;
};

/* I2C code related */
static int tea5764_i2c_read(struct tea5764_device *radio)
{
	int i;
	u16 *p = (u16 *) &radio->regs;

	struct i2c_msg msgs[1] = {
		{	.addr = radio->i2c_client->addr,
			.flags = I2C_M_RD,
			.len = sizeof(radio->regs),
			.buf = (void *)&radio->regs
		},
	};
	if (i2c_transfer(radio->i2c_client->adapter, msgs, 1) != 1)
		return -EIO;
	for (i = 0; i < sizeof(struct tea5764_regs) / sizeof(u16); i++)
		p[i] = __be16_to_cpu((__force __be16)p[i]);

	return 0;
}

static int tea5764_i2c_write(struct tea5764_device *radio)
{
	struct tea5764_write_regs wr;
	struct tea5764_regs *r = &radio->regs;
	struct i2c_msg msgs[1] = {
		{
			.addr = radio->i2c_client->addr,
			.len = sizeof(wr),
			.buf = (void *)&wr
		},
	};
	wr.intreg  = r->intreg & 0xff;
	wr.frqset  = __cpu_to_be16(r->frqset);
	wr.tnctrl  = __cpu_to_be16(r->tnctrl);
	wr.testreg = __cpu_to_be16(r->testreg);
	wr.rdsctrl = __cpu_to_be16(r->rdsctrl);
	wr.rdsbbl  = __cpu_to_be16(r->rdsbbl);
	if (i2c_transfer(radio->i2c_client->adapter, msgs, 1) != 1)
		return -EIO;
	return 0;
}

static void tea5764_power_up(struct tea5764_device *radio)
{
	struct tea5764_regs *r = &radio->regs;

	if (!(r->tnctrl & TEA5764_TNCTRL_PUPD0)) {
		r->tnctrl &= ~(TEA5764_TNCTRL_AFM | TEA5764_TNCTRL_MU |
			       TEA5764_TNCTRL_HLSI);
		if (!use_xtal)
			r->testreg |= TEA5764_TESTREG_TRIGFR;
		else
			r->testreg &= ~TEA5764_TESTREG_TRIGFR;

		r->tnctrl |= TEA5764_TNCTRL_PUPD0;
		tea5764_i2c_write(radio);
	}
}

static void tea5764_power_down(struct tea5764_device *radio)
{
	struct tea5764_regs *r = &radio->regs;

	if (r->tnctrl & TEA5764_TNCTRL_PUPD0) {
		r->tnctrl &= ~TEA5764_TNCTRL_PUPD0;
		tea5764_i2c_write(radio);
	}
}

static void tea5764_set_freq(struct tea5764_device *radio, int freq)
{
	struct tea5764_regs *r = &radio->regs;

	/* formula: (freq [+ or -] 225000) / 8192 */
	if (r->tnctrl & TEA5764_TNCTRL_HLSI)
		r->frqset = (freq + 225000) / 8192;
	else
		r->frqset = (freq - 225000) / 8192;
}

static int tea5764_get_freq(struct tea5764_device *radio)
{
	struct tea5764_regs *r = &radio->regs;

	if (r->tnctrl & TEA5764_TNCTRL_HLSI)
		return (r->frqchk * 8192) - 225000;
	else
		return (r->frqchk * 8192) + 225000;
}

/* tune an frequency, freq is defined by v4l's TUNER_LOW, i.e. 1/16th kHz */
static void tea5764_tune(struct tea5764_device *radio, int freq)
{
	tea5764_set_freq(radio, freq);
	if (tea5764_i2c_write(radio))
		PWARN("Could not set frequency!");
}

static void tea5764_set_audout_mode(struct tea5764_device *radio, int audmode)
{
	struct tea5764_regs *r = &radio->regs;
	int tnctrl = r->tnctrl;

	if (audmode == V4L2_TUNER_MODE_MONO)
		r->tnctrl |= TEA5764_TNCTRL_MST;
	else
		r->tnctrl &= ~TEA5764_TNCTRL_MST;
	if (tnctrl != r->tnctrl)
		tea5764_i2c_write(radio);
}

static int tea5764_get_audout_mode(struct tea5764_device *radio)
{
	struct tea5764_regs *r = &radio->regs;

	if (r->tnctrl & TEA5764_TNCTRL_MST)
		return V4L2_TUNER_MODE_MONO;
	else
		return V4L2_TUNER_MODE_STEREO;
}

static void tea5764_mute(struct tea5764_device *radio, int on)
{
	struct tea5764_regs *r = &radio->regs;
	int tnctrl = r->tnctrl;

	if (on)
		r->tnctrl |= TEA5764_TNCTRL_MU;
	else
		r->tnctrl &= ~TEA5764_TNCTRL_MU;
	if (tnctrl != r->tnctrl)
		tea5764_i2c_write(radio);
}

/* V4L2 vidioc */
static int vidioc_querycap(struct file *file, void  *priv,
					struct v4l2_capability *v)
{
	struct tea5764_device *radio = video_drvdata(file);
	struct video_device *dev = &radio->vdev;

	strscpy(v->driver, dev->dev.driver->name, sizeof(v->driver));
	strscpy(v->card, dev->name, sizeof(v->card));
	snprintf(v->bus_info, sizeof(v->bus_info),
		 "I2C:%s", dev_name(&dev->dev));
	v->device_caps = V4L2_CAP_TUNER | V4L2_CAP_RADIO;
	v->capabilities = v->device_caps | V4L2_CAP_DEVICE_CAPS;
	return 0;
}

static int vidioc_g_tuner(struct file *file, void *priv,
				struct v4l2_tuner *v)
{
	struct tea5764_device *radio = video_drvdata(file);
	struct tea5764_regs *r = &radio->regs;

	if (v->index > 0)
		return -EINVAL;

	strscpy(v->name, "FM", sizeof(v->name));
	v->type = V4L2_TUNER_RADIO;
	tea5764_i2c_read(radio);
	v->rangelow   = FREQ_MIN * FREQ_MUL;
	v->rangehigh  = FREQ_MAX * FREQ_MUL;
	v->capability = V4L2_TUNER_CAP_LOW | V4L2_TUNER_CAP_STEREO;
	if (r->tunchk & TEA5764_TUNCHK_STEREO)
		v->rxsubchans = V4L2_TUNER_SUB_STEREO;
	else
		v->rxsubchans = V4L2_TUNER_SUB_MONO;
	v->audmode = tea5764_get_audout_mode(radio);
	v->signal = TEA5764_TUNCHK_LEVEL(r->tunchk) * 0xffff / 0xf;
	v->afc = TEA5764_TUNCHK_IFCNT(r->tunchk);

	return 0;
}

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

	if (v->index > 0)
		return -EINVAL;

	tea5764_set_audout_mode(radio, v->audmode);
	return 0;
}

static int vidioc_s_frequency(struct file *file, void *priv,
				const struct v4l2_frequency *f)
{
	struct tea5764_device *radio = video_drvdata(file);
	unsigned freq = f->frequency;

	if (f->tuner != 0 || f->type != V4L2_TUNER_RADIO)
		return -EINVAL;
	if (freq == 0) {
		/* We special case this as a power down control. */
		tea5764_power_down(radio);
		/* Yes, that's what is returned in this case. This
		   whole special case is non-compliant and should really
		   be replaced with something better, but changing this
		   might well break code that depends on this behavior.
		   So we keep it as-is. */
		return -EINVAL;
	}
	freq = clamp(freq, FREQ_MIN * FREQ_MUL, FREQ_MAX * FREQ_MUL);
	tea5764_power_up(radio);
	tea5764_tune(radio, (freq * 125) / 2);
	return 0;
}

static int vidioc_g_frequency(struct file *file, void *priv,
				struct v4l2_frequency *f)
{
	struct tea5764_device *radio = video_drvdata(file);
	struct tea5764_regs *r = &radio->regs;

	if (f->tuner != 0)
		return -EINVAL;
	tea5764_i2c_read(radio);
	f->type = V4L2_TUNER_RADIO;
	if (r->tnctrl & TEA5764_TNCTRL_PUPD0)
		f->frequency = (tea5764_get_freq(radio) * 2) / 125;
	else
		f->frequency = 0;

	return 0;
}

static int tea5764_s_ctrl(struct v4l2_ctrl *ctrl)
{
	struct tea5764_device *radio =
		container_of(ctrl->handler, struct tea5764_device, ctrl_handler);

	switch (ctrl->id) {
	case V4L2_CID_AUDIO_MUTE:
		tea5764_mute(radio, ctrl->val);
		return 0;
	}
	return -EINVAL;
}

static const struct v4l2_ctrl_ops tea5764_ctrl_ops = {
	.s_ctrl = tea5764_s_ctrl,
};

/* File system interface */
static const struct v4l2_file_operations tea5764_fops = {
	.owner		= THIS_MODULE,
	.open		= v4l2_fh_open,
	.release	= v4l2_fh_release,
	.poll		= v4l2_ctrl_poll,
	.unlocked_ioctl	= video_ioctl2,
};

static const struct v4l2_ioctl_ops tea5764_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,
};

/* V4L2 interface */
static const struct video_device tea5764_radio_template = {
	.name		= "TEA5764 FM-Radio",
	.fops           = &tea5764_fops,
	.ioctl_ops	= &tea5764_ioctl_ops,
	.release	= video_device_release_empty,
};

/* I2C probe: check if the device exists and register with v4l if it is */
static int tea5764_i2c_probe(struct i2c_client *client,
			     const struct i2c_device_id *id)
{
	struct tea5764_device *radio;
	struct v4l2_device *v4l2_dev;
	struct v4l2_ctrl_handler *hdl;
	struct tea5764_regs *r;
	int ret;

	PDEBUG("probe");
	radio = kzalloc(sizeof(struct tea5764_device), GFP_KERNEL);
	if (!radio)
		return -ENOMEM;

	v4l2_dev = &radio->v4l2_dev;
	ret = v4l2_device_register(&client->dev, v4l2_dev);
	if (ret < 0) {
		v4l2_err(v4l2_dev, "could not register v4l2_device\n");
		goto errfr;
	}

	hdl = &radio->ctrl_handler;
	v4l2_ctrl_handler_init(hdl, 1);
	v4l2_ctrl_new_std(hdl, &tea5764_ctrl_ops,
			V4L2_CID_AUDIO_MUTE, 0, 1, 1, 1);
	v4l2_dev->ctrl_handler = hdl;
	if (hdl->error) {
		ret = hdl->error;
		v4l2_err(v4l2_dev, "Could not register controls\n");
		goto errunreg;
	}

	mutex_init(&radio->mutex);
	radio->i2c_client = client;
	ret = tea5764_i2c_read(radio);
	if (ret)
		goto errunreg;
	r = &radio->regs;
	PDEBUG("chipid = %04X, manid = %04X", r->chipid, r->manid);
	if (r->chipid != TEA5764_CHIPID ||
		(r->manid & 0x0fff) != TEA5764_MANID) {
		PWARN("This chip is not a TEA5764!");
		ret = -EINVAL;
		goto errunreg;
	}

	radio->vdev = tea5764_radio_template;

	i2c_set_clientdata(client, radio);
	video_set_drvdata(&radio->vdev, radio);
	radio->vdev.lock = &radio->mutex;
	radio->vdev.v4l2_dev = v4l2_dev;

	/* initialize and power off the chip */
	tea5764_i2c_read(radio);
	tea5764_set_audout_mode(radio, V4L2_TUNER_MODE_STEREO);
	tea5764_mute(radio, 1);
	tea5764_power_down(radio);

	ret = video_register_device(&radio->vdev, VFL_TYPE_RADIO, radio_nr);
	if (ret < 0) {
		PWARN("Could not register video device!");
		goto errunreg;
	}

	PINFO("registered.");
	return 0;
errunreg:
	v4l2_ctrl_handler_free(hdl);
	v4l2_device_unregister(v4l2_dev);
errfr:
	kfree(radio);
	return ret;
}

static int tea5764_i2c_remove(struct i2c_client *client)
{
	struct tea5764_device *radio = i2c_get_clientdata(client);

	PDEBUG("remove");
	if (radio) {
		tea5764_power_down(radio);
		video_unregister_device(&radio->vdev);
		v4l2_ctrl_handler_free(&radio->ctrl_handler);
		v4l2_device_unregister(&radio->v4l2_dev);
		kfree(radio);
	}
	return 0;
}

/* I2C subsystem interface */
static const struct i2c_device_id tea5764_id[] = {
	{ "radio-tea5764", 0 },
	{ }					/* Terminating entry */
};
MODULE_DEVICE_TABLE(i2c, tea5764_id);

static struct i2c_driver tea5764_i2c_driver = {
	.driver = {
		.name = "radio-tea5764",
	},
	.probe = tea5764_i2c_probe,
	.remove = tea5764_i2c_remove,
	.id_table = tea5764_id,
};

module_i2c_driver(tea5764_i2c_driver);

MODULE_AUTHOR(DRIVER_AUTHOR);
MODULE_DESCRIPTION(DRIVER_DESC);
MODULE_LICENSE("GPL");
MODULE_VERSION(DRIVER_VERSION);

module_param(use_xtal, int, 0);
MODULE_PARM_DESC(use_xtal, "Chip have a xtal connected in board");
module_param(radio_nr, int, 0);
MODULE_PARM_DESC(radio_nr, "video4linux device number to use");
Commit	Line	Data
c942fddf	1	// SPDX-License-Identifier: GPL-2.0-or-later
46a60cfe FB	2	/*
	3	* driver/media/radio/radio-tea5764.c
	4	*
	5	* Driver for TEA5764 radio chip for linux 2.6.
	6	* This driver is for TEA5764 chip from NXP, used in EZX phones from Motorola.
	7	* The I2C protocol is used for communicate with chip.
	8	*
	9	* Based in radio-tea5761.c Copyright (C) 2005 Nokia Corporation
	10	*
	11	* Copyright (c) 2008 Fabio Belavenuto <belavenuto@gmail.com>
	12	*
46a60cfe FB	13	* History:
	14	* 2008-12-06 Fabio Belavenuto <belavenuto@gmail.com>
	15	* initial code
	16	*
	17	* TODO:
	18	* add platform_data support for IRQs platform dependencies
	19	* add RDS support
	20	*/
	21	#include <linux/kernel.h>
5a0e3ad6	22	#include <linux/slab.h>
46a60cfe FB	23	#include <linux/module.h>
	24	#include <linux/init.h> /* Initdata */
	25	#include <linux/videodev2.h> /* kernel radio structs */
	26	#include <linux/i2c.h> /* I2C */
	27	#include <media/v4l2-common.h>
	28	#include <media/v4l2-ioctl.h>
099f88ee	29	#include <media/v4l2-device.h>
16b37178	30	#include <media/v4l2-ctrls.h>
090fdf6a	31	#include <media/v4l2-event.h>
46a60cfe	32
29834c1a	33	#define DRIVER_VERSION "0.0.2"
46a60cfe FB	34
	35	#define DRIVER_AUTHOR "Fabio Belavenuto <belavenuto@gmail.com>"
	36	#define DRIVER_DESC "A driver for the TEA5764 radio chip for EZX Phones."
	37
	38	#define PINFO(format, ...)\
	39	printk(KERN_INFO KBUILD_MODNAME ": "\
	40	DRIVER_VERSION ": " format "\n", ## __VA_ARGS__)
	41	#define PWARN(format, ...)\
	42	printk(KERN_WARNING KBUILD_MODNAME ": "\
	43	DRIVER_VERSION ": " format "\n", ## __VA_ARGS__)
	44	# define PDEBUG(format, ...)\
	45	printk(KERN_DEBUG KBUILD_MODNAME ": "\
	46	DRIVER_VERSION ": " format "\n", ## __VA_ARGS__)
	47
	48	/* Frequency limits in MHz -- these are European values. For Japanese
	49	devices, that would be 76000 and 91000. */
b7300892 HV	50	#define FREQ_MIN 87500U
b7300892 HV	51	#define FREQ_MAX 108000U
46a60cfe FB	52	#define FREQ_MUL 16
	53
	54	/* TEA5764 registers */
	55	#define TEA5764_MANID 0x002b
	56	#define TEA5764_CHIPID 0x5764
	57
	58	#define TEA5764_INTREG_BLMSK 0x0001
	59	#define TEA5764_INTREG_FRRMSK 0x0002
	60	#define TEA5764_INTREG_LEVMSK 0x0008
	61	#define TEA5764_INTREG_IFMSK 0x0010
	62	#define TEA5764_INTREG_BLMFLAG 0x0100
	63	#define TEA5764_INTREG_FRRFLAG 0x0200
	64	#define TEA5764_INTREG_LEVFLAG 0x0800
	65	#define TEA5764_INTREG_IFFLAG 0x1000
	66
	67	#define TEA5764_FRQSET_SUD 0x8000
	68	#define TEA5764_FRQSET_SM 0x4000
	69
	70	#define TEA5764_TNCTRL_PUPD1 0x8000
	71	#define TEA5764_TNCTRL_PUPD0 0x4000
	72	#define TEA5764_TNCTRL_BLIM 0x2000
	73	#define TEA5764_TNCTRL_SWPM 0x1000
	74	#define TEA5764_TNCTRL_IFCTC 0x0800
	75	#define TEA5764_TNCTRL_AFM 0x0400
	76	#define TEA5764_TNCTRL_SMUTE 0x0200
	77	#define TEA5764_TNCTRL_SNC 0x0100
	78	#define TEA5764_TNCTRL_MU 0x0080
	79	#define TEA5764_TNCTRL_SSL1 0x0040
	80	#define TEA5764_TNCTRL_SSL0 0x0020
	81	#define TEA5764_TNCTRL_HLSI 0x0010
	82	#define TEA5764_TNCTRL_MST 0x0008
	83	#define TEA5764_TNCTRL_SWP 0x0004
	84	#define TEA5764_TNCTRL_DTC 0x0002
	85	#define TEA5764_TNCTRL_AHLSI 0x0001
	86
	87	#define TEA5764_TUNCHK_LEVEL(x) (((x) & 0x00F0) >> 4)
	88	#define TEA5764_TUNCHK_IFCNT(x) (((x) & 0xFE00) >> 9)
	89	#define TEA5764_TUNCHK_TUNTO 0x0100
	90	#define TEA5764_TUNCHK_LD 0x0008
	91	#define TEA5764_TUNCHK_STEREO 0x0004
	92
	93	#define TEA5764_TESTREG_TRIGFR 0x0800
	94
	95	struct tea5764_regs {
	96	u16 intreg; /* INTFLAG & INTMSK */
	97	u16 frqset; /* FRQSETMSB & FRQSETLSB */
	98	u16 tnctrl; /* TNCTRL1 & TNCTRL2 */
	99	u16 frqchk; /* FRQCHKMSB & FRQCHKLSB */
	100	u16 tunchk; /* IFCHK & LEVCHK */
	101	u16 testreg; /* TESTBITS & TESTMODE */
	102	u16 rdsstat; /* RDSSTAT1 & RDSSTAT2 */
	103	u16 rdslb; /* RDSLBMSB & RDSLBLSB */
	104	u16 rdspb; /* RDSPBMSB & RDSPBLSB */
	105	u16 rdsbc; /* RDSBBC & RDSGBC */
	106	u16 rdsctrl; /* RDSCTRL1 & RDSCTRL2 */
	107	u16 rdsbbl; /* PAUSEDET & RDSBBL */
	108	u16 manid; /* MANID1 & MANID2 */
	109	u16 chipid; /* CHIPID1 & CHIPID2 */
	110	} __attribute__ ((packed));
	111
	112	struct tea5764_write_regs {
	113	u8 intreg; /* INTMSK */
7754622b HV	114	__be16 frqset; /* FRQSETMSB & FRQSETLSB */
	115	__be16 tnctrl; /* TNCTRL1 & TNCTRL2 */
	116	__be16 testreg; /* TESTBITS & TESTMODE */
	117	__be16 rdsctrl; /* RDSCTRL1 & RDSCTRL2 */
	118	__be16 rdsbbl; /* PAUSEDET & RDSBBL */
46a60cfe FB	119	} __attribute__ ((packed));
46a60cfe FB	120
8c4343e5	121	#ifdef CONFIG_RADIO_TEA5764_XTAL
46a60cfe	122	#define RADIO_TEA5764_XTAL 1
8c4343e5 PB	123	#else
8c4343e5 PB	124	#define RADIO_TEA5764_XTAL 0
46a60cfe FB	125	#endif
	126
	127	static int radio_nr = -1;
	128	static int use_xtal = RADIO_TEA5764_XTAL;
	129
	130	struct tea5764_device {
16b37178 HV	131	struct v4l2_device v4l2_dev;
16b37178 HV	132	struct v4l2_ctrl_handler ctrl_handler;
46a60cfe	133	struct i2c_client *i2c_client;
cf9033f9	134	struct video_device vdev;
46a60cfe FB	135	struct tea5764_regs regs;
46a60cfe FB	136	struct mutex mutex;
46a60cfe FB	137	};
	138
	139	/* I2C code related */
0dec8688	140	static int tea5764_i2c_read(struct tea5764_device *radio)
46a60cfe FB	141	{
	142	int i;
	143	u16 p = (u16 ) &radio->regs;
	144
	145	struct i2c_msg msgs[1] = {
66ba9590 S	146	{ .addr = radio->i2c_client->addr,
	147	.flags = I2C_M_RD,
	148	.len = sizeof(radio->regs),
	149	.buf = (void *)&radio->regs
	150	},
46a60cfe FB	151	};
	152	if (i2c_transfer(radio->i2c_client->adapter, msgs, 1) != 1)
	153	return -EIO;
	154	for (i = 0; i < sizeof(struct tea5764_regs) / sizeof(u16); i++)
7754622b	155	p[i] = __be16_to_cpu((__force __be16)p[i]);
46a60cfe FB	156
	157	return 0;
	158	}
	159
0dec8688	160	static int tea5764_i2c_write(struct tea5764_device *radio)
46a60cfe FB	161	{
	162	struct tea5764_write_regs wr;
	163	struct tea5764_regs *r = &radio->regs;
	164	struct i2c_msg msgs[1] = {
66ba9590 S	165	{
	166	.addr = radio->i2c_client->addr,
	167	.len = sizeof(wr),
	168	.buf = (void *)&wr
	169	},
46a60cfe FB	170	};
	171	wr.intreg = r->intreg & 0xff;
	172	wr.frqset = __cpu_to_be16(r->frqset);
	173	wr.tnctrl = __cpu_to_be16(r->tnctrl);
	174	wr.testreg = __cpu_to_be16(r->testreg);
	175	wr.rdsctrl = __cpu_to_be16(r->rdsctrl);
	176	wr.rdsbbl = __cpu_to_be16(r->rdsbbl);
	177	if (i2c_transfer(radio->i2c_client->adapter, msgs, 1) != 1)
	178	return -EIO;
	179	return 0;
	180	}
	181
46a60cfe FB	182	static void tea5764_power_up(struct tea5764_device *radio)
	183	{
	184	struct tea5764_regs *r = &radio->regs;
	185
	186	if (!(r->tnctrl & TEA5764_TNCTRL_PUPD0)) {
	187	r->tnctrl &= ~(TEA5764_TNCTRL_AFM \| TEA5764_TNCTRL_MU \|
	188	TEA5764_TNCTRL_HLSI);
	189	if (!use_xtal)
	190	r->testreg \|= TEA5764_TESTREG_TRIGFR;
	191	else
	192	r->testreg &= ~TEA5764_TESTREG_TRIGFR;
	193
	194	r->tnctrl \|= TEA5764_TNCTRL_PUPD0;
	195	tea5764_i2c_write(radio);
	196	}
	197	}
	198
	199	static void tea5764_power_down(struct tea5764_device *radio)
	200	{
	201	struct tea5764_regs *r = &radio->regs;
	202
	203	if (r->tnctrl & TEA5764_TNCTRL_PUPD0) {
	204	r->tnctrl &= ~TEA5764_TNCTRL_PUPD0;
	205	tea5764_i2c_write(radio);
	206	}
	207	}
	208
	209	static void tea5764_set_freq(struct tea5764_device *radio, int freq)
	210	{
	211	struct tea5764_regs *r = &radio->regs;
	212
	213	/* formula: (freq [+ or -] 225000) / 8192 */
	214	if (r->tnctrl & TEA5764_TNCTRL_HLSI)
	215	r->frqset = (freq + 225000) / 8192;
	216	else
	217	r->frqset = (freq - 225000) / 8192;
	218	}
	219
	220	static int tea5764_get_freq(struct tea5764_device *radio)
	221	{
	222	struct tea5764_regs *r = &radio->regs;
	223
	224	if (r->tnctrl & TEA5764_TNCTRL_HLSI)
	225	return (r->frqchk * 8192) - 225000;
	226	else
	227	return (r->frqchk * 8192) + 225000;
	228	}
	229
	230	/* tune an frequency, freq is defined by v4l's TUNER_LOW, i.e. 1/16th kHz */
	231	static void tea5764_tune(struct tea5764_device *radio, int freq)
	232	{
	233	tea5764_set_freq(radio, freq);
	234	if (tea5764_i2c_write(radio))
	235	PWARN("Could not set frequency!");
	236	}
	237
	238	static void tea5764_set_audout_mode(struct tea5764_device *radio, int audmode)
	239	{
	240	struct tea5764_regs *r = &radio->regs;
	241	int tnctrl = r->tnctrl;
	242
	243	if (audmode == V4L2_TUNER_MODE_MONO)
	244	r->tnctrl \|= TEA5764_TNCTRL_MST;
	245	else
246	r->tnctrl &= ~TEA5764_TNCTRL_MST;
247	if (tnctrl != r->tnctrl)
248	tea5764_i2c_write(radio);
249	}
250
251	static int tea5764_get_audout_mode(struct tea5764_device *radio)
252	{
253	struct tea5764_regs *r = &radio->regs;
254
255	if (r->tnctrl & TEA5764_TNCTRL_MST)
256	return V4L2_TUNER_MODE_MONO;
257	else
258	return V4L2_TUNER_MODE_STEREO;
259	}
260
261	static void tea5764_mute(struct tea5764_device *radio, int on)
262	{
263	struct tea5764_regs *r = &radio->regs;
264	int tnctrl = r->tnctrl;
265
266	if (on)
267	r->tnctrl \|= TEA5764_TNCTRL_MU;
268	else
269	r->tnctrl &= ~TEA5764_TNCTRL_MU;
270	if (tnctrl != r->tnctrl)
271	tea5764_i2c_write(radio);
272	}
273
46a60cfe FB	274	/* V4L2 vidioc */
	275	static int vidioc_querycap(struct file file, void priv,
	276	struct v4l2_capability *v)
	277	{
	278	struct tea5764_device *radio = video_drvdata(file);
cf9033f9	279	struct video_device *dev = &radio->vdev;
46a60cfe	280
c0decac1 MCC	281	strscpy(v->driver, dev->dev.driver->name, sizeof(v->driver));
c0decac1 MCC	282	strscpy(v->card, dev->name, sizeof(v->card));
c3ef01ce KS	283	snprintf(v->bus_info, sizeof(v->bus_info),
c3ef01ce KS	284	"I2C:%s", dev_name(&dev->dev));
cc9231f8 HV	285	v->device_caps = V4L2_CAP_TUNER \| V4L2_CAP_RADIO;
cc9231f8 HV	286	v->capabilities = v->device_caps \| V4L2_CAP_DEVICE_CAPS;
46a60cfe FB	287	return 0;
	288	}
	289
	290	static int vidioc_g_tuner(struct file file, void priv,
	291	struct v4l2_tuner *v)
	292	{
	293	struct tea5764_device *radio = video_drvdata(file);
	294	struct tea5764_regs *r = &radio->regs;
	295
	296	if (v->index > 0)
	297	return -EINVAL;
	298
c0decac1	299	strscpy(v->name, "FM", sizeof(v->name));
46a60cfe FB	300	v->type = V4L2_TUNER_RADIO;
	301	tea5764_i2c_read(radio);
	302	v->rangelow = FREQ_MIN * FREQ_MUL;
	303	v->rangehigh = FREQ_MAX * FREQ_MUL;
	304	v->capability = V4L2_TUNER_CAP_LOW \| V4L2_TUNER_CAP_STEREO;
	305	if (r->tunchk & TEA5764_TUNCHK_STEREO)
5543e2b4 HV	306	v->rxsubchans = V4L2_TUNER_SUB_STEREO;
	307	else
	308	v->rxsubchans = V4L2_TUNER_SUB_MONO;
46a60cfe FB	309	v->audmode = tea5764_get_audout_mode(radio);
	310	v->signal = TEA5764_TUNCHK_LEVEL(r->tunchk) * 0xffff / 0xf;
	311	v->afc = TEA5764_TUNCHK_IFCNT(r->tunchk);
	312
	313	return 0;
	314	}
	315
	316	static int vidioc_s_tuner(struct file file, void priv,
2f73c7c5	317	const struct v4l2_tuner *v)
46a60cfe FB	318	{
	319	struct tea5764_device *radio = video_drvdata(file);
	320
	321	if (v->index > 0)
	322	return -EINVAL;
	323
	324	tea5764_set_audout_mode(radio, v->audmode);
	325	return 0;
	326	}
	327
	328	static int vidioc_s_frequency(struct file file, void priv,
b530a447	329	const struct v4l2_frequency *f)
46a60cfe FB	330	{
46a60cfe FB	331	struct tea5764_device *radio = video_drvdata(file);
b7300892	332	unsigned freq = f->frequency;
46a60cfe	333
a3a9e287	334	if (f->tuner != 0 \|\| f->type != V4L2_TUNER_RADIO)
46a60cfe	335	return -EINVAL;
b7300892	336	if (freq == 0) {
46a60cfe FB	337	/* We special case this as a power down control. */
46a60cfe FB	338	tea5764_power_down(radio);
b7300892 HV	339	/* Yes, that's what is returned in this case. This
	340	whole special case is non-compliant and should really
	341	be replaced with something better, but changing this
	342	might well break code that depends on this behavior.
	343	So we keep it as-is. */
46a60cfe	344	return -EINVAL;
b7300892	345	}
9ba6a91f	346	freq = clamp(freq, FREQ_MIN * FREQ_MUL, FREQ_MAX * FREQ_MUL);
46a60cfe	347	tea5764_power_up(radio);
b7300892	348	tea5764_tune(radio, (freq * 125) / 2);
46a60cfe FB	349	return 0;
	350	}
	351
	352	static int vidioc_g_frequency(struct file file, void priv,
	353	struct v4l2_frequency *f)
	354	{
	355	struct tea5764_device *radio = video_drvdata(file);
	356	struct tea5764_regs *r = &radio->regs;
	357
a3a9e287 HV	358	if (f->tuner != 0)
a3a9e287 HV	359	return -EINVAL;
46a60cfe	360	tea5764_i2c_read(radio);
46a60cfe FB	361	f->type = V4L2_TUNER_RADIO;
	362	if (r->tnctrl & TEA5764_TNCTRL_PUPD0)
	363	f->frequency = (tea5764_get_freq(radio) * 2) / 125;
	364	else
	365	f->frequency = 0;
	366
	367	return 0;
	368	}
	369
16b37178	370	static int tea5764_s_ctrl(struct v4l2_ctrl *ctrl)
46a60cfe	371	{
16b37178 HV	372	struct tea5764_device *radio =
16b37178 HV	373	container_of(ctrl->handler, struct tea5764_device, ctrl_handler);
46a60cfe FB	374
	375	switch (ctrl->id) {
	376	case V4L2_CID_AUDIO_MUTE:
16b37178	377	tea5764_mute(radio, ctrl->val);
46a60cfe FB	378	return 0;
	379	}
	380	return -EINVAL;
	381	}
	382
16b37178 HV	383	static const struct v4l2_ctrl_ops tea5764_ctrl_ops = {
	384	.s_ctrl = tea5764_s_ctrl,
	385	};
	386
46a60cfe FB	387	/* File system interface */
	388	static const struct v4l2_file_operations tea5764_fops = {
	389	.owner = THIS_MODULE,
090fdf6a HV	390	.open = v4l2_fh_open,
	391	.release = v4l2_fh_release,
	392	.poll = v4l2_ctrl_poll,
ee71e423	393	.unlocked_ioctl = video_ioctl2,
46a60cfe FB	394	};
	395
	396	static const struct v4l2_ioctl_ops tea5764_ioctl_ops = {
	397	.vidioc_querycap = vidioc_querycap,
	398	.vidioc_g_tuner = vidioc_g_tuner,
	399	.vidioc_s_tuner = vidioc_s_tuner,
46a60cfe FB	400	.vidioc_g_frequency = vidioc_g_frequency,
46a60cfe FB	401	.vidioc_s_frequency = vidioc_s_frequency,
090fdf6a HV	402	.vidioc_log_status = v4l2_ctrl_log_status,
	403	.vidioc_subscribe_event = v4l2_ctrl_subscribe_event,
	404	.vidioc_unsubscribe_event = v4l2_event_unsubscribe,
46a60cfe FB	405	};
	406
	407	/* V4L2 interface */
96cc6956	408	static const struct video_device tea5764_radio_template = {
46a60cfe FB	409	.name = "TEA5764 FM-Radio",
46a60cfe FB	410	.fops = &tea5764_fops,
6e6a8b5a	411	.ioctl_ops = &tea5764_ioctl_ops,
cf9033f9	412	.release = video_device_release_empty,
46a60cfe FB	413	};
	414
	415	/* I2C probe: check if the device exists and register with v4l if it is */
4c62e976 GKH	416	static int tea5764_i2c_probe(struct i2c_client *client,
4c62e976 GKH	417	const struct i2c_device_id *id)
46a60cfe FB	418	{
46a60cfe FB	419	struct tea5764_device *radio;
099f88ee	420	struct v4l2_device *v4l2_dev;
16b37178	421	struct v4l2_ctrl_handler *hdl;
46a60cfe FB	422	struct tea5764_regs *r;
	423	int ret;
	424
	425	PDEBUG("probe");
ee71e423	426	radio = kzalloc(sizeof(struct tea5764_device), GFP_KERNEL);
46a60cfe FB	427	if (!radio)
	428	return -ENOMEM;
	429
099f88ee HV	430	v4l2_dev = &radio->v4l2_dev;
	431	ret = v4l2_device_register(&client->dev, v4l2_dev);
	432	if (ret < 0) {
	433	v4l2_err(v4l2_dev, "could not register v4l2_device\n");
	434	goto errfr;
	435	}
16b37178 HV	436
	437	hdl = &radio->ctrl_handler;
	438	v4l2_ctrl_handler_init(hdl, 1);
	439	v4l2_ctrl_new_std(hdl, &tea5764_ctrl_ops,
	440	V4L2_CID_AUDIO_MUTE, 0, 1, 1, 1);
	441	v4l2_dev->ctrl_handler = hdl;
	442	if (hdl->error) {
	443	ret = hdl->error;
	444	v4l2_err(v4l2_dev, "Could not register controls\n");
	445	goto errunreg;
	446	}
	447
46a60cfe FB	448	mutex_init(&radio->mutex);
	449	radio->i2c_client = client;
	450	ret = tea5764_i2c_read(radio);
	451	if (ret)
099f88ee	452	goto errunreg;
46a60cfe FB	453	r = &radio->regs;
	454	PDEBUG("chipid = %04X, manid = %04X", r->chipid, r->manid);
	455	if (r->chipid != TEA5764_CHIPID \|\|
	456	(r->manid & 0x0fff) != TEA5764_MANID) {
	457	PWARN("This chip is not a TEA5764!");
	458	ret = -EINVAL;
099f88ee	459	goto errunreg;
46a60cfe FB	460	}
46a60cfe FB	461
cf9033f9	462	radio->vdev = tea5764_radio_template;
46a60cfe FB	463
46a60cfe FB	464	i2c_set_clientdata(client, radio);
cf9033f9 HV	465	video_set_drvdata(&radio->vdev, radio);
	466	radio->vdev.lock = &radio->mutex;
	467	radio->vdev.v4l2_dev = v4l2_dev;
46a60cfe FB	468
	469	/* initialize and power off the chip */
	470	tea5764_i2c_read(radio);
	471	tea5764_set_audout_mode(radio, V4L2_TUNER_MODE_STEREO);
	472	tea5764_mute(radio, 1);
	473	tea5764_power_down(radio);
	474
cf9033f9	475	ret = video_register_device(&radio->vdev, VFL_TYPE_RADIO, radio_nr);
ee71e423 HV	476	if (ret < 0) {
ee71e423 HV	477	PWARN("Could not register video device!");
cf9033f9	478	goto errunreg;
ee71e423 HV	479	}
ee71e423 HV	480
46a60cfe FB	481	PINFO("registered.");
46a60cfe FB	482	return 0;
099f88ee	483	errunreg:
16b37178	484	v4l2_ctrl_handler_free(hdl);
099f88ee	485	v4l2_device_unregister(v4l2_dev);
46a60cfe FB	486	errfr:
	487	kfree(radio);
	488	return ret;
	489	}
	490
4c62e976	491	static int tea5764_i2c_remove(struct i2c_client *client)
46a60cfe FB	492	{
	493	struct tea5764_device *radio = i2c_get_clientdata(client);
	494
	495	PDEBUG("remove");
	496	if (radio) {
	497	tea5764_power_down(radio);
cf9033f9	498	video_unregister_device(&radio->vdev);
16b37178	499	v4l2_ctrl_handler_free(&radio->ctrl_handler);
099f88ee	500	v4l2_device_unregister(&radio->v4l2_dev);
46a60cfe FB	501	kfree(radio);
	502	}
	503	return 0;
	504	}
	505
	506	/* I2C subsystem interface */
	507	static const struct i2c_device_id tea5764_id[] = {
	508	{ "radio-tea5764", 0 },
	509	{ } /* Terminating entry */
	510	};
	511	MODULE_DEVICE_TABLE(i2c, tea5764_id);
	512
	513	static struct i2c_driver tea5764_i2c_driver = {
	514	.driver = {
	515	.name = "radio-tea5764",
46a60cfe FB	516	},
46a60cfe FB	517	.probe = tea5764_i2c_probe,
4c62e976	518	.remove = tea5764_i2c_remove,
46a60cfe FB	519	.id_table = tea5764_id,
	520	};
	521
c6e8d86f	522	module_i2c_driver(tea5764_i2c_driver);
46a60cfe FB	523
	524	MODULE_AUTHOR(DRIVER_AUTHOR);
	525	MODULE_DESCRIPTION(DRIVER_DESC);
	526	MODULE_LICENSE("GPL");
29834c1a	527	MODULE_VERSION(DRIVER_VERSION);
46a60cfe	528
731884ba	529	module_param(use_xtal, int, 0);
46a60cfe FB	530	MODULE_PARM_DESC(use_xtal, "Chip have a xtal connected in board");
	531	module_param(radio_nr, int, 0);
	532	MODULE_PARM_DESC(radio_nr, "video4linux device number to use");