Introduction

The following quick start guide provides background information about the ClearFog LX2162A products which use the LX2162A System on module.

The guide will give a technical overview about the product and by the end of it you should be able to boot an operating system and begin testing your application.

Revision and Notes

Date

Owner

Revision

Notes

 

1.0

 

Table of Contents

 

Hardware Setup

Product Specifications

 

ClearFog LX2162A

I/Os

1 x USB 2.0

1 x USB 3.0 (RunBMC)

Networking

2 x SFP28 ports (25GbE each)
2 x SFP+ ports (10GbE each)
8 x 1GbE copper (RJ45)

Processor

NXP Layerscape LX2162A 16-core Arm Cortex A72 up to 2GHz

Memory & Storage

Up to 32GB DDR4
8GB eMMC
MicroSD

Misc.

USB to STM32 for remote management
RunBMC compliant socket

Development and Debug interfaces

mini USB
JTAG

Power

12V DC Jack
ATX standard

Expansion card I/Os

*2 x mPCIe x1 Gen 3.0

Temperature

Commercial: 0°C to 70°C

Dimensions

PCBA: 170 x 137mm

  

Block Diagram

The following figure describes the ClearFog LX2162A Block Diagram.

note
  • Serdes-1 lanes are routed to the 2x SFP28 (via TI retimer) and 2x SFP+ connector

  • Serdes-2 lanes are routed to 8x 1GbE RJ-45 ports trough Marvell Octal PHY

*or 6x 1GbE RJ-45 ports trough Marvell Octal PHY and 2 mPCIe x1 Gen 3.0

  • Serdes-1 lanes are routed to the 2x SFP28 (via TI retimer) and 2x SFP+ connector

  • Serdes-2 lanes are routed to 8x 1GbE RJ-45 ports trough Marvell Octal PHY

*or 6x 1GbE RJ-45 ports trough Marvell Octal PHY and 2 mPCIe x1 Gen 3.0

Visual features overview

Please see below the features overview of the connector side of the ClearFog LX2162A

Software Setup

Cable setup and prerequisites

Here is what you will need to power up the board:

Recommended Cables

The following is a list of industry-standard cables, sorted by type, with the necessary compliance requirements that have been proven to work well with the ClearFog product family.

These examples are the cables which SolidRun uses for testing, and should provide enough information to source products from your preferred cable vendor.

Boot Select

Before powering up the board for the first time it is recommended to select the boot media. In order to configure the boot media, please refer to the following DIP switch:

Boot media

Switch 1

Switch 2

Switch 3

Switch 4

Switch 5

SD

OFF

ON

ON

ON

X

eMMC

OFF

ON

ON

OFF

X

SPI

OFF

OFF

OFF

OFF

X

The following shows how to set the switches on the boot source selector:

 

 

Booting from an SD card

The switches on the boot source SW1 selector must be set as follows:

Switch 1

Switch 2

Switch 3

Switch 4

Switch 5

OFF

ON

ON

ON

X

The following shows how to set the switches on the boot source selector:

 

 

Once you set the switches, you can apply the following for booting from an SD card.

  1. Downloading the image

Download a pre-built snapshot image from SolidRun Images

Those images are built with the suffix of the board name, SerDes protocol and commit ID of the GitHub - SolidRun/lx2160a_build  project that you can clone and build by yourself.

for example - https://images.solid-run.com/LX2k/lx2160a_build/lx2160acex7_2000_700_3200_LX2162A_CLEARFOG_18_9_0-850cda0.img.xz - targets LX2162A Clearfog with SFP connectors at 25/10Gbps and 8x Ethernet at 1Gbps each, built from commit 850cda0.

You can build your own image using the script in here – GitHub - SolidRun/lx2160a_build

  1. Writing the image to the SD card

Use the following commands for writing the image to an SD card:

xz -dc lx2160acex7_2000_700_....img.xz | dd of=/dev/sdX bs=4M conv=fdatasync
note

Note: Plug a micro SD into your Linux PC, the following assumes that the micro SD is added as /dev/sdX and all it’s partitions are unmounted.

Note: Plug a micro SD into your Linux PC, the following assumes that the micro SD is added as /dev/sdX and all it’s partitions are unmounted.

  1. SD card insertion
    Please Insert the SD card into your device.

  2. Serial Connection
    Please insert the miniUSB into your device, then you can refer to Serial Connection for installing necessary serial connection software in Linux/Windows.

  3. Power connection
    Connect your DC power , and then connect the adaptor to mains supply.

 Stop the u-boot count down by clicking any key –

To flash to eMMC run the following commands (it will wipe your data on the eMMC device).

load mmc 0:1 0xa4000000 ubuntu-core.img
mmc dev 1
mmc write 0xa4000000 0 0xd2000

Please Note:

The above commands should be run only once (in the fist boot).

Boot the machine by running ‘boot’ in u-boot.

Once you installed the necessary serial connection software and ran the above commands , you should be able to see the following:

Please note

If you are willing to use a similar image in production you must change this password, or completely disable root login.

  1. Final stages

