Xilinx Alveo X3 Series Firmware Package
+++++++++++++++++++++++++++++++++++++++

Version: 1.28.127.1158-69

Overview
++++++++

This is the v1.28.127.1158 firmware package for Xilinx Alveo X3 series
adapters.

Supported hardware platforms
++++++++++++++++++++++++++++

This release of the firmware package supports the following Xilinx Alveo
X3 series adapters:

-   Xilinx Alveo X3522 NIC

Installation
++++++++++++

This package installs the firmware update files onto the target system,
where they can be applied to its installed X3 series adapters using a
firmware update tool. First install the binary package using your
preferred package manager, for example using rpm:

    rpm --install ./xilinx-x3522p-gen4x8-hn10g-base-1.28.127.1158-69.noarch.rpm

devlink is the preferred firmware update tool, to apply an update using
devlink:

1.  List the Xilinx PCIe devices for the X3 adapter:

        lspci -D -d 10ee:

2.  Ensure the net driver is loaded:

        modprobe xlnx_efct

3.  Note the PCIe address of the first X3 LLNIC interface, which can be
    identified as an Ethernet controller of type 5084. Apply the .update
    file to the device:

        devlink dev flash pci/<domain>:<bus>:<device>.<function> file xilinx/x3/x3522-bundle.update

4.  Wait for firmware update to complete.

5.  Perform a cold reboot of the machine after updating adapter
    firmware.

6.  Confirm the version numbers are as expected:

        devlink dev info pci/<domain>:<bus>:<device>.<function>

On OS distributions which do not include devlink or support flash update
via devlink, ethtool can be used for firmware updates:

1.  Ensure the net driver is loaded:

        modprobe xlnx_efct

2.  Apply the .update file to the device:

        ethtool --flash <interface> xilinx/x3/x3522-bundle.update

3.  Wait for firmware update to complete; ethtool blocks and does not
    report progress.

4.  Perform a cold reboot of the machine after updating adapter
    firmware.

5.  Confirm the version numbers are as expected:

        ethtool -i <interface>
        cat /sys/class/net/<interface>/device/versions

Additional information
++++++++++++++++++++++

For additional information, please refer to the "Programming the X3522"
chapter in the "Alveo X3522 User Guide (UG1523)" (XN-201015-CD).

Support
+++++++

Please contact your local Xilinx support representative or email
support-nic@xilinx.com.

Known Limitations
+++++++++++++++++

The X3522 device is intended primarily for low-latency networking and,
as a result, cannot achieve full line rate across all four ports at low
packet sizes.

Change logs
+++++++++++

Alveo X3 series firmware

1.28.127.1158 --- Update Release

Components included in bundle 1.28.127.1158:

    - NMC -- v1.17.7.30
    - UEFI -- v1.3.7.2
    - SuC -- v3.0.26.1001
    - FPGA -- v1.8.16.0

Changes:

    - Bug Fixes:
        - X3-1380: Fix packet classification not terminating on L2 status errors

    - Features:
        - Support for hybrid mode has been removed

1.28.124.1154-63 --- BETA Release

Components included in bundle 1.28.124.1154:

    - NMC -- v1.17.6.28
    - UEFI -- v1.3.7.2
    - SuC -- v3.0.26.1001
    - FPGA -- v1.8.15.0

Changes:

    - General Improvements:
        - Added ability to convert X3522 to operate as a x3522PV (subject to license enablement)
        - Number of RX Queues per port is increased from 8 to 16
        - Number of Event Queues per port is increased from 24 to 32
        - CAM filter size per port is increased from 256 to 512
        - Added support for two new NIC filters: MAC destination address based filter, and MAC destination address + VLAN tag information filter
        - Added support for ULP to overwrite NIC filters
        - Added X-UEFI Annotation for MAC address

    - Bug Fixes:
        - UEFI-452: Fix naming inconsistency of X3 card in UEFI interface w.r.t VPD name
        - X3-1322: Fix interoperability issues with some server management software
        - X3-1306: Improve sensor warning hysteresis
        - X3-1275: Fix for packets with corrupted TCP header being marked as matching by IPv4 filters but incorrectly classified as non-TCP packets
        - X3-1205: Fix delay in firmware starting that can prevent enumeration

1.27.91.1118-62 --- Update Release

Components included in bundle 1.27.91.1118:

    - NMC -- v1.16.9.13
    - UEFI -- v1.3.7.0
    - SuC -- v3.0.25.1000
    - FPGA -- v1.8.9.0

Changes:

    - FW
        - X3-1205: Address memory access timeout that could cause occasional
                   delay in firmware starting, and prevent enumeration

1.27.145.3780-15 --- Update Release

Components included in bundle 1.27.145.3780:

    - NMC -- v1.16.1.8
    - UEFI -- v1.3.7.0
    - SuC -- v3.0.25.1000
    - FPGA -- v1.8.9.0

Changes:

    - FW
        - X3-1202: Bug fix to improve reset reliability
        - X3-1207: Modify the metadata description in FLASH partitions

    - HW
        - Reset circuitry and firewall improvements

    - SUC
        - X3-1182: Change color of internal board status LED

    - UEFI
        - X3-1248: Fix to UEFII custom content

1.26.126.3538-7 --- Feature Release

    - Initial release to support Alveo X3522 NIC (1.26.126.3538).

Copyright
+++++++++

Copyright 2023 Xilinx, Inc. All rights reserved.
Use is subject to license terms.