[deliverable/linux.git] / drivers / media / radio / si470x / radio-si470x-i2c.c

/*
 * drivers/media/radio/si470x/radio-si470x-i2c.c
 *
 * I2C driver for radios with Silicon Labs Si470x FM Radio Receivers
 *
 * Copyright (c) 2009 Samsung Electronics Co.Ltd
 * Author: Joonyoung Shim <jy0922.shim@samsung.com>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 */


/* driver definitions */
#define DRIVER_AUTHOR "Joonyoung Shim <jy0922.shim@samsung.com>";
#define DRIVER_CARD "Silicon Labs Si470x FM Radio Receiver"
#define DRIVER_DESC "I2C radio driver for Si470x FM Radio Receivers"
#define DRIVER_VERSION "1.0.2"

/* kernel includes */
#include <linux/i2c.h>
#include <linux/slab.h>
#include <linux/delay.h>
#include <linux/interrupt.h>

#include "radio-si470x.h"


/* I2C Device ID List */
static const struct i2c_device_id si470x_i2c_id[] = {
	/* Generic Entry */
	{ "si470x", 0 },
	/* Terminating entry */
	{ }
};
MODULE_DEVICE_TABLE(i2c, si470x_i2c_id);


/**************************************************************************
 * Module Parameters
 **************************************************************************/

/* Radio Nr */
static int radio_nr = -1;
module_param(radio_nr, int, 0444);
MODULE_PARM_DESC(radio_nr, "Radio Nr");

/* RDS buffer blocks */
static unsigned int rds_buf = 100;
module_param(rds_buf, uint, 0444);
MODULE_PARM_DESC(rds_buf, "RDS buffer entries: *100*");

/* RDS maximum block errors */
static unsigned short max_rds_errors = 1;
/* 0 means   0  errors requiring correction */
/* 1 means 1-2  errors requiring correction (used by original USBRadio.exe) */
/* 2 means 3-5  errors requiring correction */
/* 3 means   6+ errors or errors in checkword, correction not possible */
module_param(max_rds_errors, ushort, 0644);
MODULE_PARM_DESC(max_rds_errors, "RDS maximum block errors: *1*");


/**************************************************************************
 * I2C Definitions
 **************************************************************************/

/* Write starts with the upper byte of register 0x02 */
#define WRITE_REG_NUM		8
#define WRITE_INDEX(i)		(i + 0x02)

/* Read starts with the upper byte of register 0x0a */
#define READ_REG_NUM		RADIO_REGISTER_NUM
#define READ_INDEX(i)		((i + RADIO_REGISTER_NUM - 0x0a) % READ_REG_NUM)


/**************************************************************************
 * General Driver Functions - REGISTERs
 **************************************************************************/

/*
 * si470x_get_register - read register
 */
int si470x_get_register(struct si470x_device *radio, int regnr)
{
	u16 buf[READ_REG_NUM];
	struct i2c_msg msgs[1] = {
		{
			.addr = radio->client->addr,
			.flags = I2C_M_RD,
			.len = sizeof(u16) * READ_REG_NUM,
			.buf = (void *)buf
		},
	};

	if (i2c_transfer(radio->client->adapter, msgs, 1) != 1)
		return -EIO;

	radio->registers[regnr] = __be16_to_cpu(buf[READ_INDEX(regnr)]);

	return 0;
}


/*
 * si470x_set_register - write register
 */
int si470x_set_register(struct si470x_device *radio, int regnr)
{
	int i;
	u16 buf[WRITE_REG_NUM];
	struct i2c_msg msgs[1] = {
		{
			.addr = radio->client->addr,
			.len = sizeof(u16) * WRITE_REG_NUM,
			.buf = (void *)buf
		},
	};

	for (i = 0; i < WRITE_REG_NUM; i++)
		buf[i] = __cpu_to_be16(radio->registers[WRITE_INDEX(i)]);

	if (i2c_transfer(radio->client->adapter, msgs, 1) != 1)
		return -EIO;

	return 0;
}


/**************************************************************************
 * General Driver Functions - ENTIRE REGISTERS
 **************************************************************************/

/*
 * si470x_get_all_registers - read entire registers
 */
static int si470x_get_all_registers(struct si470x_device *radio)
{
	int i;
	u16 buf[READ_REG_NUM];
	struct i2c_msg msgs[1] = {
		{
			.addr = radio->client->addr,
			.flags = I2C_M_RD,
			.len = sizeof(u16) * READ_REG_NUM,
			.buf = (void *)buf
		},
	};

	if (i2c_transfer(radio->client->adapter, msgs, 1) != 1)
		return -EIO;

	for (i = 0; i < READ_REG_NUM; i++)
		radio->registers[i] = __be16_to_cpu(buf[READ_INDEX(i)]);

	return 0;
}


