blob: b0e8e13c00493394d9505c3ef4c1fb24caa111bd [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
Krzysztof Kozlowski630fd982016-04-05 11:04:51 +09005 * Chiwoong Byun <woong.byun@samsung.com>
Jonghwa Leedae8a962012-06-25 10:34:36 +02006 * 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>
Javier Martinez Canillas68e61f72017-01-13 10:34:06 -030037#include <linux/of_device.h>
Jonghwa Leedae8a962012-06-25 10:34:36 +020038
Geert Uytterhoeven7c0517b2013-11-18 14:33:00 +010039static const struct mfd_cell max77686_devs[] = {
Jonghwa Leedae8a962012-06-25 10:34:36 +020040 { .name = "max77686-pmic", },
41 { .name = "max77686-rtc", },
Olof Johanssonc0fa7e12013-05-10 10:11:59 -070042 { .name = "max77686-clk", },
Jonghwa Leedae8a962012-06-25 10:34:36 +020043};
44
Javier Martinez Canillasa259f382014-07-24 14:39:24 +020045static const struct mfd_cell max77802_devs[] = {
46 { .name = "max77802-pmic", },
47 { .name = "max77802-clk", },
48 { .name = "max77802-rtc", },
49};
50
51static bool max77802_pmic_is_accessible_reg(struct device *dev,
52 unsigned int reg)
53{
Lee Jonesb87d9a02014-08-18 15:41:59 +010054 return reg < MAX77802_REG_PMIC_END;
Javier Martinez Canillasa259f382014-07-24 14:39:24 +020055}
56
57static bool max77802_rtc_is_accessible_reg(struct device *dev,
58 unsigned int reg)
59{
60 return (reg >= MAX77802_RTC_INT && reg < MAX77802_RTC_END);
61}
62
63static bool max77802_is_accessible_reg(struct device *dev, unsigned int reg)
64{
65 return (max77802_pmic_is_accessible_reg(dev, reg) ||
66 max77802_rtc_is_accessible_reg(dev, reg));
67}
68
69static bool max77802_pmic_is_precious_reg(struct device *dev, unsigned int reg)
70{
71 return (reg == MAX77802_REG_INTSRC || reg == MAX77802_REG_INT1 ||
72 reg == MAX77802_REG_INT2);
73}
74
75static bool max77802_rtc_is_precious_reg(struct device *dev, unsigned int reg)
76{
77 return (reg == MAX77802_RTC_INT ||
78 reg == MAX77802_RTC_UPDATE0 ||
79 reg == MAX77802_RTC_UPDATE1);
80}
81
82static bool max77802_is_precious_reg(struct device *dev, unsigned int reg)
83{
84 return (max77802_pmic_is_precious_reg(dev, reg) ||
85 max77802_rtc_is_precious_reg(dev, reg));
86}
87
88static bool max77802_pmic_is_volatile_reg(struct device *dev, unsigned int reg)
89{
90 return (max77802_is_precious_reg(dev, reg) ||
91 reg == MAX77802_REG_STATUS1 || reg == MAX77802_REG_STATUS2 ||
92 reg == MAX77802_REG_PWRON);
93}
94
95static bool max77802_rtc_is_volatile_reg(struct device *dev, unsigned int reg)
96{
97 return (max77802_rtc_is_precious_reg(dev, reg) ||
98 reg == MAX77802_RTC_SEC ||
99 reg == MAX77802_RTC_MIN ||
100 reg == MAX77802_RTC_HOUR ||
101 reg == MAX77802_RTC_WEEKDAY ||
102 reg == MAX77802_RTC_MONTH ||
103 reg == MAX77802_RTC_YEAR ||
104 reg == MAX77802_RTC_DATE);
105}
106
107static bool max77802_is_volatile_reg(struct device *dev, unsigned int reg)
108{
109 return (max77802_pmic_is_volatile_reg(dev, reg) ||
110 max77802_rtc_is_volatile_reg(dev, reg));
111}
112
Krzysztof Kozlowski68be2312015-01-05 10:01:25 +0100113static const struct regmap_config max77686_regmap_config = {
Jonghwa Leedae8a962012-06-25 10:34:36 +0200114 .reg_bits = 8,
115 .val_bits = 8,
116};
117
Krzysztof Kozlowski68be2312015-01-05 10:01:25 +0100118static const struct regmap_config max77802_regmap_config = {
Javier Martinez Canillasa259f382014-07-24 14:39:24 +0200119 .reg_bits = 8,
120 .val_bits = 8,
121 .writeable_reg = max77802_is_accessible_reg,
122 .readable_reg = max77802_is_accessible_reg,
123 .precious_reg = max77802_is_precious_reg,
124 .volatile_reg = max77802_is_volatile_reg,
125 .name = "max77802-pmic",
126 .cache_type = REGCACHE_RBTREE,
127};
128
Javier Martinez Canillas6f1c1e72014-07-04 22:24:04 +0200129static const struct regmap_irq max77686_irqs[] = {
130 /* INT1 interrupts */
131 { .reg_offset = 0, .mask = MAX77686_INT1_PWRONF_MSK, },
132 { .reg_offset = 0, .mask = MAX77686_INT1_PWRONR_MSK, },
133 { .reg_offset = 0, .mask = MAX77686_INT1_JIGONBF_MSK, },
134 { .reg_offset = 0, .mask = MAX77686_INT1_JIGONBR_MSK, },
135 { .reg_offset = 0, .mask = MAX77686_INT1_ACOKBF_MSK, },
136 { .reg_offset = 0, .mask = MAX77686_INT1_ACOKBR_MSK, },
137 { .reg_offset = 0, .mask = MAX77686_INT1_ONKEY1S_MSK, },
138 { .reg_offset = 0, .mask = MAX77686_INT1_MRSTB_MSK, },
139 /* INT2 interrupts */
140 { .reg_offset = 1, .mask = MAX77686_INT2_140C_MSK, },
141 { .reg_offset = 1, .mask = MAX77686_INT2_120C_MSK, },
142};
143
144static const struct regmap_irq_chip max77686_irq_chip = {
145 .name = "max77686-pmic",
146 .status_base = MAX77686_REG_INT1,
147 .mask_base = MAX77686_REG_INT1MSK,
148 .num_regs = 2,
149 .irqs = max77686_irqs,
150 .num_irqs = ARRAY_SIZE(max77686_irqs),
151};
152
Javier Martinez Canillasa259f382014-07-24 14:39:24 +0200153static const struct regmap_irq_chip max77802_irq_chip = {
154 .name = "max77802-pmic",
155 .status_base = MAX77802_REG_INT1,
156 .mask_base = MAX77802_REG_INT1MSK,
157 .num_regs = 2,
158 .irqs = max77686_irqs, /* same masks as 77686 */
159 .num_irqs = ARRAY_SIZE(max77686_irqs),
160};
161
Krzysztof Kozlowskib68ece32014-05-13 12:58:51 +0200162static const struct of_device_id max77686_pmic_dt_match[] = {
Javier Martinez Canillasa259f382014-07-24 14:39:24 +0200163 {
164 .compatible = "maxim,max77686",
165 .data = (void *)TYPE_MAX77686,
166 },
167 {
168 .compatible = "maxim,max77802",
169 .data = (void *)TYPE_MAX77802,
170 },
171 { },
Axel Lin2984fc02012-07-09 22:29:00 +0800172};
Javier Martinez Canillas7f8ada12016-02-12 01:30:19 -0300173MODULE_DEVICE_TABLE(of, max77686_pmic_dt_match);
Axel Lin2984fc02012-07-09 22:29:00 +0800174
Javier Martinez Canillasbe1bb232017-01-13 10:34:07 -0300175static int max77686_i2c_probe(struct i2c_client *i2c)
Jonghwa Leedae8a962012-06-25 10:34:36 +0200176{
Yadwinder Singh Brarc1516f82012-07-06 17:02:55 +0530177 struct max77686_dev *max77686 = NULL;
Jonghwa Leedae8a962012-06-25 10:34:36 +0200178 unsigned int data;
179 int ret = 0;
Javier Martinez Canillasa259f382014-07-24 14:39:24 +0200180 const struct regmap_config *config;
181 const struct regmap_irq_chip *irq_chip;
Javier Martinez Canillasa259f382014-07-24 14:39:24 +0200182 const struct mfd_cell *cells;
183 int n_devs;
Jonghwa Leedae8a962012-06-25 10:34:36 +0200184
Lee Jones742413a2013-05-23 16:25:16 +0100185 max77686 = devm_kzalloc(&i2c->dev,
186 sizeof(struct max77686_dev), GFP_KERNEL);
Javier Martinez Canillasc0e0fcd2014-07-04 22:24:09 +0200187 if (!max77686)
Jonghwa Leedae8a962012-06-25 10:34:36 +0200188 return -ENOMEM;
189
Jonghwa Leedae8a962012-06-25 10:34:36 +0200190 i2c_set_clientdata(i2c, max77686);
Javier Martinez Canillas68e61f72017-01-13 10:34:06 -0300191 max77686->type = (unsigned long)of_device_get_match_data(&i2c->dev);
Jonghwa Leedae8a962012-06-25 10:34:36 +0200192 max77686->dev = &i2c->dev;
193 max77686->i2c = i2c;
Jonghwa Leedae8a962012-06-25 10:34:36 +0200194
Yadwinder Singh Brar2b404592012-07-09 13:21:45 +0200195 max77686->irq = i2c->irq;
Jonghwa Leedae8a962012-06-25 10:34:36 +0200196
Javier Martinez Canillasa259f382014-07-24 14:39:24 +0200197 if (max77686->type == TYPE_MAX77686) {
198 config = &max77686_regmap_config;
199 irq_chip = &max77686_irq_chip;
Javier Martinez Canillasa259f382014-07-24 14:39:24 +0200200 cells = max77686_devs;
201 n_devs = ARRAY_SIZE(max77686_devs);
202 } else {
203 config = &max77802_regmap_config;
204 irq_chip = &max77802_irq_chip;
Javier Martinez Canillasa259f382014-07-24 14:39:24 +0200205 cells = max77802_devs;
206 n_devs = ARRAY_SIZE(max77802_devs);
207 }
208
209 max77686->regmap = devm_regmap_init_i2c(i2c, config);
Axel Lin136d9822012-12-25 00:16:43 +0800210 if (IS_ERR(max77686->regmap)) {
211 ret = PTR_ERR(max77686->regmap);
212 dev_err(max77686->dev, "Failed to allocate register map: %d\n",
213 ret);
Axel Lin136d9822012-12-25 00:16:43 +0800214 return ret;
215 }
216
Javier Martinez Canillasc0e0fcd2014-07-04 22:24:09 +0200217 ret = regmap_read(max77686->regmap, MAX77686_REG_DEVICE_ID, &data);
218 if (ret < 0) {
Jonghwa Leedae8a962012-06-25 10:34:36 +0200219 dev_err(max77686->dev,
220 "device not found on this channel (this is not an error)\n");
Lee Jones742413a2013-05-23 16:25:16 +0100221 return -ENODEV;
Javier Martinez Canillas6f1c1e72014-07-04 22:24:04 +0200222 }
Jonghwa Leedae8a962012-06-25 10:34:36 +0200223
Laxman Dewangan1a5422c2016-04-21 17:55:54 +0530224 ret = devm_regmap_add_irq_chip(&i2c->dev, max77686->regmap,
225 max77686->irq,
226 IRQF_TRIGGER_FALLING | IRQF_ONESHOT |
227 IRQF_SHARED, 0, irq_chip,
228 &max77686->irq_data);
Laxman Dewanganf3937542016-02-09 22:56:34 +0530229 if (ret < 0) {
Javier Martinez Canillas6f1c1e72014-07-04 22:24:04 +0200230 dev_err(&i2c->dev, "failed to add PMIC irq chip: %d\n", ret);
Laxman Dewanganf3937542016-02-09 22:56:34 +0530231 return ret;
Javier Martinez Canillas6f1c1e72014-07-04 22:24:04 +0200232 }
Jonghwa Leedae8a962012-06-25 10:34:36 +0200233
Laxman Dewangan1a5422c2016-04-21 17:55:54 +0530234 ret = devm_mfd_add_devices(max77686->dev, -1, cells, n_devs, NULL,
235 0, NULL);
Lee Jones742413a2013-05-23 16:25:16 +0100236 if (ret < 0) {
Javier Martinez Canillas6f1c1e72014-07-04 22:24:04 +0200237 dev_err(&i2c->dev, "failed to add MFD devices: %d\n", ret);
Laxman Dewangan1a5422c2016-04-21 17:55:54 +0530238 return ret;
Lee Jones742413a2013-05-23 16:25:16 +0100239 }
Jonghwa Leedae8a962012-06-25 10:34:36 +0200240
Javier Martinez Canillas6f1c1e72014-07-04 22:24:04 +0200241 return 0;
Jonghwa Leedae8a962012-06-25 10:34:36 +0200242}
243
Javier Martinez Canillas2b52b5d2014-07-04 22:24:05 +0200244#ifdef CONFIG_PM_SLEEP
245static int max77686_suspend(struct device *dev)
246{
Geliang Tang1b5420e2015-12-28 23:00:14 +0800247 struct i2c_client *i2c = to_i2c_client(dev);
Javier Martinez Canillas2b52b5d2014-07-04 22:24:05 +0200248 struct max77686_dev *max77686 = i2c_get_clientdata(i2c);
249
250 if (device_may_wakeup(dev))
251 enable_irq_wake(max77686->irq);
252
253 /*
254 * IRQ must be disabled during suspend because if it happens
255 * while suspended it will be handled before resuming I2C.
256 *
257 * When device is woken up from suspend (e.g. by RTC wake alarm),
258 * an interrupt occurs before resuming I2C bus controller.
259 * Interrupt handler tries to read registers but this read
260 * will fail because I2C is still suspended.
261 */
262 disable_irq(max77686->irq);
263
264 return 0;
265}
266
267static int max77686_resume(struct device *dev)
268{
Geliang Tang1b5420e2015-12-28 23:00:14 +0800269 struct i2c_client *i2c = to_i2c_client(dev);
Javier Martinez Canillas2b52b5d2014-07-04 22:24:05 +0200270 struct max77686_dev *max77686 = i2c_get_clientdata(i2c);
271
272 if (device_may_wakeup(dev))
273 disable_irq_wake(max77686->irq);
274
275 enable_irq(max77686->irq);
276
277 return 0;
278}
279#endif /* CONFIG_PM_SLEEP */
280
281static SIMPLE_DEV_PM_OPS(max77686_pm, max77686_suspend, max77686_resume);
282
Jonghwa Leedae8a962012-06-25 10:34:36 +0200283static struct i2c_driver max77686_i2c_driver = {
284 .driver = {
285 .name = "max77686",
Javier Martinez Canillas2b52b5d2014-07-04 22:24:05 +0200286 .pm = &max77686_pm,
Yadwinder Singh Brarc1516f82012-07-06 17:02:55 +0530287 .of_match_table = of_match_ptr(max77686_pmic_dt_match),
Jonghwa Leedae8a962012-06-25 10:34:36 +0200288 },
Javier Martinez Canillasbe1bb232017-01-13 10:34:07 -0300289 .probe_new = max77686_i2c_probe,
Jonghwa Leedae8a962012-06-25 10:34:36 +0200290};
291
Javier Martinez Canillas8a0aee42016-04-04 18:46:02 -0400292module_i2c_driver(max77686_i2c_driver);
Jonghwa Leedae8a962012-06-25 10:34:36 +0200293
Javier Martinez Canillasa259f382014-07-24 14:39:24 +0200294MODULE_DESCRIPTION("MAXIM 77686/802 multi-function core driver");
Jonghwa Leedae8a962012-06-25 10:34:36 +0200295MODULE_AUTHOR("Chiwoong Byun <woong.byun@samsung.com>");
296MODULE_LICENSE("GPL");