1 // SPDX-License-Identifier: GPL-2.0-only
3 * Maxim MAX77620 MFD Driver
5 * Copyright (C) 2016 NVIDIA CORPORATION. All rights reserved.
8 * Laxman Dewangan <ldewangan@nvidia.com>
9 * Chaitanya Bandi <bandik@nvidia.com>
10 * Mallikarjun Kasoju <mkasoju@nvidia.com>
13 /****************** Teminology used in driver ********************
14 * Here are some terminology used from datasheet for quick reference:
15 * Flexible Power Sequence (FPS):
16 * The Flexible Power Sequencer (FPS) allows each regulator to power up under
17 * hardware or software control. Additionally, each regulator can power on
18 * independently or among a group of other regulators with an adjustable
19 * power-up and power-down delays (sequencing). GPIO1, GPIO2, and GPIO3 can
20 * be programmed to be part of a sequence allowing external regulators to be
21 * sequenced along with internal regulators. 32KHz clock can be programmed to
22 * be part of a sequence.
23 * There is 3 FPS confguration registers and all resources are configured to
24 * any of these FPS or no FPS.
27 #include <linux/i2c.h>
28 #include <linux/interrupt.h>
29 #include <linux/mfd/core.h>
30 #include <linux/mfd/max77620.h>
31 #include <linux/init.h>
33 #include <linux/of_device.h>
34 #include <linux/regmap.h>
35 #include <linux/slab.h>
37 static struct max77620_chip *max77620_scratch;
39 static const struct resource gpio_resources[] = {
40 DEFINE_RES_IRQ(MAX77620_IRQ_TOP_GPIO),
43 static const struct resource power_resources[] = {
44 DEFINE_RES_IRQ(MAX77620_IRQ_LBT_MBATLOW),
47 static const struct resource rtc_resources[] = {
48 DEFINE_RES_IRQ(MAX77620_IRQ_TOP_RTC),
51 static const struct resource thermal_resources[] = {
52 DEFINE_RES_IRQ(MAX77620_IRQ_LBT_TJALRM1),
53 DEFINE_RES_IRQ(MAX77620_IRQ_LBT_TJALRM2),
56 static const struct regmap_irq max77620_top_irqs[] = {
57 REGMAP_IRQ_REG(MAX77620_IRQ_TOP_GLBL, 0, MAX77620_IRQ_TOP_GLBL_MASK),
58 REGMAP_IRQ_REG(MAX77620_IRQ_TOP_SD, 0, MAX77620_IRQ_TOP_SD_MASK),
59 REGMAP_IRQ_REG(MAX77620_IRQ_TOP_LDO, 0, MAX77620_IRQ_TOP_LDO_MASK),
60 REGMAP_IRQ_REG(MAX77620_IRQ_TOP_GPIO, 0, MAX77620_IRQ_TOP_GPIO_MASK),
61 REGMAP_IRQ_REG(MAX77620_IRQ_TOP_RTC, 0, MAX77620_IRQ_TOP_RTC_MASK),
62 REGMAP_IRQ_REG(MAX77620_IRQ_TOP_32K, 0, MAX77620_IRQ_TOP_32K_MASK),
63 REGMAP_IRQ_REG(MAX77620_IRQ_TOP_ONOFF, 0, MAX77620_IRQ_TOP_ONOFF_MASK),
64 REGMAP_IRQ_REG(MAX77620_IRQ_LBT_MBATLOW, 1, MAX77620_IRQ_LBM_MASK),
65 REGMAP_IRQ_REG(MAX77620_IRQ_LBT_TJALRM1, 1, MAX77620_IRQ_TJALRM1_MASK),
66 REGMAP_IRQ_REG(MAX77620_IRQ_LBT_TJALRM2, 1, MAX77620_IRQ_TJALRM2_MASK),
69 static const struct mfd_cell max77620_children[] = {
70 { .name = "max77620-pinctrl", },
71 { .name = "max77620-clock", },
72 { .name = "max77620-pmic", },
73 { .name = "max77620-watchdog", },
75 .name = "max77620-gpio",
76 .resources = gpio_resources,
77 .num_resources = ARRAY_SIZE(gpio_resources),
79 .name = "max77620-rtc",
80 .resources = rtc_resources,
81 .num_resources = ARRAY_SIZE(rtc_resources),
83 .name = "max77620-power",
84 .resources = power_resources,
85 .num_resources = ARRAY_SIZE(power_resources),
87 .name = "max77620-thermal",
88 .resources = thermal_resources,
89 .num_resources = ARRAY_SIZE(thermal_resources),
93 static const struct mfd_cell max20024_children[] = {
94 { .name = "max20024-pinctrl", },
95 { .name = "max77620-clock", },
96 { .name = "max20024-pmic", },
97 { .name = "max77620-watchdog", },
99 .name = "max77620-gpio",
100 .resources = gpio_resources,
101 .num_resources = ARRAY_SIZE(gpio_resources),
103 .name = "max77620-rtc",
104 .resources = rtc_resources,
105 .num_resources = ARRAY_SIZE(rtc_resources),
107 .name = "max20024-power",
108 .resources = power_resources,
109 .num_resources = ARRAY_SIZE(power_resources),
113 static const struct mfd_cell max77663_children[] = {
114 { .name = "max77620-pinctrl", },
115 { .name = "max77620-clock", },
116 { .name = "max77663-pmic", },
117 { .name = "max77620-watchdog", },
119 .name = "max77620-gpio",
120 .resources = gpio_resources,
121 .num_resources = ARRAY_SIZE(gpio_resources),
123 .name = "max77620-rtc",
124 .resources = rtc_resources,
125 .num_resources = ARRAY_SIZE(rtc_resources),
127 .name = "max77663-power",
128 .resources = power_resources,
129 .num_resources = ARRAY_SIZE(power_resources),
133 static const struct regmap_range max77620_readable_ranges[] = {
134 regmap_reg_range(MAX77620_REG_CNFGGLBL1, MAX77620_REG_DVSSD4),
137 static const struct regmap_access_table max77620_readable_table = {
138 .yes_ranges = max77620_readable_ranges,
139 .n_yes_ranges = ARRAY_SIZE(max77620_readable_ranges),
142 static const struct regmap_range max20024_readable_ranges[] = {
143 regmap_reg_range(MAX77620_REG_CNFGGLBL1, MAX77620_REG_DVSSD4),
144 regmap_reg_range(MAX20024_REG_MAX_ADD, MAX20024_REG_MAX_ADD),
147 static const struct regmap_access_table max20024_readable_table = {
148 .yes_ranges = max20024_readable_ranges,
149 .n_yes_ranges = ARRAY_SIZE(max20024_readable_ranges),
152 static const struct regmap_range max77620_writable_ranges[] = {
153 regmap_reg_range(MAX77620_REG_CNFGGLBL1, MAX77620_REG_DVSSD4),
156 static const struct regmap_access_table max77620_writable_table = {
157 .yes_ranges = max77620_writable_ranges,
158 .n_yes_ranges = ARRAY_SIZE(max77620_writable_ranges),
161 static const struct regmap_range max77620_cacheable_ranges[] = {
162 regmap_reg_range(MAX77620_REG_SD0_CFG, MAX77620_REG_LDO_CFG3),
163 regmap_reg_range(MAX77620_REG_FPS_CFG0, MAX77620_REG_FPS_SD3),
166 static const struct regmap_access_table max77620_volatile_table = {
167 .no_ranges = max77620_cacheable_ranges,
168 .n_no_ranges = ARRAY_SIZE(max77620_cacheable_ranges),
171 static const struct regmap_config max77620_regmap_config = {
172 .name = "power-slave",
175 .max_register = MAX77620_REG_DVSSD4 + 1,
176 .cache_type = REGCACHE_RBTREE,
177 .rd_table = &max77620_readable_table,
178 .wr_table = &max77620_writable_table,
179 .volatile_table = &max77620_volatile_table,
182 static const struct regmap_config max20024_regmap_config = {
183 .name = "power-slave",
186 .max_register = MAX20024_REG_MAX_ADD + 1,
187 .cache_type = REGCACHE_RBTREE,
188 .rd_table = &max20024_readable_table,
189 .wr_table = &max77620_writable_table,
190 .volatile_table = &max77620_volatile_table,
193 static const struct regmap_range max77663_readable_ranges[] = {
194 regmap_reg_range(MAX77620_REG_CNFGGLBL1, MAX77620_REG_CID5),
197 static const struct regmap_access_table max77663_readable_table = {
198 .yes_ranges = max77663_readable_ranges,
199 .n_yes_ranges = ARRAY_SIZE(max77663_readable_ranges),
202 static const struct regmap_range max77663_writable_ranges[] = {
203 regmap_reg_range(MAX77620_REG_CNFGGLBL1, MAX77620_REG_CID5),
206 static const struct regmap_access_table max77663_writable_table = {
207 .yes_ranges = max77663_writable_ranges,
208 .n_yes_ranges = ARRAY_SIZE(max77663_writable_ranges),
211 static const struct regmap_config max77663_regmap_config = {
212 .name = "power-slave",
215 .max_register = MAX77620_REG_CID5 + 1,
216 .cache_type = REGCACHE_RBTREE,
217 .rd_table = &max77663_readable_table,
218 .wr_table = &max77663_writable_table,
219 .volatile_table = &max77620_volatile_table,
223 * MAX77620 and MAX20024 has the following steps of the interrupt handling
224 * for TOP interrupts:
225 * 1. When interrupt occurs from PMIC, mask the PMIC interrupt by setting GLBLM.
226 * 2. Read IRQTOP and service the interrupt.
227 * 3. Once all interrupts has been checked and serviced, the interrupt service
228 * routine un-masks the hardware interrupt line by clearing GLBLM.
230 static int max77620_irq_global_mask(void *irq_drv_data)
232 struct max77620_chip *chip = irq_drv_data;
235 ret = regmap_update_bits(chip->rmap, MAX77620_REG_INTENLBT,
236 MAX77620_GLBLM_MASK, MAX77620_GLBLM_MASK);
238 dev_err(chip->dev, "Failed to set GLBLM: %d\n", ret);
243 static int max77620_irq_global_unmask(void *irq_drv_data)
245 struct max77620_chip *chip = irq_drv_data;
248 ret = regmap_update_bits(chip->rmap, MAX77620_REG_INTENLBT,
249 MAX77620_GLBLM_MASK, 0);
251 dev_err(chip->dev, "Failed to reset GLBLM: %d\n", ret);
256 static struct regmap_irq_chip max77620_top_irq_chip = {
257 .name = "max77620-top",
258 .irqs = max77620_top_irqs,
259 .num_irqs = ARRAY_SIZE(max77620_top_irqs),
261 .status_base = MAX77620_REG_IRQTOP,
262 .mask_base = MAX77620_REG_IRQTOPM,
263 .handle_pre_irq = max77620_irq_global_mask,
264 .handle_post_irq = max77620_irq_global_unmask,
267 /* max77620_get_fps_period_reg_value: Get FPS bit field value from
269 * MAX77620 supports the FPS period of 40, 80, 160, 320, 540, 1280, 2560
270 * and 5120 microseconds. MAX20024 supports the FPS period of 20, 40, 80,
271 * 160, 320, 540, 1280 and 2560 microseconds.
272 * The FPS register has 3 bits field to set the FPS period as
273 * bits max77620 max20024
278 static int max77620_get_fps_period_reg_value(struct max77620_chip *chip,
284 switch (chip->chip_id) {
286 fps_min_period = MAX20024_FPS_PERIOD_MIN_US;
289 fps_min_period = MAX77620_FPS_PERIOD_MIN_US;
292 fps_min_period = MAX20024_FPS_PERIOD_MIN_US;
298 for (i = 0; i < 7; i++) {
299 if (fps_min_period >= tperiod)
307 /* max77620_config_fps: Configure FPS configuration registers
308 * based on platform specific information.
310 static int max77620_config_fps(struct max77620_chip *chip,
311 struct device_node *fps_np)
313 struct device *dev = chip->dev;
314 unsigned int mask = 0, config = 0;
321 switch (chip->chip_id) {
323 fps_max_period = MAX20024_FPS_PERIOD_MAX_US;
326 fps_max_period = MAX77620_FPS_PERIOD_MAX_US;
329 fps_max_period = MAX20024_FPS_PERIOD_MAX_US;
335 for (fps_id = 0; fps_id < MAX77620_FPS_COUNT; fps_id++) {
336 sprintf(fps_name, "fps%d", fps_id);
337 if (of_node_name_eq(fps_np, fps_name))
341 if (fps_id == MAX77620_FPS_COUNT) {
342 dev_err(dev, "FPS node name %pOFn is not valid\n", fps_np);
346 ret = of_property_read_u32(fps_np, "maxim,shutdown-fps-time-period-us",
349 mask |= MAX77620_FPS_TIME_PERIOD_MASK;
350 chip->shutdown_fps_period[fps_id] = min(param_val,
352 tperiod = max77620_get_fps_period_reg_value(chip,
353 chip->shutdown_fps_period[fps_id]);
354 config |= tperiod << MAX77620_FPS_TIME_PERIOD_SHIFT;
357 ret = of_property_read_u32(fps_np, "maxim,suspend-fps-time-period-us",
360 chip->suspend_fps_period[fps_id] = min(param_val,
363 ret = of_property_read_u32(fps_np, "maxim,fps-event-source",
367 dev_err(dev, "FPS%d event-source invalid\n", fps_id);
370 mask |= MAX77620_FPS_EN_SRC_MASK;
371 config |= param_val << MAX77620_FPS_EN_SRC_SHIFT;
372 if (param_val == 2) {
373 mask |= MAX77620_FPS_ENFPS_SW_MASK;
374 config |= MAX77620_FPS_ENFPS_SW;
378 if (!chip->sleep_enable && !chip->enable_global_lpm) {
379 ret = of_property_read_u32(fps_np,
380 "maxim,device-state-on-disabled-event",
384 chip->sleep_enable = true;
385 else if (param_val == 1)
386 chip->enable_global_lpm = true;
390 ret = regmap_update_bits(chip->rmap, MAX77620_REG_FPS_CFG0 + fps_id,
393 dev_err(dev, "Failed to update FPS CFG: %d\n", ret);
400 static int max77620_initialise_fps(struct max77620_chip *chip)
402 struct device *dev = chip->dev;
403 struct device_node *fps_np, *fps_child;
408 for (fps_id = 0; fps_id < MAX77620_FPS_COUNT; fps_id++) {
409 chip->shutdown_fps_period[fps_id] = -1;
410 chip->suspend_fps_period[fps_id] = -1;
413 fps_np = of_get_child_by_name(dev->of_node, "fps");
417 for_each_child_of_node(fps_np, fps_child) {
418 ret = max77620_config_fps(chip, fps_child);
423 config = chip->enable_global_lpm ? MAX77620_ONOFFCNFG2_SLP_LPM_MSK : 0;
424 ret = regmap_update_bits(chip->rmap, MAX77620_REG_ONOFFCNFG2,
425 MAX77620_ONOFFCNFG2_SLP_LPM_MSK, config);
427 dev_err(dev, "Failed to update SLP_LPM: %d\n", ret);
432 if (chip->chip_id == MAX77663)
435 /* Enable wake on EN0 pin */
436 ret = regmap_update_bits(chip->rmap, MAX77620_REG_ONOFFCNFG2,
437 MAX77620_ONOFFCNFG2_WK_EN0,
438 MAX77620_ONOFFCNFG2_WK_EN0);
440 dev_err(dev, "Failed to update WK_EN0: %d\n", ret);
444 /* For MAX20024, SLPEN will be POR reset if CLRSE is b11 */
445 if ((chip->chip_id == MAX20024) && chip->sleep_enable) {
446 config = MAX77620_ONOFFCNFG1_SLPEN | MAX20024_ONOFFCNFG1_CLRSE;
447 ret = regmap_update_bits(chip->rmap, MAX77620_REG_ONOFFCNFG1,
450 dev_err(dev, "Failed to update SLPEN: %d\n", ret);
458 static int max77620_read_es_version(struct max77620_chip *chip)
465 for (i = MAX77620_REG_CID0; i <= MAX77620_REG_CID5; i++) {
466 ret = regmap_read(chip->rmap, i, &val);
468 dev_err(chip->dev, "Failed to read CID: %d\n", ret);
471 dev_dbg(chip->dev, "CID%d: 0x%02x\n",
472 i - MAX77620_REG_CID0, val);
473 cid_val[i - MAX77620_REG_CID0] = val;
476 /* CID4 is OTP Version and CID5 is ES version */
477 dev_info(chip->dev, "PMIC Version OTP:0x%02X and ES:0x%X\n",
478 cid_val[4], MAX77620_CID5_DIDM(cid_val[5]));
483 static void max77620_pm_power_off(void)
485 struct max77620_chip *chip = max77620_scratch;
487 regmap_update_bits(chip->rmap, MAX77620_REG_ONOFFCNFG1,
488 MAX77620_ONOFFCNFG1_SFT_RST,
489 MAX77620_ONOFFCNFG1_SFT_RST);
492 static int max77620_probe(struct i2c_client *client,
493 const struct i2c_device_id *id)
495 const struct regmap_config *rmap_config;
496 struct max77620_chip *chip;
497 const struct mfd_cell *mfd_cells;
502 chip = devm_kzalloc(&client->dev, sizeof(*chip), GFP_KERNEL);
506 i2c_set_clientdata(client, chip);
507 chip->dev = &client->dev;
509 chip->chip_irq = client->irq;
510 chip->chip_id = (enum max77620_chip_id)id->driver_data;
512 switch (chip->chip_id) {
514 mfd_cells = max77620_children;
515 n_mfd_cells = ARRAY_SIZE(max77620_children);
516 rmap_config = &max77620_regmap_config;
519 mfd_cells = max20024_children;
520 n_mfd_cells = ARRAY_SIZE(max20024_children);
521 rmap_config = &max20024_regmap_config;
524 mfd_cells = max77663_children;
525 n_mfd_cells = ARRAY_SIZE(max77663_children);
526 rmap_config = &max77663_regmap_config;
529 dev_err(chip->dev, "ChipID is invalid %d\n", chip->chip_id);
533 chip->rmap = devm_regmap_init_i2c(client, rmap_config);
534 if (IS_ERR(chip->rmap)) {
535 ret = PTR_ERR(chip->rmap);
536 dev_err(chip->dev, "Failed to initialise regmap: %d\n", ret);
540 ret = max77620_read_es_version(chip);
544 max77620_top_irq_chip.irq_drv_data = chip;
545 ret = devm_regmap_add_irq_chip(chip->dev, chip->rmap, client->irq,
546 IRQF_ONESHOT | IRQF_SHARED,
547 chip->irq_base, &max77620_top_irq_chip,
548 &chip->top_irq_data);
550 dev_err(chip->dev, "Failed to add regmap irq: %d\n", ret);
554 ret = max77620_initialise_fps(chip);
558 ret = devm_mfd_add_devices(chip->dev, PLATFORM_DEVID_NONE,
559 mfd_cells, n_mfd_cells, NULL, 0,
560 regmap_irq_get_domain(chip->top_irq_data));
562 dev_err(chip->dev, "Failed to add MFD children: %d\n", ret);
566 pm_off = of_device_is_system_power_controller(client->dev.of_node);
567 if (pm_off && !pm_power_off) {
568 max77620_scratch = chip;
569 pm_power_off = max77620_pm_power_off;
575 #ifdef CONFIG_PM_SLEEP
576 static int max77620_set_fps_period(struct max77620_chip *chip,
577 int fps_id, int time_period)
579 int period = max77620_get_fps_period_reg_value(chip, time_period);
582 ret = regmap_update_bits(chip->rmap, MAX77620_REG_FPS_CFG0 + fps_id,
583 MAX77620_FPS_TIME_PERIOD_MASK,
584 period << MAX77620_FPS_TIME_PERIOD_SHIFT);
586 dev_err(chip->dev, "Failed to update FPS period: %d\n", ret);
593 static int max77620_i2c_suspend(struct device *dev)
595 struct max77620_chip *chip = dev_get_drvdata(dev);
596 struct i2c_client *client = to_i2c_client(dev);
601 for (fps = 0; fps < MAX77620_FPS_COUNT; fps++) {
602 if (chip->suspend_fps_period[fps] < 0)
605 ret = max77620_set_fps_period(chip, fps,
606 chip->suspend_fps_period[fps]);
612 * For MAX20024: No need to configure SLPEN on suspend as
613 * it will be configured on Init.
615 if (chip->chip_id == MAX20024)
618 config = (chip->sleep_enable) ? MAX77620_ONOFFCNFG1_SLPEN : 0;
619 ret = regmap_update_bits(chip->rmap, MAX77620_REG_ONOFFCNFG1,
620 MAX77620_ONOFFCNFG1_SLPEN,
623 dev_err(dev, "Failed to configure sleep in suspend: %d\n", ret);
627 if (chip->chip_id == MAX77663)
631 ret = regmap_update_bits(chip->rmap, MAX77620_REG_ONOFFCNFG2,
632 MAX77620_ONOFFCNFG2_WK_EN0, 0);
634 dev_err(dev, "Failed to configure WK_EN in suspend: %d\n", ret);
639 disable_irq(client->irq);
644 static int max77620_i2c_resume(struct device *dev)
646 struct max77620_chip *chip = dev_get_drvdata(dev);
647 struct i2c_client *client = to_i2c_client(dev);
651 for (fps = 0; fps < MAX77620_FPS_COUNT; fps++) {
652 if (chip->shutdown_fps_period[fps] < 0)
655 ret = max77620_set_fps_period(chip, fps,
656 chip->shutdown_fps_period[fps]);
662 * For MAX20024: No need to configure WKEN0 on resume as
663 * it is configured on Init.
665 if (chip->chip_id == MAX20024 || chip->chip_id == MAX77663)
669 ret = regmap_update_bits(chip->rmap, MAX77620_REG_ONOFFCNFG2,
670 MAX77620_ONOFFCNFG2_WK_EN0,
671 MAX77620_ONOFFCNFG2_WK_EN0);
673 dev_err(dev, "Failed to configure WK_EN0 n resume: %d\n", ret);
678 enable_irq(client->irq);
684 static const struct i2c_device_id max77620_id[] = {
685 {"max77620", MAX77620},
686 {"max20024", MAX20024},
687 {"max77663", MAX77663},
691 static const struct dev_pm_ops max77620_pm_ops = {
692 SET_SYSTEM_SLEEP_PM_OPS(max77620_i2c_suspend, max77620_i2c_resume)
695 static struct i2c_driver max77620_driver = {
698 .pm = &max77620_pm_ops,
700 .probe = max77620_probe,
701 .id_table = max77620_id,
703 builtin_i2c_driver(max77620_driver);