/**************************************************************************
 * File Operations Interface
 **************************************************************************/

/*
 * si470x_fops_open - file open
 */
int si470x_fops_open(struct file *file)
{
	struct si470x_device *radio = video_drvdata(file);
	int retval = v4l2_fh_open(file);

	if (retval)
		return retval;

	if (v4l2_fh_is_singular_file(file)) {
		/* start radio */
		retval = si470x_start(radio);
		if (retval < 0)
			goto done;

		/* enable RDS / STC interrupt */
		radio->registers[SYSCONFIG1] |= SYSCONFIG1_RDSIEN;
		radio->registers[SYSCONFIG1] |= SYSCONFIG1_STCIEN;
		radio->registers[SYSCONFIG1] &= ~SYSCONFIG1_GPIO2;
		radio->registers[SYSCONFIG1] |= 0x1 << 2;
		retval = si470x_set_register(radio, SYSCONFIG1);
	}

done:
	if (retval)
		v4l2_fh_release(file);
	return retval;
}


/*
 * si470x_fops_release - file release
 */
int si470x_fops_release(struct file *file)
{
	struct si470x_device *radio = video_drvdata(file);

	if (v4l2_fh_is_singular_file(file))
		/* stop radio */
		si470x_stop(radio);

	return v4l2_fh_release(file);
}


/**************************************************************************
 * Video4Linux Interface
 **************************************************************************/

/*
 * si470x_vidioc_querycap - query device capabilities
 */
int si470x_vidioc_querycap(struct file *file, void *priv,
		struct v4l2_capability *capability)
{
	strlcpy(capability->driver, DRIVER_NAME, sizeof(capability->driver));
	strlcpy(capability->card, DRIVER_CARD, sizeof(capability->card));
	capability->device_caps = V4L2_CAP_HW_FREQ_SEEK | V4L2_CAP_READWRITE |
		V4L2_CAP_TUNER | V4L2_CAP_RADIO | V4L2_CAP_RDS_CAPTURE;
	capability->capabilities = capability->device_caps | V4L2_CAP_DEVICE_CAPS;

	return 0;
}


/**************************************************************************
 * I2C Interface
 **************************************************************************/

/*
 * si470x_i2c_interrupt - interrupt handler
 */
static irqreturn_t si470x_i2c_interrupt(int irq, void *dev_id)
{
	struct si470x_device *radio = dev_id;
	unsigned char regnr;
	unsigned char blocknum;
	unsigned short bler; /* rds block errors */
	unsigned short rds;
	unsigned char tmpbuf[3];
	int retval = 0;

	/* check Seek/Tune Complete */
	retval = si470x_get_register(radio, STATUSRSSI);
	if (retval < 0)
		goto end;

	if (radio->registers[STATUSRSSI] & STATUSRSSI_STC)
		complete(&radio->completion);

	/* safety checks */
	if ((radio->registers[SYSCONFIG1] & SYSCONFIG1_RDS) == 0)
		goto end;

	/* Update RDS registers */
	for (regnr = 1; regnr < RDS_REGISTER_NUM; regnr++) {
		retval = si470x_get_register(radio, STATUSRSSI + regnr);
		if (retval < 0)
			goto end;
	}

	/* get rds blocks */
	if ((radio->registers[STATUSRSSI] & STATUSRSSI_RDSR) == 0)
		/* No RDS group ready, better luck next time */
		goto end;

	for (blocknum = 0; blocknum < 4; blocknum++) {
		switch (blocknum) {
		default:
			bler = (radio->registers[STATUSRSSI] &
					STATUSRSSI_BLERA) >> 9;
			rds = radio->registers[RDSA];
			break;
		case 1:
			bler = (radio->registers[READCHAN] &
					READCHAN_BLERB) >> 14;
			rds = radio->registers[RDSB];
			break;
		case 2:
			bler = (radio->registers[READCHAN] &
					READCHAN_BLERC) >> 12;
			rds = radio->registers[RDSC];
			break;
		case 3:
			bler = (radio->registers[READCHAN] &
					READCHAN_BLERD) >> 10;
			rds = radio->registers[RDSD];
			break;
		}

		/* Fill the V4L2 RDS buffer */
		put_unaligned_le16(rds, &tmpbuf);
		tmpbuf[2] = blocknum;		/* offset name */
		tmpbuf[2] |= blocknum << 3;	/* received offset */
		if (bler > max_rds_errors)
			tmpbuf[2] |= 0x80;	/* uncorrectable errors */
		else if (bler > 0)
			tmpbuf[2] |= 0x40;	/* corrected error(s) */

		/* copy RDS block to internal buffer */
		memcpy(&radio->buffer[radio->wr_index], &tmpbuf, 3);
		radio->wr_index += 3;

		/* wrap write pointer */
		if (radio->wr_index >= radio->buf_size)
			radio->wr_index = 0;

		/* check for overflow */
		if (radio->wr_index == radio->rd_index) {
			/* increment and wrap read pointer */
			radio->rd_index += 3;
			if (radio->rd_index >= radio->buf_size)
				radio->rd_index = 0;
		}
	}

	if (radio->wr_index != radio->rd_index)
		wake_up_interruptible(&radio->read_queue);

end:
	return IRQ_HANDLED;
}


