diff mbox series

[v2,2/2] dt-bindings: can: flexcan: convert fsl,*flexcan bindings to yaml

Message ID 20201016073315.16232-3-o.rempel@pengutronix.de
State New
Headers show
Series convert flexcan to the yaml | expand

Commit Message

Oleksij Rempel Oct. 16, 2020, 7:33 a.m. UTC
In order to automate the verification of DT nodes convert
fsl-flexcan.txt to fsl,flexcan.yaml

Signed-off-by: Oleksij Rempel <o.rempel@pengutronix.de>
---
 .../bindings/net/can/fsl,flexcan.yaml         | 137 ++++++++++++++++++
 .../bindings/net/can/fsl-flexcan.txt          |  57 --------
 2 files changed, 137 insertions(+), 57 deletions(-)
 create mode 100644 Documentation/devicetree/bindings/net/can/fsl,flexcan.yaml
 delete mode 100644 Documentation/devicetree/bindings/net/can/fsl-flexcan.txt

Comments

Rob Herring (Arm) Oct. 19, 2020, 9:25 p.m. UTC | #1
On Fri, Oct 16, 2020 at 09:33:15AM +0200, Oleksij Rempel wrote:
> In order to automate the verification of DT nodes convert

> fsl-flexcan.txt to fsl,flexcan.yaml

> 

> Signed-off-by: Oleksij Rempel <o.rempel@pengutronix.de>

> ---

>  .../bindings/net/can/fsl,flexcan.yaml         | 137 ++++++++++++++++++

>  .../bindings/net/can/fsl-flexcan.txt          |  57 --------

>  2 files changed, 137 insertions(+), 57 deletions(-)

>  create mode 100644 Documentation/devicetree/bindings/net/can/fsl,flexcan.yaml

>  delete mode 100644 Documentation/devicetree/bindings/net/can/fsl-flexcan.txt

> 

> diff --git a/Documentation/devicetree/bindings/net/can/fsl,flexcan.yaml b/Documentation/devicetree/bindings/net/can/fsl,flexcan.yaml

> new file mode 100644

> index 000000000000..c5c72bcd47c8

> --- /dev/null

> +++ b/Documentation/devicetree/bindings/net/can/fsl,flexcan.yaml

> @@ -0,0 +1,137 @@

> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)

> +%YAML 1.2

> +---

> +$id: http://devicetree.org/schemas/net/can/fsl,flexcan.yaml#

> +$schema: http://devicetree.org/meta-schemas/core.yaml#

> +

> +title:

> +  Flexcan CAN controller on Freescale's ARM and PowerPC system-on-a-chip (SOC).

> +

> +maintainers:

> +  - Marc Kleine-Budde <mkl@pengutronix.de>

> +

> +allOf:

> +  - $ref: can-controller.yaml#

> +

> +properties:

> +  compatible:

> +    oneOf:

> +      - enum:

> +          - fsl,imx8qm-flexcan

> +          - fsl,imx8mp-flexcan

> +          - fsl,imx6q-flexcan

> +          - fsl,imx53-flexcan

> +          - fsl,imx35-flexcan

> +          - fsl,imx28-flexcan

> +          - fsl,imx25-flexcan

> +          - fsl,p1010-flexcan

> +          - fsl,vf610-flexcan

> +          - fsl,ls1021ar2-flexcan

> +          - fsl,lx2160ar1-flexcan

> +      - items:

> +          - enum:

> +              - fsl,imx7d-flexcan

> +              - fsl,imx6ul-flexcan

> +              - fsl,imx6sx-flexcan

> +          - const: fsl,imx6q-flexcan

> +      - items:

> +          - enum:

> +              - fsl,ls1028ar1-flexcan

> +          - const: fsl,lx2160ar1-flexcan

> +

> +  reg:

> +    maxItems: 1

> +

> +  interrupts:

> +    maxItems: 1

> +

> +  clocks:

> +    maxItems: 2

> +

> +  clock-names:

> +    items:

> +      - const: ipg

> +      - const: per

> +

> +  clock-frequency:

> +    description: |

> +      The oscillator frequency driving the flexcan device, filled in by the

> +      boot loader. This property should only be used the used operating system

> +      doesn't support the clocks and clock-names property.

> +    $ref: /schemas/types.yaml#/definitions/uint32


Standard prop, already has a type.

> +

