]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blame - drivers/mfd/max77686.c
mfd: max77686: Add Maxim 77802 PMIC support
[mirror_ubuntu-bionic-kernel.git] / drivers / mfd / max77686.c
CommitLineData
dae8a969 1/*
a259f389 2 * max77686.c - mfd core driver for the Maxim 77686/802
dae8a969
JL
3 *
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>
6f1c1e71
JMC
28#include <linux/irq.h>
29#include <linux/interrupt.h>
dae8a969
JL
30#include <linux/pm_runtime.h>
31#include <linux/module.h>
dae8a969
JL
32#include <linux/mfd/core.h>
33#include <linux/mfd/max77686.h>
34#include <linux/mfd/max77686-private.h>
35#include <linux/err.h>
2a048d3b 36#include <linux/of.h>
dae8a969
JL
37
38#define I2C_ADDR_RTC (0x0C >> 1)
39
7c0517b1 40static const struct mfd_cell max77686_devs[] = {
dae8a969
JL
41 { .name = "max77686-pmic", },
42 { .name = "max77686-rtc", },
c0fa7e10 43 { .name = "max77686-clk", },
dae8a969
JL
44};
45
a259f389
JMC
46static 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{
55 return (reg >= MAX77802_REG_DEVICE_ID && reg < MAX77802_REG_PMIC_END);
56}
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
dae8a969
JL
114static struct regmap_config max77686_regmap_config = {
115 .reg_bits = 8,
116 .val_bits = 8,
117};
118
6f1c1e71
JMC
119static struct regmap_config max77686_rtc_regmap_config = {
120 .reg_bits = 8,
121 .val_bits = 8,
122};
123
a259f389
JMC
124static 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
6f1c1e71
JMC
135static 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
a259f389
JMC
178static 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
b68ece3d 196static const struct of_device_id max77686_pmic_dt_match[] = {
a259f389
JMC
197 {
198 .compatible = "maxim,max77686",
199 .data = (void *)TYPE_MAX77686,
200 },
201 {
202 .compatible = "maxim,max77802",
203 .data = (void *)TYPE_MAX77802,
204 },
205 { },
2984fc00
AL
206};
207
c1516f84
YSB
208static 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);
8a789b64 214 if (!pd)
c1516f84 215 return NULL;
c1516f84
YSB
216
217 dev->platform_data = pd;
218 return pd;
219}
c1516f84 220
dae8a969
JL
221static int max77686_i2c_probe(struct i2c_client *i2c,
222 const struct i2c_device_id *id)
223{
c1516f84 224 struct max77686_dev *max77686 = NULL;
334a41ce 225 struct max77686_platform_data *pdata = dev_get_platdata(&i2c->dev);
a259f389 226 const struct of_device_id *match;
dae8a969
JL
227 unsigned int data;
228 int ret = 0;
a259f389
JMC
229 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;
dae8a969 235
ede04c61 236 if (IS_ENABLED(CONFIG_OF) && i2c->dev.of_node && !pdata)
c1516f84
YSB
237 pdata = max77686_i2c_parse_dt_pdata(&i2c->dev);
238
239 if (!pdata) {
c1516f84 240 dev_err(&i2c->dev, "No platform data found.\n");
b452d7b6 241 return -EINVAL;
c1516f84
YSB
242 }
243
742413a4
LJ
244 max77686 = devm_kzalloc(&i2c->dev,
245 sizeof(struct max77686_dev), GFP_KERNEL);
c0e0fcda 246 if (!max77686)
dae8a969
JL
247 return -ENOMEM;
248
a259f389
JMC
249 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
254 max77686->type = (int)match->data;
255 } else {
256 max77686->type = id->driver_data;
257 }
258
dae8a969
JL
259 i2c_set_clientdata(i2c, max77686);
260 max77686->dev = &i2c->dev;
261 max77686->i2c = i2c;
dae8a969 262
dae8a969 263 max77686->wakeup = pdata->wakeup;
2b40459b 264 max77686->irq = i2c->irq;
dae8a969 265
a259f389
JMC
266 if (max77686->type == TYPE_MAX77686) {
267 config = &max77686_regmap_config;
268 irq_chip = &max77686_irq_chip;
269 rtc_irq_chip = &max77686_rtc_irq_chip;
270 rtc_regmap = &max77686->rtc_regmap;
271 cells = max77686_devs;
272 n_devs = ARRAY_SIZE(max77686_devs);
273 } else {
274 config = &max77802_regmap_config;
275 irq_chip = &max77802_irq_chip;
276 rtc_irq_chip = &max77802_rtc_irq_chip;
277 rtc_regmap = &max77686->regmap;
278 cells = max77802_devs;
279 n_devs = ARRAY_SIZE(max77802_devs);
280 }
281
282 max77686->regmap = devm_regmap_init_i2c(i2c, config);
136d982e
AL
283 if (IS_ERR(max77686->regmap)) {
284 ret = PTR_ERR(max77686->regmap);
285 dev_err(max77686->dev, "Failed to allocate register map: %d\n",
286 ret);
136d982e
AL
287 return ret;
288 }
289
c0e0fcda
JMC
290 ret = regmap_read(max77686->regmap, MAX77686_REG_DEVICE_ID, &data);
291 if (ret < 0) {
dae8a969
JL
292 dev_err(max77686->dev,
293 "device not found on this channel (this is not an error)\n");
742413a4 294 return -ENODEV;
6f1c1e71 295 }
dae8a969 296
a259f389
JMC
297 if (max77686->type == TYPE_MAX77686) {
298 max77686->rtc = i2c_new_dummy(i2c->adapter, I2C_ADDR_RTC);
299 if (!max77686->rtc) {
300 dev_err(max77686->dev,
301 "Failed to allocate I2C device for RTC\n");
302 return -ENODEV;
303 }
304 i2c_set_clientdata(max77686->rtc, max77686);
305
306 max77686->rtc_regmap =
307 devm_regmap_init_i2c(max77686->rtc,
308 &max77686_rtc_regmap_config);
309 if (IS_ERR(max77686->rtc_regmap)) {
310 ret = PTR_ERR(max77686->rtc_regmap);
311 dev_err(max77686->dev,
312 "failed to allocate RTC regmap: %d\n",
313 ret);
314 goto err_unregister_i2c;
315 }
6f1c1e71
JMC
316 }
317
318 ret = regmap_add_irq_chip(max77686->regmap, max77686->irq,
319 IRQF_TRIGGER_FALLING | IRQF_ONESHOT |
a259f389 320 IRQF_SHARED, 0, irq_chip,
6f1c1e71 321 &max77686->irq_data);
c0e0fcda 322 if (ret) {
6f1c1e71
JMC
323 dev_err(&i2c->dev, "failed to add PMIC irq chip: %d\n", ret);
324 goto err_unregister_i2c;
325 }
a259f389
JMC
326
327 ret = regmap_add_irq_chip(*rtc_regmap, max77686->irq,
6f1c1e71 328 IRQF_TRIGGER_FALLING | IRQF_ONESHOT |
a259f389 329 IRQF_SHARED, 0, rtc_irq_chip,
6f1c1e71 330 &max77686->rtc_irq_data);
c0e0fcda 331 if (ret) {
6f1c1e71
JMC
332 dev_err(&i2c->dev, "failed to add RTC irq chip: %d\n", ret);
333 goto err_del_irqc;
334 }
dae8a969 335
a259f389 336 ret = mfd_add_devices(max77686->dev, -1, cells, n_devs, NULL, 0, NULL);
742413a4 337 if (ret < 0) {
6f1c1e71
JMC
338 dev_err(&i2c->dev, "failed to add MFD devices: %d\n", ret);
339 goto err_del_rtc_irqc;
742413a4 340 }
dae8a969 341
6f1c1e71
JMC
342 return 0;
343
344err_del_rtc_irqc:
345 regmap_del_irq_chip(max77686->irq, max77686->rtc_irq_data);
346err_del_irqc:
347 regmap_del_irq_chip(max77686->irq, max77686->irq_data);
348err_unregister_i2c:
a259f389
JMC
349 if (max77686->type == TYPE_MAX77686)
350 i2c_unregister_device(max77686->rtc);
6f1c1e71 351
dae8a969
JL
352 return ret;
353}
354
355static int max77686_i2c_remove(struct i2c_client *i2c)
356{
357 struct max77686_dev *max77686 = i2c_get_clientdata(i2c);
358
359 mfd_remove_devices(max77686->dev);
6f1c1e71
JMC
360
361 regmap_del_irq_chip(max77686->irq, max77686->rtc_irq_data);
362 regmap_del_irq_chip(max77686->irq, max77686->irq_data);
363
a259f389
JMC
364 if (max77686->type == TYPE_MAX77686)
365 i2c_unregister_device(max77686->rtc);
dae8a969
JL
366
367 return 0;
368}
369
370static const struct i2c_device_id max77686_i2c_id[] = {
371 { "max77686", TYPE_MAX77686 },
372 { }
373};
374MODULE_DEVICE_TABLE(i2c, max77686_i2c_id);
375
2b52b5d5
JMC
376#ifdef CONFIG_PM_SLEEP
377static int max77686_suspend(struct device *dev)
378{
379 struct i2c_client *i2c = container_of(dev, struct i2c_client, dev);
380 struct max77686_dev *max77686 = i2c_get_clientdata(i2c);
381
382 if (device_may_wakeup(dev))
383 enable_irq_wake(max77686->irq);
384
385 /*
386 * IRQ must be disabled during suspend because if it happens
387 * while suspended it will be handled before resuming I2C.
388 *
389 * When device is woken up from suspend (e.g. by RTC wake alarm),
390 * an interrupt occurs before resuming I2C bus controller.
391 * Interrupt handler tries to read registers but this read
392 * will fail because I2C is still suspended.
393 */
394 disable_irq(max77686->irq);
395
396 return 0;
397}
398
399static int max77686_resume(struct device *dev)
400{
401 struct i2c_client *i2c = container_of(dev, struct i2c_client, dev);
402 struct max77686_dev *max77686 = i2c_get_clientdata(i2c);
403
404 if (device_may_wakeup(dev))
405 disable_irq_wake(max77686->irq);
406
407 enable_irq(max77686->irq);
408
409 return 0;
410}
411#endif /* CONFIG_PM_SLEEP */
412
413static SIMPLE_DEV_PM_OPS(max77686_pm, max77686_suspend, max77686_resume);
414
dae8a969
JL
415static struct i2c_driver max77686_i2c_driver = {
416 .driver = {
417 .name = "max77686",
418 .owner = THIS_MODULE,
2b52b5d5 419 .pm = &max77686_pm,
c1516f84 420 .of_match_table = of_match_ptr(max77686_pmic_dt_match),
dae8a969
JL
421 },
422 .probe = max77686_i2c_probe,
423 .remove = max77686_i2c_remove,
424 .id_table = max77686_i2c_id,
425};
426
427static int __init max77686_i2c_init(void)
428{
429 return i2c_add_driver(&max77686_i2c_driver);
430}
431/* init early so consumer devices can complete system boot */
432subsys_initcall(max77686_i2c_init);
433
434static void __exit max77686_i2c_exit(void)
435{
436 i2c_del_driver(&max77686_i2c_driver);
437}
438module_exit(max77686_i2c_exit);
439
a259f389 440MODULE_DESCRIPTION("MAXIM 77686/802 multi-function core driver");
dae8a969
JL
441MODULE_AUTHOR("Chiwoong Byun <woong.byun@samsung.com>");
442MODULE_LICENSE("GPL");