xref: /linux/drivers/mfd/qcom-pm8xxx.c (revision 32786fdc9506aeba98278c1844d4bfb766863832)
1 /*
2  * Copyright (c) 2011, Code Aurora Forum. All rights reserved.
3  *
4  * This program is free software; you can redistribute it and/or modify
5  * it under the terms of the GNU General Public License version 2 and
6  * only version 2 as published by the Free Software Foundation.
7  *
8  * This program is distributed in the hope that it will be useful,
9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11  * GNU General Public License for more details.
12  */
13 
14 #define pr_fmt(fmt) "%s: " fmt, __func__
15 
16 #include <linux/kernel.h>
17 #include <linux/interrupt.h>
18 #include <linux/irqchip/chained_irq.h>
19 #include <linux/irq.h>
20 #include <linux/irqdomain.h>
21 #include <linux/module.h>
22 #include <linux/platform_device.h>
23 #include <linux/slab.h>
24 #include <linux/err.h>
25 #include <linux/ssbi.h>
26 #include <linux/regmap.h>
27 #include <linux/of_platform.h>
28 #include <linux/mfd/core.h>
29 
30 #define	SSBI_REG_ADDR_IRQ_BASE		0x1BB
31 
32 #define	SSBI_REG_ADDR_IRQ_ROOT		(SSBI_REG_ADDR_IRQ_BASE + 0)
33 #define	SSBI_REG_ADDR_IRQ_M_STATUS1	(SSBI_REG_ADDR_IRQ_BASE + 1)
34 #define	SSBI_REG_ADDR_IRQ_M_STATUS2	(SSBI_REG_ADDR_IRQ_BASE + 2)
35 #define	SSBI_REG_ADDR_IRQ_M_STATUS3	(SSBI_REG_ADDR_IRQ_BASE + 3)
36 #define	SSBI_REG_ADDR_IRQ_M_STATUS4	(SSBI_REG_ADDR_IRQ_BASE + 4)
37 #define	SSBI_REG_ADDR_IRQ_BLK_SEL	(SSBI_REG_ADDR_IRQ_BASE + 5)
38 #define	SSBI_REG_ADDR_IRQ_IT_STATUS	(SSBI_REG_ADDR_IRQ_BASE + 6)
39 #define	SSBI_REG_ADDR_IRQ_CONFIG	(SSBI_REG_ADDR_IRQ_BASE + 7)
40 #define	SSBI_REG_ADDR_IRQ_RT_STATUS	(SSBI_REG_ADDR_IRQ_BASE + 8)
41 
42 #define	PM_IRQF_LVL_SEL			0x01	/* level select */
43 #define	PM_IRQF_MASK_FE			0x02	/* mask falling edge */
44 #define	PM_IRQF_MASK_RE			0x04	/* mask rising edge */
45 #define	PM_IRQF_CLR			0x08	/* clear interrupt */
46 #define	PM_IRQF_BITS_MASK		0x70
47 #define	PM_IRQF_BITS_SHIFT		4
48 #define	PM_IRQF_WRITE			0x80
49 
50 #define	PM_IRQF_MASK_ALL		(PM_IRQF_MASK_FE | \
51 					PM_IRQF_MASK_RE)
52 
53 #define REG_HWREV		0x002  /* PMIC4 revision */
54 #define REG_HWREV_2		0x0E8  /* PMIC4 revision 2 */
55 
56 #define PM8XXX_NR_IRQS		256
57 
58 struct pm_irq_chip {
59 	struct regmap		*regmap;
60 	spinlock_t		pm_irq_lock;
61 	struct irq_domain	*irqdomain;
62 	unsigned int		num_irqs;
63 	unsigned int		num_blocks;
64 	unsigned int		num_masters;
65 	u8			config[0];
66 };
67 
68 static int pm8xxx_read_block_irq(struct pm_irq_chip *chip, unsigned int bp,
69 				 unsigned int *ip)
70 {
71 	int	rc;
72 
73 	spin_lock(&chip->pm_irq_lock);
74 	rc = regmap_write(chip->regmap, SSBI_REG_ADDR_IRQ_BLK_SEL, bp);
75 	if (rc) {
76 		pr_err("Failed Selecting Block %d rc=%d\n", bp, rc);
77 		goto bail;
78 	}
79 
80 	rc = regmap_read(chip->regmap, SSBI_REG_ADDR_IRQ_IT_STATUS, ip);
81 	if (rc)
82 		pr_err("Failed Reading Status rc=%d\n", rc);
83 bail:
84 	spin_unlock(&chip->pm_irq_lock);
85 	return rc;
86 }
87 
88 static int
89 pm8xxx_config_irq(struct pm_irq_chip *chip, unsigned int bp, unsigned int cp)
90 {
91 	int	rc;
92 
93 	spin_lock(&chip->pm_irq_lock);
94 	rc = regmap_write(chip->regmap, SSBI_REG_ADDR_IRQ_BLK_SEL, bp);
95 	if (rc) {
96 		pr_err("Failed Selecting Block %d rc=%d\n", bp, rc);
97 		goto bail;
98 	}
99 
100 	cp |= PM_IRQF_WRITE;
101 	rc = regmap_write(chip->regmap, SSBI_REG_ADDR_IRQ_CONFIG, cp);
102 	if (rc)
103 		pr_err("Failed Configuring IRQ rc=%d\n", rc);
104 bail:
105 	spin_unlock(&chip->pm_irq_lock);
106 	return rc;
107 }
108 
109 static int pm8xxx_irq_block_handler(struct pm_irq_chip *chip, int block)
110 {
111 	int pmirq, irq, i, ret = 0;
112 	unsigned int bits;
113 
114 	ret = pm8xxx_read_block_irq(chip, block, &bits);
115 	if (ret) {
116 		pr_err("Failed reading %d block ret=%d", block, ret);
117 		return ret;
118 	}
119 	if (!bits) {
120 		pr_err("block bit set in master but no irqs: %d", block);
121 		return 0;
122 	}
123 
124 	/* Check IRQ bits */
125 	for (i = 0; i < 8; i++) {
126 		if (bits & (1 << i)) {
127 			pmirq = block * 8 + i;
128 			irq = irq_find_mapping(chip->irqdomain, pmirq);
129 			generic_handle_irq(irq);
130 		}
131 	}
132 	return 0;
133 }
134 
135 static int pm8xxx_irq_master_handler(struct pm_irq_chip *chip, int master)
136 {
137 	unsigned int blockbits;
138 	int block_number, i, ret = 0;
139 
140 	ret = regmap_read(chip->regmap, SSBI_REG_ADDR_IRQ_M_STATUS1 + master,
141 			  &blockbits);
142 	if (ret) {
143 		pr_err("Failed to read master %d ret=%d\n", master, ret);
144 		return ret;
145 	}
146 	if (!blockbits) {
147 		pr_err("master bit set in root but no blocks: %d", master);
148 		return 0;
149 	}
150 
151 	for (i = 0; i < 8; i++)
152 		if (blockbits & (1 << i)) {
153 			block_number = master * 8 + i;	/* block # */
154 			ret |= pm8xxx_irq_block_handler(chip, block_number);
155 		}
156 	return ret;
157 }
158 
159 static void pm8xxx_irq_handler(struct irq_desc *desc)
160 {
161 	struct pm_irq_chip *chip = irq_desc_get_handler_data(desc);
162 	struct irq_chip *irq_chip = irq_desc_get_chip(desc);
163 	unsigned int root;
164 	int	i, ret, masters = 0;
165 
166 	chained_irq_enter(irq_chip, desc);
167 
168 	ret = regmap_read(chip->regmap, SSBI_REG_ADDR_IRQ_ROOT, &root);
169 	if (ret) {
170 		pr_err("Can't read root status ret=%d\n", ret);
171 		return;
172 	}
173 
174 	/* on pm8xxx series masters start from bit 1 of the root */
175 	masters = root >> 1;
176 
177 	/* Read allowed masters for blocks. */
178 	for (i = 0; i < chip->num_masters; i++)
179 		if (masters & (1 << i))
180 			pm8xxx_irq_master_handler(chip, i);
181 
182 	chained_irq_exit(irq_chip, desc);
183 }
184 
185 static void pm8xxx_irq_mask_ack(struct irq_data *d)
186 {
187 	struct pm_irq_chip *chip = irq_data_get_irq_chip_data(d);
188 	unsigned int pmirq = irqd_to_hwirq(d);
189 	u8	block, config;
190 
191 	block = pmirq / 8;
192 
193 	config = chip->config[pmirq] | PM_IRQF_MASK_ALL | PM_IRQF_CLR;
194 	pm8xxx_config_irq(chip, block, config);
195 }
196 
197 static void pm8xxx_irq_unmask(struct irq_data *d)
198 {
199 	struct pm_irq_chip *chip = irq_data_get_irq_chip_data(d);
200 	unsigned int pmirq = irqd_to_hwirq(d);
201 	u8	block, config;
202 
203 	block = pmirq / 8;
204 
205 	config = chip->config[pmirq];
206 	pm8xxx_config_irq(chip, block, config);
207 }
208 
209 static int pm8xxx_irq_set_type(struct irq_data *d, unsigned int flow_type)
210 {
211 	struct pm_irq_chip *chip = irq_data_get_irq_chip_data(d);
212 	unsigned int pmirq = irqd_to_hwirq(d);
213 	int irq_bit;
214 	u8 block, config;
215 
216 	block = pmirq / 8;
217 	irq_bit  = pmirq % 8;
218 
219 	chip->config[pmirq] = (irq_bit << PM_IRQF_BITS_SHIFT)
220 							| PM_IRQF_MASK_ALL;
221 	if (flow_type & (IRQF_TRIGGER_RISING | IRQF_TRIGGER_FALLING)) {
222 		if (flow_type & IRQF_TRIGGER_RISING)
223 			chip->config[pmirq] &= ~PM_IRQF_MASK_RE;
224 		if (flow_type & IRQF_TRIGGER_FALLING)
225 			chip->config[pmirq] &= ~PM_IRQF_MASK_FE;
226 	} else {
227 		chip->config[pmirq] |= PM_IRQF_LVL_SEL;
228 
229 		if (flow_type & IRQF_TRIGGER_HIGH)
230 			chip->config[pmirq] &= ~PM_IRQF_MASK_RE;
231 		else
232 			chip->config[pmirq] &= ~PM_IRQF_MASK_FE;
233 	}
234 
235 	config = chip->config[pmirq] | PM_IRQF_CLR;
236 	return pm8xxx_config_irq(chip, block, config);
237 }
238 
239 static int pm8xxx_irq_get_irqchip_state(struct irq_data *d,
240 					enum irqchip_irq_state which,
241 					bool *state)
242 {
243 	struct pm_irq_chip *chip = irq_data_get_irq_chip_data(d);
244 	unsigned int pmirq = irqd_to_hwirq(d);
245 	unsigned int bits;
246 	int irq_bit;
247 	u8 block;
248 	int rc;
249 
250 	if (which != IRQCHIP_STATE_LINE_LEVEL)
251 		return -EINVAL;
252 
253 	block = pmirq / 8;
254 	irq_bit = pmirq % 8;
255 
256 	spin_lock(&chip->pm_irq_lock);
257 	rc = regmap_write(chip->regmap, SSBI_REG_ADDR_IRQ_BLK_SEL, block);
258 	if (rc) {
259 		pr_err("Failed Selecting Block %d rc=%d\n", block, rc);
260 		goto bail;
261 	}
262 
263 	rc = regmap_read(chip->regmap, SSBI_REG_ADDR_IRQ_RT_STATUS, &bits);
264 	if (rc) {
265 		pr_err("Failed Reading Status rc=%d\n", rc);
266 		goto bail;
267 	}
268 
269 	*state = !!(bits & BIT(irq_bit));
270 bail:
271 	spin_unlock(&chip->pm_irq_lock);
272 
273 	return rc;
274 }
275 
276 static struct irq_chip pm8xxx_irq_chip = {
277 	.name		= "pm8xxx",
278 	.irq_mask_ack	= pm8xxx_irq_mask_ack,
279 	.irq_unmask	= pm8xxx_irq_unmask,
280 	.irq_set_type	= pm8xxx_irq_set_type,
281 	.irq_get_irqchip_state = pm8xxx_irq_get_irqchip_state,
282 	.flags		= IRQCHIP_MASK_ON_SUSPEND | IRQCHIP_SKIP_SET_WAKE,
283 };
284 
285 static int pm8xxx_irq_domain_map(struct irq_domain *d, unsigned int irq,
286 				   irq_hw_number_t hwirq)
287 {
288 	struct pm_irq_chip *chip = d->host_data;
289 
290 	irq_set_chip_and_handler(irq, &pm8xxx_irq_chip, handle_level_irq);
291 	irq_set_chip_data(irq, chip);
292 	irq_set_noprobe(irq);
293 
294 	return 0;
295 }
296 
297 static const struct irq_domain_ops pm8xxx_irq_domain_ops = {
298 	.xlate = irq_domain_xlate_twocell,
299 	.map = pm8xxx_irq_domain_map,
300 };
301 
302 static const struct regmap_config ssbi_regmap_config = {
303 	.reg_bits = 16,
304 	.val_bits = 8,
305 	.max_register = 0x3ff,
306 	.fast_io = true,
307 	.reg_read = ssbi_reg_read,
308 	.reg_write = ssbi_reg_write
309 };
310 
311 static const struct of_device_id pm8xxx_id_table[] = {
312 	{ .compatible = "qcom,pm8018", },
313 	{ .compatible = "qcom,pm8058", },
314 	{ .compatible = "qcom,pm8921", },
315 	{ }
316 };
317 MODULE_DEVICE_TABLE(of, pm8xxx_id_table);
318 
319 static int pm8xxx_probe(struct platform_device *pdev)
320 {
321 	struct regmap *regmap;
322 	int irq, rc;
323 	unsigned int val;
324 	u32 rev;
325 	struct pm_irq_chip *chip;
326 	unsigned int nirqs = PM8XXX_NR_IRQS;
327 
328 	irq = platform_get_irq(pdev, 0);
329 	if (irq < 0)
330 		return irq;
331 
332 	regmap = devm_regmap_init(&pdev->dev, NULL, pdev->dev.parent,
333 				  &ssbi_regmap_config);
334 	if (IS_ERR(regmap))
335 		return PTR_ERR(regmap);
336 
337 	/* Read PMIC chip revision */
338 	rc = regmap_read(regmap, REG_HWREV, &val);
339 	if (rc) {
340 		pr_err("Failed to read hw rev reg %d:rc=%d\n", REG_HWREV, rc);
341 		return rc;
342 	}
343 	pr_info("PMIC revision 1: %02X\n", val);
344 	rev = val;
345 
346 	/* Read PMIC chip revision 2 */
347 	rc = regmap_read(regmap, REG_HWREV_2, &val);
348 	if (rc) {
349 		pr_err("Failed to read hw rev 2 reg %d:rc=%d\n",
350 			REG_HWREV_2, rc);
351 		return rc;
352 	}
353 	pr_info("PMIC revision 2: %02X\n", val);
354 	rev |= val << BITS_PER_BYTE;
355 
356 	chip = devm_kzalloc(&pdev->dev, sizeof(*chip) +
357 					sizeof(chip->config[0]) * nirqs,
358 					GFP_KERNEL);
359 	if (!chip)
360 		return -ENOMEM;
361 
362 	platform_set_drvdata(pdev, chip);
363 	chip->regmap = regmap;
364 	chip->num_irqs = nirqs;
365 	chip->num_blocks = DIV_ROUND_UP(chip->num_irqs, 8);
366 	chip->num_masters = DIV_ROUND_UP(chip->num_blocks, 8);
367 	spin_lock_init(&chip->pm_irq_lock);
368 
369 	chip->irqdomain = irq_domain_add_linear(pdev->dev.of_node, nirqs,
370 						&pm8xxx_irq_domain_ops,
371 						chip);
372 	if (!chip->irqdomain)
373 		return -ENODEV;
374 
375 	irq_set_chained_handler_and_data(irq, pm8xxx_irq_handler, chip);
376 	irq_set_irq_wake(irq, 1);
377 
378 	rc = of_platform_populate(pdev->dev.of_node, NULL, NULL, &pdev->dev);
379 	if (rc) {
380 		irq_set_chained_handler_and_data(irq, NULL, NULL);
381 		irq_domain_remove(chip->irqdomain);
382 	}
383 
384 	return rc;
385 }
386 
387 static int pm8xxx_remove_child(struct device *dev, void *unused)
388 {
389 	platform_device_unregister(to_platform_device(dev));
390 	return 0;
391 }
392 
393 static int pm8xxx_remove(struct platform_device *pdev)
394 {
395 	int irq = platform_get_irq(pdev, 0);
396 	struct pm_irq_chip *chip = platform_get_drvdata(pdev);
397 
398 	device_for_each_child(&pdev->dev, NULL, pm8xxx_remove_child);
399 	irq_set_chained_handler_and_data(irq, NULL, NULL);
400 	irq_domain_remove(chip->irqdomain);
401 
402 	return 0;
403 }
404 
405 static struct platform_driver pm8xxx_driver = {
406 	.probe		= pm8xxx_probe,
407 	.remove		= pm8xxx_remove,
408 	.driver		= {
409 		.name	= "pm8xxx-core",
410 		.of_match_table = pm8xxx_id_table,
411 	},
412 };
413 
414 static int __init pm8xxx_init(void)
415 {
416 	return platform_driver_register(&pm8xxx_driver);
417 }
418 subsys_initcall(pm8xxx_init);
419 
420 static void __exit pm8xxx_exit(void)
421 {
422 	platform_driver_unregister(&pm8xxx_driver);
423 }
424 module_exit(pm8xxx_exit);
425 
426 MODULE_LICENSE("GPL v2");
427 MODULE_DESCRIPTION("PMIC 8xxx core driver");
428 MODULE_VERSION("1.0");
429 MODULE_ALIAS("platform:pm8xxx-core");
430