Re: [PATCH v1 12/13] pinctrl: pinctrl-tps6594: Add TPS65224 PMIC pinctrl and GPIO

From: Linus Walleij
Date: Thu Feb 08 2024 - 08:50:24 EST


Top posting for context to new people.

I'd like Esteban to look at this, because he wrote the driver.

Yours,
Linus Walleij

On Thu, Feb 8, 2024 at 10:21 AM Bhargav Raviprakash <bhargav.r@lttscom> wrote:

> From: Nirmala Devi Mal Nadar <m.nirmaladevi@xxxxxxxx>
>
> Add support for TPS65224 pinctrl and GPIOs to TPS6594 driver as they
> have significant functional overlap.
> TPS65224 PMIC has 6 GPIOS which can be configured as GPIO or other
> dedicated device functions.
>
> Signed-off-by: Nirmala Devi Mal Nadar <m.nirmaladevi@xxxxxxxx>
> ---
> drivers/pinctrl/pinctrl-tps6594.c | 287 +++++++++++++++++++++++++-----
> 1 file changed, 246 insertions(+), 41 deletions(-)
>
> diff --git a/drivers/pinctrl/pinctrl-tps6594.c b/drivers/pinctrl/pinctrl-tps6594.c
> index 66985e54b..5da21aa14 100644
> --- a/drivers/pinctrl/pinctrl-tps6594.c
> +++ b/drivers/pinctrl/pinctrl-tps6594.c
> @@ -14,8 +14,6 @@
>
> #include <linux/mfd/tps6594.h>
>
> -#define TPS6594_PINCTRL_PINS_NB 11
> -
> #define TPS6594_PINCTRL_GPIO_FUNCTION 0
> #define TPS6594_PINCTRL_SCL_I2C2_CS_SPI_FUNCTION 1
> #define TPS6594_PINCTRL_TRIG_WDOG_FUNCTION 1
> @@ -40,17 +38,40 @@
> #define TPS6594_PINCTRL_SYNCCLKOUT_FUNCTION_GPIO8 3
> #define TPS6594_PINCTRL_CLK32KOUT_FUNCTION_GPIO9 3
>
> +/* TPS65224 pin muxval */
> +#define TPS65224_PINCTRL_SDA_I2C2_SDO_SPI_FUNCTION 1
> +#define TPS65224_PINCTRL_SCL_I2C2_CS_SPI_FUNCTION 1
> +#define TPS65224_PINCTRL_VMON1_FUNCTION 1
> +#define TPS65224_PINCTRL_VMON2_FUNCTION 1
> +#define TPS65224_PINCTRL_WKUP_FUNCTION 1
> +#define TPS65224_PINCTRL_NSLEEP2_FUNCTION 2
> +#define TPS65224_PINCTRL_NSLEEP1_FUNCTION 2
> +#define TPS65224_PINCTRL_SYNCCLKIN_FUNCTION 2
> +#define TPS65224_PINCTRL_NERR_MCU_FUNCTION 2
> +#define TPS65224_PINCTRL_NINT_FUNCTION 3
> +#define TPS65224_PINCTRL_TRIG_WDOG_FUNCTION 3
> +#define TPS65224_PINCTRL_PB_FUNCTION 3
> +#define TPS65224_PINCTRL_ADC_IN_FUNCTION 3
> +
> +/* TPS65224 Special muxval for recalcitrant pins */
> +#define TPS65224_PINCTRL_NSLEEP2_FUNCTION_GPIO5 1
> +#define TPS65224_PINCTRL_WKUP_FUNCTION_GPIO5 4
> +#define TPS65224_PINCTRL_SYNCCLKIN_FUNCTION_GPIO5 3
> +
> #define TPS6594_OFFSET_GPIO_SEL 5
>
> -#define FUNCTION(fname, v) \
> +#define TPS65224_NGPIO_PER_REG 6
> +#define TPS6594_NGPIO_PER_REG 8
> +
> +#define FUNCTION(dev_name, fname, v) \
> { \
> .pinfunction = PINCTRL_PINFUNCTION(#fname, \
> - tps6594_##fname##_func_group_names, \
> - ARRAY_SIZE(tps6594_##fname##_func_group_names)),\
> + dev_name##_##fname##_func_group_names, \
> + ARRAY_SIZE(dev_name##_##fname##_func_group_names)),\
> .muxval = v, \
> }
>
> -static const struct pinctrl_pin_desc tps6594_pins[TPS6594_PINCTRL_PINS_NB] = {
> +static const struct pinctrl_pin_desc tps6594_pins[] = {
> PINCTRL_PIN(0, "GPIO0"), PINCTRL_PIN(1, "GPIO1"),
> PINCTRL_PIN(2, "GPIO2"), PINCTRL_PIN(3, "GPIO3"),
> PINCTRL_PIN(4, "GPIO4"), PINCTRL_PIN(5, "GPIO5"),
> @@ -143,30 +164,127 @@ static const char *const tps6594_syncclkin_func_group_names[] = {
> "GPIO9",
> };
>
> +static const struct pinctrl_pin_desc tps65224_pins[] = {
> + PINCTRL_PIN(0, "GPIO0"), PINCTRL_PIN(1, "GPIO1"),
> + PINCTRL_PIN(2, "GPIO2"), PINCTRL_PIN(3, "GPIO3"),
> + PINCTRL_PIN(4, "GPIO4"), PINCTRL_PIN(5, "GPIO5"),
> +};
> +
> +static const char *const tps65224_gpio_func_group_names[] = {
> + "GPIO0", "GPIO1", "GPIO2", "GPIO3", "GPIO4", "GPIO5",
> +};
> +
> +static const char *const tps65224_sda_i2c2_sdo_spi_func_group_names[] = {
> + "GPIO0",
> +};
> +
> +static const char *const tps65224_nsleep2_func_group_names[] = {
> + "GPIO0", "GPIO5",
> +};
> +
> +static const char *const tps65224_nint_func_group_names[] = {
> + "GPIO0",
> +};
> +
> +static const char *const tps65224_scl_i2c2_cs_spi_func_group_names[] = {
> + "GPIO1",
> +};
> +
> +static const char *const tps65224_nsleep1_func_group_names[] = {
> + "GPIO1", "GPIO2", "GPIO3",
> +};
> +
> +static const char *const tps65224_trig_wdog_func_group_names[] = {
> + "GPIO1",
> +};
> +
> +static const char *const tps65224_vmon1_func_group_names[] = {
> + "GPIO2",
> +};
> +
> +static const char *const tps65224_pb_func_group_names[] = {
> + "GPIO2",
> +};
> +
> +static const char *const tps65224_vmon2_func_group_names[] = {
> + "GPIO3",
> +};
> +
> +static const char *const tps65224_adc_in_func_group_names[] = {
> + "GPIO3", "GPIO4",
> +};
> +
> +static const char *const tps65224_wkup_func_group_names[] = {
> + "GPIO4", "GPIO5",
> +};
> +
> +static const char *const tps65224_syncclkin_func_group_names[] = {
> + "GPIO4", "GPIO5",
> +};
> +
> +static const char *const tps65224_nerr_mcu_func_group_names[] = {
> + "GPIO5",
> +};
> +
> struct tps6594_pinctrl_function {
> struct pinfunction pinfunction;
> u8 muxval;
> };
>
> +struct muxval_remap {
> + unsigned int group;
> + u8 muxval;
> + u8 remap;
> +};
> +
> +struct muxval_remap tps65224_muxval_remap[] = {
> + {5, TPS6594_PINCTRL_DISABLE_WDOG_FUNCTION, TPS65224_PINCTRL_WKUP_FUNCTION_GPIO5},
> + {5, TPS65224_PINCTRL_SYNCCLKIN_FUNCTION, TPS65224_PINCTRL_SYNCCLKIN_FUNCTION_GPIO5},
> + {5, TPS65224_PINCTRL_NSLEEP2_FUNCTION, TPS65224_PINCTRL_NSLEEP2_FUNCTION_GPIO5},
> +};
> +
> +struct muxval_remap tps6594_muxval_remap[] = {
> + {8, TPS6594_PINCTRL_DISABLE_WDOG_FUNCTION, TPS6594_PINCTRL_DISABLE_WDOG_FUNCTION_GPIO8},
> + {8, TPS6594_PINCTRL_SYNCCLKOUT_FUNCTION, TPS6594_PINCTRL_SYNCCLKOUT_FUNCTION_GPIO8},
> + {9, TPS6594_PINCTRL_CLK32KOUT_FUNCTION, TPS6594_PINCTRL_CLK32KOUT_FUNCTION_GPIO9},
> +};
> +
> static const struct tps6594_pinctrl_function pinctrl_functions[] = {
> - FUNCTION(gpio, TPS6594_PINCTRL_GPIO_FUNCTION),
> - FUNCTION(nsleep1, TPS6594_PINCTRL_NSLEEP1_FUNCTION),
> - FUNCTION(nsleep2, TPS6594_PINCTRL_NSLEEP2_FUNCTION),
> - FUNCTION(wkup1, TPS6594_PINCTRL_WKUP1_FUNCTION),
> - FUNCTION(wkup2, TPS6594_PINCTRL_WKUP2_FUNCTION),
> - FUNCTION(scl_i2c2_cs_spi, TPS6594_PINCTRL_SCL_I2C2_CS_SPI_FUNCTION),
> - FUNCTION(nrstout_soc, TPS6594_PINCTRL_NRSTOUT_SOC_FUNCTION),
> - FUNCTION(trig_wdog, TPS6594_PINCTRL_TRIG_WDOG_FUNCTION),
> - FUNCTION(sda_i2c2_sdo_spi, TPS6594_PINCTRL_SDA_I2C2_SDO_SPI_FUNCTION),
> - FUNCTION(clk32kout, TPS6594_PINCTRL_CLK32KOUT_FUNCTION),
> - FUNCTION(nerr_soc, TPS6594_PINCTRL_NERR_SOC_FUNCTION),
> - FUNCTION(sclk_spmi, TPS6594_PINCTRL_SCLK_SPMI_FUNCTION),
> - FUNCTION(sdata_spmi, TPS6594_PINCTRL_SDATA_SPMI_FUNCTION),
> - FUNCTION(nerr_mcu, TPS6594_PINCTRL_NERR_MCU_FUNCTION),
> - FUNCTION(syncclkout, TPS6594_PINCTRL_SYNCCLKOUT_FUNCTION),
> - FUNCTION(disable_wdog, TPS6594_PINCTRL_DISABLE_WDOG_FUNCTION),
> - FUNCTION(pdog, TPS6594_PINCTRL_PDOG_FUNCTION),
> - FUNCTION(syncclkin, TPS6594_PINCTRL_SYNCCLKIN_FUNCTION),
> + FUNCTION(tps6594, gpio, TPS6594_PINCTRL_GPIO_FUNCTION),
> + FUNCTION(tps6594, nsleep1, TPS6594_PINCTRL_NSLEEP1_FUNCTION),
> + FUNCTION(tps6594, nsleep2, TPS6594_PINCTRL_NSLEEP2_FUNCTION),
> + FUNCTION(tps6594, wkup1, TPS6594_PINCTRL_WKUP1_FUNCTION),
> + FUNCTION(tps6594, wkup2, TPS6594_PINCTRL_WKUP2_FUNCTION),
> + FUNCTION(tps6594, scl_i2c2_cs_spi, TPS6594_PINCTRL_SCL_I2C2_CS_SPI_FUNCTION),
> + FUNCTION(tps6594, nrstout_soc, TPS6594_PINCTRL_NRSTOUT_SOC_FUNCTION),
> + FUNCTION(tps6594, trig_wdog, TPS6594_PINCTRL_TRIG_WDOG_FUNCTION),
> + FUNCTION(tps6594, sda_i2c2_sdo_spi, TPS6594_PINCTRL_SDA_I2C2_SDO_SPI_FUNCTION),
> + FUNCTION(tps6594, clk32kout, TPS6594_PINCTRL_CLK32KOUT_FUNCTION),
> + FUNCTION(tps6594, nerr_soc, TPS6594_PINCTRL_NERR_SOC_FUNCTION),
> + FUNCTION(tps6594, sclk_spmi, TPS6594_PINCTRL_SCLK_SPMI_FUNCTION),
> + FUNCTION(tps6594, sdata_spmi, TPS6594_PINCTRL_SDATA_SPMI_FUNCTION),
> + FUNCTION(tps6594, nerr_mcu, TPS6594_PINCTRL_NERR_MCU_FUNCTION),
> + FUNCTION(tps6594, syncclkout, TPS6594_PINCTRL_SYNCCLKOUT_FUNCTION),
> + FUNCTION(tps6594, disable_wdog, TPS6594_PINCTRL_DISABLE_WDOG_FUNCTION),
> + FUNCTION(tps6594, pdog, TPS6594_PINCTRL_PDOG_FUNCTION),
> + FUNCTION(tps6594, syncclkin, TPS6594_PINCTRL_SYNCCLKIN_FUNCTION),
> +};
> +
> +static const struct tps6594_pinctrl_function tps65224_pinctrl_functions[] = {
> + FUNCTION(tps65224, gpio, TPS6594_PINCTRL_GPIO_FUNCTION),
> + FUNCTION(tps65224, sda_i2c2_sdo_spi, TPS65224_PINCTRL_SDA_I2C2_SDO_SPI_FUNCTION),
> + FUNCTION(tps65224, nsleep2, TPS65224_PINCTRL_NSLEEP2_FUNCTION),
> + FUNCTION(tps65224, nint, TPS65224_PINCTRL_NINT_FUNCTION),
> + FUNCTION(tps65224, scl_i2c2_cs_spi, TPS65224_PINCTRL_SCL_I2C2_CS_SPI_FUNCTION),
> + FUNCTION(tps65224, nsleep1, TPS65224_PINCTRL_NSLEEP1_FUNCTION),
> + FUNCTION(tps65224, trig_wdog, TPS65224_PINCTRL_TRIG_WDOG_FUNCTION),
> + FUNCTION(tps65224, vmon1, TPS65224_PINCTRL_VMON1_FUNCTION),
> + FUNCTION(tps65224, pb, TPS65224_PINCTRL_PB_FUNCTION),
> + FUNCTION(tps65224, vmon2, TPS65224_PINCTRL_VMON2_FUNCTION),
> + FUNCTION(tps65224, adc_in, TPS65224_PINCTRL_ADC_IN_FUNCTION),
> + FUNCTION(tps65224, wkup, TPS65224_PINCTRL_WKUP_FUNCTION),
> + FUNCTION(tps65224, syncclkin, TPS65224_PINCTRL_SYNCCLKIN_FUNCTION),
> + FUNCTION(tps65224, nerr_mcu, TPS65224_PINCTRL_NERR_MCU_FUNCTION),
> };
>
> struct tps6594_pinctrl {
> @@ -201,7 +319,21 @@ static int tps6594_gpio_regmap_xlate(struct gpio_regmap *gpio,
>
> static int tps6594_pmx_func_cnt(struct pinctrl_dev *pctldev)
> {
> - return ARRAY_SIZE(pinctrl_functions);
> + struct tps6594_pinctrl *pinctrl = pinctrl_dev_get_drvdata(pctldev);
> + int func_cnt = 0;
> +
> + switch (pinctrl->tps->chip_id) {
> + case TPS65224:
> + func_cnt = ARRAY_SIZE(tps65224_pinctrl_functions);
> + break;
> + case TPS6594:
> + func_cnt = ARRAY_SIZE(pinctrl_functions);
> + break;
> + default:
> + break;
> + }
> +
> + return func_cnt;
> }
>
> static const char *tps6594_pmx_func_name(struct pinctrl_dev *pctldev,
> @@ -229,10 +361,26 @@ static int tps6594_pmx_set(struct tps6594_pinctrl *pinctrl, unsigned int pin,
> u8 muxval)
> {
> u8 mux_sel_val = muxval << TPS6594_OFFSET_GPIO_SEL;
> + u8 mux_sel_mask = 0;
> +
> + switch (pinctrl->tps->chip_id) {
> + case TPS65224:
> + mux_sel_mask = TPS65224_MASK_GPIO_SEL;
> + /* GPIO6 has a different mask in TPS65224*/
> + if (pin == 5)
> + mux_sel_mask = TPS65224_MASK_GPIO_SEL_GPIO6;
> + mux_sel_mask = TPS6594_MASK_GPIO_SEL;
> + break;
> + case TPS6594:
> + mux_sel_mask = TPS6594_MASK_GPIO_SEL;
> + break;
> + default:
> + break;
> + }
>
> return regmap_update_bits(pinctrl->tps->regmap,
> TPS6594_REG_GPIOX_CONF(pin),
> - TPS6594_MASK_GPIO_SEL, mux_sel_val);
> + mux_sel_mask, mux_sel_val);
> }
>
> static int tps6594_pmx_set_mux(struct pinctrl_dev *pctldev,
> @@ -240,16 +388,28 @@ static int tps6594_pmx_set_mux(struct pinctrl_dev *pctldev,
> {
> struct tps6594_pinctrl *pinctrl = pinctrl_dev_get_drvdata(pctldev);
> u8 muxval = pinctrl->funcs[function].muxval;
> + unsigned int remap_cnt = 0;
> + struct muxval_remap *remap;
>
> /* Some pins don't have the same muxval for the same function... */
> - if (group == 8) {
> - if (muxval == TPS6594_PINCTRL_DISABLE_WDOG_FUNCTION)
> - muxval = TPS6594_PINCTRL_DISABLE_WDOG_FUNCTION_GPIO8;
> - else if (muxval == TPS6594_PINCTRL_SYNCCLKOUT_FUNCTION)
> - muxval = TPS6594_PINCTRL_SYNCCLKOUT_FUNCTION_GPIO8;
> - } else if (group == 9) {
> - if (muxval == TPS6594_PINCTRL_CLK32KOUT_FUNCTION)
> - muxval = TPS6594_PINCTRL_CLK32KOUT_FUNCTION_GPIO9;
> + switch (pinctrl->tps->chip_id) {
> + case TPS65224:
> + remap = tps65224_muxval_remap;
> + remap_cnt = ARRAY_SIZE(tps65224_muxval_remap);
> + break;
> + case TPS6594:
> + remap = tps6594_muxval_remap;
> + remap_cnt = ARRAY_SIZE(tps6594_muxval_remap);
> + break;
> + default:
> + break;
> + }
> +
> + for (unsigned int i = 0; i < remap_cnt; i++) {
> + if (group == remap[i].group && muxval == remap[i]muxval) {
> + muxval = remap[i].remap;
> + break;
> + }
> }
>
> return tps6594_pmx_set(pinctrl, group, muxval);
> @@ -276,7 +436,21 @@ static const struct pinmux_ops tps6594_pmx_ops = {
>
> static int tps6594_groups_cnt(struct pinctrl_dev *pctldev)
> {
> - return ARRAY_SIZE(tps6594_pins);
> + struct tps6594_pinctrl *pinctrl = pinctrl_dev_get_drvdata(pctldev);
> + int num_pins = 0;
> +
> + switch (pinctrl->tps->chip_id) {
> + case TPS65224:
> + num_pins = ARRAY_SIZE(tps65224_pins);
> + break;
> + case TPS6594:
> + num_pins = ARRAY_SIZE(tps6594_pins);
> + break;
> + default:
> + break;
> + }
> +
> + return num_pins;
> }
>
> static int tps6594_group_pins(struct pinctrl_dev *pctldev,
> @@ -320,8 +494,18 @@ static int tps6594_pinctrl_probe(struct platform_device *pdev)
> return -ENOMEM;
> pctrl_desc->name = dev_name(dev);
> pctrl_desc->owner = THIS_MODULE;
> - pctrl_desc->pins = tps6594_pins;
> - pctrl_desc->npins = ARRAY_SIZE(tps6594_pins);
> + switch (tps->chip_id) {
> + case TPS65224:
> + pctrl_desc->pins = tps65224_pins;
> + pctrl_desc->npins = ARRAY_SIZE(tps65224_pins);
> + break;
> + case TPS6594:
> + pctrl_desc->pins = tps6594_pins;
> + pctrl_desc->npins = ARRAY_SIZE(tps6594_pins);
> + break;
> + default:
> + break;
> + }
> pctrl_desc->pctlops = &tps6594_pctrl_ops;
> pctrl_desc->pmxops = &tps6594_pmx_ops;
>
> @@ -329,8 +513,18 @@ static int tps6594_pinctrl_probe(struct platform_device *pdev)
> if (!pinctrl)
> return -ENOMEM;
> pinctrl->tps = dev_get_drvdata(dev->parent);
> - pinctrl->funcs = pinctrl_functions;
> - pinctrl->pins = tps6594_pins;
> + switch (pinctrl->tps->chip_id) {
> + case TPS65224:
> + pinctrl->funcs = tps65224_pinctrl_functions;
> + pinctrl->pins = tps65224_pins;
> + break;
> + case TPS6594:
> + pinctrl->funcs = pinctrl_functions;
> + pinctrl->pins = tps6594_pins;
> + break;
> + default:
> + break;
> + }
> pinctrl->pctl_dev = devm_pinctrl_register(dev, pctrl_desc, pinctrl);
> if (IS_ERR(pinctrl->pctl_dev))
> return dev_err_probe(dev, PTR_ERR(pinctrl->pctl_dev),
> @@ -338,8 +532,18 @@ static int tps6594_pinctrl_probe(struct platform_device *pdev)
>
> config.parent = tps->dev;
> config.regmap = tps->regmap;
> - config.ngpio = TPS6594_PINCTRL_PINS_NB;
> - config.ngpio_per_reg = 8;
> + switch (pinctrl->tps->chip_id) {
> + case TPS65224:
> + config.ngpio = ARRAY_SIZE(tps65224_gpio_func_group_names);
> + config.ngpio_per_reg = TPS65224_NGPIO_PER_REG;
> + break;
> + case TPS6594:
> + config.ngpio = ARRAY_SIZE(tps6594_gpio_func_group_names);
> + config.ngpio_per_reg = TPS6594_NGPIO_PER_REG;
> + break;
> + default:
> + break;
> + }
> config.reg_dat_base = TPS6594_REG_GPIO_IN_1;
> config.reg_set_base = TPS6594_REG_GPIO_OUT_1;
> config.reg_dir_out_base = TPS6594_REG_GPIOX_CONF(0);
> @@ -369,5 +573,6 @@ static struct platform_driver tps6594_pinctrl_driver = {
> module_platform_driver(tps6594_pinctrl_driver);
>
> MODULE_AUTHOR("Esteban Blanc <eblanc@xxxxxxxxxxxx>");
> +MODULE_AUTHOR("Nirmala Devi Mal Nadar <m.nirmaladevi@xxxxxxxx>");
> MODULE_DESCRIPTION("TPS6594 pinctrl and GPIO driver");
> MODULE_LICENSE("GPL");
> --
> 2.25.1
>