| Message ID | 20220215211548.31940-1-macroalpha82@gmail.com (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
| Series | [v3] dt-bindings: mfd: rk808: Convert bindings to yaml | expand |
On 2022-02-15 21:15, Chris Morgan wrote: [...] > diff --git a/Documentation/devicetree/bindings/mfd/rockchip,rk805.yaml b/Documentation/devicetree/bindings/mfd/rockchip,rk805.yaml > new file mode 100644 > index 000000000000..1b928b94fbfd > --- /dev/null > +++ b/Documentation/devicetree/bindings/mfd/rockchip,rk805.yaml > @@ -0,0 +1,88 @@ > +# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause > +%YAML 1.2 > +--- > +$id: http://devicetree.org/schemas/mfd/rockchip,rk805.yaml# > +$schema: http://devicetree.org/meta-schemas/core.yaml# > + > +title: RK805 Power Management Integrated Circuit > + > +maintainers: > + - Chris Zhong <zyw@rock-chips.com> > + - Zhang Qing <zhangqing@rock-chips.com> > + > +description: | > + Rockchip RK805 series PMIC. This device consists of an i2c controlled MFD > + that includes multiple switchable regulators. > + > +properties: > + compatible: > + enum: > + - rockchip,rk805 > + > + reg: > + maxItems: 1 > + > + interrupts: > + maxItems: 1 > + > + '#clock-cells': > + const: 1 > + > + clock-output-names: > + maxItems: 2 I think this should be 1, since RK805 only has a single CLK32K output - ditto for RK817. [...] > diff --git a/Documentation/devicetree/bindings/mfd/rockchip,rk808.yaml b/Documentation/devicetree/bindings/mfd/rockchip,rk808.yaml > new file mode 100644 > index 000000000000..f5908fa01a61 > --- /dev/null > +++ b/Documentation/devicetree/bindings/mfd/rockchip,rk808.yaml > @@ -0,0 +1,257 @@ > +# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause > +%YAML 1.2 > +--- > +$id: http://devicetree.org/schemas/mfd/rockchip,rk808.yaml# > +$schema: http://devicetree.org/meta-schemas/core.yaml# > + > +title: RK808 Power Management Integrated Circuit > + > +maintainers: > + - Chris Zhong <zyw@rock-chips.com> > + - Zhang Qing <zhangqing@rock-chips.com> > + > +description: | > + Rockchip RK808 series PMIC. This device consists of an i2c controlled MFD > + that includes regulators, an RTC, and a power button. > + > +properties: > + compatible: > + enum: > + - rockchip,rk808 > + > + reg: > + maxItems: 1 > + > + interrupts: > + maxItems: 1 > + > + '#clock-cells': > + description: > + See <dt-bindings/clock/rockchip,rk808.h> for clock IDs. > + const: 1 > + > + clock-output-names: > + description: > + From common clock binding to override the default output clock name. minItems should be consistent across RK808/818/819 - when two clocks exist, either it's legitimate to rename only the first one, or it isn't. There shouldn't be an arbitrary difference just because of what existing DTs happen to use. > + maxItems: 2 > + > + rockchip,system-power-controller: > + type: boolean > + description: > + Telling whether or not this PMIC is controlling the system power. > + > + wakeup-source: > + type: boolean > + description: > + Device can be used as a wakeup source. > + > + vcc1-supply: > + description: > + The input supply for DCDC_REG1. > + > + vcc2-supply: > + description: > + The input supply for DCDC_REG2. > + > + vcc3-supply: > + description: > + The input supply for DCDC_REG3. > + > + vcc4-supply: > + description: > + The input supply for DCDC_REG4. > + > + vcc6-supply: > + description: > + The input supply for LDO_REG1 and LDO_REG2. > + > + vcc7-supply: > + description: > + The input supply for LDO_REG3 and LDO_REG7. > + > + vcc8-supply: > + description: > + The input supply for SWITCH_REG1. > + > + vcc9-supply: > + description: > + The input supply for LDO_REG4 and LDO_REG5. > + > + vcc10-supply: > + description: > + The input supply for LDO_REG6. > + > + vcc11-supply: > + description: > + The input supply for LDO_REG8. > + > + vcc12-supply: > + description: > + The input supply for SWITCH_REG2. > + > + vddio-supply: > + description: > + The input supply for digital IO. > + > + dvs-gpios: > + description: | > + buck1/2 can be controlled by gpio dvs, this is GPIO specifiers for > + 2 host gpio's used for dvs. The format of the gpio specifier > + depends in the gpio controller. If DVS GPIOs aren't present, > + voltage changes will happen very quickly with no slow ramp time. > + maxItems: 2 > + > + regulators: > + type: object > + patternProperties: > + "^(DCDC_REG[1-4]|LDO_REG[1-8]|SWITCH_REG[1-2])$": > + type: object > + $ref: ../regulator/regulator.yaml# > + unevaluatedProperties: false > + > +required: > + - compatible > + - reg > + - interrupts > + - "#clock-cells" Is this actually required (ditto elsewhere)? Technically it's only necessary if there are any clock consumers targeting this node, so arguably it should be the clock binding's responsibility to validate that. It wouldn't make much sense for a dedicated clock controller to omit #clock-cells such that it couldn't have any consumers, but given that these things are primarily PMICs I think it's reasonable to allow a board not to care about the clocks at all if it doesn't use them. I know that the original binding claimed it was required, but if we're already relaxing that for RK805 here then we may as well relax it entirely. Cheers, Robin.
On Wed, Feb 16, 2022 at 12:39:09PM +0000, Robin Murphy wrote: > On 2022-02-15 21:15, Chris Morgan wrote: > [...] > > diff --git a/Documentation/devicetree/bindings/mfd/rockchip,rk805.yaml b/Documentation/devicetree/bindings/mfd/rockchip,rk805.yaml > > new file mode 100644 > > index 000000000000..1b928b94fbfd > > --- /dev/null > > +++ b/Documentation/devicetree/bindings/mfd/rockchip,rk805.yaml > > @@ -0,0 +1,88 @@ > > +# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause > > +%YAML 1.2 > > +--- > > +$id: https://na01.safelinks.protection.outlook.com/?url=http%3A%2F%2Fdevicetree.org%2Fschemas%2Fmfd%2Frockchip%2Crk805.yaml%23&data=04%7C01%7C%7C4b9a90979e484e90998208d9f149582b%7C84df9e7fe9f640afb435aaaaaaaaaaaa%7C1%7C0%7C637806119583069800%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000&sdata=C32SCbOML%2B29SpV3XPn6dfHnncMQpQtlNjeJmr46%2Ft0%3D&reserved=0 > > +$schema: https://na01.safelinks.protection.outlook.com/?url=http%3A%2F%2Fdevicetree.org%2Fmeta-schemas%2Fcore.yaml%23&data=04%7C01%7C%7C4b9a90979e484e90998208d9f149582b%7C84df9e7fe9f640afb435aaaaaaaaaaaa%7C1%7C0%7C637806119583069800%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000&sdata=Z6bCBf7CzFrLyMwJY2FyGQn4LKP7X0U5qcVAJlIi0Ms%3D&reserved=0 > > + > > +title: RK805 Power Management Integrated Circuit > > + > > +maintainers: > > + - Chris Zhong <zyw@rock-chips.com> > > + - Zhang Qing <zhangqing@rock-chips.com> > > + > > +description: | > > + Rockchip RK805 series PMIC. This device consists of an i2c controlled MFD > > + that includes multiple switchable regulators. > > + > > +properties: > > + compatible: > > + enum: > > + - rockchip,rk805 > > + > > + reg: > > + maxItems: 1 > > + > > + interrupts: > > + maxItems: 1 > > + > > + '#clock-cells': > > + const: 1 > > + > > + clock-output-names: > > + maxItems: 2 > > I think this should be 1, since RK805 only has a single CLK32K output - > ditto for RK817. This might be another case where the devicetree is wrong, but setting this gives me an error for the rk817 yaml now (because some boards are specifying 2 clocks when the hardware physically supports only a single clock). According to the datasheets the rk809 (in addition to the rk817 and rk805) only support a single clock-out. The driver "supports" 2 clocks for the rk805 in that it always sets the recalc_rate for the first clock as 32768 while allowing you to "enable" the 2nd clock, but it's all the same clock. The driver for the rk809 and rk817 only allow you to control a single clock. Do you think I should set the max value for 1 for each of these 3 PMICs and then we address the devicetree errors because that reflects the real-world hardware? > > [...] > > diff --git a/Documentation/devicetree/bindings/mfd/rockchip,rk808.yaml b/Documentation/devicetree/bindings/mfd/rockchip,rk808.yaml > > new file mode 100644 > > index 000000000000..f5908fa01a61 > > --- /dev/null > > +++ b/Documentation/devicetree/bindings/mfd/rockchip,rk808.yaml > > @@ -0,0 +1,257 @@ > > +# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause > > +%YAML 1.2 > > +--- > > +$id: https://na01.safelinks.protection.outlook.com/?url=http%3A%2F%2Fdevicetree.org%2Fschemas%2Fmfd%2Frockchip%2Crk808.yaml%23&data=04%7C01%7C%7C4b9a90979e484e90998208d9f149582b%7C84df9e7fe9f640afb435aaaaaaaaaaaa%7C1%7C0%7C637806119583069800%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000&sdata=JFsfLXHDw0y7KI4eAqx8wiOZGeq16Bq1LefNRhkidRo%3D&reserved=0 > > +$schema: https://na01.safelinks.protection.outlook.com/?url=http%3A%2F%2Fdevicetree.org%2Fmeta-schemas%2Fcore.yaml%23&data=04%7C01%7C%7C4b9a90979e484e90998208d9f149582b%7C84df9e7fe9f640afb435aaaaaaaaaaaa%7C1%7C0%7C637806119583069800%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000&sdata=Z6bCBf7CzFrLyMwJY2FyGQn4LKP7X0U5qcVAJlIi0Ms%3D&reserved=0 > > + > > +title: RK808 Power Management Integrated Circuit > > + > > +maintainers: > > + - Chris Zhong <zyw@rock-chips.com> > > + - Zhang Qing <zhangqing@rock-chips.com> > > + > > +description: | > > + Rockchip RK808 series PMIC. This device consists of an i2c controlled MFD > > + that includes regulators, an RTC, and a power button. > > + > > +properties: > > + compatible: > > + enum: > > + - rockchip,rk808 > > + > > + reg: > > + maxItems: 1 > > + > > + interrupts: > > + maxItems: 1 > > + > > + '#clock-cells': > > + description: > > + See <dt-bindings/clock/rockchip,rk808.h> for clock IDs. > > + const: 1 > > + > > + clock-output-names: > > + description: > > + From common clock binding to override the default output clock name. > > minItems should be consistent across RK808/818/819 - when two clocks exist, > either it's legitimate to rename only the first one, or it isn't. There > shouldn't be an arbitrary difference just because of what existing DTs > happen to use. See above. Basically it looks like the rk805, rk809, and rk817 all support just a single clock. The rk808 and rk818 support a max of 2 clocks. The driver for the rk805 supports 2 clocks, but it's all one physical clock on the PMIC. > > > + maxItems: 2 > > + > > + rockchip,system-power-controller: > > + type: boolean > > + description: > > + Telling whether or not this PMIC is controlling the system power. > > + > > + wakeup-source: > > + type: boolean > > + description: > > + Device can be used as a wakeup source. > > + > > + vcc1-supply: > > + description: > > + The input supply for DCDC_REG1. > > + > > + vcc2-supply: > > + description: > > + The input supply for DCDC_REG2. > > + > > + vcc3-supply: > > + description: > > + The input supply for DCDC_REG3. > > + > > + vcc4-supply: > > + description: > > + The input supply for DCDC_REG4. > > + > > + vcc6-supply: > > + description: > > + The input supply for LDO_REG1 and LDO_REG2. > > + > > + vcc7-supply: > > + description: > > + The input supply for LDO_REG3 and LDO_REG7. > > + > > + vcc8-supply: > > + description: > > + The input supply for SWITCH_REG1. > > + > > + vcc9-supply: > > + description: > > + The input supply for LDO_REG4 and LDO_REG5. > > + > > + vcc10-supply: > > + description: > > + The input supply for LDO_REG6. > > + > > + vcc11-supply: > > + description: > > + The input supply for LDO_REG8. > > + > > + vcc12-supply: > > + description: > > + The input supply for SWITCH_REG2. > > + > > + vddio-supply: > > + description: > > + The input supply for digital IO. > > + > > + dvs-gpios: > > + description: | > > + buck1/2 can be controlled by gpio dvs, this is GPIO specifiers for > > + 2 host gpio's used for dvs. The format of the gpio specifier > > + depends in the gpio controller. If DVS GPIOs aren't present, > > + voltage changes will happen very quickly with no slow ramp time. > > + maxItems: 2 > > + > > + regulators: > > + type: object > > + patternProperties: > > + "^(DCDC_REG[1-4]|LDO_REG[1-8]|SWITCH_REG[1-2])$": > > + type: object > > + $ref: ../regulator/regulator.yaml# > > + unevaluatedProperties: false > > + > > +required: > > + - compatible > > + - reg > > + - interrupts > > + - "#clock-cells" > > Is this actually required (ditto elsewhere)? Technically it's only necessary > if there are any clock consumers targeting this node, so arguably it should > be the clock binding's responsibility to validate that. > > It wouldn't make much sense for a dedicated clock controller to omit > #clock-cells such that it couldn't have any consumers, but given that these > things are primarily PMICs I think it's reasonable to allow a board not to > care about the clocks at all if it doesn't use them. I know that the > original binding claimed it was required, but if we're already relaxing that > for RK805 here then we may as well relax it entirely. I can remove this across the board (clock-cells) and resubmit. Let me know about the other question with the names if you can and I'll fix it all in v4. Thank you for your feedback, it was most helpful. > > Cheers, > Robin.
On Wed, Feb 16, 2022 at 12:39:09PM +0000, Robin Murphy wrote: > On 2022-02-15 21:15, Chris Morgan wrote: > [...] > > diff --git a/Documentation/devicetree/bindings/mfd/rockchip,rk805.yaml b/Documentation/devicetree/bindings/mfd/rockchip,rk805.yaml > > new file mode 100644 > > index 000000000000..1b928b94fbfd > > --- /dev/null > > +++ b/Documentation/devicetree/bindings/mfd/rockchip,rk805.yaml > > @@ -0,0 +1,88 @@ > > +# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause > > +%YAML 1.2 > > +--- > > +$id: http://devicetree.org/schemas/mfd/rockchip,rk805.yaml# > > +$schema: http://devicetree.org/meta-schemas/core.yaml# > > + > > +title: RK805 Power Management Integrated Circuit > > + > > +maintainers: > > + - Chris Zhong <zyw@rock-chips.com> > > + - Zhang Qing <zhangqing@rock-chips.com> > > + > > +description: | > > + Rockchip RK805 series PMIC. This device consists of an i2c controlled MFD > > + that includes multiple switchable regulators. > > + > > +properties: > > + compatible: > > + enum: > > + - rockchip,rk805 > > + > > + reg: > > + maxItems: 1 > > + > > + interrupts: > > + maxItems: 1 > > + > > + '#clock-cells': > > + const: 1 > > + > > + clock-output-names: > > + maxItems: 2 > > I think this should be 1, since RK805 only has a single CLK32K output - > ditto for RK817. I've confirmed that some boards use this behavior because of how the driver is written. Basically they define 2 clocks to ensure the 2nd clock gets renamed something else, as the first clock doesn't exist (but the driver won't let them rename a clock without defining the first clock). Should I push this patch series forward knowing that issue exists and then work to update the clock driver, or is that a showstopper? I'm honestly just trying to get these yaml updates done because I want to submit a battery driver and I was told they wanted the rk808.txt rewritten. I can add examples to each of the other yaml files as well from the devicetrees as they exist today (I'll just randomly pick one for each device for which we don't already have an example). So for now it looks like 2 issues remain though: 1) there are 4 boards that specify a supply regulator that doesn't exist (rk809 doesn't have vcc13 and vcc14). 2) there are 3 PMICs that use 2 clocks to overcome a driver issue, even though they only support 1 clock (rk805, rk809, and rk817 only have one clock output). > > [...] > > diff --git a/Documentation/devicetree/bindings/mfd/rockchip,rk808.yaml b/Documentation/devicetree/bindings/mfd/rockchip,rk808.yaml > > new file mode 100644 > > index 000000000000..f5908fa01a61 > > --- /dev/null > > +++ b/Documentation/devicetree/bindings/mfd/rockchip,rk808.yaml > > @@ -0,0 +1,257 @@ > > +# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause > > +%YAML 1.2 > > +--- > > +$id: http://devicetree.org/schemas/mfd/rockchip,rk808.yaml# > > +$schema: http://devicetree.org/meta-schemas/core.yaml# > > + > > +title: RK808 Power Management Integrated Circuit > > + > > +maintainers: > > + - Chris Zhong <zyw@rock-chips.com> > > + - Zhang Qing <zhangqing@rock-chips.com> > > + > > +description: | > > + Rockchip RK808 series PMIC. This device consists of an i2c controlled MFD > > + that includes regulators, an RTC, and a power button. > > + > > +properties: > > + compatible: > > + enum: > > + - rockchip,rk808 > > + > > + reg: > > + maxItems: 1 > > + > > + interrupts: > > + maxItems: 1 > > + > > + '#clock-cells': > > + description: > > + See <dt-bindings/clock/rockchip,rk808.h> for clock IDs. > > + const: 1 > > + > > + clock-output-names: > > + description: > > + From common clock binding to override the default output clock name. > > minItems should be consistent across RK808/818/819 - when two clocks exist, > either it's legitimate to rename only the first one, or it isn't. There > shouldn't be an arbitrary difference just because of what existing DTs > happen to use. > > > + maxItems: 2 > > + > > + rockchip,system-power-controller: > > + type: boolean > > + description: > > + Telling whether or not this PMIC is controlling the system power. > > + > > + wakeup-source: > > + type: boolean > > + description: > > + Device can be used as a wakeup source. > > + > > + vcc1-supply: > > + description: > > + The input supply for DCDC_REG1. > > + > > + vcc2-supply: > > + description: > > + The input supply for DCDC_REG2. > > + > > + vcc3-supply: > > + description: > > + The input supply for DCDC_REG3. > > + > > + vcc4-supply: > > + description: > > + The input supply for DCDC_REG4. > > + > > + vcc6-supply: > > + description: > > + The input supply for LDO_REG1 and LDO_REG2. > > + > > + vcc7-supply: > > + description: > > + The input supply for LDO_REG3 and LDO_REG7. > > + > > + vcc8-supply: > > + description: > > + The input supply for SWITCH_REG1. > > + > > + vcc9-supply: > > + description: > > + The input supply for LDO_REG4 and LDO_REG5. > > + > > + vcc10-supply: > > + description: > > + The input supply for LDO_REG6. > > + > > + vcc11-supply: > > + description: > > + The input supply for LDO_REG8. > > + > > + vcc12-supply: > > + description: > > + The input supply for SWITCH_REG2. > > + > > + vddio-supply: > > + description: > > + The input supply for digital IO. > > + > > + dvs-gpios: > > + description: | > > + buck1/2 can be controlled by gpio dvs, this is GPIO specifiers for > > + 2 host gpio's used for dvs. The format of the gpio specifier > > + depends in the gpio controller. If DVS GPIOs aren't present, > > + voltage changes will happen very quickly with no slow ramp time. > > + maxItems: 2 > > + > > + regulators: > > + type: object > > + patternProperties: > > + "^(DCDC_REG[1-4]|LDO_REG[1-8]|SWITCH_REG[1-2])$": > > + type: object > > + $ref: ../regulator/regulator.yaml# > > + unevaluatedProperties: false > > + > > +required: > > + - compatible > > + - reg > > + - interrupts > > + - "#clock-cells" > > Is this actually required (ditto elsewhere)? Technically it's only necessary > if there are any clock consumers targeting this node, so arguably it should > be the clock binding's responsibility to validate that. > > It wouldn't make much sense for a dedicated clock controller to omit > #clock-cells such that it couldn't have any consumers, but given that these > things are primarily PMICs I think it's reasonable to allow a board not to > care about the clocks at all if it doesn't use them. I know that the > original binding claimed it was required, but if we're already relaxing that > for RK805 here then we may as well relax it entirely. > > Cheers, > Robin.
On Wed, Feb 16, 2022 at 12:39:09PM +0000, Robin Murphy wrote: > On 2022-02-15 21:15, Chris Morgan wrote: > [...] > > diff --git a/Documentation/devicetree/bindings/mfd/rockchip,rk805.yaml b/Documentation/devicetree/bindings/mfd/rockchip,rk805.yaml > > new file mode 100644 > > index 000000000000..1b928b94fbfd > > --- /dev/null > > +++ b/Documentation/devicetree/bindings/mfd/rockchip,rk805.yaml > > @@ -0,0 +1,88 @@ > > +# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause > > +%YAML 1.2 > > +--- > > +$id: http://devicetree.org/schemas/mfd/rockchip,rk805.yaml# > > +$schema: http://devicetree.org/meta-schemas/core.yaml# > > + > > +title: RK805 Power Management Integrated Circuit > > + > > +maintainers: > > + - Chris Zhong <zyw@rock-chips.com> > > + - Zhang Qing <zhangqing@rock-chips.com> > > + > > +description: | > > + Rockchip RK805 series PMIC. This device consists of an i2c controlled MFD > > + that includes multiple switchable regulators. > > + > > +properties: > > + compatible: > > + enum: > > + - rockchip,rk805 > > + > > + reg: > > + maxItems: 1 > > + > > + interrupts: > > + maxItems: 1 > > + > > + '#clock-cells': > > + const: 1 > > + > > + clock-output-names: > > + maxItems: 2 > > I think this should be 1, since RK805 only has a single CLK32K output - > ditto for RK817. > > [...] > > diff --git a/Documentation/devicetree/bindings/mfd/rockchip,rk808.yaml b/Documentation/devicetree/bindings/mfd/rockchip,rk808.yaml > > new file mode 100644 > > index 000000000000..f5908fa01a61 > > --- /dev/null > > +++ b/Documentation/devicetree/bindings/mfd/rockchip,rk808.yaml > > @@ -0,0 +1,257 @@ > > +# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause > > +%YAML 1.2 > > +--- > > +$id: http://devicetree.org/schemas/mfd/rockchip,rk808.yaml# > > +$schema: http://devicetree.org/meta-schemas/core.yaml# > > + > > +title: RK808 Power Management Integrated Circuit > > + > > +maintainers: > > + - Chris Zhong <zyw@rock-chips.com> > > + - Zhang Qing <zhangqing@rock-chips.com> > > + > > +description: | > > + Rockchip RK808 series PMIC. This device consists of an i2c controlled MFD > > + that includes regulators, an RTC, and a power button. > > + > > +properties: > > + compatible: > > + enum: > > + - rockchip,rk808 > > + > > + reg: > > + maxItems: 1 > > + > > + interrupts: > > + maxItems: 1 > > + > > + '#clock-cells': > > + description: > > + See <dt-bindings/clock/rockchip,rk808.h> for clock IDs. > > + const: 1 > > + > > + clock-output-names: > > + description: > > + From common clock binding to override the default output clock name. > > minItems should be consistent across RK808/818/819 - when two clocks exist, > either it's legitimate to rename only the first one, or it isn't. There > shouldn't be an arbitrary difference just because of what existing DTs > happen to use. > > > + maxItems: 2 > > + > > + rockchip,system-power-controller: > > + type: boolean > > + description: > > + Telling whether or not this PMIC is controlling the system power. > > + > > + wakeup-source: > > + type: boolean > > + description: > > + Device can be used as a wakeup source. > > + > > + vcc1-supply: > > + description: > > + The input supply for DCDC_REG1. > > + > > + vcc2-supply: > > + description: > > + The input supply for DCDC_REG2. > > + > > + vcc3-supply: > > + description: > > + The input supply for DCDC_REG3. > > + > > + vcc4-supply: > > + description: > > + The input supply for DCDC_REG4. > > + > > + vcc6-supply: > > + description: > > + The input supply for LDO_REG1 and LDO_REG2. > > + > > + vcc7-supply: > > + description: > > + The input supply for LDO_REG3 and LDO_REG7. > > + > > + vcc8-supply: > > + description: > > + The input supply for SWITCH_REG1. > > + > > + vcc9-supply: > > + description: > > + The input supply for LDO_REG4 and LDO_REG5. > > + > > + vcc10-supply: > > + description: > > + The input supply for LDO_REG6. > > + > > + vcc11-supply: > > + description: > > + The input supply for LDO_REG8. > > + > > + vcc12-supply: > > + description: > > + The input supply for SWITCH_REG2. > > + > > + vddio-supply: > > + description: > > + The input supply for digital IO. > > + > > + dvs-gpios: > > + description: | > > + buck1/2 can be controlled by gpio dvs, this is GPIO specifiers for > > + 2 host gpio's used for dvs. The format of the gpio specifier > > + depends in the gpio controller. If DVS GPIOs aren't present, > > + voltage changes will happen very quickly with no slow ramp time. > > + maxItems: 2 > > + > > + regulators: > > + type: object > > + patternProperties: > > + "^(DCDC_REG[1-4]|LDO_REG[1-8]|SWITCH_REG[1-2])$": > > + type: object > > + $ref: ../regulator/regulator.yaml# > > + unevaluatedProperties: false > > + > > +required: > > + - compatible > > + - reg > > + - interrupts > > + - "#clock-cells" > > Is this actually required (ditto elsewhere)? Technically it's only necessary > if there are any clock consumers targeting this node, so arguably it should > be the clock binding's responsibility to validate that. > > It wouldn't make much sense for a dedicated clock controller to omit > #clock-cells such that it couldn't have any consumers, but given that these > things are primarily PMICs I think it's reasonable to allow a board not to > care about the clocks at all if it doesn't use them. I know that the > original binding claimed it was required, but if we're already relaxing that > for RK805 here then we may as well relax it entirely. Fair enough. However, if the consumer could be in an overlay, then I think we want it to be required and not make the overlay add the property. Properties just appearing within nodes at runtime is likely not well supported in OSs. Rob
On 2022-02-24 19:30, Rob Herring wrote: [...] >>> +required: >>> + - compatible >>> + - reg >>> + - interrupts >>> + - "#clock-cells" >> >> Is this actually required (ditto elsewhere)? Technically it's only necessary >> if there are any clock consumers targeting this node, so arguably it should >> be the clock binding's responsibility to validate that. >> >> It wouldn't make much sense for a dedicated clock controller to omit >> #clock-cells such that it couldn't have any consumers, but given that these >> things are primarily PMICs I think it's reasonable to allow a board not to >> care about the clocks at all if it doesn't use them. I know that the >> original binding claimed it was required, but if we're already relaxing that >> for RK805 here then we may as well relax it entirely. > > Fair enough. However, if the consumer could be in an overlay, then I > think we want it to be required and not make the overlay add the > property. Properties just appearing within nodes at runtime is likely > not well supported in OSs. Ah yes, that's an angle I hadn't considered, and I reckon it clearly answers my original question in the affirmative :) Indeed these clock outputs are often hooked up to SDIO WiFi modules, and I'm sure I *have* seen boards which put such modules on pluggable daughterboards in a manner which could reasonably use overlays, so in principle it does seem like a realistic concern. I'm happy with setting a general principle that if a clock output is exposed on a physical pin, then at the DTS level we can't know for sure that it *won't* be consumed (even if the original board design didn't intend it), therefore the device is always a potential clock controller and "#clock-cells" should be required. In that case, the consistency argument would fall the other way, to enforcing it for RK805 as well. Cheers, Robin.
On Fri, Feb 25, 2022 at 10:44:55AM +0000, Robin Murphy wrote: > On 2022-02-24 19:30, Rob Herring wrote: > [...] > > > > +required: > > > > + - compatible > > > > + - reg > > > > + - interrupts > > > > + - "#clock-cells" > > > > > > Is this actually required (ditto elsewhere)? Technically it's only necessary > > > if there are any clock consumers targeting this node, so arguably it should > > > be the clock binding's responsibility to validate that. > > > > > > It wouldn't make much sense for a dedicated clock controller to omit > > > #clock-cells such that it couldn't have any consumers, but given that these > > > things are primarily PMICs I think it's reasonable to allow a board not to > > > care about the clocks at all if it doesn't use them. I know that the > > > original binding claimed it was required, but if we're already relaxing that > > > for RK805 here then we may as well relax it entirely. > > > > Fair enough. However, if the consumer could be in an overlay, then I > > think we want it to be required and not make the overlay add the > > property. Properties just appearing within nodes at runtime is likely > > not well supported in OSs. > > Ah yes, that's an angle I hadn't considered, and I reckon it clearly answers > my original question in the affirmative :) > > Indeed these clock outputs are often hooked up to SDIO WiFi modules, and I'm > sure I *have* seen boards which put such modules on pluggable daughterboards > in a manner which could reasonably use overlays, so in principle it does > seem like a realistic concern. I'm happy with setting a general principle > that if a clock output is exposed on a physical pin, then at the DTS level > we can't know for sure that it *won't* be consumed (even if the original > board design didn't intend it), therefore the device is always a potential > clock controller and "#clock-cells" should be required. In that case, the > consistency argument would fall the other way, to enforcing it for RK805 as > well. Okay. So the existing point of contentions are: 1) "#clock-cells" should always be required. This causes a few boards to fail to check properly, but I assume that can be easily remedied by adding the "#clock-cells" to the devicetree. 2) The rk805, rk809, and rk817 only have a single clock-out. To workaround a quirk in the driver some boards have 2 clock-output-names. To fix the devicetree to accurately describe the hardware, the driver will have to be updated along with many boards with these PMICs. 3) The rk808 has no vcc13 or vcc14 input, but at least 4 boards preport to use such a voltage input anyway. Not a point of contention, but I need to add examples for the rk805, rk809, and rk818 which I will just pull from a popular devicetree. I can solve the clock-cells issue by simply adding that to the correct devicetrees (though I have no devices to test those on I assume they should be benign changes?). Is that acceptable to fix that? For the single clock out, I can't really fix it without updating the driver and modifying a large number of devicetrees. Should I just make it 1 min/2 max across all these YAML files and note for the rk805, rk809, and rk817 that there is only really one clock output? What should I do for #3? I've checked the schematic for the Pinebook Pro (which is one of the 4 boards affected) and can confirm that VCC13 and VCC14 on these boards is literally just VCC1 and VCC2, respectively. I can't seem to find the schematics for the other 3 boards affected though, but I assume it's something similar. Let me know, I'd like to get this finalized so I can get the battery code for the rk817 charger pushed too. Thank you very much for all your help. Chris > > Cheers, > Robin.
On 2022-03-02 16:36, Chris Morgan wrote: > On Fri, Feb 25, 2022 at 10:44:55AM +0000, Robin Murphy wrote: >> On 2022-02-24 19:30, Rob Herring wrote: >> [...] >>>>> +required: >>>>> + - compatible >>>>> + - reg >>>>> + - interrupts >>>>> + - "#clock-cells" >>>> >>>> Is this actually required (ditto elsewhere)? Technically it's only necessary >>>> if there are any clock consumers targeting this node, so arguably it should >>>> be the clock binding's responsibility to validate that. >>>> >>>> It wouldn't make much sense for a dedicated clock controller to omit >>>> #clock-cells such that it couldn't have any consumers, but given that these >>>> things are primarily PMICs I think it's reasonable to allow a board not to >>>> care about the clocks at all if it doesn't use them. I know that the >>>> original binding claimed it was required, but if we're already relaxing that >>>> for RK805 here then we may as well relax it entirely. >>> >>> Fair enough. However, if the consumer could be in an overlay, then I >>> think we want it to be required and not make the overlay add the >>> property. Properties just appearing within nodes at runtime is likely >>> not well supported in OSs. >> >> Ah yes, that's an angle I hadn't considered, and I reckon it clearly answers >> my original question in the affirmative :) >> >> Indeed these clock outputs are often hooked up to SDIO WiFi modules, and I'm >> sure I *have* seen boards which put such modules on pluggable daughterboards >> in a manner which could reasonably use overlays, so in principle it does >> seem like a realistic concern. I'm happy with setting a general principle >> that if a clock output is exposed on a physical pin, then at the DTS level >> we can't know for sure that it *won't* be consumed (even if the original >> board design didn't intend it), therefore the device is always a potential >> clock controller and "#clock-cells" should be required. In that case, the >> consistency argument would fall the other way, to enforcing it for RK805 as >> well. > > Okay. So the existing point of contentions are: > > 1) "#clock-cells" should always be required. This causes a few boards > to fail to check properly, but I assume that can be easily remedied by > adding the "#clock-cells" to the devicetree. > > 2) The rk805, rk809, and rk817 only have a single clock-out. To > workaround a quirk in the driver some boards have 2 clock-output-names. > To fix the devicetree to accurately describe the hardware, the driver > will have to be updated along with many boards with these PMICs. > > 3) The rk808 has no vcc13 or vcc14 input, but at least 4 boards preport > to use such a voltage input anyway. > > Not a point of contention, but I need to add examples for the rk805, > rk809, and rk818 which I will just pull from a popular devicetree. > > I can solve the clock-cells issue by simply adding that to the correct > devicetrees (though I have no devices to test those on I assume they > should be benign changes?). Is that acceptable to fix that? > > For the single clock out, I can't really fix it without updating the > driver and modifying a large number of devicetrees. Should I just make > it 1 min/2 max across all these YAML files and note for the rk805, > rk809, and rk817 that there is only really one clock output? > > What should I do for #3? I've checked the schematic for the Pinebook > Pro (which is one of the 4 boards affected) and can confirm that > VCC13 and VCC14 on these boards is literally just VCC1 and VCC2, > respectively. I can't seem to find the schematics for the other 3 > boards affected though, but I assume it's something similar. > > Let me know, I'd like to get this finalized so I can get the battery > code for the rk817 charger pushed too. In my opinion: 1) Yup, just fix the DTs. We're only adding a property where it would have to be anyway were there any consumers, so there's no risk of breakage, and the overlay support argument is a good one. 2) Make "clock-output-names" 2 items when "#clock-cells" = 1, or 1 item when "#clock-cells" = 0; allow the latter case for at least RK809 where it's in use already. Fixing the driver and DTs to converge all the single-clock-output chips consistently on the latter form can go on a to-do list somewhere. 3) Just fix the DTs. The properties aren't used, so they won't be missed. (FWIW it looks like those spurious names on RK808 pins 23 and 44 probably originated from the original RK3399 reference design schematic) How does that sound? > Thank you very much for all your help. And thank you for stepping up and persevering with such an annoyingly awkward binding conversion! Robin.
diff --git a/Documentation/devicetree/bindings/mfd/rk808.txt b/Documentation/devicetree/bindings/mfd/rk808.txt deleted file mode 100644 index 23a17a6663ec..000000000000 --- a/Documentation/devicetree/bindings/mfd/rk808.txt +++ /dev/null @@ -1,465 +0,0 @@ -RK8XX Power Management Integrated Circuit - -The rk8xx family current members: -rk805 -rk808 -rk809 -rk817 -rk818 - -Required properties: -- compatible: "rockchip,rk805" -- compatible: "rockchip,rk808" -- compatible: "rockchip,rk809" -- compatible: "rockchip,rk817" -- compatible: "rockchip,rk818" -- reg: I2C slave address -- interrupts: the interrupt outputs of the controller. -- #clock-cells: from common clock binding; shall be set to 1 (multiple clock - outputs). See <dt-bindings/clock/rockchip,rk808.h> for clock IDs. - -Optional properties: -- clock-output-names: From common clock binding to override the - default output clock name -- rockchip,system-power-controller: Telling whether or not this pmic is controlling - the system power. -- wakeup-source: Device can be used as a wakeup source. - -Optional RK805 properties: -- vcc1-supply: The input supply for DCDC_REG1 -- vcc2-supply: The input supply for DCDC_REG2 -- vcc3-supply: The input supply for DCDC_REG3 -- vcc4-supply: The input supply for DCDC_REG4 -- vcc5-supply: The input supply for LDO_REG1 and LDO_REG2 -- vcc6-supply: The input supply for LDO_REG3 - -Optional RK808 properties: -- vcc1-supply: The input supply for DCDC_REG1 -- vcc2-supply: The input supply for DCDC_REG2 -- vcc3-supply: The input supply for DCDC_REG3 -- vcc4-supply: The input supply for DCDC_REG4 -- vcc6-supply: The input supply for LDO_REG1 and LDO_REG2 -- vcc7-supply: The input supply for LDO_REG3 and LDO_REG7 -- vcc8-supply: The input supply for SWITCH_REG1 -- vcc9-supply: The input supply for LDO_REG4 and LDO_REG5 -- vcc10-supply: The input supply for LDO_REG6 -- vcc11-supply: The input supply for LDO_REG8 -- vcc12-supply: The input supply for SWITCH_REG2 -- dvs-gpios: buck1/2 can be controlled by gpio dvs, this is GPIO specifiers - for 2 host gpio's used for dvs. The format of the gpio specifier depends in - the gpio controller. If DVS GPIOs aren't present, voltage changes will happen - very quickly with no slow ramp time. - -Optional shared RK809 and RK817 properties: -- vcc1-supply: The input supply for DCDC_REG1 -- vcc2-supply: The input supply for DCDC_REG2 -- vcc3-supply: The input supply for DCDC_REG3 -- vcc4-supply: The input supply for DCDC_REG4 -- vcc5-supply: The input supply for LDO_REG1, LDO_REG2, LDO_REG3 -- vcc6-supply: The input supply for LDO_REG4, LDO_REG5, LDO_REG6 -- vcc7-supply: The input supply for LDO_REG7, LDO_REG8, LDO_REG9 - -Optional RK809 properties: -- vcc8-supply: The input supply for SWITCH_REG1 -- vcc9-supply: The input supply for DCDC_REG5, SWITCH_REG2 - -Optional RK817 properties: -- clocks: The input clock for the audio codec -- clock-names: The clock name for the codec clock. Should be "mclk". -- #sound-dai-cells: Needed for the interpretation of sound dais. Should be 0. - -- vcc8-supply: The input supply for BOOST -- vcc9-supply: The input supply for OTG_SWITCH -- codec: The child node for the codec to hold additional properties. - If no additional properties are required for the codec, this - node can be omitted. - -- rockchip,mic-in-differential: Telling if the microphone uses differential - mode. Should be under the codec child node. - -Optional RK818 properties: -- vcc1-supply: The input supply for DCDC_REG1 -- vcc2-supply: The input supply for DCDC_REG2 -- vcc3-supply: The input supply for DCDC_REG3 -- vcc4-supply: The input supply for DCDC_REG4 -- boost-supply: The input supply for DCDC_BOOST -- vcc6-supply: The input supply for LDO_REG1 and LDO_REG2 -- vcc7-supply: The input supply for LDO_REG3, LDO_REG5 and LDO_REG7 -- vcc8-supply: The input supply for LDO_REG4, LDO_REG6 and LDO_REG8 -- vcc9-supply: The input supply for LDO_REG9 and SWITCH_REG -- h_5v-supply: The input supply for HDMI_SWITCH -- usb-supply: The input supply for OTG_SWITCH - -Regulators: All the regulators of RK8XX to be instantiated shall be -listed in a child node named 'regulators'. Each regulator is represented -by a child node of the 'regulators' node. - - regulator-name { - /* standard regulator bindings here */ - }; - -Following regulators of the RK805 PMIC regulators are supported. Note that -the 'n' in regulator name, as in DCDC_REGn or LDOn, represents the DCDC or LDO -number as described in RK805 datasheet. - - - DCDC_REGn - - valid values for n are 1 to 4. - - LDO_REGn - - valid values for n are 1 to 3 - -Following regulators of the RK808 PMIC block are supported. Note that -the 'n' in regulator name, as in DCDC_REGn or LDOn, represents the DCDC or LDO -number as described in RK808 datasheet. - - - DCDC_REGn - - valid values for n are 1 to 4. - - LDO_REGn - - valid values for n are 1 to 8. - - SWITCH_REGn - - valid values for n are 1 to 2 - -Following regulators of the RK809 and RK817 PMIC blocks are supported. Note that -the 'n' in regulator name, as in DCDC_REGn or LDOn, represents the DCDC or LDO -number as described in RK809 and RK817 datasheets. - - - DCDC_REGn - - valid values for n are 1 to 5 for RK809. - - valid values for n are 1 to 4 for RK817. - - LDO_REGn - - valid values for n are 1 to 9 for RK809. - - valid values for n are 1 to 9 for RK817. - - SWITCH_REGn - - valid values for n are 1 to 2 for RK809. - - BOOST for RK817 - - OTG_SWITCH for RK817 - -Following regulators of the RK818 PMIC block are supported. Note that -the 'n' in regulator name, as in DCDC_REGn or LDOn, represents the DCDC or LDO -number as described in RK818 datasheet. - - - DCDC_REGn - - valid values for n are 1 to 4. - - LDO_REGn - - valid values for n are 1 to 9. - - SWITCH_REG - - HDMI_SWITCH - - OTG_SWITCH - -It is necessary to configure three pins for both the RK809 and RK817, the three -pins are "gpio_ts" "gpio_gt" "gpio_slp". - The gpio_gt and gpio_ts pins support the gpio function. - The gpio_slp pin is for controlling the pmic states, as below: - - reset - - power down - - sleep - -Standard regulator bindings are used inside regulator subnodes. Check - Documentation/devicetree/bindings/regulator/regulator.txt -for more details - -Example: - rk808: pmic@1b { - compatible = "rockchip,rk808"; - clock-output-names = "xin32k", "rk808-clkout2"; - interrupt-parent = <&gpio0>; - interrupts = <4 IRQ_TYPE_LEVEL_LOW>; - pinctrl-names = "default"; - pinctrl-0 = <&pmic_int &dvs_1 &dvs_2>; - dvs-gpios = <&gpio7 11 GPIO_ACTIVE_HIGH>, - <&gpio7 15 GPIO_ACTIVE_HIGH>; - reg = <0x1b>; - rockchip,system-power-controller; - wakeup-source; - #clock-cells = <1>; - - vcc8-supply = <&vcc_18>; - vcc9-supply = <&vcc_io>; - vcc10-supply = <&vcc_io>; - vcc12-supply = <&vcc_io>; - vddio-supply = <&vccio_pmu>; - - regulators { - vdd_cpu: DCDC_REG1 { - regulator-always-on; - regulator-boot-on; - regulator-min-microvolt = <750000>; - regulator-max-microvolt = <1300000>; - regulator-name = "vdd_arm"; - }; - - vdd_gpu: DCDC_REG2 { - regulator-always-on; - regulator-boot-on; - regulator-min-microvolt = <850000>; - regulator-max-microvolt = <1250000>; - regulator-name = "vdd_gpu"; - }; - - vcc_ddr: DCDC_REG3 { - regulator-always-on; - regulator-boot-on; - regulator-name = "vcc_ddr"; - }; - - vcc_io: DCDC_REG4 { - regulator-always-on; - regulator-boot-on; - regulator-min-microvolt = <3300000>; - regulator-max-microvolt = <3300000>; - regulator-name = "vcc_io"; - }; - - vccio_pmu: LDO_REG1 { - regulator-always-on; - regulator-boot-on; - regulator-min-microvolt = <3300000>; - regulator-max-microvolt = <3300000>; - regulator-name = "vccio_pmu"; - }; - - vcc_tp: LDO_REG2 { - regulator-always-on; - regulator-boot-on; - regulator-min-microvolt = <3300000>; - regulator-max-microvolt = <3300000>; - regulator-name = "vcc_tp"; - }; - - vdd_10: LDO_REG3 { - regulator-always-on; - regulator-boot-on; - regulator-min-microvolt = <1000000>; - regulator-max-microvolt = <1000000>; - regulator-name = "vdd_10"; - }; - - vcc18_lcd: LDO_REG4 { - regulator-always-on; - regulator-boot-on; - regulator-min-microvolt = <1800000>; - regulator-max-microvolt = <1800000>; - regulator-name = "vcc18_lcd"; - }; - - vccio_sd: LDO_REG5 { - regulator-always-on; - regulator-boot-on; - regulator-min-microvolt = <1800000>; - regulator-max-microvolt = <3300000>; - regulator-name = "vccio_sd"; - }; - - vdd10_lcd: LDO_REG6 { - regulator-always-on; - regulator-boot-on; - regulator-min-microvolt = <1000000>; - regulator-max-microvolt = <1000000>; - regulator-name = "vdd10_lcd"; - }; - - vcc_18: LDO_REG7 { - regulator-always-on; - regulator-boot-on; - regulator-min-microvolt = <1800000>; - regulator-max-microvolt = <1800000>; - regulator-name = "vcc_18"; - }; - - vcca_codec: LDO_REG8 { - regulator-always-on; - regulator-boot-on; - regulator-min-microvolt = <3300000>; - regulator-max-microvolt = <3300000>; - regulator-name = "vcca_codec"; - }; - - vcc_wl: SWITCH_REG1 { - regulator-always-on; - regulator-boot-on; - regulator-name = "vcc_wl"; - }; - - vcc_lcd: SWITCH_REG2 { - regulator-always-on; - regulator-boot-on; - regulator-name = "vcc_lcd"; - }; - }; - }; - - rk817: pmic@20 { - compatible = "rockchip,rk817"; - reg = <0x20>; - interrupt-parent = <&gpio0>; - interrupts = <RK_PB2 IRQ_TYPE_LEVEL_LOW>; - clock-output-names = "rk808-clkout1", "xin32k"; - clock-names = "mclk"; - clocks = <&cru SCLK_I2S1_OUT>; - pinctrl-names = "default"; - pinctrl-0 = <&pmic_int>, <&i2s1_2ch_mclk>; - wakeup-source; - #clock-cells = <1>; - #sound-dai-cells = <0>; - - vcc1-supply = <&vccsys>; - vcc2-supply = <&vccsys>; - vcc3-supply = <&vccsys>; - vcc4-supply = <&vccsys>; - vcc5-supply = <&vccsys>; - vcc6-supply = <&vccsys>; - vcc7-supply = <&vccsys>; - - regulators { - vdd_logic: DCDC_REG1 { - regulator-name = "vdd_logic"; - regulator-min-microvolt = <950000>; - regulator-max-microvolt = <1150000>; - regulator-ramp-delay = <6001>; - regulator-always-on; - regulator-boot-on; - - regulator-state-mem { - regulator-on-in-suspend; - regulator-suspend-microvolt = <950000>; - }; - }; - - vdd_arm: DCDC_REG2 { - regulator-name = "vdd_arm"; - regulator-min-microvolt = <950000>; - regulator-max-microvolt = <1350000>; - regulator-ramp-delay = <6001>; - regulator-always-on; - regulator-boot-on; - - regulator-state-mem { - regulator-off-in-suspend; - regulator-suspend-microvolt = <950000>; - }; - }; - - vcc_ddr: DCDC_REG3 { - regulator-name = "vcc_ddr"; - regulator-always-on; - regulator-boot-on; - - regulator-state-mem { - regulator-on-in-suspend; - }; - }; - - vcc_3v3: DCDC_REG4 { - regulator-name = "vcc_3v3"; - regulator-min-microvolt = <3300000>; - regulator-max-microvolt = <3300000>; - regulator-always-on; - regulator-boot-on; - - regulator-state-mem { - regulator-off-in-suspend; - regulator-suspend-microvolt = <3300000>; - }; - }; - - vcc_1v8: LDO_REG2 { - regulator-name = "vcc_1v8"; - regulator-min-microvolt = <1800000>; - regulator-max-microvolt = <1800000>; - regulator-always-on; - regulator-boot-on; - - regulator-state-mem { - regulator-on-in-suspend; - regulator-suspend-microvolt = <1800000>; - }; - }; - - vdd_1v0: LDO_REG3 { - regulator-name = "vdd_1v0"; - regulator-min-microvolt = <1000000>; - regulator-max-microvolt = <1000000>; - regulator-always-on; - regulator-boot-on; - - regulator-state-mem { - regulator-on-in-suspend; - regulator-suspend-microvolt = <1000000>; - }; - }; - - vcc3v3_pmu: LDO_REG4 { - regulator-name = "vcc3v3_pmu"; - regulator-min-microvolt = <3300000>; - regulator-max-microvolt = <3300000>; - regulator-always-on; - regulator-boot-on; - - regulator-state-mem { - regulator-on-in-suspend; - regulator-suspend-microvolt = <3300000>; - }; - }; - - vccio_sd: LDO_REG5 { - regulator-name = "vccio_sd"; - regulator-min-microvolt = <1800000>; - regulator-max-microvolt = <3300000>; - regulator-always-on; - regulator-boot-on; - - regulator-state-mem { - regulator-on-in-suspend; - regulator-suspend-microvolt = <3300000>; - }; - }; - - vcc_sd: LDO_REG6 { - regulator-name = "vcc_sd"; - regulator-min-microvolt = <3300000>; - regulator-max-microvolt = <3300000>; - regulator-boot-on; - - regulator-state-mem { - regulator-on-in-suspend; - regulator-suspend-microvolt = <3300000>; - }; - }; - - vcc_bl: LDO_REG7 { - regulator-name = "vcc_bl"; - regulator-min-microvolt = <3300000>; - regulator-max-microvolt = <3300000>; - - regulator-state-mem { - regulator-off-in-suspend; - regulator-suspend-microvolt = <3300000>; - }; - }; - - vcc_lcd: LDO_REG8 { - regulator-name = "vcc_lcd"; - regulator-min-microvolt = <2800000>; - regulator-max-microvolt = <2800000>; - - regulator-state-mem { - regulator-off-in-suspend; - regulator-suspend-microvolt = <2800000>; - }; - }; - - vcc_cam: LDO_REG9 { - regulator-name = "vcc_cam"; - regulator-min-microvolt = <3000000>; - regulator-max-microvolt = <3000000>; - - regulator-state-mem { - regulator-off-in-suspend; - regulator-suspend-microvolt = <3000000>; - }; - }; - }; - - rk817_codec: codec { - rockchip,mic-in-differential; - }; - }; diff --git a/Documentation/devicetree/bindings/mfd/rockchip,rk805.yaml b/Documentation/devicetree/bindings/mfd/rockchip,rk805.yaml new file mode 100644 index 000000000000..1b928b94fbfd --- /dev/null +++ b/Documentation/devicetree/bindings/mfd/rockchip,rk805.yaml @@ -0,0 +1,88 @@ +# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause +%YAML 1.2 +--- +$id: http://devicetree.org/schemas/mfd/rockchip,rk805.yaml# +$schema: http://devicetree.org/meta-schemas/core.yaml# + +title: RK805 Power Management Integrated Circuit + +maintainers: + - Chris Zhong <zyw@rock-chips.com> + - Zhang Qing <zhangqing@rock-chips.com> + +description: | + Rockchip RK805 series PMIC. This device consists of an i2c controlled MFD + that includes multiple switchable regulators. + +properties: + compatible: + enum: + - rockchip,rk805 + + reg: + maxItems: 1 + + interrupts: + maxItems: 1 + + '#clock-cells': + const: 1 + + clock-output-names: + maxItems: 2 + description: + From common clock binding to override the default output clock name. + + gpio-controller: true + + '#gpio-cells': + const: 2 + + rockchip,system-power-controller: + type: boolean + description: + Telling whether or not this PMIC is controlling the system power. + + wakeup-source: + type: boolean + description: + Device can be used as a wakeup source. + + vcc1-supply: + description: + The input supply for DCDC_REG1. + + vcc2-supply: + description: + The input supply for DCDC_REG2. + + vcc3-supply: + description: + The input supply for DCDC_REG3. + + vcc4-supply: + description: + The input supply for DCDC_REG4. + + vcc5-supply: + description: + The input supply for LDO_REG1 and LDO_REG2. + + vcc6-supply: + description: + The input supply for LDO_REG3. + + regulators: + type: object + patternProperties: + "^(DCDC_REG[1-4]|LDO_REG[1-3])$": + type: object + $ref: ../regulator/regulator.yaml# + unevaluatedProperties: false + +required: + - compatible + - reg + - interrupts + +additionalProperties: false diff --git a/Documentation/devicetree/bindings/mfd/rockchip,rk808.yaml b/Documentation/devicetree/bindings/mfd/rockchip,rk808.yaml new file mode 100644 index 000000000000..f5908fa01a61 --- /dev/null +++ b/Documentation/devicetree/bindings/mfd/rockchip,rk808.yaml @@ -0,0 +1,257 @@ +# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause +%YAML 1.2 +--- +$id: http://devicetree.org/schemas/mfd/rockchip,rk808.yaml# +$schema: http://devicetree.org/meta-schemas/core.yaml# + +title: RK808 Power Management Integrated Circuit + +maintainers: + - Chris Zhong <zyw@rock-chips.com> + - Zhang Qing <zhangqing@rock-chips.com> + +description: | + Rockchip RK808 series PMIC. This device consists of an i2c controlled MFD + that includes regulators, an RTC, and a power button. + +properties: + compatible: + enum: + - rockchip,rk808 + + reg: + maxItems: 1 + + interrupts: + maxItems: 1 + + '#clock-cells': + description: + See <dt-bindings/clock/rockchip,rk808.h> for clock IDs. + const: 1 + + clock-output-names: + description: + From common clock binding to override the default output clock name. + maxItems: 2 + + rockchip,system-power-controller: + type: boolean + description: + Telling whether or not this PMIC is controlling the system power. + + wakeup-source: + type: boolean + description: + Device can be used as a wakeup source. + + vcc1-supply: + description: + The input supply for DCDC_REG1. + + vcc2-supply: + description: + The input supply for DCDC_REG2. + + vcc3-supply: + description: + The input supply for DCDC_REG3. + + vcc4-supply: + description: + The input supply for DCDC_REG4. + + vcc6-supply: + description: + The input supply for LDO_REG1 and LDO_REG2. + + vcc7-supply: + description: + The input supply for LDO_REG3 and LDO_REG7. + + vcc8-supply: + description: + The input supply for SWITCH_REG1. + + vcc9-supply: + description: + The input supply for LDO_REG4 and LDO_REG5. + + vcc10-supply: + description: + The input supply for LDO_REG6. + + vcc11-supply: + description: + The input supply for LDO_REG8. + + vcc12-supply: + description: + The input supply for SWITCH_REG2. + + vddio-supply: + description: + The input supply for digital IO. + + dvs-gpios: + description: | + buck1/2 can be controlled by gpio dvs, this is GPIO specifiers for + 2 host gpio's used for dvs. The format of the gpio specifier + depends in the gpio controller. If DVS GPIOs aren't present, + voltage changes will happen very quickly with no slow ramp time. + maxItems: 2 + + regulators: + type: object + patternProperties: + "^(DCDC_REG[1-4]|LDO_REG[1-8]|SWITCH_REG[1-2])$": + type: object + $ref: ../regulator/regulator.yaml# + unevaluatedProperties: false + +required: + - compatible + - reg + - interrupts + - "#clock-cells" + +additionalProperties: false + +examples: + - | + #include <dt-bindings/pinctrl/rockchip.h> + #include <dt-bindings/interrupt-controller/irq.h> + #include <dt-bindings/gpio/gpio.h> + i2c { + #address-cells = <1>; + #size-cells = <0>; + + rk808: pmic@1b { + compatible = "rockchip,rk808"; + clock-output-names = "xin32k", "rk808-clkout2"; + interrupt-parent = <&gpio0>; + interrupts = <4 IRQ_TYPE_LEVEL_LOW>; + pinctrl-names = "default"; + pinctrl-0 = <&pmic_int &dvs_1 &dvs_2>; + dvs-gpios = <&gpio7 11 GPIO_ACTIVE_HIGH>, + <&gpio7 15 GPIO_ACTIVE_HIGH>; + reg = <0x1b>; + rockchip,system-power-controller; + wakeup-source; + #clock-cells = <1>; + + vcc8-supply = <&vcc_18>; + vcc9-supply = <&vcc_io>; + vcc10-supply = <&vcc_io>; + vcc12-supply = <&vcc_io>; + vddio-supply = <&vccio_pmu>; + + regulators { + vdd_cpu: DCDC_REG1 { + regulator-always-on; + regulator-boot-on; + regulator-min-microvolt = <750000>; + regulator-max-microvolt = <1300000>; + regulator-name = "vdd_arm"; + }; + + vdd_gpu: DCDC_REG2 { + regulator-always-on; + regulator-boot-on; + regulator-min-microvolt = <850000>; + regulator-max-microvolt = <1250000>; + regulator-name = "vdd_gpu"; + }; + + vcc_ddr: DCDC_REG3 { + regulator-always-on; + regulator-boot-on; + regulator-name = "vcc_ddr"; + }; + + vcc_io: DCDC_REG4 { + regulator-always-on; + regulator-boot-on; + regulator-min-microvolt = <3300000>; + regulator-max-microvolt = <3300000>; + regulator-name = "vcc_io"; + }; + + vccio_pmu: LDO_REG1 { + regulator-always-on; + regulator-boot-on; + regulator-min-microvolt = <3300000>; + regulator-max-microvolt = <3300000>; + regulator-name = "vccio_pmu"; + }; + + vcc_tp: LDO_REG2 { + regulator-always-on; + regulator-boot-on; + regulator-min-microvolt = <3300000>; + regulator-max-microvolt = <3300000>; + regulator-name = "vcc_tp"; + }; + + vdd_10: LDO_REG3 { + regulator-always-on; + regulator-boot-on; + regulator-min-microvolt = <1000000>; + regulator-max-microvolt = <1000000>; + regulator-name = "vdd_10"; + }; + + vcc18_lcd: LDO_REG4 { + regulator-always-on; + regulator-boot-on; + regulator-min-microvolt = <1800000>; + regulator-max-microvolt = <1800000>; + regulator-name = "vcc18_lcd"; + }; + + vccio_sd: LDO_REG5 { + regulator-always-on; + regulator-boot-on; + regulator-min-microvolt = <1800000>; + regulator-max-microvolt = <3300000>; + regulator-name = "vccio_sd"; + }; + + vdd10_lcd: LDO_REG6 { + regulator-always-on; + regulator-boot-on; + regulator-min-microvolt = <1000000>; + regulator-max-microvolt = <1000000>; + regulator-name = "vdd10_lcd"; + }; + + vcc_18: LDO_REG7 { + regulator-always-on; + regulator-boot-on; + regulator-min-microvolt = <1800000>; + regulator-max-microvolt = <1800000>; + regulator-name = "vcc_18"; + }; + + vcca_codec: LDO_REG8 { + regulator-always-on; + regulator-boot-on; + regulator-min-microvolt = <3300000>; + regulator-max-microvolt = <3300000>; + regulator-name = "vcca_codec"; + }; + + vcc_wl: SWITCH_REG1 { + regulator-always-on; + regulator-boot-on; + regulator-name = "vcc_wl"; + }; + + vcc_lcd: SWITCH_REG2 { + regulator-always-on; + regulator-boot-on; + regulator-name = "vcc_lcd"; + }; + }; + }; + }; diff --git a/Documentation/devicetree/bindings/mfd/rockchip,rk809.yaml b/Documentation/devicetree/bindings/mfd/rockchip,rk809.yaml new file mode 100644 index 000000000000..bc9e1c90deec --- /dev/null +++ b/Documentation/devicetree/bindings/mfd/rockchip,rk809.yaml @@ -0,0 +1,99 @@ +# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause +%YAML 1.2 +--- +$id: http://devicetree.org/schemas/mfd/rockchip,rk809.yaml# +$schema: http://devicetree.org/meta-schemas/core.yaml# + +title: RK809 Power Management Integrated Circuit + +maintainers: + - Chris Zhong <zyw@rock-chips.com> + - Zhang Qing <zhangqing@rock-chips.com> + +description: | + Rockchip RK809 series PMIC. This device consists of an i2c controlled MFD + that includes regulators, an RTC, and power button. + +properties: + compatible: + enum: + - rockchip,rk809 + + reg: + maxItems: 1 + + interrupts: + maxItems: 1 + + '#clock-cells': + description: | + See <dt-bindings/clock/rockchip,rk808.h> for clock IDs. + maximum: 1 + + clock-output-names: + description: + From common clock binding to override the default output clock name. + minItems: 1 + maxItems: 2 + + rockchip,system-power-controller: + type: boolean + description: + Telling whether or not this PMIC is controlling the system power. + + wakeup-source: + type: boolean + description: + Device can be used as a wakeup source. + + vcc1-supply: + description: + The input supply for DCDC_REG1. + + vcc2-supply: + description: + The input supply for DCDC_REG2. + + vcc3-supply: + description: + The input supply for DCDC_REG3. + + vcc4-supply: + description: + The input supply for DCDC_REG4. + + vcc5-supply: + description: + The input supply for LDO_REG1, LDO_REG2, and LDO_REG3. + + vcc6-supply: + description: + The input supply for LDO_REG4, LDO_REG5, and LDO_REG6. + + vcc7-supply: + description: + The input supply for LDO_REG7, LDO_REG8, and LDO_REG9. + + vcc8-supply: + description: + The input supply for SWITCH_REG1. + + vcc9-supply: + description: + The input supply for DCDC_REG5 and SWITCH_REG2. + + regulators: + type: object + patternProperties: + "^(LDO_REG[1-9]|DCDC_REG[1-5]|SWITCH_REG[1-2])$": + type: object + $ref: ../regulator/regulator.yaml# + unevaluatedProperties: false + +required: + - compatible + - reg + - interrupts + - "#clock-cells" + +additionalProperties: false diff --git a/Documentation/devicetree/bindings/mfd/rockchip,rk817.yaml b/Documentation/devicetree/bindings/mfd/rockchip,rk817.yaml new file mode 100644 index 000000000000..f1e4efa47ac4 --- /dev/null +++ b/Documentation/devicetree/bindings/mfd/rockchip,rk817.yaml @@ -0,0 +1,314 @@ +# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause +%YAML 1.2 +--- +$id: http://devicetree.org/schemas/mfd/rockchip,rk817.yaml# +$schema: http://devicetree.org/meta-schemas/core.yaml# + +title: RK817 Power Management Integrated Circuit + +maintainers: + - Chris Zhong <zyw@rock-chips.com> + - Zhang Qing <zhangqing@rock-chips.com> + +description: | + Rockchip RK817 series PMIC. This device consists of an i2c controlled MFD + that includes regulators, an RTC, a power button, an audio codec, and a + battery charger manager. + +properties: + compatible: + enum: + - rockchip,rk817 + + reg: + maxItems: 1 + + interrupts: + maxItems: 1 + + '#clock-cells': + description: + See <dt-bindings/clock/rockchip,rk808.h> for clock IDs. + const: 1 + + clock-output-names: + description: + From common clock binding to override the default output clock name. + maxItems: 2 + + rockchip,system-power-controller: + type: boolean + description: + Telling whether or not this PMIC is controlling the system power. + + wakeup-source: + type: boolean + description: + Device can be used as a wakeup source. + + vcc1-supply: + description: + The input supply for DCDC_REG1. + + vcc2-supply: + description: + The input supply for DCDC_REG2. + + vcc3-supply: + description: + The input supply for DCDC_REG3. + + vcc4-supply: + description: + The input supply for DCDC_REG4. + + vcc5-supply: + description: + The input supply for LDO_REG1, LDO_REG2, and LDO_REG3. + + vcc6-supply: + description: + The input supply for LDO_REG4, LDO_REG5, and LDO_REG6. + + vcc7-supply: + description: + The input supply for LDO_REG7, LDO_REG8, and LDO_REG9. + + vcc8-supply: + description: + The input supply for BOOST. + + vcc9-supply: + description: + The input supply for OTG_SWITCH. + + regulators: + type: object + patternProperties: + "^(LDO_REG[1-9]|DCDC_REG[1-4]|BOOST|OTG_SWITCH)$": + type: object + $ref: ../regulator/regulator.yaml# + unevaluatedProperties: false + + clocks: + description: + The input clock for the audio codec. + + clock-names: + description: + The clock name for the codec clock. + items: + - const: mclk + + '#sound-dai-cells': + description: + Needed for the interpretation of sound dais. + const: 0 + + codec: + description: | + The child node for the codec to hold additional properties. If no + additional properties are required for the codec, this node can be + omitted. + type: object + properties: + rockchip,mic-in-differential: + type: boolean + description: + Describes if the microphone uses differential mode. + +required: + - compatible + - reg + - interrupts + - "#clock-cells" + +additionalProperties: false + +examples: + - | + #include <dt-bindings/clock/px30-cru.h> + #include <dt-bindings/pinctrl/rockchip.h> + #include <dt-bindings/interrupt-controller/irq.h> + #include <dt-bindings/gpio/gpio.h> + i2c { + #address-cells = <1>; + #size-cells = <0>; + + rk817: pmic@20 { + compatible = "rockchip,rk817"; + reg = <0x20>; + interrupt-parent = <&gpio0>; + interrupts = <RK_PB2 IRQ_TYPE_LEVEL_LOW>; + clock-output-names = "rk808-clkout1", "xin32k"; + clock-names = "mclk"; + clocks = <&cru SCLK_I2S1_OUT>; + pinctrl-names = "default"; + pinctrl-0 = <&pmic_int>, <&i2s1_2ch_mclk>; + wakeup-source; + #clock-cells = <1>; + #sound-dai-cells = <0>; + + vcc1-supply = <&vccsys>; + vcc2-supply = <&vccsys>; + vcc3-supply = <&vccsys>; + vcc4-supply = <&vccsys>; + vcc5-supply = <&vccsys>; + vcc6-supply = <&vccsys>; + vcc7-supply = <&vccsys>; + + regulators { + vdd_logic: DCDC_REG1 { + regulator-name = "vdd_logic"; + regulator-min-microvolt = <950000>; + regulator-max-microvolt = <1150000>; + regulator-ramp-delay = <6001>; + regulator-always-on; + regulator-boot-on; + + regulator-state-mem { + regulator-on-in-suspend; + regulator-suspend-microvolt = <950000>; + }; + }; + + vdd_arm: DCDC_REG2 { + regulator-name = "vdd_arm"; + regulator-min-microvolt = <950000>; + regulator-max-microvolt = <1350000>; + regulator-ramp-delay = <6001>; + regulator-always-on; + regulator-boot-on; + + regulator-state-mem { + regulator-off-in-suspend; + regulator-suspend-microvolt = <950000>; + }; + }; + + vcc_ddr: DCDC_REG3 { + regulator-name = "vcc_ddr"; + regulator-always-on; + regulator-boot-on; + + regulator-state-mem { + regulator-on-in-suspend; + }; + }; + + vcc_3v3: DCDC_REG4 { + regulator-name = "vcc_3v3"; + regulator-min-microvolt = <3300000>; + regulator-max-microvolt = <3300000>; + regulator-always-on; + regulator-boot-on; + + regulator-state-mem { + regulator-off-in-suspend; + regulator-suspend-microvolt = <3300000>; + }; + }; + + vcc_1v8: LDO_REG2 { + regulator-name = "vcc_1v8"; + regulator-min-microvolt = <1800000>; + regulator-max-microvolt = <1800000>; + regulator-always-on; + regulator-boot-on; + + regulator-state-mem { + regulator-on-in-suspend; + regulator-suspend-microvolt = <1800000>; + }; + }; + + vdd_1v0: LDO_REG3 { + regulator-name = "vdd_1v0"; + regulator-min-microvolt = <1000000>; + regulator-max-microvolt = <1000000>; + regulator-always-on; + regulator-boot-on; + + regulator-state-mem { + regulator-on-in-suspend; + regulator-suspend-microvolt = <1000000>; + }; + }; + + vcc3v3_pmu: LDO_REG4 { + regulator-name = "vcc3v3_pmu"; + regulator-min-microvolt = <3300000>; + regulator-max-microvolt = <3300000>; + regulator-always-on; + regulator-boot-on; + + regulator-state-mem { + regulator-on-in-suspend; + regulator-suspend-microvolt = <3300000>; + }; + }; + + vccio_sd: LDO_REG5 { + regulator-name = "vccio_sd"; + regulator-min-microvolt = <1800000>; + regulator-max-microvolt = <3300000>; + regulator-always-on; + regulator-boot-on; + + regulator-state-mem { + regulator-on-in-suspend; + regulator-suspend-microvolt = <3300000>; + }; + }; + + vcc_sd: LDO_REG6 { + regulator-name = "vcc_sd"; + regulator-min-microvolt = <3300000>; + regulator-max-microvolt = <3300000>; + regulator-boot-on; + + regulator-state-mem { + regulator-on-in-suspend; + regulator-suspend-microvolt = <3300000>; + }; + }; + + vcc_bl: LDO_REG7 { + regulator-name = "vcc_bl"; + regulator-min-microvolt = <3300000>; + regulator-max-microvolt = <3300000>; + + regulator-state-mem { + regulator-off-in-suspend; + regulator-suspend-microvolt = <3300000>; + }; + }; + + vcc_lcd: LDO_REG8 { + regulator-name = "vcc_lcd"; + regulator-min-microvolt = <2800000>; + regulator-max-microvolt = <2800000>; + + regulator-state-mem { + regulator-off-in-suspend; + regulator-suspend-microvolt = <2800000>; + }; + }; + + vcc_cam: LDO_REG9 { + regulator-name = "vcc_cam"; + regulator-min-microvolt = <3000000>; + regulator-max-microvolt = <3000000>; + + regulator-state-mem { + regulator-off-in-suspend; + regulator-suspend-microvolt = <3000000>; + }; + }; + }; + + rk817_codec: codec { + rockchip,mic-in-differential; + }; + }; + }; diff --git a/Documentation/devicetree/bindings/mfd/rockchip,rk818.yaml b/Documentation/devicetree/bindings/mfd/rockchip,rk818.yaml new file mode 100644 index 000000000000..aaa573247e3f --- /dev/null +++ b/Documentation/devicetree/bindings/mfd/rockchip,rk818.yaml @@ -0,0 +1,110 @@ +# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause +%YAML 1.2 +--- +$id: http://devicetree.org/schemas/mfd/rockchip,rk818.yaml# +$schema: http://devicetree.org/meta-schemas/core.yaml# + +title: RK818 Power Management Integrated Circuit + +maintainers: + - Chris Zhong <zyw@rock-chips.com> + - Zhang Qing <zhangqing@rock-chips.com> + +description: | + Rockchip RK818 series PMIC. This device consists of an i2c controlled MFD + that includes regulators, an RTC, and a power button. + +properties: + compatible: + enum: + - rockchip,rk818 + + reg: + maxItems: 1 + + interrupts: + maxItems: 1 + + '#clock-cells': + description: | + See <dt-bindings/clock/rockchip,rk808.h> for clock IDs. + const: 1 + + clock-output-names: + description: + From common clock binding to override the default output clock name. + maxItems: 2 + + rockchip,system-power-controller: + type: boolean + description: + Telling whether or not this PMIC is controlling the system power. + + wakeup-source: + type: boolean + description: + Device can be used as a wakeup source. + + vcc1-supply: + description: + The input supply for DCDC_REG1. + + vcc2-supply: + description: + The input supply for DCDC_REG2. + + vcc3-supply: + description: + The input supply for DCDC_REG3. + + vcc4-supply: + description: + The input supply for DCDC_REG4. + + boost-supply: + description: + The input supply for DCDC_BOOST + + vcc6-supply: + description: + The input supply for LDO_REG1 and LDO_REG2. + + vcc7-supply: + description: + The input supply for LDO_REG3, LDO_REG5, and LDO_REG7. + + vcc8-supply: + description: + The input supply for LDO_REG4, LDO_REG6, and LDO_REG8. + + vcc9-supply: + description: + The input supply for LDO_REG9 and SWITCH_REG. + + vddio-supply: + description: + The input supply for digital IO. + + h_5v-supply: + description: + The input supply for HDMI_SWITCH. + + usb-supply: + description: + The input supply for OTG_SWITCH. + + regulators: + type: object + patternProperties: + "^(DCDC_REG[1-4]|LDO_REG[1-9]|SWITCH_REG|HDMI_SWITCH|OTG_SWITCH)$": + type: object + $ref: ../regulator/regulator.yaml# + unevaluatedProperties: false + +required: + - compatible + - reg + - interrupts + - "#clock-cells" + +additionalProperties: false