4 Microchip EVB-KSZ9563 on SAMA5D3 EDS

KSZ9563 Plug-in Evaluation Board (EVB-KSZ9563) on SAMA5D3 Ethernet Development System (DM320114)

Contents

4.1 Board Overview

The EVB-KSZ9563 Evaluation Board is a plug-in card that interfaces directly with a mating Microchip host processor or controller board, such as the SAMA5D3 Ethernet Development System Board. It features the KSZ9563, a highly integrated networking device that incorporates a layer-2+ managed Gigabit Ethernet switch, two 10BASE-T/100BASE-TX/1000BASE-T physical layer transceivers (PHYs) and associated MAC units, and one MAC port configured as the RGMII interface. The board’s two PHY ports are connected to RJ45 Ethernet jacks with integrated magnetics, and the RGMII MAC interface is brought out to a high-speed multi-pin (HS) connector.

Together, the EVB-KSZ9563 and SAMA5D3 Ethernet Development System (EDS) provide a highly-flexible platform for evaluation of basic PHY/Switch features via static Control-Status Registers (CSR’s) and development of firmware for advanced MAC/Switch features that require interaction with upper network layers (e.g., IEEE1588 PTP, AVB, and RSTP/MSTP).

The Microchip SAMA5D3 Ethernet Development System board (EDS) board is an MPU-based platform for evaluating Ethernet switch and PHY products. Compatible switch and PHY evaluation boards connect to the EDS board via either an RGMII connector or an RMII connector. These daughter boards are available separately. The EDS board is not intended for stand-alone use and has no Ethernet capabilities when no daughter board is connected.

Fig. 4.1 EVB-KSZ9563 on SAMA5D3 EDS Interfaces and Connectors

4.1.1 Block Diagram

Fig. 4.2 EVB-KSZ9563 Block Diagram

Fig. 4.3 SAMA5D3 EDS Block Diagram

4.1.2 Photos

Fig. 4.4 EVB-KSZ9563 Top View

Fig. 4.5 EVB-KSZ9563 Bottom View

Fig. 4.6 SAMA5D3 EDS Angled View

4.1.3 Specification

Table 4.1 EVB-KSZ9563 on SAMA5D3 EDS Specification

Model	EVB-KSZ9563 on SAMA5D3 EDS
Processor	Atmel SAMA5D36 (324-ball BGA package) 1 × ARM Cortex-A5 with v7-A Thumb®-2 instruction set frequency up to 536 MHz
Memory	256 MiB DDR2 SDRAM
Storage	Full-size SD card slot 256 MiB NAND flash
Debug	JTAG interface to program and debug the MPU (20-pin header) 1 × Serial communication (6-pin header)
USB	2 × USB 2.0 Host 1 × Micro-AB USB Device
Ethernet (SAMA5D3 EDS)	1 × Gigabit MAC with RGMII interface 1 × 10/100 Mbit MAC with RMII interface
Ethernet (EVB-KSZ9563)	2 × Gigabit Ethernet PHYs
User Interface	1 × Reset push button LEDs for power, reset USB and NAND flash disable
Expansion Interface	8 × 2 GPIO header with two-wire, SPI and audio 1 × 6 GPIO header with USART
Power Source	DC Jack
Power	12V/500mA DC input jack

4.2 Build Targets

4.2.1 Machines

Table 4.2 Supported Machines

Board[1]	Target YAML[2]	Machine[3]	Target Recipe(s)[4]	Running Media[5]	Installation Media[6]
EVB-KSZ9563 on SAMA5D3 EDS	evb-ksz9563-sd.yml	evb-ksz9563-sd	tanowrt-image-full-swu	SD card	–
	evb-ksz9563-nand.yml	evb-ksz9563-nand	tanowrt-image-full-swu-factory	internal NAND	SD card

[1]

Target board.

[2]

Target YAML-file located in the kas/targets directory.

[3]

Target machine name stored in the MACHINE BitBake variable for selected Target YAML.

[4]

