diff mbox series

[v3,4/5] dt-bindings: add bindings for polarfire soc system controller

Message ID 20201223163316.29186-1-conor.dooley@microchip.com
State New
Headers show
Series [v3,1/5] mbox: add polarfire soc system controller mailbox | expand

Commit Message

Conor Dooley Dec. 23, 2020, 4:33 p.m. UTC
From: Conor Dooley <conor.dooley@microchip.com>

Add device tree bindings for the MSS system controller on
the Microchip PolarFire SoC.

Signed-off-by: Conor Dooley <conor.dooley@microchip.com>
---
 .../microchip,mpfs_sys_controller.yaml        | 34 +++++++++++++++++++
 1 file changed, 34 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/soc/microchip/microchip,mpfs_sys_controller.yaml

Comments

Jonathan Neuschäfer Jan. 5, 2021, 9:25 p.m. UTC | #1
Hi,

On Wed, Dec 23, 2020 at 04:33:16PM +0000, conor.dooley@microchip.com wrote:
> From: Conor Dooley <conor.dooley@microchip.com>

> 

> Add device tree bindings for the MSS system controller on

> the Microchip PolarFire SoC.


"MSS" doesn't appear below, so perhaps an expansion in parentheses would
be nice, e.g.: "MSS (microprocessor subsystem)"

> 

> Signed-off-by: Conor Dooley <conor.dooley@microchip.com>

> ---

>  .../microchip,mpfs_sys_controller.yaml        | 34 +++++++++++++++++++

>  1 file changed, 34 insertions(+)

>  create mode 100644 Documentation/devicetree/bindings/soc/microchip/microchip,mpfs_sys_controller.yaml

> 

> diff --git a/Documentation/devicetree/bindings/soc/microchip/microchip,mpfs_sys_controller.yaml b/Documentation/devicetree/bindings/soc/microchip/microchip,mpfs_sys_controller.yaml

> new file mode 100644

> index 000000000000..60fde1925910

> --- /dev/null

> +++ b/Documentation/devicetree/bindings/soc/microchip/microchip,mpfs_sys_controller.yaml

> @@ -0,0 +1,34 @@

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

> +%YAML 1.2

> +---

> +$id: "http://devicetree.org/schemas/soc/microchip/microchip,mpfs_sys_controller.yaml#"

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

> +

> +title: Microchip PolarFire SoC (MPFS) system controller

> +

> +maintainers:

> +  - Conor Dooley <conor.dooley@microchip.com>

> +

> +properties:

> +  compatible:

> +    const: microchip,polarfire-soc-sys-controller


The file name and compatible string are inconsistent in phrasing
(mpfs- vs. polarfire-soc-). If possible, please align them.

> +

> +  mboxes:

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

> +    description: |

> +      phandle and index of the mailbox controller device node.

> +      See: ../mailbox/mailbox.txt for more information.

> +    maxItems: 1

> +

> +required:

> +  - compatible

> +  - "mboxes"


Quotation marks are unnecessary here, because there are no special
characters in "mboxes".

> +

> +additionalProperties: false

> +

> +examples:

> +  - |

> +    syscontroller: syscontroller {

> +      compatible = "microchip,polarfire-soc-sys-controller";

> +      mboxes = <&mbox 0>;

> +    };

> -- 



Best regards,
Jonathan Neuschäfer
Rob Herring Jan. 8, 2021, 2:31 a.m. UTC | #2
On Wed, Dec 23, 2020 at 04:33:16PM +0000, conor.dooley@microchip.com wrote:
> From: Conor Dooley <conor.dooley@microchip.com>

> 

> Add device tree bindings for the MSS system controller on

> the Microchip PolarFire SoC.

> 

> Signed-off-by: Conor Dooley <conor.dooley@microchip.com>

> ---

>  .../microchip,mpfs_sys_controller.yaml        | 34 +++++++++++++++++++

>  1 file changed, 34 insertions(+)

>  create mode 100644 Documentation/devicetree/bindings/soc/microchip/microchip,mpfs_sys_controller.yaml

> 

> diff --git a/Documentation/devicetree/bindings/soc/microchip/microchip,mpfs_sys_controller.yaml b/Documentation/devicetree/bindings/soc/microchip/microchip,mpfs_sys_controller.yaml

> new file mode 100644

> index 000000000000..60fde1925910

> --- /dev/null

> +++ b/Documentation/devicetree/bindings/soc/microchip/microchip,mpfs_sys_controller.yaml

> @@ -0,0 +1,34 @@

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

> +%YAML 1.2

> +---

> +$id: "http://devicetree.org/schemas/soc/microchip/microchip,mpfs_sys_controller.yaml#"

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

> +

> +title: Microchip PolarFire SoC (MPFS) system controller

> +

> +maintainers:

> +  - Conor Dooley <conor.dooley@microchip.com>


'description'?

Perhaps including some info about what this block does and how it is 
accessed.

> +

> +properties:

> +  compatible:

> +    const: microchip,polarfire-soc-sys-controller

> +

> +  mboxes:

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

> +    description: |

> +      phandle and index of the mailbox controller device node.

> +      See: ../mailbox/mailbox.txt for more information.


All this is defined already in the common binding schema, drop.

> +    maxItems: 1

> +

> +required:

> +  - compatible

> +  - "mboxes"


Don't need quotes.

> +

> +additionalProperties: false

> +

> +examples:

> +  - |

> +    syscontroller: syscontroller {

> +      compatible = "microchip,polarfire-soc-sys-controller";

> +      mboxes = <&mbox 0>;

> +    };

> -- 

> 2.17.1

>
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/soc/microchip/microchip,mpfs_sys_controller.yaml b/Documentation/devicetree/bindings/soc/microchip/microchip,mpfs_sys_controller.yaml
new file mode 100644
index 000000000000..60fde1925910
--- /dev/null
+++ b/Documentation/devicetree/bindings/soc/microchip/microchip,mpfs_sys_controller.yaml
@@ -0,0 +1,34 @@ 
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: "http://devicetree.org/schemas/soc/microchip/microchip,mpfs_sys_controller.yaml#"
+$schema: "http://devicetree.org/meta-schemas/core.yaml#"
+
+title: Microchip PolarFire SoC (MPFS) system controller
+
+maintainers:
+  - Conor Dooley <conor.dooley@microchip.com>
+
+properties:
+  compatible:
+    const: microchip,polarfire-soc-sys-controller
+
+  mboxes:
+    $ref: '/schemas/types.yaml#/definitions/phandle-array'
+    description: |
+      phandle and index of the mailbox controller device node.
+      See: ../mailbox/mailbox.txt for more information.
+    maxItems: 1
+
+required:
+  - compatible
+  - "mboxes"
+
+additionalProperties: false
+
+examples:
+  - |
+    syscontroller: syscontroller {
+      compatible = "microchip,polarfire-soc-sys-controller";
+      mboxes = <&mbox 0>;
+    };