/*
 * si470x_i2c_probe - probe for the device
 */
static int si470x_i2c_probe(struct i2c_client *client,
			    const struct i2c_device_id *id)
{
	struct si470x_device *radio;
	int retval = 0;
	unsigned char version_warning = 0;

	/* private data allocation and initialization */
	radio = kzalloc(sizeof(struct si470x_device), GFP_KERNEL);
	if (!radio) {
		retval = -ENOMEM;
		goto err_initial;
	}

	radio->client = client;
	radio->band = 1; /* Default to 76 - 108 MHz */
	mutex_init(&radio->lock);
	init_completion(&radio->completion);

	/* video device initialization */
	radio->videodev = si470x_viddev_template;
	video_set_drvdata(&radio->videodev, radio);

	/* power up : need 110ms */
	radio->registers[POWERCFG] = POWERCFG_ENABLE;
	if (si470x_set_register(radio, POWERCFG) < 0) {
		retval = -EIO;
		goto err_radio;
	}
	msleep(110);

	/* get device and chip versions */
	if (si470x_get_all_registers(radio) < 0) {
		retval = -EIO;
		goto err_radio;
	}
	dev_info(&client->dev, "DeviceID=0x%4.4hx ChipID=0x%4.4hx\n",
			radio->registers[DEVICEID], radio->registers[SI_CHIPID]);
	if ((radio->registers[SI_CHIPID] & SI_CHIPID_FIRMWARE) < RADIO_FW_VERSION) {
		dev_warn(&client->dev,
			"This driver is known to work with "
			"firmware version %hu,\n", RADIO_FW_VERSION);
		dev_warn(&client->dev,
			"but the device has firmware version %hu.\n",
			radio->registers[SI_CHIPID] & SI_CHIPID_FIRMWARE);
		version_warning = 1;
	}

	/* give out version warning */
	if (version_warning == 1) {
		dev_warn(&client->dev,
			"If you have some trouble using this driver,\n");
		dev_warn(&client->dev,
			"please report to V4L ML at "
			"linux-media@vger.kernel.org\n");
	}

	/* set initial frequency */
	si470x_set_freq(radio, 87.5 * FREQ_MUL); /* available in all regions */

	/* rds buffer allocation */
	radio->buf_size = rds_buf * 3;
	radio->buffer = kmalloc(radio->buf_size, GFP_KERNEL);
	if (!radio->buffer) {
		retval = -EIO;
		goto err_radio;
	}

	/* rds buffer configuration */
	radio->wr_index = 0;
	radio->rd_index = 0;
	init_waitqueue_head(&radio->read_queue);

	retval = request_threaded_irq(client->irq, NULL, si470x_i2c_interrupt,
			IRQF_TRIGGER_FALLING | IRQF_ONESHOT, DRIVER_NAME,
			radio);
	if (retval) {
		dev_err(&client->dev, "Failed to register interrupt\n");
		goto err_rds;
	}

	/* register video device */
	retval = video_register_device(&radio->videodev, VFL_TYPE_RADIO,
			radio_nr);
	if (retval) {
		dev_warn(&client->dev, "Could not register video device\n");
		goto err_all;
	}
	i2c_set_clientdata(client, radio);

	return 0;
err_all:
	free_irq(client->irq, radio);
err_rds:
	kfree(radio->buffer);
err_radio:
	kfree(radio);
err_initial:
	return retval;
}


/*
 * si470x_i2c_remove - remove the device
 */
static int si470x_i2c_remove(struct i2c_client *client)
{
	struct si470x_device *radio = i2c_get_clientdata(client);

	free_irq(client->irq, radio);
	video_unregister_device(&radio->videodev);
	kfree(radio);

	return 0;
}


#ifdef CONFIG_PM_SLEEP
/*
 * si470x_i2c_suspend - suspend the device
 */
static int si470x_i2c_suspend(struct device *dev)
{
	struct i2c_client *client = to_i2c_client(dev);
	struct si470x_device *radio = i2c_get_clientdata(client);

	/* power down */
	radio->registers[POWERCFG] |= POWERCFG_DISABLE;
	if (si470x_set_register(radio, POWERCFG) < 0)
		return -EIO;

	return 0;
}


/*
 * si470x_i2c_resume - resume the device
 */