> +  xceiver-supply:

> +    description: Regulator that powers the CAN transceiver.

> +    maxItems: 1


*-supply is always a single item. Drop maxItems.

> +

> +  big-endian:

> +    $ref: /schemas/types.yaml#/definitions/flag

> +    description: |

> +      This means the registers of FlexCAN controller are big endian. This is

> +      optional property.i.e. if this property is not present in device tree

> +      node then controller is assumed to be little endian. If this property is

> +      present then controller is assumed to be big endian.

> +

> +  fsl,stop-mode:

> +    description: |

> +      Register bits of stop mode control.

> +

> +      The format should be as follows:

> +      <gpr req_gpr req_bit>

> +      gpr is the phandle to general purpose register node.

> +      req_gpr is the gpr register offset of CAN stop request.

> +      req_bit is the bit offset of CAN stop request.

> +    $ref: /schemas/types.yaml#/definitions/phandle-array

> +    items:

> +      - description: The 'gpr' is the phandle to general purpose register node.

> +      - description: The 'req_gpr' is the gpr register offset of CAN stop request.

> +        maximum: 0xff

> +      - description: The 'req_bit' is the bit offset of CAN stop request.

> +        maximum: 0x1f

> +

> +  fsl,clk-source:

> +    description: |

> +      Select the clock source to the CAN Protocol Engine (PE). It's SoC

> +      implementation dependent. Refer to RM for detailed definition. If this

> +      property is not set in device tree node then driver selects clock source 1

> +      by default.

> +      0: clock source 0 (oscillator clock)

> +      1: clock source 1 (peripheral clock)

> +    $ref: /schemas/types.yaml#/definitions/uint32

> +    default: 1

> +    minimum: 0

> +    maximum: 1

> +

> +  wakeup-source:

> +    $ref: /schemas/types.yaml#/definitions/flag

> +    description:

> +      Enable CAN remote wakeup.

> +

> +required:

> +  - compatible

> +  - reg

> +  - interrupts

> +

> +additionalProperties: false

> +

> +examples:

> +  - |

> +    can@1c000 {

> +        compatible = "fsl,p1010-flexcan";

> +        reg = <0x1c000 0x1000>;

> +        interrupts = <48 0x2>;

> +        interrupt-parent = <&mpic>;

> +        clock-frequency = <200000000>;

> +        fsl,clk-source = <0>;

> +    };

> +  - |

> +    #include <dt-bindings/interrupt-controller/irq.h>

> +

> +    can@2090000 {

> +        compatible = "fsl,imx6q-flexcan";

> +        reg = <0x02090000 0x4000>;

> +        interrupts = <0 110 IRQ_TYPE_LEVEL_HIGH>;

> +        clocks = <&clks 1>, <&clks 2>;

> +        clock-names = "ipg", "per";

> +        fsl,stop-mode = <&gpr 0x34 28>;

> +    };

> diff --git a/Documentation/devicetree/bindings/net/can/fsl-flexcan.txt b/Documentation/devicetree/bindings/net/can/fsl-flexcan.txt

> deleted file mode 100644

> index e10b6eb955e1..000000000000

> --- a/Documentation/devicetree/bindings/net/can/fsl-flexcan.txt

> +++ /dev/null

> @@ -1,57 +0,0 @@

> -Flexcan CAN controller on Freescale's ARM and PowerPC system-on-a-chip (SOC).

> -

> -Required properties:

> -

> -- compatible : Should be "fsl,<processor>-flexcan"

> -

> -  where <processor> is imx8qm, imx6q, imx28, imx53, imx35, imx25, p1010,

> -  vf610, ls1021ar2, lx2160ar1, ls1028ar1.

> -

> -  The ls1028ar1 must be followed by lx2160ar1, e.g.

> -   - "fsl,ls1028ar1-flexcan", "fsl,lx2160ar1-flexcan"

> -

> -  An implementation should also claim any of the following compatibles

> -  that it is fully backwards compatible with:

> -

> -  - fsl,p1010-flexcan

> -

> -- reg : Offset and length of the register set for this device

> -- interrupts : Interrupt tuple for this device

> -

> -Optional properties:

> -

> -- clock-frequency : The oscillator frequency driving the flexcan device

> -

> -- xceiver-supply: Regulator that powers the CAN transceiver

> -

> -- big-endian: This means the registers of FlexCAN controller are big endian.

