realtek: Add support for ZxXEL XGS1250-12 Switch
authorBirger Koblitz <git@birger-koblitz.de>
Mon, 17 Jan 2022 14:31:43 +0000 (15:31 +0100)
committerDaniel Golle <daniel@makrotopia.org>
Thu, 17 Feb 2022 15:21:47 +0000 (15:21 +0000)
The ZyXEL XGS1250-12 Switch is a 11 + 1 port multi-GBit switch with
8 x 1000BaseT, 3 x 1000/2500/5000/10000BaseT Ethernet ports and
1 SFP+ module slot.

Hardware:
 - RTL9302B SoC
 - Macronix MX25L12833F (16MB flash)
 - Nanja NT5CC64M16GP-1 (128MB DDR3 SDRAM)
 - RTL8231 GPIO extender to control the port LEDs
 - RTL8218D 8x Gigabit PHY
 - Aquantia AQR113c 1/2.5/5/10 Gigabit PHYs
 - SFP+ 10GBit slot

Power is supplied via a 12V 2A standard barrel connector. At the
right side behind the grid is UART serial connector. A Serial
header can be connected to from the outside of the switch trough
the airvents with a standard 2.54mm header.
Pins are from top to bottom Vcc(3.3V), TX, RX and GND. Serial
connection is via 115200 baud, 8N1.

A reset button is accessble through a hole in the front panel

At the time of this commit, all ethernet ports work under OpenWRT,
including the various NBaseT modes, however the 10GBit SFP+ slot is not
supported.

Installation
--------------
* Connect serial as per the layout above. Connection parameters: 115200 8N1.
* Navigate to 'Management' in the OEM web interface and click on 'Firmware upgrade'
  to the left.
* Upload the OpenWrt initramfs image, and wait till the switch reboots.
* Connect to the device through serial and change the U-boot boot command.
  > fw_setenv bootcmd 'rtk network on; boota'
* Reboot, scp the sysupgrade image to /tmp, verify the checksum and flash it:
  > sysupgrade /tmp/openwrt-realtek-rtl930x-zyxel_xgs1250-12-squashfs-sysupgrade.bin
* Upon reboot, you have a functional OpenWrt installation. Leave the bootcmd
  value as is - without 'rtk network on' the switch will fail to initialise
  the network.

Web recovery
------------
The XGS1250-12 has a handy web recovery that will load when U-boot does
not find a bootable kernel. In case you would like to trigger the web
recovery manually, partially overwrite the firmware partition with some
zeroes:

  # dd if=/dev/zero of=/dev/mtd5 bs=1M count=2

If you have serial connected you'll see U-boot will start the web recovery
and print it's listening on 192.168.1.1, but by default it seems to be on
the OEM default IP for the switch - 192.168.1.3. The web recovery only
listens on HTTP (80) and *not* on 443 (HTTPS) unlike the web UI.

Return to stock
---------------
You can flash the ZyXEL firmware images to return to stock:

  # sysupgrade -F -n XGS1250-12_Firmware_V1.00(ABWE.1)C0.bix

Signed-off-by: Birger Koblitz <git@birger-koblitz.de>
target/linux/realtek/dts-5.10/rtl9302_zyxel_xgs1250-12.dts [new file with mode: 0644]
target/linux/realtek/image/rtl930x.mk [new file with mode: 0644]