static int si470x_i2c_resume(struct device *dev)
{
	struct i2c_client *client = to_i2c_client(dev);
	struct si470x_device *radio = i2c_get_clientdata(client);

	/* power up : need 110ms */
	radio->registers[POWERCFG] |= POWERCFG_ENABLE;
	if (si470x_set_register(radio, POWERCFG) < 0)
		return -EIO;
	msleep(110);

	return 0;
}

static SIMPLE_DEV_PM_OPS(si470x_i2c_pm, si470x_i2c_suspend, si470x_i2c_resume);
#endif


/*
 * si470x_i2c_driver - i2c driver interface
 */
static struct i2c_driver si470x_i2c_driver = {
	.driver = {
		.name		= "si470x",
#ifdef CONFIG_PM_SLEEP
		.pm		= &si470x_i2c_pm,
#endif
	},
	.probe			= si470x_i2c_probe,
	.remove			= si470x_i2c_remove,
	.id_table		= si470x_i2c_id,
};

module_i2c_driver(si470x_i2c_driver);

MODULE_LICENSE("GPL");
MODULE_AUTHOR(DRIVER_AUTHOR);
MODULE_DESCRIPTION(DRIVER_DESC);
MODULE_VERSION(DRIVER_VERSION);
Commit	Line	Data
cc35bbdd JS	1	/*
	2	* drivers/media/radio/si470x/radio-si470x-i2c.c
	3	*
	4	* I2C driver for radios with Silicon Labs Si470x FM Radio Receivers
	5	*
9dcb79c2	6	* Copyright (c) 2009 Samsung Electronics Co.Ltd
cc35bbdd JS	7	* Author: Joonyoung Shim <jy0922.shim@samsung.com>
cc35bbdd JS	8	*
9dcb79c2 TL	9	* This program is free software; you can redistribute it and/or modify
	10	* it under the terms of the GNU General Public License as published by
	11	* the Free Software Foundation; either version 2 of the License, or
	12	* (at your option) any later version.
cc35bbdd	13	*
9dcb79c2 TL	14	* This program is distributed in the hope that it will be useful,
	15	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	16	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	17	* GNU General Public License for more details.
cc35bbdd	18	*
9dcb79c2 TL	19	* You should have received a copy of the GNU General Public License
	20	* along with this program; if not, write to the Free Software
	21	* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
	22	*/
	23
	24
9dcb79c2 TL	25	/* driver definitions */
9dcb79c2 TL	26	#define DRIVER_AUTHOR "Joonyoung Shim <jy0922.shim@samsung.com>";
9dcb79c2 TL	27	#define DRIVER_CARD "Silicon Labs Si470x FM Radio Receiver"
9dcb79c2 TL	28	#define DRIVER_DESC "I2C radio driver for Si470x FM Radio Receivers"
29834c1a	29	#define DRIVER_VERSION "1.0.2"
9dcb79c2 TL	30
9dcb79c2 TL	31	/* kernel includes */
cc35bbdd	32	#include <linux/i2c.h>
5a0e3ad6	33	#include <linux/slab.h>
cc35bbdd	34	#include <linux/delay.h>
fe2137dd	35	#include <linux/interrupt.h>
cc35bbdd JS	36
	37	#include "radio-si470x.h"
	38
cc35bbdd	39
9dcb79c2 TL	40	/* I2C Device ID List */
	41	static const struct i2c_device_id si470x_i2c_id[] = {
	42	/* Generic Entry */
	43	{ "si470x", 0 },
	44	/* Terminating entry */
	45	{ }
	46	};
	47	MODULE_DEVICE_TABLE(i2c, si470x_i2c_id);
	48
	49
	50
	51	/**************************************************************************
	52	* Module Parameters
	53	**************************************************************************/
	54
	55	/* Radio Nr */
	56	static int radio_nr = -1;
	57	module_param(radio_nr, int, 0444);
	58	MODULE_PARM_DESC(radio_nr, "Radio Nr");
	59
fe2137dd JS	60	/* RDS buffer blocks */
	61	static unsigned int rds_buf = 100;
	62	module_param(rds_buf, uint, 0444);
	63	MODULE_PARM_DESC(rds_buf, "RDS buffer entries: 100");
	64
	65	/* RDS maximum block errors */
	66	static unsigned short max_rds_errors = 1;
	67	/* 0 means 0 errors requiring correction */
	68	/* 1 means 1-2 errors requiring correction (used by original USBRadio.exe) */
	69	/* 2 means 3-5 errors requiring correction */
	70	/* 3 means 6+ errors or errors in checkword, correction not possible */
	71	module_param(max_rds_errors, ushort, 0644);
	72	MODULE_PARM_DESC(max_rds_errors, "RDS maximum block errors: 1");
	73
