1 // SPDX-License-Identifier: GPL-2.0
3 * MFD core driver for Intel Broxton Whiskey Cove PMIC
5 * Copyright (C) 2015-2017, 2022 Intel Corporation. All rights reserved.
8 #include <linux/acpi.h>
9 #include <linux/bits.h>
10 #include <linux/delay.h>
11 #include <linux/err.h>
12 #include <linux/interrupt.h>
13 #include <linux/kernel.h>
14 #include <linux/mfd/core.h>
15 #include <linux/mfd/intel_soc_pmic.h>
16 #include <linux/mfd/intel_soc_pmic_bxtwc.h>
17 #include <linux/module.h>
19 #include <asm/intel_scu_ipc.h>
21 /* PMIC device registers */
22 #define REG_ADDR_MASK GENMASK(15, 8)
23 #define REG_ADDR_SHIFT 8
24 #define REG_OFFSET_MASK GENMASK(7, 0)
26 /* Interrupt Status Registers */
27 #define BXTWC_IRQLVL1 0x4E02
29 #define BXTWC_PWRBTNIRQ 0x4E03
30 #define BXTWC_THRM0IRQ 0x4E04
31 #define BXTWC_THRM1IRQ 0x4E05
32 #define BXTWC_THRM2IRQ 0x4E06
33 #define BXTWC_BCUIRQ 0x4E07
34 #define BXTWC_ADCIRQ 0x4E08
35 #define BXTWC_CHGR0IRQ 0x4E09
36 #define BXTWC_CHGR1IRQ 0x4E0A
37 #define BXTWC_GPIOIRQ0 0x4E0B
38 #define BXTWC_GPIOIRQ1 0x4E0C
39 #define BXTWC_CRITIRQ 0x4E0D
40 #define BXTWC_TMUIRQ 0x4FB6
42 /* Interrupt MASK Registers */
43 #define BXTWC_MIRQLVL1 0x4E0E
44 #define BXTWC_MIRQLVL1_MCHGR BIT(5)
46 #define BXTWC_MPWRBTNIRQ 0x4E0F
47 #define BXTWC_MTHRM0IRQ 0x4E12
48 #define BXTWC_MTHRM1IRQ 0x4E13
49 #define BXTWC_MTHRM2IRQ 0x4E14
50 #define BXTWC_MBCUIRQ 0x4E15
51 #define BXTWC_MADCIRQ 0x4E16
52 #define BXTWC_MCHGR0IRQ 0x4E17
53 #define BXTWC_MCHGR1IRQ 0x4E18
54 #define BXTWC_MGPIO0IRQ 0x4E19
55 #define BXTWC_MGPIO1IRQ 0x4E1A
56 #define BXTWC_MCRITIRQ 0x4E1B
57 #define BXTWC_MTMUIRQ 0x4FB7
59 /* Whiskey Cove PMIC share same ACPI ID between different platforms */
60 #define BROXTON_PMIC_WC_HRV 4
62 #define PMC_PMIC_ACCESS 0xFF
63 #define PMC_PMIC_READ 0x0
64 #define PMC_PMIC_WRITE 0x1
67 BXTWC_PWRBTN_LVL1_IRQ = 0,
77 enum bxtwc_irqs_pwrbtn {
90 enum bxtwc_irqs_chgr {
100 enum bxtwc_irqs_crit {
104 static const struct regmap_irq bxtwc_regmap_irqs[] = {
105 REGMAP_IRQ_REG(BXTWC_PWRBTN_LVL1_IRQ, 0, BIT(0)),
106 REGMAP_IRQ_REG(BXTWC_TMU_LVL1_IRQ, 0, BIT(1)),
107 REGMAP_IRQ_REG(BXTWC_THRM_LVL1_IRQ, 0, BIT(2)),
108 REGMAP_IRQ_REG(BXTWC_BCU_LVL1_IRQ, 0, BIT(3)),
109 REGMAP_IRQ_REG(BXTWC_ADC_LVL1_IRQ, 0, BIT(4)),
110 REGMAP_IRQ_REG(BXTWC_CHGR_LVL1_IRQ, 0, BIT(5)),
111 REGMAP_IRQ_REG(BXTWC_GPIO_LVL1_IRQ, 0, BIT(6)),
112 REGMAP_IRQ_REG(BXTWC_CRIT_LVL1_IRQ, 0, BIT(7)),
115 static const struct regmap_irq bxtwc_regmap_irqs_pwrbtn[] = {
116 REGMAP_IRQ_REG(BXTWC_PWRBTN_IRQ, 0, BIT(0)),
119 static const struct regmap_irq bxtwc_regmap_irqs_bcu[] = {
120 REGMAP_IRQ_REG(BXTWC_BCU_IRQ, 0, GENMASK(4, 0)),
123 static const struct regmap_irq bxtwc_regmap_irqs_adc[] = {
124 REGMAP_IRQ_REG(BXTWC_ADC_IRQ, 0, GENMASK(7, 0)),
127 static const struct regmap_irq bxtwc_regmap_irqs_chgr[] = {
128 REGMAP_IRQ_REG(BXTWC_USBC_IRQ, 0, BIT(5)),
129 REGMAP_IRQ_REG(BXTWC_CHGR0_IRQ, 0, GENMASK(4, 0)),
130 REGMAP_IRQ_REG(BXTWC_CHGR1_IRQ, 1, GENMASK(4, 0)),
133 static const struct regmap_irq bxtwc_regmap_irqs_tmu[] = {
134 REGMAP_IRQ_REG(BXTWC_TMU_IRQ, 0, GENMASK(2, 1)),
137 static const struct regmap_irq bxtwc_regmap_irqs_crit[] = {
138 REGMAP_IRQ_REG(BXTWC_CRIT_IRQ, 0, GENMASK(1, 0)),
141 static struct regmap_irq_chip bxtwc_regmap_irq_chip = {
142 .name = "bxtwc_irq_chip",
143 .status_base = BXTWC_IRQLVL1,
144 .mask_base = BXTWC_MIRQLVL1,
145 .irqs = bxtwc_regmap_irqs,
146 .num_irqs = ARRAY_SIZE(bxtwc_regmap_irqs),
150 static struct regmap_irq_chip bxtwc_regmap_irq_chip_pwrbtn = {
151 .name = "bxtwc_irq_chip_pwrbtn",
152 .status_base = BXTWC_PWRBTNIRQ,
153 .mask_base = BXTWC_MPWRBTNIRQ,
154 .irqs = bxtwc_regmap_irqs_pwrbtn,
155 .num_irqs = ARRAY_SIZE(bxtwc_regmap_irqs_pwrbtn),
159 static struct regmap_irq_chip bxtwc_regmap_irq_chip_tmu = {
160 .name = "bxtwc_irq_chip_tmu",
161 .status_base = BXTWC_TMUIRQ,
162 .mask_base = BXTWC_MTMUIRQ,
163 .irqs = bxtwc_regmap_irqs_tmu,
164 .num_irqs = ARRAY_SIZE(bxtwc_regmap_irqs_tmu),
168 static struct regmap_irq_chip bxtwc_regmap_irq_chip_bcu = {
169 .name = "bxtwc_irq_chip_bcu",
170 .status_base = BXTWC_BCUIRQ,
171 .mask_base = BXTWC_MBCUIRQ,
172 .irqs = bxtwc_regmap_irqs_bcu,
173 .num_irqs = ARRAY_SIZE(bxtwc_regmap_irqs_bcu),
177 static struct regmap_irq_chip bxtwc_regmap_irq_chip_adc = {
178 .name = "bxtwc_irq_chip_adc",
179 .status_base = BXTWC_ADCIRQ,
180 .mask_base = BXTWC_MADCIRQ,
181 .irqs = bxtwc_regmap_irqs_adc,
182 .num_irqs = ARRAY_SIZE(bxtwc_regmap_irqs_adc),
186 static struct regmap_irq_chip bxtwc_regmap_irq_chip_chgr = {
187 .name = "bxtwc_irq_chip_chgr",
188 .status_base = BXTWC_CHGR0IRQ,
189 .mask_base = BXTWC_MCHGR0IRQ,
190 .irqs = bxtwc_regmap_irqs_chgr,
191 .num_irqs = ARRAY_SIZE(bxtwc_regmap_irqs_chgr),
195 static struct regmap_irq_chip bxtwc_regmap_irq_chip_crit = {
196 .name = "bxtwc_irq_chip_crit",
197 .status_base = BXTWC_CRITIRQ,
198 .mask_base = BXTWC_MCRITIRQ,
199 .irqs = bxtwc_regmap_irqs_crit,
200 .num_irqs = ARRAY_SIZE(bxtwc_regmap_irqs_crit),
204 static const struct resource gpio_resources[] = {
205 DEFINE_RES_IRQ_NAMED(BXTWC_GPIO_LVL1_IRQ, "GPIO"),
208 static const struct resource adc_resources[] = {
209 DEFINE_RES_IRQ_NAMED(BXTWC_ADC_IRQ, "ADC"),
212 static const struct resource usbc_resources[] = {
213 DEFINE_RES_IRQ(BXTWC_USBC_IRQ),
216 static const struct resource charger_resources[] = {
217 DEFINE_RES_IRQ_NAMED(BXTWC_CHGR0_IRQ, "CHARGER"),
218 DEFINE_RES_IRQ_NAMED(BXTWC_CHGR1_IRQ, "CHARGER1"),
221 static const struct resource thermal_resources[] = {
222 DEFINE_RES_IRQ(BXTWC_THRM_LVL1_IRQ),
225 static const struct resource bcu_resources[] = {
226 DEFINE_RES_IRQ_NAMED(BXTWC_BCU_IRQ, "BCU"),
229 static const struct resource tmu_resources[] = {
230 DEFINE_RES_IRQ_NAMED(BXTWC_TMU_IRQ, "TMU"),
233 static struct mfd_cell bxt_wc_dev[] = {
235 .name = "bxt_wcove_gpadc",
236 .num_resources = ARRAY_SIZE(adc_resources),
237 .resources = adc_resources,
240 .name = "bxt_wcove_thermal",
241 .num_resources = ARRAY_SIZE(thermal_resources),
242 .resources = thermal_resources,
245 .name = "bxt_wcove_usbc",
246 .num_resources = ARRAY_SIZE(usbc_resources),
247 .resources = usbc_resources,
250 .name = "bxt_wcove_ext_charger",
251 .num_resources = ARRAY_SIZE(charger_resources),
252 .resources = charger_resources,
255 .name = "bxt_wcove_bcu",
256 .num_resources = ARRAY_SIZE(bcu_resources),
257 .resources = bcu_resources,
260 .name = "bxt_wcove_tmu",
261 .num_resources = ARRAY_SIZE(tmu_resources),
262 .resources = tmu_resources,
266 .name = "bxt_wcove_gpio",
267 .num_resources = ARRAY_SIZE(gpio_resources),
268 .resources = gpio_resources,
271 .name = "bxt_wcove_region",
275 static int regmap_ipc_byte_reg_read(void *context, unsigned int reg,
282 struct intel_soc_pmic *pmic = context;
287 if (reg & REG_ADDR_MASK)
288 i2c_addr = (reg & REG_ADDR_MASK) >> REG_ADDR_SHIFT;
290 i2c_addr = BXTWC_DEVICE1_ADDR;
292 reg &= REG_OFFSET_MASK;
295 ipc_in[1] = i2c_addr;
296 ret = intel_scu_ipc_dev_command(pmic->scu, PMC_PMIC_ACCESS,
297 PMC_PMIC_READ, ipc_in, sizeof(ipc_in),
298 ipc_out, sizeof(ipc_out));
307 static int regmap_ipc_byte_reg_write(void *context, unsigned int reg,
312 struct intel_soc_pmic *pmic = context;
317 if (reg & REG_ADDR_MASK)
318 i2c_addr = (reg & REG_ADDR_MASK) >> REG_ADDR_SHIFT;
320 i2c_addr = BXTWC_DEVICE1_ADDR;
322 reg &= REG_OFFSET_MASK;
325 ipc_in[1] = i2c_addr;
327 return intel_scu_ipc_dev_command(pmic->scu, PMC_PMIC_ACCESS,
328 PMC_PMIC_WRITE, ipc_in, sizeof(ipc_in),
332 /* sysfs interfaces to r/w PMIC registers, required by initial script */
333 static unsigned long bxtwc_reg_addr;
334 static ssize_t addr_show(struct device *dev,
335 struct device_attribute *attr, char *buf)
337 return sysfs_emit(buf, "0x%lx\n", bxtwc_reg_addr);
340 static ssize_t addr_store(struct device *dev,
341 struct device_attribute *attr, const char *buf, size_t count)
345 ret = kstrtoul(buf, 0, &bxtwc_reg_addr);
352 static ssize_t val_show(struct device *dev,
353 struct device_attribute *attr, char *buf)
357 struct intel_soc_pmic *pmic = dev_get_drvdata(dev);
359 ret = regmap_read(pmic->regmap, bxtwc_reg_addr, &val);
361 dev_err(dev, "Failed to read 0x%lx\n", bxtwc_reg_addr);
365 return sysfs_emit(buf, "0x%02x\n", val);
368 static ssize_t val_store(struct device *dev,
369 struct device_attribute *attr, const char *buf, size_t count)
373 struct intel_soc_pmic *pmic = dev_get_drvdata(dev);
375 ret = kstrtouint(buf, 0, &val);
379 ret = regmap_write(pmic->regmap, bxtwc_reg_addr, val);
381 dev_err(dev, "Failed to write value 0x%02x to address 0x%lx",
382 val, bxtwc_reg_addr);
388 static DEVICE_ATTR_ADMIN_RW(addr);
389 static DEVICE_ATTR_ADMIN_RW(val);
390 static struct attribute *bxtwc_attrs[] = {
396 static const struct attribute_group bxtwc_group = {
397 .attrs = bxtwc_attrs,
400 static const struct attribute_group *bxtwc_groups[] = {
405 static const struct regmap_config bxtwc_regmap_config = {
408 .reg_write = regmap_ipc_byte_reg_write,
409 .reg_read = regmap_ipc_byte_reg_read,
412 static int bxtwc_add_chained_irq_chip(struct intel_soc_pmic *pmic,
413 struct regmap_irq_chip_data *pdata,
414 int pirq, int irq_flags,
415 const struct regmap_irq_chip *chip,
416 struct regmap_irq_chip_data **data)
420 irq = regmap_irq_get_virq(pdata, pirq);
422 return dev_err_probe(pmic->dev, irq, "Failed to get parent vIRQ(%d) for chip %s\n",
425 return devm_regmap_add_irq_chip(pmic->dev, pmic->regmap, irq, irq_flags,
429 static int bxtwc_probe(struct platform_device *pdev)
431 struct device *dev = &pdev->dev;
434 unsigned long long hrv;
435 struct intel_soc_pmic *pmic;
437 status = acpi_evaluate_integer(ACPI_HANDLE(dev), "_HRV", NULL, &hrv);
438 if (ACPI_FAILURE(status))
439 return dev_err_probe(dev, -ENODEV, "Failed to get PMIC hardware revision\n");
440 if (hrv != BROXTON_PMIC_WC_HRV)
441 return dev_err_probe(dev, -ENODEV, "Invalid PMIC hardware revision: %llu\n", hrv);
443 pmic = devm_kzalloc(dev, sizeof(*pmic), GFP_KERNEL);
447 ret = platform_get_irq(pdev, 0);
452 platform_set_drvdata(pdev, pmic);
455 pmic->scu = devm_intel_scu_ipc_dev_get(dev);
457 return -EPROBE_DEFER;
459 pmic->regmap = devm_regmap_init(dev, NULL, pmic, &bxtwc_regmap_config);
460 if (IS_ERR(pmic->regmap))
461 return dev_err_probe(dev, PTR_ERR(pmic->regmap), "Failed to initialise regmap\n");
463 ret = devm_regmap_add_irq_chip(dev, pmic->regmap, pmic->irq,
464 IRQF_ONESHOT | IRQF_SHARED,
465 0, &bxtwc_regmap_irq_chip,
466 &pmic->irq_chip_data);
468 return dev_err_probe(dev, ret, "Failed to add IRQ chip\n");
470 ret = bxtwc_add_chained_irq_chip(pmic, pmic->irq_chip_data,
471 BXTWC_PWRBTN_LVL1_IRQ,
473 &bxtwc_regmap_irq_chip_pwrbtn,
474 &pmic->irq_chip_data_pwrbtn);
476 return dev_err_probe(dev, ret, "Failed to add PWRBTN IRQ chip\n");
478 ret = bxtwc_add_chained_irq_chip(pmic, pmic->irq_chip_data,
481 &bxtwc_regmap_irq_chip_tmu,
482 &pmic->irq_chip_data_tmu);
484 return dev_err_probe(dev, ret, "Failed to add TMU IRQ chip\n");
486 /* Add chained IRQ handler for BCU IRQs */
487 ret = bxtwc_add_chained_irq_chip(pmic, pmic->irq_chip_data,
490 &bxtwc_regmap_irq_chip_bcu,
491 &pmic->irq_chip_data_bcu);
493 return dev_err_probe(dev, ret, "Failed to add BUC IRQ chip\n");
495 /* Add chained IRQ handler for ADC IRQs */
496 ret = bxtwc_add_chained_irq_chip(pmic, pmic->irq_chip_data,
499 &bxtwc_regmap_irq_chip_adc,
500 &pmic->irq_chip_data_adc);
502 return dev_err_probe(dev, ret, "Failed to add ADC IRQ chip\n");
504 /* Add chained IRQ handler for CHGR IRQs */
505 ret = bxtwc_add_chained_irq_chip(pmic, pmic->irq_chip_data,
508 &bxtwc_regmap_irq_chip_chgr,
509 &pmic->irq_chip_data_chgr);
511 return dev_err_probe(dev, ret, "Failed to add CHGR IRQ chip\n");
513 /* Add chained IRQ handler for CRIT IRQs */
514 ret = bxtwc_add_chained_irq_chip(pmic, pmic->irq_chip_data,
517 &bxtwc_regmap_irq_chip_crit,
518 &pmic->irq_chip_data_crit);
520 return dev_err_probe(dev, ret, "Failed to add CRIT IRQ chip\n");
522 ret = devm_mfd_add_devices(dev, PLATFORM_DEVID_NONE, bxt_wc_dev, ARRAY_SIZE(bxt_wc_dev),
525 return dev_err_probe(dev, ret, "Failed to add devices\n");
528 * There is a known H/W bug. Upon reset, BIT 5 of register
529 * BXTWC_CHGR_LVL1_IRQ is 0 which is the expected value. However,
530 * later it's set to 1(masked) automatically by hardware. So we
531 * place the software workaround here to unmask it again in order
532 * to re-enable the charger interrupt.
534 regmap_update_bits(pmic->regmap, BXTWC_MIRQLVL1, BXTWC_MIRQLVL1_MCHGR, 0);
539 static void bxtwc_shutdown(struct platform_device *pdev)
541 struct intel_soc_pmic *pmic = platform_get_drvdata(pdev);
543 disable_irq(pmic->irq);
546 static int bxtwc_suspend(struct device *dev)
548 struct intel_soc_pmic *pmic = dev_get_drvdata(dev);
550 disable_irq(pmic->irq);
555 static int bxtwc_resume(struct device *dev)
557 struct intel_soc_pmic *pmic = dev_get_drvdata(dev);
559 enable_irq(pmic->irq);
563 static DEFINE_SIMPLE_DEV_PM_OPS(bxtwc_pm_ops, bxtwc_suspend, bxtwc_resume);
565 static const struct acpi_device_id bxtwc_acpi_ids[] = {
569 MODULE_DEVICE_TABLE(acpi, bxtwc_acpi_ids);
571 static struct platform_driver bxtwc_driver = {
572 .probe = bxtwc_probe,
573 .shutdown = bxtwc_shutdown,
575 .name = "BXTWC PMIC",
576 .pm = pm_sleep_ptr(&bxtwc_pm_ops),
577 .acpi_match_table = bxtwc_acpi_ids,
578 .dev_groups = bxtwc_groups,
582 module_platform_driver(bxtwc_driver);
584 MODULE_LICENSE("GPL v2");