GNU Linux-libre 4.4.289-gnu1
[releases.git] / drivers / mfd / max8997.c
1 /*
2  * max8997.c - mfd core driver for the Maxim 8966 and 8997
3  *
4  * Copyright (C) 2011 Samsung Electronics
5  * MyungJoo Ham <myungjoo.ham@smasung.com>
6  *
7  * This program is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation; either version 2 of the License, or
10  * (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, write to the Free Software
19  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
20  *
21  * This driver is based on max8998.c
22  */
23
24 #include <linux/err.h>
25 #include <linux/slab.h>
26 #include <linux/i2c.h>
27 #include <linux/of.h>
28 #include <linux/of_irq.h>
29 #include <linux/interrupt.h>
30 #include <linux/pm_runtime.h>
31 #include <linux/module.h>
32 #include <linux/mutex.h>
33 #include <linux/mfd/core.h>
34 #include <linux/mfd/max8997.h>
35 #include <linux/mfd/max8997-private.h>
36
37 #define I2C_ADDR_PMIC   (0xCC >> 1)
38 #define I2C_ADDR_MUIC   (0x4A >> 1)
39 #define I2C_ADDR_BATTERY        (0x6C >> 1)
40 #define I2C_ADDR_RTC    (0x0C >> 1)
41 #define I2C_ADDR_HAPTIC (0x90 >> 1)
42
43 static const struct mfd_cell max8997_devs[] = {
44         { .name = "max8997-pmic", },
45         { .name = "max8997-rtc", },
46         { .name = "max8997-battery", },
47         { .name = "max8997-haptic", },
48         { .name = "max8997-muic", },
49         { .name = "max8997-led", .id = 1 },
50         { .name = "max8997-led", .id = 2 },
51 };
52
53 #ifdef CONFIG_OF
54 static const struct of_device_id max8997_pmic_dt_match[] = {
55         { .compatible = "maxim,max8997-pmic", .data = (void *)TYPE_MAX8997 },
56         {},
57 };
58 MODULE_DEVICE_TABLE(of, max8997_pmic_dt_match);
59 #endif
60
61 int max8997_read_reg(struct i2c_client *i2c, u8 reg, u8 *dest)
62 {
63         struct max8997_dev *max8997 = i2c_get_clientdata(i2c);
64         int ret;
65
66         mutex_lock(&max8997->iolock);
67         ret = i2c_smbus_read_byte_data(i2c, reg);
68         mutex_unlock(&max8997->iolock);
69         if (ret < 0)
70                 return ret;
71
72         ret &= 0xff;
73         *dest = ret;
74         return 0;
75 }
76 EXPORT_SYMBOL_GPL(max8997_read_reg);
77
78 int max8997_bulk_read(struct i2c_client *i2c, u8 reg, int count, u8 *buf)
79 {
80         struct max8997_dev *max8997 = i2c_get_clientdata(i2c);
81         int ret;
82
83         mutex_lock(&max8997->iolock);
84         ret = i2c_smbus_read_i2c_block_data(i2c, reg, count, buf);
85         mutex_unlock(&max8997->iolock);
86         if (ret < 0)
87                 return ret;
88
89         return 0;
90 }
91 EXPORT_SYMBOL_GPL(max8997_bulk_read);
92
93 int max8997_write_reg(struct i2c_client *i2c, u8 reg, u8 value)
94 {
95         struct max8997_dev *max8997 = i2c_get_clientdata(i2c);
96         int ret;
97
98         mutex_lock(&max8997->iolock);
99         ret = i2c_smbus_write_byte_data(i2c, reg, value);
100         mutex_unlock(&max8997->iolock);
101         return ret;
102 }
103 EXPORT_SYMBOL_GPL(max8997_write_reg);
104
105 int max8997_bulk_write(struct i2c_client *i2c, u8 reg, int count, u8 *buf)
106 {
107         struct max8997_dev *max8997 = i2c_get_clientdata(i2c);
108         int ret;
109
110         mutex_lock(&max8997->iolock);
111         ret = i2c_smbus_write_i2c_block_data(i2c, reg, count, buf);
112         mutex_unlock(&max8997->iolock);
113         if (ret < 0)
114                 return ret;
115
116         return 0;
117 }
118 EXPORT_SYMBOL_GPL(max8997_bulk_write);
119
120 int max8997_update_reg(struct i2c_client *i2c, u8 reg, u8 val, u8 mask)
121 {
122         struct max8997_dev *max8997 = i2c_get_clientdata(i2c);
123         int ret;
124
125         mutex_lock(&max8997->iolock);
126         ret = i2c_smbus_read_byte_data(i2c, reg);
127         if (ret >= 0) {
128                 u8 old_val = ret & 0xff;
129                 u8 new_val = (val & mask) | (old_val & (~mask));
130                 ret = i2c_smbus_write_byte_data(i2c, reg, new_val);
131         }
132         mutex_unlock(&max8997->iolock);
133         return ret;
134 }
135 EXPORT_SYMBOL_GPL(max8997_update_reg);
136
137 /*
138  * Only the common platform data elements for max8997 are parsed here from the
139  * device tree. Other sub-modules of max8997 such as pmic, rtc and others have
140  * to parse their own platform data elements from device tree.
141  *
142  * The max8997 platform data structure is instantiated here and the drivers for
143  * the sub-modules need not instantiate another instance while parsing their
144  * platform data.
145  */
146 static struct max8997_platform_data *max8997_i2c_parse_dt_pdata(
147                                         struct device *dev)
148 {
149         struct max8997_platform_data *pd;
150
151         pd = devm_kzalloc(dev, sizeof(*pd), GFP_KERNEL);
152         if (!pd) {
153                 dev_err(dev, "could not allocate memory for pdata\n");
154                 return ERR_PTR(-ENOMEM);
155         }
156
157         pd->ono = irq_of_parse_and_map(dev->of_node, 1);
158
159         return pd;
160 }
161
162 static inline unsigned long max8997_i2c_get_driver_data(struct i2c_client *i2c,
163                                                 const struct i2c_device_id *id)
164 {
165         if (IS_ENABLED(CONFIG_OF) && i2c->dev.of_node) {
166                 const struct of_device_id *match;
167                 match = of_match_node(max8997_pmic_dt_match, i2c->dev.of_node);
168                 return (unsigned long)match->data;
169         }
170         return id->driver_data;
171 }
172
173 static int max8997_i2c_probe(struct i2c_client *i2c,
174                             const struct i2c_device_id *id)
175 {
176         struct max8997_dev *max8997;
177         struct max8997_platform_data *pdata = dev_get_platdata(&i2c->dev);
178         int ret = 0;
179
180         max8997 = devm_kzalloc(&i2c->dev, sizeof(struct max8997_dev),
181                                 GFP_KERNEL);
182         if (max8997 == NULL)
183                 return -ENOMEM;
184
185         i2c_set_clientdata(i2c, max8997);
186         max8997->dev = &i2c->dev;
187         max8997->i2c = i2c;
188         max8997->type = max8997_i2c_get_driver_data(i2c, id);
189         max8997->irq = i2c->irq;
190
191         if (IS_ENABLED(CONFIG_OF) && max8997->dev->of_node) {
192                 pdata = max8997_i2c_parse_dt_pdata(max8997->dev);
193                 if (IS_ERR(pdata))
194                         return PTR_ERR(pdata);
195         }
196
197         if (!pdata)
198                 return ret;
199
200         max8997->pdata = pdata;
201         max8997->ono = pdata->ono;
202
203         mutex_init(&max8997->iolock);
204
205         max8997->rtc = i2c_new_dummy(i2c->adapter, I2C_ADDR_RTC);
206         if (!max8997->rtc) {
207                 dev_err(max8997->dev, "Failed to allocate I2C device for RTC\n");
208                 return -ENODEV;
209         }
210         i2c_set_clientdata(max8997->rtc, max8997);
211
212         max8997->haptic = i2c_new_dummy(i2c->adapter, I2C_ADDR_HAPTIC);
213         if (!max8997->haptic) {
214                 dev_err(max8997->dev, "Failed to allocate I2C device for Haptic\n");
215                 ret = -ENODEV;
216                 goto err_i2c_haptic;
217         }
218         i2c_set_clientdata(max8997->haptic, max8997);
219
220         max8997->muic = i2c_new_dummy(i2c->adapter, I2C_ADDR_MUIC);
221         if (!max8997->muic) {
222                 dev_err(max8997->dev, "Failed to allocate I2C device for MUIC\n");
223                 ret = -ENODEV;
224                 goto err_i2c_muic;
225         }
226         i2c_set_clientdata(max8997->muic, max8997);
227
228         pm_runtime_set_active(max8997->dev);
229
230         max8997_irq_init(max8997);
231
232         ret = mfd_add_devices(max8997->dev, -1, max8997_devs,
233                         ARRAY_SIZE(max8997_devs),
234                         NULL, 0, NULL);
235         if (ret < 0) {
236                 dev_err(max8997->dev, "failed to add MFD devices %d\n", ret);
237                 goto err_mfd;
238         }
239
240         /*
241          * TODO: enable others (flash, muic, rtc, battery, ...) and
242          * check the return value
243          */
244
245         /* MAX8997 has a power button input. */
246         device_init_wakeup(max8997->dev, true);
247
248         return ret;
249
250 err_mfd:
251         mfd_remove_devices(max8997->dev);
252         i2c_unregister_device(max8997->muic);
253 err_i2c_muic:
254         i2c_unregister_device(max8997->haptic);
255 err_i2c_haptic:
256         i2c_unregister_device(max8997->rtc);
257         return ret;
258 }
259
260 static int max8997_i2c_remove(struct i2c_client *i2c)
261 {
262         struct max8997_dev *max8997 = i2c_get_clientdata(i2c);
263
264         mfd_remove_devices(max8997->dev);
265         i2c_unregister_device(max8997->muic);
266         i2c_unregister_device(max8997->haptic);
267         i2c_unregister_device(max8997->rtc);
268
269         return 0;
270 }
271
272 static const struct i2c_device_id max8997_i2c_id[] = {
273         { "max8997", TYPE_MAX8997 },
274         { "max8966", TYPE_MAX8966 },
275         { }
276 };
277 MODULE_DEVICE_TABLE(i2c, max8998_i2c_id);
278
279 static u8 max8997_dumpaddr_pmic[] = {
280         MAX8997_REG_INT1MSK,
281         MAX8997_REG_INT2MSK,
282         MAX8997_REG_INT3MSK,
283         MAX8997_REG_INT4MSK,
284         MAX8997_REG_MAINCON1,
285         MAX8997_REG_MAINCON2,
286         MAX8997_REG_BUCKRAMP,
287         MAX8997_REG_BUCK1CTRL,
288         MAX8997_REG_BUCK1DVS1,
289         MAX8997_REG_BUCK1DVS2,
290         MAX8997_REG_BUCK1DVS3,
291         MAX8997_REG_BUCK1DVS4,
292         MAX8997_REG_BUCK1DVS5,
293         MAX8997_REG_BUCK1DVS6,
294         MAX8997_REG_BUCK1DVS7,
295         MAX8997_REG_BUCK1DVS8,
296         MAX8997_REG_BUCK2CTRL,
297         MAX8997_REG_BUCK2DVS1,
298         MAX8997_REG_BUCK2DVS2,
299         MAX8997_REG_BUCK2DVS3,
300         MAX8997_REG_BUCK2DVS4,
301         MAX8997_REG_BUCK2DVS5,
302         MAX8997_REG_BUCK2DVS6,
303         MAX8997_REG_BUCK2DVS7,
304         MAX8997_REG_BUCK2DVS8,
305         MAX8997_REG_BUCK3CTRL,
306         MAX8997_REG_BUCK3DVS,
307         MAX8997_REG_BUCK4CTRL,
308         MAX8997_REG_BUCK4DVS,
309         MAX8997_REG_BUCK5CTRL,
310         MAX8997_REG_BUCK5DVS1,
311         MAX8997_REG_BUCK5DVS2,
312         MAX8997_REG_BUCK5DVS3,
313         MAX8997_REG_BUCK5DVS4,
314         MAX8997_REG_BUCK5DVS5,
315         MAX8997_REG_BUCK5DVS6,
316         MAX8997_REG_BUCK5DVS7,
317         MAX8997_REG_BUCK5DVS8,
318         MAX8997_REG_BUCK6CTRL,
319         MAX8997_REG_BUCK6BPSKIPCTRL,
320         MAX8997_REG_BUCK7CTRL,
321         MAX8997_REG_BUCK7DVS,
322         MAX8997_REG_LDO1CTRL,
323         MAX8997_REG_LDO2CTRL,
324         MAX8997_REG_LDO3CTRL,
325         MAX8997_REG_LDO4CTRL,
326         MAX8997_REG_LDO5CTRL,
327         MAX8997_REG_LDO6CTRL,
328         MAX8997_REG_LDO7CTRL,
329         MAX8997_REG_LDO8CTRL,
330         MAX8997_REG_LDO9CTRL,
331         MAX8997_REG_LDO10CTRL,
332         MAX8997_REG_LDO11CTRL,
333         MAX8997_REG_LDO12CTRL,
334         MAX8997_REG_LDO13CTRL,
335         MAX8997_REG_LDO14CTRL,
336         MAX8997_REG_LDO15CTRL,
337         MAX8997_REG_LDO16CTRL,
338         MAX8997_REG_LDO17CTRL,
339         MAX8997_REG_LDO18CTRL,
340         MAX8997_REG_LDO21CTRL,
341         MAX8997_REG_MBCCTRL1,
342         MAX8997_REG_MBCCTRL2,
343         MAX8997_REG_MBCCTRL3,
344         MAX8997_REG_MBCCTRL4,
345         MAX8997_REG_MBCCTRL5,
346         MAX8997_REG_MBCCTRL6,
347         MAX8997_REG_OTPCGHCVS,
348         MAX8997_REG_SAFEOUTCTRL,
349         MAX8997_REG_LBCNFG1,
350         MAX8997_REG_LBCNFG2,
351         MAX8997_REG_BBCCTRL,
352
353         MAX8997_REG_FLASH1_CUR,
354         MAX8997_REG_FLASH2_CUR,
355         MAX8997_REG_MOVIE_CUR,
356         MAX8997_REG_GSMB_CUR,
357         MAX8997_REG_BOOST_CNTL,
358         MAX8997_REG_LEN_CNTL,
359         MAX8997_REG_FLASH_CNTL,
360         MAX8997_REG_WDT_CNTL,
361         MAX8997_REG_MAXFLASH1,
362         MAX8997_REG_MAXFLASH2,
363         MAX8997_REG_FLASHSTATUSMASK,
364
365         MAX8997_REG_GPIOCNTL1,
366         MAX8997_REG_GPIOCNTL2,
367         MAX8997_REG_GPIOCNTL3,
368         MAX8997_REG_GPIOCNTL4,
369         MAX8997_REG_GPIOCNTL5,
370         MAX8997_REG_GPIOCNTL6,
371         MAX8997_REG_GPIOCNTL7,
372         MAX8997_REG_GPIOCNTL8,
373         MAX8997_REG_GPIOCNTL9,
374         MAX8997_REG_GPIOCNTL10,
375         MAX8997_REG_GPIOCNTL11,
376         MAX8997_REG_GPIOCNTL12,
377
378         MAX8997_REG_LDO1CONFIG,
379         MAX8997_REG_LDO2CONFIG,
380         MAX8997_REG_LDO3CONFIG,
381         MAX8997_REG_LDO4CONFIG,
382         MAX8997_REG_LDO5CONFIG,
383         MAX8997_REG_LDO6CONFIG,
384         MAX8997_REG_LDO7CONFIG,
385         MAX8997_REG_LDO8CONFIG,
386         MAX8997_REG_LDO9CONFIG,
387         MAX8997_REG_LDO10CONFIG,
388         MAX8997_REG_LDO11CONFIG,
389         MAX8997_REG_LDO12CONFIG,
390         MAX8997_REG_LDO13CONFIG,
391         MAX8997_REG_LDO14CONFIG,
392         MAX8997_REG_LDO15CONFIG,
393         MAX8997_REG_LDO16CONFIG,
394         MAX8997_REG_LDO17CONFIG,
395         MAX8997_REG_LDO18CONFIG,
396         MAX8997_REG_LDO21CONFIG,
397
398         MAX8997_REG_DVSOKTIMER1,
399         MAX8997_REG_DVSOKTIMER2,
400         MAX8997_REG_DVSOKTIMER4,
401         MAX8997_REG_DVSOKTIMER5,
402 };
403
404 static u8 max8997_dumpaddr_muic[] = {
405         MAX8997_MUIC_REG_INTMASK1,
406         MAX8997_MUIC_REG_INTMASK2,
407         MAX8997_MUIC_REG_INTMASK3,
408         MAX8997_MUIC_REG_CDETCTRL,
409         MAX8997_MUIC_REG_CONTROL1,
410         MAX8997_MUIC_REG_CONTROL2,
411         MAX8997_MUIC_REG_CONTROL3,
412 };
413
414 static u8 max8997_dumpaddr_haptic[] = {
415         MAX8997_HAPTIC_REG_CONF1,
416         MAX8997_HAPTIC_REG_CONF2,
417         MAX8997_HAPTIC_REG_DRVCONF,
418         MAX8997_HAPTIC_REG_CYCLECONF1,
419         MAX8997_HAPTIC_REG_CYCLECONF2,
420         MAX8997_HAPTIC_REG_SIGCONF1,
421         MAX8997_HAPTIC_REG_SIGCONF2,
422         MAX8997_HAPTIC_REG_SIGCONF3,
423         MAX8997_HAPTIC_REG_SIGCONF4,
424         MAX8997_HAPTIC_REG_SIGDC1,
425         MAX8997_HAPTIC_REG_SIGDC2,
426         MAX8997_HAPTIC_REG_SIGPWMDC1,
427         MAX8997_HAPTIC_REG_SIGPWMDC2,
428         MAX8997_HAPTIC_REG_SIGPWMDC3,
429         MAX8997_HAPTIC_REG_SIGPWMDC4,
430 };
431
432 static int max8997_freeze(struct device *dev)
433 {
434         struct i2c_client *i2c = container_of(dev, struct i2c_client, dev);
435         struct max8997_dev *max8997 = i2c_get_clientdata(i2c);
436         int i;
437
438         for (i = 0; i < ARRAY_SIZE(max8997_dumpaddr_pmic); i++)
439                 max8997_read_reg(i2c, max8997_dumpaddr_pmic[i],
440                                 &max8997->reg_dump[i]);
441
442         for (i = 0; i < ARRAY_SIZE(max8997_dumpaddr_muic); i++)
443                 max8997_read_reg(i2c, max8997_dumpaddr_muic[i],
444                                 &max8997->reg_dump[i + MAX8997_REG_PMIC_END]);
445
446         for (i = 0; i < ARRAY_SIZE(max8997_dumpaddr_haptic); i++)
447                 max8997_read_reg(i2c, max8997_dumpaddr_haptic[i],
448                                 &max8997->reg_dump[i + MAX8997_REG_PMIC_END +
449                                 MAX8997_MUIC_REG_END]);
450
451         return 0;
452 }
453
454 static int max8997_restore(struct device *dev)
455 {
456         struct i2c_client *i2c = container_of(dev, struct i2c_client, dev);
457         struct max8997_dev *max8997 = i2c_get_clientdata(i2c);
458         int i;
459
460         for (i = 0; i < ARRAY_SIZE(max8997_dumpaddr_pmic); i++)
461                 max8997_write_reg(i2c, max8997_dumpaddr_pmic[i],
462                                 max8997->reg_dump[i]);
463
464         for (i = 0; i < ARRAY_SIZE(max8997_dumpaddr_muic); i++)
465                 max8997_write_reg(i2c, max8997_dumpaddr_muic[i],
466                                 max8997->reg_dump[i + MAX8997_REG_PMIC_END]);
467
468         for (i = 0; i < ARRAY_SIZE(max8997_dumpaddr_haptic); i++)
469                 max8997_write_reg(i2c, max8997_dumpaddr_haptic[i],
470                                 max8997->reg_dump[i + MAX8997_REG_PMIC_END +
471                                 MAX8997_MUIC_REG_END]);
472
473         return 0;
474 }
475
476 static int max8997_suspend(struct device *dev)
477 {
478         struct i2c_client *i2c = container_of(dev, struct i2c_client, dev);
479         struct max8997_dev *max8997 = i2c_get_clientdata(i2c);
480
481         if (device_may_wakeup(dev))
482                 irq_set_irq_wake(max8997->irq, 1);
483         return 0;
484 }
485
486 static int max8997_resume(struct device *dev)
487 {
488         struct i2c_client *i2c = container_of(dev, struct i2c_client, dev);
489         struct max8997_dev *max8997 = i2c_get_clientdata(i2c);
490
491         if (device_may_wakeup(dev))
492                 irq_set_irq_wake(max8997->irq, 0);
493         return max8997_irq_resume(max8997);
494 }
495
496 static const struct dev_pm_ops max8997_pm = {
497         .suspend = max8997_suspend,
498         .resume = max8997_resume,
499         .freeze = max8997_freeze,
500         .restore = max8997_restore,
501 };
502
503 static struct i2c_driver max8997_i2c_driver = {
504         .driver = {
505                    .name = "max8997",
506                    .pm = &max8997_pm,
507                    .of_match_table = of_match_ptr(max8997_pmic_dt_match),
508         },
509         .probe = max8997_i2c_probe,
510         .remove = max8997_i2c_remove,
511         .id_table = max8997_i2c_id,
512 };
513
514 static int __init max8997_i2c_init(void)
515 {
516         return i2c_add_driver(&max8997_i2c_driver);
517 }
518 /* init early so consumer devices can complete system boot */
519 subsys_initcall(max8997_i2c_init);
520
521 static void __exit max8997_i2c_exit(void)
522 {
523         i2c_del_driver(&max8997_i2c_driver);
524 }
525 module_exit(max8997_i2c_exit);
526
527 MODULE_DESCRIPTION("MAXIM 8997 multi-function core driver");
528 MODULE_AUTHOR("MyungJoo Ham <myungjoo.ham@samsung.com>");
529 MODULE_LICENSE("GPL");