diff mbox series

[1/3] dt-bindings: arm: airoha: Add documentation for Airoha SPI controller

Message ID 20220922100410.1101874-2-bert@biot.com (mailing list archive)
State Superseded
Headers show
Series Add support for the Airoha EN7523 SPI controller | expand

Commit Message

Bert Vermeulen Sept. 22, 2022, 10:04 a.m. UTC
Create documentation for accessing the Airoha EN7523 SPI controller.

Signed-off-by: Bert Vermeulen <bert@biot.com>
---
 .../bindings/spi/airoha,en7523-spi.yaml       | 54 +++++++++++++++++++
 1 file changed, 54 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/spi/airoha,en7523-spi.yaml

Comments

Krzysztof Kozlowski Sept. 23, 2022, 11:31 a.m. UTC | #1
On 22/09/2022 12:04, Bert Vermeulen wrote:
> Create documentation for accessing the Airoha EN7523 SPI controller.
> 
> Signed-off-by: Bert Vermeulen <bert@biot.com>
> ---

Use scripts/get_maintainers.pl to CC all maintainers and relevant
mailing lists.

Pushing bindings without CC-ing maintainers is not the way...

Best regards,
Krzysztof
Bert Vermeulen Sept. 23, 2022, 11:55 a.m. UTC | #2
On 9/23/22 13:31, Krzysztof Kozlowski wrote:
> On 22/09/2022 12:04, Bert Vermeulen wrote:
>> Create documentation for accessing the Airoha EN7523 SPI controller.
>> 
>> Signed-off-by: Bert Vermeulen <bert@biot.com>
>> ---
> 
> Use scripts/get_maintainers.pl to CC all maintainers and relevant
> mailing lists.
> 
> Pushing bindings without CC-ing maintainers is not the way...

Oh sorry! I'll Cc you on V2 of the patchset.
Krzysztof Kozlowski Sept. 23, 2022, 12:07 p.m. UTC | #3
On 23/09/2022 13:55, Bert Vermeulen wrote:
> On 9/23/22 13:31, Krzysztof Kozlowski wrote:
>> On 22/09/2022 12:04, Bert Vermeulen wrote:
>>> Create documentation for accessing the Airoha EN7523 SPI controller.
>>>
>>> Signed-off-by: Bert Vermeulen <bert@biot.com>
>>> ---
>>
>> Use scripts/get_maintainers.pl to CC all maintainers and relevant
>> mailing lists.
>>
>> Pushing bindings without CC-ing maintainers is not the way...
> 
> Oh sorry! I'll Cc you on V2 of the patchset.
> 

It's not the point to cc me. The point is to Cc all necessary
maintainers. We have script for this, so you don't have to figure out
people addresses...

Best regards,
Krzysztof
Rob Herring (Arm) Sept. 26, 2022, 8:28 p.m. UTC | #4
On Thu, Sep 22, 2022 at 12:04:08PM +0200, Bert Vermeulen wrote:
> Create documentation for accessing the Airoha EN7523 SPI controller.
> 
> Signed-off-by: Bert Vermeulen <bert@biot.com>
> ---
>  .../bindings/spi/airoha,en7523-spi.yaml       | 54 +++++++++++++++++++
>  1 file changed, 54 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/spi/airoha,en7523-spi.yaml
> 
> diff --git a/Documentation/devicetree/bindings/spi/airoha,en7523-spi.yaml b/Documentation/devicetree/bindings/spi/airoha,en7523-spi.yaml
> new file mode 100644
> index 000000000000..e5bc7814424e
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/spi/airoha,en7523-spi.yaml
> @@ -0,0 +1,54 @@
> +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/spi/airoha,en7523-spi.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Airoha EN7523 SPI controller
> +
> +maintainers:
> +  - Bert Vermeulen <bert@biot.com>
> +
> +description: |
> +  This binding describes the SPI controller on Airoha EN7523 SoCs.
> +
> +allOf:
> +  - $ref: "spi-controller.yaml#"

Drop quotes.

> +
> +properties:
> +  compatible:
> +    items:
> +      - const: airoha,en7523-spi
> +
> +  reg:
> +    maxItems: 1
> +
> +  clocks:
> +    items:
> +      - description: SPI clock

'maxItems: 1' is sufficient.

> +
> +  clock-names:
> +    items:
> +      - const: spi

You don't really need clock-names when there is only 1.

> +
> +required:
> +  - compatible
> +  - reg
> +  - clocks
> +  - clock-names
> +  - '#address-cells'
> +  - '#size-cells'
> +
> +unevaluatedProperties: false
> +
> +examples:
> +  - |
> +    #include <dt-bindings/clock/en7523-clk.h>
> +    spi0: spi@1fa10000 {
> +      compatible = "airoha,en7523-spi";
> +      reg = <0x1fa10000 0x10000>;
> +      #address-cells = <1>;
> +      #size-cells = <0>;
> +      clocks = <&scu EN7523_CLK_SPI>;
> +      clock-names = "spi";
> +    };
> -- 
> 2.25.1
> 
>
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/spi/airoha,en7523-spi.yaml b/Documentation/devicetree/bindings/spi/airoha,en7523-spi.yaml
new file mode 100644
index 000000000000..e5bc7814424e
--- /dev/null
+++ b/Documentation/devicetree/bindings/spi/airoha,en7523-spi.yaml
@@ -0,0 +1,54 @@ 
+# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/spi/airoha,en7523-spi.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Airoha EN7523 SPI controller
+
+maintainers:
+  - Bert Vermeulen <bert@biot.com>
+
+description: |
+  This binding describes the SPI controller on Airoha EN7523 SoCs.
+
+allOf:
+  - $ref: "spi-controller.yaml#"
+
+properties:
+  compatible:
+    items:
+      - const: airoha,en7523-spi
+
+  reg:
+    maxItems: 1
+
+  clocks:
+    items:
+      - description: SPI clock
+
+  clock-names:
+    items:
+      - const: spi
+
+required:
+  - compatible
+  - reg
+  - clocks
+  - clock-names
+  - '#address-cells'
+  - '#size-cells'
+
+unevaluatedProperties: false
+
+examples:
+  - |
+    #include <dt-bindings/clock/en7523-clk.h>
+    spi0: spi@1fa10000 {
+      compatible = "airoha,en7523-spi";
+      reg = <0x1fa10000 0x10000>;
+      #address-cells = <1>;
+      #size-cells = <0>;
+      clocks = <&scu EN7523_CLK_SPI>;
+      clock-names = "spi";
+    };