Loading...
1// SPDX-License-Identifier: GPL-2.0+
2//
3// max77686.c - mfd core driver for the Maxim 77686/802
4//
5// Copyright (C) 2012 Samsung Electronics
6// Chiwoong Byun <woong.byun@samsung.com>
7// Jonghwa Lee <jonghwa3.lee@samsung.com>
8//
9//This driver is based on max8997.c
10
11#include <linux/export.h>
12#include <linux/slab.h>
13#include <linux/i2c.h>
14#include <linux/irq.h>
15#include <linux/interrupt.h>
16#include <linux/pm_runtime.h>
17#include <linux/module.h>
18#include <linux/mfd/core.h>
19#include <linux/mfd/max77686.h>
20#include <linux/mfd/max77686-private.h>
21#include <linux/err.h>
22#include <linux/of.h>
23#include <linux/of_device.h>
24
25static const struct mfd_cell max77686_devs[] = {
26 { .name = "max77686-pmic", },
27 { .name = "max77686-rtc", },
28 { .name = "max77686-clk", },
29};
30
31static const struct mfd_cell max77802_devs[] = {
32 { .name = "max77802-pmic", },
33 { .name = "max77802-clk", },
34 { .name = "max77802-rtc", },
35};
36
37static bool max77802_pmic_is_accessible_reg(struct device *dev,
38 unsigned int reg)
39{
40 return reg < MAX77802_REG_PMIC_END;
41}
42
43static bool max77802_rtc_is_accessible_reg(struct device *dev,
44 unsigned int reg)
45{
46 return (reg >= MAX77802_RTC_INT && reg < MAX77802_RTC_END);
47}
48
49static bool max77802_is_accessible_reg(struct device *dev, unsigned int reg)
50{
51 return (max77802_pmic_is_accessible_reg(dev, reg) ||
52 max77802_rtc_is_accessible_reg(dev, reg));
53}
54
55static bool max77802_pmic_is_precious_reg(struct device *dev, unsigned int reg)
56{
57 return (reg == MAX77802_REG_INTSRC || reg == MAX77802_REG_INT1 ||
58 reg == MAX77802_REG_INT2);
59}
60
61static bool max77802_rtc_is_precious_reg(struct device *dev, unsigned int reg)
62{
63 return (reg == MAX77802_RTC_INT ||
64 reg == MAX77802_RTC_UPDATE0 ||
65 reg == MAX77802_RTC_UPDATE1);
66}
67
68static bool max77802_is_precious_reg(struct device *dev, unsigned int reg)
69{
70 return (max77802_pmic_is_precious_reg(dev, reg) ||
71 max77802_rtc_is_precious_reg(dev, reg));
72}
73
74static bool max77802_pmic_is_volatile_reg(struct device *dev, unsigned int reg)
75{
76 return (max77802_is_precious_reg(dev, reg) ||
77 reg == MAX77802_REG_STATUS1 || reg == MAX77802_REG_STATUS2 ||
78 reg == MAX77802_REG_PWRON);
79}
80
81static bool max77802_rtc_is_volatile_reg(struct device *dev, unsigned int reg)
82{
83 return (max77802_rtc_is_precious_reg(dev, reg) ||
84 reg == MAX77802_RTC_SEC ||
85 reg == MAX77802_RTC_MIN ||
86 reg == MAX77802_RTC_HOUR ||
87 reg == MAX77802_RTC_WEEKDAY ||
88 reg == MAX77802_RTC_MONTH ||
89 reg == MAX77802_RTC_YEAR ||
90 reg == MAX77802_RTC_DATE);
91}
92
93static bool max77802_is_volatile_reg(struct device *dev, unsigned int reg)
94{
95 return (max77802_pmic_is_volatile_reg(dev, reg) ||
96 max77802_rtc_is_volatile_reg(dev, reg));
97}
98
99static const struct regmap_config max77686_regmap_config = {
100 .reg_bits = 8,
101 .val_bits = 8,
102};
103
104static const struct regmap_config max77802_regmap_config = {
105 .reg_bits = 8,
106 .val_bits = 8,
107 .writeable_reg = max77802_is_accessible_reg,
108 .readable_reg = max77802_is_accessible_reg,
109 .precious_reg = max77802_is_precious_reg,
110 .volatile_reg = max77802_is_volatile_reg,
111 .name = "max77802-pmic",
112 .cache_type = REGCACHE_RBTREE,
113};
114
115static const struct regmap_irq max77686_irqs[] = {
116 /* INT1 interrupts */
117 { .reg_offset = 0, .mask = MAX77686_INT1_PWRONF_MSK, },
118 { .reg_offset = 0, .mask = MAX77686_INT1_PWRONR_MSK, },
119 { .reg_offset = 0, .mask = MAX77686_INT1_JIGONBF_MSK, },
120 { .reg_offset = 0, .mask = MAX77686_INT1_JIGONBR_MSK, },
121 { .reg_offset = 0, .mask = MAX77686_INT1_ACOKBF_MSK, },
122 { .reg_offset = 0, .mask = MAX77686_INT1_ACOKBR_MSK, },
123 { .reg_offset = 0, .mask = MAX77686_INT1_ONKEY1S_MSK, },
124 { .reg_offset = 0, .mask = MAX77686_INT1_MRSTB_MSK, },
125 /* INT2 interrupts */
126 { .reg_offset = 1, .mask = MAX77686_INT2_140C_MSK, },
127 { .reg_offset = 1, .mask = MAX77686_INT2_120C_MSK, },
128};
129
130static const struct regmap_irq_chip max77686_irq_chip = {
131 .name = "max77686-pmic",
132 .status_base = MAX77686_REG_INT1,
133 .mask_base = MAX77686_REG_INT1MSK,
134 .num_regs = 2,
135 .irqs = max77686_irqs,
136 .num_irqs = ARRAY_SIZE(max77686_irqs),
137};
138
139static const struct regmap_irq_chip max77802_irq_chip = {
140 .name = "max77802-pmic",
141 .status_base = MAX77802_REG_INT1,
142 .mask_base = MAX77802_REG_INT1MSK,
143 .num_regs = 2,
144 .irqs = max77686_irqs, /* same masks as 77686 */
145 .num_irqs = ARRAY_SIZE(max77686_irqs),
146};
147
148static const struct of_device_id max77686_pmic_dt_match[] = {
149 {
150 .compatible = "maxim,max77686",
151 .data = (void *)TYPE_MAX77686,
152 },
153 {
154 .compatible = "maxim,max77802",
155 .data = (void *)TYPE_MAX77802,
156 },
157 { },
158};
159MODULE_DEVICE_TABLE(of, max77686_pmic_dt_match);
160
161static int max77686_i2c_probe(struct i2c_client *i2c)
162{
163 struct max77686_dev *max77686 = NULL;
164 unsigned int data;
165 int ret = 0;
166 const struct regmap_config *config;
167 const struct regmap_irq_chip *irq_chip;
168 const struct mfd_cell *cells;
169 int n_devs;
170
171 max77686 = devm_kzalloc(&i2c->dev,
172 sizeof(struct max77686_dev), GFP_KERNEL);
173 if (!max77686)
174 return -ENOMEM;
175
176 i2c_set_clientdata(i2c, max77686);
177 max77686->type = (unsigned long)of_device_get_match_data(&i2c->dev);
178 max77686->dev = &i2c->dev;
179 max77686->i2c = i2c;
180
181 max77686->irq = i2c->irq;
182
183 if (max77686->type == TYPE_MAX77686) {
184 config = &max77686_regmap_config;
185 irq_chip = &max77686_irq_chip;
186 cells = max77686_devs;
187 n_devs = ARRAY_SIZE(max77686_devs);
188 } else {
189 config = &max77802_regmap_config;
190 irq_chip = &max77802_irq_chip;
191 cells = max77802_devs;
192 n_devs = ARRAY_SIZE(max77802_devs);
193 }
194
195 max77686->regmap = devm_regmap_init_i2c(i2c, config);
196 if (IS_ERR(max77686->regmap)) {
197 ret = PTR_ERR(max77686->regmap);
198 dev_err(max77686->dev, "Failed to allocate register map: %d\n",
199 ret);
200 return ret;
201 }
202
203 ret = regmap_read(max77686->regmap, MAX77686_REG_DEVICE_ID, &data);
204 if (ret < 0) {
205 dev_err(max77686->dev,
206 "device not found on this channel (this is not an error)\n");
207 return -ENODEV;
208 }
209
210 ret = devm_regmap_add_irq_chip(&i2c->dev, max77686->regmap,
211 max77686->irq,
212 IRQF_TRIGGER_FALLING | IRQF_ONESHOT |
213 IRQF_SHARED, 0, irq_chip,
214 &max77686->irq_data);
215 if (ret < 0) {
216 dev_err(&i2c->dev, "failed to add PMIC irq chip: %d\n", ret);
217 return ret;
218 }
219
220 ret = devm_mfd_add_devices(max77686->dev, -1, cells, n_devs, NULL,
221 0, NULL);
222 if (ret < 0) {
223 dev_err(&i2c->dev, "failed to add MFD devices: %d\n", ret);
224 return ret;
225 }
226
227 return 0;
228}
229
230#ifdef CONFIG_PM_SLEEP
231static int max77686_suspend(struct device *dev)
232{
233 struct i2c_client *i2c = to_i2c_client(dev);
234 struct max77686_dev *max77686 = i2c_get_clientdata(i2c);
235
236 if (device_may_wakeup(dev))
237 enable_irq_wake(max77686->irq);
238
239 /*
240 * IRQ must be disabled during suspend because if it happens
241 * while suspended it will be handled before resuming I2C.
242 *
243 * When device is woken up from suspend (e.g. by RTC wake alarm),
244 * an interrupt occurs before resuming I2C bus controller.
245 * Interrupt handler tries to read registers but this read
246 * will fail because I2C is still suspended.
247 */
248 disable_irq(max77686->irq);
249
250 return 0;
251}
252
253static int max77686_resume(struct device *dev)
254{
255 struct i2c_client *i2c = to_i2c_client(dev);
256 struct max77686_dev *max77686 = i2c_get_clientdata(i2c);
257
258 if (device_may_wakeup(dev))
259 disable_irq_wake(max77686->irq);
260
261 enable_irq(max77686->irq);
262
263 return 0;
264}
265#endif /* CONFIG_PM_SLEEP */
266
267static SIMPLE_DEV_PM_OPS(max77686_pm, max77686_suspend, max77686_resume);
268
269static struct i2c_driver max77686_i2c_driver = {
270 .driver = {
271 .name = "max77686",
272 .pm = &max77686_pm,
273 .of_match_table = of_match_ptr(max77686_pmic_dt_match),
274 },
275 .probe_new = max77686_i2c_probe,
276};
277
278module_i2c_driver(max77686_i2c_driver);
279
280MODULE_DESCRIPTION("MAXIM 77686/802 multi-function core driver");
281MODULE_AUTHOR("Chiwoong Byun <woong.byun@samsung.com>");
282MODULE_LICENSE("GPL");
1/*
2 * max77686.c - mfd core driver for the Maxim 77686/802
3 *
4 * Copyright (C) 2012 Samsung Electronics
5 * Chiwoong Byun <woong.byun@samsung.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>
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>
36#include <linux/of.h>
37#include <linux/of_device.h>
38
39static const struct mfd_cell max77686_devs[] = {
40 { .name = "max77686-pmic", },
41 { .name = "max77686-rtc", },
42 { .name = "max77686-clk", },
43};
44
45static 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{
54 return reg < MAX77802_REG_PMIC_END;
55}
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
113static const struct regmap_config max77686_regmap_config = {
114 .reg_bits = 8,
115 .val_bits = 8,
116};
117
118static const struct regmap_config max77802_regmap_config = {
119 .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
129static 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
153static 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
162static const struct of_device_id max77686_pmic_dt_match[] = {
163 {
164 .compatible = "maxim,max77686",
165 .data = (void *)TYPE_MAX77686,
166 },
167 {
168 .compatible = "maxim,max77802",
169 .data = (void *)TYPE_MAX77802,
170 },
171 { },
172};
173MODULE_DEVICE_TABLE(of, max77686_pmic_dt_match);
174
175static int max77686_i2c_probe(struct i2c_client *i2c)
176{
177 struct max77686_dev *max77686 = NULL;
178 unsigned int data;
179 int ret = 0;
180 const struct regmap_config *config;
181 const struct regmap_irq_chip *irq_chip;
182 const struct mfd_cell *cells;
183 int n_devs;
184
185 max77686 = devm_kzalloc(&i2c->dev,
186 sizeof(struct max77686_dev), GFP_KERNEL);
187 if (!max77686)
188 return -ENOMEM;
189
190 i2c_set_clientdata(i2c, max77686);
191 max77686->type = (unsigned long)of_device_get_match_data(&i2c->dev);
192 max77686->dev = &i2c->dev;
193 max77686->i2c = i2c;
194
195 max77686->irq = i2c->irq;
196
197 if (max77686->type == TYPE_MAX77686) {
198 config = &max77686_regmap_config;
199 irq_chip = &max77686_irq_chip;
200 cells = max77686_devs;
201 n_devs = ARRAY_SIZE(max77686_devs);
202 } else {
203 config = &max77802_regmap_config;
204 irq_chip = &max77802_irq_chip;
205 cells = max77802_devs;
206 n_devs = ARRAY_SIZE(max77802_devs);
207 }
208
209 max77686->regmap = devm_regmap_init_i2c(i2c, config);
210 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);
214 return ret;
215 }
216
217 ret = regmap_read(max77686->regmap, MAX77686_REG_DEVICE_ID, &data);
218 if (ret < 0) {
219 dev_err(max77686->dev,
220 "device not found on this channel (this is not an error)\n");
221 return -ENODEV;
222 }
223
224 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);
229 if (ret < 0) {
230 dev_err(&i2c->dev, "failed to add PMIC irq chip: %d\n", ret);
231 return ret;
232 }
233
234 ret = devm_mfd_add_devices(max77686->dev, -1, cells, n_devs, NULL,
235 0, NULL);
236 if (ret < 0) {
237 dev_err(&i2c->dev, "failed to add MFD devices: %d\n", ret);
238 return ret;
239 }
240
241 return 0;
242}
243
244#ifdef CONFIG_PM_SLEEP
245static int max77686_suspend(struct device *dev)
246{
247 struct i2c_client *i2c = to_i2c_client(dev);
248 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{
269 struct i2c_client *i2c = to_i2c_client(dev);
270 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
283static struct i2c_driver max77686_i2c_driver = {
284 .driver = {
285 .name = "max77686",
286 .pm = &max77686_pm,
287 .of_match_table = of_match_ptr(max77686_pmic_dt_match),
288 },
289 .probe_new = max77686_i2c_probe,
290};
291
292module_i2c_driver(max77686_i2c_driver);
293
294MODULE_DESCRIPTION("MAXIM 77686/802 multi-function core driver");
295MODULE_AUTHOR("Chiwoong Byun <woong.byun@samsung.com>");
296MODULE_LICENSE("GPL");