diff --git a/target/linux/realtek/dts-5.10/rtl9302_zyxel_xgs1250-12.dts b/target/linux/realtek/dts-5.10/rtl9302_zyxel_xgs1250-12.dts
new file mode 100644 (file)
index 0000000..28cace6
--- /dev/null
@@ -0,0 +1,307 @@
+// SPDX-License-Identifier: GPL-2.0-or-later
+/dts-v1/;
+
+#include "rtl930x.dtsi"
+
+#include <dt-bindings/input/input.h>
+#include <dt-bindings/gpio/gpio.h>
+
+/ {
+       compatible = "zyxel,xgs1250-12", "realtek,rtl838x-soc";
+       model = "Zyxel XGS1250-12 Switch";
+
+       chosen {
+               bootargs = "console=ttyS0,115200";
+       };
+
+       keys {
+               compatible = "gpio-keys";
+
+               mode {
+                       label = "reset";
+                       gpios = <&gpio0 22 GPIO_ACTIVE_LOW>;
+                       linux,code = <KEY_RESTART>;
+               };
+       };
+
+       /* i2c of the SFP cage: port 12 */
+       i2c0: i2c-rtl9300 {
+               compatible = "realtek,rtl9300-i2c";
+               reg = <0x1b00036c 0x3c>;
+               #address-cells = <1>;
+               #size-cells = <0>;
+               sda-pin = <10>;
+               scl-pin = <8>;
+               clock-frequency = <100000>;
+       };
+
+
+       sfp0: sfp-p12 {
+               compatible = "sff,sfp";
+               i2c-bus = <&i2c0>;
+               los-gpio = <&gpio0 17 GPIO_ACTIVE_HIGH>;
+               tx-fault-gpio = <&gpio0 20 GPIO_ACTIVE_HIGH>;
+               mod-def0-gpio = <&gpio0 16 GPIO_ACTIVE_LOW>;
+               tx-disable-gpio = <&gpio0 15 GPIO_ACTIVE_HIGH>;
+       };
+
+       led_set: led_set@0 {
+               compatible = "realtek,rtl9300-leds";
+               led_set0 = <0x0000 0xffff 0x0a20 0x0b80>; // LED set 0: 1000Mbps,  10/100Mbps
+               led_set1 = <0x0a0b 0x0a28 0x0a82 0x0a0b>; // LED set 1: (10G, 5G, 2.5G) (2.5G, 1G)
+                                                         // (5G, 10/100) (10G, 5G, 2.5G)
+               led_set2 = <0x0000 0xffff 0x0a20 0x0a01>; // LED set 2: 1000MBit, 10GBit
+       };
+};
+
+&spi0 {
+       status = "okay";
+       flash@0 {
+               compatible = "jedec,spi-nor";
+               reg = <0>;
+               spi-max-frequency = <10000000>;
+
+               partitions {
+                       compatible = "fixed-partitions";
+                       #address-cells = <1>;
+                       #size-cells = <1>;
+
+                       partition@0 {
+                               label = "u-boot";
+                               reg = <0x0 0xe0000>;
+                               read-only;
+                       };
+                       partition@e0000 {
+                               label = "u-boot-env";
+                               reg = <0xe0000 0x10000>;
+                       };
+                       partition@f0000 {
+                               label = "u-boot-env2";
+                               reg = <0xf0000 0x10000>;
+                               read-only;
+                       };
+                       partition@100000 {
+                               label = "jffs";
+                               reg = <0x100000 0x100000>;
+                       };
+                       partition@200000 {
+                               label = "jffs2";
+                               reg = <0x200000 0x100000>;
+                       };
+                       partition@b300000 {
+                               label = "firmware";
+                               reg = <0x300000 0xce0000>;
+                               compatible = "openwrt,uimage", "denx,uimage";
+                               openwrt,ih-magic = <0x93001250>;
+                       };
+                       partition@fe0000 {
+                               label = "log";
+                               reg = <0xfe0000 0x20000>;
+                       };
+               };
+       };
+};
+
+&ethernet0 {
+       mdio: mdio-bus {
+               compatible = "realtek,rtl838x-mdio";
+               regmap = <&ethernet0>;
+               #address-cells = <1>;
+               #size-cells = <0>;
+
+               /* External RTL8218D PHY */
+               phy0: ethernet-phy@0 {
+                       reg = <0>;
+                       compatible = "ethernet-phy-ieee802.3-c22";
+                       rtl9300,smi-address = <0 0>;
+                       sds = < 2 >;
+                       // Disabled because we do not know how to bring up again
+                       // reset-gpios = <&gpio0 21 GPIO_ACTIVE_LOW>;
+               };
+               phy1: ethernet-phy@1 {
+                       reg = <1>;
+                       compatible = "ethernet-phy-ieee802.3-c22";
+                       rtl9300,smi-address = <0 1>;
+               };
+               phy2: ethernet-phy@2 {
+                       reg = <2>;
+                       compatible = "ethernet-phy-ieee802.3-c22";
+                       rtl9300,smi-address = <0 2>;
+               };
+               phy3: ethernet-phy@3 {
+                       reg = <3>;
+                       compatible = "ethernet-phy-ieee802.3-c22";
+                       rtl9300,smi-address = <0 3>;
+               };
+               phy4: ethernet-phy@4 {
+                       reg = <4>;
+                       compatible = "ethernet-phy-ieee802.3-c22";
+                       rtl9300,smi-address = <0 4>;
+               };
+               phy5: ethernet-phy@5 {
+                       reg = <5>;
+                       compatible = "ethernet-phy-ieee802.3-c22";
+                       rtl9300,smi-address = <0 5>;
+               };
+               phy6: ethernet-phy@6 {
+                       reg = <6>;
+                       compatible = "ethernet-phy-ieee802.3-c22";
+                       rtl9300,smi-address = <0 6>;
+               };
+               phy7: ethernet-phy@7 {
+                       reg = <7>;
+                       compatible = "ethernet-phy-ieee802.3-c22";
+                       rtl9300,smi-address = <0 7>;
+               };
+
+               /* External Aquantia 113C PHYs */
+               phy24: ethernet-phy@24 {
+                       reg = <24>;
+                       compatible = "ethernet-phy-ieee802.3-c45";
+                       rtl9300,smi-address = <1 8>;
+                       sds = < 6 >;
+                       // Disabled because we do not know how to bring up again
+                       // reset-gpios = <&gpio0 21 GPIO_ACTIVE_LOW>;
+               };
+
+               phy25: ethernet-phy@25 {
+                       reg = <25>;
+                       compatible = "ethernet-phy-ieee802.3-c45";
+                       rtl9300,smi-address = <2 8>;
+                       sds = < 7 >;
+                       // Disabled because we do not know how to bring up again
+                       // reset-gpios = <&gpio0 21 GPIO_ACTIVE_LOW>;
+               };
+
+               phy26: ethernet-phy@26 {
+                       reg = <26>;
+                       compatible = "ethernet-phy-ieee802.3-c45";
+                       rtl9300,smi-address = <3 8>;
+                       sds = < 8 >;
+                       // Disabled because we do not know how to bring up again
+                       // reset-gpios = <&gpio0 21 GPIO_ACTIVE_LOW>;
+               };
+
+               /* SFP Ports */
+               phy27: ethernet-phy@27 {
+                       compatible = "ethernet-phy-ieee802.3-c22";
+                       phy-is-integrated;
+                       reg = <27>;
+                       rtl9300,smi-address = <4 0>;
+                       sds = < 9 >;
+               };
+
+       };
+};
+
+&switch0 {
+       ports {
+               #address-cells = <1>;
+               #size-cells = <0>;
+
+               port@0 {
+                       reg = <0>;
+                       label = "lan1";
+                       phy-handle = <&phy0>;
+                       phy-mode = "xgmii";
+                       led-set = <0>;
+               };
+               port@1 {
+                       reg = <1>;
+                       label = "lan2";
+                       phy-handle = <&phy1>;
+                       phy-mode = "xgmii";
+                       led-set = <0>;
+               };
+               port@2 {
+                       reg = <2>;
+                       label = "lan3";
+                       phy-handle = <&phy2>;
+                       phy-mode = "xgmii";
+                       led-set = <0>;
+               };
+               port@3 {
+                       reg = <3>;
+                       label = "lan4";
+                       phy-handle = <&phy3>;
+                       phy-mode = "xgmii";
+                       led-set = <0>;
+               };
+               port@4 {
+                       reg = <4>;
+                       label = "lan5";
+                       phy-handle = <&phy4>;
+                       phy-mode = "xgmii";
+                       led-set = <0>;
+               };
+               port@5 {
+                       reg = <5>;
+                       label = "lan6";
+                       phy-handle = <&phy5>;
+                       phy-mode = "xgmii";
+                       led-set = <0>;
+               };
+               port@6 {
+                       reg = <6>;
+                       label = "lan7";
+                       phy-handle = <&phy6>;
+                       phy-mode = "xgmii";
+                       led-set = <0>;
+               };
+               port@7 {
+                       reg = <7>;
+                       label = "lan8";
+                       phy-handle = <&phy7>;
+                       phy-mode = "xgmii";
+                       led-set = <0>;
+               };
+
+               port@24 {
+                       reg = <24>;
+                       label = "lan9";
+                       phy-mode = "usxgmii";
+                       phy-handle = <&phy24>;
+                       led-set = <1>;
+               };
+               port@25 {
+                       reg = <25>;
+                       label = "lan10";
+                       phy-mode = "usxgmii";
+                       phy-handle = <&phy25>;
+                       led-set = <1>;
+               };
+               port@26 {
+                       reg = <26>;
+                       label = "lan11";
+                       phy-mode = "usxgmii";
+                       phy-handle = <&phy26>;
+                       led-set = <1>;
+               };
+
+               port@27 {
+                       reg = <27>;
+                       label = "lan12";
+                       phy-mode = "10gbase-r";
+                       phy-handle = <&phy27>;
+                       sfp = <&sfp0>;
+                       led-set = <2>;
+
+                       fixed-link {
+                               speed = <10000>;
+                               full-duplex;
+                               pause;
+                       };
+
+               };
+
+               port@28 {
+                       ethernet = <&ethernet0>;
+                       reg = <28>;
+                       phy-mode = "internal";
+                       fixed-link {
+                               speed = <10000>;
+                               full-duplex;
+                       };
+               };
+       };
+};
diff --git a/target/linux/realtek/image/rtl930x.mk b/target/linux/realtek/image/rtl930x.mk
new file mode 100644 (file)
index 0000000..191ea5b
--- /dev/null
@@ -0,0 +1,14 @@
+# SPDX-License-Identifier: GPL-2.0-only
+
+define Device/zyxel_xgs1250-12
+  SOC := rtl9302
+  UIMAGE_MAGIC := 0x93001250
+  ZYXEL_VERS := ABWE
+  DEVICE_VENDOR := Zyxel
+  DEVICE_MODEL := XGS1250-12
+    IMAGE_SIZE := 13312k
+  KERNEL_INITRAMFS := kernel-bin | append-dtb | gzip | zyxel-vers $$$$(ZYXEL_VERS) | \
+       uImage gzip
+endef
+
+TARGET_DEVICES += zyxel_xgs1250-12