xref: /openbmc/linux/drivers/media/tuners/tea5761.c (revision e5c86679)
1 /*
2  * For Philips TEA5761 FM Chip
3  * I2C address is allways 0x20 (0x10 at 7-bit mode).
4  *
5  * Copyright (c) 2005-2007 Mauro Carvalho Chehab (mchehab@infradead.org)
6  * This code is placed under the terms of the GNUv2 General Public License
7  *
8  */
9 
10 #include <linux/i2c.h>
11 #include <linux/slab.h>
12 #include <linux/delay.h>
13 #include <linux/videodev2.h>
14 #include <media/tuner.h>
15 #include "tuner-i2c.h"
16 #include "tea5761.h"
17 
18 static int debug;
19 module_param(debug, int, 0644);
20 MODULE_PARM_DESC(debug, "enable verbose debug messages");
21 
22 struct tea5761_priv {
23 	struct tuner_i2c_props i2c_props;
24 
25 	u32 frequency;
26 	bool standby;
27 };
28 
29 /*****************************************************************************/
30 
31 /***************************
32  * TEA5761HN I2C registers *
33  ***************************/
34 
35 /* INTREG - Read: bytes 0 and 1 / Write: byte 0 */
36 
37 	/* first byte for reading */
38 #define TEA5761_INTREG_IFFLAG		0x10
39 #define TEA5761_INTREG_LEVFLAG		0x8
40 #define TEA5761_INTREG_FRRFLAG		0x2
41 #define TEA5761_INTREG_BLFLAG		0x1
42 
43 	/* second byte for reading / byte for writing */
44 #define TEA5761_INTREG_IFMSK		0x10
45 #define TEA5761_INTREG_LEVMSK		0x8
46 #define TEA5761_INTREG_FRMSK		0x2
47 #define TEA5761_INTREG_BLMSK		0x1
48 
49 /* FRQSET - Read: bytes 2 and 3 / Write: byte 1 and 2 */
50 
51 	/* First byte */
52 #define TEA5761_FRQSET_SEARCH_UP 0x80		/* 1=Station search from botton to up */
53 #define TEA5761_FRQSET_SEARCH_MODE 0x40		/* 1=Search mode */
54 
55 	/* Bits 0-5 for divider MSB */
56 
57 	/* Second byte */
58 	/* Bits 0-7 for divider LSB */
59 
60 /* TNCTRL - Read: bytes 4 and 5 / Write: Bytes 3 and 4 */
61 
62 	/* first byte */
63 
64 #define TEA5761_TNCTRL_PUPD_0	0x40	/* Power UP/Power Down MSB */
65 #define TEA5761_TNCTRL_BLIM	0X20	/* 1= Japan Frequencies, 0= European frequencies */
66 #define TEA5761_TNCTRL_SWPM	0x10	/* 1= software port is FRRFLAG */
67 #define TEA5761_TNCTRL_IFCTC	0x08	/* 1= IF count time 15.02 ms, 0= IF count time 2.02 ms */
68 #define TEA5761_TNCTRL_AFM	0x04
69 #define TEA5761_TNCTRL_SMUTE	0x02	/* 1= Soft mute */
70 #define TEA5761_TNCTRL_SNC	0x01
71 
72 	/* second byte */
73 
74 #define TEA5761_TNCTRL_MU	0x80	/* 1=Hard mute */
75 #define TEA5761_TNCTRL_SSL_1	0x40
76 #define TEA5761_TNCTRL_SSL_0	0x20
77 #define TEA5761_TNCTRL_HLSI	0x10
78 #define TEA5761_TNCTRL_MST	0x08	/* 1 = mono */
79 #define TEA5761_TNCTRL_SWP	0x04
80 #define TEA5761_TNCTRL_DTC	0x02	/* 1 = deemphasis 50 us, 0 = deemphasis 75 us */
81 #define TEA5761_TNCTRL_AHLSI	0x01
82 
83 /* FRQCHECK - Read: bytes 6 and 7  */
84 	/* First byte */
85 
86 	/* Bits 0-5 for divider MSB */
87 
88 	/* Second byte */
89 	/* Bits 0-7 for divider LSB */
90 
91 /* TUNCHECK - Read: bytes 8 and 9  */
92 
93 	/* First byte */
94 #define TEA5761_TUNCHECK_IF_MASK	0x7e	/* IF count */
95 #define TEA5761_TUNCHECK_TUNTO		0x01
96 
97 	/* Second byte */
98 #define TEA5761_TUNCHECK_LEV_MASK	0xf0	/* Level Count */
99 #define TEA5761_TUNCHECK_LD		0x08
100 #define TEA5761_TUNCHECK_STEREO		0x04
101 
102 /* TESTREG - Read: bytes 10 and 11 / Write: bytes 5 and 6 */
103 
104 	/* All zero = no test mode */
105 
106 /* MANID - Read: bytes 12 and 13 */
107 
108 	/* First byte - should be 0x10 */
109 #define TEA5767_MANID_VERSION_MASK	0xf0	/* Version = 1 */
110 #define TEA5767_MANID_ID_MSB_MASK	0x0f	/* Manufacurer ID - should be 0 */
111 
112 	/* Second byte - Should be 0x2b */
113 
114 #define TEA5767_MANID_ID_LSB_MASK	0xfe	/* Manufacturer ID - should be 0x15 */
115 #define TEA5767_MANID_IDAV		0x01	/* 1 = Chip has ID, 0 = Chip has no ID */
116 
117 /* Chip ID - Read: bytes 14 and 15 */
118 
119 	/* First byte - should be 0x57 */
120 
121 	/* Second byte - should be 0x61 */
122 
123 /*****************************************************************************/
124 
125 #define FREQ_OFFSET 0 /* for TEA5767, it is 700 to give the right freq */
126 static void tea5761_status_dump(unsigned char *buffer)
127 {
128 	unsigned int div, frq;
129 
130 	div = ((buffer[2] & 0x3f) << 8) | buffer[3];
131 
132 	frq = 1000 * (div * 32768 / 1000 + FREQ_OFFSET + 225) / 4;	/* Freq in KHz */
133 
134 	printk(KERN_INFO "tea5761: Frequency %d.%03d KHz (divider = 0x%04x)\n",
135 	       frq / 1000, frq % 1000, div);
136 }
137 
138 /* Freq should be specifyed at 62.5 Hz */
139 static int __set_radio_freq(struct dvb_frontend *fe,
140 			    unsigned int freq,
141 			    bool mono)
142 {
143 	struct tea5761_priv *priv = fe->tuner_priv;
144 	unsigned int frq = freq;
145 	unsigned char buffer[7] = {0, 0, 0, 0, 0, 0, 0 };
146 	unsigned div;
147 	int rc;
148 
149 	tuner_dbg("radio freq counter %d\n", frq);
150 
151 	if (priv->standby) {
152 		tuner_dbg("TEA5761 set to standby mode\n");
153 		buffer[5] |= TEA5761_TNCTRL_MU;
154 	} else {
155 		buffer[4] |= TEA5761_TNCTRL_PUPD_0;
156 	}
157 
158 
159 	if (mono) {
160 		tuner_dbg("TEA5761 set to mono\n");
161 		buffer[5] |= TEA5761_TNCTRL_MST;
162 	} else {
163 		tuner_dbg("TEA5761 set to stereo\n");
164 	}
165 
166 	div = (1000 * (frq * 4 / 16 + 700 + 225) ) >> 15;
167 	buffer[1] = (div >> 8) & 0x3f;
168 	buffer[2] = div & 0xff;
169 
170 	if (debug)
171 		tea5761_status_dump(buffer);
172 
173 	if (7 != (rc = tuner_i2c_xfer_send(&priv->i2c_props, buffer, 7)))
174 		tuner_warn("i2c i/o error: rc == %d (should be 5)\n", rc);
175 
176 	priv->frequency = frq * 125 / 2;
177 
178 	return 0;
179 }
180 
181 static int set_radio_freq(struct dvb_frontend *fe,
182 			  struct analog_parameters *params)
183 {
184 	struct tea5761_priv *priv = fe->analog_demod_priv;
185 
186 	priv->standby = false;
187 
188 	return __set_radio_freq(fe, params->frequency,
189 				params->audmode == V4L2_TUNER_MODE_MONO);
190 }
191 
192 static int set_radio_sleep(struct dvb_frontend *fe)
193 {
194 	struct tea5761_priv *priv = fe->analog_demod_priv;
195 
196 	priv->standby = true;
197 
198 	return __set_radio_freq(fe, priv->frequency, false);
199 }
200 
201 static int tea5761_read_status(struct dvb_frontend *fe, char *buffer)
202 {
203 	struct tea5761_priv *priv = fe->tuner_priv;
204 	int rc;
205 
206 	memset(buffer, 0, 16);
207 	if (16 != (rc = tuner_i2c_xfer_recv(&priv->i2c_props, buffer, 16))) {
208 		tuner_warn("i2c i/o error: rc == %d (should be 16)\n", rc);
209 		return -EREMOTEIO;
210 	}
211 
212 	return 0;
213 }
214 
215 static inline int tea5761_signal(struct dvb_frontend *fe, const char *buffer)
216 {
217 	struct tea5761_priv *priv = fe->tuner_priv;
218 
219 	int signal = ((buffer[9] & TEA5761_TUNCHECK_LEV_MASK) << (13 - 4));
220 
221 	tuner_dbg("Signal strength: %d\n", signal);
222 
223 	return signal;
224 }
225 
226 static inline int tea5761_stereo(struct dvb_frontend *fe, const char *buffer)
227 {
228 	struct tea5761_priv *priv = fe->tuner_priv;
229 
230 	int stereo = buffer[9] & TEA5761_TUNCHECK_STEREO;
231 
232 	tuner_dbg("Radio ST GET = %02x\n", stereo);
233 
234 	return (stereo ? V4L2_TUNER_SUB_STEREO : 0);
235 }
236 
237 static int tea5761_get_status(struct dvb_frontend *fe, u32 *status)
238 {
239 	unsigned char buffer[16];
240 
241 	*status = 0;
242 
243 	if (0 == tea5761_read_status(fe, buffer)) {
244 		if (tea5761_signal(fe, buffer))
245 			*status = TUNER_STATUS_LOCKED;
246 		if (tea5761_stereo(fe, buffer))
247 			*status |= TUNER_STATUS_STEREO;
248 	}
249 
250 	return 0;
251 }
252 
253 static int tea5761_get_rf_strength(struct dvb_frontend *fe, u16 *strength)
254 {
255 	unsigned char buffer[16];
256 
257 	*strength = 0;
258 
259 	if (0 == tea5761_read_status(fe, buffer))
260 		*strength = tea5761_signal(fe, buffer);
261 
262 	return 0;
263 }
264 
265 int tea5761_autodetection(struct i2c_adapter* i2c_adap, u8 i2c_addr)
266 {
267 	unsigned char buffer[16];
268 	int rc;
269 	struct tuner_i2c_props i2c = { .adap = i2c_adap, .addr = i2c_addr };
270 
271 	if (16 != (rc = tuner_i2c_xfer_recv(&i2c, buffer, 16))) {
272 		printk(KERN_WARNING "it is not a TEA5761. Received %i chars.\n", rc);
273 		return -EINVAL;
274 	}
275 
276 	if ((buffer[13] != 0x2b) || (buffer[14] != 0x57) || (buffer[15] != 0x061)) {
277 		printk(KERN_WARNING "Manufacturer ID= 0x%02x, Chip ID = %02x%02x. It is not a TEA5761\n",
278 				    buffer[13], buffer[14], buffer[15]);
279 		return -EINVAL;
280 	}
281 	printk(KERN_WARNING "tea5761: TEA%02x%02x detected. Manufacturer ID= 0x%02x\n",
282 			    buffer[14], buffer[15], buffer[13]);
283 
284 	return 0;
285 }
286 
287 static void tea5761_release(struct dvb_frontend *fe)
288 {
289 	kfree(fe->tuner_priv);
290 	fe->tuner_priv = NULL;
291 }
292 
293 static int tea5761_get_frequency(struct dvb_frontend *fe, u32 *frequency)
294 {
295 	struct tea5761_priv *priv = fe->tuner_priv;
296 	*frequency = priv->frequency;
297 	return 0;
298 }
299 
300 static const struct dvb_tuner_ops tea5761_tuner_ops = {
301 	.info = {
302 		.name           = "tea5761", // Philips TEA5761HN FM Radio
303 	},
304 	.set_analog_params = set_radio_freq,
305 	.sleep		   = set_radio_sleep,
306 	.release           = tea5761_release,
307 	.get_frequency     = tea5761_get_frequency,
308 	.get_status        = tea5761_get_status,
309 	.get_rf_strength   = tea5761_get_rf_strength,
310 };
311 
312 struct dvb_frontend *tea5761_attach(struct dvb_frontend *fe,
313 				    struct i2c_adapter* i2c_adap,
314 				    u8 i2c_addr)
315 {
316 	struct tea5761_priv *priv = NULL;
317 
318 	if (tea5761_autodetection(i2c_adap, i2c_addr) != 0)
319 		return NULL;
320 
321 	priv = kzalloc(sizeof(struct tea5761_priv), GFP_KERNEL);
322 	if (priv == NULL)
323 		return NULL;
324 	fe->tuner_priv = priv;
325 
326 	priv->i2c_props.addr = i2c_addr;
327 	priv->i2c_props.adap = i2c_adap;
328 	priv->i2c_props.name = "tea5761";
329 
330 	memcpy(&fe->ops.tuner_ops, &tea5761_tuner_ops,
331 	       sizeof(struct dvb_tuner_ops));
332 
333 	tuner_info("type set to %s\n", "Philips TEA5761HN FM Radio");
334 
335 	return fe;
336 }
337 
338 
339 EXPORT_SYMBOL_GPL(tea5761_attach);
340 EXPORT_SYMBOL_GPL(tea5761_autodetection);
341 
342 MODULE_DESCRIPTION("Philips TEA5761 FM tuner driver");
343 MODULE_AUTHOR("Mauro Carvalho Chehab <mchehab@infradead.org>");
344 MODULE_LICENSE("GPL");
345