[net-next RFC PATCH v2 1/3] dt-bindings: net: dsa: Add Airoha AN8855 Gigabit Switch documentation
Rob Herring
robh at kernel.org
Thu Oct 24 08:23:05 PDT 2024
On Wed, Oct 23, 2024 at 06:19:50PM +0200, Christian Marangi wrote:
> Add Airoha AN8855 5 port Gigabit Switch documentation.
>
> The switch node requires an additional mdio node to describe each internal
> PHY relative offset as the PHY address for the switch match the one for
> the PHY ports. On top of internal PHY address, the switch base PHY address
> is added.
>
> Also the switch base PHY address can be configured and changed after the
> first initialization. On reset, the switch PHY address is ALWAYS 1.
> This can be configured with the use of "airoha,base_smi_address".
>
> Calibration values might be stored in switch EFUSE and internal PHY
> might need to be calibrated, in such case, airoha,ext_surge needs to be
> enabled and relative NVMEM cells needs to be defined in nvmem-layout
> node.
>
> Signed-off-by: Christian Marangi <ansuelsmth at gmail.com>
> ---
> .../bindings/net/dsa/airoha,an8855.yaml | 253 ++++++++++++++++++
> 1 file changed, 253 insertions(+)
> create mode 100644 Documentation/devicetree/bindings/net/dsa/airoha,an8855.yaml
>
> diff --git a/Documentation/devicetree/bindings/net/dsa/airoha,an8855.yaml b/Documentation/devicetree/bindings/net/dsa/airoha,an8855.yaml
> new file mode 100644
> index 000000000000..5982b4c39536
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/net/dsa/airoha,an8855.yaml
> @@ -0,0 +1,253 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/net/dsa/airoha,an8855.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Airoha AN8855 Gigabit switch
> +
> +maintainers:
> + - Christian Marangi <ansuelsmth at gmail.com>
> +
> +description:
You need '>' to preserve paragraphs.
> + Airoha AN8855 is a 5-port Gigabit Switch.
> +
> + The switch node requires an additional mdio node to describe each internal
> + PHY relative offset as the PHY address for the switch match the one for
> + the PHY ports. On top of internal PHY address, the switch base PHY address
> + is added.
> +
> + Also the switch base PHY address can be configured and changed after the
> + first initialization. On reset, the switch PHY address is ALWAYS 1.
> +
> +properties:
> + compatible:
> + const: airoha,an8855
> +
> + reg:
> + maxItems: 1
> +
> + reset-gpios:
> + description:
> + GPIO to be used to reset the whole device
> + maxItems: 1
> +
> + airoha,base_smi_address:
s/_/-/
> + $ref: /schemas/types.yaml#/definitions/uint32
> + description:
> + Configure and change the base switch PHY address to a new address on
> + the bus.
> + On reset, the switch PHY address is ALWAYS 1.
The paragraphs here won't be maintained without '>' and a blank line in
between.
Or just move the 2nd sentence up to follow the first one.
> + default: 1
> + maximum: 31
> +
> + airoha,ext_surge:
ditto.
> + $ref: /schemas/types.yaml#/definitions/flag
> + description:
> + Calibrate the internal PHY with the calibration values stored in EFUSE
> + for the r50Ohm values.
> +
> + '#nvmem-cell-cells':
> + const: 0
> +
> + nvmem-layout:
> + $ref: /schemas/nvmem/layouts/nvmem-layout.yaml
> + description:
> + NVMEM Layout for exposed EFUSE. (for example to propagate calibration
> + value for r50Ohm for internal PHYs)
> +
> + mdio:
> + $ref: /schemas/net/mdio.yaml#
> + unevaluatedProperties: false
> + description:
> + Define the relative address of the internal PHY for each port.
> +
> + Each reg for the PHY is relative to the switch base PHY address.
> +
> +$ref: dsa.yaml#
> +
> +required:
> + - compatible
> + - reg
> +
> +unevaluatedProperties: false
> +
> +examples:
> + - |
> + #include <dt-bindings/gpio/gpio.h>
> +
> + mdio {
> + #address-cells = <1>;
> + #size-cells = <0>;
> +
> + switch at 1 {
> + compatible = "airoha,an8855";
> + reg = <1>;
> + reset-gpios = <&pio 39 0>;
> +
> + airoha,ext_surge;
> +
> + #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 at c {
> + reg = <0xc 0x4>;
> + };
> +
> + shift_sel_port0_tx_b: shift-sel-port0-tx-b at 10 {
> + reg = <0x10 0x4>;
> + };
> +
> + shift_sel_port0_tx_c: shift-sel-port0-tx-c at 14 {
> + reg = <0x14 0x4>;
> + };
> +
> + shift_sel_port0_tx_d: shift-sel-port0-tx-d at 18 {
> + reg = <0x18 0x4>;
> + };
> +
> + shift_sel_port1_tx_a: shift-sel-port1-tx-a at 1c {
> + reg = <0x1c 0x4>;
> + };
> +
> + shift_sel_port1_tx_b: shift-sel-port1-tx-b at 20 {
> + reg = <0x20 0x4>;
> + };
> +
> + shift_sel_port1_tx_c: shift-sel-port1-tx-c at 24 {
> + reg = <0x24 0x4>;
> + };
> +
> + shift_sel_port1_tx_d: shift-sel-port1-tx-d at 28 {
> + reg = <0x28 0x4>;
> + };
> +
> + shift_sel_port2_tx_a: shift-sel-port2-tx-a at 2c {
> + reg = <0x2c 0x4>;
> + };
> +
> + shift_sel_port2_tx_b: shift-sel-port2-tx-b at 30 {
> + reg = <0x30 0x4>;
> + };
> +
> + shift_sel_port2_tx_c: shift-sel-port2-tx-c at 34 {
> + reg = <0x34 0x4>;
> + };
> +
> + shift_sel_port2_tx_d: shift-sel-port2-tx-d at 38 {
> + reg = <0x38 0x4>;
> + };
> +
> + shift_sel_port3_tx_a: shift-sel-port3-tx-a at 4c {
> + reg = <0x4c 0x4>;
> + };
> +
> + shift_sel_port3_tx_b: shift-sel-port3-tx-b at 50 {
> + reg = <0x50 0x4>;
> + };
> +
> + shift_sel_port3_tx_c: shift-sel-port3-tx-c at 54 {
> + reg = <0x54 0x4>;
> + };
> +
> + shift_sel_port3_tx_d: shift-sel-port3-tx-d at 58 {
> + reg = <0x58 0x4>;
> + };
> + };
> +
> + ports {
> + #address-cells = <1>;
> + #size-cells = <0>;
> +
> + port at 0 {
> + reg = <0>;
> + label = "lan1";
> + phy-mode = "internal";
> + phy-handle = <&internal_phy0>;
> + };
> +
> + port at 1 {
> + reg = <1>;
> + label = "lan2";
> + phy-mode = "internal";
> + phy-handle = <&internal_phy1>;
> + };
> +
> + port at 2 {
> + reg = <2>;
> + label = "lan3";
> + phy-mode = "internal";
> + phy-handle = <&internal_phy2>;
> + };
> +
> + port at 3 {
> + reg = <3>;
> + label = "lan4";
> + phy-mode = "internal";
> + phy-handle = <&internal_phy3>;
> + };
> +
> + port at 5 {
> + reg = <5>;
> + label = "cpu";
> + ethernet = <&gmac0>;
> + phy-mode = "2500base-x";
> +
> + fixed-link {
> + speed = <2500>;
> + full-duplex;
> + pause;
> + };
> + };
> + };
> +
> + mdio {
> + #address-cells = <1>;
> + #size-cells = <0>;
> +
> + internal_phy0: phy at 0 {
> + reg = <0>;
> +
> + 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_phy1: phy at 1 {
> + reg = <1>;
> +
> + 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";
> + };
> +
> + internal_phy2: phy at 2 {
> + reg = <2>;
> +
> + nvmem-cells = <&shift_sel_port2_tx_a>,
> + <&shift_sel_port2_tx_b>,
> + <&shift_sel_port2_tx_c>,
> + <&shift_sel_port2_tx_d>;
> + nvmem-cell-names = "tx_a", "tx_b", "tx_c", "tx_d";
> + };
> +
> + internal_phy3: phy at 3 {
> + reg = <3>;
> +
> + nvmem-cells = <&shift_sel_port3_tx_a>,
> + <&shift_sel_port3_tx_b>,
> + <&shift_sel_port3_tx_c>,
> + <&shift_sel_port3_tx_d>;
> + nvmem-cell-names = "tx_a", "tx_b", "tx_c", "tx_d";
> + };
> + };
> + };
> + };
> --
> 2.45.2
>
More information about the Linux-mediatek
mailing list