Merge tag 'trace-v5.2-rc1' of git://git.kernel.org/pub/scm/linux/kernel/git/rostedt...
[linux-2.6-block.git] / drivers / media / tuners / tea5767.c
CommitLineData
0c20e8ca
MCC
1// SPDX-License-Identifier: GPL-2.0
2// For Philips TEA5767 FM Chip used on some TV Cards like Prolink Pixelview
3// I2C address is always 0xC0.
4//
32590819 5// Copyright (c) 2005 Mauro Carvalho Chehab <mchehab@kernel.org>
0c20e8ca
MCC
6//
7// tea5767 autodetection thanks to Torsten Seeboth and Atsushi Nakagawa
8// from their contributions on DScaler.
586b0cab 9
bc0495c4
MCC
10#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
11
586b0cab 12#include <linux/i2c.h>
5a0e3ad6 13#include <linux/slab.h>
f7ce3cc6 14#include <linux/delay.h>
7f6adeaf 15#include <linux/videodev2.h>
8d0936ed
MK
16#include "tuner-i2c.h"
17#include "tea5767.h"
586b0cab 18
ff699e6b 19static int debug;
8d0936ed
MK
20module_param(debug, int, 0644);
21MODULE_PARM_DESC(debug, "enable verbose debug messages");
586b0cab 22
0e1165e8 23/*****************************************************************************/
8d0936ed 24
0e1165e8
MCC
25struct tea5767_priv {
26 struct tuner_i2c_props i2c_props;
27 u32 frequency;
28 struct tea5767_ctrl ctrl;
db8a6956
MK
29};
30
586b0cab
MCC
31/*****************************************************************************/
32
33/******************************
34 * Write mode register values *
35 ******************************/
36
37/* First register */
f7ce3cc6
MCC
38#define TEA5767_MUTE 0x80 /* Mutes output */
39#define TEA5767_SEARCH 0x40 /* Activates station search */
586b0cab
MCC
40/* Bits 0-5 for divider MSB */
41
42/* Second register */
43/* Bits 0-7 for divider LSB */
44
45/* Third register */
46
47/* Station search from botton to up */
48#define TEA5767_SEARCH_UP 0x80
49
50/* Searches with ADC output = 10 */
51#define TEA5767_SRCH_HIGH_LVL 0x60
52
53/* Searches with ADC output = 10 */
54#define TEA5767_SRCH_MID_LVL 0x40
55
56/* Searches with ADC output = 5 */
57#define TEA5767_SRCH_LOW_LVL 0x20
58
59/* if on, div=4*(Frf+Fif)/Fref otherwise, div=4*(Frf-Fif)/Freq) */
60#define TEA5767_HIGH_LO_INJECT 0x10
61
62/* Disable stereo */
63#define TEA5767_MONO 0x08
64
65/* Disable right channel and turns to mono */
66#define TEA5767_MUTE_RIGHT 0x04
67
68/* Disable left channel and turns to mono */
69#define TEA5767_MUTE_LEFT 0x02
70
71#define TEA5767_PORT1_HIGH 0x01
72
27487d44 73/* Fourth register */
586b0cab
MCC
74#define TEA5767_PORT2_HIGH 0x80
75/* Chips stops working. Only I2C bus remains on */
76#define TEA5767_STDBY 0x40
77
78/* Japan freq (76-108 MHz. If disabled, 87.5-108 MHz */
79#define TEA5767_JAPAN_BAND 0x20
80
81/* Unselected means 32.768 KHz freq as reference. Otherwise Xtal at 13 MHz */
82#define TEA5767_XTAL_32768 0x10
83
84/* Cuts weak signals */
85#define TEA5767_SOFT_MUTE 0x08
86
87/* Activates high cut control */
88#define TEA5767_HIGH_CUT_CTRL 0x04
89
90/* Activates stereo noise control */
91#define TEA5767_ST_NOISE_CTL 0x02
92
93/* If activate PORT 1 indicates SEARCH or else it is used as PORT1 */
94#define TEA5767_SRCH_IND 0x01
95
27487d44 96/* Fifth register */
586b0cab
MCC
97
98/* By activating, it will use Xtal at 13 MHz as reference for divider */
99#define TEA5767_PLLREF_ENABLE 0x80
100
101/* By activating, deemphasis=50, or else, deemphasis of 50us */
102#define TEA5767_DEEMPH_75 0X40
103
104/*****************************
105 * Read mode register values *
106 *****************************/
107
108/* First register */
109#define TEA5767_READY_FLAG_MASK 0x80
110#define TEA5767_BAND_LIMIT_MASK 0X40
111/* Bits 0-5 for divider MSB after search or preset */
112
113/* Second register */
114/* Bits 0-7 for divider LSB after search or preset */
115
116/* Third register */
117#define TEA5767_STEREO_MASK 0x80
118#define TEA5767_IF_CNTR_MASK 0x7f
119
27487d44 120/* Fourth register */
586b0cab
MCC
121#define TEA5767_ADC_LEVEL_MASK 0xf0
122
123/* should be 0 */
124#define TEA5767_CHIP_ID_MASK 0x0f
125
27487d44 126/* Fifth register */
586b0cab
MCC
127/* Reserved for future extensions */
128#define TEA5767_RESERVED_MASK 0xff
129
130/*****************************************************************************/
131
0e1165e8
MCC
132static void tea5767_status_dump(struct tea5767_priv *priv,
133 unsigned char *buffer)
586b0cab
MCC
134{
135 unsigned int div, frq;
136
137 if (TEA5767_READY_FLAG_MASK & buffer[0])
2756665c 138 tuner_info("Ready Flag ON\n");
586b0cab 139 else
2756665c 140 tuner_info("Ready Flag OFF\n");
586b0cab
MCC
141
142 if (TEA5767_BAND_LIMIT_MASK & buffer[0])
2756665c 143 tuner_info("Tuner at band limit\n");
586b0cab 144 else
2756665c 145 tuner_info("Tuner not at band limit\n");
586b0cab 146
f7ce3cc6 147 div = ((buffer[0] & 0x3f) << 8) | buffer[1];
586b0cab 148
0e1165e8 149 switch (priv->ctrl.xtal_freq) {
586b0cab 150 case TEA5767_HIGH_LO_13MHz:
c5287ba1 151 frq = (div * 50000 - 700000 - 225000) / 4; /* Freq in KHz */
586b0cab
MCC
152 break;
153 case TEA5767_LOW_LO_13MHz:
c5287ba1 154 frq = (div * 50000 + 700000 + 225000) / 4; /* Freq in KHz */
586b0cab
MCC
155 break;
156 case TEA5767_LOW_LO_32768:
c5287ba1 157 frq = (div * 32768 + 700000 + 225000) / 4; /* Freq in KHz */
586b0cab
MCC
158 break;
159 case TEA5767_HIGH_LO_32768:
160 default:
c5287ba1 161 frq = (div * 32768 - 700000 - 225000) / 4; /* Freq in KHz */
586b0cab
MCC
162 break;
163 }
f7ce3cc6
MCC
164 buffer[0] = (div >> 8) & 0x3f;
165 buffer[1] = div & 0xff;
586b0cab 166
2756665c
MK
167 tuner_info("Frequency %d.%03d KHz (divider = 0x%04x)\n",
168 frq / 1000, frq % 1000, div);
586b0cab
MCC
169
170 if (TEA5767_STEREO_MASK & buffer[2])
2756665c 171 tuner_info("Stereo\n");
586b0cab 172 else
2756665c 173 tuner_info("Mono\n");
586b0cab 174
2756665c 175 tuner_info("IF Counter = %d\n", buffer[2] & TEA5767_IF_CNTR_MASK);
586b0cab 176
2756665c
MK
177 tuner_info("ADC Level = %d\n",
178 (buffer[3] & TEA5767_ADC_LEVEL_MASK) >> 4);
586b0cab 179
2756665c 180 tuner_info("Chip ID = %d\n", (buffer[3] & TEA5767_CHIP_ID_MASK));
586b0cab 181
2756665c
MK
182 tuner_info("Reserved = 0x%02x\n",
183 (buffer[4] & TEA5767_RESERVED_MASK));
586b0cab
MCC
184}
185
186/* Freq should be specifyed at 62.5 Hz */
8d0936ed
MK
187static int set_radio_freq(struct dvb_frontend *fe,
188 struct analog_parameters *params)
586b0cab 189{
8d0936ed
MK
190 struct tea5767_priv *priv = fe->tuner_priv;
191 unsigned int frq = params->frequency;
f7ce3cc6 192 unsigned char buffer[5];
586b0cab
MCC
193 unsigned div;
194 int rc;
195
8d0936ed 196 tuner_dbg("radio freq = %d.%03d MHz\n", frq/16000,(frq/16)%1000);
586b0cab 197
0e1165e8 198 buffer[2] = 0;
586b0cab 199
0e1165e8
MCC
200 if (priv->ctrl.port1)
201 buffer[2] |= TEA5767_PORT1_HIGH;
f7ce3cc6 202
8d0936ed 203 if (params->audmode == V4L2_TUNER_MODE_MONO) {
586b0cab
MCC
204 tuner_dbg("TEA5767 set to mono\n");
205 buffer[2] |= TEA5767_MONO;
f7ce3cc6
MCC
206 } else {
207 tuner_dbg("TEA5767 set to stereo\n");
208 }
586b0cab 209
0e1165e8
MCC
210
211 buffer[3] = 0;
212
213 if (priv->ctrl.port2)
214 buffer[3] |= TEA5767_PORT2_HIGH;
215
216 if (priv->ctrl.high_cut)
217 buffer[3] |= TEA5767_HIGH_CUT_CTRL;
218
219 if (priv->ctrl.st_noise)
220 buffer[3] |= TEA5767_ST_NOISE_CTL;
221
222 if (priv->ctrl.soft_mute)
223 buffer[3] |= TEA5767_SOFT_MUTE;
224
225 if (priv->ctrl.japan_band)
226 buffer[3] |= TEA5767_JAPAN_BAND;
227
228 buffer[4] = 0;
229
230 if (priv->ctrl.deemph_75)
231 buffer[4] |= TEA5767_DEEMPH_75;
232
233 if (priv->ctrl.pllref)
234 buffer[4] |= TEA5767_PLLREF_ENABLE;
235
236
237 /* Rounds freq to next decimal value - for 62.5 KHz step */
238 /* frq = 20*(frq/16)+radio_frq[frq%16]; */
239
240 switch (priv->ctrl.xtal_freq) {
586b0cab 241 case TEA5767_HIGH_LO_13MHz:
8d0936ed 242 tuner_dbg("radio HIGH LO inject xtal @ 13 MHz\n");
586b0cab 243 buffer[2] |= TEA5767_HIGH_LO_INJECT;
27487d44 244 div = (frq * (4000 / 16) + 700000 + 225000 + 25000) / 50000;
586b0cab
MCC
245 break;
246 case TEA5767_LOW_LO_13MHz:
8d0936ed 247 tuner_dbg("radio LOW LO inject xtal @ 13 MHz\n");
586b0cab 248
27487d44 249 div = (frq * (4000 / 16) - 700000 - 225000 + 25000) / 50000;
586b0cab
MCC
250 break;
251 case TEA5767_LOW_LO_32768:
8d0936ed 252 tuner_dbg("radio LOW LO inject xtal @ 32,768 MHz\n");
586b0cab
MCC
253 buffer[3] |= TEA5767_XTAL_32768;
254 /* const 700=4000*175 Khz - to adjust freq to right value */
27487d44 255 div = ((frq * (4000 / 16) - 700000 - 225000) + 16384) >> 15;
586b0cab
MCC
256 break;
257 case TEA5767_HIGH_LO_32768:
258 default:
8d0936ed 259 tuner_dbg("radio HIGH LO inject xtal @ 32,768 MHz\n");
586b0cab
MCC
260
261 buffer[2] |= TEA5767_HIGH_LO_INJECT;
262 buffer[3] |= TEA5767_XTAL_32768;
c5287ba1 263 div = ((frq * (4000 / 16) + 700000 + 225000) + 16384) >> 15;
586b0cab
MCC
264 break;
265 }
f7ce3cc6
MCC
266 buffer[0] = (div >> 8) & 0x3f;
267 buffer[1] = div & 0xff;
586b0cab 268
db8a6956 269 if (5 != (rc = tuner_i2c_xfer_send(&priv->i2c_props, buffer, 5)))
f7ce3cc6 270 tuner_warn("i2c i/o error: rc == %d (should be 5)\n", rc);
c5287ba1 271
8d0936ed 272 if (debug) {
db8a6956 273 if (5 != (rc = tuner_i2c_xfer_recv(&priv->i2c_props, buffer, 5)))
c5287ba1
MCC
274 tuner_warn("i2c i/o error: rc == %d (should be 5)\n", rc);
275 else
0e1165e8 276 tea5767_status_dump(priv, buffer);
c5287ba1 277 }
8d0936ed
MK
278
279 priv->frequency = frq * 125 / 2;
280
281 return 0;
586b0cab
MCC
282}
283
6b897f2c 284static int tea5767_read_status(struct dvb_frontend *fe, char *buffer)
586b0cab 285{
8d0936ed 286 struct tea5767_priv *priv = fe->tuner_priv;
6b897f2c 287 int rc;
586b0cab 288
6b897f2c
MK
289 memset(buffer, 0, 5);
290 if (5 != (rc = tuner_i2c_xfer_recv(&priv->i2c_props, buffer, 5))) {
f7ce3cc6 291 tuner_warn("i2c i/o error: rc == %d (should be 5)\n", rc);
6b897f2c
MK
292 return -EREMOTEIO;
293 }
586b0cab 294
6b897f2c 295 return 0;
586b0cab
MCC
296}
297
6b897f2c 298static inline int tea5767_signal(struct dvb_frontend *fe, const char *buffer)
586b0cab 299{
8d0936ed 300 struct tea5767_priv *priv = fe->tuner_priv;
586b0cab 301
6b897f2c
MK
302 int signal = ((buffer[3] & TEA5767_ADC_LEVEL_MASK) << 8);
303
304 tuner_dbg("Signal strength: %d\n", signal);
305
306 return signal;
307}
586b0cab 308
6b897f2c
MK
309static inline int tea5767_stereo(struct dvb_frontend *fe, const char *buffer)
310{
311 struct tea5767_priv *priv = fe->tuner_priv;
586b0cab 312
6b897f2c 313 int stereo = buffer[2] & TEA5767_STEREO_MASK;
586b0cab 314
6b897f2c
MK
315 tuner_dbg("Radio ST GET = %02x\n", stereo);
316
317 return (stereo ? V4L2_TUNER_SUB_STEREO : 0);
586b0cab
MCC
318}
319
8d0936ed
MK
320static int tea5767_get_status(struct dvb_frontend *fe, u32 *status)
321{
6b897f2c
MK
322 unsigned char buffer[5];
323
8d0936ed
MK
324 *status = 0;
325
6b897f2c
MK
326 if (0 == tea5767_read_status(fe, buffer)) {
327 if (tea5767_signal(fe, buffer))
328 *status = TUNER_STATUS_LOCKED;
329 if (tea5767_stereo(fe, buffer))
330 *status |= TUNER_STATUS_STEREO;
331 }
332
333 return 0;
334}
335
336static int tea5767_get_rf_strength(struct dvb_frontend *fe, u16 *strength)
337{
338 unsigned char buffer[5];
339
340 *strength = 0;
8d0936ed 341
6b897f2c
MK
342 if (0 == tea5767_read_status(fe, buffer))
343 *strength = tea5767_signal(fe, buffer);
8d0936ed
MK
344
345 return 0;
346}
347
348static int tea5767_standby(struct dvb_frontend *fe)
793cf9e6
MCC
349{
350 unsigned char buffer[5];
8d0936ed 351 struct tea5767_priv *priv = fe->tuner_priv;
793cf9e6
MCC
352 unsigned div, rc;
353
354 div = (87500 * 4 + 700 + 225 + 25) / 50; /* Set frequency to 87.5 MHz */
355 buffer[0] = (div >> 8) & 0x3f;
356 buffer[1] = div & 0xff;
357 buffer[2] = TEA5767_PORT1_HIGH;
358 buffer[3] = TEA5767_PORT2_HIGH | TEA5767_HIGH_CUT_CTRL |
359 TEA5767_ST_NOISE_CTL | TEA5767_JAPAN_BAND | TEA5767_STDBY;
360 buffer[4] = 0;
361
db8a6956 362 if (5 != (rc = tuner_i2c_xfer_send(&priv->i2c_props, buffer, 5)))
793cf9e6 363 tuner_warn("i2c i/o error: rc == %d (should be 5)\n", rc);
8d0936ed
MK
364
365 return 0;
793cf9e6
MCC
366}
367
8d0936ed 368int tea5767_autodetection(struct i2c_adapter* i2c_adap, u8 i2c_addr)
586b0cab 369{
8d0936ed 370 struct tuner_i2c_props i2c = { .adap = i2c_adap, .addr = i2c_addr };
fd3113e8 371 unsigned char buffer[7] = { 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff };
bc0495c4 372
586b0cab 373 int rc;
586b0cab 374
8d0936ed 375 if ((rc = tuner_i2c_xfer_recv(&i2c, buffer, 7))< 5) {
bc0495c4 376 pr_warn("It is not a TEA5767. Received %i bytes.\n", rc);
b538d28c 377 return -EINVAL;
586b0cab
MCC
378 }
379
fd3113e8 380 /* If all bytes are the same then it's a TV tuner and not a tea5767 */
f7ce3cc6
MCC
381 if (buffer[0] == buffer[1] && buffer[0] == buffer[2] &&
382 buffer[0] == buffer[3] && buffer[0] == buffer[4]) {
bc0495c4 383 pr_warn("All bytes are equal. It is not a TEA5767\n");
b538d28c 384 return -EINVAL;
586b0cab
MCC
385 }
386
387 /* Status bytes:
388 * Byte 4: bit 3:1 : CI (Chip Identification) == 0
f7ce3cc6 389 * bit 0 : internally set to 0
586b0cab
MCC
390 * Byte 5: bit 7:0 : == 0
391 */
793cf9e6 392 if (((buffer[3] & 0x0f) != 0x00) || (buffer[4] != 0x00)) {
bc0495c4 393 pr_warn("Chip ID is not zero. It is not a TEA5767\n");
b538d28c 394 return -EINVAL;
586b0cab 395 }
c5287ba1 396
001abc93 397
586b0cab
MCC
398 return 0;
399}
400
f2709c20
MCC
401static void tea5767_release(struct dvb_frontend *fe)
402{
403 kfree(fe->tuner_priv);
404 fe->tuner_priv = NULL;
405}
406
8d0936ed
MK
407static int tea5767_get_frequency(struct dvb_frontend *fe, u32 *frequency)
408{
409 struct tea5767_priv *priv = fe->tuner_priv;
410 *frequency = priv->frequency;
0e1165e8
MCC
411
412 return 0;
413}
414
415static int tea5767_set_config (struct dvb_frontend *fe, void *priv_cfg)
416{
417 struct tea5767_priv *priv = fe->tuner_priv;
418
419 memcpy(&priv->ctrl, priv_cfg, sizeof(priv->ctrl));
420
8d0936ed
MK
421 return 0;
422}
423
96105144 424static const struct dvb_tuner_ops tea5767_tuner_ops = {
8d0936ed
MK
425 .info = {
426 .name = "tea5767", // Philips TEA5767HN FM Radio
427 },
428
429 .set_analog_params = set_radio_freq,
0e1165e8 430 .set_config = tea5767_set_config,
8d0936ed 431 .sleep = tea5767_standby,
f2709c20 432 .release = tea5767_release,
8d0936ed
MK
433 .get_frequency = tea5767_get_frequency,
434 .get_status = tea5767_get_status,
6b897f2c 435 .get_rf_strength = tea5767_get_rf_strength,
0f838f8d
MK
436};
437
8d0936ed
MK
438struct dvb_frontend *tea5767_attach(struct dvb_frontend *fe,
439 struct i2c_adapter* i2c_adap,
440 u8 i2c_addr)
586b0cab 441{
db8a6956
MK
442 struct tea5767_priv *priv = NULL;
443
444 priv = kzalloc(sizeof(struct tea5767_priv), GFP_KERNEL);
445 if (priv == NULL)
8d0936ed
MK
446 return NULL;
447 fe->tuner_priv = priv;
db8a6956 448
0e1165e8
MCC
449 priv->i2c_props.addr = i2c_addr;
450 priv->i2c_props.adap = i2c_adap;
2756665c
MK
451 priv->i2c_props.name = "tea5767";
452
0e1165e8
MCC
453 priv->ctrl.xtal_freq = TEA5767_HIGH_LO_32768;
454 priv->ctrl.port1 = 1;
455 priv->ctrl.port2 = 1;
456 priv->ctrl.high_cut = 1;
457 priv->ctrl.st_noise = 1;
458 priv->ctrl.japan_band = 1;
586b0cab 459
8d0936ed
MK
460 memcpy(&fe->ops.tuner_ops, &tea5767_tuner_ops,
461 sizeof(struct dvb_tuner_ops));
586b0cab 462
8d0936ed 463 tuner_info("type set to %s\n", "Philips TEA5767HN FM Radio");
586b0cab 464
8d0936ed 465 return fe;
586b0cab 466}
8d0936ed 467
8d0936ed
MK
468EXPORT_SYMBOL_GPL(tea5767_attach);
469EXPORT_SYMBOL_GPL(tea5767_autodetection);
470
471MODULE_DESCRIPTION("Philips TEA5767 FM tuner driver");
32590819 472MODULE_AUTHOR("Mauro Carvalho Chehab <mchehab@kernel.org>");
0c20e8ca 473MODULE_LICENSE("GPL v2");