1 // SPDX-License-Identifier: GPL-2.0-only
3 * Copyright (c) 2011, Code Aurora Forum. All rights reserved.
6 #define pr_fmt(fmt) "%s: " fmt, __func__
8 #include <linux/kernel.h>
9 #include <linux/interrupt.h>
10 #include <linux/irqchip/chained_irq.h>
11 #include <linux/irq.h>
12 #include <linux/irqdomain.h>
13 #include <linux/module.h>
14 #include <linux/platform_device.h>
15 #include <linux/slab.h>
16 #include <linux/err.h>
17 #include <linux/ssbi.h>
18 #include <linux/regmap.h>
19 #include <linux/of_platform.h>
20 #include <linux/mfd/core.h>
22 #define SSBI_REG_ADDR_IRQ_BASE 0x1BB
24 #define SSBI_REG_ADDR_IRQ_ROOT (SSBI_REG_ADDR_IRQ_BASE + 0)
25 #define SSBI_REG_ADDR_IRQ_M_STATUS1 (SSBI_REG_ADDR_IRQ_BASE + 1)
26 #define SSBI_REG_ADDR_IRQ_M_STATUS2 (SSBI_REG_ADDR_IRQ_BASE + 2)
27 #define SSBI_REG_ADDR_IRQ_M_STATUS3 (SSBI_REG_ADDR_IRQ_BASE + 3)
28 #define SSBI_REG_ADDR_IRQ_M_STATUS4 (SSBI_REG_ADDR_IRQ_BASE + 4)
29 #define SSBI_REG_ADDR_IRQ_BLK_SEL (SSBI_REG_ADDR_IRQ_BASE + 5)
30 #define SSBI_REG_ADDR_IRQ_IT_STATUS (SSBI_REG_ADDR_IRQ_BASE + 6)
31 #define SSBI_REG_ADDR_IRQ_CONFIG (SSBI_REG_ADDR_IRQ_BASE + 7)
32 #define SSBI_REG_ADDR_IRQ_RT_STATUS (SSBI_REG_ADDR_IRQ_BASE + 8)
34 #define PM8821_SSBI_REG_ADDR_IRQ_BASE 0x100
35 #define PM8821_SSBI_REG_ADDR_IRQ_MASTER0 (PM8821_SSBI_REG_ADDR_IRQ_BASE + 0x30)
36 #define PM8821_SSBI_REG_ADDR_IRQ_MASTER1 (PM8821_SSBI_REG_ADDR_IRQ_BASE + 0xb0)
37 #define PM8821_SSBI_REG(m, b, offset) \
39 (PM8821_SSBI_REG_ADDR_IRQ_MASTER0 + b + offset) : \
40 (PM8821_SSBI_REG_ADDR_IRQ_MASTER1 + b + offset))
41 #define PM8821_SSBI_ADDR_IRQ_ROOT(m, b) PM8821_SSBI_REG(m, b, 0x0)
42 #define PM8821_SSBI_ADDR_IRQ_CLEAR(m, b) PM8821_SSBI_REG(m, b, 0x01)
43 #define PM8821_SSBI_ADDR_IRQ_MASK(m, b) PM8821_SSBI_REG(m, b, 0x08)
44 #define PM8821_SSBI_ADDR_IRQ_RT_STATUS(m, b) PM8821_SSBI_REG(m, b, 0x0f)
46 #define PM8821_BLOCKS_PER_MASTER 7
48 #define PM_IRQF_LVL_SEL 0x01 /* level select */
49 #define PM_IRQF_MASK_FE 0x02 /* mask falling edge */
50 #define PM_IRQF_MASK_RE 0x04 /* mask rising edge */
51 #define PM_IRQF_CLR 0x08 /* clear interrupt */
52 #define PM_IRQF_BITS_MASK 0x70
53 #define PM_IRQF_BITS_SHIFT 4
54 #define PM_IRQF_WRITE 0x80
56 #define PM_IRQF_MASK_ALL (PM_IRQF_MASK_FE | \
59 #define REG_HWREV 0x002 /* PMIC4 revision */
60 #define REG_HWREV_2 0x0E8 /* PMIC4 revision 2 */
62 #define PM8XXX_NR_IRQS 256
63 #define PM8821_NR_IRQS 112
67 struct irq_chip *irq_chip;
68 irq_handler_t irq_handler;
72 struct regmap *regmap;
73 spinlock_t pm_irq_lock;
74 struct irq_domain *irqdomain;
75 unsigned int num_blocks;
76 unsigned int num_masters;
77 const struct pm_irq_data *pm_irq_data;
78 /* MUST BE AT THE END OF THIS STRUCT */
82 static int pm8xxx_read_block_irq(struct pm_irq_chip *chip, unsigned int bp,
87 spin_lock(&chip->pm_irq_lock);
88 rc = regmap_write(chip->regmap, SSBI_REG_ADDR_IRQ_BLK_SEL, bp);
90 pr_err("Failed Selecting Block %d rc=%d\n", bp, rc);
94 rc = regmap_read(chip->regmap, SSBI_REG_ADDR_IRQ_IT_STATUS, ip);
96 pr_err("Failed Reading Status rc=%d\n", rc);
98 spin_unlock(&chip->pm_irq_lock);
103 pm8xxx_config_irq(struct pm_irq_chip *chip, unsigned int bp, unsigned int cp)
108 spin_lock_irqsave(&chip->pm_irq_lock, flags);
109 rc = regmap_write(chip->regmap, SSBI_REG_ADDR_IRQ_BLK_SEL, bp);
111 pr_err("Failed Selecting Block %d rc=%d\n", bp, rc);
116 rc = regmap_write(chip->regmap, SSBI_REG_ADDR_IRQ_CONFIG, cp);
118 pr_err("Failed Configuring IRQ rc=%d\n", rc);
120 spin_unlock_irqrestore(&chip->pm_irq_lock, flags);
124 static int pm8xxx_irq_block_handler(struct pm_irq_chip *chip, int block)
126 int pmirq, i, ret = 0;
129 ret = pm8xxx_read_block_irq(chip, block, &bits);
131 pr_err("Failed reading %d block ret=%d", block, ret);
135 pr_err("block bit set in master but no irqs: %d", block);
140 for (i = 0; i < 8; i++) {
141 if (bits & (1 << i)) {
142 pmirq = block * 8 + i;
143 generic_handle_domain_irq(chip->irqdomain, pmirq);
149 static int pm8xxx_irq_master_handler(struct pm_irq_chip *chip, int master)
151 unsigned int blockbits;
152 int block_number, i, ret = 0;
154 ret = regmap_read(chip->regmap, SSBI_REG_ADDR_IRQ_M_STATUS1 + master,
157 pr_err("Failed to read master %d ret=%d\n", master, ret);
161 pr_err("master bit set in root but no blocks: %d", master);
165 for (i = 0; i < 8; i++)
166 if (blockbits & (1 << i)) {
167 block_number = master * 8 + i; /* block # */
168 ret |= pm8xxx_irq_block_handler(chip, block_number);
173 static irqreturn_t pm8xxx_irq_handler(int irq, void *data)
175 struct pm_irq_chip *chip = data;
177 int i, ret, masters = 0;
179 ret = regmap_read(chip->regmap, SSBI_REG_ADDR_IRQ_ROOT, &root);
181 pr_err("Can't read root status ret=%d\n", ret);
185 /* on pm8xxx series masters start from bit 1 of the root */
188 /* Read allowed masters for blocks. */
189 for (i = 0; i < chip->num_masters; i++)
190 if (masters & (1 << i))
191 pm8xxx_irq_master_handler(chip, i);
196 static void pm8821_irq_block_handler(struct pm_irq_chip *chip,
197 int master, int block)
202 ret = regmap_read(chip->regmap,
203 PM8821_SSBI_ADDR_IRQ_ROOT(master, block), &bits);
205 pr_err("Reading block %d failed ret=%d", block, ret);
209 /* Convert block offset to global block number */
210 block += (master * PM8821_BLOCKS_PER_MASTER) - 1;
213 for (i = 0; i < 8; i++) {
215 pmirq = block * 8 + i;
216 generic_handle_domain_irq(chip->irqdomain, pmirq);
221 static inline void pm8821_irq_master_handler(struct pm_irq_chip *chip,
222 int master, u8 master_val)
226 for (block = 1; block < 8; block++)
227 if (master_val & BIT(block))
228 pm8821_irq_block_handler(chip, master, block);
231 static irqreturn_t pm8821_irq_handler(int irq, void *data)
233 struct pm_irq_chip *chip = data;
237 ret = regmap_read(chip->regmap,
238 PM8821_SSBI_REG_ADDR_IRQ_MASTER0, &master);
240 pr_err("Failed to read master 0 ret=%d\n", ret);
244 /* bits 1 through 7 marks the first 7 blocks in master 0 */
245 if (master & GENMASK(7, 1))
246 pm8821_irq_master_handler(chip, 0, master);
248 /* bit 0 marks if master 1 contains any bits */
249 if (!(master & BIT(0)))
252 ret = regmap_read(chip->regmap,
253 PM8821_SSBI_REG_ADDR_IRQ_MASTER1, &master);
255 pr_err("Failed to read master 1 ret=%d\n", ret);
259 pm8821_irq_master_handler(chip, 1, master);
264 static void pm8xxx_irq_mask_ack(struct irq_data *d)
266 struct pm_irq_chip *chip = irq_data_get_irq_chip_data(d);
267 unsigned int pmirq = irqd_to_hwirq(d);
272 config = chip->config[pmirq] | PM_IRQF_MASK_ALL | PM_IRQF_CLR;
273 pm8xxx_config_irq(chip, block, config);
276 static void pm8xxx_irq_unmask(struct irq_data *d)
278 struct pm_irq_chip *chip = irq_data_get_irq_chip_data(d);
279 unsigned int pmirq = irqd_to_hwirq(d);
284 config = chip->config[pmirq];
285 pm8xxx_config_irq(chip, block, config);
288 static int pm8xxx_irq_set_type(struct irq_data *d, unsigned int flow_type)
290 struct pm_irq_chip *chip = irq_data_get_irq_chip_data(d);
291 unsigned int pmirq = irqd_to_hwirq(d);
298 chip->config[pmirq] = (irq_bit << PM_IRQF_BITS_SHIFT)
300 if (flow_type & (IRQF_TRIGGER_RISING | IRQF_TRIGGER_FALLING)) {
301 if (flow_type & IRQF_TRIGGER_RISING)
302 chip->config[pmirq] &= ~PM_IRQF_MASK_RE;
303 if (flow_type & IRQF_TRIGGER_FALLING)
304 chip->config[pmirq] &= ~PM_IRQF_MASK_FE;
306 chip->config[pmirq] |= PM_IRQF_LVL_SEL;
308 if (flow_type & IRQF_TRIGGER_HIGH)
309 chip->config[pmirq] &= ~PM_IRQF_MASK_RE;
311 chip->config[pmirq] &= ~PM_IRQF_MASK_FE;
314 config = chip->config[pmirq] | PM_IRQF_CLR;
315 return pm8xxx_config_irq(chip, block, config);
318 static int pm8xxx_irq_get_irqchip_state(struct irq_data *d,
319 enum irqchip_irq_state which,
322 struct pm_irq_chip *chip = irq_data_get_irq_chip_data(d);
323 unsigned int pmirq = irqd_to_hwirq(d);
330 if (which != IRQCHIP_STATE_LINE_LEVEL)
336 spin_lock_irqsave(&chip->pm_irq_lock, flags);
337 rc = regmap_write(chip->regmap, SSBI_REG_ADDR_IRQ_BLK_SEL, block);
339 pr_err("Failed Selecting Block %d rc=%d\n", block, rc);
343 rc = regmap_read(chip->regmap, SSBI_REG_ADDR_IRQ_RT_STATUS, &bits);
345 pr_err("Failed Reading Status rc=%d\n", rc);
349 *state = !!(bits & BIT(irq_bit));
351 spin_unlock_irqrestore(&chip->pm_irq_lock, flags);
356 static struct irq_chip pm8xxx_irq_chip = {
358 .irq_mask_ack = pm8xxx_irq_mask_ack,
359 .irq_unmask = pm8xxx_irq_unmask,
360 .irq_set_type = pm8xxx_irq_set_type,
361 .irq_get_irqchip_state = pm8xxx_irq_get_irqchip_state,
362 .flags = IRQCHIP_MASK_ON_SUSPEND | IRQCHIP_SKIP_SET_WAKE,
365 static void pm8xxx_irq_domain_map(struct pm_irq_chip *chip,
366 struct irq_domain *domain, unsigned int irq,
367 irq_hw_number_t hwirq, unsigned int type)
369 irq_domain_set_info(domain, irq, hwirq, chip->pm_irq_data->irq_chip,
370 chip, handle_level_irq, NULL, NULL);
371 irq_set_noprobe(irq);
374 static int pm8xxx_irq_domain_alloc(struct irq_domain *domain, unsigned int virq,
375 unsigned int nr_irqs, void *data)
377 struct pm_irq_chip *chip = domain->host_data;
378 struct irq_fwspec *fwspec = data;
379 irq_hw_number_t hwirq;
383 ret = irq_domain_translate_twocell(domain, fwspec, &hwirq, &type);
387 for (i = 0; i < nr_irqs; i++)
388 pm8xxx_irq_domain_map(chip, domain, virq + i, hwirq + i, type);
393 static const struct irq_domain_ops pm8xxx_irq_domain_ops = {
394 .alloc = pm8xxx_irq_domain_alloc,
395 .free = irq_domain_free_irqs_common,
396 .translate = irq_domain_translate_twocell,
399 static void pm8821_irq_mask_ack(struct irq_data *d)
401 struct pm_irq_chip *chip = irq_data_get_irq_chip_data(d);
402 unsigned int pmirq = irqd_to_hwirq(d);
407 master = block / PM8821_BLOCKS_PER_MASTER;
409 block %= PM8821_BLOCKS_PER_MASTER;
411 rc = regmap_update_bits(chip->regmap,
412 PM8821_SSBI_ADDR_IRQ_MASK(master, block),
413 BIT(irq_bit), BIT(irq_bit));
415 pr_err("Failed to mask IRQ:%d rc=%d\n", pmirq, rc);
419 rc = regmap_update_bits(chip->regmap,
420 PM8821_SSBI_ADDR_IRQ_CLEAR(master, block),
421 BIT(irq_bit), BIT(irq_bit));
423 pr_err("Failed to CLEAR IRQ:%d rc=%d\n", pmirq, rc);
426 static void pm8821_irq_unmask(struct irq_data *d)
428 struct pm_irq_chip *chip = irq_data_get_irq_chip_data(d);
429 unsigned int pmirq = irqd_to_hwirq(d);
434 master = block / PM8821_BLOCKS_PER_MASTER;
436 block %= PM8821_BLOCKS_PER_MASTER;
438 rc = regmap_update_bits(chip->regmap,
439 PM8821_SSBI_ADDR_IRQ_MASK(master, block),
440 BIT(irq_bit), ~BIT(irq_bit));
442 pr_err("Failed to read/write unmask IRQ:%d rc=%d\n", pmirq, rc);
446 static int pm8821_irq_get_irqchip_state(struct irq_data *d,
447 enum irqchip_irq_state which,
450 struct pm_irq_chip *chip = irq_data_get_irq_chip_data(d);
451 int rc, pmirq = irqd_to_hwirq(d);
452 u8 block, irq_bit, master;
456 master = block / PM8821_BLOCKS_PER_MASTER;
458 block %= PM8821_BLOCKS_PER_MASTER;
460 rc = regmap_read(chip->regmap,
461 PM8821_SSBI_ADDR_IRQ_RT_STATUS(master, block), &bits);
463 pr_err("Reading Status of IRQ %d failed rc=%d\n", pmirq, rc);
467 *state = !!(bits & BIT(irq_bit));
472 static struct irq_chip pm8821_irq_chip = {
474 .irq_mask_ack = pm8821_irq_mask_ack,
475 .irq_unmask = pm8821_irq_unmask,
476 .irq_get_irqchip_state = pm8821_irq_get_irqchip_state,
477 .flags = IRQCHIP_MASK_ON_SUSPEND | IRQCHIP_SKIP_SET_WAKE,
480 static const struct regmap_config ssbi_regmap_config = {
483 .max_register = 0x3ff,
485 .reg_read = ssbi_reg_read,
486 .reg_write = ssbi_reg_write
489 static const struct pm_irq_data pm8xxx_data = {
490 .num_irqs = PM8XXX_NR_IRQS,
491 .irq_chip = &pm8xxx_irq_chip,
492 .irq_handler = pm8xxx_irq_handler,
495 static const struct pm_irq_data pm8821_data = {
496 .num_irqs = PM8821_NR_IRQS,
497 .irq_chip = &pm8821_irq_chip,
498 .irq_handler = pm8821_irq_handler,
501 static const struct of_device_id pm8xxx_id_table[] = {
502 { .compatible = "qcom,pm8058", .data = &pm8xxx_data},
503 { .compatible = "qcom,pm8821", .data = &pm8821_data},
504 { .compatible = "qcom,pm8921", .data = &pm8xxx_data},
507 MODULE_DEVICE_TABLE(of, pm8xxx_id_table);
509 static int pm8xxx_probe(struct platform_device *pdev)
511 const struct pm_irq_data *data;
512 struct regmap *regmap;
515 struct pm_irq_chip *chip;
517 data = of_device_get_match_data(&pdev->dev);
519 dev_err(&pdev->dev, "No matching driver data found\n");
523 irq = platform_get_irq(pdev, 0);
527 regmap = devm_regmap_init(&pdev->dev, NULL, pdev->dev.parent,
528 &ssbi_regmap_config);
530 return PTR_ERR(regmap);
532 /* Read PMIC chip revision */
533 rc = regmap_read(regmap, REG_HWREV, &val);
535 pr_err("Failed to read hw rev reg %d:rc=%d\n", REG_HWREV, rc);
538 pr_info("PMIC revision 1: %02X\n", val);
540 /* Read PMIC chip revision 2 */
541 rc = regmap_read(regmap, REG_HWREV_2, &val);
543 pr_err("Failed to read hw rev 2 reg %d:rc=%d\n",
547 pr_info("PMIC revision 2: %02X\n", val);
549 chip = devm_kzalloc(&pdev->dev,
550 struct_size(chip, config, data->num_irqs),
555 platform_set_drvdata(pdev, chip);
556 chip->regmap = regmap;
557 chip->num_blocks = DIV_ROUND_UP(data->num_irqs, 8);
558 chip->num_masters = DIV_ROUND_UP(chip->num_blocks, 8);
559 chip->pm_irq_data = data;
560 spin_lock_init(&chip->pm_irq_lock);
562 chip->irqdomain = irq_domain_add_linear(pdev->dev.of_node,
564 &pm8xxx_irq_domain_ops,
566 if (!chip->irqdomain)
569 rc = devm_request_irq(&pdev->dev, irq, data->irq_handler, 0, dev_name(&pdev->dev), chip);
573 irq_set_irq_wake(irq, 1);
575 rc = of_platform_populate(pdev->dev.of_node, NULL, NULL, &pdev->dev);
577 irq_domain_remove(chip->irqdomain);
582 static int pm8xxx_remove_child(struct device *dev, void *unused)
584 platform_device_unregister(to_platform_device(dev));
588 static int pm8xxx_remove(struct platform_device *pdev)
590 struct pm_irq_chip *chip = platform_get_drvdata(pdev);
592 device_for_each_child(&pdev->dev, NULL, pm8xxx_remove_child);
593 irq_domain_remove(chip->irqdomain);
598 static struct platform_driver pm8xxx_driver = {
599 .probe = pm8xxx_probe,
600 .remove = pm8xxx_remove,
602 .name = "pm8xxx-core",
603 .of_match_table = pm8xxx_id_table,
607 static int __init pm8xxx_init(void)
609 return platform_driver_register(&pm8xxx_driver);
611 subsys_initcall(pm8xxx_init);
613 static void __exit pm8xxx_exit(void)
615 platform_driver_unregister(&pm8xxx_driver);
617 module_exit(pm8xxx_exit);
619 MODULE_LICENSE("GPL v2");
620 MODULE_DESCRIPTION("PMIC 8xxx core driver");
621 MODULE_VERSION("1.0");
622 MODULE_ALIAS("platform:pm8xxx-core");