2 * driver/media/radio/radio-tea5764.c
4 * Driver for TEA5764 radio chip for linux 2.6.
5 * This driver is for TEA5764 chip from NXP, used in EZX phones from Motorola.
6 * The I2C protocol is used for communicate with chip.
8 * Based in radio-tea5761.c Copyright (C) 2005 Nokia Corporation
10 * Copyright (c) 2008 Fabio Belavenuto <belavenuto@gmail.com>
12 * This program is free software; you can redistribute it and/or modify
13 * it under the terms of the GNU General Public License as published by
14 * the Free Software Foundation; either version 2 of the License, or
15 * (at your option) any later version.
17 * This program is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU General Public License for more details.
22 * You should have received a copy of the GNU General Public License
23 * along with this program; if not, write to the Free Software
24 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
27 * 2008-12-06 Fabio Belavenuto <belavenuto@gmail.com>
31 * add platform_data support for IRQs platform dependencies
34 #include <linux/kernel.h>
35 #include <linux/module.h>
36 #include <linux/init.h> /* Initdata */
37 #include <linux/videodev2.h> /* kernel radio structs */
38 #include <linux/i2c.h> /* I2C */
39 #include <media/v4l2-common.h>
40 #include <media/v4l2-ioctl.h>
41 #include <linux/version.h> /* for KERNEL_VERSION MACRO */
43 #define DRIVER_VERSION "v0.01"
44 #define RADIO_VERSION KERNEL_VERSION(0, 0, 1)
46 #define DRIVER_AUTHOR "Fabio Belavenuto <belavenuto@gmail.com>"
47 #define DRIVER_DESC "A driver for the TEA5764 radio chip for EZX Phones."
49 #define PINFO(format, ...)\
50 printk(KERN_INFO KBUILD_MODNAME ": "\
51 DRIVER_VERSION ": " format "\n", ## __VA_ARGS__)
52 #define PWARN(format, ...)\
53 printk(KERN_WARNING KBUILD_MODNAME ": "\
54 DRIVER_VERSION ": " format "\n", ## __VA_ARGS__)
55 # define PDEBUG(format, ...)\
56 printk(KERN_DEBUG KBUILD_MODNAME ": "\
57 DRIVER_VERSION ": " format "\n", ## __VA_ARGS__)
59 /* Frequency limits in MHz -- these are European values. For Japanese
60 devices, that would be 76000 and 91000. */
61 #define FREQ_MIN 87500
62 #define FREQ_MAX 108000
65 /* TEA5764 registers */
66 #define TEA5764_MANID 0x002b
67 #define TEA5764_CHIPID 0x5764
69 #define TEA5764_INTREG_BLMSK 0x0001
70 #define TEA5764_INTREG_FRRMSK 0x0002
71 #define TEA5764_INTREG_LEVMSK 0x0008
72 #define TEA5764_INTREG_IFMSK 0x0010
73 #define TEA5764_INTREG_BLMFLAG 0x0100
74 #define TEA5764_INTREG_FRRFLAG 0x0200
75 #define TEA5764_INTREG_LEVFLAG 0x0800
76 #define TEA5764_INTREG_IFFLAG 0x1000
78 #define TEA5764_FRQSET_SUD 0x8000
79 #define TEA5764_FRQSET_SM 0x4000
81 #define TEA5764_TNCTRL_PUPD1 0x8000
82 #define TEA5764_TNCTRL_PUPD0 0x4000
83 #define TEA5764_TNCTRL_BLIM 0x2000
84 #define TEA5764_TNCTRL_SWPM 0x1000
85 #define TEA5764_TNCTRL_IFCTC 0x0800
86 #define TEA5764_TNCTRL_AFM 0x0400
87 #define TEA5764_TNCTRL_SMUTE 0x0200
88 #define TEA5764_TNCTRL_SNC 0x0100
89 #define TEA5764_TNCTRL_MU 0x0080
90 #define TEA5764_TNCTRL_SSL1 0x0040
91 #define TEA5764_TNCTRL_SSL0 0x0020
92 #define TEA5764_TNCTRL_HLSI 0x0010
93 #define TEA5764_TNCTRL_MST 0x0008
94 #define TEA5764_TNCTRL_SWP 0x0004
95 #define TEA5764_TNCTRL_DTC 0x0002
96 #define TEA5764_TNCTRL_AHLSI 0x0001
98 #define TEA5764_TUNCHK_LEVEL(x) (((x) & 0x00F0) >> 4)
99 #define TEA5764_TUNCHK_IFCNT(x) (((x) & 0xFE00) >> 9)
100 #define TEA5764_TUNCHK_TUNTO 0x0100
101 #define TEA5764_TUNCHK_LD 0x0008
102 #define TEA5764_TUNCHK_STEREO 0x0004
104 #define TEA5764_TESTREG_TRIGFR 0x0800
106 struct tea5764_regs {
107 u16 intreg; /* INTFLAG & INTMSK */
108 u16 frqset; /* FRQSETMSB & FRQSETLSB */
109 u16 tnctrl; /* TNCTRL1 & TNCTRL2 */
110 u16 frqchk; /* FRQCHKMSB & FRQCHKLSB */
111 u16 tunchk; /* IFCHK & LEVCHK */
112 u16 testreg; /* TESTBITS & TESTMODE */
113 u16 rdsstat; /* RDSSTAT1 & RDSSTAT2 */
114 u16 rdslb; /* RDSLBMSB & RDSLBLSB */
115 u16 rdspb; /* RDSPBMSB & RDSPBLSB */
116 u16 rdsbc; /* RDSBBC & RDSGBC */
117 u16 rdsctrl; /* RDSCTRL1 & RDSCTRL2 */
118 u16 rdsbbl; /* PAUSEDET & RDSBBL */
119 u16 manid; /* MANID1 & MANID2 */
120 u16 chipid; /* CHIPID1 & CHIPID2 */
121 } __attribute__ ((packed));
123 struct tea5764_write_regs {
124 u8 intreg; /* INTMSK */
125 u16 frqset; /* FRQSETMSB & FRQSETLSB */
126 u16 tnctrl; /* TNCTRL1 & TNCTRL2 */
127 u16 testreg; /* TESTBITS & TESTMODE */
128 u16 rdsctrl; /* RDSCTRL1 & RDSCTRL2 */
129 u16 rdsbbl; /* PAUSEDET & RDSBBL */
130 } __attribute__ ((packed));
132 #ifndef RADIO_TEA5764_XTAL
133 #define RADIO_TEA5764_XTAL 1
136 static int radio_nr = -1;
137 static int use_xtal = RADIO_TEA5764_XTAL;
139 struct tea5764_device {
140 struct i2c_client *i2c_client;
141 struct video_device *videodev;
142 struct tea5764_regs regs;
147 /* I2C code related */
148 int tea5764_i2c_read(struct tea5764_device *radio)
151 u16 *p = (u16 *) &radio->regs;
153 struct i2c_msg msgs[1] = {
154 { radio->i2c_client->addr, I2C_M_RD, sizeof(radio->regs),
155 (void *)&radio->regs },
157 if (i2c_transfer(radio->i2c_client->adapter, msgs, 1) != 1)
159 for (i = 0; i < sizeof(struct tea5764_regs) / sizeof(u16); i++)
160 p[i] = __be16_to_cpu(p[i]);
165 int tea5764_i2c_write(struct tea5764_device *radio)
167 struct tea5764_write_regs wr;
168 struct tea5764_regs *r = &radio->regs;
169 struct i2c_msg msgs[1] = {
170 { radio->i2c_client->addr, 0, sizeof(wr), (void *) &wr },
172 wr.intreg = r->intreg & 0xff;
173 wr.frqset = __cpu_to_be16(r->frqset);
174 wr.tnctrl = __cpu_to_be16(r->tnctrl);
175 wr.testreg = __cpu_to_be16(r->testreg);
176 wr.rdsctrl = __cpu_to_be16(r->rdsctrl);
177 wr.rdsbbl = __cpu_to_be16(r->rdsbbl);
178 if (i2c_transfer(radio->i2c_client->adapter, msgs, 1) != 1)
183 /* V4L2 code related */
184 static struct v4l2_queryctrl radio_qctrl[] = {
186 .id = V4L2_CID_AUDIO_MUTE,
191 .type = V4L2_CTRL_TYPE_BOOLEAN,
195 static void tea5764_power_up(struct tea5764_device *radio)
197 struct tea5764_regs *r = &radio->regs;
199 if (!(r->tnctrl & TEA5764_TNCTRL_PUPD0)) {
200 r->tnctrl &= ~(TEA5764_TNCTRL_AFM | TEA5764_TNCTRL_MU |
201 TEA5764_TNCTRL_HLSI);
203 r->testreg |= TEA5764_TESTREG_TRIGFR;
205 r->testreg &= ~TEA5764_TESTREG_TRIGFR;
207 r->tnctrl |= TEA5764_TNCTRL_PUPD0;
208 tea5764_i2c_write(radio);
212 static void tea5764_power_down(struct tea5764_device *radio)
214 struct tea5764_regs *r = &radio->regs;
216 if (r->tnctrl & TEA5764_TNCTRL_PUPD0) {
217 r->tnctrl &= ~TEA5764_TNCTRL_PUPD0;
218 tea5764_i2c_write(radio);
222 static void tea5764_set_freq(struct tea5764_device *radio, int freq)
224 struct tea5764_regs *r = &radio->regs;
226 /* formula: (freq [+ or -] 225000) / 8192 */
227 if (r->tnctrl & TEA5764_TNCTRL_HLSI)
228 r->frqset = (freq + 225000) / 8192;
230 r->frqset = (freq - 225000) / 8192;
233 static int tea5764_get_freq(struct tea5764_device *radio)
235 struct tea5764_regs *r = &radio->regs;
237 if (r->tnctrl & TEA5764_TNCTRL_HLSI)
238 return (r->frqchk * 8192) - 225000;
240 return (r->frqchk * 8192) + 225000;
243 /* tune an frequency, freq is defined by v4l's TUNER_LOW, i.e. 1/16th kHz */
244 static void tea5764_tune(struct tea5764_device *radio, int freq)
246 tea5764_set_freq(radio, freq);
247 if (tea5764_i2c_write(radio))
248 PWARN("Could not set frequency!");
251 static void tea5764_set_audout_mode(struct tea5764_device *radio, int audmode)
253 struct tea5764_regs *r = &radio->regs;
254 int tnctrl = r->tnctrl;
256 if (audmode == V4L2_TUNER_MODE_MONO)
257 r->tnctrl |= TEA5764_TNCTRL_MST;
259 r->tnctrl &= ~TEA5764_TNCTRL_MST;
260 if (tnctrl != r->tnctrl)
261 tea5764_i2c_write(radio);
264 static int tea5764_get_audout_mode(struct tea5764_device *radio)
266 struct tea5764_regs *r = &radio->regs;
268 if (r->tnctrl & TEA5764_TNCTRL_MST)
269 return V4L2_TUNER_MODE_MONO;
271 return V4L2_TUNER_MODE_STEREO;
274 static void tea5764_mute(struct tea5764_device *radio, int on)
276 struct tea5764_regs *r = &radio->regs;
277 int tnctrl = r->tnctrl;
280 r->tnctrl |= TEA5764_TNCTRL_MU;
282 r->tnctrl &= ~TEA5764_TNCTRL_MU;
283 if (tnctrl != r->tnctrl)
284 tea5764_i2c_write(radio);
287 static int tea5764_is_muted(struct tea5764_device *radio)
289 return radio->regs.tnctrl & TEA5764_TNCTRL_MU;
293 static int vidioc_querycap(struct file *file, void *priv,
294 struct v4l2_capability *v)
296 struct tea5764_device *radio = video_drvdata(file);
297 struct video_device *dev = radio->videodev;
299 strlcpy(v->driver, dev->dev.driver->name, sizeof(v->driver));
300 strlcpy(v->card, dev->name, sizeof(v->card));
301 snprintf(v->bus_info, sizeof(v->bus_info),
302 "I2C:%s", dev_name(&dev->dev));
303 v->version = RADIO_VERSION;
304 v->capabilities = V4L2_CAP_TUNER | V4L2_CAP_RADIO;
308 static int vidioc_g_tuner(struct file *file, void *priv,
309 struct v4l2_tuner *v)
311 struct tea5764_device *radio = video_drvdata(file);
312 struct tea5764_regs *r = &radio->regs;
317 memset(v, 0, sizeof(*v));
318 strcpy(v->name, "FM");
319 v->type = V4L2_TUNER_RADIO;
320 tea5764_i2c_read(radio);
321 v->rangelow = FREQ_MIN * FREQ_MUL;
322 v->rangehigh = FREQ_MAX * FREQ_MUL;
323 v->capability = V4L2_TUNER_CAP_LOW | V4L2_TUNER_CAP_STEREO;
324 if (r->tunchk & TEA5764_TUNCHK_STEREO)
325 v->rxsubchans = V4L2_TUNER_SUB_STEREO;
327 v->rxsubchans = V4L2_TUNER_SUB_MONO;
328 v->audmode = tea5764_get_audout_mode(radio);
329 v->signal = TEA5764_TUNCHK_LEVEL(r->tunchk) * 0xffff / 0xf;
330 v->afc = TEA5764_TUNCHK_IFCNT(r->tunchk);
335 static int vidioc_s_tuner(struct file *file, void *priv,
336 struct v4l2_tuner *v)
338 struct tea5764_device *radio = video_drvdata(file);
343 tea5764_set_audout_mode(radio, v->audmode);
347 static int vidioc_s_frequency(struct file *file, void *priv,
348 struct v4l2_frequency *f)
350 struct tea5764_device *radio = video_drvdata(file);
352 if (f->tuner != 0 || f->type != V4L2_TUNER_RADIO)
354 if (f->frequency == 0) {
355 /* We special case this as a power down control. */
356 tea5764_power_down(radio);
358 if (f->frequency < (FREQ_MIN * FREQ_MUL))
360 if (f->frequency > (FREQ_MAX * FREQ_MUL))
362 tea5764_power_up(radio);
363 tea5764_tune(radio, (f->frequency * 125) / 2);
367 static int vidioc_g_frequency(struct file *file, void *priv,
368 struct v4l2_frequency *f)
370 struct tea5764_device *radio = video_drvdata(file);
371 struct tea5764_regs *r = &radio->regs;
375 tea5764_i2c_read(radio);
376 memset(f, 0, sizeof(*f));
377 f->type = V4L2_TUNER_RADIO;
378 if (r->tnctrl & TEA5764_TNCTRL_PUPD0)
379 f->frequency = (tea5764_get_freq(radio) * 2) / 125;
386 static int vidioc_queryctrl(struct file *file, void *priv,
387 struct v4l2_queryctrl *qc)
391 for (i = 0; i < ARRAY_SIZE(radio_qctrl); i++) {
392 if (qc->id && qc->id == radio_qctrl[i].id) {
393 memcpy(qc, &(radio_qctrl[i]), sizeof(*qc));
400 static int vidioc_g_ctrl(struct file *file, void *priv,
401 struct v4l2_control *ctrl)
403 struct tea5764_device *radio = video_drvdata(file);
406 case V4L2_CID_AUDIO_MUTE:
407 tea5764_i2c_read(radio);
408 ctrl->value = tea5764_is_muted(radio) ? 1 : 0;
414 static int vidioc_s_ctrl(struct file *file, void *priv,
415 struct v4l2_control *ctrl)
417 struct tea5764_device *radio = video_drvdata(file);
420 case V4L2_CID_AUDIO_MUTE:
421 tea5764_mute(radio, ctrl->value);
427 static int vidioc_g_input(struct file *filp, void *priv, unsigned int *i)
433 static int vidioc_s_input(struct file *filp, void *priv, unsigned int i)
440 static int vidioc_g_audio(struct file *file, void *priv,
441 struct v4l2_audio *a)
446 strcpy(a->name, "Radio");
447 a->capability = V4L2_AUDCAP_STEREO;
451 static int vidioc_s_audio(struct file *file, void *priv,
452 struct v4l2_audio *a)
460 static int tea5764_open(struct file *file)
462 /* Currently we support only one device */
463 struct tea5764_device *radio = video_drvdata(file);
465 mutex_lock(&radio->mutex);
466 /* Only exclusive access */
468 mutex_unlock(&radio->mutex);
472 mutex_unlock(&radio->mutex);
473 file->private_data = radio;
477 static int tea5764_close(struct file *file)
479 struct tea5764_device *radio = video_drvdata(file);
483 mutex_lock(&radio->mutex);
485 mutex_unlock(&radio->mutex);
489 /* File system interface */
490 static const struct v4l2_file_operations tea5764_fops = {
491 .owner = THIS_MODULE,
492 .open = tea5764_open,
493 .release = tea5764_close,
494 .ioctl = video_ioctl2,
497 static const struct v4l2_ioctl_ops tea5764_ioctl_ops = {
498 .vidioc_querycap = vidioc_querycap,
499 .vidioc_g_tuner = vidioc_g_tuner,
500 .vidioc_s_tuner = vidioc_s_tuner,
501 .vidioc_g_audio = vidioc_g_audio,
502 .vidioc_s_audio = vidioc_s_audio,
503 .vidioc_g_input = vidioc_g_input,
504 .vidioc_s_input = vidioc_s_input,
505 .vidioc_g_frequency = vidioc_g_frequency,
506 .vidioc_s_frequency = vidioc_s_frequency,
507 .vidioc_queryctrl = vidioc_queryctrl,
508 .vidioc_g_ctrl = vidioc_g_ctrl,
509 .vidioc_s_ctrl = vidioc_s_ctrl,
513 static struct video_device tea5764_radio_template = {
514 .name = "TEA5764 FM-Radio",
515 .fops = &tea5764_fops,
516 .ioctl_ops = &tea5764_ioctl_ops,
517 .release = video_device_release,
520 /* I2C probe: check if the device exists and register with v4l if it is */
521 static int __devinit tea5764_i2c_probe(struct i2c_client *client,
522 const struct i2c_device_id *id)
524 struct tea5764_device *radio;
525 struct tea5764_regs *r;
529 radio = kmalloc(sizeof(struct tea5764_device), GFP_KERNEL);
533 mutex_init(&radio->mutex);
534 radio->i2c_client = client;
535 ret = tea5764_i2c_read(radio);
539 PDEBUG("chipid = %04X, manid = %04X", r->chipid, r->manid);
540 if (r->chipid != TEA5764_CHIPID ||
541 (r->manid & 0x0fff) != TEA5764_MANID) {
542 PWARN("This chip is not a TEA5764!");
547 radio->videodev = video_device_alloc();
548 if (!(radio->videodev)) {
552 memcpy(radio->videodev, &tea5764_radio_template,
553 sizeof(tea5764_radio_template));
555 i2c_set_clientdata(client, radio);
556 video_set_drvdata(radio->videodev, radio);
558 ret = video_register_device(radio->videodev, VFL_TYPE_RADIO, radio_nr);
560 PWARN("Could not register video device!");
564 /* initialize and power off the chip */
565 tea5764_i2c_read(radio);
566 tea5764_set_audout_mode(radio, V4L2_TUNER_MODE_STEREO);
567 tea5764_mute(radio, 1);
568 tea5764_power_down(radio);
570 PINFO("registered.");
573 video_device_release(radio->videodev);
579 static int __devexit tea5764_i2c_remove(struct i2c_client *client)
581 struct tea5764_device *radio = i2c_get_clientdata(client);
585 tea5764_power_down(radio);
586 video_unregister_device(radio->videodev);
592 /* I2C subsystem interface */
593 static const struct i2c_device_id tea5764_id[] = {
594 { "radio-tea5764", 0 },
595 { } /* Terminating entry */
597 MODULE_DEVICE_TABLE(i2c, tea5764_id);
599 static struct i2c_driver tea5764_i2c_driver = {
601 .name = "radio-tea5764",
602 .owner = THIS_MODULE,
604 .probe = tea5764_i2c_probe,
605 .remove = __devexit_p(tea5764_i2c_remove),
606 .id_table = tea5764_id,
609 /* init the driver */
610 static int __init tea5764_init(void)
612 int ret = i2c_add_driver(&tea5764_i2c_driver);
614 printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_VERSION ": "
619 /* cleanup the driver */
620 static void __exit tea5764_exit(void)
622 i2c_del_driver(&tea5764_i2c_driver);
625 MODULE_AUTHOR(DRIVER_AUTHOR);
626 MODULE_DESCRIPTION(DRIVER_DESC);
627 MODULE_LICENSE("GPL");
629 module_param(use_xtal, int, 1);
630 MODULE_PARM_DESC(use_xtal, "Chip have a xtal connected in board");
631 module_param(radio_nr, int, 0);
632 MODULE_PARM_DESC(radio_nr, "video4linux device number to use");
634 module_init(tea5764_init);
635 module_exit(tea5764_exit);