1 /**
2  * Driver for Sharp IX2505V (marked B0017) DVB-S silicon tuner
3  *
4  * Copyright (C) 2010 Malcolm Priestley
5  *
6  * This program is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License Version 2, as
8  * published by the Free Software Foundation.
9  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License
16  * along with this program; if not, write to the Free Software
17  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
18  *
19  */
20 
21 #include <linux/module.h>
22 #include <linux/dvb/frontend.h>
23 #include <linux/slab.h>
24 #include <linux/types.h>
25 
26 #include "ix2505v.h"
27 
28 static int ix2505v_debug;
29 #define dprintk(level, args...) do { \
30 	if (ix2505v_debug & level) \
31 		printk(KERN_DEBUG "ix2505v: " args); \
32 } while (0)
33 
34 #define deb_info(args...)  dprintk(0x01, args)
35 #define deb_i2c(args...)  dprintk(0x02, args)
36 
37 struct ix2505v_state {
38 	struct i2c_adapter *i2c;
39 	const struct ix2505v_config *config;
40 	u32 frequency;
41 };
42 
43 /**
44  *  Data read format of the Sharp IX2505V B0017
45  *
46  *  byte1:   1   |   1   |   0   |   0   |   0   |  MA1  |  MA0  |  1
47  *  byte2:  POR  |   FL  |  RD2  |  RD1  |  RD0  |   X   |   X   |  X
48  *
49  *  byte1 = address
50  *  byte2;
51  *	POR = Power on Reset (VCC H=<2.2v L=>2.2v)
52  *	FL  = Phase Lock (H=lock L=unlock)
53  *	RD0-2 = Reserved internal operations
54  *
55  * Only POR can be used to check the tuner is present
56  *
57  * Caution: after byte2 the I2C reverts to write mode continuing to read
58  *          may corrupt tuning data.
59  *
60  */
61 
62 static int ix2505v_read_status_reg(struct ix2505v_state *state)
63 {
64 	u8 addr = state->config->tuner_address;
65 	u8 b2[] = {0};
66 	int ret;
67 
68 	struct i2c_msg msg[1] = {
69 		{ .addr = addr, .flags = I2C_M_RD, .buf = b2, .len = 1 }
70 	};
71 
72 	ret = i2c_transfer(state->i2c, msg, 1);
73 	deb_i2c("Read %s ", __func__);
74 
75 	return (ret == 1) ? (int) b2[0] : -1;
76 }
77 
78 static int ix2505v_write(struct ix2505v_state *state, u8 buf[], u8 count)
79 {
80 	struct i2c_msg msg[1] = {
81 		{ .addr = state->config->tuner_address, .flags = 0,
82 		  .buf = buf, .len = count },
83 	};
84 
85 	int ret;
86 
87 	ret = i2c_transfer(state->i2c, msg, 1);
88 
89 	if (ret != 1) {
90 		deb_i2c("%s: i2c error, ret=%d\n", __func__, ret);
91 		return -EIO;
92 	}
93 
94 	return 0;
95 }
96 
97 static void ix2505v_release(struct dvb_frontend *fe)
98 {
99 	struct ix2505v_state *state = fe->tuner_priv;
100 
101 	fe->tuner_priv = NULL;
102 	kfree(state);
103 
104 }
105 
106 /**
107  *  Data write format of the Sharp IX2505V B0017
108  *
109  *  byte1:   1   |   1   |   0   |   0   |   0   | 0(MA1)| 0(MA0)|  0
110  *  byte2:   0   |  BG1  |  BG2  |   N8  |   N7  |   N6  |  N5   |  N4
111  *  byte3:   N3  |   N2  |   N1  |   A5  |   A4  |   A3  |   A2  |  A1
112  *  byte4:   1   | 1(C1) | 1(C0) |  PD5  |  PD4  |   TM  | 0(RTS)| 1(REF)
113  *  byte5:   BA2 |   BA1 |  BA0  |  PSC  |  PD3  |PD2/TS2|DIV/TS1|PD0/TS0
114  *
115  *  byte1 = address
116  *
117  *  Write order
118  *  1) byte1 -> byte2 -> byte3 -> byte4 -> byte5
119  *  2) byte1 -> byte4 -> byte5 -> byte2 -> byte3
120  *  3) byte1 -> byte2 -> byte3 -> byte4
121  *  4) byte1 -> byte4 -> byte5 -> byte2
122  *  5) byte1 -> byte2 -> byte3
123  *  6) byte1 -> byte4 -> byte5
124  *  7) byte1 -> byte2
125  *  8) byte1 -> byte4
126  *
127  *  Recommended Setup
128  *  1 -> 8 -> 6
129  */
130 
131 static int ix2505v_set_params(struct dvb_frontend *fe)
132 {
133 	struct dtv_frontend_properties *c = &fe->dtv_property_cache;
134 	struct ix2505v_state *state = fe->tuner_priv;
135 	u32 frequency = c->frequency;
136 	u32 b_w  = (c->symbol_rate * 27) / 32000;
137 	u32 div_factor, N , A, x;
138 	int ret = 0, len;
139 	u8 gain, cc, ref, psc, local_osc, lpf;
140 	u8 data[4] = {0};
141 
142 	if ((frequency < fe->ops.info.frequency_min)
143 	||  (frequency > fe->ops.info.frequency_max))
144 		return -EINVAL;
145 
146 	if (state->config->tuner_gain)
147 		gain = (state->config->tuner_gain < 4)
148 			? state->config->tuner_gain : 0;
149 	else
150 		gain = 0x0;
151 
152 	if (state->config->tuner_chargepump)
153 		cc = state->config->tuner_chargepump;
154 	else
155 		cc = 0x3;
156 
157 	ref = 8; /* REF =1 */
158 	psc = 32; /* PSC = 0 */
159 
160 	div_factor = (frequency * ref) / 40; /* local osc = 4Mhz */
161 	x = div_factor / psc;
162 	N = x/100;
163 	A = ((x - (N * 100)) * psc) / 100;
164 
165 	data[0] = ((gain & 0x3) << 5) | (N >> 3);
166 	data[1] = (N << 5) | (A & 0x1f);
167 	data[2] = 0x81 | ((cc & 0x3) << 5) ; /*PD5,PD4 & TM = 0|C1,C0|REF=1*/
168 
169 	deb_info("Frq=%d x=%d N=%d A=%d\n", frequency, x, N, A);
170 
171 	if (frequency <= 1065000)
172 		local_osc = (6 << 5) | 2;
173 	else if (frequency <= 1170000)
174 		local_osc = (7 << 5) | 2;
175 	else if (frequency <= 1300000)
176 		local_osc = (1 << 5);
177 	else if (frequency <= 1445000)
178 		local_osc = (2 << 5);
179 	else if (frequency <= 1607000)
180 		local_osc = (3 << 5);
181 	else if (frequency <= 1778000)
182 		local_osc = (4 << 5);
183 	else if (frequency <= 1942000)
184 		local_osc = (5 << 5);
185 	else		/*frequency up to 2150000*/
186 		local_osc = (6 << 5);
187 
188 	data[3] = local_osc; /* all other bits set 0 */
189 
190 	if (b_w <= 10000)
191 		lpf = 0xc;
192 	else if (b_w <= 12000)
193 		lpf = 0x2;
194 	else if (b_w <= 14000)
195 		lpf = 0xa;
196 	else if (b_w <= 16000)
197 		lpf = 0x6;
198 	else if (b_w <= 18000)
199 		lpf = 0xe;
200 	else if (b_w <= 20000)
201 		lpf = 0x1;
202 	else if (b_w <= 22000)
203 		lpf = 0x9;
204 	else if (b_w <= 24000)
205 		lpf = 0x5;
206 	else if (b_w <= 26000)
207 		lpf = 0xd;
208 	else if (b_w <= 28000)
209 		lpf = 0x3;
210 		else
211 		lpf = 0xb;
212 
213 	deb_info("Osc=%x b_w=%x lpf=%x\n", local_osc, b_w, lpf);
214 	deb_info("Data 0=[%4phN]\n", data);
215 
216 	if (fe->ops.i2c_gate_ctrl)
217 		fe->ops.i2c_gate_ctrl(fe, 1);
218 
219 	len = sizeof(data);
220 	ret |= ix2505v_write(state, data, len);
221 
222 	data[2] |= 0x4; /* set TM = 1 other bits same */
223 
224 	if (fe->ops.i2c_gate_ctrl)
225 		fe->ops.i2c_gate_ctrl(fe, 1);
226 
227 	len = 1;
228 	ret |= ix2505v_write(state, &data[2], len); /* write byte 4 only */
229 
230 	msleep(10);
231 
232 	data[2] |= ((lpf >> 2) & 0x3) << 3; /* lpf */
233 	data[3] |= (lpf & 0x3) << 2;
234 
235 	deb_info("Data 2=[%x%x]\n", data[2], data[3]);
236 
237 	if (fe->ops.i2c_gate_ctrl)
238 		fe->ops.i2c_gate_ctrl(fe, 1);
239 
240 	len = 2;
241 	ret |= ix2505v_write(state, &data[2], len); /* write byte 4 & 5 */
242 
243 	if (state->config->min_delay_ms)
244 		msleep(state->config->min_delay_ms);
245 
246 	state->frequency = frequency;
247 
248 	return ret;
249 }
250 
251 static int ix2505v_get_frequency(struct dvb_frontend *fe, u32 *frequency)
252 {
253 	struct ix2505v_state *state = fe->tuner_priv;
254 
255 	*frequency = state->frequency;
256 
257 	return 0;
258 }
259 
260 static const struct dvb_tuner_ops ix2505v_tuner_ops = {
261 	.info = {
262 		.name = "Sharp IX2505V (B0017)",
263 		.frequency_min = 950000,
264 		.frequency_max = 2175000
265 	},
266 	.release = ix2505v_release,
267 	.set_params = ix2505v_set_params,
268 	.get_frequency = ix2505v_get_frequency,
269 };
270 
271 struct dvb_frontend *ix2505v_attach(struct dvb_frontend *fe,
272 				    const struct ix2505v_config *config,
273 				    struct i2c_adapter *i2c)
274 {
275 	struct ix2505v_state *state = NULL;
276 	int ret;
277 
278 	if (NULL == config) {
279 		deb_i2c("%s: no config ", __func__);
280 		goto error;
281 	}
282 
283 	state = kzalloc(sizeof(struct ix2505v_state), GFP_KERNEL);
284 	if (NULL == state)
285 		return NULL;
286 
287 	state->config = config;
288 	state->i2c = i2c;
289 
290 	if (state->config->tuner_write_only) {
291 		if (fe->ops.i2c_gate_ctrl)
292 			fe->ops.i2c_gate_ctrl(fe, 1);
293 
294 		ret = ix2505v_read_status_reg(state);
295 
296 		if (ret & 0x80) {
297 			deb_i2c("%s: No IX2505V found\n", __func__);
298 			goto error;
299 		}
300 
301 		if (fe->ops.i2c_gate_ctrl)
302 			fe->ops.i2c_gate_ctrl(fe, 0);
303 	}
304 
305 	fe->tuner_priv = state;
306 
307 	memcpy(&fe->ops.tuner_ops, &ix2505v_tuner_ops,
308 		sizeof(struct dvb_tuner_ops));
309 	deb_i2c("%s: initialization (%s addr=0x%02x) ok\n",
310 		__func__, fe->ops.tuner_ops.info.name, config->tuner_address);
311 
312 	return fe;
313 
314 error:
315 	kfree(state);
316 	return NULL;
317 }
318 EXPORT_SYMBOL(ix2505v_attach);
319 
320 module_param_named(debug, ix2505v_debug, int, 0644);
321 MODULE_PARM_DESC(debug, "Turn on/off frontend debugging (default:off).");
322 MODULE_DESCRIPTION("DVB IX2505V tuner driver");
323 MODULE_AUTHOR("Malcolm Priestley");
324 MODULE_LICENSE("GPL");
325