Skip to contentSkip to conversation

regulator: core: Use different devices for resource allocation and DT lookup

PATCH In review cy_huang 3 participants 9 messages Dec 6, 2022 – Dec 14, 2022

Subsystems (4)
lore
Share & tools
lore

cy_huang

author
#0 lore raw

PATCH v2 1/1 regulator: core: Use different devices for resource allocation and DT lookup

From: ChiYuan Huang <[email protected]>

Following by the below discussion, there's the potential UAF issue between regulator and mfd.
https://lore.kernel.org/all/[email protected]/

From the analysis of Yingliang

CPU A |CPU B
mt6370_probe() |
devm_mfd_add_devices() |

				|mt6370_regulator_probe()
				|  regulator_register()
				|    //allocate init_data and add it to devres
				|    regulator_of_get_init_data()
i2c_unregister_device()		|
  device_del()			|
    devres_release_all()	|
      // init_data is freed	|
      release_nodes()		|
				|  // using init_data causes UAF
				|  regulator_register()

It's common to use mfd core to create child device for the regulator. In order to do the DT lookup for init data, the child that registered the regulator would pass its parent as the parameter. And this causes init data resource allocated to its parent, not itself. The issue happen when parent device is going to release and regulator core is still doing some operation of init data constraint for the regulator of child device.

To fix it, this patch expand 'regulator_register' API to use the different devices for init data allocation and DT lookup.

---
loop Yang Yingliang in cc list.

Since v2
- Fix typo 'int3742' to 'int3472' for kernel build test

---
 drivers/platform/x86/intel/int3472/clk_and_regulator.c | 3 ++-
 drivers/regulator/core.c                               | 8 ++++----
 drivers/regulator/devres.c                             | 2 +-
 drivers/regulator/of_regulator.c                       | 2 +-
 drivers/regulator/stm32-vrefbuf.c                      | 2 +-
 include/linux/regulator/driver.h                       | 3 ++-
 6 files changed, 11 insertions(+), 9 deletions(-)
