diff mbox series

dt-bindings: power: Convert power_supply text to yaml

Message ID 20200430151841.17453-1-dmurphy@ti.com (mailing list archive)
State Not Applicable, archived
Headers show
Series dt-bindings: power: Convert power_supply text to yaml | expand

Commit Message

Dan Murphy April 30, 2020, 3:18 p.m. UTC 
Convert the power_supply.txt to power-supply.yaml.
This conversion entailed fixing up the binding to being yaml and dt
checker compliant.

Added a note in the power_supply.txt to reference the power-supply.yaml

CC: Rob Herring <robh@kernel.org>
Signed-off-by: Dan Murphy <dmurphy@ti.com>
---
 .../bindings/power/supply/power-supply.yaml   | 40 +++++++++++++++++++
 .../bindings/power/supply/power_supply.txt    | 25 +-----------
 2 files changed, 42 insertions(+), 23 deletions(-)
 create mode 100644 Documentation/devicetree/bindings/power/supply/power-supply.yaml

Comments

Sebastian Reichel May 1, 2020, 4:58 p.m. UTC | #1 
Hi,

On Thu, Apr 30, 2020 at 10:18:41AM -0500, Dan Murphy wrote:
> Convert the power_supply.txt to power-supply.yaml.
> This conversion entailed fixing up the binding to being yaml and dt
> checker compliant.

Looks mostly good to me, thanks for taking care of it.

> Added a note in the power_supply.txt to reference the power-supply.yaml

Yes, we should keep the file until all bindings referencing the file
have been converted to YAML.

> CC: Rob Herring <robh@kernel.org>
> Signed-off-by: Dan Murphy <dmurphy@ti.com>
> ---
>  .../bindings/power/supply/power-supply.yaml   | 40 +++++++++++++++++++
>  .../bindings/power/supply/power_supply.txt    | 25 +-----------
>  2 files changed, 42 insertions(+), 23 deletions(-)
>  create mode 100644 Documentation/devicetree/bindings/power/supply/power-supply.yaml
> 
> diff --git a/Documentation/devicetree/bindings/power/supply/power-supply.yaml b/Documentation/devicetree/bindings/power/supply/power-supply.yaml
> new file mode 100644
> index 000000000000..cfbc79833ed8
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/power/supply/power-supply.yaml
> @@ -0,0 +1,40 @@
> +# SPDX-License-Identifier: GPL-2.0
> +%YAML 1.2
> +---
> +$id: "http://devicetree.org/schemas/power/supply/power_supply.yaml#"

This should be power-supply instead of power_supply, which is also
reported by dtb_binding_check on my system :)

> +$schema: "http://devicetree.org/meta-schemas/core.yaml#"
> +
> +title: Power Supply Core Support
> +
> +maintainers:
> +  - Sebastian Reichel <sre@kernel.org>
> +
> +properties:
> +  power-supplies:
> +    $ref: /schemas/types.yaml#/definitions/phandle-array
> +    description:
> +      This property is added to a supply in order to list the devices which
> +      supply it power, referenced by their phandles.
> +
> +examples:
> +  - |
> +    power {
> +      #address-cells = <1>;
> +      #size-cells = <0>;
> +
> +      usb_charger:power@e {
> +        compatible = "some,usb-charger";
> +        reg = <0xe>;
> +      };
> +
> +      ac_charger:power@c {

^^^ while at it, let's also fix this up and use
charger instead of power (for both entries).

> +        compatible = "some,ac-charger";
> +        reg = <0xc>;
> +      };
> +
> +      battery:battery@b {
> +        compatible = "some,battery";
> +        reg = <0xb>;
> +        power-supplies = <&usb_charger>, <&ac_charger>;
> +      };
> +    };
> diff --git a/Documentation/devicetree/bindings/power/supply/power_supply.txt b/Documentation/devicetree/bindings/power/supply/power_supply.txt
> index 8391bfa0edac..d9693e054509 100644
> --- a/Documentation/devicetree/bindings/power/supply/power_supply.txt
> +++ b/Documentation/devicetree/bindings/power/supply/power_supply.txt
> @@ -1,23 +1,2 @@
> -Power Supply Core Support
> -
> -Optional Properties:
> - - power-supplies : This property is added to a supply in order to list the
> -   devices which supply it power, referenced by their phandles.
> -
> -Example:
> -
> -	usb-charger: power@e {
> -		compatible = "some,usb-charger";
> -		...
> -	};
> -
> -	ac-charger: power@c {
> -		compatible = "some,ac-charger";
> -		...
> -	};
> -
> -	battery@b {
> -		compatible = "some,battery";
> -		...
> -		power-supplies = <&usb-charger>, <&ac-charger>;
> -	};
> +This binding has been converted to yaml please see power-supply.yaml in this
> +directory.
> -- 
> 2.25.1
>
Dan Murphy May 1, 2020, 5 p.m. UTC | #2 
Sebastian

