1 /*
2 * max8998.c - mfd core driver for the Maxim 8998
3 *
4 * Copyright (C) 2009-2010 Samsung Electronics
5 * Kyungmin Park <kyungmin.park@samsung.com>
6 * Marek Szyprowski <m.szyprowski@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
23 #include <linux/err.h>
24 #include <linux/init.h>
25 #include <linux/slab.h>
26 #include <linux/i2c.h>
27 #include <linux/interrupt.h>
28 #include <linux/of.h>
29 #include <linux/of_irq.h>
30 #include <linux/pm_runtime.h>
31 #include <linux/mutex.h>
32 #include <linux/mfd/core.h>
33 #include <linux/mfd/max8998.h>
34 #include <linux/mfd/max8998-private.h>
35
36 #define RTC_I2C_ADDR (0x0c >> 1)
37
38 static const struct mfd_cell max8998_devs[] = {
39 {
40 .name = "max8998-pmic",
41 }, {
42 .name = "max8998-rtc",
43 }, {
44 .name = "max8998-battery",
45 },
46 };
47
48 static const struct mfd_cell lp3974_devs[] = {
49 {
50 .name = "lp3974-pmic",
51 }, {
52 .name = "lp3974-rtc",
53 },
54 };
55
max8998_read_reg(struct i2c_client * i2c,u8 reg,u8 * dest)56 int max8998_read_reg(struct i2c_client *i2c, u8 reg, u8 *dest)
57 {
58 struct max8998_dev *max8998 = i2c_get_clientdata(i2c);
59 int ret;
60
61 mutex_lock(&max8998->iolock);
62 ret = i2c_smbus_read_byte_data(i2c, reg);
63 mutex_unlock(&max8998->iolock);
64 if (ret < 0)
65 return ret;
66
67 ret &= 0xff;
68 *dest = ret;
69 return 0;
70 }
71 EXPORT_SYMBOL(max8998_read_reg);
72
max8998_bulk_read(struct i2c_client * i2c,u8 reg,int count,u8 * buf)73 int max8998_bulk_read(struct i2c_client *i2c, u8 reg, int count, u8 *buf)
74 {
75 struct max8998_dev *max8998 = i2c_get_clientdata(i2c);
76 int ret;
77
78 mutex_lock(&max8998->iolock);
79 ret = i2c_smbus_read_i2c_block_data(i2c, reg, count, buf);
80 mutex_unlock(&max8998->iolock);
81 if (ret < 0)
82 return ret;
83
84 return 0;
85 }
86 EXPORT_SYMBOL(max8998_bulk_read);
87
max8998_write_reg(struct i2c_client * i2c,u8 reg,u8 value)88 int max8998_write_reg(struct i2c_client *i2c, u8 reg, u8 value)
89 {
90 struct max8998_dev *max8998 = i2c_get_clientdata(i2c);
91 int ret;
92
93 mutex_lock(&max8998->iolock);
94 ret = i2c_smbus_write_byte_data(i2c, reg, value);
95 mutex_unlock(&max8998->iolock);
96 return ret;
97 }
98 EXPORT_SYMBOL(max8998_write_reg);
99
max8998_bulk_write(struct i2c_client * i2c,u8 reg,int count,u8 * buf)100 int max8998_bulk_write(struct i2c_client *i2c, u8 reg, int count, u8 *buf)
101 {
102 struct max8998_dev *max8998 = i2c_get_clientdata(i2c);
103 int ret;
104
105 mutex_lock(&max8998->iolock);
106 ret = i2c_smbus_write_i2c_block_data(i2c, reg, count, buf);
107 mutex_unlock(&max8998->iolock);
108 if (ret < 0)
109 return ret;
110
111 return 0;
112 }
113 EXPORT_SYMBOL(max8998_bulk_write);
114
max8998_update_reg(struct i2c_client * i2c,u8 reg,u8 val,u8 mask)115 int max8998_update_reg(struct i2c_client *i2c, u8 reg, u8 val, u8 mask)
116 {
117 struct max8998_dev *max8998 = i2c_get_clientdata(i2c);
118 int ret;
119
120 mutex_lock(&max8998->iolock);
121 ret = i2c_smbus_read_byte_data(i2c, reg);
122 if (ret >= 0) {
123 u8 old_val = ret & 0xff;
124 u8 new_val = (val & mask) | (old_val & (~mask));
125 ret = i2c_smbus_write_byte_data(i2c, reg, new_val);
126 }
127 mutex_unlock(&max8998->iolock);
128 return ret;
129 }
130 EXPORT_SYMBOL(max8998_update_reg);
131
132 #ifdef CONFIG_OF
133 static const struct of_device_id max8998_dt_match[] = {
134 { .compatible = "maxim,max8998", .data = (void *)TYPE_MAX8998 },
135 { .compatible = "national,lp3974", .data = (void *)TYPE_LP3974 },
136 { .compatible = "ti,lp3974", .data = (void *)TYPE_LP3974 },
137 {},
138 };
139 #endif
140
141 /*
142 * Only the common platform data elements for max8998 are parsed here from the
143 * device tree. Other sub-modules of max8998 such as pmic, rtc and others have
144 * to parse their own platform data elements from device tree.
145 *
146 * The max8998 platform data structure is instantiated here and the drivers for
147 * the sub-modules need not instantiate another instance while parsing their
148 * platform data.
149 */
max8998_i2c_parse_dt_pdata(struct device * dev)150 static struct max8998_platform_data *max8998_i2c_parse_dt_pdata(
151 struct device *dev)
152 {
153 struct max8998_platform_data *pd;
154
155 pd = devm_kzalloc(dev, sizeof(*pd), GFP_KERNEL);
156 if (!pd)
157 return ERR_PTR(-ENOMEM);
158
159 pd->ono = irq_of_parse_and_map(dev->of_node, 1);
160
161 /*
162 * ToDo: the 'wakeup' member in the platform data is more of a linux
163 * specfic information. Hence, there is no binding for that yet and
164 * not parsed here.
165 */
166 return pd;
167 }
168
max8998_i2c_get_driver_data(struct i2c_client * i2c,const struct i2c_device_id * id)169 static inline unsigned long max8998_i2c_get_driver_data(struct i2c_client *i2c,
170 const struct i2c_device_id *id)
171 {
172 if (IS_ENABLED(CONFIG_OF) && i2c->dev.of_node) {
173 const struct of_device_id *match;
174 match = of_match_node(max8998_dt_match, i2c->dev.of_node);
175 return (unsigned long)match->data;
176 }
177
178 return id->driver_data;
179 }
180
max8998_i2c_probe(struct i2c_client * i2c,const struct i2c_device_id * id)181 static int max8998_i2c_probe(struct i2c_client *i2c,
182 const struct i2c_device_id *id)
183 {
184 struct max8998_platform_data *pdata = dev_get_platdata(&i2c->dev);
185 struct max8998_dev *max8998;
186 int ret = 0;
187
188 max8998 = devm_kzalloc(&i2c->dev, sizeof(struct max8998_dev),
189 GFP_KERNEL);
190 if (max8998 == NULL)
191 return -ENOMEM;
192
193 if (IS_ENABLED(CONFIG_OF) && i2c->dev.of_node) {
194 pdata = max8998_i2c_parse_dt_pdata(&i2c->dev);
195 if (IS_ERR(pdata))
196 return PTR_ERR(pdata);
197 }
198
199 i2c_set_clientdata(i2c, max8998);
200 max8998->dev = &i2c->dev;
201 max8998->i2c = i2c;
202 max8998->irq = i2c->irq;
203 max8998->type = max8998_i2c_get_driver_data(i2c, id);
204 max8998->pdata = pdata;
205 if (pdata) {
206 max8998->ono = pdata->ono;
207 max8998->irq_base = pdata->irq_base;
208 max8998->wakeup = pdata->wakeup;
209 }
210 mutex_init(&max8998->iolock);
211
212 max8998->rtc = i2c_new_dummy(i2c->adapter, RTC_I2C_ADDR);
213 if (!max8998->rtc) {
214 dev_err(&i2c->dev, "Failed to allocate I2C device for RTC\n");
215 return -ENODEV;
216 }
217 i2c_set_clientdata(max8998->rtc, max8998);
218
219 max8998_irq_init(max8998);
220
221 pm_runtime_set_active(max8998->dev);
222
223 switch (max8998->type) {
224 case TYPE_LP3974:
225 ret = mfd_add_devices(max8998->dev, -1,
226 lp3974_devs, ARRAY_SIZE(lp3974_devs),
227 NULL, 0, NULL);
228 break;
229 case TYPE_MAX8998:
230 ret = mfd_add_devices(max8998->dev, -1,
231 max8998_devs, ARRAY_SIZE(max8998_devs),
232 NULL, 0, NULL);
233 break;
234 default:
235 ret = -EINVAL;
236 }
237
238 if (ret < 0)
239 goto err;
240
241 device_init_wakeup(max8998->dev, max8998->wakeup);
242
243 return ret;
244
245 err:
246 mfd_remove_devices(max8998->dev);
247 max8998_irq_exit(max8998);
248 i2c_unregister_device(max8998->rtc);
249 return ret;
250 }
251
252 static const struct i2c_device_id max8998_i2c_id[] = {
253 { "max8998", TYPE_MAX8998 },
254 { "lp3974", TYPE_LP3974},
255 { }
256 };
257
max8998_suspend(struct device * dev)258 static int max8998_suspend(struct device *dev)
259 {
260 struct i2c_client *i2c = to_i2c_client(dev);
261 struct max8998_dev *max8998 = i2c_get_clientdata(i2c);
262
263 if (device_may_wakeup(dev))
264 irq_set_irq_wake(max8998->irq, 1);
265 return 0;
266 }
267
max8998_resume(struct device * dev)268 static int max8998_resume(struct device *dev)
269 {
270 struct i2c_client *i2c = to_i2c_client(dev);
271 struct max8998_dev *max8998 = i2c_get_clientdata(i2c);
272
273 if (device_may_wakeup(dev))
274 irq_set_irq_wake(max8998->irq, 0);
275 /*
276 * In LP3974, if IRQ registers are not "read & clear"
277 * when it's set during sleep, the interrupt becomes
278 * disabled.
279 */
280 return max8998_irq_resume(i2c_get_clientdata(i2c));
281 }
282
283 struct max8998_reg_dump {
284 u8 addr;
285 u8 val;
286 };
287 #define SAVE_ITEM(x) { .addr = (x), .val = 0x0, }
288 static struct max8998_reg_dump max8998_dump[] = {
289 SAVE_ITEM(MAX8998_REG_IRQM1),
290 SAVE_ITEM(MAX8998_REG_IRQM2),
291 SAVE_ITEM(MAX8998_REG_IRQM3),
292 SAVE_ITEM(MAX8998_REG_IRQM4),
293 SAVE_ITEM(MAX8998_REG_STATUSM1),
294 SAVE_ITEM(MAX8998_REG_STATUSM2),
295 SAVE_ITEM(MAX8998_REG_CHGR1),
296 SAVE_ITEM(MAX8998_REG_CHGR2),
297 SAVE_ITEM(MAX8998_REG_LDO_ACTIVE_DISCHARGE1),
298 SAVE_ITEM(MAX8998_REG_LDO_ACTIVE_DISCHARGE1),
299 SAVE_ITEM(MAX8998_REG_BUCK_ACTIVE_DISCHARGE3),
300 SAVE_ITEM(MAX8998_REG_ONOFF1),
301 SAVE_ITEM(MAX8998_REG_ONOFF2),
302 SAVE_ITEM(MAX8998_REG_ONOFF3),
303 SAVE_ITEM(MAX8998_REG_ONOFF4),
304 SAVE_ITEM(MAX8998_REG_BUCK1_VOLTAGE1),
305 SAVE_ITEM(MAX8998_REG_BUCK1_VOLTAGE2),
306 SAVE_ITEM(MAX8998_REG_BUCK1_VOLTAGE3),
307 SAVE_ITEM(MAX8998_REG_BUCK1_VOLTAGE4),
308 SAVE_ITEM(MAX8998_REG_BUCK2_VOLTAGE1),
309 SAVE_ITEM(MAX8998_REG_BUCK2_VOLTAGE2),
310 SAVE_ITEM(MAX8998_REG_LDO2_LDO3),
311 SAVE_ITEM(MAX8998_REG_LDO4),
312 SAVE_ITEM(MAX8998_REG_LDO5),
313 SAVE_ITEM(MAX8998_REG_LDO6),
314 SAVE_ITEM(MAX8998_REG_LDO7),
315 SAVE_ITEM(MAX8998_REG_LDO8_LDO9),
316 SAVE_ITEM(MAX8998_REG_LDO10_LDO11),
317 SAVE_ITEM(MAX8998_REG_LDO12),
318 SAVE_ITEM(MAX8998_REG_LDO13),
319 SAVE_ITEM(MAX8998_REG_LDO14),
320 SAVE_ITEM(MAX8998_REG_LDO15),
321 SAVE_ITEM(MAX8998_REG_LDO16),
322 SAVE_ITEM(MAX8998_REG_LDO17),
323 SAVE_ITEM(MAX8998_REG_BKCHR),
324 SAVE_ITEM(MAX8998_REG_LBCNFG1),
325 SAVE_ITEM(MAX8998_REG_LBCNFG2),
326 };
327 /* Save registers before hibernation */
max8998_freeze(struct device * dev)328 static int max8998_freeze(struct device *dev)
329 {
330 struct i2c_client *i2c = to_i2c_client(dev);
331 int i;
332
333 for (i = 0; i < ARRAY_SIZE(max8998_dump); i++)
334 max8998_read_reg(i2c, max8998_dump[i].addr,
335 &max8998_dump[i].val);
336
337 return 0;
338 }
339
340 /* Restore registers after hibernation */
max8998_restore(struct device * dev)341 static int max8998_restore(struct device *dev)
342 {
343 struct i2c_client *i2c = to_i2c_client(dev);
344 int i;
345
346 for (i = 0; i < ARRAY_SIZE(max8998_dump); i++)
347 max8998_write_reg(i2c, max8998_dump[i].addr,
348 max8998_dump[i].val);
349
350 return 0;
351 }
352
353 static const struct dev_pm_ops max8998_pm = {
354 .suspend = max8998_suspend,
355 .resume = max8998_resume,
356 .freeze = max8998_freeze,
357 .restore = max8998_restore,
358 };
359
360 static struct i2c_driver max8998_i2c_driver = {
361 .driver = {
362 .name = "max8998",
363 .pm = &max8998_pm,
364 .suppress_bind_attrs = true,
365 .of_match_table = of_match_ptr(max8998_dt_match),
366 },
367 .probe = max8998_i2c_probe,
368 .id_table = max8998_i2c_id,
369 };
370
max8998_i2c_init(void)371 static int __init max8998_i2c_init(void)
372 {
373 return i2c_add_driver(&max8998_i2c_driver);
374 }
375 /* init early so consumer devices can complete system boot */
376 subsys_initcall(max8998_i2c_init);
377
