xref: /openbmc/linux/drivers/mfd/sec-core.c (revision 8e9356c6)
1 /*
2  * sec-core.c
3  *
4  * Copyright (c) 2012 Samsung Electronics Co., Ltd
5  *              http://www.samsung.com
6  *
7  *  This program is free software; you can redistribute  it and/or modify it
8  *  under  the terms of  the GNU General  Public License as published by the
9  *  Free Software Foundation;  either version 2 of the  License, or (at your
10  *  option) any later version.
11  *
12  */
13 
14 #include <linux/module.h>
15 #include <linux/moduleparam.h>
16 #include <linux/init.h>
17 #include <linux/err.h>
18 #include <linux/slab.h>
19 #include <linux/i2c.h>
20 #include <linux/of.h>
21 #include <linux/of_irq.h>
22 #include <linux/interrupt.h>
23 #include <linux/pm_runtime.h>
24 #include <linux/mutex.h>
25 #include <linux/mfd/core.h>
26 #include <linux/mfd/samsung/core.h>
27 #include <linux/mfd/samsung/irq.h>
28 #include <linux/mfd/samsung/rtc.h>
29 #include <linux/mfd/samsung/s2mps11.h>
30 #include <linux/mfd/samsung/s5m8763.h>
31 #include <linux/mfd/samsung/s5m8767.h>
32 #include <linux/regmap.h>
33 
34 static const struct mfd_cell s5m8751_devs[] = {
35 	{
36 		.name = "s5m8751-pmic",
37 	}, {
38 		.name = "s5m-charger",
39 	}, {
40 		.name = "s5m8751-codec",
41 	},
42 };
43 
44 static const struct mfd_cell s5m8763_devs[] = {
45 	{
46 		.name = "s5m8763-pmic",
47 	}, {
48 		.name = "s5m-rtc",
49 	}, {
50 		.name = "s5m-charger",
51 	},
52 };
53 
54 static const struct mfd_cell s5m8767_devs[] = {
55 	{
56 		.name = "s5m8767-pmic",
57 	}, {
58 		.name = "s5m-rtc",
59 	}, {
60 		.name = "s5m8767-clk",
61 	}
62 };
63 
64 static const struct mfd_cell s2mps11_devs[] = {
65 	{
66 		.name = "s2mps11-pmic",
67 	}, {
68 		.name = "s2mps11-clk",
69 	}
70 };
71 
72 #ifdef CONFIG_OF
73 static struct of_device_id sec_dt_match[] = {
74 	{	.compatible = "samsung,s5m8767-pmic",
75 		.data = (void *)S5M8767X,
76 	},
77 	{	.compatible = "samsung,s2mps11-pmic",
78 		.data = (void *)S2MPS11X,
79 	},
80 	{},
81 };
82 #endif
83 
84 static bool s2mps11_volatile(struct device *dev, unsigned int reg)
85 {
86 	switch (reg) {
87 	case S2MPS11_REG_INT1M:
88 	case S2MPS11_REG_INT2M:
89 	case S2MPS11_REG_INT3M:
90 		return false;
91 	default:
92 		return true;
93 	}
94 }
95 
96 static bool s5m8763_volatile(struct device *dev, unsigned int reg)
97 {
98 	switch (reg) {
99 	case S5M8763_REG_IRQM1:
100 	case S5M8763_REG_IRQM2:
101 	case S5M8763_REG_IRQM3:
102 	case S5M8763_REG_IRQM4:
103 		return false;
104 	default:
105 		return true;
106 	}
107 }
108 
109 static const struct regmap_config sec_regmap_config = {
110 	.reg_bits = 8,
111 	.val_bits = 8,
112 };
113 
114 static const struct regmap_config s2mps11_regmap_config = {
115 	.reg_bits = 8,
116 	.val_bits = 8,
117 
118 	.max_register = S2MPS11_REG_L38CTRL,
119 	.volatile_reg = s2mps11_volatile,
120 	.cache_type = REGCACHE_FLAT,
121 };
122 
123 static const struct regmap_config s5m8763_regmap_config = {
124 	.reg_bits = 8,
125 	.val_bits = 8,
126 
127 	.max_register = S5M8763_REG_LBCNFG2,
128 	.volatile_reg = s5m8763_volatile,
129 	.cache_type = REGCACHE_FLAT,
130 };
131 
132 static const struct regmap_config s5m8767_regmap_config = {
133 	.reg_bits = 8,
134 	.val_bits = 8,
135 
136 	.max_register = S5M8767_REG_LDO28CTRL,
137 	.volatile_reg = s2mps11_volatile,
138 	.cache_type = REGCACHE_FLAT,
139 };
140 
141 static const struct regmap_config sec_rtc_regmap_config = {
142 	.reg_bits = 8,
143 	.val_bits = 8,
144 };
145 
146 #ifdef CONFIG_OF
147 /*
148  * Only the common platform data elements for s5m8767 are parsed here from the
149  * device tree. Other sub-modules of s5m8767 such as pmic, rtc , charger and
150  * others have to parse their own platform data elements from device tree.
151  *
152  * The s5m8767 platform data structure is instantiated here and the drivers for
153  * the sub-modules need not instantiate another instance while parsing their
154  * platform data.
155  */
156 static struct sec_platform_data *sec_pmic_i2c_parse_dt_pdata(
157 					struct device *dev)
158 {
159 	struct sec_platform_data *pd;
160 
161 	pd = devm_kzalloc(dev, sizeof(*pd), GFP_KERNEL);
162 	if (!pd) {
163 		dev_err(dev, "could not allocate memory for pdata\n");
164 		return ERR_PTR(-ENOMEM);
165 	}
166 
167 	/*
168 	 * ToDo: the 'wakeup' member in the platform data is more of a linux
169 	 * specfic information. Hence, there is no binding for that yet and
170 	 * not parsed here.
171 	 */
172 
173 	return pd;
174 }
175 #else
176 static struct sec_platform_data *sec_pmic_i2c_parse_dt_pdata(
177 					struct device *dev)
178 {
179 	return NULL;
180 }
181 #endif
182 
183 static inline int sec_i2c_get_driver_data(struct i2c_client *i2c,
184 						const struct i2c_device_id *id)
185 {
186 #ifdef CONFIG_OF
187 	if (i2c->dev.of_node) {
188 		const struct of_device_id *match;
189 		match = of_match_node(sec_dt_match, i2c->dev.of_node);
190 		return (int)match->data;
191 	}
192 #endif
193 	return (int)id->driver_data;
194 }
195 
196 static int sec_pmic_probe(struct i2c_client *i2c,
197 			    const struct i2c_device_id *id)
198 {
199 	struct sec_platform_data *pdata = dev_get_platdata(&i2c->dev);
200 	const struct regmap_config *regmap;
201 	struct sec_pmic_dev *sec_pmic;
202 	int ret;
203 
204 	sec_pmic = devm_kzalloc(&i2c->dev, sizeof(struct sec_pmic_dev),
205 				GFP_KERNEL);
206 	if (sec_pmic == NULL)
207 		return -ENOMEM;
208 
209 	i2c_set_clientdata(i2c, sec_pmic);
210 	sec_pmic->dev = &i2c->dev;
211 	sec_pmic->i2c = i2c;
212 	sec_pmic->irq = i2c->irq;
213 	sec_pmic->type = sec_i2c_get_driver_data(i2c, id);
214 
215 	if (sec_pmic->dev->of_node) {
216 		pdata = sec_pmic_i2c_parse_dt_pdata(sec_pmic->dev);
217 		if (IS_ERR(pdata)) {
218 			ret = PTR_ERR(pdata);
219 			return ret;
220 		}
221 		pdata->device_type = sec_pmic->type;
222 	}
223 	if (pdata) {
224 		sec_pmic->device_type = pdata->device_type;
225 		sec_pmic->ono = pdata->ono;
226 		sec_pmic->irq_base = pdata->irq_base;
227 		sec_pmic->wakeup = pdata->wakeup;
228 		sec_pmic->pdata = pdata;
229 	}
230 
231 	switch (sec_pmic->device_type) {
232 	case S2MPS11X:
233 		regmap = &s2mps11_regmap_config;
234 		break;
235 	case S5M8763X:
236 		regmap = &s5m8763_regmap_config;
237 		break;
238 	case S5M8767X:
239 		regmap = &s5m8767_regmap_config;
240 		break;
241 	default:
242 		regmap = &sec_regmap_config;
243 		break;
244 	}
245 
246 	sec_pmic->regmap_pmic = devm_regmap_init_i2c(i2c, regmap);
247 	if (IS_ERR(sec_pmic->regmap_pmic)) {
248 		ret = PTR_ERR(sec_pmic->regmap_pmic);
249 		dev_err(&i2c->dev, "Failed to allocate register map: %d\n",
250 			ret);
251 		return ret;
252 	}
253 
254 	sec_pmic->rtc = i2c_new_dummy(i2c->adapter, RTC_I2C_ADDR);
255 	i2c_set_clientdata(sec_pmic->rtc, sec_pmic);
256 
257 	sec_pmic->regmap_rtc = devm_regmap_init_i2c(sec_pmic->rtc,
258 			&sec_rtc_regmap_config);
259 	if (IS_ERR(sec_pmic->regmap_rtc)) {
260 		ret = PTR_ERR(sec_pmic->regmap_rtc);
261 		dev_err(&i2c->dev, "Failed to allocate RTC register map: %d\n",
262 			ret);
263 		return ret;
264 	}
265 
266 	if (pdata && pdata->cfg_pmic_irq)
267 		pdata->cfg_pmic_irq();
268 
269 	sec_irq_init(sec_pmic);
270 
271 	pm_runtime_set_active(sec_pmic->dev);
272 
273 	switch (sec_pmic->device_type) {
274 	case S5M8751X:
275 		ret = mfd_add_devices(sec_pmic->dev, -1, s5m8751_devs,
276 				      ARRAY_SIZE(s5m8751_devs), NULL, 0, NULL);
277 		break;
278 	case S5M8763X:
279 		ret = mfd_add_devices(sec_pmic->dev, -1, s5m8763_devs,
280 				      ARRAY_SIZE(s5m8763_devs), NULL, 0, NULL);
281 		break;
282 	case S5M8767X:
283 		ret = mfd_add_devices(sec_pmic->dev, -1, s5m8767_devs,
284 				      ARRAY_SIZE(s5m8767_devs), NULL, 0, NULL);
285 		break;
286 	case S2MPS11X:
287 		ret = mfd_add_devices(sec_pmic->dev, -1, s2mps11_devs,
288 				      ARRAY_SIZE(s2mps11_devs), NULL, 0, NULL);
289 		break;
290 	default:
291 		/* If this happens the probe function is problem */
292 		BUG();
293 	}
294 
295 	if (ret)
296 		goto err;
297 
298 	device_init_wakeup(sec_pmic->dev, sec_pmic->wakeup);
299 
300 	return ret;
301 
302 err:
303 	sec_irq_exit(sec_pmic);
304 	i2c_unregister_device(sec_pmic->rtc);
305 	return ret;
306 }
307 
308 static int sec_pmic_remove(struct i2c_client *i2c)
309 {
310 	struct sec_pmic_dev *sec_pmic = i2c_get_clientdata(i2c);
311 
312 	mfd_remove_devices(sec_pmic->dev);
313 	sec_irq_exit(sec_pmic);
314 	i2c_unregister_device(sec_pmic->rtc);
315 	return 0;
316 }
317 
318 static int sec_pmic_suspend(struct device *dev)
319 {
320 	struct i2c_client *i2c = container_of(dev, struct i2c_client, dev);
321 	struct sec_pmic_dev *sec_pmic = i2c_get_clientdata(i2c);
322 
323 	if (device_may_wakeup(dev)) {
324 		enable_irq_wake(sec_pmic->irq);
325 		/*
326 		 * PMIC IRQ must be disabled during suspend for RTC alarm
327 		 * to work properly.
328 		 * When device is woken up from suspend by RTC Alarm, an
329 		 * interrupt occurs before resuming I2C bus controller.
330 		 * The interrupt is handled by regmap_irq_thread which tries
331 		 * to read RTC registers. This read fails (I2C is still
332 		 * suspended) and RTC Alarm interrupt is disabled.
333 		 */
334 		disable_irq(sec_pmic->irq);
335 	}
336 
337 	return 0;
338 }
339 
340 static int sec_pmic_resume(struct device *dev)
341 {
342 	struct i2c_client *i2c = container_of(dev, struct i2c_client, dev);
343 	struct sec_pmic_dev *sec_pmic = i2c_get_clientdata(i2c);
344 
345 	if (device_may_wakeup(dev)) {
346 		disable_irq_wake(sec_pmic->irq);
347 		enable_irq(sec_pmic->irq);
348 	}
349 
350 	return 0;
351 }
352 
353 static SIMPLE_DEV_PM_OPS(sec_pmic_pm_ops, sec_pmic_suspend, sec_pmic_resume);
354 
355 static const struct i2c_device_id sec_pmic_id[] = {
356 	{ "sec_pmic", 0 },
357 	{ }
358 };
359 MODULE_DEVICE_TABLE(i2c, sec_pmic_id);
360 
361 static struct i2c_driver sec_pmic_driver = {
362 	.driver = {
363 		   .name = "sec_pmic",
364 		   .owner = THIS_MODULE,
365 		   .pm = &sec_pmic_pm_ops,
366 		   .of_match_table = of_match_ptr(sec_dt_match),
367 	},
368 	.probe = sec_pmic_probe,
369 	.remove = sec_pmic_remove,
370 	.id_table = sec_pmic_id,
371 };
372 
373 static int __init sec_pmic_init(void)
374 {
375 	return i2c_add_driver(&sec_pmic_driver);
376 }
377 
378 subsys_initcall(sec_pmic_init);
379 
380 static void __exit sec_pmic_exit(void)
381 {
382 	i2c_del_driver(&sec_pmic_driver);
383 }
384 module_exit(sec_pmic_exit);
385 
386 MODULE_AUTHOR("Sangbeom Kim <sbkim73@samsung.com>");
387 MODULE_DESCRIPTION("Core support for the S5M MFD");
388 MODULE_LICENSE("GPL");
389