regulator: bd71837: Devicetree bindings for BD71837 regulators
PATCH 4/9 regulator: bd71837: Devicetree bindings for BD71837 regulators
Document devicetree bindings for ROHM BD71837 PMIC regulators.
--- .../bindings/regulator/rohm,bd71837-regulator.txt | 124 +++++++++++++++++++++ 1 file changed, 124 insertions(+) create mode 100644 Documentation/devicetree/bindings/regulator/rohm,bd71837-regulator.txt
Documentation/devicetree/bindings/regulator/rohm,bd71837-regulator.txt new file +124 -0
@@ -0,0 +1,124 @@ +ROHM BD71837 Power Management Integrated Circuit (PMIC) regulator bindings + +BD71837MWV is a programmable Power Management +IC (PMIC) for powering single-core, dual-core, and +quad-core SoC’s such as NXP-i.MX 8M. It is optimized +for low BOM cost and compact solution footprint. It +integrates 8 Buck regulators and 7 LDO’s to provide all +the power rails required by the SoC and the commonly +used peripherals. + +Required properties: + - compatible: should be "rohm,bd71837-pmic". + - regulator-name: should be "buck1", ..., "buck8" and "ldo1", ..., "ldo7" + +List of regulators provided by this controller. BD71837 regulators node +should be sub node of the BD71837 MFD node. See BD71837 MFD bindings at +Documentation/devicetree/bindings/mfd/rohm,bd71837-pmic.txt +Regulator nodes should be named to BUCK_<number> and LDO_<number>. The +definition for each of these nodes is defined using the standard +binding for regulators at +Documentation/devicetree/bindings/regulator/regulator.txt. + +The valid names for regulators are: +BUCK1, BUCK2, BUCK3, BUCK4, BUCK5, BUCK6, BUCK7, BUCK8 +LDO1, LDO2, LDO3, LDO4, LDO5, LDO6, LDO7 + +Optional properties: +- Any optional property defined in bindings/regulator/regulator.txt + +Example: +regulators { + compatible = "rohm,bd71837-pmic"; + #address-cells = <1>; + #size-cells = <0>; + buck1: BUCK1 { + pmic-supply = <&vmmcsd_fixed>; + regulator-name = "buck1"; + regulator-min-microvolt = <700000>; + regulator-max-microvolt = <1300000>; + regulator-boot-on; + regulator-ramp-delay = <1250>; + }; + buck2: BUCK2 { + regulator-name = "buck2"; + regulator-min-microvolt = <700000>; + regulator-max-microvolt = <1300000>; + regulator-boot-on; + regulator-always-on; + regulator-ramp-delay = <1250>; + }; + buck3: BUCK3 { + regulator-name = "buck3"; + regulator-min-microvolt = <700000>; + regulator-max-microvolt = <1300000>; + regulator-boot-on; + }; + buck4: BUCK4 { + regulator-name = "buck4"; + regulator-min-microvolt = <700000>; + regulator-max-microvolt = <1300000>; + regulator-boot-on; + }; + buck5: BUCK5 { + regulator-name = "buck5"; + regulator-min-microvolt = <700000>; + regulator-max-microvolt = <1350000>; + regulator-boot-on; + }; + buck6: BUCK6 { + regulator-name = "buck6"; + regulator-min-microvolt = <3000000>; + regulator-max-microvolt = <3300000>; + }; + buck7: BUCK7 { + regulator-name = "buck7"; + regulator-min-microvolt = <1605000>; + regulator-max-microvolt = <1995000>; + }; + buck8: BUCK8 { + regulator-name = "buck8"; + regulator-min-microvolt = <800000>; + regulator-max-microvolt = <1400000>; + }; + + ldo1: LDO1 { + regulator-name = "ldo1"; + regulator-min-microvolt = <3000000>; + regulator-max-microvolt = <3300000>; + regulator-boot-on; + }; + ldo2: LDO2 { + regulator-name = "ldo2"; + regulator-min-microvolt = <900000>; + regulator-max-microvolt = <900000>; + regulator-boot-on; + }; + ldo3: LDO3 { + regulator-name = "ldo3"; + regulator-min-microvolt = <1800000>; + regulator-max-microvolt = <3300000>; + }; + ldo4: LDO4 { + regulator-name = "ldo4"; + regulator-min-microvolt = <900000>; + regulator-max-microvolt = <1800000>; + }; + ldo5: LDO5 { + regulator-name = "ldo5"; + regulator-min-microvolt = <1800000>; + regulator-max-microvolt = <3300000>; + }; + ldo6: LDO6 { + regulator-name = "ldo6"; + regulator-min-microvolt = <900000>; + regulator-max-microvolt = <1800000>; + }; + ldo7_reg: LDO7 { + regulator-name = "ldo7"; + regulator-min-microvolt = <1800000>; + regulator-max-microvolt = <3300000>; + }; +}; + +
Signature · 1 line
2.14.3
Mark Brown
maintainerQuoted 3 lines · Matti Vaittinen
+Required properties:
+ - compatible: should be "rohm,bd71837-pmic".
+ - regulator-name: should be "buck1", ..., "buck8" and "ldo1", ..., "ldo7"
The MFD is for a single device, there should be no need for compatibles on subfunctions.
Hello Mark,=0A=
=0A=
First of all, thank you for taking your time to check the patches. I do=0A= appreciate it. I find reading patches hard myself.=0A=
=0A=
Quoted 8 lines
From: Mark Brown [[email protected]]=0A=
Sent: Thursday, May 24, 2018 5:01 PM=0A=
=0A=Quoted 1 line
On Thu, May 24, 2018 at 08:57:52AM +0300, Matti Vaittinen wrote:=0A=
=0A=
Quoted 3 lines
+Required properties:=0A=
+ - compatible: should be "rohm,bd71837-pmic".=0A=
+ - regulator-name: should be "buck1", ..., "buck8" and "ldo1", ..., "l=
do7"=0A=
Quoted 2 lines
=0A=
The MFD is for a single device, there should be no need for compatibles=
=0A=
Quoted 1 line
on subfunctions.=0A=
=0A=
I will check this. I must admit I am not sure what is the de-facto mechanis= m=0A=
for assigning the correct device-tree nodes to sub devices if compatibles= =0A=
are not used? I think I saw device-tree node name being used for regulators= =0A=
but how is it done for example with clk? I would be grateful if anyone coul= d=0A=
point me to right direction with this.=0A=
=0A=
Also, another thing I was wondering is how supply regulators should be=0A= handled? In this case the LDO5 is supplied by BUCK6 and LDO6 by=0A= BUCK7. =0A=
=0A=
Quoted 1 line
From generic regulator bindings=0A=
/Documentation/devicetree/bindings/regulator/regulator.txt=0A= I found statement:=0A=
=0A=
Quoted 1 line
- <name>-supply: phandle to the parent supply/regulator node=0A=
=0A=
and=0A=
=0A=
Quoted 10 lines
Regulator Consumers:=0A=
Consumer nodes can reference one or more of its supplies/=0A= regulators using the below bindings.=0A=
=0A=
- <name>-supply: phandle to the regulator node=0A= =0A=
These are the same bindings that a regulator in the above=0A= example used to reference its own supply, in which case=0A= ts just seen as a special case of a regulator being a=0A= consumer itself.=0A=
=0A=
but I did not find handling for the supply properties from regulator core.= =0A=
Thus I ended up hard coding the supply relation in driver. This means=0A= that buck6 name must be fixed.=0A=
=0A=
Br,=0A=
Matti Vaittinen=
Mark Brown
maintainerQuoted 6 lines · Matti
Quoted 6 lines
Quoted 5 lines · Matti Vaittinen
+Required properties:
+ - compatible: should be "rohm,bd71837-pmic".
+ - regulator-name: should be "buck1", ..., "buck8" and "ldo1", ..., "ldo7"
Quoted 6 lines
Quoted 2 lines
The MFD is for a single device, there should be no need for compatibles on subfunctions.
I will check this. I must admit I am not sure what is the de-facto mechanism for assigning the correct device-tree nodes to sub devices if compatibles are not used? I think I saw device-tree node name being used for regulators
You can look at the regulators node within the parent device, you know that in Linux the parent device will be the MFD. Having a compatible string within the device makes no difference here. There's quite a few in tree examples of this.
Quoted 9 lines
Also, another thing I was wondering is how supply regulators should be handled? In this case the LDO5 is supplied by BUCK6 and LDO6 by BUCK7.
From generic regulator bindings /Documentation/devicetree/bindings/regulator/regulator.txt I found statement:
Quoted 1 line
- <name>-supply: phandle to the parent supply/regulator node
None of that stuff uses compatible strings, just handle it as covered in the bindings.
Quoted 10 lines · Mark Brown
Quoted 9 lines · Matti
Quoted 8 lines
Quoted 5 lines · Matti Vaittinen
+Required properties:
+ - compatible: should be "rohm,bd71837-pmic".
+ - regulator-name: should be "buck1", ..., "buck8" and "ldo1", ..., "ldo7"The MFD is for a single device, there should be no need for compatibles on subfunctions.
Quoted 6 lines
Quoted 3 lines
I will check this. I must admit I am not sure what is the de-facto mechanism for assigning the correct device-tree nodes to sub devices if compatibles are not used? I think I saw device-tree node name being used for regulators
You can look at the regulators node within the parent device, you know that in Linux the parent device will be the MFD.
So I should parse the device-tree in MFD my driver in order to locate the regulators node? Isn't that somewhat like code dublication? If we rely on compatibles we can avoid device-tree parsing in MFD driver, right? An in-tree example of this is:
Documentation/devicetree/bindings/regulator/sprd,sc2731-regulator.txt
Quoted 2 lines
Required properties:
- compatible: should be "sprd,sc27xx-regulator".
//snip
Quoted 7 lines
Example:
regulators { compatible = "sprd,sc27xx-regulator"; vddarm0: BUCK_CPU0 { regulator-name = "vddarm0"; regulator-min-microvolt = <400000>;
drivers/mfd/sprd-sc27xx-spi.c
Quoted 1 line
static const struct
mfd_cellsprd_pmic_devs[] = {
//snip
Quoted 4 lines
}, {
.name = "sc27xx-regulator",
.of_compatible = "sprd,sc27xx-regulator",
}, {//snip
Quoted 1 line
};
and in probe just:
Quoted 4 lines
ret = devm_mfd_add_devices(&spi->dev, PLATFORM_DEVID_AUTO,
sprd_pmic_devs, ARRAY_SIZE(sprd_pmic_devs),
NULL, 0,
regmap_irq_get_domain(ddata->irq_data));this looks clean to me and offloads the device-tree parsing completely to generic code. Wouldn't that be simpler approach that looking up the regulator node in MFD driver code? (I can do as you suggested but to me the approach used in sprd-sc27xx-spi.c makes sense)
Quoted 4 lines
Quoted 3 lines
Also, another thing I was wondering is how supply regulators should be handled? In this case the LDO5 is supplied by BUCK6 and LDO6 by BUCK7.
Quoted 8 lines
Quoted 5 lines
From generic regulator bindings /Documentation/devicetree/bindings/regulator/regulator.txt I found statement:
Quoted 1 line
- <name>-supply: phandle to the parent supply/regulator node
None of that stuff uses compatible strings, just handle it as covered in the bindings.
Sorry. I have not been clear with my question. This part was unrelated to compatible properties - I should have stated it in my previous mail.
What I meant is that I tried out adding
xxx-supply = <&buck6>;
in LDO5 device tree node and expected that the regulator core code would take care of parsing this from device-tree and adding the supply information to LDO5. This was not done and I did not fing parsing for *-supply from drivers/regulator/of_regulator.c. So I was wondering if I am missing something? I guess the *-supply properties in device-tree for BD71837 regulators are now ignored. Should the supply parsing be added in drivers/regulator/of_regulator.c - or have I simply misunderstood something?
Anyways, I ended up hard coding:
.supply_name = "buck6"
in LDO5 regulator_desc before passing the desc to regulator_register(). This works but it means the buck6 name must be fixed to "buck6".
Br,
Matti Vaittinen
Mark Brown
maintainerQuoted 8 lines · Matti Vaittinen
Quoted 2 lines · Mark Brown
You can look at the regulators node within the parent device, you know that in Linux the parent device will be the MFD.
So I should parse the device-tree in MFD my driver in order to locate the regulators node? Isn't that somewhat like code dublication? If we rely on compatibles we can avoid device-tree parsing in MFD driver,
No, there's no need to do this - the child can just look at the of_node of the parent since it can never be instantiated otherwise.
Quoted 1 line
right? An in-tree example of this is:
There are some bad examples (and some where the same regulators can get used with multiple different parents) but that's no reason not to follow good practice.
Quoted 10 lines · Mark Brown
Quoted 8 lines · Matti Vaittinen
Quoted 2 lines · Mark Brown
You can look at the regulators node within the parent device, you know that in Linux the parent device will be the MFD.
So I should parse the device-tree in MFD my driver in order to locate the regulators node? Isn't that somewhat like code dublication? If we rely on compatibles we can avoid device-tree parsing in MFD driver,
Quoted 8 lines
No, there's no need to do this - the child can just look at the
of_nodeof the parent since it can never be instantiated otherwise.Quoted 1 line
right? An in-tree example of this is:
There are some bad examples (and some where the same regulators can get used with multiple different parents) but that's no reason not to follow good practice.
Fair enough. I guess you may still know regulator subsystem better than I do with my one month of experience ;) I'll follow your suggestion and cook-up new patches.
Br,
Matti Vaittinen