blob: ab28b29400f65b62095c67d9accdeaca818bb0c6 [file] [log] [blame]
Kyungmin Park156f2522010-06-16 09:04:16 +02001/*
Joonyoung Shim2c7e6f52010-09-10 18:36:39 +02002 * max8998.c - mfd core driver for the Maxim 8998
Kyungmin Park156f2522010-06-16 09:04:16 +02003 *
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
Tomasz Figaee999fb2013-06-25 16:08:10 +020023#include <linux/err.h>
Kyungmin Park156f2522010-06-16 09:04:16 +020024#include <linux/module.h>
25#include <linux/moduleparam.h>
26#include <linux/init.h>
27#include <linux/slab.h>
28#include <linux/i2c.h>
MyungJoo Hamcdd137c2010-12-23 17:53:36 +090029#include <linux/interrupt.h>
Tomasz Figaee999fb2013-06-25 16:08:10 +020030#include <linux/of.h>
31#include <linux/of_irq.h>
MyungJoo Hamcdd137c2010-12-23 17:53:36 +090032#include <linux/pm_runtime.h>
Kyungmin Park156f2522010-06-16 09:04:16 +020033#include <linux/mutex.h>
34#include <linux/mfd/core.h>
35#include <linux/mfd/max8998.h>
36#include <linux/mfd/max8998-private.h>
37
Joonyoung Shim9b16c0a2010-08-06 11:28:08 +090038#define RTC_I2C_ADDR (0x0c >> 1)
39
Geert Uytterhoeven7c0517b2013-11-18 14:33:00 +010040static const struct mfd_cell max8998_devs[] = {
Kyungmin Park156f2522010-06-16 09:04:16 +020041 {
42 .name = "max8998-pmic",
Joonyoung Shim9b16c0a2010-08-06 11:28:08 +090043 }, {
44 .name = "max8998-rtc",
Donggeun Kimbb4ce972011-06-24 19:04:18 +090045 }, {
46 .name = "max8998-battery",
Joonyoung Shim9b16c0a2010-08-06 11:28:08 +090047 },
Kyungmin Park156f2522010-06-16 09:04:16 +020048};
49
Geert Uytterhoeven7c0517b2013-11-18 14:33:00 +010050static const struct mfd_cell lp3974_devs[] = {
MyungJoo Ham337ce5d2011-01-04 14:17:39 +090051 {
52 .name = "lp3974-pmic",
53 }, {
54 .name = "lp3974-rtc",
55 },
56};
57
Joonyoung Shim676e02d2010-08-06 11:28:06 +090058int max8998_read_reg(struct i2c_client *i2c, u8 reg, u8 *dest)
Kyungmin Park156f2522010-06-16 09:04:16 +020059{
Joonyoung Shim676e02d2010-08-06 11:28:06 +090060 struct max8998_dev *max8998 = i2c_get_clientdata(i2c);
Kyungmin Park156f2522010-06-16 09:04:16 +020061 int ret;
62
63 mutex_lock(&max8998->iolock);
Joonyoung Shim676e02d2010-08-06 11:28:06 +090064 ret = i2c_smbus_read_byte_data(i2c, reg);
Kyungmin Park156f2522010-06-16 09:04:16 +020065 mutex_unlock(&max8998->iolock);
66 if (ret < 0)
67 return ret;
68
69 ret &= 0xff;
70 *dest = ret;
71 return 0;
72}
Joonyoung Shim676e02d2010-08-06 11:28:06 +090073EXPORT_SYMBOL(max8998_read_reg);
Kyungmin Park156f2522010-06-16 09:04:16 +020074
Joonyoung Shim2c7e6f52010-09-10 18:36:39 +020075int max8998_bulk_read(struct i2c_client *i2c, u8 reg, int count, u8 *buf)
76{
77 struct max8998_dev *max8998 = i2c_get_clientdata(i2c);
78 int ret;
79
80 mutex_lock(&max8998->iolock);
81 ret = i2c_smbus_read_i2c_block_data(i2c, reg, count, buf);
82 mutex_unlock(&max8998->iolock);
83 if (ret < 0)
84 return ret;
85
86 return 0;
87}
88EXPORT_SYMBOL(max8998_bulk_read);
89
Joonyoung Shim676e02d2010-08-06 11:28:06 +090090int max8998_write_reg(struct i2c_client *i2c, u8 reg, u8 value)
Kyungmin Park156f2522010-06-16 09:04:16 +020091{
Joonyoung Shim676e02d2010-08-06 11:28:06 +090092 struct max8998_dev *max8998 = i2c_get_clientdata(i2c);
Kyungmin Park156f2522010-06-16 09:04:16 +020093 int ret;
94
95 mutex_lock(&max8998->iolock);
Joonyoung Shim676e02d2010-08-06 11:28:06 +090096 ret = i2c_smbus_write_byte_data(i2c, reg, value);
Kyungmin Park156f2522010-06-16 09:04:16 +020097 mutex_unlock(&max8998->iolock);
98 return ret;
99}
Joonyoung Shim676e02d2010-08-06 11:28:06 +0900100EXPORT_SYMBOL(max8998_write_reg);
Kyungmin Park156f2522010-06-16 09:04:16 +0200101
Joonyoung Shim9b16c0a2010-08-06 11:28:08 +0900102int max8998_bulk_write(struct i2c_client *i2c, u8 reg, int count, u8 *buf)
103{
104 struct max8998_dev *max8998 = i2c_get_clientdata(i2c);
105 int ret;
106
107 mutex_lock(&max8998->iolock);
108 ret = i2c_smbus_write_i2c_block_data(i2c, reg, count, buf);
109 mutex_unlock(&max8998->iolock);
110 if (ret < 0)
111 return ret;
112
113 return 0;
114}
115EXPORT_SYMBOL(max8998_bulk_write);
116
Joonyoung Shim676e02d2010-08-06 11:28:06 +0900117int max8998_update_reg(struct i2c_client *i2c, u8 reg, u8 val, u8 mask)
Kyungmin Park156f2522010-06-16 09:04:16 +0200118{
Joonyoung Shim676e02d2010-08-06 11:28:06 +0900119 struct max8998_dev *max8998 = i2c_get_clientdata(i2c);
Kyungmin Park156f2522010-06-16 09:04:16 +0200120 int ret;
121
122 mutex_lock(&max8998->iolock);
Joonyoung Shim676e02d2010-08-06 11:28:06 +0900123 ret = i2c_smbus_read_byte_data(i2c, reg);
Kyungmin Park156f2522010-06-16 09:04:16 +0200124 if (ret >= 0) {
125 u8 old_val = ret & 0xff;
126 u8 new_val = (val & mask) | (old_val & (~mask));
Joonyoung Shim676e02d2010-08-06 11:28:06 +0900127 ret = i2c_smbus_write_byte_data(i2c, reg, new_val);
Kyungmin Park156f2522010-06-16 09:04:16 +0200128 }
129 mutex_unlock(&max8998->iolock);
130 return ret;
131}
Joonyoung Shim676e02d2010-08-06 11:28:06 +0900132EXPORT_SYMBOL(max8998_update_reg);
Kyungmin Park156f2522010-06-16 09:04:16 +0200133
Tomasz Figaee999fb2013-06-25 16:08:10 +0200134#ifdef CONFIG_OF
Krzysztof Kozlowskie9205742014-05-13 12:58:48 +0200135static const struct of_device_id max8998_dt_match[] = {
Tomasz Figaee999fb2013-06-25 16:08:10 +0200136 { .compatible = "maxim,max8998", .data = (void *)TYPE_MAX8998 },
137 { .compatible = "national,lp3974", .data = (void *)TYPE_LP3974 },
138 { .compatible = "ti,lp3974", .data = (void *)TYPE_LP3974 },
139 {},
140};
141MODULE_DEVICE_TABLE(of, max8998_dt_match);
142#endif
143
144/*
145 * Only the common platform data elements for max8998 are parsed here from the
146 * device tree. Other sub-modules of max8998 such as pmic, rtc and others have
147 * to parse their own platform data elements from device tree.
148 *
149 * The max8998 platform data structure is instantiated here and the drivers for
150 * the sub-modules need not instantiate another instance while parsing their
151 * platform data.
152 */
153static struct max8998_platform_data *max8998_i2c_parse_dt_pdata(
154 struct device *dev)
155{
156 struct max8998_platform_data *pd;
157
158 pd = devm_kzalloc(dev, sizeof(*pd), GFP_KERNEL);
159 if (!pd)
160 return ERR_PTR(-ENOMEM);
161
162 pd->ono = irq_of_parse_and_map(dev->of_node, 1);
163
164 /*
165 * ToDo: the 'wakeup' member in the platform data is more of a linux
166 * specfic information. Hence, there is no binding for that yet and
167 * not parsed here.
168 */
169 return pd;
170}
171
Lee Jones8bace2d2014-02-03 08:22:30 +0000172static inline unsigned long max8998_i2c_get_driver_data(struct i2c_client *i2c,
Tomasz Figaee999fb2013-06-25 16:08:10 +0200173 const struct i2c_device_id *id)
174{
175 if (IS_ENABLED(CONFIG_OF) && i2c->dev.of_node) {
176 const struct of_device_id *match;
177 match = of_match_node(max8998_dt_match, i2c->dev.of_node);
Lee Jones8bace2d2014-02-03 08:22:30 +0000178 return (unsigned long)match->data;
Tomasz Figaee999fb2013-06-25 16:08:10 +0200179 }
180
Lee Jones8bace2d2014-02-03 08:22:30 +0000181 return id->driver_data;
Tomasz Figaee999fb2013-06-25 16:08:10 +0200182}
183
Kyungmin Park156f2522010-06-16 09:04:16 +0200184static int max8998_i2c_probe(struct i2c_client *i2c,
185 const struct i2c_device_id *id)
186{
Jingoo Han334a41c2013-07-30 17:10:05 +0900187 struct max8998_platform_data *pdata = dev_get_platdata(&i2c->dev);
Kyungmin Park156f2522010-06-16 09:04:16 +0200188 struct max8998_dev *max8998;
189 int ret = 0;
190
Jingoo Han0010dd32013-08-20 16:04:42 +0900191 max8998 = devm_kzalloc(&i2c->dev, sizeof(struct max8998_dev),
192 GFP_KERNEL);
Axel Lin8f1f1512010-08-09 14:48:16 +0800193 if (max8998 == NULL)
Kyungmin Park156f2522010-06-16 09:04:16 +0200194 return -ENOMEM;
Kyungmin Park156f2522010-06-16 09:04:16 +0200195
Tomasz Figaee999fb2013-06-25 16:08:10 +0200196 if (IS_ENABLED(CONFIG_OF) && i2c->dev.of_node) {
197 pdata = max8998_i2c_parse_dt_pdata(&i2c->dev);
198 if (IS_ERR(pdata)) {
199 ret = PTR_ERR(pdata);
200 goto err;
201 }
202 }
203
Kyungmin Park156f2522010-06-16 09:04:16 +0200204 i2c_set_clientdata(i2c, max8998);
205 max8998->dev = &i2c->dev;
Joonyoung Shim676e02d2010-08-06 11:28:06 +0900206 max8998->i2c = i2c;
Joonyoung Shim2c7e6f52010-09-10 18:36:39 +0200207 max8998->irq = i2c->irq;
Tomasz Figaee999fb2013-06-25 16:08:10 +0200208 max8998->type = max8998_i2c_get_driver_data(i2c, id);
209 max8998->pdata = pdata;
Joonyoung Shim2c7e6f52010-09-10 18:36:39 +0200210 if (pdata) {
211 max8998->ono = pdata->ono;
212 max8998->irq_base = pdata->irq_base;
MyungJoo Hamcdd137c2010-12-23 17:53:36 +0900213 max8998->wakeup = pdata->wakeup;
Joonyoung Shim2c7e6f52010-09-10 18:36:39 +0200214 }
Kyungmin Park156f2522010-06-16 09:04:16 +0200215 mutex_init(&max8998->iolock);
216
Joonyoung Shim9b16c0a2010-08-06 11:28:08 +0900217 max8998->rtc = i2c_new_dummy(i2c->adapter, RTC_I2C_ADDR);
Krzysztof Kozlowskied26f872014-02-11 11:03:35 +0100218 if (!max8998->rtc) {
219 dev_err(&i2c->dev, "Failed to allocate I2C device for RTC\n");
220 return -ENODEV;
221 }
Joonyoung Shim9b16c0a2010-08-06 11:28:08 +0900222 i2c_set_clientdata(max8998->rtc, max8998);
223
Joonyoung Shim2c7e6f52010-09-10 18:36:39 +0200224 max8998_irq_init(max8998);
225
MyungJoo Hamcdd137c2010-12-23 17:53:36 +0900226 pm_runtime_set_active(max8998->dev);
227
Tomasz Figaee999fb2013-06-25 16:08:10 +0200228 switch (max8998->type) {
MyungJoo Ham337ce5d2011-01-04 14:17:39 +0900229 case TYPE_LP3974:
230 ret = mfd_add_devices(max8998->dev, -1,
Mark Brown0848c942012-09-11 15:16:36 +0800231 lp3974_devs, ARRAY_SIZE(lp3974_devs),
232 NULL, 0, NULL);
MyungJoo Ham337ce5d2011-01-04 14:17:39 +0900233 break;
234 case TYPE_MAX8998:
235 ret = mfd_add_devices(max8998->dev, -1,
Mark Brown0848c942012-09-11 15:16:36 +0800236 max8998_devs, ARRAY_SIZE(max8998_devs),
237 NULL, 0, NULL);
MyungJoo Ham337ce5d2011-01-04 14:17:39 +0900238 break;
239 default:
240 ret = -EINVAL;
241 }
242
Kyungmin Park156f2522010-06-16 09:04:16 +0200243 if (ret < 0)
244 goto err;
245
Jonghwan Choi7ef73592011-11-29 17:17:51 +0900246 device_init_wakeup(max8998->dev, max8998->wakeup);
247
Kyungmin Park156f2522010-06-16 09:04:16 +0200248 return ret;
249
250err:
251 mfd_remove_devices(max8998->dev);
Axel Lin74845522010-10-22 08:31:49 +0800252 max8998_irq_exit(max8998);
253 i2c_unregister_device(max8998->rtc);
Kyungmin Park156f2522010-06-16 09:04:16 +0200254 return ret;
255}
256
257static int max8998_i2c_remove(struct i2c_client *i2c)
258{
259 struct max8998_dev *max8998 = i2c_get_clientdata(i2c);
260
261 mfd_remove_devices(max8998->dev);
Axel Lin74845522010-10-22 08:31:49 +0800262 max8998_irq_exit(max8998);
263 i2c_unregister_device(max8998->rtc);
Kyungmin Park156f2522010-06-16 09:04:16 +0200264
265 return 0;
266}
267
268static const struct i2c_device_id max8998_i2c_id[] = {
Lukasz Majewski509bd472010-09-27 14:32:24 +0200269 { "max8998", TYPE_MAX8998 },
270 { "lp3974", TYPE_LP3974},
Kyungmin Parkf8539dd2010-08-23 13:46:49 +0900271 { }
Kyungmin Park156f2522010-06-16 09:04:16 +0200272};
273MODULE_DEVICE_TABLE(i2c, max8998_i2c_id);
274
MyungJoo Hamcdd137c2010-12-23 17:53:36 +0900275static int max8998_suspend(struct device *dev)
276{
Geliang Tang1b5420e2015-12-28 23:00:14 +0800277 struct i2c_client *i2c = to_i2c_client(dev);
MyungJoo Hamcdd137c2010-12-23 17:53:36 +0900278 struct max8998_dev *max8998 = i2c_get_clientdata(i2c);
279
Jonghwan Choi7ef73592011-11-29 17:17:51 +0900280 if (device_may_wakeup(dev))
Thomas Gleixnerd5bb1222011-03-25 11:12:32 +0000281 irq_set_irq_wake(max8998->irq, 1);
MyungJoo Hamcdd137c2010-12-23 17:53:36 +0900282 return 0;
283}
284
285static int max8998_resume(struct device *dev)
286{
Geliang Tang1b5420e2015-12-28 23:00:14 +0800287 struct i2c_client *i2c = to_i2c_client(dev);
MyungJoo Hamcdd137c2010-12-23 17:53:36 +0900288 struct max8998_dev *max8998 = i2c_get_clientdata(i2c);
289
Jonghwan Choi7ef73592011-11-29 17:17:51 +0900290 if (device_may_wakeup(dev))
Thomas Gleixnerd5bb1222011-03-25 11:12:32 +0000291 irq_set_irq_wake(max8998->irq, 0);
MyungJoo Hamcdd137c2010-12-23 17:53:36 +0900292 /*
293 * In LP3974, if IRQ registers are not "read & clear"
294 * when it's set during sleep, the interrupt becomes
295 * disabled.
296 */
297 return max8998_irq_resume(i2c_get_clientdata(i2c));
298}
299
300struct max8998_reg_dump {
301 u8 addr;
302 u8 val;
303};
304#define SAVE_ITEM(x) { .addr = (x), .val = 0x0, }
Mark Brown44be0a42011-01-20 21:47:31 +0000305static struct max8998_reg_dump max8998_dump[] = {
MyungJoo Hamcdd137c2010-12-23 17:53:36 +0900306 SAVE_ITEM(MAX8998_REG_IRQM1),
307 SAVE_ITEM(MAX8998_REG_IRQM2),
308 SAVE_ITEM(MAX8998_REG_IRQM3),
309 SAVE_ITEM(MAX8998_REG_IRQM4),
310 SAVE_ITEM(MAX8998_REG_STATUSM1),
311 SAVE_ITEM(MAX8998_REG_STATUSM2),
312 SAVE_ITEM(MAX8998_REG_CHGR1),
313 SAVE_ITEM(MAX8998_REG_CHGR2),
314 SAVE_ITEM(MAX8998_REG_LDO_ACTIVE_DISCHARGE1),
315 SAVE_ITEM(MAX8998_REG_LDO_ACTIVE_DISCHARGE1),
316 SAVE_ITEM(MAX8998_REG_BUCK_ACTIVE_DISCHARGE3),
317 SAVE_ITEM(MAX8998_REG_ONOFF1),
318 SAVE_ITEM(MAX8998_REG_ONOFF2),
319 SAVE_ITEM(MAX8998_REG_ONOFF3),
320 SAVE_ITEM(MAX8998_REG_ONOFF4),
321 SAVE_ITEM(MAX8998_REG_BUCK1_VOLTAGE1),
322 SAVE_ITEM(MAX8998_REG_BUCK1_VOLTAGE2),
323 SAVE_ITEM(MAX8998_REG_BUCK1_VOLTAGE3),
324 SAVE_ITEM(MAX8998_REG_BUCK1_VOLTAGE4),
325 SAVE_ITEM(MAX8998_REG_BUCK2_VOLTAGE1),
326 SAVE_ITEM(MAX8998_REG_BUCK2_VOLTAGE2),
327 SAVE_ITEM(MAX8998_REG_LDO2_LDO3),
328 SAVE_ITEM(MAX8998_REG_LDO4),
329 SAVE_ITEM(MAX8998_REG_LDO5),
330 SAVE_ITEM(MAX8998_REG_LDO6),
331 SAVE_ITEM(MAX8998_REG_LDO7),
332 SAVE_ITEM(MAX8998_REG_LDO8_LDO9),
333 SAVE_ITEM(MAX8998_REG_LDO10_LDO11),
334 SAVE_ITEM(MAX8998_REG_LDO12),
335 SAVE_ITEM(MAX8998_REG_LDO13),
336 SAVE_ITEM(MAX8998_REG_LDO14),
337 SAVE_ITEM(MAX8998_REG_LDO15),
338 SAVE_ITEM(MAX8998_REG_LDO16),
339 SAVE_ITEM(MAX8998_REG_LDO17),
340 SAVE_ITEM(MAX8998_REG_BKCHR),
341 SAVE_ITEM(MAX8998_REG_LBCNFG1),
342 SAVE_ITEM(MAX8998_REG_LBCNFG2),
343};
344/* Save registers before hibernation */
345static int max8998_freeze(struct device *dev)
346{
Geliang Tang1b5420e2015-12-28 23:00:14 +0800347 struct i2c_client *i2c = to_i2c_client(dev);
MyungJoo Hamcdd137c2010-12-23 17:53:36 +0900348 int i;
349
350 for (i = 0; i < ARRAY_SIZE(max8998_dump); i++)
351 max8998_read_reg(i2c, max8998_dump[i].addr,
352 &max8998_dump[i].val);
353
354 return 0;
355}
356
357/* Restore registers after hibernation */
358static int max8998_restore(struct device *dev)
359{
Geliang Tang1b5420e2015-12-28 23:00:14 +0800360 struct i2c_client *i2c = to_i2c_client(dev);
MyungJoo Hamcdd137c2010-12-23 17:53:36 +0900361 int i;
362
363 for (i = 0; i < ARRAY_SIZE(max8998_dump); i++)
364 max8998_write_reg(i2c, max8998_dump[i].addr,
365 max8998_dump[i].val);
366
367 return 0;
368}
369
Mark Brown44be0a42011-01-20 21:47:31 +0000370static const struct dev_pm_ops max8998_pm = {
MyungJoo Hamcdd137c2010-12-23 17:53:36 +0900371 .suspend = max8998_suspend,
372 .resume = max8998_resume,
373 .freeze = max8998_freeze,
374 .restore = max8998_restore,
375};
376
Kyungmin Park156f2522010-06-16 09:04:16 +0200377static struct i2c_driver max8998_i2c_driver = {
378 .driver = {
379 .name = "max8998",
MyungJoo Hamcdd137c2010-12-23 17:53:36 +0900380 .pm = &max8998_pm,
Tomasz Figaee999fb2013-06-25 16:08:10 +0200381 .of_match_table = of_match_ptr(max8998_dt_match),
Kyungmin Park156f2522010-06-16 09:04:16 +0200382 },
383 .probe = max8998_i2c_probe,
384 .remove = max8998_i2c_remove,
385 .id_table = max8998_i2c_id,
386};
387
388static int __init max8998_i2c_init(void)
389{
390 return i2c_add_driver(&max8998_i2c_driver);
391}
392/* init early so consumer devices can complete system boot */
393subsys_initcall(max8998_i2c_init);
394
395static void __exit max8998_i2c_exit(void)
396{
397 i2c_del_driver(&max8998_i2c_driver);
398}
399module_exit(max8998_i2c_exit);
400
401MODULE_DESCRIPTION("MAXIM 8998 multi-function core driver");
402MODULE_AUTHOR("Kyungmin Park <kyungmin.park@samsung.com>");
403MODULE_LICENSE("GPL");