Recipes that will be built by default for the target. In Section 4.2.2, you can find list of supported recipes for the target images, which you can build in addition to the default recipes using optional --target option in build command (see Section 4.3).

[5]

External or internal data storage where the TanoWrt operating system is running.

[6]

External storage device for which an installation image is generated. When booting from the Installation Media, the TanoWrt system is installed on the Running Media storage.

4.2.2 Images

Table 4.3 Supported Images

Read-Only Root Filesystem Image	Recipe[7]	Supported by Target(s)	Description
tanowrt-image-full	tanowrt-image-full	All	Standard TanoWrt image.
	tanowrt-image-full-swu	All	Standard TanoWrt image and firmware upgrade image. When building this image, tanowrt-image-full will also be built as dependency.
	tanowrt-image-full-swu-factory	evb-ksz9563-nand.yml	Factory installation image for standard TanoWrt image. When building this image, tanowrt-image-full and tanowrt-image-full-swu will also be built as dependencies.

[7]

Image recipe name. This name can be used as argument for --target build command option (see Section 4.3 section).

4.3 Build

Please read the common information on how to perform a TanoWrt images build and preparing the build environment in section “Building TanoWrt”.

See also

• See section Section 4.2.1 to select the required target YAML file (<target-yml>).

• See section Section 4.2.2 to select the required root filesystem image recipe (<target-recipe>).

• See section Section 4.5 for detailed information about the produced build artifacts.

4.3.1 Examples

4.3.1.1 Build Default Images for EVB-KSZ9563 on SAMA5D3 EDS Board

For SD Card

$ kas build targets/kas/evb-ksz9563-sd.yml

Default images will be produced to boot and run from the SD card on the EVB-KSZ9563 on SAMA5D3 EDS target board.

For Internal NAND Flash

$ kas build targets/kas/evb-ksz9563-nand.yml

An initial factory installation image will be generated, intended to run from the SD card. The installer image will install the default image to the internal NAND flash memory and further the EVB-KSZ9563 on SAMA5D3 EDS board will boot and run from the NAND flash memory.

4.4 Partitioning Layouts

4.4.1 SD Card

The partitioning and data layout of the SD card image for the EVB-KSZ9563 on SAMA5D3 EDS board are shown in the figure below.

Fig. 4.7 EVB-KSZ9563 on SAMA5D3 EDS Partitions Layout for SD Card

4.4.2 NAND

The partitioning and data layout of the NAND image for the EVB-KSZ9563 on SAMA5D3 EDS board are shown in the figure below.

Fig. 4.8 EVB-KSZ9563 on SAMA5D3 EDS Partitions Layout for NAND

4.5 Produced Build Artifacts

All produced build artifacts are stored in the ~/tanowrt/build/tanowrt-glibc/deploy/images/<MACHINE> directory. Refer to table Produced Build Artifacts for a description of some common (not all) build artifacts.

Table 4.4 Produced Build Artifacts