9dcb79c2 TL	74
	75
	76	/**************************************************************************
	77	* I2C Definitions
	78	**************************************************************************/
	79
	80	/* Write starts with the upper byte of register 0x02 */
	81	#define WRITE_REG_NUM 8
	82	#define WRITE_INDEX(i) (i + 0x02)
	83
	84	/* Read starts with the upper byte of register 0x0a */
cc35bbdd JS	85	#define READ_REG_NUM RADIO_REGISTER_NUM
	86	#define READ_INDEX(i) ((i + RADIO_REGISTER_NUM - 0x0a) % READ_REG_NUM)
	87
cc35bbdd	88
cc35bbdd	89
9dcb79c2 TL	90	/**************************************************************************
	91	* General Driver Functions - REGISTERs
	92	**************************************************************************/
cc35bbdd	93
9dcb79c2 TL	94	/*
	95	* si470x_get_register - read register
	96	*/
cc35bbdd JS	97	int si470x_get_register(struct si470x_device *radio, int regnr)
	98	{
	99	u16 buf[READ_REG_NUM];
	100	struct i2c_msg msgs[1] = {
058fef68 S	101	{
	102	.addr = radio->client->addr,
	103	.flags = I2C_M_RD,
	104	.len = sizeof(u16) * READ_REG_NUM,
	105	.buf = (void *)buf
	106	},
cc35bbdd JS	107	};
	108
	109	if (i2c_transfer(radio->client->adapter, msgs, 1) != 1)
	110	return -EIO;
	111
	112	radio->registers[regnr] = __be16_to_cpu(buf[READ_INDEX(regnr)]);
	113
	114	return 0;
	115	}
	116
cc35bbdd	117
9dcb79c2 TL	118	/*
	119	* si470x_set_register - write register
	120	*/
cc35bbdd JS	121	int si470x_set_register(struct si470x_device *radio, int regnr)
	122	{
	123	int i;
	124	u16 buf[WRITE_REG_NUM];
	125	struct i2c_msg msgs[1] = {
058fef68 S	126	{
	127	.addr = radio->client->addr,
	128	.len = sizeof(u16) * WRITE_REG_NUM,
	129	.buf = (void *)buf
	130	},
cc35bbdd JS	131	};
	132
	133	for (i = 0; i < WRITE_REG_NUM; i++)
	134	buf[i] = __cpu_to_be16(radio->registers[WRITE_INDEX(i)]);
	135
	136	if (i2c_transfer(radio->client->adapter, msgs, 1) != 1)
	137	return -EIO;
	138
	139	return 0;
	140	}
	141
9dcb79c2 TL	142
	143
	144	/**************************************************************************
	145	* General Driver Functions - ENTIRE REGISTERS
	146	**************************************************************************/
	147
	148	/*
	149	* si470x_get_all_registers - read entire registers
	150	*/
	151	static int si470x_get_all_registers(struct si470x_device *radio)
	152	{
	153	int i;
	154	u16 buf[READ_REG_NUM];
	155	struct i2c_msg msgs[1] = {
058fef68 S	156	{
	157	.addr = radio->client->addr,
	158	.flags = I2C_M_RD,
	159	.len = sizeof(u16) * READ_REG_NUM,
	160	.buf = (void *)buf
	161	},
9dcb79c2 TL	162	};
	163
	164	if (i2c_transfer(radio->client->adapter, msgs, 1) != 1)
	165	return -EIO;
	166
	167	for (i = 0; i < READ_REG_NUM; i++)
	168	radio->registers[i] = __be16_to_cpu(buf[READ_INDEX(i)]);
	169
	170	return 0;
	171	}
	172
	173
	174
9dcb79c2 TL	175	/**************************************************************************
	176	* File Operations Interface
	177	**************************************************************************/
	178
	179	/*
	180	* si470x_fops_open - file open
	181	*/
1aa925c9	182	int si470x_fops_open(struct file *file)
cc35bbdd JS	183	{
cc35bbdd JS	184	struct si470x_device *radio = video_drvdata(file);
4967d53d	185	int retval = v4l2_fh_open(file);
cc35bbdd	186
4967d53d HV	187	if (retval)
4967d53d HV	188	return retval;
cc35bbdd	189
4967d53d	190	if (v4l2_fh_is_singular_file(file)) {
cc35bbdd JS	191	/* start radio */
cc35bbdd JS	192	retval = si470x_start(radio);
fe2137dd JS	193	if (retval < 0)
	194	goto done;
	195
0830be3f	196	/* enable RDS / STC interrupt */
fe2137dd	197	radio->registers[SYSCONFIG1] \|= SYSCONFIG1_RDSIEN;
0830be3f	198	radio->registers[SYSCONFIG1] \|= SYSCONFIG1_STCIEN;
fe2137dd JS	199	radio->registers[SYSCONFIG1] &= ~SYSCONFIG1_GPIO2;
	200	radio->registers[SYSCONFIG1] \|= 0x1 << 2;
	201	retval = si470x_set_register(radio, SYSCONFIG1);
	202	}
9dcb79c2	203
fe2137dd	204	done:
4967d53d HV	205	if (retval)
4967d53d HV	206	v4l2_fh_release(file);
cc35bbdd JS	207	return retval;
	208	}
	209
