2 * MFD driver for TWL6040 audio device
4 * Authors: Misael Lopez Cruz <misael.lopez@ti.com>
5 * Jorge Eduardo Candelaria <jorge.candelaria@ti.com>
6 * Peter Ujfalusi <peter.ujfalusi@ti.com>
8 * Copyright: (C) 2011 Texas Instruments, Inc.
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License version 2 as
12 * published by the Free Software Foundation.
14 * This program is distributed in the hope that it will be useful, but
15 * WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 * General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
26 #include <linux/module.h>
27 #include <linux/types.h>
28 #include <linux/slab.h>
29 #include <linux/kernel.h>
30 #include <linux/err.h>
31 #include <linux/platform_device.h>
33 #include <linux/of_irq.h>
34 #include <linux/of_gpio.h>
35 #include <linux/of_platform.h>
36 #include <linux/gpio.h>
37 #include <linux/delay.h>
38 #include <linux/i2c.h>
39 #include <linux/regmap.h>
40 #include <linux/err.h>
41 #include <linux/mfd/core.h>
42 #include <linux/mfd/twl6040.h>
43 #include <linux/regulator/consumer.h>
45 #define VIBRACTRL_MEMBER(reg) ((reg == TWL6040_REG_VIBCTLL) ? 0 : 1)
46 #define TWL6040_NUM_SUPPLIES (2)
48 static bool twl6040_has_vibra(struct twl6040_platform_data *pdata,
49 struct device_node *node)
51 if (pdata && pdata->vibra)
55 if (of_find_node_by_name(node, "vibra"))
62 int twl6040_reg_read(struct twl6040 *twl6040, unsigned int reg)
67 /* Vibra control registers from cache */
68 if (unlikely(reg == TWL6040_REG_VIBCTLL ||
69 reg == TWL6040_REG_VIBCTLR)) {
70 val = twl6040->vibra_ctrl_cache[VIBRACTRL_MEMBER(reg)];
72 ret = regmap_read(twl6040->regmap, reg, &val);
79 EXPORT_SYMBOL(twl6040_reg_read);
81 int twl6040_reg_write(struct twl6040 *twl6040, unsigned int reg, u8 val)
85 ret = regmap_write(twl6040->regmap, reg, val);
86 /* Cache the vibra control registers */
87 if (reg == TWL6040_REG_VIBCTLL || reg == TWL6040_REG_VIBCTLR)
88 twl6040->vibra_ctrl_cache[VIBRACTRL_MEMBER(reg)] = val;
92 EXPORT_SYMBOL(twl6040_reg_write);
94 int twl6040_set_bits(struct twl6040 *twl6040, unsigned int reg, u8 mask)
96 return regmap_update_bits(twl6040->regmap, reg, mask, mask);
98 EXPORT_SYMBOL(twl6040_set_bits);
100 int twl6040_clear_bits(struct twl6040 *twl6040, unsigned int reg, u8 mask)
102 return regmap_update_bits(twl6040->regmap, reg, mask, 0);
104 EXPORT_SYMBOL(twl6040_clear_bits);
106 /* twl6040 codec manual power-up sequence */
107 static int twl6040_power_up_manual(struct twl6040 *twl6040)
109 u8 ldoctl, ncpctl, lppllctl;
112 /* enable high-side LDO, reference system and internal oscillator */
113 ldoctl = TWL6040_HSLDOENA | TWL6040_REFENA | TWL6040_OSCENA;
114 ret = twl6040_reg_write(twl6040, TWL6040_REG_LDOCTL, ldoctl);
117 usleep_range(10000, 10500);
119 /* enable negative charge pump */
120 ncpctl = TWL6040_NCPENA;
121 ret = twl6040_reg_write(twl6040, TWL6040_REG_NCPCTL, ncpctl);
124 usleep_range(1000, 1500);
126 /* enable low-side LDO */
127 ldoctl |= TWL6040_LSLDOENA;
128 ret = twl6040_reg_write(twl6040, TWL6040_REG_LDOCTL, ldoctl);
131 usleep_range(1000, 1500);
133 /* enable low-power PLL */
134 lppllctl = TWL6040_LPLLENA;
135 ret = twl6040_reg_write(twl6040, TWL6040_REG_LPPLLCTL, lppllctl);
138 usleep_range(5000, 5500);
140 /* disable internal oscillator */
141 ldoctl &= ~TWL6040_OSCENA;
142 ret = twl6040_reg_write(twl6040, TWL6040_REG_LDOCTL, ldoctl);
149 lppllctl &= ~TWL6040_LPLLENA;
150 twl6040_reg_write(twl6040, TWL6040_REG_LPPLLCTL, lppllctl);
152 ldoctl &= ~TWL6040_LSLDOENA;
153 twl6040_reg_write(twl6040, TWL6040_REG_LDOCTL, ldoctl);
155 ncpctl &= ~TWL6040_NCPENA;
156 twl6040_reg_write(twl6040, TWL6040_REG_NCPCTL, ncpctl);
158 ldoctl &= ~(TWL6040_HSLDOENA | TWL6040_REFENA | TWL6040_OSCENA);
159 twl6040_reg_write(twl6040, TWL6040_REG_LDOCTL, ldoctl);
161 dev_err(twl6040->dev, "manual power-up failed\n");
165 /* twl6040 manual power-down sequence */
166 static void twl6040_power_down_manual(struct twl6040 *twl6040)
168 u8 ncpctl, ldoctl, lppllctl;
170 ncpctl = twl6040_reg_read(twl6040, TWL6040_REG_NCPCTL);
171 ldoctl = twl6040_reg_read(twl6040, TWL6040_REG_LDOCTL);
172 lppllctl = twl6040_reg_read(twl6040, TWL6040_REG_LPPLLCTL);
174 /* enable internal oscillator */
175 ldoctl |= TWL6040_OSCENA;
176 twl6040_reg_write(twl6040, TWL6040_REG_LDOCTL, ldoctl);
177 usleep_range(1000, 1500);
179 /* disable low-power PLL */
180 lppllctl &= ~TWL6040_LPLLENA;
181 twl6040_reg_write(twl6040, TWL6040_REG_LPPLLCTL, lppllctl);
183 /* disable low-side LDO */
184 ldoctl &= ~TWL6040_LSLDOENA;
185 twl6040_reg_write(twl6040, TWL6040_REG_LDOCTL, ldoctl);
187 /* disable negative charge pump */
188 ncpctl &= ~TWL6040_NCPENA;
189 twl6040_reg_write(twl6040, TWL6040_REG_NCPCTL, ncpctl);
191 /* disable high-side LDO, reference system and internal oscillator */
192 ldoctl &= ~(TWL6040_HSLDOENA | TWL6040_REFENA | TWL6040_OSCENA);
193 twl6040_reg_write(twl6040, TWL6040_REG_LDOCTL, ldoctl);
196 static irqreturn_t twl6040_readyint_handler(int irq, void *data)
198 struct twl6040 *twl6040 = data;
200 complete(&twl6040->ready);
205 static irqreturn_t twl6040_thint_handler(int irq, void *data)
207 struct twl6040 *twl6040 = data;
210 status = twl6040_reg_read(twl6040, TWL6040_REG_STATUS);
211 if (status & TWL6040_TSHUTDET) {
212 dev_warn(twl6040->dev, "Thermal shutdown, powering-off");
213 twl6040_power(twl6040, 0);
215 dev_warn(twl6040->dev, "Leaving thermal shutdown, powering-on");
216 twl6040_power(twl6040, 1);
222 static int twl6040_power_up_automatic(struct twl6040 *twl6040)
226 gpio_set_value(twl6040->audpwron, 1);
228 time_left = wait_for_completion_timeout(&twl6040->ready,
229 msecs_to_jiffies(144));
233 dev_warn(twl6040->dev, "timeout waiting for READYINT\n");
234 intid = twl6040_reg_read(twl6040, TWL6040_REG_INTID);
235 if (!(intid & TWL6040_READYINT)) {
236 dev_err(twl6040->dev, "automatic power-up failed\n");
237 gpio_set_value(twl6040->audpwron, 0);
245 int twl6040_power(struct twl6040 *twl6040, int on)
249 mutex_lock(&twl6040->mutex);
252 /* already powered-up */
253 if (twl6040->power_count++)
256 if (gpio_is_valid(twl6040->audpwron)) {
257 /* use automatic power-up sequence */
258 ret = twl6040_power_up_automatic(twl6040);
260 twl6040->power_count = 0;
264 /* use manual power-up sequence */
265 ret = twl6040_power_up_manual(twl6040);
267 twl6040->power_count = 0;
271 /* Default PLL configuration after power up */
272 twl6040->pll = TWL6040_SYSCLK_SEL_LPPLL;
273 twl6040->sysclk = 19200000;
274 twl6040->mclk = 32768;
276 /* already powered-down */
277 if (!twl6040->power_count) {
278 dev_err(twl6040->dev,
279 "device is already powered-off\n");
284 if (--twl6040->power_count)
287 if (gpio_is_valid(twl6040->audpwron)) {
288 /* use AUDPWRON line */
289 gpio_set_value(twl6040->audpwron, 0);
291 /* power-down sequence latency */
292 usleep_range(500, 700);
294 /* use manual power-down sequence */
295 twl6040_power_down_manual(twl6040);
302 mutex_unlock(&twl6040->mutex);
305 EXPORT_SYMBOL(twl6040_power);
307 int twl6040_set_pll(struct twl6040 *twl6040, int pll_id,
308 unsigned int freq_in, unsigned int freq_out)
310 u8 hppllctl, lppllctl;
313 mutex_lock(&twl6040->mutex);
315 hppllctl = twl6040_reg_read(twl6040, TWL6040_REG_HPPLLCTL);
316 lppllctl = twl6040_reg_read(twl6040, TWL6040_REG_LPPLLCTL);
318 /* Force full reconfiguration when switching between PLL */
319 if (pll_id != twl6040->pll) {
325 case TWL6040_SYSCLK_SEL_LPPLL:
326 /* low-power PLL divider */
327 /* Change the sysclk configuration only if it has been canged */
328 if (twl6040->sysclk != freq_out) {
331 lppllctl |= TWL6040_LPLLFIN;
334 lppllctl &= ~TWL6040_LPLLFIN;
337 dev_err(twl6040->dev,
338 "freq_out %d not supported\n",
343 twl6040_reg_write(twl6040, TWL6040_REG_LPPLLCTL,
347 /* The PLL in use has not been change, we can exit */
348 if (twl6040->pll == pll_id)
353 lppllctl |= TWL6040_LPLLENA;
354 twl6040_reg_write(twl6040, TWL6040_REG_LPPLLCTL,
357 lppllctl &= ~TWL6040_HPLLSEL;
358 twl6040_reg_write(twl6040, TWL6040_REG_LPPLLCTL,
360 hppllctl &= ~TWL6040_HPLLENA;
361 twl6040_reg_write(twl6040, TWL6040_REG_HPPLLCTL,
365 dev_err(twl6040->dev,
366 "freq_in %d not supported\n", freq_in);
371 case TWL6040_SYSCLK_SEL_HPPLL:
372 /* high-performance PLL can provide only 19.2 MHz */
373 if (freq_out != 19200000) {
374 dev_err(twl6040->dev,
375 "freq_out %d not supported\n", freq_out);
380 if (twl6040->mclk != freq_in) {
381 hppllctl &= ~TWL6040_MCLK_MSK;
385 /* PLL enabled, active mode */
386 hppllctl |= TWL6040_MCLK_12000KHZ |
392 * (enable PLL if MCLK jitter quality
393 * doesn't meet specification)
395 hppllctl |= TWL6040_MCLK_19200KHZ;
398 /* PLL enabled, active mode */
399 hppllctl |= TWL6040_MCLK_26000KHZ |
403 /* PLL enabled, active mode */
404 hppllctl |= TWL6040_MCLK_38400KHZ |
408 dev_err(twl6040->dev,
409 "freq_in %d not supported\n", freq_in);
415 * enable clock slicer to ensure input waveform is
418 hppllctl |= TWL6040_HPLLSQRENA;
420 twl6040_reg_write(twl6040, TWL6040_REG_HPPLLCTL,
422 usleep_range(500, 700);
423 lppllctl |= TWL6040_HPLLSEL;
424 twl6040_reg_write(twl6040, TWL6040_REG_LPPLLCTL,
426 lppllctl &= ~TWL6040_LPLLENA;
427 twl6040_reg_write(twl6040, TWL6040_REG_LPPLLCTL,
432 dev_err(twl6040->dev, "unknown pll id %d\n", pll_id);
437 twl6040->sysclk = freq_out;
438 twl6040->mclk = freq_in;
439 twl6040->pll = pll_id;
442 mutex_unlock(&twl6040->mutex);
445 EXPORT_SYMBOL(twl6040_set_pll);
447 int twl6040_get_pll(struct twl6040 *twl6040)
449 if (twl6040->power_count)
454 EXPORT_SYMBOL(twl6040_get_pll);
456 unsigned int twl6040_get_sysclk(struct twl6040 *twl6040)
458 return twl6040->sysclk;
460 EXPORT_SYMBOL(twl6040_get_sysclk);
462 /* Get the combined status of the vibra control register */
463 int twl6040_get_vibralr_status(struct twl6040 *twl6040)
467 status = twl6040->vibra_ctrl_cache[0] | twl6040->vibra_ctrl_cache[1];
468 status &= (TWL6040_VIBENA | TWL6040_VIBSEL);
472 EXPORT_SYMBOL(twl6040_get_vibralr_status);
474 static struct resource twl6040_vibra_rsrc[] = {
476 .flags = IORESOURCE_IRQ,
480 static struct resource twl6040_codec_rsrc[] = {
482 .flags = IORESOURCE_IRQ,
486 static bool twl6040_readable_reg(struct device *dev, unsigned int reg)
488 /* Register 0 is not readable */
494 static struct regmap_config twl6040_regmap_config = {
497 .max_register = TWL6040_REG_STATUS, /* 0x2e */
499 .readable_reg = twl6040_readable_reg,
502 static int __devinit twl6040_probe(struct i2c_client *client,
503 const struct i2c_device_id *id)
505 struct twl6040_platform_data *pdata = client->dev.platform_data;
506 struct device_node *node = client->dev.of_node;
507 struct twl6040 *twl6040;
508 struct mfd_cell *cell = NULL;
509 int irq, ret, children = 0;
511 if (!pdata && !node) {
512 dev_err(&client->dev, "Platform data is missing\n");
516 /* In order to operate correctly we need valid interrupt config */
518 dev_err(&client->dev, "Invalid IRQ configuration\n");
522 twl6040 = devm_kzalloc(&client->dev, sizeof(struct twl6040),
529 twl6040->regmap = devm_regmap_init_i2c(client, &twl6040_regmap_config);
530 if (IS_ERR(twl6040->regmap)) {
531 ret = PTR_ERR(twl6040->regmap);
535 i2c_set_clientdata(client, twl6040);
537 twl6040->supplies[0].supply = "vio";
538 twl6040->supplies[1].supply = "v2v1";
539 ret = regulator_bulk_get(&client->dev, TWL6040_NUM_SUPPLIES,
542 dev_err(&client->dev, "Failed to get supplies: %d\n", ret);
543 goto regulator_get_err;
546 ret = regulator_bulk_enable(TWL6040_NUM_SUPPLIES, twl6040->supplies);
548 dev_err(&client->dev, "Failed to enable supplies: %d\n", ret);
552 twl6040->dev = &client->dev;
553 twl6040->irq = client->irq;
555 mutex_init(&twl6040->mutex);
556 init_completion(&twl6040->ready);
558 twl6040->rev = twl6040_reg_read(twl6040, TWL6040_REG_ASICREV);
560 /* ERRATA: Automatic power-up is not possible in ES1.0 */
561 if (twl6040_get_revid(twl6040) > TWL6040_REV_ES1_0) {
563 twl6040->audpwron = pdata->audpwron_gpio;
565 twl6040->audpwron = of_get_named_gpio(node,
566 "ti,audpwron-gpio", 0);
568 twl6040->audpwron = -EINVAL;
570 if (gpio_is_valid(twl6040->audpwron)) {
571 ret = gpio_request_one(twl6040->audpwron, GPIOF_OUT_INIT_LOW,
577 /* codec interrupt */
578 ret = twl6040_irq_init(twl6040);
582 ret = request_threaded_irq(twl6040->irq_base + TWL6040_IRQ_READY,
583 NULL, twl6040_readyint_handler, IRQF_ONESHOT,
584 "twl6040_irq_ready", twl6040);
586 dev_err(twl6040->dev, "READY IRQ request failed: %d\n", ret);
590 ret = request_threaded_irq(twl6040->irq_base + TWL6040_IRQ_TH,
591 NULL, twl6040_thint_handler, IRQF_ONESHOT,
592 "twl6040_irq_th", twl6040);
594 dev_err(twl6040->dev, "Thermal IRQ request failed: %d\n", ret);
598 /* dual-access registers controlled by I2C only */
599 twl6040_set_bits(twl6040, TWL6040_REG_ACCCTL, TWL6040_I2CSEL);
602 * The main functionality of twl6040 to provide audio on OMAP4+ systems.
603 * We can add the ASoC codec child whenever this driver has been loaded.
604 * The ASoC codec can work without pdata, pass the platform_data only if
605 * it has been provided.
607 irq = twl6040->irq_base + TWL6040_IRQ_PLUG;
608 cell = &twl6040->cells[children];
609 cell->name = "twl6040-codec";
610 twl6040_codec_rsrc[0].start = irq;
611 twl6040_codec_rsrc[0].end = irq;
612 cell->resources = twl6040_codec_rsrc;
613 cell->num_resources = ARRAY_SIZE(twl6040_codec_rsrc);
614 if (pdata && pdata->codec) {
615 cell->platform_data = pdata->codec;
616 cell->pdata_size = sizeof(*pdata->codec);
620 if (twl6040_has_vibra(pdata, node)) {
621 irq = twl6040->irq_base + TWL6040_IRQ_VIB;
623 cell = &twl6040->cells[children];
624 cell->name = "twl6040-vibra";
625 twl6040_vibra_rsrc[0].start = irq;
626 twl6040_vibra_rsrc[0].end = irq;
627 cell->resources = twl6040_vibra_rsrc;
628 cell->num_resources = ARRAY_SIZE(twl6040_vibra_rsrc);
630 if (pdata && pdata->vibra) {
631 cell->platform_data = pdata->vibra;
632 cell->pdata_size = sizeof(*pdata->vibra);
638 * Enable the GPO driver in the following cases:
639 * DT booted kernel or legacy boot with valid gpo platform_data
641 if (!pdata || (pdata && pdata->gpo)) {
642 cell = &twl6040->cells[children];
643 cell->name = "twl6040-gpo";
646 cell->platform_data = pdata->gpo;
647 cell->pdata_size = sizeof(*pdata->gpo);
652 ret = mfd_add_devices(&client->dev, -1, twl6040->cells, children,
660 free_irq(twl6040->irq_base + TWL6040_IRQ_TH, twl6040);
662 free_irq(twl6040->irq_base + TWL6040_IRQ_READY, twl6040);
664 twl6040_irq_exit(twl6040);
666 if (gpio_is_valid(twl6040->audpwron))
667 gpio_free(twl6040->audpwron);
669 regulator_bulk_disable(TWL6040_NUM_SUPPLIES, twl6040->supplies);
671 regulator_bulk_free(TWL6040_NUM_SUPPLIES, twl6040->supplies);
673 i2c_set_clientdata(client, NULL);
678 static int __devexit twl6040_remove(struct i2c_client *client)
680 struct twl6040 *twl6040 = i2c_get_clientdata(client);
682 if (twl6040->power_count)
683 twl6040_power(twl6040, 0);
685 if (gpio_is_valid(twl6040->audpwron))
686 gpio_free(twl6040->audpwron);
688 free_irq(twl6040->irq_base + TWL6040_IRQ_READY, twl6040);
689 free_irq(twl6040->irq_base + TWL6040_IRQ_TH, twl6040);
690 twl6040_irq_exit(twl6040);
692 mfd_remove_devices(&client->dev);
693 i2c_set_clientdata(client, NULL);
695 regulator_bulk_disable(TWL6040_NUM_SUPPLIES, twl6040->supplies);
696 regulator_bulk_free(TWL6040_NUM_SUPPLIES, twl6040->supplies);
701 static const struct i2c_device_id twl6040_i2c_id[] = {
706 MODULE_DEVICE_TABLE(i2c, twl6040_i2c_id);
708 static struct i2c_driver twl6040_driver = {
711 .owner = THIS_MODULE,
713 .probe = twl6040_probe,
714 .remove = __devexit_p(twl6040_remove),
715 .id_table = twl6040_i2c_id,
718 module_i2c_driver(twl6040_driver);
720 MODULE_DESCRIPTION("TWL6040 MFD");
721 MODULE_AUTHOR("Misael Lopez Cruz <misael.lopez@ti.com>");
722 MODULE_AUTHOR("Jorge Eduardo Candelaria <jorge.candelaria@ti.com>");
723 MODULE_LICENSE("GPL");
724 MODULE_ALIAS("platform:twl6040");