Back to home page

OSCL-LXR

 
 

    


0001 // SPDX-License-Identifier: GPL-2.0+
0002 //
0003 // max8998.c - mfd core driver for the Maxim 8998
0004 //
0005 //  Copyright (C) 2009-2010 Samsung Electronics
0006 //  Kyungmin Park <kyungmin.park@samsung.com>
0007 //  Marek Szyprowski <m.szyprowski@samsung.com>
0008 
0009 #include <linux/err.h>
0010 #include <linux/init.h>
0011 #include <linux/slab.h>
0012 #include <linux/i2c.h>
0013 #include <linux/interrupt.h>
0014 #include <linux/of.h>
0015 #include <linux/of_device.h>
0016 #include <linux/of_irq.h>
0017 #include <linux/pm_runtime.h>
0018 #include <linux/mutex.h>
0019 #include <linux/mfd/core.h>
0020 #include <linux/mfd/max8998.h>
0021 #include <linux/mfd/max8998-private.h>
0022 
0023 #define RTC_I2C_ADDR        (0x0c >> 1)
0024 
0025 static const struct mfd_cell max8998_devs[] = {
0026     {
0027         .name = "max8998-pmic",
0028     }, {
0029         .name = "max8998-rtc",
0030     }, {
0031         .name = "max8998-battery",
0032     },
0033 };
0034 
0035 static const struct mfd_cell lp3974_devs[] = {
0036     {
0037         .name = "lp3974-pmic",
0038     }, {
0039         .name = "lp3974-rtc",
0040     },
0041 };
0042 
0043 int max8998_read_reg(struct i2c_client *i2c, u8 reg, u8 *dest)
0044 {
0045     struct max8998_dev *max8998 = i2c_get_clientdata(i2c);
0046     int ret;
0047 
0048     mutex_lock(&max8998->iolock);
0049     ret = i2c_smbus_read_byte_data(i2c, reg);
0050     mutex_unlock(&max8998->iolock);
0051     if (ret < 0)
0052         return ret;
0053 
0054     ret &= 0xff;
0055     *dest = ret;
0056     return 0;
0057 }
0058 EXPORT_SYMBOL(max8998_read_reg);
0059 
0060 int max8998_bulk_read(struct i2c_client *i2c, u8 reg, int count, u8 *buf)
0061 {
0062     struct max8998_dev *max8998 = i2c_get_clientdata(i2c);
0063     int ret;
0064 
0065     mutex_lock(&max8998->iolock);
0066     ret = i2c_smbus_read_i2c_block_data(i2c, reg, count, buf);
0067     mutex_unlock(&max8998->iolock);
0068     if (ret < 0)
0069         return ret;
0070 
0071     return 0;
0072 }
0073 EXPORT_SYMBOL(max8998_bulk_read);
0074 
0075 int max8998_write_reg(struct i2c_client *i2c, u8 reg, u8 value)
0076 {
0077     struct max8998_dev *max8998 = i2c_get_clientdata(i2c);
0078     int ret;
0079 
0080     mutex_lock(&max8998->iolock);
0081     ret = i2c_smbus_write_byte_data(i2c, reg, value);
0082     mutex_unlock(&max8998->iolock);
0083     return ret;
0084 }
0085 EXPORT_SYMBOL(max8998_write_reg);
0086 
0087 int max8998_bulk_write(struct i2c_client *i2c, u8 reg, int count, u8 *buf)
0088 {
0089     struct max8998_dev *max8998 = i2c_get_clientdata(i2c);
0090     int ret;
0091 
0092     mutex_lock(&max8998->iolock);
0093     ret = i2c_smbus_write_i2c_block_data(i2c, reg, count, buf);
0094     mutex_unlock(&max8998->iolock);
0095     if (ret < 0)
0096         return ret;
0097 
0098     return 0;
0099 }
0100 EXPORT_SYMBOL(max8998_bulk_write);
0101 
0102 int max8998_update_reg(struct i2c_client *i2c, u8 reg, u8 val, u8 mask)
0103 {
0104     struct max8998_dev *max8998 = i2c_get_clientdata(i2c);
0105     int ret;
0106 
0107     mutex_lock(&max8998->iolock);
0108     ret = i2c_smbus_read_byte_data(i2c, reg);
0109     if (ret >= 0) {
0110         u8 old_val = ret & 0xff;
0111         u8 new_val = (val & mask) | (old_val & (~mask));
0112         ret = i2c_smbus_write_byte_data(i2c, reg, new_val);
0113     }
0114     mutex_unlock(&max8998->iolock);
0115     return ret;
0116 }
0117 EXPORT_SYMBOL(max8998_update_reg);
0118 
0119 #ifdef CONFIG_OF
0120 static const struct of_device_id max8998_dt_match[] = {
0121     { .compatible = "maxim,max8998", .data = (void *)TYPE_MAX8998 },
0122     { .compatible = "national,lp3974", .data = (void *)TYPE_LP3974 },
0123     { .compatible = "ti,lp3974", .data = (void *)TYPE_LP3974 },
0124     {},
0125 };
0126 #endif
0127 
0128 /*
0129  * Only the common platform data elements for max8998 are parsed here from the
0130  * device tree. Other sub-modules of max8998 such as pmic, rtc and others have
0131  * to parse their own platform data elements from device tree.
0132  *
0133  * The max8998 platform data structure is instantiated here and the drivers for
0134  * the sub-modules need not instantiate another instance while parsing their
0135  * platform data.
0136  */
0137 static struct max8998_platform_data *max8998_i2c_parse_dt_pdata(
0138                             struct device *dev)
0139 {
0140     struct max8998_platform_data *pd;
0141 
0142     pd = devm_kzalloc(dev, sizeof(*pd), GFP_KERNEL);
0143     if (!pd)
0144         return ERR_PTR(-ENOMEM);
0145 
0146     pd->ono = irq_of_parse_and_map(dev->of_node, 1);
0147 
0148     /*
0149      * ToDo: the 'wakeup' member in the platform data is more of a linux
0150      * specfic information. Hence, there is no binding for that yet and
0151      * not parsed here.
0152      */
0153     return pd;
0154 }
0155 
0156 static inline unsigned long max8998_i2c_get_driver_data(struct i2c_client *i2c,
0157                         const struct i2c_device_id *id)
0158 {
0159     if (i2c->dev.of_node)
0160         return (unsigned long)of_device_get_match_data(&i2c->dev);
0161 
0162     return id->driver_data;
0163 }
0164 
0165 static int max8998_i2c_probe(struct i2c_client *i2c,
0166                 const struct i2c_device_id *id)
0167 {
0168     struct max8998_platform_data *pdata = dev_get_platdata(&i2c->dev);
0169     struct max8998_dev *max8998;
0170     int ret = 0;
0171 
0172     max8998 = devm_kzalloc(&i2c->dev, sizeof(struct max8998_dev),
0173                 GFP_KERNEL);
0174     if (max8998 == NULL)
0175         return -ENOMEM;
0176 
0177     if (IS_ENABLED(CONFIG_OF) && i2c->dev.of_node) {
0178         pdata = max8998_i2c_parse_dt_pdata(&i2c->dev);
0179         if (IS_ERR(pdata))
0180             return PTR_ERR(pdata);
0181     }
0182 
0183     i2c_set_clientdata(i2c, max8998);
0184     max8998->dev = &i2c->dev;
0185     max8998->i2c = i2c;
0186     max8998->irq = i2c->irq;
0187     max8998->type = max8998_i2c_get_driver_data(i2c, id);
0188     max8998->pdata = pdata;
0189     if (pdata) {
0190         max8998->ono = pdata->ono;
0191         max8998->irq_base = pdata->irq_base;
0192         max8998->wakeup = pdata->wakeup;
0193     }
0194     mutex_init(&max8998->iolock);
0195 
0196     max8998->rtc = i2c_new_dummy_device(i2c->adapter, RTC_I2C_ADDR);
0197     if (IS_ERR(max8998->rtc)) {
0198         dev_err(&i2c->dev, "Failed to allocate I2C device for RTC\n");
0199         return PTR_ERR(max8998->rtc);
0200     }
0201     i2c_set_clientdata(max8998->rtc, max8998);
0202 
0203     max8998_irq_init(max8998);
0204 
0205     pm_runtime_set_active(max8998->dev);
0206 
0207     switch (max8998->type) {
0208     case TYPE_LP3974:
0209         ret = mfd_add_devices(max8998->dev, -1,
0210                       lp3974_devs, ARRAY_SIZE(lp3974_devs),
0211                       NULL, 0, NULL);
0212         break;
0213     case TYPE_MAX8998:
0214         ret = mfd_add_devices(max8998->dev, -1,
0215                       max8998_devs, ARRAY_SIZE(max8998_devs),
0216                       NULL, 0, NULL);
0217         break;
0218     default:
0219         ret = -EINVAL;
0220     }
0221 
0222     if (ret < 0)
0223         goto err;
0224 
0225     device_init_wakeup(max8998->dev, max8998->wakeup);
0226 
0227     return ret;
0228 
0229 err:
0230     mfd_remove_devices(max8998->dev);
0231     max8998_irq_exit(max8998);
0232     i2c_unregister_device(max8998->rtc);
0233     return ret;
0234 }
0235 
0236 static const struct i2c_device_id max8998_i2c_id[] = {
0237     { "max8998", TYPE_MAX8998 },
0238     { "lp3974", TYPE_LP3974},
0239     { }
0240 };
0241 
0242 static int max8998_suspend(struct device *dev)
0243 {
0244     struct i2c_client *i2c = to_i2c_client(dev);
0245     struct max8998_dev *max8998 = i2c_get_clientdata(i2c);
0246 
0247     if (device_may_wakeup(dev))
0248         irq_set_irq_wake(max8998->irq, 1);
0249     return 0;
0250 }
0251 
0252 static int max8998_resume(struct device *dev)
0253 {
0254     struct i2c_client *i2c = to_i2c_client(dev);
0255     struct max8998_dev *max8998 = i2c_get_clientdata(i2c);
0256 
0257     if (device_may_wakeup(dev))
0258         irq_set_irq_wake(max8998->irq, 0);
0259     /*
0260      * In LP3974, if IRQ registers are not "read & clear"
0261      * when it's set during sleep, the interrupt becomes
0262      * disabled.
0263      */
0264     return max8998_irq_resume(i2c_get_clientdata(i2c));
0265 }
0266 
0267 struct max8998_reg_dump {
0268     u8  addr;
0269     u8  val;
0270 };
0271 #define SAVE_ITEM(x)    { .addr = (x), .val = 0x0, }
0272 static struct max8998_reg_dump max8998_dump[] = {
0273     SAVE_ITEM(MAX8998_REG_IRQM1),
0274     SAVE_ITEM(MAX8998_REG_IRQM2),
0275     SAVE_ITEM(MAX8998_REG_IRQM3),
0276     SAVE_ITEM(MAX8998_REG_IRQM4),
0277     SAVE_ITEM(MAX8998_REG_STATUSM1),
0278     SAVE_ITEM(MAX8998_REG_STATUSM2),
0279     SAVE_ITEM(MAX8998_REG_CHGR1),
0280     SAVE_ITEM(MAX8998_REG_CHGR2),
0281     SAVE_ITEM(MAX8998_REG_LDO_ACTIVE_DISCHARGE1),
0282     SAVE_ITEM(MAX8998_REG_LDO_ACTIVE_DISCHARGE1),
0283     SAVE_ITEM(MAX8998_REG_BUCK_ACTIVE_DISCHARGE3),
0284     SAVE_ITEM(MAX8998_REG_ONOFF1),
0285     SAVE_ITEM(MAX8998_REG_ONOFF2),
0286     SAVE_ITEM(MAX8998_REG_ONOFF3),
0287     SAVE_ITEM(MAX8998_REG_ONOFF4),
0288     SAVE_ITEM(MAX8998_REG_BUCK1_VOLTAGE1),
0289     SAVE_ITEM(MAX8998_REG_BUCK1_VOLTAGE2),
0290     SAVE_ITEM(MAX8998_REG_BUCK1_VOLTAGE3),
0291     SAVE_ITEM(MAX8998_REG_BUCK1_VOLTAGE4),
0292     SAVE_ITEM(MAX8998_REG_BUCK2_VOLTAGE1),
0293     SAVE_ITEM(MAX8998_REG_BUCK2_VOLTAGE2),
0294     SAVE_ITEM(MAX8998_REG_LDO2_LDO3),
0295     SAVE_ITEM(MAX8998_REG_LDO4),
0296     SAVE_ITEM(MAX8998_REG_LDO5),
0297     SAVE_ITEM(MAX8998_REG_LDO6),
0298     SAVE_ITEM(MAX8998_REG_LDO7),
0299     SAVE_ITEM(MAX8998_REG_LDO8_LDO9),
0300     SAVE_ITEM(MAX8998_REG_LDO10_LDO11),
0301     SAVE_ITEM(MAX8998_REG_LDO12),
0302     SAVE_ITEM(MAX8998_REG_LDO13),
0303     SAVE_ITEM(MAX8998_REG_LDO14),
0304     SAVE_ITEM(MAX8998_REG_LDO15),
0305     SAVE_ITEM(MAX8998_REG_LDO16),
0306     SAVE_ITEM(MAX8998_REG_LDO17),
0307     SAVE_ITEM(MAX8998_REG_BKCHR),
0308     SAVE_ITEM(MAX8998_REG_LBCNFG1),
0309     SAVE_ITEM(MAX8998_REG_LBCNFG2),
0310 };
0311 /* Save registers before hibernation */
0312 static int max8998_freeze(struct device *dev)
0313 {
0314     struct i2c_client *i2c = to_i2c_client(dev);
0315     int i;
0316 
0317     for (i = 0; i < ARRAY_SIZE(max8998_dump); i++)
0318         max8998_read_reg(i2c, max8998_dump[i].addr,
0319                 &max8998_dump[i].val);
0320 
0321     return 0;
0322 }
0323 
0324 /* Restore registers after hibernation */
0325 static int max8998_restore(struct device *dev)
0326 {
0327     struct i2c_client *i2c = to_i2c_client(dev);
0328     int i;
0329 
0330     for (i = 0; i < ARRAY_SIZE(max8998_dump); i++)
0331         max8998_write_reg(i2c, max8998_dump[i].addr,
0332                 max8998_dump[i].val);
0333 
0334     return 0;
0335 }
0336 
0337 static const struct dev_pm_ops max8998_pm = {
0338     .suspend = max8998_suspend,
0339     .resume = max8998_resume,
0340     .freeze = max8998_freeze,
0341     .restore = max8998_restore,
0342 };
0343 
0344 static struct i2c_driver max8998_i2c_driver = {
0345     .driver = {
0346            .name = "max8998",
0347            .pm = &max8998_pm,
0348            .suppress_bind_attrs = true,
0349            .of_match_table = of_match_ptr(max8998_dt_match),
0350     },
0351     .probe = max8998_i2c_probe,
0352     .id_table = max8998_i2c_id,
0353 };
0354 
0355 static int __init max8998_i2c_init(void)
0356 {
0357     return i2c_add_driver(&max8998_i2c_driver);
0358 }
0359 /* init early so consumer devices can complete system boot */
0360 subsys_initcall(max8998_i2c_init);