Artifact	Target(s)	Description
Bootloader (AT91Bootstrap)
at91bootstrap.bin-sdcard	All	AT91Bootstrap binary for SD card images.
at91bootstrap.bin-nand	evb-ksz9477-nand.yml	AT91Bootstrap binary for NAND flash images.
Bootloader (U-Boot)
startup-<MACHINE>.img	All	U-Boot startup script.
startup-factory-<MACHINE>.img	evb-ksz9477-nand.yml	U-Boot startup script for factory installation image.
u-boot-initial-env-<MACHINE>-sdcard	All	U-Boot initial environment image for SD card image.
u-boot-initial-env-<MACHINE>-nand	evb-ksz9477-nand.yml	U-Boot initial environment image for internal NAND flash.
u-boot-<MACHINE>.bin-sdcard	All	U-Boot binary image for booting from SD card.
u-boot-<MACHINE>.bin-nand	evb-ksz9477-nand.yml	U-Boot binary image for booting from internal NAND flash.
Linux Kernel and DTB
fitImage-<MACHINE>.bin	All	Flattened Image Tree (FIT) image with Linux kernel and Device Tree Blobs (DTB).
fitImage-<MACHINE>.ext4	All	FIT image packed into an ext4 file system image.
at91-evb-ksz9563.dtb	All	Target Device Tree Blob (DTB).
fitImage-tanowrt-image-initramfs-swu-factory-<MACHINE>.ext4	evb-ksz9477-nand.yml	FIT image for SWU factory installation image with initramfs image.
Images
<rootfs-image>-<MACHINE>.sdcard.img	evb-ksz9477-sd.yml	SD card image including all required partitions for booting and running the system. This image is ready to be written to the SD card using the dd utility or similar (see Writing Images).
<rootfs-image>-swu-factory-<MACHINE>.sdcard.img	evb-ksz9477-nand.yml	SD card factory installation image. This image is ready to be written to the SD card using the dd utility or similar (see Writing Images).
tanowrt-image-initramfs-swu-factory-<MACHINE>.cpio.gz	evb-ksz9477-nand.yml	Root filesystem initramfs image for factory installtion image. This image is included in fitImage-tanowrt-image-initramfs-swu-factory-<MACHINE>.ext4.
<rootfs-image>-<MACHINE>.squashfs-lzo	All	Root filesystem image (squashfs with LZO compression).
<rootfs-image>-swu-<MACHINE>.swu	All	Firmware upgrade image.

Note

<MACHINE> in the artifacts path and artifact file names are replaced by the actual value of the MACHINE BitBake variable for the chosen target. <rootfs-image> is replaced by the actual read-only root filesystem image name.

For example, below is the lists of artifacts produced by the evb-ksz9563-nand.yml and evb-ksz9563-sd.yml target builds. There are two types of listings here — a complete listing, and a reduced listing without the symbolic links display.

4.5.1 Build Artifacts Listings for evb-ksz9563-sd.yml Target

ReducedComplete

[~/tanowrt/build/tanowrt-glibc/deploy/images/evb-ksz9563-sd]$ ls -gGh | grep -v -e "^l"
total 135M
-rwxr-xr-x 2  20K Jul 27 17:54 at91bootstrap.bin-sdcard
-rw-r--r-- 2  50K Jul 27 17:55 at91-evb-ksz9563--4.19.78+git0+046113c438+ksz2-tano0.2.20.20.0.1-evb-ksz9563-sd-20220727145300.dtb
-rw-r--r-- 2 4.5M Jul 27 17:55 fitImage--4.19.78+git0+046113c438+ksz2-tano0.2.20.20.0.1-evb-ksz9563-sd-20220727145300.bin
-rw-r--r-- 2 6.4M Jul 27 17:55 fitImage-4.19.78+gitAUTOINC+046113c438+ksz2-tano0.2.20.20.0.1-evb-ksz9563-sd.ext4
-rw-r--r-- 2 6.4M Jul 27 17:55 fitImage-evb-ksz9563-sd.ext4
-rw-r--r-- 2 1.6K Jul 27 17:55 fitImage-its--4.19.78+git0+046113c438+ksz2-tano0.2.20.20.0.1-evb-ksz9563-sd-20220727145300.its
-rw-r--r-- 2 4.4M Jul 27 17:55 fitImage-linux.bin--4.19.78+git0+046113c438+ksz2-tano0.2.20.20.0.1-evb-ksz9563-sd-20220727145300.bin
-rw-r--r-- 2 2.0M Jul 27 17:55 modules--4.19.78+git0+046113c438+ksz2-tano0.2.20.20.0.1-evb-ksz9563-sd-20220727145300.tgz
drwxr-xr-x 7  260 Jul 27 16:28 sam-ba
-rw-r--r-- 2  771 Jul 27 17:54 startup-factory.img
-rw-r--r-- 2   12 Jul 27 17:54 startup-factory.img.version
-rw-r--r-- 2 2.0K Jul 27 17:54 startup.img
-rw-r--r-- 2   12 Jul 27 17:54 startup.img.version
-rw-r--r-- 2 5.3K Jul 27 17:57 tanowrt-image-full.env
-rw-r--r-- 2  63K Jul 27 17:56 tanowrt-image-full-evb-ksz9563-sd-20220727145300.rootfs.manifest
-rw-r--r-- 2 940M Jul 27 17:57 tanowrt-image-full-evb-ksz9563-sd-20220727145300.rootfs.sdcard.img
-rw-r--r-- 2  24M Jul 27 17:57 tanowrt-image-full-evb-ksz9563-sd-20220727145300.rootfs.squashfs-lzo
-rw-r--r-- 2   24 Jul 27 17:57 tanowrt-image-full-evb-ksz9563-sd-20220727145300.rootfs.version
-rw-r--r-- 2 374K Jul 27 17:56 tanowrt-image-full-evb-ksz9563-sd-20220727145300.testdata.json
-rw-r--r-- 2 2.6K Jul 27 17:57 tanowrt-image-full-sdimage-at91-swu-a-b.wks
-rw-r--r-- 2  31M Jul 27 17:57 tanowrt-image-full-swu-evb-ksz9563-sd-20220727145300.swu
-rw-r--r-- 2  192 Jul 27 17:53 u-boot-initial-env-evb-ksz9563-sd-sdcard-v2020.01-at91+gitAUTOINC+af59b26c22-tano0.0
-rw-r--r-- 2 128K Jul 27 17:53 u-boot-initial-env-evb-ksz9563-sd-sdcard-v2020.01-at91+gitAUTOINC+af59b26c22-tano0.0.bin
-rw-r--r-- 2 719K Jul 27 17:53 u-boot-sdcard-v2020.01-at91+gitAUTOINC+af59b26c22-tano0.0.bin