drivers/platform/x86/intel/int3472/clk_and_regulator.c +2 -1
index 1cf9589..b2342b3 100644
@@ -185,7 +185,8 @@ int skl_int3472_register_regulator(struct int3472_discrete_device *int3472,
 	cfg.init_data = &init_data;
 	cfg.ena_gpiod = int3472->regulator.gpio;
 
-	int3472->regulator.rdev = regulator_register(&int3472->regulator.rdesc,
+	int3472->regulator.rdev = regulator_register(int3472->dev,
+						     &int3472->regulator.rdesc,
 						     &cfg);
 	if (IS_ERR(int3472->regulator.rdev)) {
 		ret = PTR_ERR(int3472->regulator.rdev);
drivers/regulator/core.c +4 -4
index e8c00a8..ea4a720 100644
@@ -5396,6 +5396,7 @@ static struct regulator_coupler generic_regulator_coupler = {
 
 /**
  * regulator_register - register regulator
+ * @dev: the device that drive the regulator
  * @regulator_desc: regulator to register
  * @cfg: runtime configuration for regulator
  *
@@ -5404,7 +5405,8 @@ static struct regulator_coupler generic_regulator_coupler = {
  * or an ERR_PTR() on error.
  */
 struct regulator_dev *
-regulator_register(const struct regulator_desc *regulator_desc,
+regulator_register(struct device *dev,
+		   const struct regulator_desc *regulator_desc,
 		   const struct regulator_config *cfg)
 {
 	const struct regulator_init_data *init_data;
@@ -5413,7 +5415,6 @@ regulator_register(const struct regulator_desc *regulator_desc,
 	struct regulator_dev *rdev;
 	bool dangling_cfg_gpiod = false;
 	bool dangling_of_gpiod = false;
-	struct device *dev;
 	int ret, i;
 	bool resolved_early = false;
 
@@ -5426,8 +5427,7 @@ regulator_register(const struct regulator_desc *regulator_desc,
 		goto rinse;
 	}
 
-	dev = cfg->dev;
-	WARN_ON(!dev);
+	WARN_ON(!dev || !cfg->dev);
 
 	if (regulator_desc->name == NULL || regulator_desc->ops == NULL) {
 		ret = -EINVAL;
drivers/regulator/devres.c +1 -1
index 3265e75..5c7ff9b 100644
@@ -385,7 +385,7 @@ struct regulator_dev *devm_regulator_register(struct device *dev,
 	if (!ptr)
 		return ERR_PTR(-ENOMEM);
 
-	rdev = regulator_register(regulator_desc, config);
+	rdev = regulator_register(dev, regulator_desc, config);
 	if (!IS_ERR(rdev)) {
 		*ptr = rdev;
 		devres_add(dev, ptr);
drivers/regulator/of_regulator.c +1 -1
index 0aff1c2..cd726d4 100644
@@ -505,7 +505,7 @@ struct regulator_init_data *regulator_of_get_init_data(struct device *dev,
 	struct device_node *child;
 	struct regulator_init_data *init_data = NULL;
 
-	child = regulator_of_get_init_node(dev, desc);
+	child = regulator_of_get_init_node(config->dev, desc);
 	if (!child)
 		return NULL;
 
drivers/regulator/stm32-vrefbuf.c +1 -1
index 30ea3bc..7a454b7 100644
@@ -210,7 +210,7 @@ static int stm32_vrefbuf_probe(struct platform_device *pdev)
 						      pdev->dev.of_node,
 						      &stm32_vrefbuf_regu);
 
-	rdev = regulator_register(&stm32_vrefbuf_regu, &config);
+	rdev = regulator_register(&pdev->dev, &stm32_vrefbuf_regu, &config);
 	if (IS_ERR(rdev)) {
 		ret = PTR_ERR(rdev);
 		dev_err(&pdev->dev, "register failed with error %d\n", ret);
include/linux/regulator/driver.h +2 -1
index f9a7461..d3b4a3d 100644
@@ -687,7 +687,8 @@ static inline int regulator_err2notif(int err)
 
 
 struct regulator_dev *
-regulator_register(const struct regulator_desc *regulator_desc,
+regulator_register(struct device *dev,
+		   const struct regulator_desc *regulator_desc,
 		   const struct regulator_config *config);
 struct regulator_dev *
 devm_regulator_register(struct device *dev,
Signature · 1 line
2.7.4
maintainer
#1 lore raw
Quoted 21 lines · cy_huang

Following by the below discussion, there's the potential UAF issue between regulator and mfd.
https://lore.kernel.org/all/[email protected]/

From the analysis of Yingliang

CPU A |CPU B
mt6370_probe() |
devm_mfd_add_devices() |

				|mt6370_regulator_probe()
				|  regulator_register()
				|    //allocate init_data and add it to devres
				|    regulator_of_get_init_data()
i2c_unregister_device()		|
  device_del()			|
    devres_release_all()	|
      // init_data is freed	|
      release_nodes()		|
				|  // using init_data causes UAF
				|  regulator_register()
Quoted 1 line

[...]

Applied to

https://git.kernel.org/pub/scm/linux/kernel/git/broonie/regulator.git for-next

Thanks!

[1/1] regulator: core: Use different devices for resource allocation and DT lookup

      commit: 8f3cbcd6b440032ebc7f7d48a1689dcc70a4eb98

All being well this means that it will be integrated into the linux-next tree (usually sometime in the next 24 hours) and sent to Linus during the next merge window (or sooner if it is a bug fix), however if problems are discovered then the patch may be dropped or reverted.

You may get further e-mails resulting from automated or manual testing and review of the tree, please engage with people reporting problems and send followup patches addressing any issues that are reported if needed.

If any updates are required or you are submitting further changes they should be sent as incremental updates against current git, existing patches will not be replaced.

Please add any relevant lists and maintainers to the CCs when replying to this mail.

Thanks,
Mark

#2 lore raw
In reply to cy_huang

Dear All,

Quoted 30 lines · cy_huang

From: ChiYuan Huang <[email protected]>

Following by the below discussion, there's the potential UAF issue between regulator and mfd.
https://lore.kernel.org/all/[email protected]/

Quoted 1 line

From the analysis of Yingliang

CPU A |CPU B
mt6370_probe() |
devm_mfd_add_devices() |

				|mt6370_regulator_probe()
				|  regulator_register()
				|    //allocate init_data and add it to devres
				|    regulator_of_get_init_data()
i2c_unregister_device()		|
   device_del()			|
     devres_release_all()	|
       // init_data is freed	|
       release_nodes()		|
				|  // using init_data causes UAF
				|  regulator_register()

It's common to use mfd core to create child device for the regulator. In order to do the DT lookup for init data, the child that registered the regulator would pass its parent as the parameter. And this causes init data resource allocated to its parent, not itself. The issue happen when parent device is going to release and regulator core is still doing some operation of init data constraint for the regulator of child device.

Quoted 5 lines

To fix it, this patch expand 'regulator_register' API to use the different devices for init data allocation and DT lookup.

This patch landed in linux-next 202212 as commit 8f3cbcd6b440 ("regulator: core: Use different devices for resource allocation and DT lookup"). Unfortunately it causes serious regression on my test systems. It looks that some supplies are not resolved correctly and then turned off as 'unused', even if they provide power to other core regulators in the system. I've observed this issue on Samsung Chromebook Peach-Pit and Peach-Pi (ARM 32bit Exynos based). The symptoms are somehow similar to the issue reported here some time ago:

https://lore.kernel.org/all/[email protected]/

I've post more information once I analyze this issue further.

Quoted 15 lines

---
loop Yang Yingliang in cc list.

Since v2
- Fix typo 'int3742' to 'int3472' for kernel build test

---
  drivers/platform/x86/intel/int3472/clk_and_regulator.c | 3 ++-
  drivers/regulator/core.c                               | 8 ++++----
  drivers/regulator/devres.c                             | 2 +-
  drivers/regulator/of_regulator.c                       | 2 +-
  drivers/regulator/stm32-vrefbuf.c                      | 2 +-
  include/linux/regulator/driver.h                       | 3 ++-
  6 files changed, 11 insertions(+), 9 deletions(-)
Quoted 1 line

...

Best regards

Signature · 2 lines
Marek Szyprowski, PhD
Samsung R&D Institute Poland
#3 lore raw

HI,

Marek Szyprowski <[email protected]> 於 2022年12月13日 週二 晚上7:33寫道:

Quoted 50 lines

Dear All,

Quoted 30 lines · cy_huang

From: ChiYuan Huang <[email protected]>

Following by the below discussion, there's the potential UAF issue between regulator and mfd.
https://lore.kernel.org/all/[email protected]/

Quoted 1 line

From the analysis of Yingliang

CPU A |CPU B
mt6370_probe() |

   devm_mfd_add_devices()     |
                              |mt6370_regulator_probe()
                              |  regulator_register()
                              |    //allocate init_data and add it to devres
                              |    regulator_of_get_init_data()

i2c_unregister_device() |
device_del() |
devres_release_all() |
// init_data is freed |
release_nodes() |
| // using init_data causes UAF | regulator_register()

It's common to use mfd core to create child device for the regulator. In order to do the DT lookup for init data, the child that registered the regulator would pass its parent as the parameter. And this causes init data resource allocated to its parent, not itself. The issue happen when parent device is going to release and regulator core is still doing some operation of init data constraint for the regulator of child device.

Quoted 5 lines

To fix it, this patch expand 'regulator_register' API to use the different devices for init data allocation and DT lookup.

This patch landed in linux-next 202212 as commit 8f3cbcd6b440 ("regulator: core: Use different devices for resource allocation and DT lookup"). Unfortunately it causes serious regression on my test systems. It looks that some supplies are not resolved correctly and then turned off as 'unused', even if they provide power to other core regulators in the system. I've observed this issue on Samsung Chromebook Peach-Pit and Peach-Pi (ARM 32bit Exynos based). The symptoms are somehow similar to the issue reported here some time ago:

Quoted 4 lines

https://lore.kernel.org/all/[email protected]/

I've post more information once I analyze this issue further.

It seems the issue occurs in 'regulator register' resolve supply. Due to the parent device don't have the of_node, to resolve the supply, it may need to get the
dt node by recursively finding child regulator.
Like this
parent {

  regulators {
     xxx-supply = <&vdd12-ldo>;
     vdd12-ldo: vdd12-ldo {
         regulator-name = "xxx";
         regulator-min-microvolts = <xxxxx>;
         regulator-max-microvolts = <xxxxx>;
      }

};
};
From this case, 'resolve supply' need to parse at least the more top level like 'regulators'.
But now, it only take 'vdd12-ldo' as the node or its child to parse its supply.

Below's the fix I guess.
It'll make the parent of the regulator the same as the dev parameter in 'regulator_config'.

drivers/regulator/core.c +1 -1
index ea4a720..7c5036e 100644
@@ -5526,7 +5526,7 @@ regulator_register(struct device *dev,
 
        /* register with sysfs */
        rdev->dev.class = &regulator_class;
-       rdev->dev.parent = dev;
+       rdev->dev.parent = config->dev;
        dev_set_name(&rdev->dev, "regulator.%lu",
                    (unsigned long) atomic_inc_return(&regulator_no));
        dev_set_drvdata(&rdev->dev, rdev);

I don't have the board. Could you help to test this change to see whether it's been fixed or not?

Quoted 23 lines
Quoted 16 lines

---
loop Yang Yingliang in cc list.

Since v2
- Fix typo 'int3742' to 'int3472' for kernel build test

---
  drivers/platform/x86/intel/int3472/clk_and_regulator.c | 3 ++-
  drivers/regulator/core.c                               | 8 ++++----
  drivers/regulator/devres.c                             | 2 +-
  drivers/regulator/of_regulator.c                       | 2 +-
  drivers/regulator/stm32-vrefbuf.c                      | 2 +-
  include/linux/regulator/driver.h                       | 3 ++-
  6 files changed, 11 insertions(+), 9 deletions(-)
Quoted 1 line

...

Best regards
--
Marek Szyprowski, PhD
Samsung R&D Institute Poland

#4 lore raw

Hi,

Quoted 88 lines · ChiYuan Huang

Marek Szyprowski <[email protected]> 於 2022年12月13日 週二 晚上7:33寫道:

Quoted 46 lines · cy_huang
Quoted 30 lines

From: ChiYuan Huang <[email protected]>

Following by the below discussion, there's the potential UAF issue between regulator and mfd.
https://lore.kernel.org/all/[email protected]/

Quoted 1 line

From the analysis of Yingliang

CPU A |CPU B
mt6370_probe() |

    devm_mfd_add_devices()     |
                               |mt6370_regulator_probe()
                               |  regulator_register()
                               |    //allocate init_data and add it to devres
                               |    regulator_of_get_init_data()

i2c_unregister_device() |
device_del() |
devres_release_all() |
// init_data is freed |
release_nodes() |
| // using init_data causes UAF | regulator_register()

It's common to use mfd core to create child device for the regulator. In order to do the DT lookup for init data, the child that registered the regulator would pass its parent as the parameter. And this causes init data resource allocated to its parent, not itself. The issue happen when parent device is going to release and regulator core is still doing some operation of init data constraint for the regulator of child device.

Quoted 5 lines

To fix it, this patch expand 'regulator_register' API to use the different devices for init data allocation and DT lookup.

This patch landed in linux-next 202212 as commit 8f3cbcd6b440 ("regulator: core: Use different devices for resource allocation and DT lookup"). Unfortunately it causes serious regression on my test systems. It looks that some supplies are not resolved correctly and then turned off as 'unused', even if they provide power to other core regulators in the system. I've observed this issue on Samsung Chromebook Peach-Pit and Peach-Pi (ARM 32bit Exynos based). The symptoms are somehow similar to the issue reported here some time ago:

Quoted 4 lines

https://lore.kernel.org/all/[email protected]/

I've post more information once I analyze this issue further.

It seems the issue occurs in 'regulator register' resolve supply. Due to the parent device don't have the of_node, to resolve the supply, it may need to get the
dt node by recursively finding child regulator.
Like this

parent {
   regulators {
      xxx-supply = <&vdd12-ldo>;
      vdd12-ldo: vdd12-ldo {
          regulator-name = "xxx";
          regulator-min-microvolts = <xxxxx>;
          regulator-max-microvolts = <xxxxx>;
       }
   };
};
Quoted 1 line

From this case, 'resolve supply' need to parse at least the more top

level like 'regulators'.
But now, it only take 'vdd12-ldo' as the node or its child to parse its supply.

Below's the fix I guess.
It'll make the parent of the regulator the same as the dev parameter in 'regulator_config'.

drivers/regulator/core.c +1 -1
index ea4a720..7c5036e 100644
@@ -5526,7 +5526,7 @@ regulator_register(struct device *dev,
 
         /* register with sysfs */
         rdev->dev.class = &regulator_class;
-       rdev->dev.parent = dev;
+       rdev->dev.parent = config->dev;
         dev_set_name(&rdev->dev, "regulator.%lu",
                     (unsigned long) atomic_inc_return(&regulator_no));
         dev_set_drvdata(&rdev->dev, rdev);
Quoted 2 lines

I don't have the board. Could you help to test this change to see whether it's been fixed or not?

The above change fixes the issue. Thanks! Feel free to add following tags to the final patch:

Best regards

Signature · 2 lines
Marek Szyprowski, PhD
Samsung R&D Institute Poland
maintainer
#5 lore raw
Quoted 10 lines · Marek Szyprowski
Quoted 2 lines · ChiYuan Huang

I don't have the board. Could you help to test this change to see whether it's been fixed or not?

The above change fixes the issue. Thanks! Feel free to add following tags to the final patch:

Thanks for jumping on this so quickly! Marek, are these boards (or similar ones) generally available? They seem great at showing up issues so it'd be good if I could get them into my CI and spot problems earlier (or something like kernelci.org would be about as good)?

#6 lore raw
Quoted 4 lines · Mark Brown
Quoted 3 lines · Marek Szyprowski
Quoted 2 lines · ChiYuan Huang

I don't have the board. Could you help to test this change to see whether it's been fixed or not?

Quoted 8 lines
Quoted 4 lines

The above change fixes the issue. Thanks! Feel free to add following tags to the final patch:

Thanks for jumping on this so quickly! Marek, are these boards (or similar ones) generally available? They seem great at showing up issues so it'd be good if I could get them into my CI and spot problems earlier (or something like kernelci.org would be about as good)?

Well, they are quite old, but I've seen some used ones on eBay. Just look for "Samsung Chomebook XE503C12" (Peach-Pit) or XE503C32 (Peach-Pi, very rare).

Getting it integrated into the CI requires a bit of manual work. You have to solder UART lines to the test points on the motherboard. The board can be fully controlled via so called Embedded Controller, what in practice means that you can turn power on/off by sending commands to the dedicated EC UART. The kernel console UART uses 1.8V, while the EC UART
- 3.3V. Let me know if you need more details.

Peach-Pi was used on kernelci.org some time ago, but I have no idea what has happened to it.

Best regards

Signature · 2 lines
Marek Szyprowski, PhD
Samsung R&D Institute Poland
maintainer
#7 lore raw
Quoted 11 lines · Marek Szyprowski
Quoted 4 lines · Mark Brown

Thanks for jumping on this so quickly! Marek, are these boards (or similar ones) generally available? They seem great at showing up issues so it'd be good if I could get them into my CI and spot problems earlier (or something like kernelci.org would be about as good)?

Well, they are quite old, but I've seen some used ones on eBay. Just look for "Samsung Chomebook XE503C12" (Peach-Pit) or XE503C32 (Peach-Pi, very rare).

Quoted 6 lines

Getting it integrated into the CI requires a bit of manual work. You have to solder UART lines to the test points on the motherboard. The board can be fully controlled via so called Embedded Controller, what in practice means that you can turn power on/off by sending commands to the dedicated EC UART. The kernel console UART uses 1.8V, while the EC UART
- 3.3V. Let me know if you need more details.

Ah, oh dear - I'm afraid my soldering ability isn't up to that sort of modification.

Quoted 2 lines

Peach-Pi was used on kernelci.org some time ago, but I have no idea what has happened to it.

I suspect it might've fallen off the end of the ChromeOS support window and got pulled, I'll see if I can find out. Perhaps there's some modified boards kicking about that didn't get thrown out.

#8 lore raw
In reply to Marek Szyprowski

Marek Szyprowski <[email protected]> 於 2022年12月13日 週二 晚上10:29寫道:

Quoted 98 lines

Hi,

Quoted 88 lines · ChiYuan Huang

Marek Szyprowski <[email protected]> 於 2022年12月13日 週二 晚上7:33寫道:

Quoted 46 lines · cy_huang
Quoted 30 lines

From: ChiYuan Huang <[email protected]>

Following by the below discussion, there's the potential UAF issue between regulator and mfd.
https://lore.kernel.org/all/[email protected]/

Quoted 1 line

From the analysis of Yingliang

CPU A |CPU B
mt6370_probe() |

    devm_mfd_add_devices()     |
                               |mt6370_regulator_probe()
                               |  regulator_register()
                               |    //allocate init_data and add it to devres
                               |    regulator_of_get_init_data()

i2c_unregister_device() |
device_del() |
devres_release_all() |
// init_data is freed |
release_nodes() |
| // using init_data causes UAF | regulator_register()

It's common to use mfd core to create child device for the regulator. In order to do the DT lookup for init data, the child that registered the regulator would pass its parent as the parameter. And this causes init data resource allocated to its parent, not itself. The issue happen when parent device is going to release and regulator core is still doing some operation of init data constraint for the regulator of child device.

Quoted 5 lines

To fix it, this patch expand 'regulator_register' API to use the different devices for init data allocation and DT lookup.

This patch landed in linux-next 202212 as commit 8f3cbcd6b440 ("regulator: core: Use different devices for resource allocation and DT lookup"). Unfortunately it causes serious regression on my test systems. It looks that some supplies are not resolved correctly and then turned off as 'unused', even if they provide power to other core regulators in the system. I've observed this issue on Samsung Chromebook Peach-Pit and Peach-Pi (ARM 32bit Exynos based). The symptoms are somehow similar to the issue reported here some time ago:

Quoted 4 lines

https://lore.kernel.org/all/[email protected]/

I've post more information once I analyze this issue further.

It seems the issue occurs in 'regulator register' resolve supply. Due to the parent device don't have the of_node, to resolve the supply, it may need to get the
dt node by recursively finding child regulator.
Like this

parent {
   regulators {
      xxx-supply = <&vdd12-ldo>;
      vdd12-ldo: vdd12-ldo {
          regulator-name = "xxx";
          regulator-min-microvolts = <xxxxx>;
          regulator-max-microvolts = <xxxxx>;
       }
   };
};
Quoted 1 line

From this case, 'resolve supply' need to parse at least the more top

level like 'regulators'.
But now, it only take 'vdd12-ldo' as the node or its child to parse its supply.

Below's the fix I guess.
It'll make the parent of the regulator the same as the dev parameter in 'regulator_config'.

drivers/regulator/core.c +1 -1
index ea4a720..7c5036e 100644
@@ -5526,7 +5526,7 @@ regulator_register(struct device *dev,
 
         /* register with sysfs */
         rdev->dev.class = &regulator_class;
-       rdev->dev.parent = dev;
+       rdev->dev.parent = config->dev;
         dev_set_name(&rdev->dev, "regulator.%lu",
                     (unsigned long) atomic_inc_return(&regulator_no));
         dev_set_drvdata(&rdev->dev, rdev);
Quoted 2 lines

I don't have the board. Could you help to test this change to see whether it's been fixed or not?

The above change fixes the issue. Thanks! Feel free to add following tags to the final patch:

Quoted 4 lines

Thanks.
I'll submit the change to fix it.

Quoted 6 lines

Best regards
--
Marek Szyprowski, PhD
Samsung R&D Institute Poland

_______________________________________________
linux-arm-kernel mailing list
[email protected]
http://lists.infradead.org/mailman/listinfo/linux-arm-kernel