Add documentation to describe Nuvoton BMC NPCM dwmac driver(sgmii).
Signed-off-by: Tomer Maimon <[email protected]>
---
.../bindings/net/nuvoton,npcm8xx-sgmii.yaml | 72 +++++++++++++++++++
.../devicetree/bindings/net/snps,dwmac.yaml | 1 +
2 files changed, 73 insertions(+)
create mode 100644 Documentation/devicetree/bindings/net/nuvoton,npcm8xx-sgmii.yaml
diff --git a/Documentation/devicetree/bindings/net/nuvoton,npcm8xx-sgmii.yaml b/Documentation/devicetree/bindings/net/nuvoton,npcm8xx-sgmii.yaml
new file mode 100644
index 000000000000..6a5f2cade7c9
--- /dev/null
+++ b/Documentation/devicetree/bindings/net/nuvoton,npcm8xx-sgmii.yaml
@@ -0,0 +1,72 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/net/nuvoton,npcm8xx-sgmii.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Nuvoton NPCM DWMAC SGMII Ethernet controller
+
+maintainers:
+ - Tomer Maimon <[email protected]>
+
+select:
+ properties:
+ compatible:
+ contains:
+ enum:
+ - nuvoton,npcm8xx-sgmii
+ required:
+ - compatible
+
+allOf:
+ - $ref: snps,dwmac.yaml#
+
+properties:
+ compatible:
+ oneOf:
+ - items:
+ - enum:
+ - nuvoton,npcm8xx-sgmii
+ - const: snps,dwmac-3.50a
+ reg:
+ items:
+ - description:
+ The first range represent DWMAC controller registers.
+ - description:
+ The second range represent PCS configuration registers.
+
+ clocks:
+ items:
+ - description: GMAC main clock
+
+ clock-names:
+ items:
+ - const: stmmaceth
+
+required:
+ - compatible
+ - reg
+ - clocks
+ - clock-names
+
+unevaluatedProperties: false
+
+examples:
+ - |
+ #include <dt-bindings/interrupt-controller/arm-gic.h>
+ #include <dt-bindings/clock/nuvoton,npcm845-clk.h>
+
+ ahb {
+ #address-cells = <2>;
+ #size-cells = <2>;
+
+ gmac0: ethernet@f0802000 {
+ compatible = "nuvoton,npcm8xx-sgmii","snps,dwmac-3.50a";
+ reg = <0x0 0xf0802000 0x0 0x2000>, <0x0 0xf0780000 0x0 0x200>;
+ interrupts = <GIC_SPI 14 IRQ_TYPE_LEVEL_HIGH>;
+ interrupt-names = "macirq";
+ clocks = <&clk NPCM8XX_CLK_AHB>;
+ clock-names = "stmmaceth";
+ phy-mode = "rgmii-id";
+ };
+ };
diff --git a/Documentation/devicetree/bindings/net/snps,dwmac.yaml b/Documentation/devicetree/bindings/net/snps,dwmac.yaml
index 5c2769dc689a..ba52dbc85144 100644
--- a/Documentation/devicetree/bindings/net/snps,dwmac.yaml
+++ b/Documentation/devicetree/bindings/net/snps,dwmac.yaml
@@ -66,6 +66,7 @@ properties:
- ingenic,x2000-mac
- loongson,ls2k-dwmac
- loongson,ls7a-dwmac
+ - nuvoton,npcm8xx-sgmii
- qcom,qcs404-ethqos
- qcom,sa8775p-ethqos
- qcom,sc8280xp-ethqos
--
2.33.0
On 21/11/2023 16:17, Tomer Maimon wrote:
> Add documentation to describe Nuvoton BMC NPCM dwmac driver(sgmii).
>
> Signed-off-by: Tomer Maimon <[email protected]>
> ---
> .../bindings/net/nuvoton,npcm8xx-sgmii.yaml | 72 +++++++++++++++++++
> .../devicetree/bindings/net/snps,dwmac.yaml | 1 +
> 2 files changed, 73 insertions(+)
> create mode 100644 Documentation/devicetree/bindings/net/nuvoton,npcm8xx-sgmii.yaml
>
> diff --git a/Documentation/devicetree/bindings/net/nuvoton,npcm8xx-sgmii.yaml b/Documentation/devicetree/bindings/net/nuvoton,npcm8xx-sgmii.yaml
> new file mode 100644
> index 000000000000..6a5f2cade7c9
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/net/nuvoton,npcm8xx-sgmii.yaml
> @@ -0,0 +1,72 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/net/nuvoton,npcm8xx-sgmii.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Nuvoton NPCM DWMAC SGMII Ethernet controller
> +
> +maintainers:
> + - Tomer Maimon <[email protected]>
> +
> +select:
> + properties:
> + compatible:
> + contains:
> + enum:
> + - nuvoton,npcm8xx-sgmii
This must be specific compatible, no wildcards. Then use the same for
filename.
> + required:
> + - compatible
> +
> +allOf:
> + - $ref: snps,dwmac.yaml#
> +
> +properties:
> + compatible:
> + oneOf:
> + - items:
> + - enum:
> + - nuvoton,npcm8xx-sgmii
> + - const: snps,dwmac-3.50a
Blank line
> + reg:
> + items:
> + - description:
> + The first range represent DWMAC controller registers.
Keep it in one line and drop redundant "The first range represent".
> + - description:
> + The second range represent PCS configuration registers.
> +
> + clocks:
> + items:
> + - description: GMAC main clock
> +
> + clock-names:
> + items:
> + - const: stmmaceth
> +
Constrain also interrupts and resets.
> +required:
> + - compatible
> + - reg
> + - clocks
> + - clock-names
> +
> +unevaluatedProperties: false
> +
> +examples:
> + - |
> + #include <dt-bindings/interrupt-controller/arm-gic.h>
> + #include <dt-bindings/clock/nuvoton,npcm845-clk.h>
> +
> + ahb {
> + #address-cells = <2>;
> + #size-cells = <2>;
Your indentation is mixed. Use 4 spaces for example indentation.
> +
> + gmac0: ethernet@f0802000 {
Best regards,
Krzysztof