[deliverable/linux.git] / drivers / media / dvb-frontends / stb6100.c

/*
	STB6100 Silicon Tuner
	Copyright (C) Manu Abraham (abraham.manu@gmail.com)

	Copyright (C) ST Microelectronics

	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., 675 Mass Ave, Cambridge, MA 02139, USA.
*/

#include <linux/init.h>
#include <linux/kernel.h>
#include <linux/module.h>
#include <linux/slab.h>
#include <linux/string.h>

#include "dvb_frontend.h"
#include "stb6100.h"

static unsigned int verbose;
module_param(verbose, int, 0644);

/* Max transfer size done by I2C transfer functions */
#define MAX_XFER_SIZE  64

#define FE_ERROR		0
#define FE_NOTICE		1
#define FE_INFO			2
#define FE_DEBUG		3

#define dprintk(x, y, z, format, arg...) do {						\
	if (z) {									\
		if	((x > FE_ERROR) && (x > y))					\
			printk(KERN_ERR "%s: " format "\n", __func__ , ##arg);		\
		else if	((x > FE_NOTICE) && (x > y))					\
			printk(KERN_NOTICE "%s: " format "\n", __func__ , ##arg);	\
		else if ((x > FE_INFO) && (x > y))					\
			printk(KERN_INFO "%s: " format "\n", __func__ , ##arg);		\
		else if ((x > FE_DEBUG) && (x > y))					\
			printk(KERN_DEBUG "%s: " format "\n", __func__ , ##arg);	\
	} else {									\
		if (x > y)								\
			printk(format, ##arg);						\
	}										\
} while (0)

struct stb6100_lkup {
	u32 val_low;
	u32 val_high;
	u8   reg;
};

static int stb6100_release(struct dvb_frontend *fe);

static const struct stb6100_lkup lkup[] = {
	{       0,  950000, 0x0a },
	{  950000, 1000000, 0x0a },
	{ 1000000, 1075000, 0x0c },
	{ 1075000, 1200000, 0x00 },
	{ 1200000, 1300000, 0x01 },
	{ 1300000, 1370000, 0x02 },
	{ 1370000, 1470000, 0x04 },
	{ 1470000, 1530000, 0x05 },
	{ 1530000, 1650000, 0x06 },
	{ 1650000, 1800000, 0x08 },
	{ 1800000, 1950000, 0x0a },
	{ 1950000, 2150000, 0x0c },
	{ 2150000, 9999999, 0x0c },
	{       0,       0, 0x00 }
};

/* Register names for easy debugging.	*/
static const char *stb6100_regnames[] = {
	[STB6100_LD]		= "LD",
	[STB6100_VCO]		= "VCO",
	[STB6100_NI]		= "NI",
	[STB6100_NF_LSB]	= "NF",
	[STB6100_K]		= "K",
	[STB6100_G]		= "G",
	[STB6100_F]		= "F",
	[STB6100_DLB]		= "DLB",
	[STB6100_TEST1]		= "TEST1",
	[STB6100_FCCK]		= "FCCK",
	[STB6100_LPEN]		= "LPEN",
	[STB6100_TEST3]		= "TEST3",
};

/* Template for normalisation, i.e. setting unused or undocumented
 * bits as required according to the documentation.
 */
struct stb6100_regmask {
	u8 mask;
	u8 set;
};

static const struct stb6100_regmask stb6100_template[] = {
	[STB6100_LD]		= { 0xff, 0x00 },
	[STB6100_VCO]		= { 0xff, 0x00 },
	[STB6100_NI]		= { 0xff, 0x00 },
	[STB6100_NF_LSB]	= { 0xff, 0x00 },
	[STB6100_K]		= { 0xc7, 0x38 },
	[STB6100_G]		= { 0xef, 0x10 },
	[STB6100_F]		= { 0x1f, 0xc0 },
	[STB6100_DLB]		= { 0x38, 0xc4 },
	[STB6100_TEST1]		= { 0x00, 0x8f },
	[STB6100_FCCK]		= { 0x40, 0x0d },
	[STB6100_LPEN]		= { 0xf0, 0x0b },
	[STB6100_TEST3]		= { 0x00, 0xde },
};

/*
 * Currently unused. Some boards might need it in the future
 */
static inline void stb6100_normalise_regs(u8 regs[])
{
	int i;

	for (i = 0; i < STB6100_NUMREGS; i++)
		regs[i] = (regs[i] & stb6100_template[i].mask) | stb6100_template[i].set;
}

static int stb6100_read_regs(struct stb6100_state *state, u8 regs[])
{
	int rc;
	struct i2c_msg msg = {
		.addr	= state->config->tuner_address,
		.flags	= I2C_M_RD,
		.buf	= regs,
		.len	= STB6100_NUMREGS
	};

	rc = i2c_transfer(state->i2c, &msg, 1);
	if (unlikely(rc != 1)) {
		dprintk(verbose, FE_ERROR, 1, "Read (0x%x) err, rc=[%d]",
			state->config->tuner_address, rc);

		return -EREMOTEIO;
	}
	if (unlikely(verbose > FE_DEBUG)) {
		int i;

		dprintk(verbose, FE_DEBUG, 1, "    Read from 0x%02x", state->config->tuner_address);
		for (i = 0; i < STB6100_NUMREGS; i++)
			dprintk(verbose, FE_DEBUG, 1, "        %s: 0x%02x", stb6100_regnames[i], regs[i]);
	}
	return 0;
}

static int stb6100_read_reg(struct stb6100_state *state, u8 reg)
{
	u8 regs[STB6100_NUMREGS];

	struct i2c_msg msg = {
		.addr	= state->config->tuner_address + reg,
		.flags	= I2C_M_RD,
		.buf	= regs,
		.len	= 1
	};

	i2c_transfer(state->i2c, &msg, 1);

	if (unlikely(reg >= STB6100_NUMREGS)) {
		dprintk(verbose, FE_ERROR, 1, "Invalid register offset 0x%x", reg);
		return -EINVAL;
	}
	if (unlikely(verbose > FE_DEBUG)) {
		dprintk(verbose, FE_DEBUG, 1, "    Read from 0x%02x", state->config->tuner_address);
		dprintk(verbose, FE_DEBUG, 1, "        %s: 0x%02x", stb6100_regnames[reg], regs[0]);
	}

	return (unsigned int)regs[0];
}

static int stb6100_write_reg_range(struct stb6100_state *state, u8 buf[], int start, int len)
{
	int rc;
	u8 cmdbuf[MAX_XFER_SIZE];
	struct i2c_msg msg = {
		.addr	= state->config->tuner_address,
		.flags	= 0,
		.buf	= cmdbuf,
		.len	= len + 1
	};

	if (1 + len > sizeof(cmdbuf)) {
		printk(KERN_WARNING
		       "%s: i2c wr: len=%d is too big!\n",
		       KBUILD_MODNAME, len);
		return -EINVAL;
	}

	if (unlikely(start < 1 || start + len > STB6100_NUMREGS)) {
		dprintk(verbose, FE_ERROR, 1, "Invalid register range %d:%d",
			start, len);
		return -EINVAL;
	}
	memcpy(&cmdbuf[1], buf, len);
	cmdbuf[0] = start;

	if (unlikely(verbose > FE_DEBUG)) {
		int i;

		dprintk(verbose, FE_DEBUG, 1, "    Write @ 0x%02x: [%d:%d]", state->config->tuner_address, start, len);
		for (i = 0; i < len; i++)
			dprintk(verbose, FE_DEBUG, 1, "        %s: 0x%02x", stb6100_regnames[start + i], buf[i]);
	}
	rc = i2c_transfer(state->i2c, &msg, 1);
	if (unlikely(rc != 1)) {
		dprintk(verbose, FE_ERROR, 1, "(0x%x) write err [%d:%d], rc=[%d]",
			(unsigned int)state->config->tuner_address, start, len,	rc);
		return -EREMOTEIO;
	}
	return 0;
}

static int stb6100_write_reg(struct stb6100_state *state, u8 reg, u8 data)
{
	if (unlikely(reg >= STB6100_NUMREGS)) {
		dprintk(verbose, FE_ERROR, 1, "Invalid register offset 0x%x", reg);
		return -EREMOTEIO;
	}
	data = (data & stb6100_template[reg].mask) | stb6100_template[reg].set;
	return stb6100_write_reg_range(state, &data, reg, 1);
}


static int stb6100_get_status(struct dvb_frontend *fe, u32 *status)
{
	int rc;
	struct stb6100_state *state = fe->tuner_priv;

	rc = stb6100_read_reg(state, STB6100_LD);
	if (rc < 0) {
		dprintk(verbose, FE_ERROR, 1, "%s failed", __func__);
		return rc;
	}
	return (rc & STB6100_LD_LOCK) ? TUNER_STATUS_LOCKED : 0;
}

static int stb6100_get_bandwidth(struct dvb_frontend *fe, u32 *bandwidth)
{
	int rc;
	u8 f;
	u32 bw;
	struct stb6100_state *state = fe->tuner_priv;

	rc = stb6100_read_reg(state, STB6100_F);
	if (rc < 0)
		return rc;
	f = rc & STB6100_F_F;

	bw = (f + 5) * 2000;	/* x2 for ZIF	*/

	*bandwidth = state->bandwidth = bw * 1000;
	dprintk(verbose, FE_DEBUG, 1, "bandwidth = %u Hz", state->bandwidth);
	return 0;
}

static int stb6100_set_bandwidth(struct dvb_frontend *fe, u32 bandwidth)
{
	u32 tmp;
	int rc;
	struct stb6100_state *state = fe->tuner_priv;

	dprintk(verbose, FE_DEBUG, 1, "set bandwidth to %u Hz", bandwidth);

	bandwidth /= 2; /* ZIF */

	if (bandwidth >= 36000000)	/* F[4:0] BW/2 max =31+5=36 mhz for F=31	*/
		tmp = 31;
	else if (bandwidth <= 5000000)	/* bw/2 min = 5Mhz for F=0			*/
		tmp = 0;
	else				/* if 5 < bw/2 < 36				*/
		tmp = (bandwidth + 500000) / 1000000 - 5;

	/* Turn on LPF bandwidth setting clock control,
	 * set bandwidth, wait 10ms, turn off.
	 */
	rc = stb6100_write_reg(state, STB6100_FCCK, 0x0d | STB6100_FCCK_FCCK);
	if (rc < 0)
		return rc;
	rc = stb6100_write_reg(state, STB6100_F, 0xc0 | tmp);
	if (rc < 0)
		return rc;

	msleep(5);  /*  This is dangerous as another (related) thread may start */

	rc = stb6100_write_reg(state, STB6100_FCCK, 0x0d);
	if (rc < 0)
		return rc;

	msleep(10);  /*  This is dangerous as another (related) thread may start */

	return 0;
}

static int stb6100_get_frequency(struct dvb_frontend *fe, u32 *frequency)
{
	int rc;
	u32 nint, nfrac, fvco;
	int psd2, odiv;
	struct stb6100_state *state = fe->tuner_priv;
	u8 regs[STB6100_NUMREGS];

	rc = stb6100_read_regs(state, regs);
	if (rc < 0)
		return rc;

	odiv = (regs[STB6100_VCO] & STB6100_VCO_ODIV) >> STB6100_VCO_ODIV_SHIFT;
	psd2 = (regs[STB6100_K] & STB6100_K_PSD2) >> STB6100_K_PSD2_SHIFT;
	nint = regs[STB6100_NI];
	nfrac = ((regs[STB6100_K] & STB6100_K_NF_MSB) << 8) | regs[STB6100_NF_LSB];
	fvco = (nfrac * state->reference >> (9 - psd2)) + (nint * state->reference << psd2);
	*frequency = state->frequency = fvco >> (odiv + 1);

	dprintk(verbose, FE_DEBUG, 1,
		"frequency = %u kHz, odiv = %u, psd2 = %u, fxtal = %u kHz, fvco = %u kHz, N(I) = %u, N(F) = %u",
		state->frequency, odiv, psd2, state->reference,	fvco, nint, nfrac);
	return 0;
}


static int stb6100_set_frequency(struct dvb_frontend *fe, u32 frequency)
{
	int rc;
	const struct stb6100_lkup *ptr;
	struct stb6100_state *state = fe->tuner_priv;
	struct dtv_frontend_properties *p = &fe->dtv_property_cache;

	u32 srate = 0, fvco, nint, nfrac;
	u8 regs[STB6100_NUMREGS];
	u8 g, psd2, odiv;

	dprintk(verbose, FE_DEBUG, 1, "Version 2010-8-14 13:51");

	if (fe->ops.get_frontend) {
		dprintk(verbose, FE_DEBUG, 1, "Get frontend parameters");
		fe->ops.get_frontend(fe, p);
	}
	srate = p->symbol_rate;

	/* Set up tuner cleanly, LPF calibration on */
	rc = stb6100_write_reg(state, STB6100_FCCK, 0x4d | STB6100_FCCK_FCCK);
	if (rc < 0)
		return rc;  /* allow LPF calibration */

	/* PLL Loop disabled, bias on, VCO on, synth on */
	regs[STB6100_LPEN] = 0xeb;
	rc = stb6100_write_reg(state, STB6100_LPEN, regs[STB6100_LPEN]);
	if (rc < 0)
		return rc;

	/* Program the registers with their data values */

	/* VCO divide ratio (LO divide ratio, VCO prescaler enable).	*/
	if (frequency <= 1075000)
		odiv = 1;
	else
		odiv = 0;

	/* VCO enabled, search clock off as per LL3.7, 3.4.1 */
	regs[STB6100_VCO] = 0xe0 | (odiv << STB6100_VCO_ODIV_SHIFT);

	/* OSM	*/
	for (ptr = lkup;
	     (ptr->val_high != 0) && !CHKRANGE(frequency, ptr->val_low, ptr->val_high);
	     ptr++);

	if (ptr->val_high == 0) {
		printk(KERN_ERR "%s: frequency out of range: %u kHz\n", __func__, frequency);
		return -EINVAL;
	}
	regs[STB6100_VCO] = (regs[STB6100_VCO] & ~STB6100_VCO_OSM) | ptr->reg;
	rc = stb6100_write_reg(state, STB6100_VCO, regs[STB6100_VCO]);
	if (rc < 0)
		return rc;

	if ((frequency > 1075000) && (frequency <= 1325000))
		psd2 = 0;
	else
		psd2 = 1;
	/* F(VCO) = F(LO) * (ODIV == 0 ? 2 : 4)			*/
	fvco = frequency << (1 + odiv);
	/* N(I) = floor(f(VCO) / (f(XTAL) * (PSD2 ? 2 : 1)))	*/
	nint = fvco / (state->reference << psd2);
	/* N(F) = round(f(VCO) / f(XTAL) * (PSD2 ? 2 : 1) - N(I)) * 2 ^ 9	*/
	nfrac = DIV_ROUND_CLOSEST((fvco - (nint * state->reference << psd2))
					 << (9 - psd2), state->reference);

	/* NI */
	regs[STB6100_NI] = nint;
	rc = stb6100_write_reg(state, STB6100_NI, regs[STB6100_NI]);
	if (rc < 0)
		return rc;

	/* NF */
	regs[STB6100_NF_LSB] = nfrac;
	rc = stb6100_write_reg(state, STB6100_NF_LSB, regs[STB6100_NF_LSB]);
	if (rc < 0)
		return rc;

	/* K */
	regs[STB6100_K] = (0x38 & ~STB6100_K_PSD2) | (psd2 << STB6100_K_PSD2_SHIFT);
	regs[STB6100_K] = (regs[STB6100_K] & ~STB6100_K_NF_MSB) | ((nfrac >> 8) & STB6100_K_NF_MSB);
	rc = stb6100_write_reg(state, STB6100_K, regs[STB6100_K]);
	if (rc < 0)
		return rc;

	/* G Baseband gain. */
	if (srate >= 15000000)
		g = 9;  /*  +4 dB */
	else if (srate >= 5000000)
		g = 11; /*  +8 dB */
	else
		g = 14; /* +14 dB */

	regs[STB6100_G] = (0x10 & ~STB6100_G_G) | g;
	regs[STB6100_G] &= ~STB6100_G_GCT; /* mask GCT */
	regs[STB6100_G] |= (1 << 5); /* 2Vp-p Mode */
	rc = stb6100_write_reg(state, STB6100_G, regs[STB6100_G]);
	if (rc < 0)
		return rc;

	/* F we don't write as it is set up in BW set */

	/* DLB set DC servo loop BW to 160Hz (LLA 3.8 / 2.1) */
	regs[STB6100_DLB] = 0xcc;
	rc = stb6100_write_reg(state, STB6100_DLB, regs[STB6100_DLB]);
	if (rc < 0)
		return rc;

	dprintk(verbose, FE_DEBUG, 1,
		"frequency = %u, srate = %u, g = %u, odiv = %u, psd2 = %u, fxtal = %u, osm = %u, fvco = %u, N(I) = %u, N(F) = %u",
		frequency, srate, (unsigned int)g, (unsigned int)odiv,
		(unsigned int)psd2, state->reference,
		ptr->reg, fvco, nint, nfrac);

	/* Set up the test registers */
	regs[STB6100_TEST1] = 0x8f;
	rc = stb6100_write_reg(state, STB6100_TEST1, regs[STB6100_TEST1]);
	if (rc < 0)
		return rc;
	regs[STB6100_TEST3] = 0xde;
	rc = stb6100_write_reg(state, STB6100_TEST3, regs[STB6100_TEST3]);
	if (rc < 0)
		return rc;

	/* Bring up tuner according to LLA 3.7 3.4.1, step 2 */
	regs[STB6100_LPEN] = 0xfb; /* PLL Loop enabled, bias on, VCO on, synth on */
	rc = stb6100_write_reg(state, STB6100_LPEN, regs[STB6100_LPEN]);
	if (rc < 0)
		return rc;

	msleep(2);

	/* Bring up tuner according to LLA 3.7 3.4.1, step 3 */
	regs[STB6100_VCO] &= ~STB6100_VCO_OCK;		/* VCO fast search		*/
	rc = stb6100_write_reg(state, STB6100_VCO, regs[STB6100_VCO]);
	if (rc < 0)
		return rc;

	msleep(10);  /*  This is dangerous as another (related) thread may start */ /* wait for LO to lock */

	regs[STB6100_VCO] &= ~STB6100_VCO_OSCH;		/* vco search disabled		*/
	regs[STB6100_VCO] |= STB6100_VCO_OCK;		/* search clock off		*/
	rc = stb6100_write_reg(state, STB6100_VCO, regs[STB6100_VCO]);
	if (rc < 0)
		return rc;

	rc = stb6100_write_reg(state, STB6100_FCCK, 0x0d);
	if (rc < 0)
		return rc;  /* Stop LPF calibration */

	msleep(10);  /*  This is dangerous as another (related) thread may start */
		     /* wait for stabilisation, (should not be necessary)		*/
	return 0;
}

static int stb6100_sleep(struct dvb_frontend *fe)
{
	/* TODO: power down	*/
	return 0;
}

static int stb6100_init(struct dvb_frontend *fe)
{
	struct stb6100_state *state = fe->tuner_priv;
	int refclk = 27000000; /* Hz */

	/*
	 * iqsense = 1
	 * tunerstep = 125000
	 */
	state->bandwidth        = 36000000;		/* Hz	*/
	state->reference	= refclk / 1000;	/* kHz	*/

	/* Set default bandwidth. Modified, PN 13-May-10	*/
	return 0;
}

static int stb6100_set_params(struct dvb_frontend *fe)
{
	struct dtv_frontend_properties *c = &fe->dtv_property_cache;

	if (c->frequency > 0)
		stb6100_set_frequency(fe, c->frequency);

	if (c->bandwidth_hz > 0)
		stb6100_set_bandwidth(fe, c->bandwidth_hz);

	return 0;
}

static struct dvb_tuner_ops stb6100_ops = {
	.info = {
		.name			= "STB6100 Silicon Tuner",
		.frequency_min		= 950000,
		.frequency_max		= 2150000,
		.frequency_step		= 0,
	},

	.init		= stb6100_init,
	.sleep          = stb6100_sleep,
	.get_status	= stb6100_get_status,
	.set_params	= stb6100_set_params,
	.get_frequency  = stb6100_get_frequency,
	.get_bandwidth  = stb6100_get_bandwidth,
	.release	= stb6100_release
};

struct dvb_frontend *stb6100_attach(struct dvb_frontend *fe,
				    const struct stb6100_config *config,
				    struct i2c_adapter *i2c)
{
	struct stb6100_state *state = NULL;

	state = kzalloc(sizeof (struct stb6100_state), GFP_KERNEL);
	if (!state)
		return NULL;

	state->config		= config;
	state->i2c		= i2c;
	state->frontend		= fe;
	state->reference	= config->refclock / 1000; /* kHz */
	fe->tuner_priv		= state;
	fe->ops.tuner_ops	= stb6100_ops;

	printk("%s: Attaching STB6100 \n", __func__);
	return fe;
}

static int stb6100_release(struct dvb_frontend *fe)
{
	struct stb6100_state *state = fe->tuner_priv;

	fe->tuner_priv = NULL;
	kfree(state);

	return 0;
}

EXPORT_SYMBOL(stb6100_attach);
MODULE_PARM_DESC(verbose, "Set Verbosity level");

MODULE_AUTHOR("Manu Abraham");
MODULE_DESCRIPTION("STB6100 Silicon tuner");
MODULE_LICENSE("GPL");
Commit	Line	Data
c46b6562 MA	1	/*
	2	STB6100 Silicon Tuner
	3	Copyright (C) Manu Abraham (abraham.manu@gmail.com)
	4
	5	Copyright (C) ST Microelectronics
	6
	7	This program is free software; you can redistribute it and/or modify
	8	it under the terms of the GNU General Public License as published by
	9	the Free Software Foundation; either version 2 of the License, or
	10	(at your option) any later version.
	11
	12	This program is distributed in the hope that it will be useful,
	13	but WITHOUT ANY WARRANTY; without even the implied warranty of
	14	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	15	GNU General Public License for more details.
	16
	17	You should have received a copy of the GNU General Public License
	18	along with this program; if not, write to the Free Software
	19	Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
	20	*/
	21
	22	#include <linux/init.h>
	23	#include <linux/kernel.h>
	24	#include <linux/module.h>
5a0e3ad6	25	#include <linux/slab.h>
c46b6562 MA	26	#include <linux/string.h>
	27
	28	#include "dvb_frontend.h"
	29	#include "stb6100.h"
	30
	31	static unsigned int verbose;
	32	module_param(verbose, int, 0644);
	33
8393796d MCC	34	/* Max transfer size done by I2C transfer functions */
8393796d MCC	35	#define MAX_XFER_SIZE 64
c46b6562 MA	36
	37	#define FE_ERROR 0
	38	#define FE_NOTICE 1
	39	#define FE_INFO 2
	40	#define FE_DEBUG 3
	41
	42	#define dprintk(x, y, z, format, arg...) do { \
	43	if (z) { \
	44	if ((x > FE_ERROR) && (x > y)) \
	45	printk(KERN_ERR "%s: " format "\n", __func__ , ##arg); \
	46	else if ((x > FE_NOTICE) && (x > y)) \
	47	printk(KERN_NOTICE "%s: " format "\n", __func__ , ##arg); \
	48	else if ((x > FE_INFO) && (x > y)) \
	49	printk(KERN_INFO "%s: " format "\n", __func__ , ##arg); \
	50	else if ((x > FE_DEBUG) && (x > y)) \
	51	printk(KERN_DEBUG "%s: " format "\n", __func__ , ##arg); \
	52	} else { \
	53	if (x > y) \
	54	printk(format, ##arg); \
	55	} \
f14bfe94	56	} while (0)
c46b6562 MA	57
	58	struct stb6100_lkup {
	59	u32 val_low;
	60	u32 val_high;
	61	u8 reg;
	62	};
	63
	64	static int stb6100_release(struct dvb_frontend *fe);
	65
	66	static const struct stb6100_lkup lkup[] = {
	67	{ 0, 950000, 0x0a },
	68	{ 950000, 1000000, 0x0a },
	69	{ 1000000, 1075000, 0x0c },
	70	{ 1075000, 1200000, 0x00 },
	71	{ 1200000, 1300000, 0x01 },
	72	{ 1300000, 1370000, 0x02 },
	73	{ 1370000, 1470000, 0x04 },
	74	{ 1470000, 1530000, 0x05 },
	75	{ 1530000, 1650000, 0x06 },
	76	{ 1650000, 1800000, 0x08 },
	77	{ 1800000, 1950000, 0x0a },
	78	{ 1950000, 2150000, 0x0c },
	79	{ 2150000, 9999999, 0x0c },
	80	{ 0, 0, 0x00 }
	81	};
	82
	83	/* Register names for easy debugging. */
	84	static const char *stb6100_regnames[] = {
	85	[STB6100_LD] = "LD",
	86	[STB6100_VCO] = "VCO",
	87	[STB6100_NI] = "NI",
	88	[STB6100_NF_LSB] = "NF",
	89	[STB6100_K] = "K",
	90	[STB6100_G] = "G",
	91	[STB6100_F] = "F",
	92	[STB6100_DLB] = "DLB",
	93	[STB6100_TEST1] = "TEST1",
	94	[STB6100_FCCK] = "FCCK",
	95	[STB6100_LPEN] = "LPEN",
	96	[STB6100_TEST3] = "TEST3",
	97	};
	98
	99	/* Template for normalisation, i.e. setting unused or undocumented
	100	* bits as required according to the documentation.
	101	*/
	102	struct stb6100_regmask {
	103	u8 mask;
	104	u8 set;
	105	};
	106
	107	static const struct stb6100_regmask stb6100_template[] = {
	108	[STB6100_LD] = { 0xff, 0x00 },
	109	[STB6100_VCO] = { 0xff, 0x00 },
	110	[STB6100_NI] = { 0xff, 0x00 },
	111	[STB6100_NF_LSB] = { 0xff, 0x00 },
	112	[STB6100_K] = { 0xc7, 0x38 },
	113	[STB6100_G] = { 0xef, 0x10 },
	114	[STB6100_F] = { 0x1f, 0xc0 },
	115	[STB6100_DLB] = { 0x38, 0xc4 },
	116	[STB6100_TEST1] = { 0x00, 0x8f },
	117	[STB6100_FCCK] = { 0x40, 0x0d },
	118	[STB6100_LPEN] = { 0xf0, 0x0b },
	119	[STB6100_TEST3] = { 0x00, 0xde },
	120	};
121
a931910d MCC	122	/*
	123	* Currently unused. Some boards might need it in the future
	124	*/
	125	static inline void stb6100_normalise_regs(u8 regs[])
c46b6562 MA	126	{
	127	int i;
	128
	129	for (i = 0; i < STB6100_NUMREGS; i++)
	130	regs[i] = (regs[i] & stb6100_template[i].mask) \| stb6100_template[i].set;
	131	}
	132
	133	static int stb6100_read_regs(struct stb6100_state *state, u8 regs[])
	134	{
	135	int rc;
	136	struct i2c_msg msg = {
	137	.addr = state->config->tuner_address,
	138	.flags = I2C_M_RD,
	139	.buf = regs,
	140	.len = STB6100_NUMREGS
	141	};
	142
c46b6562	143	rc = i2c_transfer(state->i2c, &msg, 1);
c46b6562 MA	144	if (unlikely(rc != 1)) {
	145	dprintk(verbose, FE_ERROR, 1, "Read (0x%x) err, rc=[%d]",
	146	state->config->tuner_address, rc);
	147
	148	return -EREMOTEIO;
	149	}
	150	if (unlikely(verbose > FE_DEBUG)) {
	151	int i;
	152
	153	dprintk(verbose, FE_DEBUG, 1, " Read from 0x%02x", state->config->tuner_address);
	154	for (i = 0; i < STB6100_NUMREGS; i++)
	155	dprintk(verbose, FE_DEBUG, 1, " %s: 0x%02x", stb6100_regnames[i], regs[i]);
	156	}
	157	return 0;
	158	}
	159
	160	static int stb6100_read_reg(struct stb6100_state *state, u8 reg)
	161	{
	162	u8 regs[STB6100_NUMREGS];
c46b6562	163
f14bfe94 MA	164	struct i2c_msg msg = {
	165	.addr = state->config->tuner_address + reg,
	166	.flags = I2C_M_RD,
	167	.buf = regs,
	168	.len = 1
	169	};
	170
fdf07b02	171	i2c_transfer(state->i2c, &msg, 1);
f14bfe94	172
c46b6562 MA	173	if (unlikely(reg >= STB6100_NUMREGS)) {
	174	dprintk(verbose, FE_ERROR, 1, "Invalid register offset 0x%x", reg);
	175	return -EINVAL;
	176	}
f14bfe94 MA	177	if (unlikely(verbose > FE_DEBUG)) {
	178	dprintk(verbose, FE_DEBUG, 1, " Read from 0x%02x", state->config->tuner_address);
	179	dprintk(verbose, FE_DEBUG, 1, " %s: 0x%02x", stb6100_regnames[reg], regs[0]);
	180	}
	181
	182	return (unsigned int)regs[0];
c46b6562 MA	183	}
	184
	185	static int stb6100_write_reg_range(struct stb6100_state *state, u8 buf[], int start, int len)
	186	{
	187	int rc;
8393796d	188	u8 cmdbuf[MAX_XFER_SIZE];
c46b6562 MA	189	struct i2c_msg msg = {
	190	.addr = state->config->tuner_address,
	191	.flags = 0,
	192	.buf = cmdbuf,
	193	.len = len + 1
	194	};
	195
7e6bd12f	196	if (1 + len > sizeof(cmdbuf)) {
8393796d MCC	197	printk(KERN_WARNING
	198	"%s: i2c wr: len=%d is too big!\n",
	199	KBUILD_MODNAME, len);
	200	return -EINVAL;
	201	}
	202
c46b6562 MA	203	if (unlikely(start < 1 \|\| start + len > STB6100_NUMREGS)) {
	204	dprintk(verbose, FE_ERROR, 1, "Invalid register range %d:%d",
	205	start, len);
	206	return -EINVAL;
	207	}
	208	memcpy(&cmdbuf[1], buf, len);
	209	cmdbuf[0] = start;
	210
	211	if (unlikely(verbose > FE_DEBUG)) {
	212	int i;
	213
	214	dprintk(verbose, FE_DEBUG, 1, " Write @ 0x%02x: [%d:%d]", state->config->tuner_address, start, len);
	215	for (i = 0; i < len; i++)
	216	dprintk(verbose, FE_DEBUG, 1, " %s: 0x%02x", stb6100_regnames[start + i], buf[i]);
	217	}
c46b6562	218	rc = i2c_transfer(state->i2c, &msg, 1);
c46b6562 MA	219	if (unlikely(rc != 1)) {
	220	dprintk(verbose, FE_ERROR, 1, "(0x%x) write err [%d:%d], rc=[%d]",
	221	(unsigned int)state->config->tuner_address, start, len, rc);
	222	return -EREMOTEIO;
	223	}
	224	return 0;
	225	}
	226
	227	static int stb6100_write_reg(struct stb6100_state *state, u8 reg, u8 data)
	228	{
	229	if (unlikely(reg >= STB6100_NUMREGS)) {
	230	dprintk(verbose, FE_ERROR, 1, "Invalid register offset 0x%x", reg);
	231	return -EREMOTEIO;
	232	}
	233	data = (data & stb6100_template[reg].mask) \| stb6100_template[reg].set;
	234	return stb6100_write_reg_range(state, &data, reg, 1);
	235	}
	236
c46b6562 MA	237
	238	static int stb6100_get_status(struct dvb_frontend fe, u32 status)
	239	{
	240	int rc;
	241	struct stb6100_state *state = fe->tuner_priv;
	242
f14bfe94 MA	243	rc = stb6100_read_reg(state, STB6100_LD);
	244	if (rc < 0) {
	245	dprintk(verbose, FE_ERROR, 1, "%s failed", __func__);
c46b6562	246	return rc;
f14bfe94	247	}
c46b6562 MA	248	return (rc & STB6100_LD_LOCK) ? TUNER_STATUS_LOCKED : 0;
	249	}
	250
	251	static int stb6100_get_bandwidth(struct dvb_frontend fe, u32 bandwidth)
	252	{
	253	int rc;
	254	u8 f;
cffdbfe7	255	u32 bw;
c46b6562 MA	256	struct stb6100_state *state = fe->tuner_priv;
c46b6562 MA	257
f14bfe94 MA	258	rc = stb6100_read_reg(state, STB6100_F);
f14bfe94 MA	259	if (rc < 0)
c46b6562 MA	260	return rc;
	261	f = rc & STB6100_F_F;
	262
cffdbfe7	263	bw = (f + 5) * 2000; /* x2 for ZIF */
c46b6562	264
cffdbfe7	265	bandwidth = state->bandwidth = bw 1000;
c46b6562 MA	266	dprintk(verbose, FE_DEBUG, 1, "bandwidth = %u Hz", state->bandwidth);
	267	return 0;
	268	}
	269
	270	static int stb6100_set_bandwidth(struct dvb_frontend *fe, u32 bandwidth)
	271	{
	272	u32 tmp;
	273	int rc;
	274	struct stb6100_state *state = fe->tuner_priv;
	275
89693b7d	276	dprintk(verbose, FE_DEBUG, 1, "set bandwidth to %u Hz", bandwidth);
c46b6562	277
763fbaf6	278	bandwidth /= 2; /* ZIF */
c46b6562	279
89693b7d	280	if (bandwidth >= 36000000) /* F[4:0] BW/2 max =31+5=36 mhz for F=31 */
c46b6562	281	tmp = 31;
89693b7d	282	else if (bandwidth <= 5000000) /* bw/2 min = 5Mhz for F=0 */
c46b6562 MA	283	tmp = 0;
c46b6562 MA	284	else /* if 5 < bw/2 < 36 */
6f6c268b	285	tmp = (bandwidth + 500000) / 1000000 - 5;
c46b6562 MA	286
	287	/* Turn on LPF bandwidth setting clock control,
	288	* set bandwidth, wait 10ms, turn off.
	289	*/
f14bfe94 MA	290	rc = stb6100_write_reg(state, STB6100_FCCK, 0x0d \| STB6100_FCCK_FCCK);
f14bfe94 MA	291	if (rc < 0)
c46b6562	292	return rc;
f14bfe94 MA	293	rc = stb6100_write_reg(state, STB6100_F, 0xc0 \| tmp);
f14bfe94 MA	294	if (rc < 0)
c46b6562	295	return rc;
f14bfe94 MA	296
	297	msleep(5); /* This is dangerous as another (related) thread may start */
	298
	299	rc = stb6100_write_reg(state, STB6100_FCCK, 0x0d);
	300	if (rc < 0)
c46b6562 MA	301	return rc;
c46b6562 MA	302
f14bfe94 MA	303	msleep(10); /* This is dangerous as another (related) thread may start */
f14bfe94 MA	304
c46b6562 MA	305	return 0;
	306	}
	307
	308	static int stb6100_get_frequency(struct dvb_frontend fe, u32 frequency)
	309	{
	310	int rc;
	311	u32 nint, nfrac, fvco;
	312	int psd2, odiv;
	313	struct stb6100_state *state = fe->tuner_priv;
	314	u8 regs[STB6100_NUMREGS];
	315
f14bfe94 MA	316	rc = stb6100_read_regs(state, regs);
f14bfe94 MA	317	if (rc < 0)
c46b6562 MA	318	return rc;
	319
	320	odiv = (regs[STB6100_VCO] & STB6100_VCO_ODIV) >> STB6100_VCO_ODIV_SHIFT;
	321	psd2 = (regs[STB6100_K] & STB6100_K_PSD2) >> STB6100_K_PSD2_SHIFT;
	322	nint = regs[STB6100_NI];
	323	nfrac = ((regs[STB6100_K] & STB6100_K_NF_MSB) << 8) \| regs[STB6100_NF_LSB];
	324	fvco = (nfrac * state->reference >> (9 - psd2)) + (nint * state->reference << psd2);
	325	*frequency = state->frequency = fvco >> (odiv + 1);
	326
	327	dprintk(verbose, FE_DEBUG, 1,
	328	"frequency = %u kHz, odiv = %u, psd2 = %u, fxtal = %u kHz, fvco = %u kHz, N(I) = %u, N(F) = %u",
	329	state->frequency, odiv, psd2, state->reference, fvco, nint, nfrac);
	330	return 0;
	331	}
	332
	333
	334	static int stb6100_set_frequency(struct dvb_frontend *fe, u32 frequency)
	335	{
	336	int rc;
	337	const struct stb6100_lkup *ptr;
	338	struct stb6100_state *state = fe->tuner_priv;
1e73fa5d	339	struct dtv_frontend_properties *p = &fe->dtv_property_cache;
c46b6562 MA	340
	341	u32 srate = 0, fvco, nint, nfrac;
	342	u8 regs[STB6100_NUMREGS];
	343	u8 g, psd2, odiv;
	344
f14bfe94	345	dprintk(verbose, FE_DEBUG, 1, "Version 2010-8-14 13:51");
3f400925	346
5135986e	347	if (fe->ops.get_frontend) {
3f400925	348	dprintk(verbose, FE_DEBUG, 1, "Get frontend parameters");
7e3e68bc	349	fe->ops.get_frontend(fe, p);
c46b6562	350	}
1e73fa5d	351	srate = p->symbol_rate;
c46b6562	352
f14bfe94 MA	353	/* Set up tuner cleanly, LPF calibration on */
	354	rc = stb6100_write_reg(state, STB6100_FCCK, 0x4d \| STB6100_FCCK_FCCK);
	355	if (rc < 0)
	356	return rc; /* allow LPF calibration */
20dafb3b	357
f14bfe94 MA	358	/* PLL Loop disabled, bias on, VCO on, synth on */
	359	regs[STB6100_LPEN] = 0xeb;
	360	rc = stb6100_write_reg(state, STB6100_LPEN, regs[STB6100_LPEN]);
	361	if (rc < 0)
20dafb3b AJ	362	return rc;
20dafb3b AJ	363
f14bfe94	364	/* Program the registers with their data values */
c46b6562 MA	365
	366	/* VCO divide ratio (LO divide ratio, VCO prescaler enable). */
	367	if (frequency <= 1075000)
	368	odiv = 1;
	369	else
	370	odiv = 0;
c46b6562	371
25985edc	372	/* VCO enabled, search clock off as per LL3.7, 3.4.1 */
f14bfe94	373	regs[STB6100_VCO] = 0xe0 \| (odiv << STB6100_VCO_ODIV_SHIFT);
c46b6562 MA	374
	375	/* OSM */
	376	for (ptr = lkup;
	377	(ptr->val_high != 0) && !CHKRANGE(frequency, ptr->val_low, ptr->val_high);
	378	ptr++);
f14bfe94	379
c46b6562 MA	380	if (ptr->val_high == 0) {
	381	printk(KERN_ERR "%s: frequency out of range: %u kHz\n", __func__, frequency);
	382	return -EINVAL;
	383	}
	384	regs[STB6100_VCO] = (regs[STB6100_VCO] & ~STB6100_VCO_OSM) \| ptr->reg;
f14bfe94 MA	385	rc = stb6100_write_reg(state, STB6100_VCO, regs[STB6100_VCO]);
	386	if (rc < 0)
	387	return rc;
c46b6562	388
f14bfe94 MA	389	if ((frequency > 1075000) && (frequency <= 1325000))
	390	psd2 = 0;
	391	else
	392	psd2 = 1;
c46b6562 MA	393	/* F(VCO) = F(LO) * (ODIV == 0 ? 2 : 4) */
	394	fvco = frequency << (1 + odiv);
	395	/* N(I) = floor(f(VCO) / (f(XTAL) * (PSD2 ? 2 : 1))) */
	396	nint = fvco / (state->reference << psd2);
	397	/* N(F) = round(f(VCO) / f(XTAL) * (PSD2 ? 2 : 1) - N(I)) * 2 ^ 9 */
75b697f7	398	nfrac = DIV_ROUND_CLOSEST((fvco - (nint * state->reference << psd2))
f14bfe94 MA	399	<< (9 - psd2), state->reference);
	400
	401	/* NI */
	402	regs[STB6100_NI] = nint;
	403	rc = stb6100_write_reg(state, STB6100_NI, regs[STB6100_NI]);
	404	if (rc < 0)
	405	return rc;
	406
	407	/* NF */
	408	regs[STB6100_NF_LSB] = nfrac;
	409	rc = stb6100_write_reg(state, STB6100_NF_LSB, regs[STB6100_NF_LSB]);
	410	if (rc < 0)
	411	return rc;
	412
	413	/* K */
	414	regs[STB6100_K] = (0x38 & ~STB6100_K_PSD2) \| (psd2 << STB6100_K_PSD2_SHIFT);
	415	regs[STB6100_K] = (regs[STB6100_K] & ~STB6100_K_NF_MSB) \| ((nfrac >> 8) & STB6100_K_NF_MSB);
	416	rc = stb6100_write_reg(state, STB6100_K, regs[STB6100_K]);
	417	if (rc < 0)
	418	return rc;
	419
	420	/* G Baseband gain. */
	421	if (srate >= 15000000)
	422	g = 9; /* +4 dB */
	423	else if (srate >= 5000000)
	424	g = 11; /* +8 dB */
	425	else
	426	g = 14; /* +14 dB */
	427
	428	regs[STB6100_G] = (0x10 & ~STB6100_G_G) \| g;
	429	regs[STB6100_G] &= ~STB6100_G_GCT; /* mask GCT */
	430	regs[STB6100_G] \|= (1 << 5); /* 2Vp-p Mode */
	431	rc = stb6100_write_reg(state, STB6100_G, regs[STB6100_G]);
	432	if (rc < 0)
	433	return rc;
	434
	435	/* F we don't write as it is set up in BW set */
	436
	437	/* DLB set DC servo loop BW to 160Hz (LLA 3.8 / 2.1) */
	438	regs[STB6100_DLB] = 0xcc;
	439	rc = stb6100_write_reg(state, STB6100_DLB, regs[STB6100_DLB]);
	440	if (rc < 0)
	441	return rc;
	442
c46b6562 MA	443	dprintk(verbose, FE_DEBUG, 1,
	444	"frequency = %u, srate = %u, g = %u, odiv = %u, psd2 = %u, fxtal = %u, osm = %u, fvco = %u, N(I) = %u, N(F) = %u",
	445	frequency, srate, (unsigned int)g, (unsigned int)odiv,
	446	(unsigned int)psd2, state->reference,
	447	ptr->reg, fvco, nint, nfrac);
c46b6562	448
f14bfe94 MA	449	/* Set up the test registers */
	450	regs[STB6100_TEST1] = 0x8f;
	451	rc = stb6100_write_reg(state, STB6100_TEST1, regs[STB6100_TEST1]);
	452	if (rc < 0)
	453	return rc;
	454	regs[STB6100_TEST3] = 0xde;
	455	rc = stb6100_write_reg(state, STB6100_TEST3, regs[STB6100_TEST3]);
	456	if (rc < 0)
c46b6562 MA	457	return rc;
c46b6562 MA	458
f14bfe94 MA	459	/* Bring up tuner according to LLA 3.7 3.4.1, step 2 */
	460	regs[STB6100_LPEN] = 0xfb; /* PLL Loop enabled, bias on, VCO on, synth on */
	461	rc = stb6100_write_reg(state, STB6100_LPEN, regs[STB6100_LPEN]);
	462	if (rc < 0)
c46b6562 MA	463	return rc;
c46b6562 MA	464
f14bfe94 MA	465	msleep(2);
	466
	467	/* Bring up tuner according to LLA 3.7 3.4.1, step 3 */
c46b6562	468	regs[STB6100_VCO] &= ~STB6100_VCO_OCK; /* VCO fast search */
f14bfe94 MA	469	rc = stb6100_write_reg(state, STB6100_VCO, regs[STB6100_VCO]);
f14bfe94 MA	470	if (rc < 0)
c46b6562 MA	471	return rc;
c46b6562 MA	472
f14bfe94 MA	473	msleep(10); /* This is dangerous as another (related) thread may start / / wait for LO to lock */
f14bfe94 MA	474
c46b6562 MA	475	regs[STB6100_VCO] &= ~STB6100_VCO_OSCH; /* vco search disabled */
c46b6562 MA	476	regs[STB6100_VCO] \|= STB6100_VCO_OCK; /* search clock off */
f14bfe94 MA	477	rc = stb6100_write_reg(state, STB6100_VCO, regs[STB6100_VCO]);
f14bfe94 MA	478	if (rc < 0)
c46b6562 MA	479	return rc;
c46b6562 MA	480
f14bfe94 MA	481	rc = stb6100_write_reg(state, STB6100_FCCK, 0x0d);
	482	if (rc < 0)
	483	return rc; /* Stop LPF calibration */
7e4e8c52	484
f14bfe94 MA	485	msleep(10); /* This is dangerous as another (related) thread may start */
f14bfe94 MA	486	/* wait for stabilisation, (should not be necessary) */
c46b6562 MA	487	return 0;
	488	}
	489
	490	static int stb6100_sleep(struct dvb_frontend *fe)
	491	{
	492	/* TODO: power down */
	493	return 0;
	494	}
	495
	496	static int stb6100_init(struct dvb_frontend *fe)
	497	{
	498	struct stb6100_state *state = fe->tuner_priv;
2184e253	499	int refclk = 27000000; /* Hz */
c46b6562	500
2184e253 MCC	501	/*
	502	* iqsense = 1
	503	* tunerstep = 125000
	504	*/
65f0f686	505	state->bandwidth = 36000000; /* Hz */
2184e253	506	state->reference = refclk / 1000; /* kHz */
c46b6562	507
f14bfe94 MA	508	/* Set default bandwidth. Modified, PN 13-May-10 */
f14bfe94 MA	509	return 0;
c46b6562 MA	510	}
c46b6562 MA	511
65f0f686	512	static int stb6100_set_params(struct dvb_frontend *fe)
c46b6562	513	{
65f0f686	514	struct dtv_frontend_properties *c = &fe->dtv_property_cache;
c46b6562	515
65f0f686 MCC	516	if (c->frequency > 0)
65f0f686 MCC	517	stb6100_set_frequency(fe, c->frequency);
c46b6562	518
65f0f686 MCC	519	if (c->bandwidth_hz > 0)
65f0f686 MCC	520	stb6100_set_bandwidth(fe, c->bandwidth_hz);
c46b6562 MA	521
	522	return 0;
	523	}
	524
	525	static struct dvb_tuner_ops stb6100_ops = {
	526	.info = {
	527	.name = "STB6100 Silicon Tuner",
	528	.frequency_min = 950000,
	529	.frequency_max = 2150000,
	530	.frequency_step = 0,
	531	},
	532
	533	.init = stb6100_init,
	534	.sleep = stb6100_sleep,
	535	.get_status = stb6100_get_status,
65f0f686 MCC	536	.set_params = stb6100_set_params,
	537	.get_frequency = stb6100_get_frequency,
	538	.get_bandwidth = stb6100_get_bandwidth,
c46b6562 MA	539	.release = stb6100_release
	540	};
	541
	542	struct dvb_frontend stb6100_attach(struct dvb_frontend fe,
2e4e98e7	543	const struct stb6100_config *config,
c46b6562 MA	544	struct i2c_adapter *i2c)
	545	{
	546	struct stb6100_state *state = NULL;
	547
a18d4315	548	state = kzalloc(sizeof (struct stb6100_state), GFP_KERNEL);
e4533e65 PST	549	if (!state)
e4533e65 PST	550	return NULL;
c46b6562 MA	551
	552	state->config = config;
	553	state->i2c = i2c;
	554	state->frontend = fe;
3e3263e6	555	state->reference = config->refclock / 1000; /* kHz */
c46b6562 MA	556	fe->tuner_priv = state;
	557	fe->ops.tuner_ops = stb6100_ops;
	558
3e3263e6	559	printk("%s: Attaching STB6100 \n", __func__);
c46b6562	560	return fe;
c46b6562 MA	561	}
	562
	563	static int stb6100_release(struct dvb_frontend *fe)
	564	{
	565	struct stb6100_state *state = fe->tuner_priv;
	566
	567	fe->tuner_priv = NULL;
c46b6562 MA	568	kfree(state);
	569
	570	return 0;
	571	}
	572
	573	EXPORT_SYMBOL(stb6100_attach);
	574	MODULE_PARM_DESC(verbose, "Set Verbosity level");
	575
	576	MODULE_AUTHOR("Manu Abraham");
	577	MODULE_DESCRIPTION("STB6100 Silicon tuner");
	578	MODULE_LICENSE("GPL");