2 * max77686.c - mfd core driver for the Maxim 77686/802
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 const struct mfd_cell max77802_devs[] = {
47 { .name = "max77802-pmic", },
48 { .name = "max77802-clk", },
49 { .name = "max77802-rtc", },
52 static bool max77802_pmic_is_accessible_reg(struct device *dev,
55 return reg < MAX77802_REG_PMIC_END;
58 static bool max77802_rtc_is_accessible_reg(struct device *dev,
61 return (reg >= MAX77802_RTC_INT && reg < MAX77802_RTC_END);
64 static bool max77802_is_accessible_reg(struct device *dev, unsigned int reg)
66 return (max77802_pmic_is_accessible_reg(dev, reg) ||
67 max77802_rtc_is_accessible_reg(dev, reg));
70 static bool max77802_pmic_is_precious_reg(struct device *dev, unsigned int reg)
72 return (reg == MAX77802_REG_INTSRC || reg == MAX77802_REG_INT1 ||
73 reg == MAX77802_REG_INT2);
76 static bool max77802_rtc_is_precious_reg(struct device *dev, unsigned int reg)
78 return (reg == MAX77802_RTC_INT ||
79 reg == MAX77802_RTC_UPDATE0 ||
80 reg == MAX77802_RTC_UPDATE1);
83 static bool max77802_is_precious_reg(struct device *dev, unsigned int reg)
85 return (max77802_pmic_is_precious_reg(dev, reg) ||
86 max77802_rtc_is_precious_reg(dev, reg));
89 static bool max77802_pmic_is_volatile_reg(struct device *dev, unsigned int reg)
91 return (max77802_is_precious_reg(dev, reg) ||
92 reg == MAX77802_REG_STATUS1 || reg == MAX77802_REG_STATUS2 ||
93 reg == MAX77802_REG_PWRON);
96 static bool max77802_rtc_is_volatile_reg(struct device *dev, unsigned int reg)
98 return (max77802_rtc_is_precious_reg(dev, reg) ||
99 reg == MAX77802_RTC_SEC ||
100 reg == MAX77802_RTC_MIN ||
101 reg == MAX77802_RTC_HOUR ||
102 reg == MAX77802_RTC_WEEKDAY ||
103 reg == MAX77802_RTC_MONTH ||
104 reg == MAX77802_RTC_YEAR ||
105 reg == MAX77802_RTC_DATE);
108 static bool max77802_is_volatile_reg(struct device *dev, unsigned int reg)
110 return (max77802_pmic_is_volatile_reg(dev, reg) ||
111 max77802_rtc_is_volatile_reg(dev, reg));
114 static const struct regmap_config max77686_regmap_config = {
119 static const struct regmap_config max77686_rtc_regmap_config = {
124 static const struct regmap_config max77802_regmap_config = {
127 .writeable_reg = max77802_is_accessible_reg,
128 .readable_reg = max77802_is_accessible_reg,
129 .precious_reg = max77802_is_precious_reg,
130 .volatile_reg = max77802_is_volatile_reg,
131 .name = "max77802-pmic",
132 .cache_type = REGCACHE_RBTREE,
135 static const struct regmap_irq max77686_irqs[] = {
136 /* INT1 interrupts */
137 { .reg_offset = 0, .mask = MAX77686_INT1_PWRONF_MSK, },
138 { .reg_offset = 0, .mask = MAX77686_INT1_PWRONR_MSK, },
139 { .reg_offset = 0, .mask = MAX77686_INT1_JIGONBF_MSK, },
140 { .reg_offset = 0, .mask = MAX77686_INT1_JIGONBR_MSK, },
141 { .reg_offset = 0, .mask = MAX77686_INT1_ACOKBF_MSK, },
142 { .reg_offset = 0, .mask = MAX77686_INT1_ACOKBR_MSK, },
143 { .reg_offset = 0, .mask = MAX77686_INT1_ONKEY1S_MSK, },
144 { .reg_offset = 0, .mask = MAX77686_INT1_MRSTB_MSK, },
145 /* INT2 interrupts */
146 { .reg_offset = 1, .mask = MAX77686_INT2_140C_MSK, },
147 { .reg_offset = 1, .mask = MAX77686_INT2_120C_MSK, },
150 static const struct regmap_irq_chip max77686_irq_chip = {
151 .name = "max77686-pmic",
152 .status_base = MAX77686_REG_INT1,
153 .mask_base = MAX77686_REG_INT1MSK,
155 .irqs = max77686_irqs,
156 .num_irqs = ARRAY_SIZE(max77686_irqs),
159 static const struct regmap_irq max77686_rtc_irqs[] = {
161 { .reg_offset = 0, .mask = MAX77686_RTCINT_RTC60S_MSK, },
162 { .reg_offset = 0, .mask = MAX77686_RTCINT_RTCA1_MSK, },
163 { .reg_offset = 0, .mask = MAX77686_RTCINT_RTCA2_MSK, },
164 { .reg_offset = 0, .mask = MAX77686_RTCINT_SMPL_MSK, },
165 { .reg_offset = 0, .mask = MAX77686_RTCINT_RTC1S_MSK, },
166 { .reg_offset = 0, .mask = MAX77686_RTCINT_WTSR_MSK, },
169 static const struct regmap_irq_chip max77686_rtc_irq_chip = {
170 .name = "max77686-rtc",
171 .status_base = MAX77686_RTC_INT,
172 .mask_base = MAX77686_RTC_INTM,
174 .irqs = max77686_rtc_irqs,
175 .num_irqs = ARRAY_SIZE(max77686_rtc_irqs),
178 static const struct regmap_irq_chip max77802_irq_chip = {
179 .name = "max77802-pmic",
180 .status_base = MAX77802_REG_INT1,
181 .mask_base = MAX77802_REG_INT1MSK,
183 .irqs = max77686_irqs, /* same masks as 77686 */
184 .num_irqs = ARRAY_SIZE(max77686_irqs),
187 static const struct regmap_irq_chip max77802_rtc_irq_chip = {
188 .name = "max77802-rtc",
189 .status_base = MAX77802_RTC_INT,
190 .mask_base = MAX77802_RTC_INTM,
192 .irqs = max77686_rtc_irqs, /* same masks as 77686 */
193 .num_irqs = ARRAY_SIZE(max77686_rtc_irqs),
196 static const struct of_device_id max77686_pmic_dt_match[] = {
198 .compatible = "maxim,max77686",
199 .data = (void *)TYPE_MAX77686,
202 .compatible = "maxim,max77802",
203 .data = (void *)TYPE_MAX77802,
208 static int max77686_i2c_probe(struct i2c_client *i2c,
209 const struct i2c_device_id *id)
211 struct max77686_dev *max77686 = NULL;
212 const struct of_device_id *match;
215 const struct regmap_config *config;
216 const struct regmap_irq_chip *irq_chip;
217 const struct regmap_irq_chip *rtc_irq_chip;
218 struct regmap **rtc_regmap;
219 const struct mfd_cell *cells;
222 max77686 = devm_kzalloc(&i2c->dev,
223 sizeof(struct max77686_dev), GFP_KERNEL);
227 if (i2c->dev.of_node) {
228 match = of_match_node(max77686_pmic_dt_match, i2c->dev.of_node);
232 max77686->type = (unsigned long)match->data;
234 max77686->type = id->driver_data;
236 i2c_set_clientdata(i2c, max77686);
237 max77686->dev = &i2c->dev;
240 max77686->irq = i2c->irq;
242 if (max77686->type == TYPE_MAX77686) {
243 config = &max77686_regmap_config;
244 irq_chip = &max77686_irq_chip;
245 rtc_irq_chip = &max77686_rtc_irq_chip;
246 rtc_regmap = &max77686->rtc_regmap;
247 cells = max77686_devs;
248 n_devs = ARRAY_SIZE(max77686_devs);
250 config = &max77802_regmap_config;
251 irq_chip = &max77802_irq_chip;
252 rtc_irq_chip = &max77802_rtc_irq_chip;
253 rtc_regmap = &max77686->regmap;
254 cells = max77802_devs;
255 n_devs = ARRAY_SIZE(max77802_devs);
258 max77686->regmap = devm_regmap_init_i2c(i2c, config);
259 if (IS_ERR(max77686->regmap)) {
260 ret = PTR_ERR(max77686->regmap);
261 dev_err(max77686->dev, "Failed to allocate register map: %d\n",
266 ret = regmap_read(max77686->regmap, MAX77686_REG_DEVICE_ID, &data);
268 dev_err(max77686->dev,
269 "device not found on this channel (this is not an error)\n");
273 if (max77686->type == TYPE_MAX77686) {
274 max77686->rtc = i2c_new_dummy(i2c->adapter, I2C_ADDR_RTC);
275 if (!max77686->rtc) {
276 dev_err(max77686->dev,
277 "Failed to allocate I2C device for RTC\n");
280 i2c_set_clientdata(max77686->rtc, max77686);
282 max77686->rtc_regmap =
283 devm_regmap_init_i2c(max77686->rtc,
284 &max77686_rtc_regmap_config);
285 if (IS_ERR(max77686->rtc_regmap)) {
286 ret = PTR_ERR(max77686->rtc_regmap);
287 dev_err(max77686->dev,
288 "failed to allocate RTC regmap: %d\n",
290 goto err_unregister_i2c;
294 ret = regmap_add_irq_chip(max77686->regmap, max77686->irq,
295 IRQF_TRIGGER_FALLING | IRQF_ONESHOT |
296 IRQF_SHARED, 0, irq_chip,
297 &max77686->irq_data);
299 dev_err(&i2c->dev, "failed to add PMIC irq chip: %d\n", ret);
300 goto err_unregister_i2c;
303 ret = regmap_add_irq_chip(*rtc_regmap, max77686->irq,
304 IRQF_TRIGGER_FALLING | IRQF_ONESHOT |
305 IRQF_SHARED, 0, rtc_irq_chip,
306 &max77686->rtc_irq_data);
308 dev_err(&i2c->dev, "failed to add RTC irq chip: %d\n", ret);
312 ret = mfd_add_devices(max77686->dev, -1, cells, n_devs, NULL, 0, NULL);
314 dev_err(&i2c->dev, "failed to add MFD devices: %d\n", ret);
315 goto err_del_rtc_irqc;
321 regmap_del_irq_chip(max77686->irq, max77686->rtc_irq_data);
323 regmap_del_irq_chip(max77686->irq, max77686->irq_data);
325 if (max77686->type == TYPE_MAX77686)
326 i2c_unregister_device(max77686->rtc);
331 static int max77686_i2c_remove(struct i2c_client *i2c)
333 struct max77686_dev *max77686 = i2c_get_clientdata(i2c);
335 mfd_remove_devices(max77686->dev);
337 regmap_del_irq_chip(max77686->irq, max77686->rtc_irq_data);
338 regmap_del_irq_chip(max77686->irq, max77686->irq_data);
340 if (max77686->type == TYPE_MAX77686)
341 i2c_unregister_device(max77686->rtc);
346 static const struct i2c_device_id max77686_i2c_id[] = {
347 { "max77686", TYPE_MAX77686 },
350 MODULE_DEVICE_TABLE(i2c, max77686_i2c_id);
352 #ifdef CONFIG_PM_SLEEP
353 static int max77686_suspend(struct device *dev)
355 struct i2c_client *i2c = container_of(dev, struct i2c_client, dev);
356 struct max77686_dev *max77686 = i2c_get_clientdata(i2c);
358 if (device_may_wakeup(dev))
359 enable_irq_wake(max77686->irq);
362 * IRQ must be disabled during suspend because if it happens
363 * while suspended it will be handled before resuming I2C.
365 * When device is woken up from suspend (e.g. by RTC wake alarm),
366 * an interrupt occurs before resuming I2C bus controller.
367 * Interrupt handler tries to read registers but this read
368 * will fail because I2C is still suspended.
370 disable_irq(max77686->irq);
375 static int max77686_resume(struct device *dev)
377 struct i2c_client *i2c = container_of(dev, struct i2c_client, dev);
378 struct max77686_dev *max77686 = i2c_get_clientdata(i2c);
380 if (device_may_wakeup(dev))
381 disable_irq_wake(max77686->irq);
383 enable_irq(max77686->irq);
387 #endif /* CONFIG_PM_SLEEP */
389 static SIMPLE_DEV_PM_OPS(max77686_pm, max77686_suspend, max77686_resume);
391 static struct i2c_driver max77686_i2c_driver = {
395 .of_match_table = of_match_ptr(max77686_pmic_dt_match),
397 .probe = max77686_i2c_probe,
398 .remove = max77686_i2c_remove,
399 .id_table = max77686_i2c_id,
402 static int __init max77686_i2c_init(void)
404 return i2c_add_driver(&max77686_i2c_driver);
406 /* init early so consumer devices can complete system boot */
407 subsys_initcall(max77686_i2c_init);
409 static void __exit max77686_i2c_exit(void)
411 i2c_del_driver(&max77686_i2c_driver);
413 module_exit(max77686_i2c_exit);
415 MODULE_DESCRIPTION("MAXIM 77686/802 multi-function core driver");
416 MODULE_AUTHOR("Chiwoong Byun <woong.byun@samsung.com>");
417 MODULE_LICENSE("GPL");