Investigate whether Xilinx getting started guides need to refer to section on creating unique Ethernet addresses in Installation Guide

Location of document

ZCU102 Getting Started Guide

ZCU111 Getting Started Guide

Problem identified

The hardware for some OpenCPI-supported HDL platforms is not given a unique MAC address by the manufacturer. Adding these HDL platforms to an Ethernet network requires that they have a unique MAC address. The workaround was originally documented in the OpenCPI getting started guides for these platforms, causing duplication across each platform that required this information. The solution was to move the information to a central place, which is the Installation Guide, and have the getting started guides refer to this document. Issue opencpi #3144 accomplishes the first part of the solution. This issue describes the second part, which is to 1) verify that the boards in the Xilinx OSP do not have a unique MAC address, and if they don't, 2) create a sentence with a hyperlink that refers the reader to the new section in the Installation Guide that describes how to get one if needed.

Proposed solution

The process is:

  1. Verify that the ZCU102 and ZCU111 OpenCPI-supported HDL platforms require the unique MAC address workaround.
  2. If they do, add a link to the Installation Guide in the file /hdl/platforms/include/zcu_sfw_setup.inc as follows:

Connecting a |device_name| to a DHCP-supported Network (Optional)

Each OpenCPI HDL platform that is to be connected to an Ethernet network must have a unique MAC address. However, The built-in MAC address on a |device_name| is not unique to the board. Follow the instructions in the section "Connecting HDL Platforms to an Ethernet Network" in the OpenCPI Installation Guide to assign a unique MAC address to any |device_name| that you plan to connect to an Ethernet network.

Acceptance criteria

This issue can be closed when the getting started guides for the Xilinx OSP platforms that require setting a unique MAC address in the Xilinx OSP have a link to the relevant section in the OpenCPI Installation Guide.