x86/speculation/mds: Fix documentation typo
[linux/fpc-iii.git] / drivers / mfd / max77693.c
blob662ae0d9e33497e2eac861de437386009315a335
1 /*
2 * max77693.c - mfd core driver for the MAX 77693
4 * Copyright (C) 2012 Samsung Electronics
5 * SangYoung Son <hello.son@samsung.com>
7 * This program is not provided / owned by Maxim Integrated Products.
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
23 * This driver is based on max8997.c
26 #include <linux/module.h>
27 #include <linux/slab.h>
28 #include <linux/i2c.h>
29 #include <linux/err.h>
30 #include <linux/interrupt.h>
31 #include <linux/of.h>
32 #include <linux/pm_runtime.h>
33 #include <linux/mutex.h>
34 #include <linux/mfd/core.h>
35 #include <linux/mfd/max77693.h>
36 #include <linux/mfd/max77693-common.h>
37 #include <linux/mfd/max77693-private.h>
38 #include <linux/regulator/machine.h>
39 #include <linux/regmap.h>
41 #define I2C_ADDR_PMIC (0xCC >> 1) /* Charger, Flash LED */
42 #define I2C_ADDR_MUIC (0x4A >> 1)
43 #define I2C_ADDR_HAPTIC (0x90 >> 1)
45 static const struct mfd_cell max77693_devs[] = {
46 { .name = "max77693-pmic", },
48 .name = "max77693-charger",
49 .of_compatible = "maxim,max77693-charger",
51 { .name = "max77693-muic", },
53 .name = "max77693-haptic",
54 .of_compatible = "maxim,max77693-haptic",
57 .name = "max77693-led",
58 .of_compatible = "maxim,max77693-led",
62 static const struct regmap_config max77693_regmap_config = {
63 .reg_bits = 8,
64 .val_bits = 8,
65 .max_register = MAX77693_PMIC_REG_END,
68 static const struct regmap_irq max77693_led_irqs[] = {
69 { .mask = LED_IRQ_FLED2_OPEN, },
70 { .mask = LED_IRQ_FLED2_SHORT, },
71 { .mask = LED_IRQ_FLED1_OPEN, },
72 { .mask = LED_IRQ_FLED1_SHORT, },
73 { .mask = LED_IRQ_MAX_FLASH, },
76 static const struct regmap_irq_chip max77693_led_irq_chip = {
77 .name = "max77693-led",
78 .status_base = MAX77693_LED_REG_FLASH_INT,
79 .mask_base = MAX77693_LED_REG_FLASH_INT_MASK,
80 .mask_invert = false,
81 .num_regs = 1,
82 .irqs = max77693_led_irqs,
83 .num_irqs = ARRAY_SIZE(max77693_led_irqs),
86 static const struct regmap_irq max77693_topsys_irqs[] = {
87 { .mask = TOPSYS_IRQ_T120C_INT, },
88 { .mask = TOPSYS_IRQ_T140C_INT, },
89 { .mask = TOPSYS_IRQ_LOWSYS_INT, },
92 static const struct regmap_irq_chip max77693_topsys_irq_chip = {
93 .name = "max77693-topsys",
94 .status_base = MAX77693_PMIC_REG_TOPSYS_INT,
95 .mask_base = MAX77693_PMIC_REG_TOPSYS_INT_MASK,
96 .mask_invert = false,
97 .num_regs = 1,
98 .irqs = max77693_topsys_irqs,
99 .num_irqs = ARRAY_SIZE(max77693_topsys_irqs),
102 static const struct regmap_irq max77693_charger_irqs[] = {
103 { .mask = CHG_IRQ_BYP_I, },
104 { .mask = CHG_IRQ_THM_I, },
105 { .mask = CHG_IRQ_BAT_I, },
106 { .mask = CHG_IRQ_CHG_I, },
107 { .mask = CHG_IRQ_CHGIN_I, },
110 static const struct regmap_irq_chip max77693_charger_irq_chip = {
111 .name = "max77693-charger",
112 .status_base = MAX77693_CHG_REG_CHG_INT,
113 .mask_base = MAX77693_CHG_REG_CHG_INT_MASK,
114 .mask_invert = false,
115 .num_regs = 1,
116 .irqs = max77693_charger_irqs,
117 .num_irqs = ARRAY_SIZE(max77693_charger_irqs),
120 static const struct regmap_config max77693_regmap_muic_config = {
121 .reg_bits = 8,
122 .val_bits = 8,
123 .max_register = MAX77693_MUIC_REG_END,
126 static const struct regmap_irq max77693_muic_irqs[] = {
127 { .reg_offset = 0, .mask = MUIC_IRQ_INT1_ADC, },
128 { .reg_offset = 0, .mask = MUIC_IRQ_INT1_ADC_LOW, },
129 { .reg_offset = 0, .mask = MUIC_IRQ_INT1_ADC_ERR, },
130 { .reg_offset = 0, .mask = MUIC_IRQ_INT1_ADC1K, },
132 { .reg_offset = 1, .mask = MUIC_IRQ_INT2_CHGTYP, },
133 { .reg_offset = 1, .mask = MUIC_IRQ_INT2_CHGDETREUN, },
134 { .reg_offset = 1, .mask = MUIC_IRQ_INT2_DCDTMR, },
135 { .reg_offset = 1, .mask = MUIC_IRQ_INT2_DXOVP, },
136 { .reg_offset = 1, .mask = MUIC_IRQ_INT2_VBVOLT, },
137 { .reg_offset = 1, .mask = MUIC_IRQ_INT2_VIDRM, },
139 { .reg_offset = 2, .mask = MUIC_IRQ_INT3_EOC, },
140 { .reg_offset = 2, .mask = MUIC_IRQ_INT3_CGMBC, },
141 { .reg_offset = 2, .mask = MUIC_IRQ_INT3_OVP, },
142 { .reg_offset = 2, .mask = MUIC_IRQ_INT3_MBCCHG_ERR, },
143 { .reg_offset = 2, .mask = MUIC_IRQ_INT3_CHG_ENABLED, },
144 { .reg_offset = 2, .mask = MUIC_IRQ_INT3_BAT_DET, },
147 static const struct regmap_irq_chip max77693_muic_irq_chip = {
148 .name = "max77693-muic",
149 .status_base = MAX77693_MUIC_REG_INT1,
150 .mask_base = MAX77693_MUIC_REG_INTMASK1,
151 .mask_invert = true,
152 .num_regs = 3,
153 .irqs = max77693_muic_irqs,
154 .num_irqs = ARRAY_SIZE(max77693_muic_irqs),
157 static const struct regmap_config max77693_regmap_haptic_config = {
158 .reg_bits = 8,
159 .val_bits = 8,
160 .max_register = MAX77693_HAPTIC_REG_END,
163 static int max77693_i2c_probe(struct i2c_client *i2c,
164 const struct i2c_device_id *id)
166 struct max77693_dev *max77693;
167 unsigned int reg_data;
168 int ret = 0;
170 max77693 = devm_kzalloc(&i2c->dev,
171 sizeof(struct max77693_dev), GFP_KERNEL);
172 if (max77693 == NULL)
173 return -ENOMEM;
175 i2c_set_clientdata(i2c, max77693);
176 max77693->dev = &i2c->dev;
177 max77693->i2c = i2c;
178 max77693->irq = i2c->irq;
179 max77693->type = id->driver_data;
181 max77693->regmap = devm_regmap_init_i2c(i2c, &max77693_regmap_config);
182 if (IS_ERR(max77693->regmap)) {
183 ret = PTR_ERR(max77693->regmap);
184 dev_err(max77693->dev, "failed to allocate register map: %d\n",
185 ret);
186 return ret;
189 ret = regmap_read(max77693->regmap, MAX77693_PMIC_REG_PMIC_ID2,
190 &reg_data);
191 if (ret < 0) {
192 dev_err(max77693->dev, "device not found on this channel\n");
193 return ret;
194 } else
195 dev_info(max77693->dev, "device ID: 0x%x\n", reg_data);
197 max77693->i2c_muic = i2c_new_dummy(i2c->adapter, I2C_ADDR_MUIC);
198 if (!max77693->i2c_muic) {
199 dev_err(max77693->dev, "Failed to allocate I2C device for MUIC\n");
200 return -ENODEV;
202 i2c_set_clientdata(max77693->i2c_muic, max77693);
204 max77693->i2c_haptic = i2c_new_dummy(i2c->adapter, I2C_ADDR_HAPTIC);
205 if (!max77693->i2c_haptic) {
206 dev_err(max77693->dev, "Failed to allocate I2C device for Haptic\n");
207 ret = -ENODEV;
208 goto err_i2c_haptic;
210 i2c_set_clientdata(max77693->i2c_haptic, max77693);
212 max77693->regmap_haptic = devm_regmap_init_i2c(max77693->i2c_haptic,
213 &max77693_regmap_haptic_config);
214 if (IS_ERR(max77693->regmap_haptic)) {
215 ret = PTR_ERR(max77693->regmap_haptic);
216 dev_err(max77693->dev,
217 "failed to initialize haptic register map: %d\n", ret);
218 goto err_regmap;
222 * Initialize register map for MUIC device because use regmap-muic
223 * instance of MUIC device when irq of max77693 is initialized
224 * before call max77693-muic probe() function.
226 max77693->regmap_muic = devm_regmap_init_i2c(max77693->i2c_muic,
227 &max77693_regmap_muic_config);
228 if (IS_ERR(max77693->regmap_muic)) {
229 ret = PTR_ERR(max77693->regmap_muic);
230 dev_err(max77693->dev,
231 "failed to allocate register map: %d\n", ret);
232 goto err_regmap;
235 ret = regmap_add_irq_chip(max77693->regmap, max77693->irq,
236 IRQF_ONESHOT | IRQF_SHARED |
237 IRQF_TRIGGER_FALLING, 0,
238 &max77693_led_irq_chip,
239 &max77693->irq_data_led);
240 if (ret) {
241 dev_err(max77693->dev, "failed to add irq chip: %d\n", ret);
242 goto err_regmap;
245 ret = regmap_add_irq_chip(max77693->regmap, max77693->irq,
246 IRQF_ONESHOT | IRQF_SHARED |
247 IRQF_TRIGGER_FALLING, 0,
248 &max77693_topsys_irq_chip,
249 &max77693->irq_data_topsys);
250 if (ret) {
251 dev_err(max77693->dev, "failed to add irq chip: %d\n", ret);
252 goto err_irq_topsys;
255 ret = regmap_add_irq_chip(max77693->regmap, max77693->irq,
256 IRQF_ONESHOT | IRQF_SHARED |
257 IRQF_TRIGGER_FALLING, 0,
258 &max77693_charger_irq_chip,
259 &max77693->irq_data_chg);
260 if (ret) {
261 dev_err(max77693->dev, "failed to add irq chip: %d\n", ret);
262 goto err_irq_charger;
265 ret = regmap_add_irq_chip(max77693->regmap_muic, max77693->irq,
266 IRQF_ONESHOT | IRQF_SHARED |
267 IRQF_TRIGGER_FALLING, 0,
268 &max77693_muic_irq_chip,
269 &max77693->irq_data_muic);
270 if (ret) {
271 dev_err(max77693->dev, "failed to add irq chip: %d\n", ret);
272 goto err_irq_muic;
275 /* Unmask interrupts from all blocks in interrupt source register */
276 ret = regmap_update_bits(max77693->regmap,
277 MAX77693_PMIC_REG_INTSRC_MASK,
278 SRC_IRQ_ALL, (unsigned int)~SRC_IRQ_ALL);
279 if (ret < 0) {
280 dev_err(max77693->dev,
281 "Could not unmask interrupts in INTSRC: %d\n",
282 ret);
283 goto err_intsrc;
286 pm_runtime_set_active(max77693->dev);
288 ret = mfd_add_devices(max77693->dev, -1, max77693_devs,
289 ARRAY_SIZE(max77693_devs), NULL, 0, NULL);
290 if (ret < 0)
291 goto err_mfd;
293 return ret;
295 err_mfd:
296 mfd_remove_devices(max77693->dev);
297 err_intsrc:
298 regmap_del_irq_chip(max77693->irq, max77693->irq_data_muic);
299 err_irq_muic:
300 regmap_del_irq_chip(max77693->irq, max77693->irq_data_chg);
301 err_irq_charger:
302 regmap_del_irq_chip(max77693->irq, max77693->irq_data_topsys);
303 err_irq_topsys:
304 regmap_del_irq_chip(max77693->irq, max77693->irq_data_led);
305 err_regmap:
306 i2c_unregister_device(max77693->i2c_haptic);
307 err_i2c_haptic:
308 i2c_unregister_device(max77693->i2c_muic);
309 return ret;
312 static int max77693_i2c_remove(struct i2c_client *i2c)
314 struct max77693_dev *max77693 = i2c_get_clientdata(i2c);
316 mfd_remove_devices(max77693->dev);
318 regmap_del_irq_chip(max77693->irq, max77693->irq_data_muic);
319 regmap_del_irq_chip(max77693->irq, max77693->irq_data_chg);
320 regmap_del_irq_chip(max77693->irq, max77693->irq_data_topsys);
321 regmap_del_irq_chip(max77693->irq, max77693->irq_data_led);
323 i2c_unregister_device(max77693->i2c_muic);
324 i2c_unregister_device(max77693->i2c_haptic);
326 return 0;
329 static const struct i2c_device_id max77693_i2c_id[] = {
330 { "max77693", TYPE_MAX77693 },
333 MODULE_DEVICE_TABLE(i2c, max77693_i2c_id);
335 static int max77693_suspend(struct device *dev)
337 struct i2c_client *i2c = to_i2c_client(dev);
338 struct max77693_dev *max77693 = i2c_get_clientdata(i2c);
340 if (device_may_wakeup(dev)) {
341 enable_irq_wake(max77693->irq);
342 disable_irq(max77693->irq);
345 return 0;
348 static int max77693_resume(struct device *dev)
350 struct i2c_client *i2c = to_i2c_client(dev);
351 struct max77693_dev *max77693 = i2c_get_clientdata(i2c);
353 if (device_may_wakeup(dev)) {
354 disable_irq_wake(max77693->irq);
355 enable_irq(max77693->irq);
358 return 0;
361 static const struct dev_pm_ops max77693_pm = {
362 .suspend = max77693_suspend,
363 .resume = max77693_resume,
366 #ifdef CONFIG_OF
367 static const struct of_device_id max77693_dt_match[] = {
368 { .compatible = "maxim,max77693" },
371 MODULE_DEVICE_TABLE(of, max77693_dt_match);
372 #endif
374 static struct i2c_driver max77693_i2c_driver = {
375 .driver = {
376 .name = "max77693",
377 .pm = &max77693_pm,
378 .of_match_table = of_match_ptr(max77693_dt_match),
380 .probe = max77693_i2c_probe,
381 .remove = max77693_i2c_remove,
382 .id_table = max77693_i2c_id,
385 module_i2c_driver(max77693_i2c_driver);
387 MODULE_DESCRIPTION("MAXIM 77693 multi-function core driver");
388 MODULE_AUTHOR("SangYoung, Son <hello.son@samsung.com>");
389 MODULE_LICENSE("GPL");