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