4.5.2 Build Artifacts Listings for evb-ksz9563-nand.yml Target

ReducedComplete

[~/tanowrt/build/tanowrt-glibc/deploy/images/evb-ksz9563-nand]$ ls -gGh | grep -v -e "^l"
total 123M
-rwxr-xr-x 2  15K Jul 27 17:47 at91bootstrap.bin-nand
-rw-r--r-- 2  16K Jul 27 17:47 at91bootstrap.bin-nand-pmecc
-rwxr-xr-x 2  20K Jul 27 17:47 at91bootstrap.bin-sdcard
-rw-r--r-- 2  20K Jul 27 17:47 at91bootstrap.bin-sdcard-pmecc
-rw-r--r-- 2  50K Jul 27 17:50 at91-evb-ksz9563--4.19.78+git0+046113c438+ksz2-tano0.2.20.20.0.1-evb-ksz9563-nand-20220727144635.dtb
-rw-r--r-- 2 4.5M Jul 27 17:50 fitImage--4.19.78+git0+046113c438+ksz2-tano0.2.20.20.0.1-evb-ksz9563-nand-20220727144635.bin
-rw-r--r-- 2 1.6K Jul 27 17:50 fitImage-its--4.19.78+git0+046113c438+ksz2-tano0.2.20.20.0.1-evb-ksz9563-nand-20220727144635.its
-rw-r--r-- 2 2.3K Jul 27 17:50 fitImage-its-tanowrt-image-initramfs-swu-factory-evb-ksz9563-nand--4.19.78+git0+046113c438+ksz2-tano0.2.20.20.0.1-evb-ksz9563-nand-20220727144635.its
-rw-r--r-- 2 4.4M Jul 27 17:50 fitImage-linux.bin--4.19.78+git0+046113c438+ksz2-tano0.2.20.20.0.1-evb-ksz9563-nand-20220727144635.bin
-rw-r--r-- 2  12M Jul 27 17:50 fitImage-tanowrt-image-initramfs-swu-factory-evb-ksz9563-nand--4.19.78+git0+046113c438+ksz2-tano0.2.20.20.0.1-evb-ksz9563-nand-20220727144635.bin
-rw-r--r-- 2 2.0M Jul 27 17:50 modules--4.19.78+git0+046113c438+ksz2-tano0.2.20.20.0.1-evb-ksz9563-nand-20220727144635.tgz
drwxr-xr-x 7  260 Jul 27 16:28 sam-ba
-rw-r--r-- 2  846 Jul 27 17:47 startup-factory.img
-rw-r--r-- 2   12 Jul 27 17:47 startup-factory.img.version
-rw-r--r-- 2 2.2K Jul 27 17:47 startup.img
-rw-r--r-- 2   12 Jul 27 17:47 startup.img.version
-rw-r--r-- 2  64K Jul 27 17:50 tanowrt-image-full-evb-ksz9563-nand-20220727144635.rootfs.manifest
-rw-r--r-- 2  23M Jul 27 17:50 tanowrt-image-full-evb-ksz9563-nand-20220727144635.rootfs.squashfs-lzo
-rw-r--r-- 2   24 Jul 27 17:51 tanowrt-image-full-evb-ksz9563-nand-20220727144635.rootfs.version
-rw-r--r-- 2 374K Jul 27 17:50 tanowrt-image-full-evb-ksz9563-nand-20220727144635.testdata.json
-rw-r--r-- 2  29M Jul 27 17:51 tanowrt-image-full-swu-evb-ksz9563-nand-20220727144635.swu
-rw-r--r-- 2 5.9K Jul 27 17:49 tanowrt-image-full-swu-factory.env
-rw-r--r-- 2  42M Jul 27 17:51 tanowrt-image-full-swu-factory-evb-ksz9563-nand-20220727144635.sdcard.img
-rw-r--r-- 2  778 Jul 27 17:49 tanowrt-image-full-swu-factory-sdimage-at91-swu-factory.wks
-rw-r--r-- 2 6.6M Jul 27 17:50 tanowrt-image-initramfs-swu-factory-evb-ksz9563-nand-20220727144635.rootfs.cpio.gz
-rw-r--r-- 2 3.3K Jul 27 17:50 tanowrt-image-initramfs-swu-factory-evb-ksz9563-nand-20220727144635.rootfs.manifest
-rw-r--r-- 2   24 Jul 27 17:50 tanowrt-image-initramfs-swu-factory-evb-ksz9563-nand-20220727144635.rootfs.version
-rw-r--r-- 2 381K Jul 27 17:50 tanowrt-image-initramfs-swu-factory-evb-ksz9563-nand-20220727144635.testdata.json
-rw-r--r-- 2  187 Jul 27 17:47 u-boot-initial-env-evb-ksz9563-nand-nand-v2020.01-at91+gitAUTOINC+af59b26c22-tano0.0
-rw-r--r-- 2 128K Jul 27 17:47 u-boot-initial-env-evb-ksz9563-nand-nand-v2020.01-at91+gitAUTOINC+af59b26c22-tano0.0.bin
-rw-r--r-- 2  192 Jul 27 17:47 u-boot-initial-env-evb-ksz9563-nand-sdcard-v2020.01-at91+gitAUTOINC+af59b26c22-tano0.0
-rw-r--r-- 2 128K Jul 27 17:47 u-boot-initial-env-evb-ksz9563-nand-sdcard-v2020.01-at91+gitAUTOINC+af59b26c22-tano0.0.bin
-rw-r--r-- 2 727K Jul 27 17:47 u-boot-nand-v2020.01-at91+gitAUTOINC+af59b26c22-tano0.0.bin
-rw-r--r-- 2 719K Jul 27 17:47 u-boot-sdcard-v2020.01-at91+gitAUTOINC+af59b26c22-tano0.0.bin