The following stages need to be done in order to finalize the system:

  1. Run fdisk /dev/mmcblk0 if using SD, or run if using fdisk /dev/mmcblk1 eMMC.

  2. Recreate the first partition by deleting it and then creating a new partition that starts at block 131072 and extends to the end of the drive (or less depending on your needs).

  3. Write the new partition, when prompt about ‘Do you want to remove the signature?’ then answer with No.

  4. Run resize2fs /dev/mmcblk0p1 if using SD Card, or Run resize2fs /dev/mmcblk1p1 if using eMMC.

  5. In this stage the root partition should be big enough to start populating it; but first update the RTC clock.

  6. Activate Network Interfaces
    The native NICs of the SoC currently need to be explicitly enabled after boot, by instantiating a Linux network interface for each desired physical mac. Please find a mapping of the mac numbers to physical connectors in the picture below.

    For example to enable RJ45 bottom port at the end of the PCB, execute

    ls-addni dpmac.18

    The kernel will then create an eth? device automatically. The first interface is called eth0, successive ones receive incremental numbers. Please also refer to the output of dmesg command to find kernel messages about the interfaces that have been created.

  7. Connect the RJ45 to your network with internet access (and DHCP server); and then run dhclient .

  8. Update the RTC clock by running ntpdate pool.ntp.org and then hwclock -w.

  9. Run apt-update and then populate the root filesystem as you wish.

Please see below an example of resizing the filesystem :

SFP Modules

For some SFP modules that work on SolidRun networking hardware platforms, please refer to SFP Modules .

Packet Generator using DPDK

Following is an example instructions that demonstrates using the DPDK framework that is built in the lx2160a_build project under build/dpdk/ directory –

  1. Make sure that the kernel is booted with the following variables in the command line –

    default_hugepagesz=1024m hugepagesz=1024m hugepages=2 isolcpus=1-15 iommu.passthrough=1

    If using the above installation of Ubuntu then the /extlinux/extlinux.conf file should look as follows (the default installation with the addition of isolcpus=1-15 iommu.passthrough=1) –

      TIMEOUT 30
      DEFAULT linux
      MENU TITLE linux-lx2160a boot options
      LABEL primary
      MENU LABEL primary kernel
      LINUX /boot/Image
        FDT /boot/fsl-lx2160a-cex7.dtb
        APPEND console=ttyAMA0,115200 earlycon=pl011,mmio32,0x21c0000 default_hugepagesz=1024m hugepagesz=1024m hugepages=2 isolcpus=1-15 iommu.passthrough=1 pci=pcie_bus_perf root=PARTUUID=30303030-01 rw rootwait
    
  2. From build/dpdk directory under the lx2160a_build project, search for dynamic_dpl.sh and testpmd files and copy them over to the LX2160A Ubuntu root filesystem

  3. Run the following that will generate 10Gbps traffic on dpmac.10 using only a single core. Can be used to generate traffic on dpmac.1 and other interfaces –

dynamic_dpl.sh dpmac.10
export DPRC=dprc.2
testpmd -c 0x3 -n 1 -- --txd=1500 --txpkts=1500 --tx-first --auto-start --forward-mode=txonly --stats-period=10

Notice that DPRC variable in this case holds the output of dynamic_dpl.sh

An alternative way to run testpmd in interactive mode is as follows –

dynamic_dpl.sh dpmac.10
export DPRC=dprc.2
testpmd -c 0x3 -n 1 -- --txd=1500 -i
set fwd txonly
set txpkts 1500
show port info 0
show config txpkts
start

Tips

  1. sshd is disabled by default for root access. Edit /etc/ssh/sshd_config and set ‘PermitRootLogin yes’

  2. ssh to the machine might take long time after boot. To accelerate that install ‘rng-tools’ where it’s main daemon increases the kernel’s entropy and accelerates random number key generation (which used by libssl and sshd afterwards).

Example to install Gentoo from the Ubuntu

Gentoo is a free and open-source distribution with a rolling-release model.
The bootloader and kernel provided are recent enough to install Gentoo from the eMMC Ubuntu to the NVMe or SATA device.

 apt install btrfs-progs
 mkfs.btrfs /dev/nvme0n1p1
 mount /dev/nvme0n1p1 /mnt
 cd /mnt
# change 20200609 with what's available here http://distfiles.gentoo.org/experimental/arm64/
 wget http://distfiles.gentoo.org/experimental/arm64/stage3-arm64-20200609.tar.bz2
 mount --rbind /dev dev
 mount --make-rslave dev
 mount -t proc /proc proc
 mount --rbind /sys sys
 mount --make-rslave sys
 mount --rbind /tmp tmp
 cp /etc/resolv.conf etc
 chroot . /bin/bash
 env-update && . /etc/profile
 emerge-webrsync
 emerge superadduser openssh vim
# Set the root password
 passwd 
# enable root login
 vim /etc/ssh/sshd_config 
# or create your user
 superadduser your_user
 ln -s /etc/init.d/net.{lo,eth0}
 rc-update add sshd default
 reboot

 

Please note

  • In the same way, can install Debian or another Linux arm64 distribution.

 

Please note

  • The default bootcmd probes every device and looks for a /extlinux/extlinux.conf

  • The kernel command line uses the PARTUUID to boot the right drive can editing the root in the extlinux.conf to use directly root=/dev/nvme0n1p1 or  root=/dev/sdx .

Build From Source

  • Download a pre-built snapshot image based on Ubuntu 20.04 from here SolidRun Images

Documentation

 

File

Modified

Schematics and Board Layout Rev 1.1

Rev 1.1 files here

December 2022

Mechanical files Rev 1.1

Rev 1.1 files here

December 2022

Related Articles

Related pages

LX2160A COM Hardware User ManualLX2162A COM Hardware User ManualDeveloper CenterOften read together

LX2162A SoftwareLX2160A SoftwareDeveloper Center