Document support for Airoha AN8855 Switch SoC. This SoC expose various
peripherals like an Ethernet Switch, a NVMEM provider and Ethernet PHYs.
It does also support i2c and timers but those are not currently
supported/used.
Signed-off-by: Christian Marangi <ansuelsmth@gmail.com>
---
.../bindings/mfd/airoha,an8855.yaml | 182 ++++++++++++++++++
MAINTAINERS | 1 +
2 files changed, 183 insertions(+)
create mode 100644 Documentation/devicetree/bindings/mfd/airoha,an8855.yaml
diff --git a/Documentation/devicetree/bindings/mfd/airoha,an8855.yaml b/Documentation/devicetree/bindings/mfd/airoha,an8855.yaml
new file mode 100644
index 000000000000..a59a23056b3a
--- /dev/null
+++ b/Documentation/devicetree/bindings/mfd/airoha,an8855.yaml
@@ -0,0 +1,182 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/mfd/airoha,an8855.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Airoha AN8855 Switch SoC
+
+maintainers:
+ - Christian Marangi <ansuelsmth@gmail.com>
+
+description: >
+ Airoha AN8855 Switch is a SoC that expose various peripherals like an
+ Ethernet Switch, a NVMEM provider and Ethernet PHYs.
+
+ It does also support i2c and timers but those are not currently
+ supported/used.
+
+properties:
+ compatible:
+ const: airoha,an8855
+
+ reg:
+ maxItems: 1
+
+ reset-gpios: true
+
+ efuse:
+ type: object
+ $ref: /schemas/nvmem/airoha,an8855-efuse.yaml
+ description:
+ EFUSE exposed by the Airoha AN8855 Switch. This child node definition
+ should follow the bindings specified in
+ Documentation/devicetree/bindings/nvmem/airoha,an8855-efuse.yaml
+
+ ethernet-switch:
+ type: object
+ $ref: /schemas/net/dsa/airoha,an8855-switch.yaml
+ description:
+ Switch exposed by the Airoha AN8855 Switch. This child node definition
+ should follow the bindings specified in
+ Documentation/devicetree/bindings/net/dsa/airoha,an8855-switch.yaml
+
+ mdio:
+ type: object
+ $ref: /schemas/net/airoha,an8855-mdio.yaml
+ description:
+ MDIO exposed by the Airoha AN8855 Switch. This child node definition
+ should follow the bindings specified in
+ Documentation/devicetree/bindings/net/airoha,an8855-mdio.yaml
+
+required:
+ - compatible
+ - reg
+
+additionalProperties: false
+
+examples:
+ - |
+ #include <dt-bindings/gpio/gpio.h>
+
+ mdio {
+ #address-cells = <1>;
+ #size-cells = <0>;
+
+ soc@1 {
+ compatible = "airoha,an8855";
+ reg = <1>;
+
+ reset-gpios = <&pio 39 0>;
+
+ efuse {
+ compatible = "airoha,an8855-efuse";
+
+ #nvmem-cell-cells = <0>;
+
+ nvmem-layout {
+ compatible = "fixed-layout";
+ #address-cells = <1>;
+ #size-cells = <1>;
+
+ shift_sel_port0_tx_a: shift-sel-port0-tx-a@c {
+ reg = <0xc 0x4>;
+ };
+
+ shift_sel_port0_tx_b: shift-sel-port0-tx-b@10 {
+ reg = <0x10 0x4>;
+ };
+
+ shift_sel_port0_tx_c: shift-sel-port0-tx-c@14 {
+ reg = <0x14 0x4>;
+ };
+
+ shift_sel_port0_tx_d: shift-sel-port0-tx-d@18 {
+ reg = <0x18 0x4>;
+ };
+
+ shift_sel_port1_tx_a: shift-sel-port1-tx-a@1c {
+ reg = <0x1c 0x4>;
+ };
+
+ shift_sel_port1_tx_b: shift-sel-port1-tx-b@20 {
+ reg = <0x20 0x4>;
+ };
+
+ shift_sel_port1_tx_c: shift-sel-port1-tx-c@24 {
+ reg = <0x24 0x4>;
+ };
+
+ shift_sel_port1_tx_d: shift-sel-port1-tx-d@28 {
+ reg = <0x28 0x4>;
+ };
+ };
+ };
+
+ ethernet-switch {
+ compatible = "airoha,an8855-switch";
+
+ ports {
+ #address-cells = <1>;
+ #size-cells = <0>;
+
+ port@0 {
+ reg = <0>;
+ label = "lan1";
+ phy-mode = "internal";
+ phy-handle = <&internal_phy1>;
+ };
+
+ port@1 {
+ reg = <1>;
+ label = "lan2";
+ phy-mode = "internal";
+ phy-handle = <&internal_phy2>;
+ };
+
+ port@5 {
+ reg = <5>;
+ label = "cpu";
+ ethernet = <&gmac0>;
+ phy-mode = "2500base-x";
+
+ fixed-link {
+ speed = <2500>;
+ full-duplex;
+ pause;
+ };
+ };
+ };
+ };
+
+ mdio {
+ compatible = "airoha,an8855-mdio";
+ #address-cells = <1>;
+ #size-cells = <0>;
+
+ internal_phy1: phy@1 {
+ compatible = "ethernet-phy-idc0ff.0410",
+ "ethernet-phy-ieee802.3-c45";
+ reg = <1>;
+
+ nvmem-cells = <&shift_sel_port0_tx_a>,
+ <&shift_sel_port0_tx_b>,
+ <&shift_sel_port0_tx_c>,
+ <&shift_sel_port0_tx_d>;
+ nvmem-cell-names = "tx_a", "tx_b", "tx_c", "tx_d";
+ };
+
+ internal_phy2: phy@2 {
+ compatible = "ethernet-phy-idc0ff.0410",
+ "ethernet-phy-ieee802.3-c45";
+ reg = <2>;
+
+ nvmem-cells = <&shift_sel_port1_tx_a>,
+ <&shift_sel_port1_tx_b>,
+ <&shift_sel_port1_tx_c>,
+ <&shift_sel_port1_tx_d>;
+ nvmem-cell-names = "tx_a", "tx_b", "tx_c", "tx_d";
+ };
+ };
+ };
+ };
diff --git a/MAINTAINERS b/MAINTAINERS
index 45f4bb8deb0d..65709e47adc7 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -725,6 +725,7 @@ L: linux-arm-kernel@lists.infradead.org (moderated for non-subscribers)
L: linux-mediatek@lists.infradead.org (moderated for non-subscribers)
L: netdev@vger.kernel.org
S: Maintained
+F: Documentation/devicetree/bindings/mfd/airoha,an8855.yaml
F: Documentation/devicetree/bindings/net/airoha,an8855-mdio.yaml
F: Documentation/devicetree/bindings/net/airoha,an8855-phy.yaml
F: Documentation/devicetree/bindings/net/dsa/airoha,an8855-switch.yaml
--
2.48.1On Sat, Mar 15, 2025 at 04:43:45PM +0100, Christian Marangi wrote:
> Document support for Airoha AN8855 Switch SoC. This SoC expose various
> peripherals like an Ethernet Switch, a NVMEM provider and Ethernet PHYs.
>
> It does also support i2c and timers but those are not currently
> supported/used.
>
> Signed-off-by: Christian Marangi <ansuelsmth@gmail.com>
> ---
> .../bindings/mfd/airoha,an8855.yaml | 182 ++++++++++++++++++
> MAINTAINERS | 1 +
> 2 files changed, 183 insertions(+)
> create mode 100644 Documentation/devicetree/bindings/mfd/airoha,an8855.yaml
>
> diff --git a/Documentation/devicetree/bindings/mfd/airoha,an8855.yaml b/Documentation/devicetree/bindings/mfd/airoha,an8855.yaml
> new file mode 100644
> index 000000000000..a59a23056b3a
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/mfd/airoha,an8855.yaml
> @@ -0,0 +1,182 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/mfd/airoha,an8855.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Airoha AN8855 Switch SoC
> +
> +maintainers:
> + - Christian Marangi <ansuelsmth@gmail.com>
> +
> +description: >
> + Airoha AN8855 Switch is a SoC that expose various peripherals like an
> + Ethernet Switch, a NVMEM provider and Ethernet PHYs.
> +
> + It does also support i2c and timers but those are not currently
> + supported/used.
> +
> +properties:
> + compatible:
> + const: airoha,an8855
> +
> + reg:
> + maxItems: 1
> +
> + reset-gpios: true
> +
> + efuse:
> + type: object
> + $ref: /schemas/nvmem/airoha,an8855-efuse.yaml
> + description:
> + EFUSE exposed by the Airoha AN8855 Switch. This child node definition
> + should follow the bindings specified in
> + Documentation/devicetree/bindings/nvmem/airoha,an8855-efuse.yaml
No need to list the schema twice. Drop the 2nd sentence.
> +
> + ethernet-switch:
> + type: object
> + $ref: /schemas/net/dsa/airoha,an8855-switch.yaml
> + description:
> + Switch exposed by the Airoha AN8855 Switch. This child node definition
> + should follow the bindings specified in
> + Documentation/devicetree/bindings/net/dsa/airoha,an8855-switch.yaml
ditto
> +
> + mdio:
> + type: object
> + $ref: /schemas/net/airoha,an8855-mdio.yaml
> + description:
> + MDIO exposed by the Airoha AN8855 Switch. This child node definition
> + should follow the bindings specified in
> + Documentation/devicetree/bindings/net/airoha,an8855-mdio.yaml
ditto
> +
> +required:
> + - compatible
> + - reg
The child nodes are optional?
> +
> +additionalProperties: false
> +
> +examples:
> + - |
> + #include <dt-bindings/gpio/gpio.h>
> +
> + mdio {
> + #address-cells = <1>;
> + #size-cells = <0>;
> +
> + soc@1 {
> + compatible = "airoha,an8855";
> + reg = <1>;
> +
> + reset-gpios = <&pio 39 0>;
> +
> + efuse {
> + compatible = "airoha,an8855-efuse";
> +
> + #nvmem-cell-cells = <0>;
> +
> + nvmem-layout {
> + compatible = "fixed-layout";
> + #address-cells = <1>;
> + #size-cells = <1>;
> +
> + shift_sel_port0_tx_a: shift-sel-port0-tx-a@c {
> + reg = <0xc 0x4>;
> + };
> +
> + shift_sel_port0_tx_b: shift-sel-port0-tx-b@10 {
> + reg = <0x10 0x4>;
> + };
> +
> + shift_sel_port0_tx_c: shift-sel-port0-tx-c@14 {
> + reg = <0x14 0x4>;
> + };
> +
> + shift_sel_port0_tx_d: shift-sel-port0-tx-d@18 {
> + reg = <0x18 0x4>;
> + };
> +
> + shift_sel_port1_tx_a: shift-sel-port1-tx-a@1c {
> + reg = <0x1c 0x4>;
> + };
> +
> + shift_sel_port1_tx_b: shift-sel-port1-tx-b@20 {
> + reg = <0x20 0x4>;
> + };
> +
> + shift_sel_port1_tx_c: shift-sel-port1-tx-c@24 {
> + reg = <0x24 0x4>;
> + };
> +
> + shift_sel_port1_tx_d: shift-sel-port1-tx-d@28 {
> + reg = <0x28 0x4>;
> + };
> + };
> + };
> +
> + ethernet-switch {
> + compatible = "airoha,an8855-switch";
> +
> + ports {
> + #address-cells = <1>;
> + #size-cells = <0>;
> +
> + port@0 {
> + reg = <0>;
> + label = "lan1";
> + phy-mode = "internal";
> + phy-handle = <&internal_phy1>;
> + };
> +
> + port@1 {
> + reg = <1>;
> + label = "lan2";
> + phy-mode = "internal";
> + phy-handle = <&internal_phy2>;
> + };
> +
> + port@5 {
> + reg = <5>;
> + label = "cpu";
> + ethernet = <&gmac0>;
> + phy-mode = "2500base-x";
> +
> + fixed-link {
> + speed = <2500>;
> + full-duplex;
> + pause;
> + };
> + };
> + };
> + };
> +
> + mdio {
> + compatible = "airoha,an8855-mdio";
> + #address-cells = <1>;
> + #size-cells = <0>;
> +
> + internal_phy1: phy@1 {
> + compatible = "ethernet-phy-idc0ff.0410",
> + "ethernet-phy-ieee802.3-c45";
> + reg = <1>;
> +
> + nvmem-cells = <&shift_sel_port0_tx_a>,
> + <&shift_sel_port0_tx_b>,
> + <&shift_sel_port0_tx_c>,
> + <&shift_sel_port0_tx_d>;
> + nvmem-cell-names = "tx_a", "tx_b", "tx_c", "tx_d";
> + };
> +
> + internal_phy2: phy@2 {
> + compatible = "ethernet-phy-idc0ff.0410",
> + "ethernet-phy-ieee802.3-c45";
> + reg = <2>;
> +
> + nvmem-cells = <&shift_sel_port1_tx_a>,
> + <&shift_sel_port1_tx_b>,
> + <&shift_sel_port1_tx_c>,
> + <&shift_sel_port1_tx_d>;
> + nvmem-cell-names = "tx_a", "tx_b", "tx_c", "tx_d";
> + };
> + };
> + };
> + };
> diff --git a/MAINTAINERS b/MAINTAINERS
> index 45f4bb8deb0d..65709e47adc7 100644
> --- a/MAINTAINERS
> +++ b/MAINTAINERS
> @@ -725,6 +725,7 @@ L: linux-arm-kernel@lists.infradead.org (moderated for non-subscribers)
> L: linux-mediatek@lists.infradead.org (moderated for non-subscribers)
> L: netdev@vger.kernel.org
> S: Maintained
> +F: Documentation/devicetree/bindings/mfd/airoha,an8855.yaml
> F: Documentation/devicetree/bindings/net/airoha,an8855-mdio.yaml
> F: Documentation/devicetree/bindings/net/airoha,an8855-phy.yaml
> F: Documentation/devicetree/bindings/net/dsa/airoha,an8855-switch.yaml
> --
> 2.48.1
>
On Sat, 15 Mar 2025 16:43:45 +0100, Christian Marangi wrote:
> Document support for Airoha AN8855 Switch SoC. This SoC expose various
> peripherals like an Ethernet Switch, a NVMEM provider and Ethernet PHYs.
>
> It does also support i2c and timers but those are not currently
> supported/used.
>
> Signed-off-by: Christian Marangi <ansuelsmth@gmail.com>
> ---
> .../bindings/mfd/airoha,an8855.yaml | 182 ++++++++++++++++++
> MAINTAINERS | 1 +
> 2 files changed, 183 insertions(+)
> create mode 100644 Documentation/devicetree/bindings/mfd/airoha,an8855.yaml
>
My bot found errors running 'make dt_binding_check' on your patch:
yamllint warnings/errors:
dtschema/dtc warnings/errors:
/builds/robherring/dt-review-ci/linux/Documentation/devicetree/bindings/mfd/airoha,an8855.example.dtb: phy@1: $nodename:0: 'phy@1' does not match '^ethernet-phy(@[a-f0-9]+)?$'
from schema $id: http://devicetree.org/schemas/net/airoha,an8855-phy.yaml#
/builds/robherring/dt-review-ci/linux/Documentation/devicetree/bindings/mfd/airoha,an8855.example.dtb: phy@1: Unevaluated properties are not allowed ('compatible' was unexpected)
from schema $id: http://devicetree.org/schemas/net/airoha,an8855-phy.yaml#
/builds/robherring/dt-review-ci/linux/Documentation/devicetree/bindings/mfd/airoha,an8855.example.dtb: phy@2: $nodename:0: 'phy@2' does not match '^ethernet-phy(@[a-f0-9]+)?$'
from schema $id: http://devicetree.org/schemas/net/airoha,an8855-phy.yaml#
/builds/robherring/dt-review-ci/linux/Documentation/devicetree/bindings/mfd/airoha,an8855.example.dtb: phy@2: Unevaluated properties are not allowed ('compatible' was unexpected)
from schema $id: http://devicetree.org/schemas/net/airoha,an8855-phy.yaml#
doc reference errors (make refcheckdocs):
See https://patchwork.ozlabs.org/project/devicetree-bindings/patch/20250315154407.26304-6-ansuelsmth@gmail.com
The base for the series is generally the latest rc1. A different dependency
should be noted in *this* patch.
If you already ran 'make dt_binding_check' and didn't see the above
error(s), then make sure 'yamllint' is installed and dt-schema is up to
date:
pip3 install dtschema --upgrade
Please check and re-submit after running the above command yourself. Note
that DT_SCHEMA_FILES can be set to your schema file to speed up checking
your schema. However, it must be unset to test all examples with your schema.
© 2016 - 2025 Red Hat, Inc.