2 * max77686.c - mfd core driver for the Maxim 77686
4 * Copyright (C) 2012 Samsung Electronics
5 * Chiwoong Byun <woong.byun@smasung.com>
6 * Jonghwa Lee <jonghwa3.lee@samsung.com>
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
22 * This driver is based on max8997.c
25 #include <linux/export.h>
26 #include <linux/slab.h>
27 #include <linux/i2c.h>
28 #include <linux/irq.h>
29 #include <linux/interrupt.h>
30 #include <linux/pm_runtime.h>
31 #include <linux/module.h>
32 #include <linux/mfd/core.h>
33 #include <linux/mfd/max77686.h>
34 #include <linux/mfd/max77686-private.h>
35 #include <linux/err.h>
38 #define I2C_ADDR_RTC (0x0C >> 1)
40 static const struct mfd_cell max77686_devs[] = {
41 { .name = "max77686-pmic", },
42 { .name = "max77686-rtc", },
43 { .name = "max77686-clk", },
46 static struct regmap_config max77686_regmap_config = {
51 static struct regmap_config max77686_rtc_regmap_config = {
56 static const struct regmap_irq max77686_irqs[] = {
58 { .reg_offset = 0, .mask = MAX77686_INT1_PWRONF_MSK, },
59 { .reg_offset = 0, .mask = MAX77686_INT1_PWRONR_MSK, },
60 { .reg_offset = 0, .mask = MAX77686_INT1_JIGONBF_MSK, },
61 { .reg_offset = 0, .mask = MAX77686_INT1_JIGONBR_MSK, },
62 { .reg_offset = 0, .mask = MAX77686_INT1_ACOKBF_MSK, },
63 { .reg_offset = 0, .mask = MAX77686_INT1_ACOKBR_MSK, },
64 { .reg_offset = 0, .mask = MAX77686_INT1_ONKEY1S_MSK, },
65 { .reg_offset = 0, .mask = MAX77686_INT1_MRSTB_MSK, },
67 { .reg_offset = 1, .mask = MAX77686_INT2_140C_MSK, },
68 { .reg_offset = 1, .mask = MAX77686_INT2_120C_MSK, },
71 static const struct regmap_irq_chip max77686_irq_chip = {
72 .name = "max77686-pmic",
73 .status_base = MAX77686_REG_INT1,
74 .mask_base = MAX77686_REG_INT1MSK,
76 .irqs = max77686_irqs,
77 .num_irqs = ARRAY_SIZE(max77686_irqs),
80 static const struct regmap_irq max77686_rtc_irqs[] = {
82 { .reg_offset = 0, .mask = MAX77686_RTCINT_RTC60S_MSK, },
83 { .reg_offset = 0, .mask = MAX77686_RTCINT_RTCA1_MSK, },
84 { .reg_offset = 0, .mask = MAX77686_RTCINT_RTCA2_MSK, },
85 { .reg_offset = 0, .mask = MAX77686_RTCINT_SMPL_MSK, },
86 { .reg_offset = 0, .mask = MAX77686_RTCINT_RTC1S_MSK, },
87 { .reg_offset = 0, .mask = MAX77686_RTCINT_WTSR_MSK, },
90 static const struct regmap_irq_chip max77686_rtc_irq_chip = {
91 .name = "max77686-rtc",
92 .status_base = MAX77686_RTC_INT,
93 .mask_base = MAX77686_RTC_INTM,
95 .irqs = max77686_rtc_irqs,
96 .num_irqs = ARRAY_SIZE(max77686_rtc_irqs),
99 static const struct of_device_id max77686_pmic_dt_match[] = {
100 {.compatible = "maxim,max77686", .data = NULL},
104 static struct max77686_platform_data *max77686_i2c_parse_dt_pdata(struct device
107 struct max77686_platform_data *pd;
109 pd = devm_kzalloc(dev, sizeof(*pd), GFP_KERNEL);
113 dev->platform_data = pd;
117 static int max77686_i2c_probe(struct i2c_client *i2c,
118 const struct i2c_device_id *id)
120 struct max77686_dev *max77686 = NULL;
121 struct max77686_platform_data *pdata = dev_get_platdata(&i2c->dev);
125 if (IS_ENABLED(CONFIG_OF) && i2c->dev.of_node && !pdata)
126 pdata = max77686_i2c_parse_dt_pdata(&i2c->dev);
129 dev_err(&i2c->dev, "No platform data found.\n");
133 max77686 = devm_kzalloc(&i2c->dev,
134 sizeof(struct max77686_dev), GFP_KERNEL);
138 i2c_set_clientdata(i2c, max77686);
139 max77686->dev = &i2c->dev;
141 max77686->type = id->driver_data;
143 max77686->wakeup = pdata->wakeup;
144 max77686->irq = i2c->irq;
146 max77686->regmap = devm_regmap_init_i2c(i2c, &max77686_regmap_config);
147 if (IS_ERR(max77686->regmap)) {
148 ret = PTR_ERR(max77686->regmap);
149 dev_err(max77686->dev, "Failed to allocate register map: %d\n",
154 ret = regmap_read(max77686->regmap, MAX77686_REG_DEVICE_ID, &data);
156 dev_err(max77686->dev,
157 "device not found on this channel (this is not an error)\n");
161 max77686->rtc = i2c_new_dummy(i2c->adapter, I2C_ADDR_RTC);
162 if (!max77686->rtc) {
163 dev_err(max77686->dev, "Failed to allocate I2C device for RTC\n");
166 i2c_set_clientdata(max77686->rtc, max77686);
168 max77686->rtc_regmap = devm_regmap_init_i2c(max77686->rtc,
169 &max77686_rtc_regmap_config);
170 if (IS_ERR(max77686->rtc_regmap)) {
171 ret = PTR_ERR(max77686->rtc_regmap);
172 dev_err(max77686->dev, "failed to allocate RTC regmap: %d\n",
174 goto err_unregister_i2c;
177 ret = regmap_add_irq_chip(max77686->regmap, max77686->irq,
178 IRQF_TRIGGER_FALLING | IRQF_ONESHOT |
179 IRQF_SHARED, 0, &max77686_irq_chip,
180 &max77686->irq_data);
182 dev_err(&i2c->dev, "failed to add PMIC irq chip: %d\n", ret);
183 goto err_unregister_i2c;
185 ret = regmap_add_irq_chip(max77686->rtc_regmap, max77686->irq,
186 IRQF_TRIGGER_FALLING | IRQF_ONESHOT |
187 IRQF_SHARED, 0, &max77686_rtc_irq_chip,
188 &max77686->rtc_irq_data);
190 dev_err(&i2c->dev, "failed to add RTC irq chip: %d\n", ret);
194 ret = mfd_add_devices(max77686->dev, -1, max77686_devs,
195 ARRAY_SIZE(max77686_devs), NULL, 0, NULL);
197 dev_err(&i2c->dev, "failed to add MFD devices: %d\n", ret);
198 goto err_del_rtc_irqc;
204 regmap_del_irq_chip(max77686->irq, max77686->rtc_irq_data);
206 regmap_del_irq_chip(max77686->irq, max77686->irq_data);
208 i2c_unregister_device(max77686->rtc);
213 static int max77686_i2c_remove(struct i2c_client *i2c)
215 struct max77686_dev *max77686 = i2c_get_clientdata(i2c);
217 mfd_remove_devices(max77686->dev);
219 regmap_del_irq_chip(max77686->irq, max77686->rtc_irq_data);
220 regmap_del_irq_chip(max77686->irq, max77686->irq_data);
222 i2c_unregister_device(max77686->rtc);
227 static const struct i2c_device_id max77686_i2c_id[] = {
228 { "max77686", TYPE_MAX77686 },
231 MODULE_DEVICE_TABLE(i2c, max77686_i2c_id);
233 #ifdef CONFIG_PM_SLEEP
234 static int max77686_suspend(struct device *dev)
236 struct i2c_client *i2c = container_of(dev, struct i2c_client, dev);
237 struct max77686_dev *max77686 = i2c_get_clientdata(i2c);
239 if (device_may_wakeup(dev))
240 enable_irq_wake(max77686->irq);
243 * IRQ must be disabled during suspend because if it happens
244 * while suspended it will be handled before resuming I2C.
246 * When device is woken up from suspend (e.g. by RTC wake alarm),
247 * an interrupt occurs before resuming I2C bus controller.
248 * Interrupt handler tries to read registers but this read
249 * will fail because I2C is still suspended.
251 disable_irq(max77686->irq);
256 static int max77686_resume(struct device *dev)
258 struct i2c_client *i2c = container_of(dev, struct i2c_client, dev);
259 struct max77686_dev *max77686 = i2c_get_clientdata(i2c);
261 if (device_may_wakeup(dev))
262 disable_irq_wake(max77686->irq);
264 enable_irq(max77686->irq);
268 #endif /* CONFIG_PM_SLEEP */
270 static SIMPLE_DEV_PM_OPS(max77686_pm, max77686_suspend, max77686_resume);
272 static struct i2c_driver max77686_i2c_driver = {
275 .owner = THIS_MODULE,
277 .of_match_table = of_match_ptr(max77686_pmic_dt_match),
279 .probe = max77686_i2c_probe,
280 .remove = max77686_i2c_remove,
281 .id_table = max77686_i2c_id,
284 static int __init max77686_i2c_init(void)
286 return i2c_add_driver(&max77686_i2c_driver);
288 /* init early so consumer devices can complete system boot */
289 subsys_initcall(max77686_i2c_init);
291 static void __exit max77686_i2c_exit(void)
293 i2c_del_driver(&max77686_i2c_driver);
295 module_exit(max77686_i2c_exit);
297 MODULE_DESCRIPTION("MAXIM 77686 multi-function core driver");
298 MODULE_AUTHOR("Chiwoong Byun <woong.byun@samsung.com>");
299 MODULE_LICENSE("GPL");