> -              This is optional property.i.e. if this property is not present in

> -              device tree node then controller is assumed to be little endian.

> -              if this property is present then controller is assumed to be big

> -              endian.

> -

> -- fsl,stop-mode: register bits of stop mode control, the format is

> -		 <&gpr req_gpr req_bit>.

> -		 gpr is the phandle to general purpose register node.

> -		 req_gpr is the gpr register offset of CAN stop request.

> -		 req_bit is the bit offset of CAN stop request.

> -

> -- fsl,clk-source: Select the clock source to the CAN Protocol Engine (PE).

> -		  It's SoC Implementation dependent. Refer to RM for detailed

> -		  definition. If this property is not set in device tree node

> -		  then driver selects clock source 1 by default.

> -		  0: clock source 0 (oscillator clock)

> -		  1: clock source 1 (peripheral clock)

> -

> -- wakeup-source: enable CAN remote wakeup

> -

> -Example:

> -

> -	can@1c000 {

> -		compatible = "fsl,p1010-flexcan";

> -		reg = <0x1c000 0x1000>;

> -		interrupts = <48 0x2>;

> -		interrupt-parent = <&mpic>;

> -		clock-frequency = <200000000>; // filled in by bootloader

> -		fsl,clk-source = <0>; // select clock source 0 for PE

> -	};

> -- 

> 2.28.0

