1 // SPDX-License-Identifier: GPL-2.0
3 * MFD core driver for Intel Broxton Whiskey Cove PMIC
5 * Copyright (C) 2015 Intel Corporation. All rights reserved.
8 #include <linux/acpi.h>
9 #include <linux/delay.h>
10 #include <linux/err.h>
11 #include <linux/interrupt.h>
12 #include <linux/kernel.h>
13 #include <linux/mfd/core.h>
14 #include <linux/mfd/intel_soc_pmic.h>
15 #include <linux/mfd/intel_soc_pmic_bxtwc.h>
16 #include <linux/module.h>
18 #include <asm/intel_scu_ipc.h>
20 /* PMIC device registers */
21 #define REG_ADDR_MASK 0xFF00
22 #define REG_ADDR_SHIFT 8
23 #define REG_OFFSET_MASK 0xFF
25 /* Interrupt Status Registers */
26 #define BXTWC_IRQLVL1 0x4E02
28 #define BXTWC_PWRBTNIRQ 0x4E03
29 #define BXTWC_THRM0IRQ 0x4E04
30 #define BXTWC_THRM1IRQ 0x4E05
31 #define BXTWC_THRM2IRQ 0x4E06
32 #define BXTWC_BCUIRQ 0x4E07
33 #define BXTWC_ADCIRQ 0x4E08
34 #define BXTWC_CHGR0IRQ 0x4E09
35 #define BXTWC_CHGR1IRQ 0x4E0A
36 #define BXTWC_GPIOIRQ0 0x4E0B
37 #define BXTWC_GPIOIRQ1 0x4E0C
38 #define BXTWC_CRITIRQ 0x4E0D
39 #define BXTWC_TMUIRQ 0x4FB6
41 /* Interrupt MASK Registers */
42 #define BXTWC_MIRQLVL1 0x4E0E
43 #define BXTWC_MIRQLVL1_MCHGR BIT(5)
45 #define BXTWC_MPWRBTNIRQ 0x4E0F
46 #define BXTWC_MTHRM0IRQ 0x4E12
47 #define BXTWC_MTHRM1IRQ 0x4E13
48 #define BXTWC_MTHRM2IRQ 0x4E14
49 #define BXTWC_MBCUIRQ 0x4E15
50 #define BXTWC_MADCIRQ 0x4E16
51 #define BXTWC_MCHGR0IRQ 0x4E17
52 #define BXTWC_MCHGR1IRQ 0x4E18
53 #define BXTWC_MGPIO0IRQ 0x4E19
54 #define BXTWC_MGPIO1IRQ 0x4E1A
55 #define BXTWC_MCRITIRQ 0x4E1B
56 #define BXTWC_MTMUIRQ 0x4FB7
58 /* Whiskey Cove PMIC share same ACPI ID between different platforms */
59 #define BROXTON_PMIC_WC_HRV 4
61 #define PMC_PMIC_ACCESS 0xFF
62 #define PMC_PMIC_READ 0x0
63 #define PMC_PMIC_WRITE 0x1
66 BXTWC_PWRBTN_LVL1_IRQ
= 0,
76 enum bxtwc_irqs_pwrbtn
{
89 enum bxtwc_irqs_chgr
{
99 enum bxtwc_irqs_crit
{
103 static const struct regmap_irq bxtwc_regmap_irqs
[] = {
104 REGMAP_IRQ_REG(BXTWC_PWRBTN_LVL1_IRQ
, 0, BIT(0)),
105 REGMAP_IRQ_REG(BXTWC_TMU_LVL1_IRQ
, 0, BIT(1)),
106 REGMAP_IRQ_REG(BXTWC_THRM_LVL1_IRQ
, 0, BIT(2)),
107 REGMAP_IRQ_REG(BXTWC_BCU_LVL1_IRQ
, 0, BIT(3)),
108 REGMAP_IRQ_REG(BXTWC_ADC_LVL1_IRQ
, 0, BIT(4)),
109 REGMAP_IRQ_REG(BXTWC_CHGR_LVL1_IRQ
, 0, BIT(5)),
110 REGMAP_IRQ_REG(BXTWC_GPIO_LVL1_IRQ
, 0, BIT(6)),
111 REGMAP_IRQ_REG(BXTWC_CRIT_LVL1_IRQ
, 0, BIT(7)),
114 static const struct regmap_irq bxtwc_regmap_irqs_pwrbtn
[] = {
115 REGMAP_IRQ_REG(BXTWC_PWRBTN_IRQ
, 0, 0x01),
118 static const struct regmap_irq bxtwc_regmap_irqs_bcu
[] = {
119 REGMAP_IRQ_REG(BXTWC_BCU_IRQ
, 0, 0x1f),
122 static const struct regmap_irq bxtwc_regmap_irqs_adc
[] = {
123 REGMAP_IRQ_REG(BXTWC_ADC_IRQ
, 0, 0xff),
126 static const struct regmap_irq bxtwc_regmap_irqs_chgr
[] = {
127 REGMAP_IRQ_REG(BXTWC_USBC_IRQ
, 0, 0x20),
128 REGMAP_IRQ_REG(BXTWC_CHGR0_IRQ
, 0, 0x1f),
129 REGMAP_IRQ_REG(BXTWC_CHGR1_IRQ
, 1, 0x1f),
132 static const struct regmap_irq bxtwc_regmap_irqs_tmu
[] = {
133 REGMAP_IRQ_REG(BXTWC_TMU_IRQ
, 0, 0x06),
136 static const struct regmap_irq bxtwc_regmap_irqs_crit
[] = {
137 REGMAP_IRQ_REG(BXTWC_CRIT_IRQ
, 0, 0x03),
140 static struct regmap_irq_chip bxtwc_regmap_irq_chip
= {
141 .name
= "bxtwc_irq_chip",
142 .status_base
= BXTWC_IRQLVL1
,
143 .mask_base
= BXTWC_MIRQLVL1
,
144 .irqs
= bxtwc_regmap_irqs
,
145 .num_irqs
= ARRAY_SIZE(bxtwc_regmap_irqs
),
149 static struct regmap_irq_chip bxtwc_regmap_irq_chip_pwrbtn
= {
150 .name
= "bxtwc_irq_chip_pwrbtn",
151 .status_base
= BXTWC_PWRBTNIRQ
,
152 .mask_base
= BXTWC_MPWRBTNIRQ
,
153 .irqs
= bxtwc_regmap_irqs_pwrbtn
,
154 .num_irqs
= ARRAY_SIZE(bxtwc_regmap_irqs_pwrbtn
),
158 static struct regmap_irq_chip bxtwc_regmap_irq_chip_tmu
= {
159 .name
= "bxtwc_irq_chip_tmu",
160 .status_base
= BXTWC_TMUIRQ
,
161 .mask_base
= BXTWC_MTMUIRQ
,
162 .irqs
= bxtwc_regmap_irqs_tmu
,
163 .num_irqs
= ARRAY_SIZE(bxtwc_regmap_irqs_tmu
),
167 static struct regmap_irq_chip bxtwc_regmap_irq_chip_bcu
= {
168 .name
= "bxtwc_irq_chip_bcu",
169 .status_base
= BXTWC_BCUIRQ
,
170 .mask_base
= BXTWC_MBCUIRQ
,
171 .irqs
= bxtwc_regmap_irqs_bcu
,
172 .num_irqs
= ARRAY_SIZE(bxtwc_regmap_irqs_bcu
),
176 static struct regmap_irq_chip bxtwc_regmap_irq_chip_adc
= {
177 .name
= "bxtwc_irq_chip_adc",
178 .status_base
= BXTWC_ADCIRQ
,
179 .mask_base
= BXTWC_MADCIRQ
,
180 .irqs
= bxtwc_regmap_irqs_adc
,
181 .num_irqs
= ARRAY_SIZE(bxtwc_regmap_irqs_adc
),
185 static struct regmap_irq_chip bxtwc_regmap_irq_chip_chgr
= {
186 .name
= "bxtwc_irq_chip_chgr",
187 .status_base
= BXTWC_CHGR0IRQ
,
188 .mask_base
= BXTWC_MCHGR0IRQ
,
189 .irqs
= bxtwc_regmap_irqs_chgr
,
190 .num_irqs
= ARRAY_SIZE(bxtwc_regmap_irqs_chgr
),
194 static struct regmap_irq_chip bxtwc_regmap_irq_chip_crit
= {
195 .name
= "bxtwc_irq_chip_crit",
196 .status_base
= BXTWC_CRITIRQ
,
197 .mask_base
= BXTWC_MCRITIRQ
,
198 .irqs
= bxtwc_regmap_irqs_crit
,
199 .num_irqs
= ARRAY_SIZE(bxtwc_regmap_irqs_crit
),
203 static const struct resource gpio_resources
[] = {
204 DEFINE_RES_IRQ_NAMED(BXTWC_GPIO_LVL1_IRQ
, "GPIO"),
207 static const struct resource adc_resources
[] = {
208 DEFINE_RES_IRQ_NAMED(BXTWC_ADC_IRQ
, "ADC"),
211 static const struct resource usbc_resources
[] = {
212 DEFINE_RES_IRQ(BXTWC_USBC_IRQ
),
215 static const struct resource charger_resources
[] = {
216 DEFINE_RES_IRQ_NAMED(BXTWC_CHGR0_IRQ
, "CHARGER"),
217 DEFINE_RES_IRQ_NAMED(BXTWC_CHGR1_IRQ
, "CHARGER1"),
220 static const struct resource thermal_resources
[] = {
221 DEFINE_RES_IRQ(BXTWC_THRM_LVL1_IRQ
),
224 static const struct resource bcu_resources
[] = {
225 DEFINE_RES_IRQ_NAMED(BXTWC_BCU_IRQ
, "BCU"),
228 static const struct resource tmu_resources
[] = {
229 DEFINE_RES_IRQ_NAMED(BXTWC_TMU_IRQ
, "TMU"),
232 static struct mfd_cell bxt_wc_dev
[] = {
234 .name
= "bxt_wcove_gpadc",
235 .num_resources
= ARRAY_SIZE(adc_resources
),
236 .resources
= adc_resources
,
239 .name
= "bxt_wcove_thermal",
240 .num_resources
= ARRAY_SIZE(thermal_resources
),
241 .resources
= thermal_resources
,
244 .name
= "bxt_wcove_usbc",
245 .num_resources
= ARRAY_SIZE(usbc_resources
),
246 .resources
= usbc_resources
,
249 .name
= "bxt_wcove_ext_charger",
250 .num_resources
= ARRAY_SIZE(charger_resources
),
251 .resources
= charger_resources
,
254 .name
= "bxt_wcove_bcu",
255 .num_resources
= ARRAY_SIZE(bcu_resources
),
256 .resources
= bcu_resources
,
259 .name
= "bxt_wcove_tmu",
260 .num_resources
= ARRAY_SIZE(tmu_resources
),
261 .resources
= tmu_resources
,
265 .name
= "bxt_wcove_gpio",
266 .num_resources
= ARRAY_SIZE(gpio_resources
),
267 .resources
= gpio_resources
,
270 .name
= "bxt_wcove_region",
274 static int regmap_ipc_byte_reg_read(void *context
, unsigned int reg
,
281 struct intel_soc_pmic
*pmic
= context
;
286 if (reg
& REG_ADDR_MASK
)
287 i2c_addr
= (reg
& REG_ADDR_MASK
) >> REG_ADDR_SHIFT
;
289 i2c_addr
= BXTWC_DEVICE1_ADDR
;
291 reg
&= REG_OFFSET_MASK
;
294 ipc_in
[1] = i2c_addr
;
295 ret
= intel_scu_ipc_dev_command(pmic
->scu
, PMC_PMIC_ACCESS
,
296 PMC_PMIC_READ
, ipc_in
, sizeof(ipc_in
),
297 ipc_out
, sizeof(ipc_out
));
306 static int regmap_ipc_byte_reg_write(void *context
, unsigned int reg
,
311 struct intel_soc_pmic
*pmic
= context
;
316 if (reg
& REG_ADDR_MASK
)
317 i2c_addr
= (reg
& REG_ADDR_MASK
) >> REG_ADDR_SHIFT
;
319 i2c_addr
= BXTWC_DEVICE1_ADDR
;
321 reg
&= REG_OFFSET_MASK
;
324 ipc_in
[1] = i2c_addr
;
326 return intel_scu_ipc_dev_command(pmic
->scu
, PMC_PMIC_ACCESS
,
327 PMC_PMIC_WRITE
, ipc_in
, sizeof(ipc_in
),
331 /* sysfs interfaces to r/w PMIC registers, required by initial script */
332 static unsigned long bxtwc_reg_addr
;
333 static ssize_t
bxtwc_reg_show(struct device
*dev
,
334 struct device_attribute
*attr
, char *buf
)
336 return sprintf(buf
, "0x%lx\n", bxtwc_reg_addr
);
339 static ssize_t
bxtwc_reg_store(struct device
*dev
,
340 struct device_attribute
*attr
, const char *buf
, size_t count
)
342 if (kstrtoul(buf
, 0, &bxtwc_reg_addr
)) {
343 dev_err(dev
, "Invalid register address\n");
346 return (ssize_t
)count
;
349 static ssize_t
bxtwc_val_show(struct device
*dev
,
350 struct device_attribute
*attr
, char *buf
)
354 struct intel_soc_pmic
*pmic
= dev_get_drvdata(dev
);
356 ret
= regmap_read(pmic
->regmap
, bxtwc_reg_addr
, &val
);
358 dev_err(dev
, "Failed to read 0x%lx\n", bxtwc_reg_addr
);
362 return sprintf(buf
, "0x%02x\n", val
);
365 static ssize_t
bxtwc_val_store(struct device
*dev
,
366 struct device_attribute
*attr
, const char *buf
, size_t count
)
370 struct intel_soc_pmic
*pmic
= dev_get_drvdata(dev
);
372 ret
= kstrtouint(buf
, 0, &val
);
376 ret
= regmap_write(pmic
->regmap
, bxtwc_reg_addr
, val
);
378 dev_err(dev
, "Failed to write value 0x%02x to address 0x%lx",
379 val
, bxtwc_reg_addr
);
385 static DEVICE_ATTR(addr
, S_IWUSR
| S_IRUSR
, bxtwc_reg_show
, bxtwc_reg_store
);
386 static DEVICE_ATTR(val
, S_IWUSR
| S_IRUSR
, bxtwc_val_show
, bxtwc_val_store
);
387 static struct attribute
*bxtwc_attrs
[] = {
393 static const struct attribute_group bxtwc_group
= {
394 .attrs
= bxtwc_attrs
,
397 static const struct regmap_config bxtwc_regmap_config
= {
400 .reg_write
= regmap_ipc_byte_reg_write
,
401 .reg_read
= regmap_ipc_byte_reg_read
,
404 static int bxtwc_add_chained_irq_chip(struct intel_soc_pmic
*pmic
,
405 struct regmap_irq_chip_data
*pdata
,
406 int pirq
, int irq_flags
,
407 const struct regmap_irq_chip
*chip
,
408 struct regmap_irq_chip_data
**data
)
412 irq
= regmap_irq_get_virq(pdata
, pirq
);
415 "Failed to get parent vIRQ(%d) for chip %s, ret:%d\n",
416 pirq
, chip
->name
, irq
);
420 return devm_regmap_add_irq_chip(pmic
->dev
, pmic
->regmap
, irq
, irq_flags
,
424 static int bxtwc_probe(struct platform_device
*pdev
)
429 unsigned long long hrv
;
430 struct intel_soc_pmic
*pmic
;
432 handle
= ACPI_HANDLE(&pdev
->dev
);
433 status
= acpi_evaluate_integer(handle
, "_HRV", NULL
, &hrv
);
434 if (ACPI_FAILURE(status
)) {
435 dev_err(&pdev
->dev
, "Failed to get PMIC hardware revision\n");
438 if (hrv
!= BROXTON_PMIC_WC_HRV
) {
439 dev_err(&pdev
->dev
, "Invalid PMIC hardware revision: %llu\n",
444 pmic
= devm_kzalloc(&pdev
->dev
, sizeof(*pmic
), GFP_KERNEL
);
448 ret
= platform_get_irq(pdev
, 0);
453 dev_set_drvdata(&pdev
->dev
, pmic
);
454 pmic
->dev
= &pdev
->dev
;
456 pmic
->scu
= devm_intel_scu_ipc_dev_get(&pdev
->dev
);
458 return -EPROBE_DEFER
;
460 pmic
->regmap
= devm_regmap_init(&pdev
->dev
, NULL
, pmic
,
461 &bxtwc_regmap_config
);
462 if (IS_ERR(pmic
->regmap
)) {
463 ret
= PTR_ERR(pmic
->regmap
);
464 dev_err(&pdev
->dev
, "Failed to initialise regmap: %d\n", ret
);
468 ret
= devm_regmap_add_irq_chip(&pdev
->dev
, pmic
->regmap
, pmic
->irq
,
469 IRQF_ONESHOT
| IRQF_SHARED
,
470 0, &bxtwc_regmap_irq_chip
,
471 &pmic
->irq_chip_data
);
473 dev_err(&pdev
->dev
, "Failed to add IRQ chip\n");
477 ret
= bxtwc_add_chained_irq_chip(pmic
, pmic
->irq_chip_data
,
478 BXTWC_PWRBTN_LVL1_IRQ
,
480 &bxtwc_regmap_irq_chip_pwrbtn
,
481 &pmic
->irq_chip_data_pwrbtn
);
483 dev_err(&pdev
->dev
, "Failed to add PWRBTN IRQ chip\n");
487 ret
= bxtwc_add_chained_irq_chip(pmic
, pmic
->irq_chip_data
,
490 &bxtwc_regmap_irq_chip_tmu
,
491 &pmic
->irq_chip_data_tmu
);
493 dev_err(&pdev
->dev
, "Failed to add TMU IRQ chip\n");
497 /* Add chained IRQ handler for BCU IRQs */
498 ret
= bxtwc_add_chained_irq_chip(pmic
, pmic
->irq_chip_data
,
501 &bxtwc_regmap_irq_chip_bcu
,
502 &pmic
->irq_chip_data_bcu
);
506 dev_err(&pdev
->dev
, "Failed to add BUC IRQ chip\n");
510 /* Add chained IRQ handler for ADC IRQs */
511 ret
= bxtwc_add_chained_irq_chip(pmic
, pmic
->irq_chip_data
,
514 &bxtwc_regmap_irq_chip_adc
,
515 &pmic
->irq_chip_data_adc
);
519 dev_err(&pdev
->dev
, "Failed to add ADC IRQ chip\n");
523 /* Add chained IRQ handler for CHGR IRQs */
524 ret
= bxtwc_add_chained_irq_chip(pmic
, pmic
->irq_chip_data
,
527 &bxtwc_regmap_irq_chip_chgr
,
528 &pmic
->irq_chip_data_chgr
);
532 dev_err(&pdev
->dev
, "Failed to add CHGR IRQ chip\n");
536 /* Add chained IRQ handler for CRIT IRQs */
537 ret
= bxtwc_add_chained_irq_chip(pmic
, pmic
->irq_chip_data
,
540 &bxtwc_regmap_irq_chip_crit
,
541 &pmic
->irq_chip_data_crit
);
545 dev_err(&pdev
->dev
, "Failed to add CRIT IRQ chip\n");
549 ret
= devm_mfd_add_devices(&pdev
->dev
, PLATFORM_DEVID_NONE
, bxt_wc_dev
,
550 ARRAY_SIZE(bxt_wc_dev
), NULL
, 0, NULL
);
552 dev_err(&pdev
->dev
, "Failed to add devices\n");
556 ret
= sysfs_create_group(&pdev
->dev
.kobj
, &bxtwc_group
);
558 dev_err(&pdev
->dev
, "Failed to create sysfs group %d\n", ret
);
563 * There is known hw bug. Upon reset BIT 5 of register
564 * BXTWC_CHGR_LVL1_IRQ is 0 which is the expected value. However,
565 * later it's set to 1(masked) automatically by hardware. So we
566 * have the software workaround here to unmaksed it in order to let
567 * charger interrutp work.
569 regmap_update_bits(pmic
->regmap
, BXTWC_MIRQLVL1
,
570 BXTWC_MIRQLVL1_MCHGR
, 0);
575 static int bxtwc_remove(struct platform_device
*pdev
)
577 sysfs_remove_group(&pdev
->dev
.kobj
, &bxtwc_group
);
582 static void bxtwc_shutdown(struct platform_device
*pdev
)
584 struct intel_soc_pmic
*pmic
= dev_get_drvdata(&pdev
->dev
);
586 disable_irq(pmic
->irq
);
589 #ifdef CONFIG_PM_SLEEP
590 static int bxtwc_suspend(struct device
*dev
)
592 struct intel_soc_pmic
*pmic
= dev_get_drvdata(dev
);
594 disable_irq(pmic
->irq
);
599 static int bxtwc_resume(struct device
*dev
)
601 struct intel_soc_pmic
*pmic
= dev_get_drvdata(dev
);
603 enable_irq(pmic
->irq
);
607 static SIMPLE_DEV_PM_OPS(bxtwc_pm_ops
, bxtwc_suspend
, bxtwc_resume
);
609 static const struct acpi_device_id bxtwc_acpi_ids
[] = {
613 MODULE_DEVICE_TABLE(acpi
, bxtwc_acpi_ids
);
615 static struct platform_driver bxtwc_driver
= {
616 .probe
= bxtwc_probe
,
617 .remove
= bxtwc_remove
,
618 .shutdown
= bxtwc_shutdown
,
620 .name
= "BXTWC PMIC",
622 .acpi_match_table
= ACPI_PTR(bxtwc_acpi_ids
),
626 module_platform_driver(bxtwc_driver
);
628 MODULE_LICENSE("GPL v2");
629 MODULE_AUTHOR("Qipeng Zha<qipeng.zha@intel.com>");