drivers/mfd/max8997.c

0001 // SPDX-License-Identifier: GPL-2.0+
0002 //
0003 // max8997.c - mfd core driver for the Maxim 8966 and 8997
0004 //
0005 // Copyright (C) 2011 Samsung Electronics
0006 // MyungJoo Ham <myungjoo.ham@samsung.com>
0007 //
0008 // This driver is based on max8998.c
0009
0010 #include <linux/err.h>
0011 #include <linux/slab.h>
0012 #include <linux/i2c.h>
0013 #include <linux/of.h>
0014 #include <linux/of_device.h>
0015 #include <linux/of_irq.h>
0016 #include <linux/interrupt.h>
0017 #include <linux/pm_runtime.h>
0018 #include <linux/init.h>
0019 #include <linux/mutex.h>
0020 #include <linux/mfd/core.h>
0021 #include <linux/mfd/max8997.h>
0022 #include <linux/mfd/max8997-private.h>
0023
0024 #define I2C_ADDR_PMIC   (0xCC >> 1)
0025 #define I2C_ADDR_MUIC   (0x4A >> 1)
0026 #define I2C_ADDR_BATTERY    (0x6C >> 1)
0027 #define I2C_ADDR_RTC    (0x0C >> 1)
0028 #define I2C_ADDR_HAPTIC (0x90 >> 1)
0029
0030 static const struct mfd_cell max8997_devs[] = {
0031     { .name = "max8997-pmic", },
0032     { .name = "max8997-rtc", },
0033     { .name = "max8997-battery", },
0034     { .name = "max8997-haptic", },
0035     { .name = "max8997-muic", },
0036     { .name = "max8997-led", .id = 1 },
0037     { .name = "max8997-led", .id = 2 },
0038 };
0039
0040 #ifdef CONFIG_OF
0041 static const struct of_device_id max8997_pmic_dt_match[] = {
0042     { .compatible = "maxim,max8997-pmic", .data = (void *)TYPE_MAX8997 },
0043     {},
0044 };
0045 #endif
0046
0047 int max8997_read_reg(struct i2c_client *i2c, u8 reg, u8 *dest)
0048 {
0049     struct max8997_dev *max8997 = i2c_get_clientdata(i2c);
0050     int ret;
0051
0052     mutex_lock(&max8997->iolock);
0053     ret = i2c_smbus_read_byte_data(i2c, reg);
0054     mutex_unlock(&max8997->iolock);
0055     if (ret < 0)
0056         return ret;
0057
0058     ret &= 0xff;
0059     *dest = ret;
0060     return 0;
0061 }
0062 EXPORT_SYMBOL_GPL(max8997_read_reg);
0063
0064 int max8997_bulk_read(struct i2c_client *i2c, u8 reg, int count, u8 *buf)
0065 {
0066     struct max8997_dev *max8997 = i2c_get_clientdata(i2c);
0067     int ret;
0068
0069     mutex_lock(&max8997->iolock);
0070     ret = i2c_smbus_read_i2c_block_data(i2c, reg, count, buf);
0071     mutex_unlock(&max8997->iolock);
0072     if (ret < 0)
0073         return ret;
0074
0075     return 0;
0076 }
0077 EXPORT_SYMBOL_GPL(max8997_bulk_read);
0078
0079 int max8997_write_reg(struct i2c_client *i2c, u8 reg, u8 value)
0080 {
0081     struct max8997_dev *max8997 = i2c_get_clientdata(i2c);
0082     int ret;
0083
0084     mutex_lock(&max8997->iolock);
0085     ret = i2c_smbus_write_byte_data(i2c, reg, value);
0086     mutex_unlock(&max8997->iolock);
0087     return ret;
0088 }
0089 EXPORT_SYMBOL_GPL(max8997_write_reg);
0090
0091 int max8997_bulk_write(struct i2c_client *i2c, u8 reg, int count, u8 *buf)
0092 {
0093     struct max8997_dev *max8997 = i2c_get_clientdata(i2c);
0094     int ret;
0095
0096     mutex_lock(&max8997->iolock);
0097     ret = i2c_smbus_write_i2c_block_data(i2c, reg, count, buf);
0098     mutex_unlock(&max8997->iolock);
0099     if (ret < 0)
0100         return ret;
0101
0102     return 0;
0103 }
0104 EXPORT_SYMBOL_GPL(max8997_bulk_write);
0105
0106 int max8997_update_reg(struct i2c_client *i2c, u8 reg, u8 val, u8 mask)
0107 {
0108     struct max8997_dev *max8997 = i2c_get_clientdata(i2c);
0109     int ret;
0110
0111     mutex_lock(&max8997->iolock);
0112     ret = i2c_smbus_read_byte_data(i2c, reg);
0113     if (ret >= 0) {
0114         u8 old_val = ret & 0xff;
0115         u8 new_val = (val & mask) | (old_val & (~mask));
0116         ret = i2c_smbus_write_byte_data(i2c, reg, new_val);
0117     }
0118     mutex_unlock(&max8997->iolock);
0119     return ret;
0120 }
0121 EXPORT_SYMBOL_GPL(max8997_update_reg);
0122
0123 /*
0124  * Only the common platform data elements for max8997 are parsed here from the
0125  * device tree. Other sub-modules of max8997 such as pmic, rtc and others have
0126  * to parse their own platform data elements from device tree.
0127  *
0128  * The max8997 platform data structure is instantiated here and the drivers for
0129  * the sub-modules need not instantiate another instance while parsing their
0130  * platform data.
0131  */
0132 static struct max8997_platform_data *max8997_i2c_parse_dt_pdata(
0133                     struct device *dev)
0134 {
0135     struct max8997_platform_data *pd;
0136
0137     pd = devm_kzalloc(dev, sizeof(*pd), GFP_KERNEL);
0138     if (!pd)
0139         return ERR_PTR(-ENOMEM);
0140
0141     pd->ono = irq_of_parse_and_map(dev->of_node, 1);
0142
0143     return pd;
0144 }
0145
0146 static inline unsigned long max8997_i2c_get_driver_data(struct i2c_client *i2c,
0147                         const struct i2c_device_id *id)
0148 {
0149     if (i2c->dev.of_node)
0150         return (unsigned long)of_device_get_match_data(&i2c->dev);
0151
0152     return id->driver_data;
0153 }
0154
0155 static int max8997_i2c_probe(struct i2c_client *i2c,
0156                 const struct i2c_device_id *id)
0157 {
0158     struct max8997_dev *max8997;
0159     struct max8997_platform_data *pdata = dev_get_platdata(&i2c->dev);
0160     int ret = 0;
0161
0162     max8997 = devm_kzalloc(&i2c->dev, sizeof(struct max8997_dev),
0163                 GFP_KERNEL);
0164     if (max8997 == NULL)
0165         return -ENOMEM;
0166
0167     i2c_set_clientdata(i2c, max8997);
0168     max8997->dev = &i2c->dev;
0169     max8997->i2c = i2c;
0170     max8997->type = max8997_i2c_get_driver_data(i2c, id);
0171     max8997->irq = i2c->irq;
0172
0173     if (IS_ENABLED(CONFIG_OF) && max8997->dev->of_node) {
0174         pdata = max8997_i2c_parse_dt_pdata(max8997->dev);
0175         if (IS_ERR(pdata))
0176             return PTR_ERR(pdata);
0177     }
0178
0179     if (!pdata)
0180         return ret;
0181
0182     max8997->pdata = pdata;
0183     max8997->ono = pdata->ono;
0184
0185     mutex_init(&max8997->iolock);
0186
0187     max8997->rtc = i2c_new_dummy_device(i2c->adapter, I2C_ADDR_RTC);
0188     if (IS_ERR(max8997->rtc)) {
0189         dev_err(max8997->dev, "Failed to allocate I2C device for RTC\n");
0190         return PTR_ERR(max8997->rtc);
0191     }
0192     i2c_set_clientdata(max8997->rtc, max8997);
0193
0194     max8997->haptic = i2c_new_dummy_device(i2c->adapter, I2C_ADDR_HAPTIC);
0195     if (IS_ERR(max8997->haptic)) {
0196         dev_err(max8997->dev, "Failed to allocate I2C device for Haptic\n");
0197         ret = PTR_ERR(max8997->haptic);
0198         goto err_i2c_haptic;
0199     }
0200     i2c_set_clientdata(max8997->haptic, max8997);
0201
0202     max8997->muic = i2c_new_dummy_device(i2c->adapter, I2C_ADDR_MUIC);
0203     if (IS_ERR(max8997->muic)) {
0204         dev_err(max8997->dev, "Failed to allocate I2C device for MUIC\n");
0205         ret = PTR_ERR(max8997->muic);
0206         goto err_i2c_muic;
0207     }
0208     i2c_set_clientdata(max8997->muic, max8997);
0209
0210     pm_runtime_set_active(max8997->dev);
0211
0212     max8997_irq_init(max8997);
0213
0214     ret = mfd_add_devices(max8997->dev, -1, max8997_devs,
0215             ARRAY_SIZE(max8997_devs),
0216             NULL, 0, NULL);
0217     if (ret < 0) {
0218         dev_err(max8997->dev, "failed to add MFD devices %d\n", ret);
0219         goto err_mfd;
0220     }
0221
0222     /*
0223      * TODO: enable others (flash, muic, rtc, battery, ...) and
0224      * check the return value
0225      */
0226
0227     /* MAX8997 has a power button input. */
0228     device_init_wakeup(max8997->dev, true);
0229
0230     return ret;
0231
0232 err_mfd:
0233     mfd_remove_devices(max8997->dev);
0234     i2c_unregister_device(max8997->muic);
0235 err_i2c_muic:
0236     i2c_unregister_device(max8997->haptic);
0237 err_i2c_haptic:
0238     i2c_unregister_device(max8997->rtc);
0239     return ret;
0240 }
0241
0242 static const struct i2c_device_id max8997_i2c_id[] = {
0243     { "max8997", TYPE_MAX8997 },
0244     { "max8966", TYPE_MAX8966 },
0245     { }
0246 };
0247
0248 static u8 max8997_dumpaddr_pmic[] = {
0249     MAX8997_REG_INT1MSK,
0250     MAX8997_REG_INT2MSK,
0251     MAX8997_REG_INT3MSK,
0252     MAX8997_REG_INT4MSK,
0253     MAX8997_REG_MAINCON1,
0254     MAX8997_REG_MAINCON2,
0255     MAX8997_REG_BUCKRAMP,
0256     MAX8997_REG_BUCK1CTRL,
0257     MAX8997_REG_BUCK1DVS1,
0258     MAX8997_REG_BUCK1DVS2,
0259     MAX8997_REG_BUCK1DVS3,
0260     MAX8997_REG_BUCK1DVS4,
0261     MAX8997_REG_BUCK1DVS5,
0262     MAX8997_REG_BUCK1DVS6,
0263     MAX8997_REG_BUCK1DVS7,
0264     MAX8997_REG_BUCK1DVS8,
0265     MAX8997_REG_BUCK2CTRL,
0266     MAX8997_REG_BUCK2DVS1,
0267     MAX8997_REG_BUCK2DVS2,
0268     MAX8997_REG_BUCK2DVS3,
0269     MAX8997_REG_BUCK2DVS4,
0270     MAX8997_REG_BUCK2DVS5,
0271     MAX8997_REG_BUCK2DVS6,
0272     MAX8997_REG_BUCK2DVS7,
0273     MAX8997_REG_BUCK2DVS8,
0274     MAX8997_REG_BUCK3CTRL,
0275     MAX8997_REG_BUCK3DVS,
0276     MAX8997_REG_BUCK4CTRL,
0277     MAX8997_REG_BUCK4DVS,
0278     MAX8997_REG_BUCK5CTRL,
0279     MAX8997_REG_BUCK5DVS1,
0280     MAX8997_REG_BUCK5DVS2,
0281     MAX8997_REG_BUCK5DVS3,
0282     MAX8997_REG_BUCK5DVS4,
0283     MAX8997_REG_BUCK5DVS5,
0284     MAX8997_REG_BUCK5DVS6,
0285     MAX8997_REG_BUCK5DVS7,
0286     MAX8997_REG_BUCK5DVS8,
0287     MAX8997_REG_BUCK6CTRL,
0288     MAX8997_REG_BUCK6BPSKIPCTRL,
0289     MAX8997_REG_BUCK7CTRL,
0290     MAX8997_REG_BUCK7DVS,
0291     MAX8997_REG_LDO1CTRL,
0292     MAX8997_REG_LDO2CTRL,
0293     MAX8997_REG_LDO3CTRL,
0294     MAX8997_REG_LDO4CTRL,
0295     MAX8997_REG_LDO5CTRL,
0296     MAX8997_REG_LDO6CTRL,
0297     MAX8997_REG_LDO7CTRL,
0298     MAX8997_REG_LDO8CTRL,
0299     MAX8997_REG_LDO9CTRL,
0300     MAX8997_REG_LDO10CTRL,
0301     MAX8997_REG_LDO11CTRL,
0302     MAX8997_REG_LDO12CTRL,
0303     MAX8997_REG_LDO13CTRL,
0304     MAX8997_REG_LDO14CTRL,
0305     MAX8997_REG_LDO15CTRL,
0306     MAX8997_REG_LDO16CTRL,
0307     MAX8997_REG_LDO17CTRL,
0308     MAX8997_REG_LDO18CTRL,
0309     MAX8997_REG_LDO21CTRL,
0310     MAX8997_REG_MBCCTRL1,
0311     MAX8997_REG_MBCCTRL2,
0312     MAX8997_REG_MBCCTRL3,
0313     MAX8997_REG_MBCCTRL4,
0314     MAX8997_REG_MBCCTRL5,
0315     MAX8997_REG_MBCCTRL6,
0316     MAX8997_REG_OTPCGHCVS,
0317     MAX8997_REG_SAFEOUTCTRL,
0318     MAX8997_REG_LBCNFG1,
0319     MAX8997_REG_LBCNFG2,
0320     MAX8997_REG_BBCCTRL,
0321
0322     MAX8997_REG_FLASH1_CUR,
0323     MAX8997_REG_FLASH2_CUR,
0324     MAX8997_REG_MOVIE_CUR,
0325     MAX8997_REG_GSMB_CUR,
0326     MAX8997_REG_BOOST_CNTL,
0327     MAX8997_REG_LEN_CNTL,
0328     MAX8997_REG_FLASH_CNTL,
0329     MAX8997_REG_WDT_CNTL,
0330     MAX8997_REG_MAXFLASH1,
0331     MAX8997_REG_MAXFLASH2,
0332     MAX8997_REG_FLASHSTATUSMASK,
0333
0334     MAX8997_REG_GPIOCNTL1,
0335     MAX8997_REG_GPIOCNTL2,
0336     MAX8997_REG_GPIOCNTL3,
0337     MAX8997_REG_GPIOCNTL4,
0338     MAX8997_REG_GPIOCNTL5,
0339     MAX8997_REG_GPIOCNTL6,
0340     MAX8997_REG_GPIOCNTL7,
0341     MAX8997_REG_GPIOCNTL8,
0342     MAX8997_REG_GPIOCNTL9,
0343     MAX8997_REG_GPIOCNTL10,
0344     MAX8997_REG_GPIOCNTL11,
0345     MAX8997_REG_GPIOCNTL12,
0346
0347     MAX8997_REG_LDO1CONFIG,
0348     MAX8997_REG_LDO2CONFIG,
0349     MAX8997_REG_LDO3CONFIG,
0350     MAX8997_REG_LDO4CONFIG,
0351     MAX8997_REG_LDO5CONFIG,
0352     MAX8997_REG_LDO6CONFIG,
0353     MAX8997_REG_LDO7CONFIG,
0354     MAX8997_REG_LDO8CONFIG,
0355     MAX8997_REG_LDO9CONFIG,
0356     MAX8997_REG_LDO10CONFIG,
0357     MAX8997_REG_LDO11CONFIG,
0358     MAX8997_REG_LDO12CONFIG,
0359     MAX8997_REG_LDO13CONFIG,
0360     MAX8997_REG_LDO14CONFIG,
0361     MAX8997_REG_LDO15CONFIG,
0362     MAX8997_REG_LDO16CONFIG,
0363     MAX8997_REG_LDO17CONFIG,
0364     MAX8997_REG_LDO18CONFIG,
0365     MAX8997_REG_LDO21CONFIG,
0366
0367     MAX8997_REG_DVSOKTIMER1,
0368     MAX8997_REG_DVSOKTIMER2,
0369     MAX8997_REG_DVSOKTIMER4,
0370     MAX8997_REG_DVSOKTIMER5,
0371 };
0372
0373 static u8 max8997_dumpaddr_muic[] = {
0374     MAX8997_MUIC_REG_INTMASK1,
0375     MAX8997_MUIC_REG_INTMASK2,
0376     MAX8997_MUIC_REG_INTMASK3,
0377     MAX8997_MUIC_REG_CDETCTRL,
0378     MAX8997_MUIC_REG_CONTROL1,
0379     MAX8997_MUIC_REG_CONTROL2,
0380     MAX8997_MUIC_REG_CONTROL3,
0381 };
0382
0383 static u8 max8997_dumpaddr_haptic[] = {
0384     MAX8997_HAPTIC_REG_CONF1,
0385     MAX8997_HAPTIC_REG_CONF2,
0386     MAX8997_HAPTIC_REG_DRVCONF,
0387     MAX8997_HAPTIC_REG_CYCLECONF1,
0388     MAX8997_HAPTIC_REG_CYCLECONF2,
0389     MAX8997_HAPTIC_REG_SIGCONF1,
0390     MAX8997_HAPTIC_REG_SIGCONF2,
0391     MAX8997_HAPTIC_REG_SIGCONF3,
0392     MAX8997_HAPTIC_REG_SIGCONF4,
0393     MAX8997_HAPTIC_REG_SIGDC1,
0394     MAX8997_HAPTIC_REG_SIGDC2,
0395     MAX8997_HAPTIC_REG_SIGPWMDC1,
0396     MAX8997_HAPTIC_REG_SIGPWMDC2,
0397     MAX8997_HAPTIC_REG_SIGPWMDC3,
0398     MAX8997_HAPTIC_REG_SIGPWMDC4,
0399 };
0400
0401 static int max8997_freeze(struct device *dev)
0402 {
0403     struct i2c_client *i2c = to_i2c_client(dev);
0404     struct max8997_dev *max8997 = i2c_get_clientdata(i2c);
0405     int i;
0406
0407     for (i = 0; i < ARRAY_SIZE(max8997_dumpaddr_pmic); i++)
0408         max8997_read_reg(i2c, max8997_dumpaddr_pmic[i],
0409                 &max8997->reg_dump[i]);
0410
0411     for (i = 0; i < ARRAY_SIZE(max8997_dumpaddr_muic); i++)
0412         max8997_read_reg(i2c, max8997_dumpaddr_muic[i],
0413                 &max8997->reg_dump[i + MAX8997_REG_PMIC_END]);
0414
0415     for (i = 0; i < ARRAY_SIZE(max8997_dumpaddr_haptic); i++)
0416         max8997_read_reg(i2c, max8997_dumpaddr_haptic[i],
0417                 &max8997->reg_dump[i + MAX8997_REG_PMIC_END +
0418                 MAX8997_MUIC_REG_END]);
0419
0420     return 0;
0421 }
0422
0423 static int max8997_restore(struct device *dev)
0424 {
0425     struct i2c_client *i2c = to_i2c_client(dev);
0426     struct max8997_dev *max8997 = i2c_get_clientdata(i2c);
0427     int i;
0428
0429     for (i = 0; i < ARRAY_SIZE(max8997_dumpaddr_pmic); i++)
0430         max8997_write_reg(i2c, max8997_dumpaddr_pmic[i],
0431                 max8997->reg_dump[i]);
0432
0433     for (i = 0; i < ARRAY_SIZE(max8997_dumpaddr_muic); i++)
0434         max8997_write_reg(i2c, max8997_dumpaddr_muic[i],
0435                 max8997->reg_dump[i + MAX8997_REG_PMIC_END]);
0436
0437     for (i = 0; i < ARRAY_SIZE(max8997_dumpaddr_haptic); i++)
0438         max8997_write_reg(i2c, max8997_dumpaddr_haptic[i],
0439                 max8997->reg_dump[i + MAX8997_REG_PMIC_END +
0440                 MAX8997_MUIC_REG_END]);
0441
0442     return 0;
0443 }
0444
0445 static int max8997_suspend(struct device *dev)
0446 {
0447     struct i2c_client *i2c = to_i2c_client(dev);
0448     struct max8997_dev *max8997 = i2c_get_clientdata(i2c);
0449
0450     disable_irq(max8997->irq);
0451     if (device_may_wakeup(dev))
0452         irq_set_irq_wake(max8997->irq, 1);
0453     return 0;
0454 }
0455
0456 static int max8997_resume(struct device *dev)
0457 {
0458     struct i2c_client *i2c = to_i2c_client(dev);
0459     struct max8997_dev *max8997 = i2c_get_clientdata(i2c);
0460
0461     if (device_may_wakeup(dev))
0462         irq_set_irq_wake(max8997->irq, 0);
0463     enable_irq(max8997->irq);
0464     return max8997_irq_resume(max8997);
0465 }
0466
0467 static const struct dev_pm_ops max8997_pm = {
0468     .suspend = max8997_suspend,
0469     .resume = max8997_resume,
0470     .freeze = max8997_freeze,
0471     .restore = max8997_restore,
0472 };
0473
0474 static struct i2c_driver max8997_i2c_driver = {
0475     .driver = {
0476            .name = "max8997",
0477            .pm = &max8997_pm,
0478            .suppress_bind_attrs = true,
0479            .of_match_table = of_match_ptr(max8997_pmic_dt_match),
0480     },
0481     .probe = max8997_i2c_probe,
0482     .id_table = max8997_i2c_id,
0483 };
0484
0485 static int __init max8997_i2c_init(void)
0486 {
0487     return i2c_add_driver(&max8997_i2c_driver);
0488 }
0489 /* init early so consumer devices can complete system boot */
0490 subsys_initcall(max8997_i2c_init);