4.6 Writing Images

4.6.1 Writing Image to SD Card

No special information about writing images to SD card for EVB-KSZ9563 on SAMA5D3 EDS board. See common instructions in Writing Images to SD Card or USB Flash Drive section.

Examples

Writing factory installation image for the evb-ksz9563-nand.yml target to the SD card /dev/mmcblk1:

$ dd if=tanowrt-image-full-swu-factory-evb-ksz9563-nand.sdcard.img of=/dev/mmcblk1

Writing bootable card image for the evb-ksz9563-sd.yml target to the SD card /dev/mmcblk1:

$ dd if=tanowrt-image-full-evb-ksz9563-sd.sdcard.img of=/dev/mmcblk1

4.6.2 Writing Image to NAND Flash

For the initial flashing of the internal NAND memory it is recommended to use the special image of the initial factory installation. If you choose a build target (see Build Targets for details) that assumes using the factory installation image for the initial flashing of the device, a factory installation image (<rootfs-image>-swu-factory-<MACHINE>.sdcard.img) will be automatically generated during the build process (see Build). To write the factory installation image to a SD card, follow the instructions from Writing Images to SD Card or USB Flash Drive section.

When you boot device from the prepaired SD card with factory installation image the installation of TanoWrt to the internal NAND flash memory will be done automatically. The detailed installation log is available on the debug UART. After the installation is complete, the board will power off automatically. You need to remove SD card with the installation image and power on the board. When the board boots up, the installed system will be booted from the internal NAND flash memory.

