Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

mfd: stpmic1: Add STPMIC1 driver

STPMIC1 is a PMIC from STMicroelectronics. The STPMIC1 integrates 10
regulators, 3 power switches, a watchdog and an input for a power on key.

Signed-off-by: Pascal Paillet <p.paillet@st.com>
Signed-off-by: Lee Jones <lee.jones@linaro.org>

authored by

Pascal PAILLET-LME and committed by
Lee Jones
51908d2e 3eafbd3a

+442
+16
drivers/mfd/Kconfig
··· 1871 1871 for PWM and IIO Timer. This driver allow to share the 1872 1872 registers between the others drivers. 1873 1873 1874 + config MFD_STPMIC1 1875 + tristate "Support for STPMIC1 PMIC" 1876 + depends on (I2C=y && OF) 1877 + select REGMAP_I2C 1878 + select REGMAP_IRQ 1879 + select MFD_CORE 1880 + help 1881 + Support for ST Microelectronics STPMIC1 PMIC. STPMIC1 has power on 1882 + key, watchdog and regulator functionalities which are supported via 1883 + the relevant subsystems. This driver provides core support for the 1884 + STPMIC1. In order to use the actual functionaltiy of the device other 1885 + drivers must be enabled. 1886 + 1887 + To compile this driver as a module, choose M here: the 1888 + module will be called stpmic1. 1889 + 1874 1890 menu "Multimedia Capabilities Port drivers" 1875 1891 depends on ARCH_SA1100 1876 1892
+1
drivers/mfd/Makefile
··· 233 233 obj-$(CONFIG_MFD_MT6397) += mt6397-core.o 234 234 235 235 obj-$(CONFIG_MFD_ALTERA_A10SR) += altera-a10sr.o 236 + obj-$(CONFIG_MFD_STPMIC1) += stpmic1.o 236 237 obj-$(CONFIG_MFD_SUN4I_GPADC) += sun4i-gpadc.o 237 238 238 239 obj-$(CONFIG_MFD_STM32_LPTIMER) += stm32-lptimer.o
+213
drivers/mfd/stpmic1.c
··· 1 + // SPDX-License-Identifier: GPL-2.0 2 + // Copyright (C) STMicroelectronics 2018 3 + // Author: Pascal Paillet <p.paillet@st.com> 4 + 5 + #include <linux/i2c.h> 6 + #include <linux/interrupt.h> 7 + #include <linux/mfd/core.h> 8 + #include <linux/mfd/stpmic1.h> 9 + #include <linux/module.h> 10 + #include <linux/of.h> 11 + #include <linux/of_irq.h> 12 + #include <linux/of_platform.h> 13 + #include <linux/pm_wakeirq.h> 14 + #include <linux/regmap.h> 15 + 16 + #include <dt-bindings/mfd/st,stpmic1.h> 17 + 18 + #define STPMIC1_MAIN_IRQ 0 19 + 20 + static const struct regmap_range stpmic1_readable_ranges[] = { 21 + regmap_reg_range(TURN_ON_SR, VERSION_SR), 22 + regmap_reg_range(SWOFF_PWRCTRL_CR, LDO6_STDBY_CR), 23 + regmap_reg_range(BST_SW_CR, BST_SW_CR), 24 + regmap_reg_range(INT_PENDING_R1, INT_PENDING_R4), 25 + regmap_reg_range(INT_CLEAR_R1, INT_CLEAR_R4), 26 + regmap_reg_range(INT_MASK_R1, INT_MASK_R4), 27 + regmap_reg_range(INT_SET_MASK_R1, INT_SET_MASK_R4), 28 + regmap_reg_range(INT_CLEAR_MASK_R1, INT_CLEAR_MASK_R4), 29 + regmap_reg_range(INT_SRC_R1, INT_SRC_R1), 30 + }; 31 + 32 + static const struct regmap_range stpmic1_writeable_ranges[] = { 33 + regmap_reg_range(SWOFF_PWRCTRL_CR, LDO6_STDBY_CR), 34 + regmap_reg_range(BST_SW_CR, BST_SW_CR), 35 + regmap_reg_range(INT_CLEAR_R1, INT_CLEAR_R4), 36 + regmap_reg_range(INT_SET_MASK_R1, INT_SET_MASK_R4), 37 + regmap_reg_range(INT_CLEAR_MASK_R1, INT_CLEAR_MASK_R4), 38 + }; 39 + 40 + static const struct regmap_range stpmic1_volatile_ranges[] = { 41 + regmap_reg_range(TURN_ON_SR, VERSION_SR), 42 + regmap_reg_range(WCHDG_CR, WCHDG_CR), 43 + regmap_reg_range(INT_PENDING_R1, INT_PENDING_R4), 44 + regmap_reg_range(INT_SRC_R1, INT_SRC_R4), 45 + }; 46 + 47 + static const struct regmap_access_table stpmic1_readable_table = { 48 + .yes_ranges = stpmic1_readable_ranges, 49 + .n_yes_ranges = ARRAY_SIZE(stpmic1_readable_ranges), 50 + }; 51 + 52 + static const struct regmap_access_table stpmic1_writeable_table = { 53 + .yes_ranges = stpmic1_writeable_ranges, 54 + .n_yes_ranges = ARRAY_SIZE(stpmic1_writeable_ranges), 55 + }; 56 + 57 + static const struct regmap_access_table stpmic1_volatile_table = { 58 + .yes_ranges = stpmic1_volatile_ranges, 59 + .n_yes_ranges = ARRAY_SIZE(stpmic1_volatile_ranges), 60 + }; 61 + 62 + const struct regmap_config stpmic1_regmap_config = { 63 + .reg_bits = 8, 64 + .val_bits = 8, 65 + .cache_type = REGCACHE_RBTREE, 66 + .max_register = PMIC_MAX_REGISTER_ADDRESS, 67 + .rd_table = &stpmic1_readable_table, 68 + .wr_table = &stpmic1_writeable_table, 69 + .volatile_table = &stpmic1_volatile_table, 70 + }; 71 + 72 + static const struct regmap_irq stpmic1_irqs[] = { 73 + REGMAP_IRQ_REG(IT_PONKEY_F, 0, 0x01), 74 + REGMAP_IRQ_REG(IT_PONKEY_R, 0, 0x02), 75 + REGMAP_IRQ_REG(IT_WAKEUP_F, 0, 0x04), 76 + REGMAP_IRQ_REG(IT_WAKEUP_R, 0, 0x08), 77 + REGMAP_IRQ_REG(IT_VBUS_OTG_F, 0, 0x10), 78 + REGMAP_IRQ_REG(IT_VBUS_OTG_R, 0, 0x20), 79 + REGMAP_IRQ_REG(IT_SWOUT_F, 0, 0x40), 80 + REGMAP_IRQ_REG(IT_SWOUT_R, 0, 0x80), 81 + 82 + REGMAP_IRQ_REG(IT_CURLIM_BUCK1, 1, 0x01), 83 + REGMAP_IRQ_REG(IT_CURLIM_BUCK2, 1, 0x02), 84 + REGMAP_IRQ_REG(IT_CURLIM_BUCK3, 1, 0x04), 85 + REGMAP_IRQ_REG(IT_CURLIM_BUCK4, 1, 0x08), 86 + REGMAP_IRQ_REG(IT_OCP_OTG, 1, 0x10), 87 + REGMAP_IRQ_REG(IT_OCP_SWOUT, 1, 0x20), 88 + REGMAP_IRQ_REG(IT_OCP_BOOST, 1, 0x40), 89 + REGMAP_IRQ_REG(IT_OVP_BOOST, 1, 0x80), 90 + 91 + REGMAP_IRQ_REG(IT_CURLIM_LDO1, 2, 0x01), 92 + REGMAP_IRQ_REG(IT_CURLIM_LDO2, 2, 0x02), 93 + REGMAP_IRQ_REG(IT_CURLIM_LDO3, 2, 0x04), 94 + REGMAP_IRQ_REG(IT_CURLIM_LDO4, 2, 0x08), 95 + REGMAP_IRQ_REG(IT_CURLIM_LDO5, 2, 0x10), 96 + REGMAP_IRQ_REG(IT_CURLIM_LDO6, 2, 0x20), 97 + REGMAP_IRQ_REG(IT_SHORT_SWOTG, 2, 0x40), 98 + REGMAP_IRQ_REG(IT_SHORT_SWOUT, 2, 0x80), 99 + 100 + REGMAP_IRQ_REG(IT_TWARN_F, 3, 0x01), 101 + REGMAP_IRQ_REG(IT_TWARN_R, 3, 0x02), 102 + REGMAP_IRQ_REG(IT_VINLOW_F, 3, 0x04), 103 + REGMAP_IRQ_REG(IT_VINLOW_R, 3, 0x08), 104 + REGMAP_IRQ_REG(IT_SWIN_F, 3, 0x40), 105 + REGMAP_IRQ_REG(IT_SWIN_R, 3, 0x80), 106 + }; 107 + 108 + static const struct regmap_irq_chip stpmic1_regmap_irq_chip = { 109 + .name = "pmic_irq", 110 + .status_base = INT_PENDING_R1, 111 + .mask_base = INT_CLEAR_MASK_R1, 112 + .unmask_base = INT_SET_MASK_R1, 113 + .ack_base = INT_CLEAR_R1, 114 + .num_regs = STPMIC1_PMIC_NUM_IRQ_REGS, 115 + .irqs = stpmic1_irqs, 116 + .num_irqs = ARRAY_SIZE(stpmic1_irqs), 117 + }; 118 + 119 + static int stpmic1_probe(struct i2c_client *i2c, 120 + const struct i2c_device_id *id) 121 + { 122 + struct stpmic1 *ddata; 123 + struct device *dev = &i2c->dev; 124 + int ret; 125 + struct device_node *np = dev->of_node; 126 + u32 reg; 127 + 128 + ddata = devm_kzalloc(dev, sizeof(struct stpmic1), GFP_KERNEL); 129 + if (!ddata) 130 + return -ENOMEM; 131 + 132 + i2c_set_clientdata(i2c, ddata); 133 + ddata->dev = dev; 134 + 135 + ddata->regmap = devm_regmap_init_i2c(i2c, &stpmic1_regmap_config); 136 + if (IS_ERR(ddata->regmap)) 137 + return PTR_ERR(ddata->regmap); 138 + 139 + ddata->irq = of_irq_get(np, STPMIC1_MAIN_IRQ); 140 + if (ddata->irq < 0) { 141 + dev_err(dev, "Failed to get main IRQ: %d\n", ddata->irq); 142 + return ddata->irq; 143 + } 144 + 145 + ret = regmap_read(ddata->regmap, VERSION_SR, &reg); 146 + if (ret) { 147 + dev_err(dev, "Unable to read PMIC version\n"); 148 + return ret; 149 + } 150 + dev_info(dev, "PMIC Chip Version: 0x%x\n", reg); 151 + 152 + /* Initialize PMIC IRQ Chip & associated IRQ domains */ 153 + ret = devm_regmap_add_irq_chip(dev, ddata->regmap, ddata->irq, 154 + IRQF_ONESHOT | IRQF_SHARED, 155 + 0, &stpmic1_regmap_irq_chip, 156 + &ddata->irq_data); 157 + if (ret) { 158 + dev_err(dev, "IRQ Chip registration failed: %d\n", ret); 159 + return ret; 160 + } 161 + 162 + return devm_of_platform_populate(dev); 163 + } 164 + 165 + #ifdef CONFIG_PM_SLEEP 166 + static int stpmic1_suspend(struct device *dev) 167 + { 168 + struct i2c_client *i2c = to_i2c_client(dev); 169 + struct stpmic1 *pmic_dev = i2c_get_clientdata(i2c); 170 + 171 + disable_irq(pmic_dev->irq); 172 + 173 + return 0; 174 + } 175 + 176 + static int stpmic1_resume(struct device *dev) 177 + { 178 + struct i2c_client *i2c = to_i2c_client(dev); 179 + struct stpmic1 *pmic_dev = i2c_get_clientdata(i2c); 180 + int ret; 181 + 182 + ret = regcache_sync(pmic_dev->regmap); 183 + if (ret) 184 + return ret; 185 + 186 + enable_irq(pmic_dev->irq); 187 + 188 + return 0; 189 + } 190 + #endif 191 + 192 + static SIMPLE_DEV_PM_OPS(stpmic1_pm, stpmic1_suspend, stpmic1_resume); 193 + 194 + static const struct of_device_id stpmic1_of_match[] = { 195 + { .compatible = "st,stpmic1", }, 196 + {}, 197 + }; 198 + MODULE_DEVICE_TABLE(of, stpmic1_of_match); 199 + 200 + static struct i2c_driver stpmic1_driver = { 201 + .driver = { 202 + .name = "stpmic1", 203 + .of_match_table = of_match_ptr(stpmic1_of_match), 204 + .pm = &stpmic1_pm, 205 + }, 206 + .probe = stpmic1_probe, 207 + }; 208 + 209 + module_i2c_driver(stpmic1_driver); 210 + 211 + MODULE_DESCRIPTION("STPMIC1 PMIC Driver"); 212 + MODULE_AUTHOR("Pascal Paillet <p.paillet@st.com>"); 213 + MODULE_LICENSE("GPL v2");
+212
include/linux/mfd/stpmic1.h
··· 1 + /* SPDX-License-Identifier: GPL-2.0 */ 2 + /* 3 + * Copyright (C) STMicroelectronics 2018 - All Rights Reserved 4 + * Author: Philippe Peurichard <philippe.peurichard@st.com>, 5 + * Pascal Paillet <p.paillet@st.com> for STMicroelectronics. 6 + */ 7 + 8 + #ifndef __LINUX_MFD_STPMIC1_H 9 + #define __LINUX_MFD_STPMIC1_H 10 + 11 + #define TURN_ON_SR 0x1 12 + #define TURN_OFF_SR 0x2 13 + #define ICC_LDO_TURN_OFF_SR 0x3 14 + #define ICC_BUCK_TURN_OFF_SR 0x4 15 + #define RREQ_STATE_SR 0x5 16 + #define VERSION_SR 0x6 17 + 18 + #define SWOFF_PWRCTRL_CR 0x10 19 + #define PADS_PULL_CR 0x11 20 + #define BUCKS_PD_CR 0x12 21 + #define LDO14_PD_CR 0x13 22 + #define LDO56_VREF_PD_CR 0x14 23 + #define VBUS_DET_VIN_CR 0x15 24 + #define PKEY_TURNOFF_CR 0x16 25 + #define BUCKS_MASK_RANK_CR 0x17 26 + #define BUCKS_MASK_RESET_CR 0x18 27 + #define LDOS_MASK_RANK_CR 0x19 28 + #define LDOS_MASK_RESET_CR 0x1A 29 + #define WCHDG_CR 0x1B 30 + #define WCHDG_TIMER_CR 0x1C 31 + #define BUCKS_ICCTO_CR 0x1D 32 + #define LDOS_ICCTO_CR 0x1E 33 + 34 + #define BUCK1_ACTIVE_CR 0x20 35 + #define BUCK2_ACTIVE_CR 0x21 36 + #define BUCK3_ACTIVE_CR 0x22 37 + #define BUCK4_ACTIVE_CR 0x23 38 + #define VREF_DDR_ACTIVE_CR 0x24 39 + #define LDO1_ACTIVE_CR 0x25 40 + #define LDO2_ACTIVE_CR 0x26 41 + #define LDO3_ACTIVE_CR 0x27 42 + #define LDO4_ACTIVE_CR 0x28 43 + #define LDO5_ACTIVE_CR 0x29 44 + #define LDO6_ACTIVE_CR 0x2A 45 + 46 + #define BUCK1_STDBY_CR 0x30 47 + #define BUCK2_STDBY_CR 0x31 48 + #define BUCK3_STDBY_CR 0x32 49 + #define BUCK4_STDBY_CR 0x33 50 + #define VREF_DDR_STDBY_CR 0x34 51 + #define LDO1_STDBY_CR 0x35 52 + #define LDO2_STDBY_CR 0x36 53 + #define LDO3_STDBY_CR 0x37 54 + #define LDO4_STDBY_CR 0x38 55 + #define LDO5_STDBY_CR 0x39 56 + #define LDO6_STDBY_CR 0x3A 57 + 58 + #define BST_SW_CR 0x40 59 + 60 + #define INT_PENDING_R1 0x50 61 + #define INT_PENDING_R2 0x51 62 + #define INT_PENDING_R3 0x52 63 + #define INT_PENDING_R4 0x53 64 + 65 + #define INT_DBG_LATCH_R1 0x60 66 + #define INT_DBG_LATCH_R2 0x61 67 + #define INT_DBG_LATCH_R3 0x62 68 + #define INT_DBG_LATCH_R4 0x63 69 + 70 + #define INT_CLEAR_R1 0x70 71 + #define INT_CLEAR_R2 0x71 72 + #define INT_CLEAR_R3 0x72 73 + #define INT_CLEAR_R4 0x73 74 + 75 + #define INT_MASK_R1 0x80 76 + #define INT_MASK_R2 0x81 77 + #define INT_MASK_R3 0x82 78 + #define INT_MASK_R4 0x83 79 + 80 + #define INT_SET_MASK_R1 0x90 81 + #define INT_SET_MASK_R2 0x91 82 + #define INT_SET_MASK_R3 0x92 83 + #define INT_SET_MASK_R4 0x93 84 + 85 + #define INT_CLEAR_MASK_R1 0xA0 86 + #define INT_CLEAR_MASK_R2 0xA1 87 + #define INT_CLEAR_MASK_R3 0xA2 88 + #define INT_CLEAR_MASK_R4 0xA3 89 + 90 + #define INT_SRC_R1 0xB0 91 + #define INT_SRC_R2 0xB1 92 + #define INT_SRC_R3 0xB2 93 + #define INT_SRC_R4 0xB3 94 + 95 + #define PMIC_MAX_REGISTER_ADDRESS INT_SRC_R4 96 + 97 + #define STPMIC1_PMIC_NUM_IRQ_REGS 4 98 + 99 + #define TURN_OFF_SR_ICC_EVENT 0x08 100 + 101 + #define LDO_VOLTAGE_MASK GENMASK(6, 2) 102 + #define BUCK_VOLTAGE_MASK GENMASK(7, 2) 103 + #define LDO_BUCK_VOLTAGE_SHIFT 2 104 + 105 + #define LDO_ENABLE_MASK BIT(0) 106 + #define BUCK_ENABLE_MASK BIT(0) 107 + 108 + #define BUCK_HPLP_ENABLE_MASK BIT(1) 109 + #define BUCK_HPLP_SHIFT 1 110 + 111 + #define STDBY_ENABLE_MASK BIT(0) 112 + 113 + #define BUCKS_PD_CR_REG_MASK GENMASK(7, 0) 114 + #define BUCK_MASK_RANK_REGISTER_MASK GENMASK(3, 0) 115 + #define BUCK_MASK_RESET_REGISTER_MASK GENMASK(3, 0) 116 + #define LDO1234_PULL_DOWN_REGISTER_MASK GENMASK(7, 0) 117 + #define LDO56_VREF_PD_CR_REG_MASK GENMASK(5, 0) 118 + #define LDO_MASK_RANK_REGISTER_MASK GENMASK(5, 0) 119 + #define LDO_MASK_RESET_REGISTER_MASK GENMASK(5, 0) 120 + 121 + #define BUCK1_PULL_DOWN_REG BUCKS_PD_CR 122 + #define BUCK1_PULL_DOWN_MASK BIT(0) 123 + #define BUCK2_PULL_DOWN_REG BUCKS_PD_CR 124 + #define BUCK2_PULL_DOWN_MASK BIT(2) 125 + #define BUCK3_PULL_DOWN_REG BUCKS_PD_CR 126 + #define BUCK3_PULL_DOWN_MASK BIT(4) 127 + #define BUCK4_PULL_DOWN_REG BUCKS_PD_CR 128 + #define BUCK4_PULL_DOWN_MASK BIT(6) 129 + 130 + #define LDO1_PULL_DOWN_REG LDO14_PD_CR 131 + #define LDO1_PULL_DOWN_MASK BIT(0) 132 + #define LDO2_PULL_DOWN_REG LDO14_PD_CR 133 + #define LDO2_PULL_DOWN_MASK BIT(2) 134 + #define LDO3_PULL_DOWN_REG LDO14_PD_CR 135 + #define LDO3_PULL_DOWN_MASK BIT(4) 136 + #define LDO4_PULL_DOWN_REG LDO14_PD_CR 137 + #define LDO4_PULL_DOWN_MASK BIT(6) 138 + #define LDO5_PULL_DOWN_REG LDO56_VREF_PD_CR 139 + #define LDO5_PULL_DOWN_MASK BIT(0) 140 + #define LDO6_PULL_DOWN_REG LDO56_VREF_PD_CR 141 + #define LDO6_PULL_DOWN_MASK BIT(2) 142 + #define VREF_DDR_PULL_DOWN_REG LDO56_VREF_PD_CR 143 + #define VREF_DDR_PULL_DOWN_MASK BIT(4) 144 + 145 + #define BUCKS_ICCTO_CR_REG_MASK GENMASK(6, 0) 146 + #define LDOS_ICCTO_CR_REG_MASK GENMASK(5, 0) 147 + 148 + #define LDO_BYPASS_MASK BIT(7) 149 + 150 + /* Main PMIC Control Register 151 + * SWOFF_PWRCTRL_CR 152 + * Address : 0x10 153 + */ 154 + #define ICC_EVENT_ENABLED BIT(4) 155 + #define PWRCTRL_POLARITY_HIGH BIT(3) 156 + #define PWRCTRL_PIN_VALID BIT(2) 157 + #define RESTART_REQUEST_ENABLED BIT(1) 158 + #define SOFTWARE_SWITCH_OFF_ENABLED BIT(0) 159 + 160 + /* Main PMIC PADS Control Register 161 + * PADS_PULL_CR 162 + * Address : 0x11 163 + */ 164 + #define WAKEUP_DETECTOR_DISABLED BIT(4) 165 + #define PWRCTRL_PD_ACTIVE BIT(3) 166 + #define PWRCTRL_PU_ACTIVE BIT(2) 167 + #define WAKEUP_PD_ACTIVE BIT(1) 168 + #define PONKEY_PU_INACTIVE BIT(0) 169 + 170 + /* Main PMIC VINLOW Control Register 171 + * VBUS_DET_VIN_CRC DMSC 172 + * Address : 0x15 173 + */ 174 + #define SWIN_DETECTOR_ENABLED BIT(7) 175 + #define SWOUT_DETECTOR_ENABLED BIT(6) 176 + #define VINLOW_ENABLED BIT(0) 177 + #define VINLOW_CTRL_REG_MASK GENMASK(7, 0) 178 + 179 + /* USB Control Register 180 + * Address : 0x40 181 + */ 182 + #define BOOST_OVP_DISABLED BIT(7) 183 + #define VBUS_OTG_DETECTION_DISABLED BIT(6) 184 + #define SW_OUT_DISCHARGE BIT(5) 185 + #define VBUS_OTG_DISCHARGE BIT(4) 186 + #define OCP_LIMIT_HIGH BIT(3) 187 + #define SWIN_SWOUT_ENABLED BIT(2) 188 + #define USBSW_OTG_SWITCH_ENABLED BIT(1) 189 + #define BOOST_ENABLED BIT(0) 190 + 191 + /* PKEY_TURNOFF_CR 192 + * Address : 0x16 193 + */ 194 + #define PONKEY_PWR_OFF BIT(7) 195 + #define PONKEY_CC_FLAG_CLEAR BIT(6) 196 + #define PONKEY_TURNOFF_TIMER_MASK GENMASK(3, 0) 197 + #define PONKEY_TURNOFF_MASK GENMASK(7, 0) 198 + 199 + /* 200 + * struct stpmic1 - stpmic1 master device for sub-drivers 201 + * @dev: master device of the chip (can be used to access platform data) 202 + * @irq: main IRQ number 203 + * @regmap_irq_chip_data: irq chip data 204 + */ 205 + struct stpmic1 { 206 + struct device *dev; 207 + struct regmap *regmap; 208 + int irq; 209 + struct regmap_irq_chip_data *irq_data; 210 + }; 211 + 212 + #endif /* __LINUX_MFD_STPMIC1_H */