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_pmc_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
62 BXTWC_PWRBTN_LVL1_IRQ
= 0,
72 enum bxtwc_irqs_pwrbtn
{
85 enum bxtwc_irqs_chgr
{
95 enum bxtwc_irqs_crit
{
99 static const struct regmap_irq bxtwc_regmap_irqs
[] = {
100 REGMAP_IRQ_REG(BXTWC_PWRBTN_LVL1_IRQ
, 0, BIT(0)),
101 REGMAP_IRQ_REG(BXTWC_TMU_LVL1_IRQ
, 0, BIT(1)),
102 REGMAP_IRQ_REG(BXTWC_THRM_LVL1_IRQ
, 0, BIT(2)),
103 REGMAP_IRQ_REG(BXTWC_BCU_LVL1_IRQ
, 0, BIT(3)),
104 REGMAP_IRQ_REG(BXTWC_ADC_LVL1_IRQ
, 0, BIT(4)),
105 REGMAP_IRQ_REG(BXTWC_CHGR_LVL1_IRQ
, 0, BIT(5)),
106 REGMAP_IRQ_REG(BXTWC_GPIO_LVL1_IRQ
, 0, BIT(6)),
107 REGMAP_IRQ_REG(BXTWC_CRIT_LVL1_IRQ
, 0, BIT(7)),
110 static const struct regmap_irq bxtwc_regmap_irqs_pwrbtn
[] = {
111 REGMAP_IRQ_REG(BXTWC_PWRBTN_IRQ
, 0, 0x01),
114 static const struct regmap_irq bxtwc_regmap_irqs_bcu
[] = {
115 REGMAP_IRQ_REG(BXTWC_BCU_IRQ
, 0, 0x1f),
118 static const struct regmap_irq bxtwc_regmap_irqs_adc
[] = {
119 REGMAP_IRQ_REG(BXTWC_ADC_IRQ
, 0, 0xff),
122 static const struct regmap_irq bxtwc_regmap_irqs_chgr
[] = {
123 REGMAP_IRQ_REG(BXTWC_USBC_IRQ
, 0, 0x20),
124 REGMAP_IRQ_REG(BXTWC_CHGR0_IRQ
, 0, 0x1f),
125 REGMAP_IRQ_REG(BXTWC_CHGR1_IRQ
, 1, 0x1f),
128 static const struct regmap_irq bxtwc_regmap_irqs_tmu
[] = {
129 REGMAP_IRQ_REG(BXTWC_TMU_IRQ
, 0, 0x06),
132 static const struct regmap_irq bxtwc_regmap_irqs_crit
[] = {
133 REGMAP_IRQ_REG(BXTWC_CRIT_IRQ
, 0, 0x03),
136 static struct regmap_irq_chip bxtwc_regmap_irq_chip
= {
137 .name
= "bxtwc_irq_chip",
138 .status_base
= BXTWC_IRQLVL1
,
139 .mask_base
= BXTWC_MIRQLVL1
,
140 .irqs
= bxtwc_regmap_irqs
,
141 .num_irqs
= ARRAY_SIZE(bxtwc_regmap_irqs
),
145 static struct regmap_irq_chip bxtwc_regmap_irq_chip_pwrbtn
= {
146 .name
= "bxtwc_irq_chip_pwrbtn",
147 .status_base
= BXTWC_PWRBTNIRQ
,
148 .mask_base
= BXTWC_MPWRBTNIRQ
,
149 .irqs
= bxtwc_regmap_irqs_pwrbtn
,
150 .num_irqs
= ARRAY_SIZE(bxtwc_regmap_irqs_pwrbtn
),
154 static struct regmap_irq_chip bxtwc_regmap_irq_chip_tmu
= {
155 .name
= "bxtwc_irq_chip_tmu",
156 .status_base
= BXTWC_TMUIRQ
,
157 .mask_base
= BXTWC_MTMUIRQ
,
158 .irqs
= bxtwc_regmap_irqs_tmu
,
159 .num_irqs
= ARRAY_SIZE(bxtwc_regmap_irqs_tmu
),
163 static struct regmap_irq_chip bxtwc_regmap_irq_chip_bcu
= {
164 .name
= "bxtwc_irq_chip_bcu",
165 .status_base
= BXTWC_BCUIRQ
,
166 .mask_base
= BXTWC_MBCUIRQ
,
167 .irqs
= bxtwc_regmap_irqs_bcu
,
168 .num_irqs
= ARRAY_SIZE(bxtwc_regmap_irqs_bcu
),
172 static struct regmap_irq_chip bxtwc_regmap_irq_chip_adc
= {
173 .name
= "bxtwc_irq_chip_adc",
174 .status_base
= BXTWC_ADCIRQ
,
175 .mask_base
= BXTWC_MADCIRQ
,
176 .irqs
= bxtwc_regmap_irqs_adc
,
177 .num_irqs
= ARRAY_SIZE(bxtwc_regmap_irqs_adc
),
181 static struct regmap_irq_chip bxtwc_regmap_irq_chip_chgr
= {
182 .name
= "bxtwc_irq_chip_chgr",
183 .status_base
= BXTWC_CHGR0IRQ
,
184 .mask_base
= BXTWC_MCHGR0IRQ
,
185 .irqs
= bxtwc_regmap_irqs_chgr
,
186 .num_irqs
= ARRAY_SIZE(bxtwc_regmap_irqs_chgr
),
190 static struct regmap_irq_chip bxtwc_regmap_irq_chip_crit
= {
191 .name
= "bxtwc_irq_chip_crit",
192 .status_base
= BXTWC_CRITIRQ
,
193 .mask_base
= BXTWC_MCRITIRQ
,
194 .irqs
= bxtwc_regmap_irqs_crit
,
195 .num_irqs
= ARRAY_SIZE(bxtwc_regmap_irqs_crit
),
199 static struct resource gpio_resources
[] = {
200 DEFINE_RES_IRQ_NAMED(BXTWC_GPIO_LVL1_IRQ
, "GPIO"),
203 static struct resource adc_resources
[] = {
204 DEFINE_RES_IRQ_NAMED(BXTWC_ADC_IRQ
, "ADC"),
207 static struct resource usbc_resources
[] = {
208 DEFINE_RES_IRQ(BXTWC_USBC_IRQ
),
211 static struct resource charger_resources
[] = {
212 DEFINE_RES_IRQ_NAMED(BXTWC_CHGR0_IRQ
, "CHARGER"),
213 DEFINE_RES_IRQ_NAMED(BXTWC_CHGR1_IRQ
, "CHARGER1"),
216 static struct resource thermal_resources
[] = {
217 DEFINE_RES_IRQ(BXTWC_THRM_LVL1_IRQ
),
220 static struct resource bcu_resources
[] = {
221 DEFINE_RES_IRQ_NAMED(BXTWC_BCU_IRQ
, "BCU"),
224 static struct resource tmu_resources
[] = {
225 DEFINE_RES_IRQ_NAMED(BXTWC_TMU_IRQ
, "TMU"),
228 static struct mfd_cell bxt_wc_dev
[] = {
230 .name
= "bxt_wcove_gpadc",
231 .num_resources
= ARRAY_SIZE(adc_resources
),
232 .resources
= adc_resources
,
235 .name
= "bxt_wcove_thermal",
236 .num_resources
= ARRAY_SIZE(thermal_resources
),
237 .resources
= thermal_resources
,
240 .name
= "bxt_wcove_usbc",
241 .num_resources
= ARRAY_SIZE(usbc_resources
),
242 .resources
= usbc_resources
,
245 .name
= "bxt_wcove_ext_charger",
246 .num_resources
= ARRAY_SIZE(charger_resources
),
247 .resources
= charger_resources
,
250 .name
= "bxt_wcove_bcu",
251 .num_resources
= ARRAY_SIZE(bcu_resources
),
252 .resources
= bcu_resources
,
255 .name
= "bxt_wcove_tmu",
256 .num_resources
= ARRAY_SIZE(tmu_resources
),
257 .resources
= tmu_resources
,
261 .name
= "bxt_wcove_gpio",
262 .num_resources
= ARRAY_SIZE(gpio_resources
),
263 .resources
= gpio_resources
,
266 .name
= "bxt_wcove_region",
270 static int regmap_ipc_byte_reg_read(void *context
, unsigned int reg
,
277 struct intel_soc_pmic
*pmic
= context
;
282 if (reg
& REG_ADDR_MASK
)
283 i2c_addr
= (reg
& REG_ADDR_MASK
) >> REG_ADDR_SHIFT
;
285 i2c_addr
= BXTWC_DEVICE1_ADDR
;
287 reg
&= REG_OFFSET_MASK
;
290 ipc_in
[1] = i2c_addr
;
291 ret
= intel_pmc_ipc_command(PMC_IPC_PMIC_ACCESS
,
292 PMC_IPC_PMIC_ACCESS_READ
,
293 ipc_in
, sizeof(ipc_in
), (u32
*)ipc_out
, 1);
295 dev_err(pmic
->dev
, "Failed to read from PMIC\n");
303 static int regmap_ipc_byte_reg_write(void *context
, unsigned int reg
,
309 struct intel_soc_pmic
*pmic
= context
;
314 if (reg
& REG_ADDR_MASK
)
315 i2c_addr
= (reg
& REG_ADDR_MASK
) >> REG_ADDR_SHIFT
;
317 i2c_addr
= BXTWC_DEVICE1_ADDR
;
319 reg
&= REG_OFFSET_MASK
;
322 ipc_in
[1] = i2c_addr
;
324 ret
= intel_pmc_ipc_command(PMC_IPC_PMIC_ACCESS
,
325 PMC_IPC_PMIC_ACCESS_WRITE
,
326 ipc_in
, sizeof(ipc_in
), NULL
, 0);
328 dev_err(pmic
->dev
, "Failed to write to PMIC\n");
335 /* sysfs interfaces to r/w PMIC registers, required by initial script */
336 static unsigned long bxtwc_reg_addr
;
337 static ssize_t
bxtwc_reg_show(struct device
*dev
,
338 struct device_attribute
*attr
, char *buf
)
340 return sprintf(buf
, "0x%lx\n", bxtwc_reg_addr
);
343 static ssize_t
bxtwc_reg_store(struct device
*dev
,
344 struct device_attribute
*attr
, const char *buf
, size_t count
)
346 if (kstrtoul(buf
, 0, &bxtwc_reg_addr
)) {
347 dev_err(dev
, "Invalid register address\n");
350 return (ssize_t
)count
;
353 static ssize_t
bxtwc_val_show(struct device
*dev
,
354 struct device_attribute
*attr
, char *buf
)
358 struct intel_soc_pmic
*pmic
= dev_get_drvdata(dev
);
360 ret
= regmap_read(pmic
->regmap
, bxtwc_reg_addr
, &val
);
362 dev_err(dev
, "Failed to read 0x%lx\n", bxtwc_reg_addr
);
366 return sprintf(buf
, "0x%02x\n", val
);
369 static ssize_t
bxtwc_val_store(struct device
*dev
,
370 struct device_attribute
*attr
, const char *buf
, size_t count
)
374 struct intel_soc_pmic
*pmic
= dev_get_drvdata(dev
);
376 ret
= kstrtouint(buf
, 0, &val
);
380 ret
= regmap_write(pmic
->regmap
, bxtwc_reg_addr
, val
);
382 dev_err(dev
, "Failed to write value 0x%02x to address 0x%lx",
383 val
, bxtwc_reg_addr
);
389 static DEVICE_ATTR(addr
, S_IWUSR
| S_IRUSR
, bxtwc_reg_show
, bxtwc_reg_store
);
390 static DEVICE_ATTR(val
, S_IWUSR
| S_IRUSR
, bxtwc_val_show
, bxtwc_val_store
);
391 static struct attribute
*bxtwc_attrs
[] = {
397 static const struct attribute_group bxtwc_group
= {
398 .attrs
= bxtwc_attrs
,
401 static const struct regmap_config bxtwc_regmap_config
= {
404 .reg_write
= regmap_ipc_byte_reg_write
,
405 .reg_read
= regmap_ipc_byte_reg_read
,
408 static int bxtwc_add_chained_irq_chip(struct intel_soc_pmic
*pmic
,
409 struct regmap_irq_chip_data
*pdata
,
410 int pirq
, int irq_flags
,
411 const struct regmap_irq_chip
*chip
,
412 struct regmap_irq_chip_data
**data
)
416 irq
= regmap_irq_get_virq(pdata
, pirq
);
419 "Failed to get parent vIRQ(%d) for chip %s, ret:%d\n",
420 pirq
, chip
->name
, irq
);
424 return devm_regmap_add_irq_chip(pmic
->dev
, pmic
->regmap
, irq
, irq_flags
,
428 static int bxtwc_probe(struct platform_device
*pdev
)
433 unsigned long long hrv
;
434 struct intel_soc_pmic
*pmic
;
436 handle
= ACPI_HANDLE(&pdev
->dev
);
437 status
= acpi_evaluate_integer(handle
, "_HRV", NULL
, &hrv
);
438 if (ACPI_FAILURE(status
)) {
439 dev_err(&pdev
->dev
, "Failed to get PMIC hardware revision\n");
442 if (hrv
!= BROXTON_PMIC_WC_HRV
) {
443 dev_err(&pdev
->dev
, "Invalid PMIC hardware revision: %llu\n",
448 pmic
= devm_kzalloc(&pdev
->dev
, sizeof(*pmic
), GFP_KERNEL
);
452 ret
= platform_get_irq(pdev
, 0);
457 dev_set_drvdata(&pdev
->dev
, pmic
);
458 pmic
->dev
= &pdev
->dev
;
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>");