9dcb79c2 TL	210
	211	/*
	212	* si470x_fops_release - file release
	213	*/
1aa925c9	214	int si470x_fops_release(struct file *file)
cc35bbdd JS	215	{
cc35bbdd JS	216	struct si470x_device *radio = video_drvdata(file);
cc35bbdd	217
4967d53d	218	if (v4l2_fh_is_singular_file(file))
cc35bbdd	219	/* stop radio */
4967d53d	220	si470x_stop(radio);
9dcb79c2	221
4967d53d	222	return v4l2_fh_release(file);
cc35bbdd JS	223	}
cc35bbdd JS	224
9dcb79c2	225
9dcb79c2 TL	226
	227	/**************************************************************************
	228	* Video4Linux Interface
	229	**************************************************************************/
	230
	231	/*
	232	* si470x_vidioc_querycap - query device capabilities
	233	*/
cc35bbdd JS	234	int si470x_vidioc_querycap(struct file file, void priv,
	235	struct v4l2_capability *capability)
	236	{
	237	strlcpy(capability->driver, DRIVER_NAME, sizeof(capability->driver));
	238	strlcpy(capability->card, DRIVER_CARD, sizeof(capability->card));
32737810 HV	239	capability->device_caps = V4L2_CAP_HW_FREQ_SEEK \| V4L2_CAP_READWRITE \|
	240	V4L2_CAP_TUNER \| V4L2_CAP_RADIO \| V4L2_CAP_RDS_CAPTURE;
	241	capability->capabilities = capability->device_caps \| V4L2_CAP_DEVICE_CAPS;
cc35bbdd JS	242
	243	return 0;
	244	}
	245
9dcb79c2 TL	246
	247
	248	/**************************************************************************
	249	* I2C Interface
	250	**************************************************************************/
	251
fe2137dd	252	/*
474fdc08	253	* si470x_i2c_interrupt - interrupt handler
fe2137dd	254	*/
474fdc08	255	static irqreturn_t si470x_i2c_interrupt(int irq, void *dev_id)
fe2137dd	256	{
474fdc08	257	struct si470x_device *radio = dev_id;
fe2137dd JS	258	unsigned char regnr;
	259	unsigned char blocknum;
	260	unsigned short bler; /* rds block errors */
	261	unsigned short rds;
	262	unsigned char tmpbuf[3];
	263	int retval = 0;
	264
0830be3f JS	265	/* check Seek/Tune Complete */
	266	retval = si470x_get_register(radio, STATUSRSSI);
	267	if (retval < 0)
474fdc08	268	goto end;
0830be3f JS	269
	270	if (radio->registers[STATUSRSSI] & STATUSRSSI_STC)
	271	complete(&radio->completion);
	272
fe2137dd JS	273	/* safety checks */
fe2137dd JS	274	if ((radio->registers[SYSCONFIG1] & SYSCONFIG1_RDS) == 0)
474fdc08	275	goto end;
fe2137dd JS	276
fe2137dd JS	277	/* Update RDS registers */
0830be3f	278	for (regnr = 1; regnr < RDS_REGISTER_NUM; regnr++) {
fe2137dd JS	279	retval = si470x_get_register(radio, STATUSRSSI + regnr);
fe2137dd JS	280	if (retval < 0)
474fdc08	281	goto end;
fe2137dd JS	282	}
	283
	284	/* get rds blocks */
	285	if ((radio->registers[STATUSRSSI] & STATUSRSSI_RDSR) == 0)
	286	/* No RDS group ready, better luck next time */
474fdc08	287	goto end;
fe2137dd JS	288
	289	for (blocknum = 0; blocknum < 4; blocknum++) {
	290	switch (blocknum) {
	291	default:
	292	bler = (radio->registers[STATUSRSSI] &
	293	STATUSRSSI_BLERA) >> 9;
	294	rds = radio->registers[RDSA];
	295	break;
	296	case 1:
	297	bler = (radio->registers[READCHAN] &
	298	READCHAN_BLERB) >> 14;
	299	rds = radio->registers[RDSB];
	300	break;
	301	case 2:
	302	bler = (radio->registers[READCHAN] &
	303	READCHAN_BLERC) >> 12;
	304	rds = radio->registers[RDSC];
	305	break;
	306	case 3:
	307	bler = (radio->registers[READCHAN] &
	308	READCHAN_BLERD) >> 10;
	309	rds = radio->registers[RDSD];
	310	break;
c2c1b415	311	}
fe2137dd JS	312
	313	/* Fill the V4L2 RDS buffer */
	314	put_unaligned_le16(rds, &tmpbuf);
	315	tmpbuf[2] = blocknum; /* offset name */
	316	tmpbuf[2] \|= blocknum << 3; /* received offset */
	317	if (bler > max_rds_errors)
	318	tmpbuf[2] \|= 0x80; /* uncorrectable errors */
	319	else if (bler > 0)
	320	tmpbuf[2] \|= 0x40; /* corrected error(s) */
	321
	322	/* copy RDS block to internal buffer */
	323	memcpy(&radio->buffer[radio->wr_index], &tmpbuf, 3);
	324	radio->wr_index += 3;
	325
	326	/* wrap write pointer */
	327	if (radio->wr_index >= radio->buf_size)
	328	radio->wr_index = 0;
	329
	330	/* check for overflow */
	331	if (radio->wr_index == radio->rd_index) {
	332	/* increment and wrap read pointer */
	333	radio->rd_index += 3;
	334	if (radio->rd_index >= radio->buf_size)
	335	radio->rd_index = 0;
	336	}
	337	}
	338
	339	if (radio->wr_index != radio->rd_index)
	340	wake_up_interruptible(&radio->read_queue);
fe2137dd	341
474fdc08	342	end:
fe2137dd JS	343	return IRQ_HANDLED;
	344	}
	345
	346
