xref: /openbmc/linux/drivers/mfd/max8997.c (revision 9c1f8594)
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/slab.h>
25 #include <linux/i2c.h>
26 #include <linux/pm_runtime.h>
27 #include <linux/mutex.h>
28 #include <linux/mfd/core.h>
29 #include <linux/mfd/max8997.h>
30 #include <linux/mfd/max8997-private.h>
31 
32 #define I2C_ADDR_PMIC	(0xCC >> 1)
33 #define I2C_ADDR_MUIC	(0x4A >> 1)
34 #define I2C_ADDR_BATTERY	(0x6C >> 1)
35 #define I2C_ADDR_RTC	(0x0C >> 1)
36 #define I2C_ADDR_HAPTIC	(0x90 >> 1)
37 
38 static struct mfd_cell max8997_devs[] = {
39 	{ .name = "max8997-pmic", },
40 	{ .name = "max8997-rtc", },
41 	{ .name = "max8997-battery", },
42 	{ .name = "max8997-haptic", },
43 	{ .name = "max8997-muic", },
44 	{ .name = "max8997-flash", },
45 };
46 
47 int max8997_read_reg(struct i2c_client *i2c, u8 reg, u8 *dest)
48 {
49 	struct max8997_dev *max8997 = i2c_get_clientdata(i2c);
50 	int ret;
51 
52 	mutex_lock(&max8997->iolock);
53 	ret = i2c_smbus_read_byte_data(i2c, reg);
54 	mutex_unlock(&max8997->iolock);
55 	if (ret < 0)
56 		return ret;
57 
58 	ret &= 0xff;
59 	*dest = ret;
60 	return 0;
61 }
62 EXPORT_SYMBOL_GPL(max8997_read_reg);
63 
64 int max8997_bulk_read(struct i2c_client *i2c, u8 reg, int count, u8 *buf)
65 {
66 	struct max8997_dev *max8997 = i2c_get_clientdata(i2c);
67 	int ret;
68 
69 	mutex_lock(&max8997->iolock);
70 	ret = i2c_smbus_read_i2c_block_data(i2c, reg, count, buf);
71 	mutex_unlock(&max8997->iolock);
72 	if (ret < 0)
73 		return ret;
74 
75 	return 0;
76 }
77 EXPORT_SYMBOL_GPL(max8997_bulk_read);
78 
79 int max8997_write_reg(struct i2c_client *i2c, u8 reg, u8 value)
80 {
81 	struct max8997_dev *max8997 = i2c_get_clientdata(i2c);
82 	int ret;
83 
84 	mutex_lock(&max8997->iolock);
85 	ret = i2c_smbus_write_byte_data(i2c, reg, value);
86 	mutex_unlock(&max8997->iolock);
87 	return ret;
88 }
89 EXPORT_SYMBOL_GPL(max8997_write_reg);
90 
91 int max8997_bulk_write(struct i2c_client *i2c, u8 reg, int count, u8 *buf)
92 {
93 	struct max8997_dev *max8997 = i2c_get_clientdata(i2c);
94 	int ret;
95 
96 	mutex_lock(&max8997->iolock);
97 	ret = i2c_smbus_write_i2c_block_data(i2c, reg, count, buf);
98 	mutex_unlock(&max8997->iolock);
99 	if (ret < 0)
100 		return ret;
101 
102 	return 0;
103 }
104 EXPORT_SYMBOL_GPL(max8997_bulk_write);
105 
106 int max8997_update_reg(struct i2c_client *i2c, u8 reg, u8 val, u8 mask)
107 {
108 	struct max8997_dev *max8997 = i2c_get_clientdata(i2c);
109 	int ret;
110 
111 	mutex_lock(&max8997->iolock);
112 	ret = i2c_smbus_read_byte_data(i2c, reg);
113 	if (ret >= 0) {
114 		u8 old_val = ret & 0xff;
115 		u8 new_val = (val & mask) | (old_val & (~mask));
116 		ret = i2c_smbus_write_byte_data(i2c, reg, new_val);
117 	}
118 	mutex_unlock(&max8997->iolock);
119 	return ret;
120 }
121 EXPORT_SYMBOL_GPL(max8997_update_reg);
122 
123 static int max8997_i2c_probe(struct i2c_client *i2c,
124 			    const struct i2c_device_id *id)
125 {
126 	struct max8997_dev *max8997;
127 	struct max8997_platform_data *pdata = i2c->dev.platform_data;
128 	int ret = 0;
129 
130 	max8997 = kzalloc(sizeof(struct max8997_dev), GFP_KERNEL);
131 	if (max8997 == NULL)
132 		return -ENOMEM;
133 
134 	i2c_set_clientdata(i2c, max8997);
135 	max8997->dev = &i2c->dev;
136 	max8997->i2c = i2c;
137 	max8997->type = id->driver_data;
138 	max8997->irq = i2c->irq;
139 
140 	if (!pdata)
141 		goto err;
142 
143 	max8997->irq_base = pdata->irq_base;
144 	max8997->ono = pdata->ono;
145 	max8997->wakeup = pdata->wakeup;
146 
147 	mutex_init(&max8997->iolock);
148 
149 	max8997->rtc = i2c_new_dummy(i2c->adapter, I2C_ADDR_RTC);
150 	i2c_set_clientdata(max8997->rtc, max8997);
151 	max8997->haptic = i2c_new_dummy(i2c->adapter, I2C_ADDR_HAPTIC);
152 	i2c_set_clientdata(max8997->haptic, max8997);
153 	max8997->muic = i2c_new_dummy(i2c->adapter, I2C_ADDR_MUIC);
154 	i2c_set_clientdata(max8997->muic, max8997);
155 
156 	pm_runtime_set_active(max8997->dev);
157 
158 	max8997_irq_init(max8997);
159 
160 	mfd_add_devices(max8997->dev, -1, max8997_devs,
161 			ARRAY_SIZE(max8997_devs),
162 			NULL, 0);
163 
164 	/*
165 	 * TODO: enable others (flash, muic, rtc, battery, ...) and
166 	 * check the return value
167 	 */
168 
169 	if (ret < 0)
170 		goto err_mfd;
171 
172 	return ret;
173 
174 err_mfd:
175 	mfd_remove_devices(max8997->dev);
176 	i2c_unregister_device(max8997->muic);
177 	i2c_unregister_device(max8997->haptic);
178 	i2c_unregister_device(max8997->rtc);
179 err:
180 	kfree(max8997);
181 	return ret;
182 }
183 
184 static int max8997_i2c_remove(struct i2c_client *i2c)
185 {
186 	struct max8997_dev *max8997 = i2c_get_clientdata(i2c);
187 
188 	mfd_remove_devices(max8997->dev);
189 	i2c_unregister_device(max8997->muic);
190 	i2c_unregister_device(max8997->haptic);
191 	i2c_unregister_device(max8997->rtc);
192 	kfree(max8997);
193 
194 	return 0;
195 }
196 
197 static const struct i2c_device_id max8997_i2c_id[] = {
198 	{ "max8997", TYPE_MAX8997 },
199 	{ "max8966", TYPE_MAX8966 },
200 	{ }
201 };
202 MODULE_DEVICE_TABLE(i2c, max8998_i2c_id);
203 
204 u8 max8997_dumpaddr_pmic[] = {
205 	MAX8997_REG_INT1MSK,
206 	MAX8997_REG_INT2MSK,
207 	MAX8997_REG_INT3MSK,
208 	MAX8997_REG_INT4MSK,
209 	MAX8997_REG_MAINCON1,
210 	MAX8997_REG_MAINCON2,
211 	MAX8997_REG_BUCKRAMP,
212 	MAX8997_REG_BUCK1CTRL,
213 	MAX8997_REG_BUCK1DVS1,
214 	MAX8997_REG_BUCK1DVS2,
215 	MAX8997_REG_BUCK1DVS3,
216 	MAX8997_REG_BUCK1DVS4,
217 	MAX8997_REG_BUCK1DVS5,
218 	MAX8997_REG_BUCK1DVS6,
219 	MAX8997_REG_BUCK1DVS7,
220 	MAX8997_REG_BUCK1DVS8,
221 	MAX8997_REG_BUCK2CTRL,
222 	MAX8997_REG_BUCK2DVS1,
223 	MAX8997_REG_BUCK2DVS2,
224 	MAX8997_REG_BUCK2DVS3,
225 	MAX8997_REG_BUCK2DVS4,
226 	MAX8997_REG_BUCK2DVS5,
227 	MAX8997_REG_BUCK2DVS6,
228 	MAX8997_REG_BUCK2DVS7,
229 	MAX8997_REG_BUCK2DVS8,
230 	MAX8997_REG_BUCK3CTRL,
231 	MAX8997_REG_BUCK3DVS,
232 	MAX8997_REG_BUCK4CTRL,
233 	MAX8997_REG_BUCK4DVS,
234 	MAX8997_REG_BUCK5CTRL,
235 	MAX8997_REG_BUCK5DVS1,
236 	MAX8997_REG_BUCK5DVS2,
237 	MAX8997_REG_BUCK5DVS3,
238 	MAX8997_REG_BUCK5DVS4,
239 	MAX8997_REG_BUCK5DVS5,
240 	MAX8997_REG_BUCK5DVS6,
241 	MAX8997_REG_BUCK5DVS7,
242 	MAX8997_REG_BUCK5DVS8,
243 	MAX8997_REG_BUCK6CTRL,
244 	MAX8997_REG_BUCK6BPSKIPCTRL,
245 	MAX8997_REG_BUCK7CTRL,
246 	MAX8997_REG_BUCK7DVS,
247 	MAX8997_REG_LDO1CTRL,
248 	MAX8997_REG_LDO2CTRL,
249 	MAX8997_REG_LDO3CTRL,
250 	MAX8997_REG_LDO4CTRL,
251 	MAX8997_REG_LDO5CTRL,
252 	MAX8997_REG_LDO6CTRL,
253 	MAX8997_REG_LDO7CTRL,
254 	MAX8997_REG_LDO8CTRL,
255 	MAX8997_REG_LDO9CTRL,
256 	MAX8997_REG_LDO10CTRL,
257 	MAX8997_REG_LDO11CTRL,
258 	MAX8997_REG_LDO12CTRL,
259 	MAX8997_REG_LDO13CTRL,
260 	MAX8997_REG_LDO14CTRL,
261 	MAX8997_REG_LDO15CTRL,
262 	MAX8997_REG_LDO16CTRL,
263 	MAX8997_REG_LDO17CTRL,
264 	MAX8997_REG_LDO18CTRL,
265 	MAX8997_REG_LDO21CTRL,
266 	MAX8997_REG_MBCCTRL1,
267 	MAX8997_REG_MBCCTRL2,
268 	MAX8997_REG_MBCCTRL3,
269 	MAX8997_REG_MBCCTRL4,
270 	MAX8997_REG_MBCCTRL5,
271 	MAX8997_REG_MBCCTRL6,
272 	MAX8997_REG_OTPCGHCVS,
273 	MAX8997_REG_SAFEOUTCTRL,
274 	MAX8997_REG_LBCNFG1,
275 	MAX8997_REG_LBCNFG2,
276 	MAX8997_REG_BBCCTRL,
277 
278 	MAX8997_REG_FLASH1_CUR,
279 	MAX8997_REG_FLASH2_CUR,
280 	MAX8997_REG_MOVIE_CUR,
281 	MAX8997_REG_GSMB_CUR,
282 	MAX8997_REG_BOOST_CNTL,
283 	MAX8997_REG_LEN_CNTL,
284 	MAX8997_REG_FLASH_CNTL,
285 	MAX8997_REG_WDT_CNTL,
286 	MAX8997_REG_MAXFLASH1,
287 	MAX8997_REG_MAXFLASH2,
288 	MAX8997_REG_FLASHSTATUSMASK,
289 
290 	MAX8997_REG_GPIOCNTL1,
291 	MAX8997_REG_GPIOCNTL2,
292 	MAX8997_REG_GPIOCNTL3,
293 	MAX8997_REG_GPIOCNTL4,
294 	MAX8997_REG_GPIOCNTL5,
295 	MAX8997_REG_GPIOCNTL6,
296 	MAX8997_REG_GPIOCNTL7,
297 	MAX8997_REG_GPIOCNTL8,
298 	MAX8997_REG_GPIOCNTL9,
299 	MAX8997_REG_GPIOCNTL10,
300 	MAX8997_REG_GPIOCNTL11,
301 	MAX8997_REG_GPIOCNTL12,
302 
303 	MAX8997_REG_LDO1CONFIG,
304 	MAX8997_REG_LDO2CONFIG,
305 	MAX8997_REG_LDO3CONFIG,
306 	MAX8997_REG_LDO4CONFIG,
307 	MAX8997_REG_LDO5CONFIG,
308 	MAX8997_REG_LDO6CONFIG,
309 	MAX8997_REG_LDO7CONFIG,
310 	MAX8997_REG_LDO8CONFIG,
311 	MAX8997_REG_LDO9CONFIG,
312 	MAX8997_REG_LDO10CONFIG,
313 	MAX8997_REG_LDO11CONFIG,
314 	MAX8997_REG_LDO12CONFIG,
315 	MAX8997_REG_LDO13CONFIG,
316 	MAX8997_REG_LDO14CONFIG,
317 	MAX8997_REG_LDO15CONFIG,
318 	MAX8997_REG_LDO16CONFIG,
319 	MAX8997_REG_LDO17CONFIG,
320 	MAX8997_REG_LDO18CONFIG,
321 	MAX8997_REG_LDO21CONFIG,
322 
323 	MAX8997_REG_DVSOKTIMER1,
324 	MAX8997_REG_DVSOKTIMER2,
325 	MAX8997_REG_DVSOKTIMER4,
326 	MAX8997_REG_DVSOKTIMER5,
327 };
328 
329 u8 max8997_dumpaddr_muic[] = {
330 	MAX8997_MUIC_REG_INTMASK1,
331 	MAX8997_MUIC_REG_INTMASK2,
332 	MAX8997_MUIC_REG_INTMASK3,
333 	MAX8997_MUIC_REG_CDETCTRL,
334 	MAX8997_MUIC_REG_CONTROL1,
335 	MAX8997_MUIC_REG_CONTROL2,
336 	MAX8997_MUIC_REG_CONTROL3,
337 };
338 
339 u8 max8997_dumpaddr_haptic[] = {
340 	MAX8997_HAPTIC_REG_CONF1,
341 	MAX8997_HAPTIC_REG_CONF2,
342 	MAX8997_HAPTIC_REG_DRVCONF,
343 	MAX8997_HAPTIC_REG_CYCLECONF1,
344 	MAX8997_HAPTIC_REG_CYCLECONF2,
345 	MAX8997_HAPTIC_REG_SIGCONF1,
346 	MAX8997_HAPTIC_REG_SIGCONF2,
347 	MAX8997_HAPTIC_REG_SIGCONF3,
348 	MAX8997_HAPTIC_REG_SIGCONF4,
349 	MAX8997_HAPTIC_REG_SIGDC1,
350 	MAX8997_HAPTIC_REG_SIGDC2,
351 	MAX8997_HAPTIC_REG_SIGPWMDC1,
352 	MAX8997_HAPTIC_REG_SIGPWMDC2,
353 	MAX8997_HAPTIC_REG_SIGPWMDC3,
354 	MAX8997_HAPTIC_REG_SIGPWMDC4,
355 };
356 
357 static int max8997_freeze(struct device *dev)
358 {
359 	struct i2c_client *i2c = container_of(dev, struct i2c_client, dev);
360 	struct max8997_dev *max8997 = i2c_get_clientdata(i2c);
361 	int i;
362 
363 	for (i = 0; i < ARRAY_SIZE(max8997_dumpaddr_pmic); i++)
364 		max8997_read_reg(i2c, max8997_dumpaddr_pmic[i],
365 				&max8997->reg_dump[i]);
366 
367 	for (i = 0; i < ARRAY_SIZE(max8997_dumpaddr_muic); i++)
368 		max8997_read_reg(i2c, max8997_dumpaddr_muic[i],
369 				&max8997->reg_dump[i + MAX8997_REG_PMIC_END]);
370 
371 	for (i = 0; i < ARRAY_SIZE(max8997_dumpaddr_haptic); i++)
372 		max8997_read_reg(i2c, max8997_dumpaddr_haptic[i],
373 				&max8997->reg_dump[i + MAX8997_REG_PMIC_END +
374 				MAX8997_MUIC_REG_END]);
375 
376 	return 0;
377 }
378 
379 static int max8997_restore(struct device *dev)
380 {
381 	struct i2c_client *i2c = container_of(dev, struct i2c_client, dev);
382 	struct max8997_dev *max8997 = i2c_get_clientdata(i2c);
383 	int i;
384 
385 	for (i = 0; i < ARRAY_SIZE(max8997_dumpaddr_pmic); i++)
386 		max8997_write_reg(i2c, max8997_dumpaddr_pmic[i],
387 				max8997->reg_dump[i]);
388 
389 	for (i = 0; i < ARRAY_SIZE(max8997_dumpaddr_muic); i++)
390 		max8997_write_reg(i2c, max8997_dumpaddr_muic[i],
391 				max8997->reg_dump[i + MAX8997_REG_PMIC_END]);
392 
393 	for (i = 0; i < ARRAY_SIZE(max8997_dumpaddr_haptic); i++)
394 		max8997_write_reg(i2c, max8997_dumpaddr_haptic[i],
395 				max8997->reg_dump[i + MAX8997_REG_PMIC_END +
396 				MAX8997_MUIC_REG_END]);
397 
398 	return 0;
399 }
400 
401 const struct dev_pm_ops max8997_pm = {
402 	.freeze = max8997_freeze,
403 	.restore = max8997_restore,
404 };
405 
406 static struct i2c_driver max8997_i2c_driver = {
407 	.driver = {
408 		   .name = "max8997",
409 		   .owner = THIS_MODULE,
410 		   .pm = &max8997_pm,
411 	},
412 	.probe = max8997_i2c_probe,
413 	.remove = max8997_i2c_remove,
414 	.id_table = max8997_i2c_id,
415 };
416 
417 static int __init max8997_i2c_init(void)
418 {
419 	return i2c_add_driver(&max8997_i2c_driver);
420 }
421 /* init early so consumer devices can complete system boot */
422 subsys_initcall(max8997_i2c_init);
423 
424 static void __exit max8997_i2c_exit(void)
425 {
426 	i2c_del_driver(&max8997_i2c_driver);
427 }
428 module_exit(max8997_i2c_exit);
429 
430 MODULE_DESCRIPTION("MAXIM 8997 multi-function core driver");
431 MODULE_AUTHOR("MyungJoo Ham <myungjoo.ham@samsung.com>");
432 MODULE_LICENSE("GPL");
433