drivers/mfd/ti-lmu.c

   1 // SPDX-License-Identifier: GPL-2.0-only
   2 /*
   3  * TI LMU (Lighting Management Unit) Core Driver
   4  *
   5  * Copyright 2017 Texas Instruments
   6  *
   7  * Author: Milo Kim <milo.kim@ti.com>
   8  */
   9
  10 #include <linux/delay.h>
  11 #include <linux/err.h>
  12 #include <linux/gpio/consumer.h>
  13 #include <linux/i2c.h>
  14 #include <linux/kernel.h>
  15 #include <linux/mfd/core.h>
  16 #include <linux/mfd/ti-lmu.h>
  17 #include <linux/mfd/ti-lmu-register.h>
  18 #include <linux/module.h>
  19 #include <linux/of.h>
  20 #include <linux/of_device.h>
  21 #include <linux/slab.h>
  22
  23 struct ti_lmu_data {
  24         const struct mfd_cell *cells;
  25         int num_cells;
  26         unsigned int max_register;
  27 };
  28
  29 static int ti_lmu_enable_hw(struct ti_lmu *lmu, enum ti_lmu_id id)
  30 {
  31         if (lmu->en_gpio)
  32                 gpiod_set_value(lmu->en_gpio, 1);
  33
  34         /* Delay about 1ms after HW enable pin control */
  35         usleep_range(1000, 1500);
  36
  37         /* LM3631 has additional power up sequence - enable LCD_EN bit. */
  38         if (id == LM3631) {
  39                 return regmap_update_bits(lmu->regmap, LM3631_REG_DEVCTRL,
  40                                           LM3631_LCD_EN_MASK,
  41                                           LM3631_LCD_EN_MASK);
  42         }
  43
  44         return 0;
  45 }
  46
  47 static void ti_lmu_disable_hw(void *data)
  48 {
  49         struct ti_lmu *lmu = data;
  50         if (lmu->en_gpio)
  51                 gpiod_set_value(lmu->en_gpio, 0);
  52 }
  53
  54 #define LM363X_REGULATOR(_id)                   \
  55 {                                               \
  56         .name          = "lm363x-regulator",    \
  57         .id            = _id,                   \
  58         .of_compatible = "ti,lm363x-regulator", \
  59 }                                               \
  60
  61 static const struct mfd_cell lm3631_devices[] = {
  62         LM363X_REGULATOR(LM3631_BOOST),
  63         LM363X_REGULATOR(LM3631_LDO_CONT),
  64         LM363X_REGULATOR(LM3631_LDO_OREF),
  65         LM363X_REGULATOR(LM3631_LDO_POS),
  66         LM363X_REGULATOR(LM3631_LDO_NEG),
  67         {
  68                 .name          = "ti-lmu-backlight",
  69                 .id            = LM3631,
  70                 .of_compatible = "ti,lm3631-backlight",
  71         },
  72 };
  73
  74 static const struct mfd_cell lm3632_devices[] = {
  75         LM363X_REGULATOR(LM3632_BOOST),
  76         LM363X_REGULATOR(LM3632_LDO_POS),
  77         LM363X_REGULATOR(LM3632_LDO_NEG),
  78         {
  79                 .name          = "ti-lmu-backlight",
  80                 .id            = LM3632,
  81                 .of_compatible = "ti,lm3632-backlight",
  82         },
  83 };
  84
  85 static const struct mfd_cell lm3633_devices[] = {
  86         {
  87                 .name          = "ti-lmu-backlight",
  88                 .id            = LM3633,
  89                 .of_compatible = "ti,lm3633-backlight",
  90         },
  91         {
  92                 .name          = "lm3633-leds",
  93                 .of_compatible = "ti,lm3633-leds",
  94         },
  95         /* Monitoring driver for open/short circuit detection */
  96         {
  97                 .name          = "ti-lmu-fault-monitor",
  98                 .id            = LM3633,
  99                 .of_compatible = "ti,lm3633-fault-monitor",
 100         },
 101 };
 102
 103 static const struct mfd_cell lm3695_devices[] = {
 104         {
 105                 .name          = "ti-lmu-backlight",
 106                 .id            = LM3695,
 107                 .of_compatible = "ti,lm3695-backlight",
 108         },
 109 };
 110
 111 static const struct mfd_cell lm36274_devices[] = {
 112         LM363X_REGULATOR(LM36274_BOOST),
 113         LM363X_REGULATOR(LM36274_LDO_POS),
 114         LM363X_REGULATOR(LM36274_LDO_NEG),
 115         {
 116                 .name          = "lm36274-leds",
 117                 .id            = LM36274,
 118                 .of_compatible = "ti,lm36274-backlight",
 119         },
 120 };
 121
 122 #define TI_LMU_DATA(chip, max_reg)              \
 123 static const struct ti_lmu_data chip##_data =   \
 124 {                                               \
 125         .cells = chip##_devices,                \
 126         .num_cells = ARRAY_SIZE(chip##_devices),\
 127         .max_register = max_reg,                \
 128 }                                               \
 129
 130 TI_LMU_DATA(lm3631, LM3631_MAX_REG);
 131 TI_LMU_DATA(lm3632, LM3632_MAX_REG);
 132 TI_LMU_DATA(lm3633, LM3633_MAX_REG);
 133 TI_LMU_DATA(lm3695, LM3695_MAX_REG);
 134 TI_LMU_DATA(lm36274, LM36274_MAX_REG);
 135
 136 static int ti_lmu_probe(struct i2c_client *cl)
 137 {
 138         const struct i2c_device_id *id = i2c_client_get_device_id(cl);
 139         struct device *dev = &cl->dev;
 140         const struct ti_lmu_data *data;
 141         struct regmap_config regmap_cfg;
 142         struct ti_lmu *lmu;
 143         int ret;
 144
 145         /*
 146          * Get device specific data from of_match table.
 147          * This data is defined by using TI_LMU_DATA() macro.
 148          */
 149         data = of_device_get_match_data(dev);
 150         if (!data)
 151                 return -ENODEV;
 152
 153         lmu = devm_kzalloc(dev, sizeof(*lmu), GFP_KERNEL);
 154         if (!lmu)
 155                 return -ENOMEM;
 156
 157         lmu->dev = &cl->dev;
 158
 159         /* Setup regmap */
 160         memset(&regmap_cfg, 0, sizeof(struct regmap_config));
 161         regmap_cfg.reg_bits = 8;
 162         regmap_cfg.val_bits = 8;
 163         regmap_cfg.name = id->name;
 164         regmap_cfg.max_register = data->max_register;
 165
 166         lmu->regmap = devm_regmap_init_i2c(cl, &regmap_cfg);
 167         if (IS_ERR(lmu->regmap))
 168                 return PTR_ERR(lmu->regmap);
 169
 170         /* HW enable pin control and additional power up sequence if required */
 171         lmu->en_gpio = devm_gpiod_get_optional(dev, "enable", GPIOD_OUT_HIGH);
 172         if (IS_ERR(lmu->en_gpio)) {
 173                 ret = PTR_ERR(lmu->en_gpio);
 174                 dev_err(dev, "Can not request enable GPIO: %d\n", ret);
 175                 return ret;
 176         }
 177
 178         ret = ti_lmu_enable_hw(lmu, id->driver_data);
 179         if (ret)
 180                 return ret;
 181
 182         ret = devm_add_action_or_reset(dev, ti_lmu_disable_hw, lmu);
 183         if (ret)
 184                 return ret;
 185
 186         /*
 187          * Fault circuit(open/short) can be detected by ti-lmu-fault-monitor.
 188          * After fault detection is done, some devices should re-initialize
 189          * configuration. The notifier enables such kind of handling.
 190          */
 191         BLOCKING_INIT_NOTIFIER_HEAD(&lmu->notifier);
 192
 193         i2c_set_clientdata(cl, lmu);
 194
 195         return devm_mfd_add_devices(lmu->dev, 0, data->cells,
 196                                     data->num_cells, NULL, 0, NULL);
 197 }
 198
 199 static const struct of_device_id ti_lmu_of_match[] = {
 200         { .compatible = "ti,lm3631", .data = &lm3631_data },
 201         { .compatible = "ti,lm3632", .data = &lm3632_data },
 202         { .compatible = "ti,lm3633", .data = &lm3633_data },
 203         { .compatible = "ti,lm3695", .data = &lm3695_data },
 204         { .compatible = "ti,lm36274", .data = &lm36274_data },
 205         { }
 206 };
 207 MODULE_DEVICE_TABLE(of, ti_lmu_of_match);
 208
 209 static const struct i2c_device_id ti_lmu_ids[] = {
 210         { "lm3631", LM3631 },
 211         { "lm3632", LM3632 },
 212         { "lm3633", LM3633 },
 213         { "lm3695", LM3695 },
 214         { "lm36274", LM36274 },
 215         { }
 216 };
 217 MODULE_DEVICE_TABLE(i2c, ti_lmu_ids);
 218
 219 static struct i2c_driver ti_lmu_driver = {
 220         .probe_new = ti_lmu_probe,
 221         .driver = {
 222                 .name = "ti-lmu",
 223                 .of_match_table = ti_lmu_of_match,
 224         },
 225         .id_table = ti_lmu_ids,
 226 };
 227
 228 module_i2c_driver(ti_lmu_driver);
 229
 230 MODULE_DESCRIPTION("TI LMU MFD Core Driver");
 231 MODULE_AUTHOR("Milo Kim");
 232 MODULE_LICENSE("GPL v2");