9dcb79c2 TL	347	/*
	348	* si470x_i2c_probe - probe for the device
	349	*/
4c62e976 GKH	350	static int si470x_i2c_probe(struct i2c_client *client,
4c62e976 GKH	351	const struct i2c_device_id *id)
cc35bbdd JS	352	{
	353	struct si470x_device *radio;
	354	int retval = 0;
9dcb79c2	355	unsigned char version_warning = 0;
cc35bbdd JS	356
	357	/* private data allocation and initialization */
	358	radio = kzalloc(sizeof(struct si470x_device), GFP_KERNEL);
	359	if (!radio) {
	360	retval = -ENOMEM;
	361	goto err_initial;
	362	}
fe2137dd	363
9dcb79c2	364	radio->client = client;
f140612d	365	radio->band = 1; /* Default to 76 - 108 MHz */
cc35bbdd	366	mutex_init(&radio->lock);
77947111	367	init_completion(&radio->completion);
cc35bbdd	368
4967d53d HV	369	/* video device initialization */
	370	radio->videodev = si470x_viddev_template;
	371	video_set_drvdata(&radio->videodev, radio);
cc35bbdd JS	372
	373	/* power up : need 110ms */
	374	radio->registers[POWERCFG] = POWERCFG_ENABLE;
	375	if (si470x_set_register(radio, POWERCFG) < 0) {
	376	retval = -EIO;
4967d53d	377	goto err_radio;
cc35bbdd JS	378	}
	379	msleep(110);
	380
9dcb79c2	381	/* get device and chip versions */
cc35bbdd JS	382	if (si470x_get_all_registers(radio) < 0) {
cc35bbdd JS	383	retval = -EIO;
4967d53d	384	goto err_radio;
cc35bbdd JS	385	}
cc35bbdd JS	386	dev_info(&client->dev, "DeviceID=0x%4.4hx ChipID=0x%4.4hx\n",
dd7a2acf MCC	387	radio->registers[DEVICEID], radio->registers[SI_CHIPID]);
dd7a2acf MCC	388	if ((radio->registers[SI_CHIPID] & SI_CHIPID_FIRMWARE) < RADIO_FW_VERSION) {
9dcb79c2 TL	389	dev_warn(&client->dev,
	390	"This driver is known to work with "
	391	"firmware version %hu,\n", RADIO_FW_VERSION);
	392	dev_warn(&client->dev,
	393	"but the device has firmware version %hu.\n",
dd7a2acf	394	radio->registers[SI_CHIPID] & SI_CHIPID_FIRMWARE);
9dcb79c2 TL	395	version_warning = 1;
	396	}
	397
	398	/* give out version warning */
	399	if (version_warning == 1) {
	400	dev_warn(&client->dev,
	401	"If you have some trouble using this driver,\n");
	402	dev_warn(&client->dev,
	403	"please report to V4L ML at "
	404	"linux-media@vger.kernel.org\n");
	405	}
cc35bbdd JS	406
	407	/* set initial frequency */
	408	si470x_set_freq(radio, 87.5 * FREQ_MUL); /* available in all regions */
	409
fe2137dd JS	410	/* rds buffer allocation */
	411	radio->buf_size = rds_buf * 3;
	412	radio->buffer = kmalloc(radio->buf_size, GFP_KERNEL);
	413	if (!radio->buffer) {
	414	retval = -EIO;
4967d53d	415	goto err_radio;
fe2137dd JS	416	}
	417
	418	/* rds buffer configuration */
	419	radio->wr_index = 0;
	420	radio->rd_index = 0;
	421	init_waitqueue_head(&radio->read_queue);
	422
474fdc08	423	retval = request_threaded_irq(client->irq, NULL, si470x_i2c_interrupt,
4d38cde7 FE	424	IRQF_TRIGGER_FALLING \| IRQF_ONESHOT, DRIVER_NAME,
4d38cde7 FE	425	radio);
fe2137dd JS	426	if (retval) {
	427	dev_err(&client->dev, "Failed to register interrupt\n");
	428	goto err_rds;
	429	}
	430
cc35bbdd	431	/* register video device */
4967d53d	432	retval = video_register_device(&radio->videodev, VFL_TYPE_RADIO,
9dcb79c2	433	radio_nr);
cc35bbdd JS	434	if (retval) {
	435	dev_warn(&client->dev, "Could not register video device\n");
	436	goto err_all;
	437	}
cc35bbdd JS	438	i2c_set_clientdata(client, radio);
	439
	440	return 0;
	441	err_all:
fe2137dd JS	442	free_irq(client->irq, radio);
	443	err_rds:
	444	kfree(radio->buffer);
cc35bbdd JS	445	err_radio:
	446	kfree(radio);
	447	err_initial:
	448	return retval;
	449	}
	450