>
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/net/can/fsl,flexcan.yaml b/Documentation/devicetree/bindings/net/can/fsl,flexcan.yaml
new file mode 100644
index 000000000000..c5c72bcd47c8
--- /dev/null
+++ b/Documentation/devicetree/bindings/net/can/fsl,flexcan.yaml
@@ -0,0 +1,137 @@ 
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/net/can/fsl,flexcan.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title:
+  Flexcan CAN controller on Freescale's ARM and PowerPC system-on-a-chip (SOC).
+
+maintainers:
+  - Marc Kleine-Budde <mkl@pengutronix.de>
+
+allOf:
+  - $ref: can-controller.yaml#
+
+properties:
+  compatible:
+    oneOf:
+      - enum:
+          - fsl,imx8qm-flexcan
+          - fsl,imx8mp-flexcan
+          - fsl,imx6q-flexcan
+          - fsl,imx53-flexcan
+          - fsl,imx35-flexcan
+          - fsl,imx28-flexcan
+          - fsl,imx25-flexcan
+          - fsl,p1010-flexcan
+          - fsl,vf610-flexcan
+          - fsl,ls1021ar2-flexcan
+          - fsl,lx2160ar1-flexcan
+      - items:
+          - enum:
+              - fsl,imx7d-flexcan
+              - fsl,imx6ul-flexcan
+              - fsl,imx6sx-flexcan
+          - const: fsl,imx6q-flexcan
+      - items:
+          - enum:
+              - fsl,ls1028ar1-flexcan
+          - const: fsl,lx2160ar1-flexcan
+
+  reg:
+    maxItems: 1
+
+  interrupts:
+    maxItems: 1
+
+  clocks:
+    maxItems: 2
+
+  clock-names:
+    items:
+      - const: ipg
+      - const: per
+
+  clock-frequency:
+    description: |
+      The oscillator frequency driving the flexcan device, filled in by the
+      boot loader. This property should only be used the used operating system
+      doesn't support the clocks and clock-names property.
+    $ref: /schemas/types.yaml#/definitions/uint32
+
+  xceiver-supply:
+    description: Regulator that powers the CAN transceiver.
+    maxItems: 1
+
+  big-endian:
+    $ref: /schemas/types.yaml#/definitions/flag
+    description: |
+      This means the registers of FlexCAN controller are big endian. This is
+      optional property.i.e. if this property is not present in device tree
+      node then controller is assumed to be little endian. If this property is
+      present then controller is assumed to be big endian.
+
+  fsl,stop-mode:
+    description: |
+      Register bits of stop mode control.
+
+      The format should be as follows:
+      <gpr req_gpr req_bit>
+      gpr is the phandle to general purpose register node.
+      req_gpr is the gpr register offset of CAN stop request.
+      req_bit is the bit offset of CAN stop request.
+    $ref: /schemas/types.yaml#/definitions/phandle-array
+    items:
+      - description: The 'gpr' is the phandle to general purpose register node.
+      - description: The 'req_gpr' is the gpr register offset of CAN stop request.
+        maximum: 0xff
+      - description: The 'req_bit' is the bit offset of CAN stop request.
+        maximum: 0x1f
+
+  fsl,clk-source:
+    description: |
+      Select the clock source to the CAN Protocol Engine (PE). It's SoC
+      implementation dependent. Refer to RM for detailed definition. If this
+      property is not set in device tree node then driver selects clock source 1
+      by default.
+      0: clock source 0 (oscillator clock)
+      1: clock source 1 (peripheral clock)
+    $ref: /schemas/types.yaml#/definitions/uint32
+    default: 1
+    minimum: 0
+    maximum: 1
+
+  wakeup-source:
+    $ref: /schemas/types.yaml#/definitions/flag
+    description:
+      Enable CAN remote wakeup.
+
+required:
+  - compatible
+  - reg
+  - interrupts
+
+additionalProperties: false
+
+examples:
+  - |
+    can@1c000 {
+        compatible = "fsl,p1010-flexcan";
+        reg = <0x1c000 0x1000>;
+        interrupts = <48 0x2>;
+        interrupt-parent = <&mpic>;
+        clock-frequency = <200000000>;
+        fsl,clk-source = <0>;
+    };
+  - |
+    #include <dt-bindings/interrupt-controller/irq.h>
+
+    can@2090000 {
+        compatible = "fsl,imx6q-flexcan";
+        reg = <0x02090000 0x4000>;
+        interrupts = <0 110 IRQ_TYPE_LEVEL_HIGH>;
+        clocks = <&clks 1>, <&clks 2>;
+        clock-names = "ipg", "per";
+        fsl,stop-mode = <&gpr 0x34 28>;
+    };
diff --git a/Documentation/devicetree/bindings/net/can/fsl-flexcan.txt b/Documentation/devicetree/bindings/net/can/fsl-flexcan.txt
deleted file mode 100644
index e10b6eb955e1..000000000000
--- a/Documentation/devicetree/bindings/net/can/fsl-flexcan.txt
+++ /dev/null
@@ -1,57 +0,0 @@ 
-Flexcan CAN controller on Freescale's ARM and PowerPC system-on-a-chip (SOC).
-
-Required properties:
-
-- compatible : Should be "fsl,<processor>-flexcan"
-
-  where <processor> is imx8qm, imx6q, imx28, imx53, imx35, imx25, p1010,
-  vf610, ls1021ar2, lx2160ar1, ls1028ar1.
-
-  The ls1028ar1 must be followed by lx2160ar1, e.g.
-   - "fsl,ls1028ar1-flexcan", "fsl,lx2160ar1-flexcan"
-
-  An implementation should also claim any of the following compatibles
-  that it is fully backwards compatible with:
-
-  - fsl,p1010-flexcan
-
-- reg : Offset and length of the register set for this device
-- interrupts : Interrupt tuple for this device
-
-Optional properties:
-
-- clock-frequency : The oscillator frequency driving the flexcan device
-
-- xceiver-supply: Regulator that powers the CAN transceiver
-
-- big-endian: This means the registers of FlexCAN controller are big endian.
-              This is optional property.i.e. if this property is not present in
-              device tree node then controller is assumed to be little endian.
-              if this property is present then controller is assumed to be big
-              endian.
-
-- fsl,stop-mode: register bits of stop mode control, the format is
-		 <&gpr req_gpr req_bit>.
-		 gpr is the phandle to general purpose register node.
-		 req_gpr is the gpr register offset of CAN stop request.
-		 req_bit is the bit offset of CAN stop request.
-
-- fsl,clk-source: Select the clock source to the CAN Protocol Engine (PE).
-		  It's SoC Implementation dependent. Refer to RM for detailed
-		  definition. If this property is not set in device tree node
-		  then driver selects clock source 1 by default.
-		  0: clock source 0 (oscillator clock)
-		  1: clock source 1 (peripheral clock)
-
-- wakeup-source: enable CAN remote wakeup
-
-Example:
-
-	can@1c000 {
-		compatible = "fsl,p1010-flexcan";
-		reg = <0x1c000 0x1000>;
-		interrupts = <48 0x2>;
-		interrupt-parent = <&mpic>;
-		clock-frequency = <200000000>; // filled in by bootloader
-		fsl,clk-source = <0>; // select clock source 0 for PE
-	};