On 5/1/20 11:58 AM, Sebastian Reichel wrote:
> Hi,
>
> On Thu, Apr 30, 2020 at 10:18:41AM -0500, Dan Murphy wrote:
>> Convert the power_supply.txt to power-supply.yaml.
>> This conversion entailed fixing up the binding to being yaml and dt
>> checker compliant.
> Looks mostly good to me, thanks for taking care of it.
>
>> Added a note in the power_supply.txt to reference the power-supply.yaml
> Yes, we should keep the file until all bindings referencing the file
> have been converted to YAML.
Ack
>> CC: Rob Herring <robh@kernel.org>
>> Signed-off-by: Dan Murphy <dmurphy@ti.com>
>> ---
>>   .../bindings/power/supply/power-supply.yaml   | 40 +++++++++++++++++++
>>   .../bindings/power/supply/power_supply.txt    | 25 +-----------
>>   2 files changed, 42 insertions(+), 23 deletions(-)
>>   create mode 100644 Documentation/devicetree/bindings/power/supply/power-supply.yaml
>>
>> diff --git a/Documentation/devicetree/bindings/power/supply/power-supply.yaml b/Documentation/devicetree/bindings/power/supply/power-supply.yaml
>> new file mode 100644
>> index 000000000000..cfbc79833ed8
>> --- /dev/null
>> +++ b/Documentation/devicetree/bindings/power/supply/power-supply.yaml
>> @@ -0,0 +1,40 @@
>> +# SPDX-License-Identifier: GPL-2.0
>> +%YAML 1.2
>> +---
>> +$id: "http://devicetree.org/schemas/power/supply/power_supply.yaml#"
> This should be power-supply instead of power_supply, which is also
> reported by dtb_binding_check on my system :)

Yeah I had an untracked file called power_supply.yaml and removed it 
after checking it in.

I will change this

>
>> +$schema: "http://devicetree.org/meta-schemas/core.yaml#"
>> +
>> +title: Power Supply Core Support
>> +
>> +maintainers:
>> +  - Sebastian Reichel <sre@kernel.org>
>> +
>> +properties:
>> +  power-supplies:
>> +    $ref: /schemas/types.yaml#/definitions/phandle-array
>> +    description:
>> +      This property is added to a supply in order to list the devices which
>> +      supply it power, referenced by their phandles.
>> +
>> +examples:
>> +  - |
>> +    power {
>> +      #address-cells = <1>;
>> +      #size-cells = <0>;
>> +
>> +      usb_charger:power@e {
>> +        compatible = "some,usb-charger";
>> +        reg = <0xe>;
>> +      };
>> +
>> +      ac_charger:power@c {
> ^^^ while at it, let's also fix this up and use
> charger instead of power (for both entries).

Ack

Dan
Rob Herring (Arm) May 1, 2020, 9:13 p.m. UTC | #3 
On Thu, 30 Apr 2020 10:18:41 -0500, Dan Murphy wrote:
> Convert the power_supply.txt to power-supply.yaml.
> This conversion entailed fixing up the binding to being yaml and dt
> checker compliant.
> 
> Added a note in the power_supply.txt to reference the power-supply.yaml
> 
> CC: Rob Herring <robh@kernel.org>
> Signed-off-by: Dan Murphy <dmurphy@ti.com>
> ---
>  .../bindings/power/supply/power-supply.yaml   | 40 +++++++++++++++++++
>  .../bindings/power/supply/power_supply.txt    | 25 +-----------
>  2 files changed, 42 insertions(+), 23 deletions(-)
>  create mode 100644 Documentation/devicetree/bindings/power/supply/power-supply.yaml
> 

My bot found errors running 'make dt_binding_check' on your patch:

Documentation/devicetree/bindings/power/supply/power-supply.yaml: $id: relative path/filename doesn't match actual path or filename
	expected: http://devicetree.org/schemas/power/supply/power-supply.yaml#

See https://patchwork.ozlabs.org/patch/1280522

If you already ran 'make dt_binding_check' and didn't see the above
error(s), then make sure dt-schema is up to date:

pip3 install git+https://github.com/devicetree-org/dt-schema.git@master --upgrade

Please check and re-submit.
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/power/supply/power-supply.yaml b/Documentation/devicetree/bindings/power/supply/power-supply.yaml
new file mode 100644
index 000000000000..cfbc79833ed8
--- /dev/null
+++ b/Documentation/devicetree/bindings/power/supply/power-supply.yaml
@@ -0,0 +1,40 @@ 
+# SPDX-License-Identifier: GPL-2.0
+%YAML 1.2
+---
+$id: "http://devicetree.org/schemas/power/supply/power_supply.yaml#"
+$schema: "http://devicetree.org/meta-schemas/core.yaml#"
+
+title: Power Supply Core Support
+
+maintainers:
+  - Sebastian Reichel <sre@kernel.org>
+
+properties:
+  power-supplies:
+    $ref: /schemas/types.yaml#/definitions/phandle-array
+    description:
+      This property is added to a supply in order to list the devices which
+      supply it power, referenced by their phandles.
+
+examples:
+  - |
+    power {
+      #address-cells = <1>;
+      #size-cells = <0>;
+
+      usb_charger:power@e {
+        compatible = "some,usb-charger";
+        reg = <0xe>;
+      };
+
+      ac_charger:power@c {
+        compatible = "some,ac-charger";
+        reg = <0xc>;
+      };
+
+      battery:battery@b {
+        compatible = "some,battery";
+        reg = <0xb>;
+        power-supplies = <&usb_charger>, <&ac_charger>;
+      };
+    };
diff --git a/Documentation/devicetree/bindings/power/supply/power_supply.txt b/Documentation/devicetree/bindings/power/supply/power_supply.txt
index 8391bfa0edac..d9693e054509 100644
--- a/Documentation/devicetree/bindings/power/supply/power_supply.txt
+++ b/Documentation/devicetree/bindings/power/supply/power_supply.txt
@@ -1,23 +1,2 @@ 
-Power Supply Core Support
-
-Optional Properties:
- - power-supplies : This property is added to a supply in order to list the
-   devices which supply it power, referenced by their phandles.
-
-Example:
-
-	usb-charger: power@e {
-		compatible = "some,usb-charger";
-		...
-	};
-
-	ac-charger: power@c {
-		compatible = "some,ac-charger";
-		...
-	};
-
-	battery@b {
-		compatible = "some,battery";
-		...
-		power-supplies = <&usb-charger>, <&ac-charger>;
-	};
+This binding has been converted to yaml please see power-supply.yaml in this
+directory.