9dcb79c2 TL	451
	452	/*
	453	* si470x_i2c_remove - remove the device
	454	*/
4c62e976	455	static int si470x_i2c_remove(struct i2c_client *client)
cc35bbdd JS	456	{
	457	struct si470x_device *radio = i2c_get_clientdata(client);
	458
fe2137dd	459	free_irq(client->irq, radio);
4967d53d	460	video_unregister_device(&radio->videodev);
cc35bbdd	461	kfree(radio);
cc35bbdd JS	462
	463	return 0;
	464	}
	465
cc35bbdd	466
c6c3795e	467	#ifdef CONFIG_PM_SLEEP
d1471f02 JS	468	/*
	469	* si470x_i2c_suspend - suspend the device
	470	*/
949cf31c	471	static int si470x_i2c_suspend(struct device *dev)
d1471f02	472	{
949cf31c	473	struct i2c_client *client = to_i2c_client(dev);
d1471f02 JS	474	struct si470x_device *radio = i2c_get_clientdata(client);
	475
	476	/* power down */
	477	radio->registers[POWERCFG] \|= POWERCFG_DISABLE;
	478	if (si470x_set_register(radio, POWERCFG) < 0)
	479	return -EIO;
	480
	481	return 0;
	482	}
	483
	484
	485	/*
	486	* si470x_i2c_resume - resume the device
	487	*/
949cf31c	488	static int si470x_i2c_resume(struct device *dev)
d1471f02	489	{
949cf31c	490	struct i2c_client *client = to_i2c_client(dev);
d1471f02 JS	491	struct si470x_device *radio = i2c_get_clientdata(client);
	492
	493	/* power up : need 110ms */
	494	radio->registers[POWERCFG] \|= POWERCFG_ENABLE;
	495	if (si470x_set_register(radio, POWERCFG) < 0)
	496	return -EIO;
	497	msleep(110);
	498
	499	return 0;
	500	}
949cf31c JS	501
949cf31c JS	502	static SIMPLE_DEV_PM_OPS(si470x_i2c_pm, si470x_i2c_suspend, si470x_i2c_resume);
d1471f02 JS	503	#endif
	504
	505
9dcb79c2 TL	506	/*
	507	* si470x_i2c_driver - i2c driver interface
	508	*/
cc35bbdd JS	509	static struct i2c_driver si470x_i2c_driver = {
cc35bbdd JS	510	.driver = {
9dcb79c2	511	.name = "si470x",
c6c3795e	512	#ifdef CONFIG_PM_SLEEP
949cf31c JS	513	.pm = &si470x_i2c_pm,
949cf31c JS	514	#endif
cc35bbdd	515	},
9dcb79c2	516	.probe = si470x_i2c_probe,
4c62e976	517	.remove = si470x_i2c_remove,
9dcb79c2	518	.id_table = si470x_i2c_id,
cc35bbdd JS	519	};
cc35bbdd JS	520
c6e8d86f	521	module_i2c_driver(si470x_i2c_driver);
cc35bbdd	522
cc35bbdd	523	MODULE_LICENSE("GPL");
9dcb79c2 TL	524	MODULE_AUTHOR(DRIVER_AUTHOR);
	525	MODULE_DESCRIPTION(DRIVER_DESC);
	526	MODULE_VERSION(DRIVER_VERSION);