drivers/mfd/rohm-bd70528.c

   1 // SPDX-License-Identifier: GPL-2.0-or-later
   2 //
   3 // Copyright (C) 2019 ROHM Semiconductors
   4 //
   5 // ROHM BD70528 PMIC driver
   6
   7 #include <linux/i2c.h>
   8 #include <linux/interrupt.h>
   9 #include <linux/ioport.h>
  10 #include <linux/irq.h>
  11 #include <linux/mfd/core.h>
  12 #include <linux/mfd/rohm-bd70528.h>
  13 #include <linux/module.h>
  14 #include <linux/of_device.h>
  15 #include <linux/regmap.h>
  16 #include <linux/types.h>
  17
  18 #define BD70528_NUM_OF_GPIOS 4
  19
  20 static const struct resource rtc_irqs[] = {
  21         DEFINE_RES_IRQ_NAMED(BD70528_INT_RTC_ALARM, "bd70528-rtc-alm"),
  22         DEFINE_RES_IRQ_NAMED(BD70528_INT_ELPS_TIM, "bd70528-elapsed-timer"),
  23 };
  24
  25 static const struct resource charger_irqs[] = {
  26         DEFINE_RES_IRQ_NAMED(BD70528_INT_BAT_OV_RES, "bd70528-bat-ov-res"),
  27         DEFINE_RES_IRQ_NAMED(BD70528_INT_BAT_OV_DET, "bd70528-bat-ov-det"),
  28         DEFINE_RES_IRQ_NAMED(BD70528_INT_DBAT_DET, "bd70528-bat-dead"),
  29         DEFINE_RES_IRQ_NAMED(BD70528_INT_BATTSD_COLD_RES, "bd70528-bat-warmed"),
  30         DEFINE_RES_IRQ_NAMED(BD70528_INT_BATTSD_COLD_DET, "bd70528-bat-cold"),
  31         DEFINE_RES_IRQ_NAMED(BD70528_INT_BATTSD_HOT_RES, "bd70528-bat-cooled"),
  32         DEFINE_RES_IRQ_NAMED(BD70528_INT_BATTSD_HOT_DET, "bd70528-bat-hot"),
  33         DEFINE_RES_IRQ_NAMED(BD70528_INT_CHG_TSD, "bd70528-chg-tshd"),
  34         DEFINE_RES_IRQ_NAMED(BD70528_INT_BAT_RMV, "bd70528-bat-removed"),
  35         DEFINE_RES_IRQ_NAMED(BD70528_INT_BAT_DET, "bd70528-bat-detected"),
  36         DEFINE_RES_IRQ_NAMED(BD70528_INT_DCIN2_OV_RES, "bd70528-dcin2-ov-res"),
  37         DEFINE_RES_IRQ_NAMED(BD70528_INT_DCIN2_OV_DET, "bd70528-dcin2-ov-det"),
  38         DEFINE_RES_IRQ_NAMED(BD70528_INT_DCIN2_RMV, "bd70528-dcin2-removed"),
  39         DEFINE_RES_IRQ_NAMED(BD70528_INT_DCIN2_DET, "bd70528-dcin2-detected"),
  40         DEFINE_RES_IRQ_NAMED(BD70528_INT_DCIN1_RMV, "bd70528-dcin1-removed"),
  41         DEFINE_RES_IRQ_NAMED(BD70528_INT_DCIN1_DET, "bd70528-dcin1-detected"),
  42 };
  43
  44 static struct mfd_cell bd70528_mfd_cells[] = {
  45         { .name = "bd70528-pmic", },
  46         { .name = "bd70528-gpio", },
  47         /*
  48          * We use BD71837 driver to drive the clock block. Only differences to
  49          * BD70528 clock gate are the register address and mask.
  50          */
  51         { .name = "bd718xx-clk", },
  52         { .name = "bd70528-wdt", },
  53         {
  54                 .name = "bd70528-power",
  55                 .resources = charger_irqs,
  56                 .num_resources = ARRAY_SIZE(charger_irqs),
  57         }, {
  58                 .name = "bd70528-rtc",
  59                 .resources = rtc_irqs,
  60                 .num_resources = ARRAY_SIZE(rtc_irqs),
  61         },
  62 };
  63
  64 static const struct regmap_range volatile_ranges[] = {
  65         {
  66                 .range_min = BD70528_REG_INT_MAIN,
  67                 .range_max = BD70528_REG_INT_OP_FAIL,
  68         }, {
  69                 .range_min = BD70528_REG_RTC_COUNT_H,
  70                 .range_max = BD70528_REG_RTC_ALM_REPEAT,
  71         }, {
  72                 /*
  73                  * WDT control reg is special. Magic values must be written to
  74                  * it in order to change the control. Should not be cached.
  75                  */
  76                 .range_min = BD70528_REG_WDT_CTRL,
  77                 .range_max = BD70528_REG_WDT_CTRL,
  78         }, {
  79                 /*
  80                  * BD70528 also contains a few other registers which require
  81                  * magic sequences to be written in order to update the value.
  82                  * At least SHIPMODE, HWRESET, WARMRESET,and STANDBY
  83                  */
  84                 .range_min = BD70528_REG_SHIPMODE,
  85                 .range_max = BD70528_REG_STANDBY,
  86         },
  87 };
  88
  89 static const struct regmap_access_table volatile_regs = {
  90         .yes_ranges = &volatile_ranges[0],
  91         .n_yes_ranges = ARRAY_SIZE(volatile_ranges),
  92 };
  93
  94 static struct regmap_config bd70528_regmap = {
  95         .reg_bits = 8,
  96         .val_bits = 8,
  97         .volatile_table = &volatile_regs,
  98         .max_register = BD70528_MAX_REGISTER,
  99         .cache_type = REGCACHE_RBTREE,
 100 };
 101
 102 /*
 103  * Mapping of main IRQ register bits to sub-IRQ register offsets so that we can
 104  * access corect sub-IRQ registers based on bits that are set in main IRQ
 105  * register.
 106  */
 107
 108 /* bit [0] - Shutdown register */
 109 unsigned int bit0_offsets[] = {0};      /* Shutdown register */
 110 unsigned int bit1_offsets[] = {1};      /* Power failure register */
 111 unsigned int bit2_offsets[] = {2};      /* VR FAULT register */
 112 unsigned int bit3_offsets[] = {3};      /* PMU register interrupts */
 113 unsigned int bit4_offsets[] = {4, 5};   /* Charger 1 and Charger 2 registers */
 114 unsigned int bit5_offsets[] = {6};      /* RTC register */
 115 unsigned int bit6_offsets[] = {7};      /* GPIO register */
 116 unsigned int bit7_offsets[] = {8};      /* Invalid operation register */
 117
 118 static struct regmap_irq_sub_irq_map bd70528_sub_irq_offsets[] = {
 119         REGMAP_IRQ_MAIN_REG_OFFSET(bit0_offsets),
 120         REGMAP_IRQ_MAIN_REG_OFFSET(bit1_offsets),
 121         REGMAP_IRQ_MAIN_REG_OFFSET(bit2_offsets),
 122         REGMAP_IRQ_MAIN_REG_OFFSET(bit3_offsets),
 123         REGMAP_IRQ_MAIN_REG_OFFSET(bit4_offsets),
 124         REGMAP_IRQ_MAIN_REG_OFFSET(bit5_offsets),
 125         REGMAP_IRQ_MAIN_REG_OFFSET(bit6_offsets),
 126         REGMAP_IRQ_MAIN_REG_OFFSET(bit7_offsets),
 127 };
 128
 129 static struct regmap_irq bd70528_irqs[] = {
 130         REGMAP_IRQ_REG(BD70528_INT_LONGPUSH, 0, BD70528_INT_LONGPUSH_MASK),
 131         REGMAP_IRQ_REG(BD70528_INT_WDT, 0, BD70528_INT_WDT_MASK),
 132         REGMAP_IRQ_REG(BD70528_INT_HWRESET, 0, BD70528_INT_HWRESET_MASK),
 133         REGMAP_IRQ_REG(BD70528_INT_RSTB_FAULT, 0, BD70528_INT_RSTB_FAULT_MASK),
 134         REGMAP_IRQ_REG(BD70528_INT_VBAT_UVLO, 0, BD70528_INT_VBAT_UVLO_MASK),
 135         REGMAP_IRQ_REG(BD70528_INT_TSD, 0, BD70528_INT_TSD_MASK),
 136         REGMAP_IRQ_REG(BD70528_INT_RSTIN, 0, BD70528_INT_RSTIN_MASK),
 137         REGMAP_IRQ_REG(BD70528_INT_BUCK1_FAULT, 1,
 138                        BD70528_INT_BUCK1_FAULT_MASK),
 139         REGMAP_IRQ_REG(BD70528_INT_BUCK2_FAULT, 1,
 140                        BD70528_INT_BUCK2_FAULT_MASK),
 141         REGMAP_IRQ_REG(BD70528_INT_BUCK3_FAULT, 1,
 142                        BD70528_INT_BUCK3_FAULT_MASK),
 143         REGMAP_IRQ_REG(BD70528_INT_LDO1_FAULT, 1, BD70528_INT_LDO1_FAULT_MASK),
 144         REGMAP_IRQ_REG(BD70528_INT_LDO2_FAULT, 1, BD70528_INT_LDO2_FAULT_MASK),
 145         REGMAP_IRQ_REG(BD70528_INT_LDO3_FAULT, 1, BD70528_INT_LDO3_FAULT_MASK),
 146         REGMAP_IRQ_REG(BD70528_INT_LED1_FAULT, 1, BD70528_INT_LED1_FAULT_MASK),
 147         REGMAP_IRQ_REG(BD70528_INT_LED2_FAULT, 1, BD70528_INT_LED2_FAULT_MASK),
 148         REGMAP_IRQ_REG(BD70528_INT_BUCK1_OCP, 2, BD70528_INT_BUCK1_OCP_MASK),
 149         REGMAP_IRQ_REG(BD70528_INT_BUCK2_OCP, 2, BD70528_INT_BUCK2_OCP_MASK),
 150         REGMAP_IRQ_REG(BD70528_INT_BUCK3_OCP, 2, BD70528_INT_BUCK3_OCP_MASK),
 151         REGMAP_IRQ_REG(BD70528_INT_LED1_OCP, 2, BD70528_INT_LED1_OCP_MASK),
 152         REGMAP_IRQ_REG(BD70528_INT_LED2_OCP, 2, BD70528_INT_LED2_OCP_MASK),
 153         REGMAP_IRQ_REG(BD70528_INT_BUCK1_FULLON, 2,
 154                        BD70528_INT_BUCK1_FULLON_MASK),
 155         REGMAP_IRQ_REG(BD70528_INT_BUCK2_FULLON, 2,
 156                        BD70528_INT_BUCK2_FULLON_MASK),
 157         REGMAP_IRQ_REG(BD70528_INT_SHORTPUSH, 3, BD70528_INT_SHORTPUSH_MASK),
 158         REGMAP_IRQ_REG(BD70528_INT_AUTO_WAKEUP, 3,
 159                        BD70528_INT_AUTO_WAKEUP_MASK),
 160         REGMAP_IRQ_REG(BD70528_INT_STATE_CHANGE, 3,
 161                        BD70528_INT_STATE_CHANGE_MASK),
 162         REGMAP_IRQ_REG(BD70528_INT_BAT_OV_RES, 4, BD70528_INT_BAT_OV_RES_MASK),
 163         REGMAP_IRQ_REG(BD70528_INT_BAT_OV_DET, 4, BD70528_INT_BAT_OV_DET_MASK),
 164         REGMAP_IRQ_REG(BD70528_INT_DBAT_DET, 4, BD70528_INT_DBAT_DET_MASK),
 165         REGMAP_IRQ_REG(BD70528_INT_BATTSD_COLD_RES, 4,
 166                        BD70528_INT_BATTSD_COLD_RES_MASK),
 167         REGMAP_IRQ_REG(BD70528_INT_BATTSD_COLD_DET, 4,
 168                        BD70528_INT_BATTSD_COLD_DET_MASK),
 169         REGMAP_IRQ_REG(BD70528_INT_BATTSD_HOT_RES, 4,
 170                        BD70528_INT_BATTSD_HOT_RES_MASK),
 171         REGMAP_IRQ_REG(BD70528_INT_BATTSD_HOT_DET, 4,
 172                        BD70528_INT_BATTSD_HOT_DET_MASK),
 173         REGMAP_IRQ_REG(BD70528_INT_CHG_TSD, 4, BD70528_INT_CHG_TSD_MASK),
 174         REGMAP_IRQ_REG(BD70528_INT_BAT_RMV, 5, BD70528_INT_BAT_RMV_MASK),
 175         REGMAP_IRQ_REG(BD70528_INT_BAT_DET, 5, BD70528_INT_BAT_DET_MASK),
 176         REGMAP_IRQ_REG(BD70528_INT_DCIN2_OV_RES, 5,
 177                        BD70528_INT_DCIN2_OV_RES_MASK),
 178         REGMAP_IRQ_REG(BD70528_INT_DCIN2_OV_DET, 5,
 179                        BD70528_INT_DCIN2_OV_DET_MASK),
 180         REGMAP_IRQ_REG(BD70528_INT_DCIN2_RMV, 5, BD70528_INT_DCIN2_RMV_MASK),
 181         REGMAP_IRQ_REG(BD70528_INT_DCIN2_DET, 5, BD70528_INT_DCIN2_DET_MASK),
 182         REGMAP_IRQ_REG(BD70528_INT_DCIN1_RMV, 5, BD70528_INT_DCIN1_RMV_MASK),
 183         REGMAP_IRQ_REG(BD70528_INT_DCIN1_DET, 5, BD70528_INT_DCIN1_DET_MASK),
 184         REGMAP_IRQ_REG(BD70528_INT_RTC_ALARM, 6, BD70528_INT_RTC_ALARM_MASK),
 185         REGMAP_IRQ_REG(BD70528_INT_ELPS_TIM, 6, BD70528_INT_ELPS_TIM_MASK),
 186         REGMAP_IRQ_REG(BD70528_INT_GPIO0, 7, BD70528_INT_GPIO0_MASK),
 187         REGMAP_IRQ_REG(BD70528_INT_GPIO1, 7, BD70528_INT_GPIO1_MASK),
 188         REGMAP_IRQ_REG(BD70528_INT_GPIO2, 7, BD70528_INT_GPIO2_MASK),
 189         REGMAP_IRQ_REG(BD70528_INT_GPIO3, 7, BD70528_INT_GPIO3_MASK),
 190         REGMAP_IRQ_REG(BD70528_INT_BUCK1_DVS_OPFAIL, 8,
 191                        BD70528_INT_BUCK1_DVS_OPFAIL_MASK),
 192         REGMAP_IRQ_REG(BD70528_INT_BUCK2_DVS_OPFAIL, 8,
 193                        BD70528_INT_BUCK2_DVS_OPFAIL_MASK),
 194         REGMAP_IRQ_REG(BD70528_INT_BUCK3_DVS_OPFAIL, 8,
 195                        BD70528_INT_BUCK3_DVS_OPFAIL_MASK),
 196         REGMAP_IRQ_REG(BD70528_INT_LED1_VOLT_OPFAIL, 8,
 197                        BD70528_INT_LED1_VOLT_OPFAIL_MASK),
 198         REGMAP_IRQ_REG(BD70528_INT_LED2_VOLT_OPFAIL, 8,
 199                        BD70528_INT_LED2_VOLT_OPFAIL_MASK),
 200 };
 201
 202 static struct regmap_irq_chip bd70528_irq_chip = {
 203         .name = "bd70528_irq",
 204         .main_status = BD70528_REG_INT_MAIN,
 205         .irqs = &bd70528_irqs[0],
 206         .num_irqs = ARRAY_SIZE(bd70528_irqs),
 207         .status_base = BD70528_REG_INT_SHDN,
 208         .mask_base = BD70528_REG_INT_SHDN_MASK,
 209         .ack_base = BD70528_REG_INT_SHDN,
 210         .type_base = BD70528_REG_GPIO1_IN,
 211         .init_ack_masked = true,
 212         .num_regs = 9,
 213         .num_main_regs = 1,
 214         .num_type_reg = 4,
 215         .sub_reg_offsets = &bd70528_sub_irq_offsets[0],
 216         .num_main_status_bits = 8,
 217         .irq_reg_stride = 1,
 218 };
 219
 220 static int bd70528_i2c_probe(struct i2c_client *i2c,
 221                              const struct i2c_device_id *id)
 222 {
 223         struct bd70528_data *bd70528;
 224         struct regmap_irq_chip_data *irq_data;
 225         int ret, i;
 226
 227         if (!i2c->irq) {
 228                 dev_err(&i2c->dev, "No IRQ configured\n");
 229                 return -EINVAL;
 230         }
 231
 232         bd70528 = devm_kzalloc(&i2c->dev, sizeof(*bd70528), GFP_KERNEL);
 233         if (!bd70528)
 234                 return -ENOMEM;
 235
 236         mutex_init(&bd70528->rtc_timer_lock);
 237
 238         dev_set_drvdata(&i2c->dev, &bd70528->chip);
 239
 240         bd70528->chip.chip_type = ROHM_CHIP_TYPE_BD70528;
 241         bd70528->chip.regmap = devm_regmap_init_i2c(i2c, &bd70528_regmap);
 242         if (IS_ERR(bd70528->chip.regmap)) {
 243                 dev_err(&i2c->dev, "Failed to initialize Regmap\n");
 244                 return PTR_ERR(bd70528->chip.regmap);
 245         }
 246
 247         /*
 248          * Disallow type setting for all IRQs by default as most of them do not
 249          * support setting type.
 250          */
 251         for (i = 0; i < ARRAY_SIZE(bd70528_irqs); i++)
 252                 bd70528_irqs[i].type.types_supported = 0;
 253
 254         /* Set IRQ typesetting information for GPIO pins 0 - 3 */
 255         for (i = 0; i < BD70528_NUM_OF_GPIOS; i++) {
 256                 struct regmap_irq_type *type;
 257
 258                 type = &bd70528_irqs[BD70528_INT_GPIO0 + i].type;
 259                 type->type_reg_offset = 2 * i;
 260                 type->type_rising_val = 0x20;
 261                 type->type_falling_val = 0x10;
 262                 type->type_level_high_val = 0x40;
 263                 type->type_level_low_val = 0x50;
 264                 type->types_supported = (IRQ_TYPE_EDGE_BOTH |
 265                                 IRQ_TYPE_LEVEL_HIGH | IRQ_TYPE_LEVEL_LOW);
 266         }
 267
 268         ret = devm_regmap_add_irq_chip(&i2c->dev, bd70528->chip.regmap,
 269                                        i2c->irq, IRQF_ONESHOT, 0,
 270                                        &bd70528_irq_chip, &irq_data);
 271         if (ret) {
 272                 dev_err(&i2c->dev, "Failed to add IRQ chip\n");
 273                 return ret;
 274         }
 275         dev_dbg(&i2c->dev, "Registered %d IRQs for chip\n",
 276                 bd70528_irq_chip.num_irqs);
 277
 278         /*
 279          * BD70528 IRQ controller is not touching the main mask register.
 280          * So enable the GPIO block interrupts at main level. We can just leave
 281          * them enabled as the IRQ controller should disable IRQs from
 282          * sub-registers when IRQ is disabled or freed.
 283          */
 284         ret = regmap_update_bits(bd70528->chip.regmap,
 285                                  BD70528_REG_INT_MAIN_MASK,
 286                                  BD70528_INT_GPIO_MASK, 0);
 287
 288         ret = devm_mfd_add_devices(&i2c->dev, PLATFORM_DEVID_AUTO,
 289                                    bd70528_mfd_cells,
 290                                    ARRAY_SIZE(bd70528_mfd_cells), NULL, 0,
 291                                    regmap_irq_get_domain(irq_data));
 292         if (ret)
 293                 dev_err(&i2c->dev, "Failed to create subdevices\n");
 294
 295         return ret;
 296 }
 297
 298 static const struct of_device_id bd70528_of_match[] = {
 299         { .compatible = "rohm,bd70528", },
 300         { },
 301 };
 302 MODULE_DEVICE_TABLE(of, bd70528_of_match);
 303
 304 static struct i2c_driver bd70528_drv = {
 305         .driver = {
 306                 .name = "rohm-bd70528",
 307                 .of_match_table = bd70528_of_match,
 308         },
 309         .probe = &bd70528_i2c_probe,
 310 };
 311
 312 module_i2c_driver(bd70528_drv);
 313
 314 MODULE_AUTHOR("Matti Vaittinen <matti.vaittinen@fi.rohmeurope.com>");
 315 MODULE_DESCRIPTION("ROHM BD70528 Power Management IC driver");
 316 MODULE_LICENSE("GPL");