drivers/mfd/max77686.c

0001 // SPDX-License-Identifier: GPL-2.0+
0002 //
0003 // max77686.c - mfd core driver for the Maxim 77686/802
0004 //
0005 // Copyright (C) 2012 Samsung Electronics
0006 // Chiwoong Byun <woong.byun@samsung.com>
0007 // Jonghwa Lee <jonghwa3.lee@samsung.com>
0008 //
0009 //This driver is based on max8997.c
0010
0011 #include <linux/export.h>
0012 #include <linux/slab.h>
0013 #include <linux/i2c.h>
0014 #include <linux/irq.h>
0015 #include <linux/interrupt.h>
0016 #include <linux/pm_runtime.h>
0017 #include <linux/module.h>
0018 #include <linux/mfd/core.h>
0019 #include <linux/mfd/max77686.h>
0020 #include <linux/mfd/max77686-private.h>
0021 #include <linux/err.h>
0022 #include <linux/of.h>
0023 #include <linux/of_device.h>
0024
0025 static const struct mfd_cell max77686_devs[] = {
0026     { .name = "max77686-pmic", },
0027     { .name = "max77686-rtc", },
0028     { .name = "max77686-clk", },
0029 };
0030
0031 static const struct mfd_cell max77802_devs[] = {
0032     { .name = "max77802-pmic", },
0033     { .name = "max77802-clk", },
0034     { .name = "max77802-rtc", },
0035 };
0036
0037 static bool max77802_pmic_is_accessible_reg(struct device *dev,
0038                         unsigned int reg)
0039 {
0040     return reg < MAX77802_REG_PMIC_END;
0041 }
0042
0043 static bool max77802_rtc_is_accessible_reg(struct device *dev,
0044                        unsigned int reg)
0045 {
0046     return (reg >= MAX77802_RTC_INT && reg < MAX77802_RTC_END);
0047 }
0048
0049 static bool max77802_is_accessible_reg(struct device *dev, unsigned int reg)
0050 {
0051     return (max77802_pmic_is_accessible_reg(dev, reg) ||
0052         max77802_rtc_is_accessible_reg(dev, reg));
0053 }
0054
0055 static bool max77802_pmic_is_precious_reg(struct device *dev, unsigned int reg)
0056 {
0057     return (reg == MAX77802_REG_INTSRC || reg == MAX77802_REG_INT1 ||
0058         reg == MAX77802_REG_INT2);
0059 }
0060
0061 static bool max77802_rtc_is_precious_reg(struct device *dev, unsigned int reg)
0062 {
0063     return (reg == MAX77802_RTC_INT ||
0064         reg == MAX77802_RTC_UPDATE0 ||
0065         reg == MAX77802_RTC_UPDATE1);
0066 }
0067
0068 static bool max77802_is_precious_reg(struct device *dev, unsigned int reg)
0069 {
0070     return (max77802_pmic_is_precious_reg(dev, reg) ||
0071         max77802_rtc_is_precious_reg(dev, reg));
0072 }
0073
0074 static bool max77802_pmic_is_volatile_reg(struct device *dev, unsigned int reg)
0075 {
0076     return (max77802_is_precious_reg(dev, reg) ||
0077         reg == MAX77802_REG_STATUS1 || reg == MAX77802_REG_STATUS2 ||
0078         reg == MAX77802_REG_PWRON);
0079 }
0080
0081 static bool max77802_rtc_is_volatile_reg(struct device *dev, unsigned int reg)
0082 {
0083     return (max77802_rtc_is_precious_reg(dev, reg) ||
0084         reg == MAX77802_RTC_SEC ||
0085         reg == MAX77802_RTC_MIN ||
0086         reg == MAX77802_RTC_HOUR ||
0087         reg == MAX77802_RTC_WEEKDAY ||
0088         reg == MAX77802_RTC_MONTH ||
0089         reg == MAX77802_RTC_YEAR ||
0090         reg == MAX77802_RTC_MONTHDAY);
0091 }
0092
0093 static bool max77802_is_volatile_reg(struct device *dev, unsigned int reg)
0094 {
0095     return (max77802_pmic_is_volatile_reg(dev, reg) ||
0096         max77802_rtc_is_volatile_reg(dev, reg));
0097 }
0098
0099 static const struct regmap_config max77686_regmap_config = {
0100     .reg_bits = 8,
0101     .val_bits = 8,
0102 };
0103
0104 static const struct regmap_config max77802_regmap_config = {
0105     .reg_bits = 8,
0106     .val_bits = 8,
0107     .writeable_reg = max77802_is_accessible_reg,
0108     .readable_reg = max77802_is_accessible_reg,
0109     .precious_reg = max77802_is_precious_reg,
0110     .volatile_reg = max77802_is_volatile_reg,
0111     .name = "max77802-pmic",
0112     .cache_type = REGCACHE_RBTREE,
0113 };
0114
0115 static const struct regmap_irq max77686_irqs[] = {
0116     /* INT1 interrupts */
0117     { .reg_offset = 0, .mask = MAX77686_INT1_PWRONF_MSK, },
0118     { .reg_offset = 0, .mask = MAX77686_INT1_PWRONR_MSK, },
0119     { .reg_offset = 0, .mask = MAX77686_INT1_JIGONBF_MSK, },
0120     { .reg_offset = 0, .mask = MAX77686_INT1_JIGONBR_MSK, },
0121     { .reg_offset = 0, .mask = MAX77686_INT1_ACOKBF_MSK, },
0122     { .reg_offset = 0, .mask = MAX77686_INT1_ACOKBR_MSK, },
0123     { .reg_offset = 0, .mask = MAX77686_INT1_ONKEY1S_MSK, },
0124     { .reg_offset = 0, .mask = MAX77686_INT1_MRSTB_MSK, },
0125     /* INT2 interrupts */
0126     { .reg_offset = 1, .mask = MAX77686_INT2_140C_MSK, },
0127     { .reg_offset = 1, .mask = MAX77686_INT2_120C_MSK, },
0128 };
0129
0130 static const struct regmap_irq_chip max77686_irq_chip = {
0131     .name           = "max77686-pmic",
0132     .status_base        = MAX77686_REG_INT1,
0133     .mask_base      = MAX77686_REG_INT1MSK,
0134     .num_regs       = 2,
0135     .irqs           = max77686_irqs,
0136     .num_irqs       = ARRAY_SIZE(max77686_irqs),
0137 };
0138
0139 static const struct regmap_irq_chip max77802_irq_chip = {
0140     .name           = "max77802-pmic",
0141     .status_base        = MAX77802_REG_INT1,
0142     .mask_base      = MAX77802_REG_INT1MSK,
0143     .num_regs       = 2,
0144     .irqs           = max77686_irqs, /* same masks as 77686 */
0145     .num_irqs       = ARRAY_SIZE(max77686_irqs),
0146 };
0147
0148 static const struct of_device_id max77686_pmic_dt_match[] = {
0149     {
0150         .compatible = "maxim,max77686",
0151         .data = (void *)TYPE_MAX77686,
0152     },
0153     {
0154         .compatible = "maxim,max77802",
0155         .data = (void *)TYPE_MAX77802,
0156     },
0157     { },
0158 };
0159 MODULE_DEVICE_TABLE(of, max77686_pmic_dt_match);
0160
0161 static int max77686_i2c_probe(struct i2c_client *i2c)
0162 {
0163     struct max77686_dev *max77686 = NULL;
0164     unsigned int data;
0165     int ret = 0;
0166     const struct regmap_config *config;
0167     const struct regmap_irq_chip *irq_chip;
0168     const struct mfd_cell *cells;
0169     int n_devs;
0170
0171     max77686 = devm_kzalloc(&i2c->dev,
0172                 sizeof(struct max77686_dev), GFP_KERNEL);
0173     if (!max77686)
0174         return -ENOMEM;
0175
0176     i2c_set_clientdata(i2c, max77686);
0177     max77686->type = (unsigned long)of_device_get_match_data(&i2c->dev);
0178     max77686->dev = &i2c->dev;
0179     max77686->i2c = i2c;
0180
0181     max77686->irq = i2c->irq;
0182
0183     if (max77686->type == TYPE_MAX77686) {
0184         config = &max77686_regmap_config;
0185         irq_chip = &max77686_irq_chip;
0186         cells =  max77686_devs;
0187         n_devs = ARRAY_SIZE(max77686_devs);
0188     } else {
0189         config = &max77802_regmap_config;
0190         irq_chip = &max77802_irq_chip;
0191         cells =  max77802_devs;
0192         n_devs = ARRAY_SIZE(max77802_devs);
0193     }
0194
0195     max77686->regmap = devm_regmap_init_i2c(i2c, config);
0196     if (IS_ERR(max77686->regmap)) {
0197         ret = PTR_ERR(max77686->regmap);
0198         dev_err(max77686->dev, "Failed to allocate register map: %d\n",
0199                 ret);
0200         return ret;
0201     }
0202
0203     ret = regmap_read(max77686->regmap, MAX77686_REG_DEVICE_ID, &data);
0204     if (ret < 0) {
0205         dev_err(max77686->dev,
0206             "device not found on this channel (this is not an error)\n");
0207         return -ENODEV;
0208     }
0209
0210     ret = devm_regmap_add_irq_chip(&i2c->dev, max77686->regmap,
0211                        max77686->irq,
0212                        IRQF_ONESHOT | IRQF_SHARED, 0, irq_chip,
0213                        &max77686->irq_data);
0214     if (ret < 0) {
0215         dev_err(&i2c->dev, "failed to add PMIC irq chip: %d\n", ret);
0216         return ret;
0217     }
0218
0219     ret = devm_mfd_add_devices(max77686->dev, -1, cells, n_devs, NULL,
0220                    0, NULL);
0221     if (ret < 0) {
0222         dev_err(&i2c->dev, "failed to add MFD devices: %d\n", ret);
0223         return ret;
0224     }
0225
0226     return 0;
0227 }
0228
0229 #ifdef CONFIG_PM_SLEEP
0230 static int max77686_suspend(struct device *dev)
0231 {
0232     struct i2c_client *i2c = to_i2c_client(dev);
0233     struct max77686_dev *max77686 = i2c_get_clientdata(i2c);
0234
0235     if (device_may_wakeup(dev))
0236         enable_irq_wake(max77686->irq);
0237
0238     /*
0239      * IRQ must be disabled during suspend because if it happens
0240      * while suspended it will be handled before resuming I2C.
0241      *
0242      * When device is woken up from suspend (e.g. by RTC wake alarm),
0243      * an interrupt occurs before resuming I2C bus controller.
0244      * Interrupt handler tries to read registers but this read
0245      * will fail because I2C is still suspended.
0246      */
0247     disable_irq(max77686->irq);
0248
0249     return 0;
0250 }
0251
0252 static int max77686_resume(struct device *dev)
0253 {
0254     struct i2c_client *i2c = to_i2c_client(dev);
0255     struct max77686_dev *max77686 = i2c_get_clientdata(i2c);
0256
0257     if (device_may_wakeup(dev))
0258         disable_irq_wake(max77686->irq);
0259
0260     enable_irq(max77686->irq);
0261
0262     return 0;
0263 }
0264 #endif /* CONFIG_PM_SLEEP */
0265
0266 static SIMPLE_DEV_PM_OPS(max77686_pm, max77686_suspend, max77686_resume);
0267
0268 static struct i2c_driver max77686_i2c_driver = {
0269     .driver = {
0270            .name = "max77686",
0271            .pm = &max77686_pm,
0272            .of_match_table = max77686_pmic_dt_match,
0273     },
0274     .probe_new = max77686_i2c_probe,
0275 };
0276
0277 module_i2c_driver(max77686_i2c_driver);
0278
0279 MODULE_DESCRIPTION("MAXIM 77686/802 multi-function core driver");
0280 MODULE_AUTHOR("Chiwoong Byun <woong.byun@samsung.com>");
0281 MODULE_LICENSE("GPL");