Caution

Be aware that during the installation all existing data on the internal NAND flash memory will be permanently lost.

4.7 Booting and Running

4.7.1 Configuring Boot Mode

The SAMA5D3 Ethernet Development System board does not have any switches or jumpers for selecting the boot source. By default, booting is performed from the SD card. If booting from an SD card fails, NAND flash memory is used for booting.

4.7.2 Hardware Configuration

Ensure that the J20 (NAND Enable) jumper on SAMA5D3 EDS board is shorted (this is needed for installing and running the TanoWrt from the internal NAND flash memory).

4.7.3 Booting from SD Card

1. Insert the SD card into the slot on the SAMA5D3 EDS board (power is off).

2. Power on board.

3. TanoWrt will be booting from SD card.

4. Log in to system using default credentials.

4.8 Serial Console

Serial console on SAMA5D3 EDS board are available through 6-pin serial communication header J10. Connect the USB to TTL serial cable as described below. Don’t connect the VCC wire of the USB to TTL converted, connect only TX, RX and GND wires.

SAMA5D3 EDS J10 6-pin Header	Signal
Pin 1	Not used
Pin 2	TX
Pin 3	RX
Pin 4	Not connected
Pin 5	Not used
Pin 6	GND

See Fig. 4.1 for example connection USB to TTL converter with SAMA5D3 EDS board.

The default serial console settings for SAMA5D3 EDS for U-Boot and kernel are described in the table below.

Parameter	Value
Baudrate	115200
Data bits	8
Stop bits	1
Parity	none
Flow control	none

4.9 Default Network Configuration

By default, network ports 1 and 2 are joined into a bridge (br-lan interface) with the RSTP protocol enabled. Bridge br-lan is in the LAN firewall zone. By default, the br-lan bridge is configured with static IP address 192.168.0.1/24 with enabled DHCP server.

Also you can connect to the board using USB RNDIS connection (usb0 interface). RNDIS interface configured with static IP address 172.16.0.1/24 with enabled DHCP server.

Default network configuration for the EVB-KSZ9563 has no WAN interface.

Ethernet ports 1 and 2 have enabled LLDP for Rx and Tx state by default.

4.10 Web User Interface

The WebUI can be accessed via any Ethernet port bridged to LAN network (1 or 2) or via USB RNDIS connection through HTTP(s) protocol. You must see something like this in browser:

Fig. 4.9 LuCI WebUI Login Page

Fig. 4.10 LuCI WebUI Overview Page

4.11 Firmware Upgrade

No special information about firmware upgrade. Use produced .swu artifact for upgrading running system.

See also

See common instructions in Firmware Upgrade section.

4.12 References

1. KSZ9563 Plug-in Evaluation Board (EVB-KSZ9563)

2. SAMA5D3 Ethernet Development System (DM320114)