blob: 929795eae9fcbf2df33f18b81606980b56f8d7ff [file] [log] [blame]
Jonghwa Leedae8a962012-06-25 10:34:36 +02001/*
Javier Martinez Canillasa259f382014-07-24 14:39:24 +02002 * max77686.c - mfd core driver for the Maxim 77686/802
Jonghwa Leedae8a962012-06-25 10:34:36 +02003 *
4 * Copyright (C) 2012 Samsung Electronics
5 * Chiwoong Byun <woong.byun@smasung.com>
6 * Jonghwa Lee <jonghwa3.lee@samsung.com>
7 *
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.
12 *
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.
17 *
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
21 *
22 * This driver is based on max8997.c
23 */
24
25#include <linux/export.h>
26#include <linux/slab.h>
27#include <linux/i2c.h>
Javier Martinez Canillas6f1c1e72014-07-04 22:24:04 +020028#include <linux/irq.h>
29#include <linux/interrupt.h>
Jonghwa Leedae8a962012-06-25 10:34:36 +020030#include <linux/pm_runtime.h>
31#include <linux/module.h>
Jonghwa Leedae8a962012-06-25 10:34:36 +020032#include <linux/mfd/core.h>
33#include <linux/mfd/max77686.h>
34#include <linux/mfd/max77686-private.h>
35#include <linux/err.h>
Sachin Kamat2a048d32013-10-16 14:26:49 +053036#include <linux/of.h>
Jonghwa Leedae8a962012-06-25 10:34:36 +020037
38#define I2C_ADDR_RTC (0x0C >> 1)
39
Geert Uytterhoeven7c0517b2013-11-18 14:33:00 +010040static const struct mfd_cell max77686_devs[] = {
Jonghwa Leedae8a962012-06-25 10:34:36 +020041 { .name = "max77686-pmic", },
42 { .name = "max77686-rtc", },
Olof Johanssonc0fa7e12013-05-10 10:11:59 -070043 { .name = "max77686-clk", },
Jonghwa Leedae8a962012-06-25 10:34:36 +020044};
45
Javier Martinez Canillasa259f382014-07-24 14:39:24 +020046static const struct mfd_cell max77802_devs[] = {
47 { .name = "max77802-pmic", },
48 { .name = "max77802-clk", },
49 { .name = "max77802-rtc", },
50};
51
52static bool max77802_pmic_is_accessible_reg(struct device *dev,
53 unsigned int reg)
54{
Lee Jonesb87d9a02014-08-18 15:41:59 +010055 return reg < MAX77802_REG_PMIC_END;
Javier Martinez Canillasa259f382014-07-24 14:39:24 +020056}
57
58static bool max77802_rtc_is_accessible_reg(struct device *dev,
59 unsigned int reg)
60{
61 return (reg >= MAX77802_RTC_INT && reg < MAX77802_RTC_END);
62}
63
64static bool max77802_is_accessible_reg(struct device *dev, unsigned int reg)
65{
66 return (max77802_pmic_is_accessible_reg(dev, reg) ||
67 max77802_rtc_is_accessible_reg(dev, reg));
68}
69
70static bool max77802_pmic_is_precious_reg(struct device *dev, unsigned int reg)
71{
72 return (reg == MAX77802_REG_INTSRC || reg == MAX77802_REG_INT1 ||
73 reg == MAX77802_REG_INT2);
74}
75
76static bool max77802_rtc_is_precious_reg(struct device *dev, unsigned int reg)
77{
78 return (reg == MAX77802_RTC_INT ||
79 reg == MAX77802_RTC_UPDATE0 ||
80 reg == MAX77802_RTC_UPDATE1);
81}
82
83static bool max77802_is_precious_reg(struct device *dev, unsigned int reg)
84{
85 return (max77802_pmic_is_precious_reg(dev, reg) ||
86 max77802_rtc_is_precious_reg(dev, reg));
87}
88
89static bool max77802_pmic_is_volatile_reg(struct device *dev, unsigned int reg)
90{
91 return (max77802_is_precious_reg(dev, reg) ||
92 reg == MAX77802_REG_STATUS1 || reg == MAX77802_REG_STATUS2 ||
93 reg == MAX77802_REG_PWRON);
94}
95
96static bool max77802_rtc_is_volatile_reg(struct device *dev, unsigned int reg)
97{
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);
106}
107
108static bool max77802_is_volatile_reg(struct device *dev, unsigned int reg)
109{
110 return (max77802_pmic_is_volatile_reg(dev, reg) ||
111 max77802_rtc_is_volatile_reg(dev, reg));
112}
113
Jonghwa Leedae8a962012-06-25 10:34:36 +0200114static struct regmap_config max77686_regmap_config = {
115 .reg_bits = 8,
116 .val_bits = 8,
117};
118
Javier Martinez Canillas6f1c1e72014-07-04 22:24:04 +0200119static struct regmap_config max77686_rtc_regmap_config = {
120 .reg_bits = 8,
121 .val_bits = 8,
122};
123
Javier Martinez Canillasa259f382014-07-24 14:39:24 +0200124static struct regmap_config max77802_regmap_config = {
125 .reg_bits = 8,
126 .val_bits = 8,
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,
133};
134
Javier Martinez Canillas6f1c1e72014-07-04 22:24:04 +0200135static 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, },
148};
149
150static const struct regmap_irq_chip max77686_irq_chip = {
151 .name = "max77686-pmic",
152 .status_base = MAX77686_REG_INT1,
153 .mask_base = MAX77686_REG_INT1MSK,
154 .num_regs = 2,
155 .irqs = max77686_irqs,
156 .num_irqs = ARRAY_SIZE(max77686_irqs),
157};
158
159static const struct regmap_irq max77686_rtc_irqs[] = {
160 /* RTC interrupts */
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, },
167};
168
169static 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,
173 .num_regs = 1,
174 .irqs = max77686_rtc_irqs,
175 .num_irqs = ARRAY_SIZE(max77686_rtc_irqs),
176};
177
Javier Martinez Canillasa259f382014-07-24 14:39:24 +0200178static const struct regmap_irq_chip max77802_irq_chip = {
179 .name = "max77802-pmic",
180 .status_base = MAX77802_REG_INT1,
181 .mask_base = MAX77802_REG_INT1MSK,
182 .num_regs = 2,
183 .irqs = max77686_irqs, /* same masks as 77686 */
184 .num_irqs = ARRAY_SIZE(max77686_irqs),
185};
186
187static 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,
191 .num_regs = 1,
192 .irqs = max77686_rtc_irqs, /* same masks as 77686 */
193 .num_irqs = ARRAY_SIZE(max77686_rtc_irqs),
194};
195
Krzysztof Kozlowskib68ece32014-05-13 12:58:51 +0200196static const struct of_device_id max77686_pmic_dt_match[] = {
Javier Martinez Canillasa259f382014-07-24 14:39:24 +0200197 {
198 .compatible = "maxim,max77686",
199 .data = (void *)TYPE_MAX77686,
200 },
201 {
202 .compatible = "maxim,max77802",
203 .data = (void *)TYPE_MAX77802,
204 },
205 { },
Axel Lin2984fc02012-07-09 22:29:00 +0800206};
207
Yadwinder Singh Brarc1516f82012-07-06 17:02:55 +0530208static struct max77686_platform_data *max77686_i2c_parse_dt_pdata(struct device
209 *dev)
210{
211 struct max77686_platform_data *pd;
212
213 pd = devm_kzalloc(dev, sizeof(*pd), GFP_KERNEL);
Javier Martinez Canillas8a789b62014-07-04 22:24:10 +0200214 if (!pd)
Yadwinder Singh Brarc1516f82012-07-06 17:02:55 +0530215 return NULL;
Yadwinder Singh Brarc1516f82012-07-06 17:02:55 +0530216
217 dev->platform_data = pd;
218 return pd;
219}
Yadwinder Singh Brarc1516f82012-07-06 17:02:55 +0530220
Jonghwa Leedae8a962012-06-25 10:34:36 +0200221static int max77686_i2c_probe(struct i2c_client *i2c,
222 const struct i2c_device_id *id)
223{
Yadwinder Singh Brarc1516f82012-07-06 17:02:55 +0530224 struct max77686_dev *max77686 = NULL;
Jingoo Han334a41c2013-07-30 17:10:05 +0900225 struct max77686_platform_data *pdata = dev_get_platdata(&i2c->dev);
Javier Martinez Canillasa259f382014-07-24 14:39:24 +0200226 const struct of_device_id *match;
Jonghwa Leedae8a962012-06-25 10:34:36 +0200227 unsigned int data;
228 int ret = 0;
Javier Martinez Canillasa259f382014-07-24 14:39:24 +0200229 const struct regmap_config *config;
230 const struct regmap_irq_chip *irq_chip;
231 const struct regmap_irq_chip *rtc_irq_chip;
232 struct regmap **rtc_regmap;
233 const struct mfd_cell *cells;
234 int n_devs;
Jonghwa Leedae8a962012-06-25 10:34:36 +0200235
Javier Martinez Canillasede04c62014-07-04 22:24:07 +0200236 if (IS_ENABLED(CONFIG_OF) && i2c->dev.of_node && !pdata)
Yadwinder Singh Brarc1516f82012-07-06 17:02:55 +0530237 pdata = max77686_i2c_parse_dt_pdata(&i2c->dev);
238
239 if (!pdata) {
Yadwinder Singh Brarc1516f82012-07-06 17:02:55 +0530240 dev_err(&i2c->dev, "No platform data found.\n");
Javier Martinez Canillasb452d7b2014-07-04 22:24:08 +0200241 return -EINVAL;
Yadwinder Singh Brarc1516f82012-07-06 17:02:55 +0530242 }
243
Lee Jones742413a2013-05-23 16:25:16 +0100244 max77686 = devm_kzalloc(&i2c->dev,
245 sizeof(struct max77686_dev), GFP_KERNEL);
Javier Martinez Canillasc0e0fcd2014-07-04 22:24:09 +0200246 if (!max77686)
Jonghwa Leedae8a962012-06-25 10:34:36 +0200247 return -ENOMEM;
248
Javier Martinez Canillasa259f382014-07-24 14:39:24 +0200249 if (i2c->dev.of_node) {
250 match = of_match_node(max77686_pmic_dt_match, i2c->dev.of_node);
251 if (!match)
252 return -EINVAL;
253
Lee Jonesec8bd562014-07-24 17:07:16 +0100254 max77686->type = (unsigned long)match->data;
255 } else
Javier Martinez Canillasa259f382014-07-24 14:39:24 +0200256 max77686->type = id->driver_data;
Javier Martinez Canillasa259f382014-07-24 14:39:24 +0200257
Jonghwa Leedae8a962012-06-25 10:34:36 +0200258 i2c_set_clientdata(i2c, max77686);
259 max77686->dev = &i2c->dev;
260 max77686->i2c = i2c;
Jonghwa Leedae8a962012-06-25 10:34:36 +0200261
Jonghwa Leedae8a962012-06-25 10:34:36 +0200262 max77686->wakeup = pdata->wakeup;
Yadwinder Singh Brar2b404592012-07-09 13:21:45 +0200263 max77686->irq = i2c->irq;
Jonghwa Leedae8a962012-06-25 10:34:36 +0200264
Javier Martinez Canillasa259f382014-07-24 14:39:24 +0200265 if (max77686->type == TYPE_MAX77686) {
266 config = &max77686_regmap_config;
267 irq_chip = &max77686_irq_chip;
268 rtc_irq_chip = &max77686_rtc_irq_chip;
269 rtc_regmap = &max77686->rtc_regmap;
270 cells = max77686_devs;
271 n_devs = ARRAY_SIZE(max77686_devs);
272 } else {
273 config = &max77802_regmap_config;
274 irq_chip = &max77802_irq_chip;
275 rtc_irq_chip = &max77802_rtc_irq_chip;
276 rtc_regmap = &max77686->regmap;
277 cells = max77802_devs;
278 n_devs = ARRAY_SIZE(max77802_devs);
279 }
280
281 max77686->regmap = devm_regmap_init_i2c(i2c, config);
Axel Lin136d9822012-12-25 00:16:43 +0800282 if (IS_ERR(max77686->regmap)) {
283 ret = PTR_ERR(max77686->regmap);
284 dev_err(max77686->dev, "Failed to allocate register map: %d\n",
285 ret);
Axel Lin136d9822012-12-25 00:16:43 +0800286 return ret;
287 }
288
Javier Martinez Canillasc0e0fcd2014-07-04 22:24:09 +0200289 ret = regmap_read(max77686->regmap, MAX77686_REG_DEVICE_ID, &data);
290 if (ret < 0) {
Jonghwa Leedae8a962012-06-25 10:34:36 +0200291 dev_err(max77686->dev,
292 "device not found on this channel (this is not an error)\n");
Lee Jones742413a2013-05-23 16:25:16 +0100293 return -ENODEV;
Javier Martinez Canillas6f1c1e72014-07-04 22:24:04 +0200294 }
Jonghwa Leedae8a962012-06-25 10:34:36 +0200295
Javier Martinez Canillasa259f382014-07-24 14:39:24 +0200296 if (max77686->type == TYPE_MAX77686) {
297 max77686->rtc = i2c_new_dummy(i2c->adapter, I2C_ADDR_RTC);
298 if (!max77686->rtc) {
299 dev_err(max77686->dev,
300 "Failed to allocate I2C device for RTC\n");
301 return -ENODEV;
302 }
303 i2c_set_clientdata(max77686->rtc, max77686);
Jonghwa Leedae8a962012-06-25 10:34:36 +0200304
Javier Martinez Canillasa259f382014-07-24 14:39:24 +0200305 max77686->rtc_regmap =
306 devm_regmap_init_i2c(max77686->rtc,
307 &max77686_rtc_regmap_config);
308 if (IS_ERR(max77686->rtc_regmap)) {
309 ret = PTR_ERR(max77686->rtc_regmap);
310 dev_err(max77686->dev,
311 "failed to allocate RTC regmap: %d\n",
312 ret);
313 goto err_unregister_i2c;
314 }
Javier Martinez Canillas6f1c1e72014-07-04 22:24:04 +0200315 }
316
317 ret = regmap_add_irq_chip(max77686->regmap, max77686->irq,
318 IRQF_TRIGGER_FALLING | IRQF_ONESHOT |
Javier Martinez Canillasa259f382014-07-24 14:39:24 +0200319 IRQF_SHARED, 0, irq_chip,
Javier Martinez Canillas6f1c1e72014-07-04 22:24:04 +0200320 &max77686->irq_data);
Javier Martinez Canillasc0e0fcd2014-07-04 22:24:09 +0200321 if (ret) {
Javier Martinez Canillas6f1c1e72014-07-04 22:24:04 +0200322 dev_err(&i2c->dev, "failed to add PMIC irq chip: %d\n", ret);
323 goto err_unregister_i2c;
324 }
Javier Martinez Canillasa259f382014-07-24 14:39:24 +0200325
326 ret = regmap_add_irq_chip(*rtc_regmap, max77686->irq,
Javier Martinez Canillas6f1c1e72014-07-04 22:24:04 +0200327 IRQF_TRIGGER_FALLING | IRQF_ONESHOT |
Javier Martinez Canillasa259f382014-07-24 14:39:24 +0200328 IRQF_SHARED, 0, rtc_irq_chip,
Javier Martinez Canillas6f1c1e72014-07-04 22:24:04 +0200329 &max77686->rtc_irq_data);
Javier Martinez Canillasc0e0fcd2014-07-04 22:24:09 +0200330 if (ret) {
Javier Martinez Canillas6f1c1e72014-07-04 22:24:04 +0200331 dev_err(&i2c->dev, "failed to add RTC irq chip: %d\n", ret);
332 goto err_del_irqc;
333 }
Jonghwa Leedae8a962012-06-25 10:34:36 +0200334
Javier Martinez Canillasa259f382014-07-24 14:39:24 +0200335 ret = mfd_add_devices(max77686->dev, -1, cells, n_devs, NULL, 0, NULL);
Lee Jones742413a2013-05-23 16:25:16 +0100336 if (ret < 0) {
Javier Martinez Canillas6f1c1e72014-07-04 22:24:04 +0200337 dev_err(&i2c->dev, "failed to add MFD devices: %d\n", ret);
338 goto err_del_rtc_irqc;
Lee Jones742413a2013-05-23 16:25:16 +0100339 }
Jonghwa Leedae8a962012-06-25 10:34:36 +0200340
Javier Martinez Canillas6f1c1e72014-07-04 22:24:04 +0200341 return 0;
342
343err_del_rtc_irqc:
344 regmap_del_irq_chip(max77686->irq, max77686->rtc_irq_data);
345err_del_irqc:
346 regmap_del_irq_chip(max77686->irq, max77686->irq_data);
347err_unregister_i2c:
Javier Martinez Canillasa259f382014-07-24 14:39:24 +0200348 if (max77686->type == TYPE_MAX77686)
349 i2c_unregister_device(max77686->rtc);
Javier Martinez Canillas6f1c1e72014-07-04 22:24:04 +0200350
Jonghwa Leedae8a962012-06-25 10:34:36 +0200351 return ret;
352}
353
354static int max77686_i2c_remove(struct i2c_client *i2c)
355{
356 struct max77686_dev *max77686 = i2c_get_clientdata(i2c);
357
358 mfd_remove_devices(max77686->dev);
Javier Martinez Canillas6f1c1e72014-07-04 22:24:04 +0200359
360 regmap_del_irq_chip(max77686->irq, max77686->rtc_irq_data);
361 regmap_del_irq_chip(max77686->irq, max77686->irq_data);
362
Javier Martinez Canillasa259f382014-07-24 14:39:24 +0200363 if (max77686->type == TYPE_MAX77686)
364 i2c_unregister_device(max77686->rtc);
Jonghwa Leedae8a962012-06-25 10:34:36 +0200365
366 return 0;
367}
368
369static const struct i2c_device_id max77686_i2c_id[] = {
370 { "max77686", TYPE_MAX77686 },
371 { }
372};
373MODULE_DEVICE_TABLE(i2c, max77686_i2c_id);
374
Javier Martinez Canillas2b52b5d2014-07-04 22:24:05 +0200375#ifdef CONFIG_PM_SLEEP
376static int max77686_suspend(struct device *dev)
377{
378 struct i2c_client *i2c = container_of(dev, struct i2c_client, dev);
379 struct max77686_dev *max77686 = i2c_get_clientdata(i2c);
380
381 if (device_may_wakeup(dev))
382 enable_irq_wake(max77686->irq);
383
384 /*
385 * IRQ must be disabled during suspend because if it happens
386 * while suspended it will be handled before resuming I2C.
387 *
388 * When device is woken up from suspend (e.g. by RTC wake alarm),
389 * an interrupt occurs before resuming I2C bus controller.
390 * Interrupt handler tries to read registers but this read
391 * will fail because I2C is still suspended.
392 */
393 disable_irq(max77686->irq);
394
395 return 0;
396}
397
398static int max77686_resume(struct device *dev)
399{
400 struct i2c_client *i2c = container_of(dev, struct i2c_client, dev);
401 struct max77686_dev *max77686 = i2c_get_clientdata(i2c);
402
403 if (device_may_wakeup(dev))
404 disable_irq_wake(max77686->irq);
405
406 enable_irq(max77686->irq);
407
408 return 0;
409}
410#endif /* CONFIG_PM_SLEEP */
411
412static SIMPLE_DEV_PM_OPS(max77686_pm, max77686_suspend, max77686_resume);
413
Jonghwa Leedae8a962012-06-25 10:34:36 +0200414static struct i2c_driver max77686_i2c_driver = {
415 .driver = {
416 .name = "max77686",
417 .owner = THIS_MODULE,
Javier Martinez Canillas2b52b5d2014-07-04 22:24:05 +0200418 .pm = &max77686_pm,
Yadwinder Singh Brarc1516f82012-07-06 17:02:55 +0530419 .of_match_table = of_match_ptr(max77686_pmic_dt_match),
Jonghwa Leedae8a962012-06-25 10:34:36 +0200420 },
421 .probe = max77686_i2c_probe,
422 .remove = max77686_i2c_remove,
423 .id_table = max77686_i2c_id,
424};
425
426static int __init max77686_i2c_init(void)
427{
428 return i2c_add_driver(&max77686_i2c_driver);
429}
430/* init early so consumer devices can complete system boot */
431subsys_initcall(max77686_i2c_init);
432
433static void __exit max77686_i2c_exit(void)
434{
435 i2c_del_driver(&max77686_i2c_driver);
436}
437module_exit(max77686_i2c_exit);
438
Javier Martinez Canillasa259f382014-07-24 14:39:24 +0200439MODULE_DESCRIPTION("MAXIM 77686/802 multi-function core driver");
Jonghwa Leedae8a962012-06-25 10:34:36 +0200440MODULE_AUTHOR("Chiwoong Byun <woong.byun@samsung.com>");
441MODULE_LICENSE("GPL");