.. include:: ../../../../shared/links.rst .. include:: ../links.rst .. _checklist-results: ########################################################################## Checklist Template ########################################################################## .. contents:: Table of content :depth: 1 :local: Duplicate this page for each xbtest packages release. .. _package-information-checklist: ******************************************************** Package information ******************************************************** Fill the following tables: .. table:: +--------------------------------------+-----------+ | xbtest information | +======================================+===========+ | Release number | ```` | +--------------------------------------+-----------+ | Description (what's new) | ```` | +--------------------------------------+-----------+ .. table:: +--------------------------------------+-----------+ | Platform Information | +======================================+===========+ | Development platform (XSA) | ```` | +--------------------------------------+-----------+ | Deployment platform (shell, CMC, SC) | ```` | +--------------------------------------+-----------+ .. _system-information-checklist: ******************************************************** System information ******************************************************** Fill the following table: .. table:: +------------------------+-----------+ | System information | +========================+===========+ | OS | ```` | +------------------------+-----------+ | Architecture | ```` | +------------------------+-----------+ | Server type | ```` | +------------------------+-----------+ | AUX cable | ```` | +------------------------+-----------+ | Card S/N | ```` | +------------------------+-----------+ | XRT version | ```` | +------------------------+-----------+ | Measured download time | ```` | +------------------------+-----------+ .. _requirements-checklist: ******************************************************** Requirement - Platform high level features ******************************************************** Refer to :ref:`requirement-platform-high-level-features` instruction page to complete this section. ===================================================== Platform and card requirements ===================================================== Update the following according to your platform: .. table:: +--------------------------------------+-----------+ | Platform and card requirements | +======================================+===========+ | FPGA part | ```` | +--------------------------------------+-----------+ | PCIe speed and width | ```` | +--------------------------------------+-----------+ | DMA type | ```` | +--------------------------------------+-----------+ | DDR: speed, size and quantity | ```` | +--------------------------------------+-----------+ | HBM: size, quantity and power rail | ```` | +--------------------------------------+-----------+ | Host memory support | ```` | +--------------------------------------+-----------+ | P2P support | ```` | +--------------------------------------+-----------+ | GTs: type, quad, SLR location | ```` | +--------------------------------------+-----------+ ===================================================== Power rails requirements ===================================================== Remove/add rows according to the actual power rails available in your platform. ``3v3_pex``, ``12v_pex``, ``12v_aux`` and ``vccint`` rows have been given as example/placeholder, but a generic template is also present for any other type of power rail. .. table:: +-------------+----------------+-----------+ | Power rail | Card limit (W) | Note | +=============+================+===========+ | ``12v_pex`` | ```` | ```` | +-------------+----------------+-----------+ | ``3v3_pex`` | ```` | ```` | +-------------+----------------+-----------+ | ``12v_aux`` | ```` | ```` | +-------------+----------------+-----------+ | ``vccint`` | ```` | ```` | +-------------+----------------+-----------+ | ```` | ```` | ```` | +-------------+----------------+-----------+ .. _calibration-power-cu-checklist: ******************************************************** Calibration - Power CU - Results ******************************************************** Refer to :ref:`calibration-power-cu` instruction page to complete this section. Remove/add rows according to the actual power rails available in your platform. ``3v3_pex``, ``12v_pex``, ``12v_aux`` and ``vccint`` rows have been given as example/placeholder, but a generic template is also present for any other type of power rail. .. table:: +--------------------------+-------------------------------------------------------------------+-------------------------------------------------------------------------+ | Description | Results | +==========================+===================================================================+=========================================================================+ | Attach here your xbtest logs (ZIP file) | :download:`power_calibration.zip <./attachments/power_calibration.zip>` | +----------------------------------------------------------------------------------------------+-------------------------------------------------------------------------+ | Power, temperature & toggle rate graph | .. figure:: ./attachments/power_calibration.png | | | :alt: | | | :align: center | +----------------------------------------------------------------------------------------------+-------------------------------------------------------------------------+ | Maximum toggle rate reached (%) | ```` | +--------------------------+-------------------------------------------------------------------+-------------------------------------------------------------------------+ | Power consumption balance achieved: | ```` | | | | | * Yes/no and justification (why are some rails not close to their critical current limit?) | | +--------------------------+-------------------------------------------------------------------+-------------------------------------------------------------------------+ | | Measurement | ```` | | ``3v3_pex`` current (A) +-------------------------------------------------------------------+-------------------------------------------------------------------------+ | | Critical limit | ```` | +--------------------------+-------------------------------------------------------------------+-------------------------------------------------------------------------+ | | Measurement | ```` | | ``12v_pex`` current (A) +-------------------------------------------------------------------+-------------------------------------------------------------------------+ | | Critical limit | ```` | +--------------------------+-------------------------------------------------------------------+-------------------------------------------------------------------------+ | | Measurement | ```` | | ``12v_aux`` current (A) +-------------------------------------------------------------------+-------------------------------------------------------------------------+ | | Critical limit | ```` | +--------------------------+-------------------------------------------------------------------+-------------------------------------------------------------------------+ | | Measurement | ```` | | ``vccint`` current (A) +-------------------------------------------------------------------+-------------------------------------------------------------------------+ | | Critical limit | ```` | +--------------------------+-------------------------------------------------------------------+-------------------------------------------------------------------------+ | | Measurement | ```` | | ```` current (A) +-------------------------------------------------------------------+-------------------------------------------------------------------------+ | | Critical limit | ```` | +--------------------------+-------------------------------------------------------------------+-------------------------------------------------------------------------+ .. _calibration-memory-cu-power-checklist: ******************************************************** Calibration - Memory CU power ******************************************************** Refer to :ref:`calibration-memory-cu-power` instruction page to complete this section. Remove/add tables according to the actual on-board memory available in your platform. DDR and HBM tables have been given as example/placeholder, but a generic template is also present for any other type of memory (e.g. PS_DDR, PL_DDR ...). If there is enough power for a memory, add only the graph and ZIP files to the table. .. table:: +----------+-----------------------------------------+-------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------+ | Memory | Description | ``simultaneous_wr_rd`` | ``only_rd`` | ``only_wr`` | +==========+=========================================+=======================================================================================================+=================================================================================+=================================================================================+ | DDR | Is there enough power for memory? | ```` | ```` | ```` | + +-----------------------------------------+-------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------+ | | Power rail name | ```` | ```` | ```` | + +-----------------------------------------+-------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------+ | | Power throttle limit (W) | ```` | ```` | ```` | + +-----------------------------------------+-------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------+ | | 20% below power throttle limit (W) | ```` | ```` | ```` | + +-----------------------------------------+-------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------+ | | CU rate (%) @ 20% below limit | ```` | ```` | ```` | + +-----------------------------------------+-------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------+ | | Power graph | .. figure:: ./attachments/simultaneous_wr_rd_rate_ramp_power_ddr.png | .. figure:: ./attachments/only_rd_rate_ramp_power_ddr.png | .. figure:: ./attachments/only_wr_rate_ramp_power_ddr.png | | | | :alt: | :alt: | :alt: | | | | :align: center | :align: center | :align: center | | | | | | | + +-----------------------------------------+-------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------+ | | BW graph | .. figure:: ./attachments/simultaneous_wr_rd_rate_ramp_bw_ddr.png | .. figure:: ./attachments/only_rd_rate_ramp_bw_ddr.png | .. figure:: ./attachments/only_wr_rate_ramp_bw_ddr.png | | | | :alt: | :alt: | :alt: | | | | :align: center | :align: center | :align: center | | | | | | | + +-----------------------------------------+-------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------+ | | Latency graphs | .. figure:: ./attachments/simultaneous_wr_rd_rate_ramp_latency_wr_ddr.png | .. figure:: ./attachments/only_rd_rate_ramp_latency_ddr.png | .. figure:: ./attachments/only_wr_rate_ramp_latency_ddr.png | | | | :alt: | :alt: | :alt: | | | | :align: center | :align: center | :align: center | | | | | | | | | | .. figure:: ./attachments/simultaneous_wr_rd_rate_ramp_latency_rd_ddr.png | | | | | | :alt: | | | | | | :align: center | | | | | | | | | + +-----------------------------------------+-------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------+ | | Attach here your xbtest logs (ZIP file) | :download:`simultaneous_wr_rd_rate_ramp_ddr.zip <./attachments/simultaneous_wr_rd_rate_ramp_ddr.zip>` | :download:`only_rd_rate_ramp_ddr.zip <./attachments/only_rd_rate_ramp_ddr.zip>` | :download:`only_wr_rate_ramp_ddr.zip <./attachments/only_wr_rate_ramp_ddr.zip>` | +----------+-----------------------------------------+-------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------+ .. table:: +----------+-----------------------------------------+-------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------+ | Memory | Description | ``simultaneous_wr_rd`` | ``only_rd`` | ``only_wr`` | +==========+=========================================+=======================================================================================================+=================================================================================+=================================================================================+ | HBM | Is there enough power for memory? | ```` | ```` | ```` | + +-----------------------------------------+-------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------+ | | Power rail name | ```` | ```` | ```` | + +-----------------------------------------+-------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------+ | | Power throttle limit (W) | ```` | ```` | ```` | + +-----------------------------------------+-------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------+ | | 20% below power throttle limit (W) | ```` | ```` | ```` | + +-----------------------------------------+-------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------+ | | CU rate (%) @ 20% below limit | ```` | ```` | ```` | + +-----------------------------------------+-------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------+ | | Power graph | .. figure:: ./attachments/simultaneous_wr_rd_rate_ramp_power_hbm.png | .. figure:: ./attachments/only_rd_rate_ramp_power_hbm.png | .. figure:: ./attachments/only_wr_rate_ramp_power_hbm.png | | | | :alt: | :alt: | :alt: | | | | :align: center | :align: center | :align: center | | | | | | | + +-----------------------------------------+-------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------+ | | BW graph | .. figure:: ./attachments/simultaneous_wr_rd_rate_ramp_bw_hbm.png | .. figure:: ./attachments/only_rd_rate_ramp_bw_hbm.png | .. figure:: ./attachments/only_wr_rate_ramp_bw_hbm.png | | | | :alt: | :alt: | :alt: | | | | :align: center | :align: center | :align: center | | | | | | | + +-----------------------------------------+-------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------+ | | Latency graphs | .. figure:: ./attachments/simultaneous_wr_rd_rate_ramp_latency_wr_hbm.png | .. figure:: ./attachments/only_rd_rate_ramp_latency_hbm.png | .. figure:: ./attachments/only_wr_rate_ramp_latency_hbm.png | | | | :alt: | :alt: | :alt: | | | | :align: center | :align: center | :align: center | | | | | | | | | | .. figure:: ./attachments/simultaneous_wr_rd_rate_ramp_latency_rd_hbm.png | | | | | | :alt: | | | | | | :align: center | | | | | | | | | + +-----------------------------------------+-------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------+ | | Attach here your xbtest logs (ZIP file) | :download:`simultaneous_wr_rd_rate_ramp_hbm.zip <./attachments/simultaneous_wr_rd_rate_ramp_hbm.zip>` | :download:`only_rd_rate_ramp_hbm.zip <./attachments/only_rd_rate_ramp_hbm.zip>` | :download:`only_wr_rate_ramp_hbm.zip <./attachments/only_wr_rate_ramp_hbm.zip>` | +----------+-----------------------------------------+-------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------+ .. table:: +----------+-----------------------------------------+-------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------+ | Memory | Description | ``simultaneous_wr_rd`` | ``only_rd`` | ``only_wr`` | +==========+=========================================+=======================================================================================================+=================================================================================+=================================================================================+ |```` | Is there enough power for memory? | ```` | ```` | ```` | + +-----------------------------------------+-------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------+ | | Power rail name | ```` | ```` | ```` | + +-----------------------------------------+-------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------+ | | Power throttle limit (W) | ```` | ```` | ```` | + +-----------------------------------------+-------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------+ | | 20% below power throttle limit (W) | ```` | ```` | ```` | + +-----------------------------------------+-------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------+ | | CU rate (%) @ 20% below limit | ```` | ```` | ```` | + +-----------------------------------------+-------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------+ | | Power graph | ```` | ```` | ```` | + +-----------------------------------------+-------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------+ | | BW graph | ```` | ```` | ```` | + +-----------------------------------------+-------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------+ | | Latency graphs | ```` | ```` | ```` | + +-----------------------------------------+-------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------+ | | Attach here your xbtest logs (ZIP file) | ```` | ```` | ```` | +----------+-----------------------------------------+-------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------+ .. _calibration-memory-bandwidth-and-latency-checklist: ******************************************************** Calibration - Memory bandwidth and latency ******************************************************** Refer to :ref:`calibration-memory-bandwidth-and-latency` instruction page to complete this section. Remove/add tables according to the actual on-board memory available in your platform. DDR and HBM tables have been given as example/placeholder, but a generic template is also present for any other type of memory (e.g. PS_DDR, PL_DDR ...). .. note:: * **N/A**: not applicable * .. [1] The outstanding write/read is the maximum number of outstanding reads just before the read pipeline is full, giving the best BW and latency results. .. table:: +-----------+-----------------------------------------+---------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ | Memory | Description | ``simultaneous_wr_rd`` | ``only_rd`` | ``only_wr`` | +===========+=========================================+=====================================================================================================================+===============================================================================================+===============================================================================================+ | DDR | QoS / power reduction rate | Write rate = ```` %; read rate = ```` % | Read rate = ```` % | Write rate = ```` % | | | | | | | | | | .. figure:: ./attachments/simultaneous_wr_rd_qos_rate_ramp_bw_ddr.png | | | | | | :alt: | | | | | | :align: center | | | | | | | | | | | | :download:`simultaneous_wr_rd_qos_rate_ramp_ddr.zip <./attachments/simultaneous_wr_rd_qos_rate_ramp_ddr.zip>` | | | | | | | | | | | | **Only if used**, else ``N/A`` | **Only if used**, else ``N/A`` | **Only if used**, else ``N/A`` | + +-----------------------------------------+---------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ | | Best write BW (MBps) | ```` | **N/A** | ```` | + +-----------------------------------------+---------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ | | Best write latency (ns) | ```` | **N/A** | ```` | + +-----------------------------------------+---------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ | | Best read BW (MBps) | ```` | ```` | **N/A** | + +-----------------------------------------+---------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ | | Best read latency (ns) | ```` | ```` | **N/A** | + +-----------------------------------------+---------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ | | Outstanding write/read [1]_ | Write = ```` / read = ```` | ```` | ```` | | | | | | | | | | Due to QoS rate reduction, this may not possible to select value as the BW and latency are +/- constant. | | | | | | In such case do not define any value in platform definition JSON file and set ``N/A`` in this table cell. | | | + +-----------------------------------------+---------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ | | BW/latency graphs | .. figure:: ./attachments/simultaneous_wr_rd_outstanding_ramp_wr_ddr.png | .. figure:: ./attachments/only_rd_outstanding_ramp_ddr.png | .. figure:: ./attachments/only_wr_outstanding_ramp_ddr.png | | | (do one for read and one for write) | :alt: | :alt: | :alt: | | | | :align: center | :align: center | :align: center | | | | | | | | | | .. figure:: ./attachments/simultaneous_wr_rd_outstanding_ramp_rd_ddr.png | | | | | | :alt: | | | | | | :align: center | | | | | | | | | + +-----------------------------------------+---------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ | | Attach here your xbtest logs (ZIP file) | :download:`simultaneous_wr_rd_outstanding_ramp_ddr.zip <./attachments/simultaneous_wr_rd_outstanding_ramp_ddr.zip>` | :download:`only_rd_outstanding_ramp_ddr.zip <./attachments/only_rd_outstanding_ramp_ddr.zip>` | :download:`only_wr_outstanding_ramp_ddr.zip <./attachments/only_wr_outstanding_ramp_ddr.zip>` | +-----------+-----------------------------------------+---------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ .. table:: +-----------+-----------------------------------------+---------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ | Memory | Description | ``simultaneous_wr_rd`` | ``only_rd`` | ``only_wr`` | +===========+=========================================+=====================================================================================================================+===============================================================================================+===============================================================================================+ | HBM | QoS / power reduction rate | wr_rate ````; rd_rate ```` | rd_rate ```` | wr_rate ```` | | | | | | | | | | .. figure:: ./attachments/simultaneous_wr_rd_qos_rate_ramp_bw_hbm.png | | | | | | :alt: | | | | | | :align: center | | | | | | | | | | | | :download:`simultaneous_wr_rd_qos_rate_ramp_hbm.zip <./attachments/simultaneous_wr_rd_qos_rate_ramp_hbm.zip>` | | | | | | | | | | | | **Only if used**, else ``N/A`` | **Only if used**, else ``N/A`` | **Only if used**, else ``N/A`` | + +-----------------------------------------+---------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ | | Best write BW (MBps) | ```` | **N/A** | ```` | + +-----------------------------------------+---------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ | | Best write latency (ns) | ```` | **N/A** | ```` | + +-----------------------------------------+---------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ | | Best read BW (MBps) | ```` | ```` | **N/A** | + +-----------------------------------------+---------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ | | Best read latency (ns) | ```` | ```` | **N/A** | + +-----------------------------------------+---------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ | | Outstanding write/read [1]_ | ```` | ```` | ```` | | | | | | | | | | Due to QoS rate reduction, this may not possible to select value as the BW and latency are +/- constant. | | | | | | In such case do not define any value in platform definition JSON file and set ``N/A`` in this table cell. | | | + +-----------------------------------------+---------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ | | BW/latency graphs | .. figure:: ./attachments/simultaneous_wr_rd_outstanding_ramp_wr_hbm.png | .. figure:: ./attachments/only_rd_outstanding_ramp_hbm.png | .. figure:: ./attachments/only_wr_outstanding_ramp_hbm.png | | | (do one for read and one for write) | :alt: | :alt: | :alt: | | | | :align: center | :align: center | :align: center | | | | | | | | | | .. figure:: ./attachments/simultaneous_wr_rd_outstanding_ramp_rd_hbm.png | | | | | | :alt: | | | | | | :align: center | | | | | | | | | + +-----------------------------------------+---------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ | | Attach here your xbtest logs (ZIP file) | :download:`simultaneous_wr_rd_outstanding_ramp_hbm.zip <./attachments/simultaneous_wr_rd_outstanding_ramp_hbm.zip>` | :download:`only_rd_outstanding_ramp_hbm.zip <./attachments/only_rd_outstanding_ramp_hbm.zip>` | :download:`only_wr_outstanding_ramp_hbm.zip <./attachments/only_wr_outstanding_ramp_hbm.zip>` | +-----------+-----------------------------------------+---------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ .. table:: +-----------+-----------------------------------------+---------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ | Memory | Description | ``simultaneous_wr_rd`` | ``only_rd`` | ``only_wr`` | +===========+=========================================+=====================================================================================================================+===============================================================================================+===============================================================================================+ | ```` | QoS / power reduction rate | wr_rate ````; rd_rate ```` | rd_rate ```` | wr_rate ```` | | | | | | | | | | **Only if used**, else ``N/A`` | **Only if used**, else ``N/A`` | **Only if used**, else ``N/A`` | + +-----------------------------------------+---------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ | | Best write BW (MBps) | ```` | **N/A** | ```` | + +-----------------------------------------+---------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ | | Best write latency (ns) | ```` | **N/A** | ```` | + +-----------------------------------------+---------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ | | Best read BW (MBps) | ```` | ```` | **N/A** | + +-----------------------------------------+---------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ | | Best read latency (ns) | ```` | ```` | **N/A** | + +-----------------------------------------+---------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ | | Outstanding write/read [1]_ | ```` | ```` | ```` | | | | | | | | | | Due to QoS rate reduction, this may not possible to select value as the BW and latency are +/- constant. | | | | | | In such case do not define any value in platform definition JSON file and set ``N/A`` in this table cell. | | | + +-----------------------------------------+---------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ | | BW/latency graphs | ```` | ```` | ```` | | | (do one for read and one for write) | | | | + +-----------------------------------------+---------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ | | Attach here your xbtest logs (ZIP file) | ```` | ```` | ```` | +-----------+-----------------------------------------+---------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ .. _checklist-questionnaire: ******************************************************** Checklist questionnaire ******************************************************** Refer to :ref:`platform-definition-json-file` instruction page to complete this section. ===================================================== Runtime ===================================================== Fill the following table: .. table:: +---------------------------------------------------------------------------------+-----------------------------------------------------------+ | Question | Answer / justification / problem tracker reference number | +=================================================================================+===========================================================+ | Have you updated the default download time? | ```` | | | | | * FYI: | | | | | | * u250 xclbin (90Mb) downloads in 3.9 sec (PCIe 3x16). | | | * HBM requires calibration which may take time. | | +---------------------------------------------------------------------------------+-----------------------------------------------------------+ ===================================================== Sensors ===================================================== Fill the following table: .. table:: +---------------------------------------------------------------------------------+-----------------------------------------------------------+ | Question | Answer / justification / problem tracker reference number | +=================================================================================+===========================================================+ | Do you need to monitor more mechanical sources than the default one | ```` | | (``fpga_fan_1``)? | | | | | | * Yes, see |fill-platform-definition-json|_ | | +---------------------------------------------------------------------------------+-----------------------------------------------------------+ | Do you need to monitor more thermal sources than the default one (``fpga0``)? | ```` | | | | | * Yes, see |fill-platform-definition-json|_ | | +---------------------------------------------------------------------------------+-----------------------------------------------------------+ | Do you need to monitor more electrical sources than the default ones | ```` | | (``power_consumption``, ``12v_pex``, ``12v_aux``, ``3v3_pex`` and ``vccint``)? | | | | | | * Yes, see |fill-platform-definition-json|_ | | +---------------------------------------------------------------------------------+-----------------------------------------------------------+ ===================================================== GT ===================================================== Fill the following table: .. table:: +---------------------------------------------------------------------------------+-----------------------------------------------------------+-----------------------------------------------------------+ | Question | Answer / justification / problem tracker reference number | +=================================================================================+===========================================================+===========================================================+ | GT | ```` | ```` | +---------------------------------------------------------------------------------+-----------------------------------------------------------+-----------------------------------------------------------+ | Have you updated GT default settings to maximize signal integrity? | ```` | ```` | | | | | | * Run all GT pre-canned tests. | | | +---------------------------------------------------------------------------------+-----------------------------------------------------------+-----------------------------------------------------------+ ===================================================== Memory ===================================================== Fill the following table: .. table:: +---------------------------------------------------------------------------------+-----------------------------------------------------------+-----------------------------------------------------------+-----------------------------------------------------------+-----------------------------------------------------------+ | Question | Answer / justification / problem tracker reference number | +=================================================================================+===========================================================+===========================================================+===========================================================+===========================================================+ | Memory | DDR | HBM | HOST | ```` | +---------------------------------------------------------------------------------+-----------------------------------------------------------+-----------------------------------------------------------+-----------------------------------------------------------+-----------------------------------------------------------+ | Have you defined specific DMA bandwidths (``dma_bw``)? | ```` | ```` | **N/A** | ```` | | | | | | | | * This not applicable for host memory. | | | | | +---------------------------------------------------------------------------------+-----------------------------------------------------------+-----------------------------------------------------------+-----------------------------------------------------------+-----------------------------------------------------------+ | Have you defined optimum DMA settings (``buffer_size`` and ``total_size``) | ```` | ```` | **N/A** | ```` | | or are default settings enough? | | | | | | | | | | | | * Run dma pre-canned test. | | | | | +---------------------------------------------------------------------------------+-----------------------------------------------------------+-----------------------------------------------------------+-----------------------------------------------------------+-----------------------------------------------------------+ | Have you defined specific P2P CARD bandwidths (``p2p_card_bw``)? | ```` | ```` | **N/A** | ```` | | | | | | | | * This not applicable for host memory. | | | | | +---------------------------------------------------------------------------------+-----------------------------------------------------------+-----------------------------------------------------------+-----------------------------------------------------------+-----------------------------------------------------------+ | Have you defined optimum P2P CARD settings (``buffer_size`` and ``total_size``) | ```` | ```` | **N/A** | ```` | | or are default settings enough? | | | | | | | | | | | | * Run p2p_card pre-canned test. | | | | | +---------------------------------------------------------------------------------+-----------------------------------------------------------+-----------------------------------------------------------+-----------------------------------------------------------+-----------------------------------------------------------+ | Have you defined specific P2P NVME bandwidths (``p2p_nvme_bw``)? | ```` | ```` | **N/A** | ```` | | | | | | | | * This not applicable for host memory. | | | | | +---------------------------------------------------------------------------------+-----------------------------------------------------------+-----------------------------------------------------------+-----------------------------------------------------------+-----------------------------------------------------------+ | Have you defined optimum P2P NVME settings (``buffer_size`` and ``total_size``) | ```` | ```` | **N/A** | ```` | | or are default settings enough? | | | | | | | | | | | | * Run p2p_nvme pre-canned test. | | | | | +---------------------------------------------------------------------------------+-----------------------------------------------------------+-----------------------------------------------------------+-----------------------------------------------------------+-----------------------------------------------------------+ | Have you reduced the CU rate to avoid over-power (``cu_rate``)? | ```` | ```` | ```` | ```` | +---------------------------------------------------------------------------------+-----------------------------------------------------------+-----------------------------------------------------------+-----------------------------------------------------------+-----------------------------------------------------------+ | Have you defined ``cu_rate`` for simultaneous write/read bandwidth QoS? | ```` | ```` | ```` | ```` | +---------------------------------------------------------------------------------+-----------------------------------------------------------+-----------------------------------------------------------+-----------------------------------------------------------+-----------------------------------------------------------+ | Have you defined ``cu_bw``? | ```` | ```` | ```` | ```` | | | | | | | | * For each test mode: ``only_wr``, ``only_rd`` and ``simul_wr_rd`` | | | | | | | | | | | | For host memory these values are depending on the PCIe speed. | | | | | +---------------------------------------------------------------------------------+-----------------------------------------------------------+-----------------------------------------------------------+-----------------------------------------------------------+-----------------------------------------------------------+ | Have you defined ``cu_latency``? | ```` | ```` | ```` | ```` | | | | | | | | * For each test mode: ``only_wr``, ``only_rd`` and ``simul_wr_rd`` | | | | | +---------------------------------------------------------------------------------+-----------------------------------------------------------+-----------------------------------------------------------+-----------------------------------------------------------+-----------------------------------------------------------+ | Have you defined ``cu_outstanding``? | ```` | ```` | ```` | ```` | | | | | | | | * For each test mode: ``only_wr``, ``only_rd`` and ``simul_wr_rd`` | | | | | +---------------------------------------------------------------------------------+-----------------------------------------------------------+-----------------------------------------------------------+-----------------------------------------------------------+-----------------------------------------------------------+ | Have you defined ``cu_burst_size``? | ```` | ```` | ```` | ```` | | | | | | | | * For each test mode: ``only_wr``, ``only_rd`` and ``simul_wr_rd`` | | | | | +---------------------------------------------------------------------------------+-----------------------------------------------------------+-----------------------------------------------------------+-----------------------------------------------------------+-----------------------------------------------------------+ ===================================================== Pre-canned tests ===================================================== Fill the following table: .. table:: +---------------------------------------------------------------------------------+-----------------------------------------------------------+ | Question | Answer / justification / problem tracker reference number | +=================================================================================+===========================================================+ | Have you tested all provided pre-canned tests? | ```` | | | | | * If not: list the skipped one and the reason? | | +---------------------------------------------------------------------------------+-----------------------------------------------------------+ | Have you modified the pre-canned test template? | ```` | | | | | * If yes: | | | | | | * Why?  | | | * Was it not possible to make a platform definition update | | | (and thus, available for any test as default)? | | | * Update next section with your modifications. | | +---------------------------------------------------------------------------------+-----------------------------------------------------------+ | Have you saved all pre-canned results? | ```` | | | | | * Update package information section of your checklist. | | +---------------------------------------------------------------------------------+-----------------------------------------------------------+ ===================================================== Issues tracking ===================================================== Fill the following table: .. table:: +---------------------------------------------------------------------------------+-----------------------------------------------------------+ | Question | Answer / justification / problem tracker reference number | +=================================================================================+===========================================================+ | Did you modify the platform definition limits and range after running the | ```` | | pre-canned tests? | | | | | | * If yes: | | | | | | * List the problem tracker reference number | | +---------------------------------------------------------------------------------+-----------------------------------------------------------+ .. _pre-canned-tests-checklist: ******************************************************** Pre-canned tests results ******************************************************** Refer to :ref:`pre-canned-tests` instruction page to complete this section. .. _pre-canned-tests-modifications-checklist: ===================================================== Pre-canned test modifications ===================================================== Fill the following table: .. table:: +-----------+-------------------------------------+----------------+ | Test name | Modification from original template | Justifications | +===========+=====================================+================+ | ```` | ```` | ```` | +-----------+-------------------------------------+----------------+ .. _dma_pre-canned-test-checklist: ===================================================== ``dma`` pre-canned test ===================================================== Attach here your xbtest logs (ZIP file): * :download:`dma.zip <./attachments/dma.zip>` Remove/add rows according to the actual on-board memory available in your platform. DDR and HBM rows have been given as example/placeholder, but a generic template is also present for any other type of memory (e.g. PS_DDR, PL_DDR ...). .. table:: +-----------------+-----------------+-----------------+ | Memory | Write BW (MBps) | Read BW (MBps) | +=================+=================+=================+ | DDR | ```` | ```` | +-----------------+-----------------+-----------------+ | HBM | ```` | ```` | +-----------------+-----------------+-----------------+ | ```` | ```` | ```` | +-----------------+-----------------+-----------------+ .. _p2p_card_pre-canned-test-checklist: ===================================================== ``p2p_card`` pre-canned test ===================================================== Attach here your xbtest logs (ZIP file): * :download:`p2p_card.zip <./attachments/p2p_card.zip>` Remove/add rows according to the actual on-board memory available in your platform. DDR and HBM rows have been given as example/placeholder, but a generic template is also present for any other type of memory (e.g. PS_DDR, PL_DDR ...). .. table:: +-----------------+-----------------+-----------------+ | Memory | Write BW (MBps) | Read BW (MBps) | +=================+=================+=================+ | DDR | ```` | ```` | +-----------------+-----------------+-----------------+ | HBM | ```` | ```` | +-----------------+-----------------+-----------------+ | ```` | ```` | ```` | +-----------------+-----------------+-----------------+ .. _p2p_nvme_pre-canned-test-checklist: ===================================================== ``p2p_nvme`` pre-canned test ===================================================== Attach here your xbtest logs (ZIP file): * :download:`p2p_nvme.zip <./attachments/p2p_nvme.zip>` Remove/add rows according to the actual on-board memory available in your platform. DDR and HBM rows have been given as example/placeholder, but a generic template is also present for any other type of memory (e.g. PS_DDR, PL_DDR ...). .. table:: +-----------------+-----------+-----------------+-----------------+ | Memory | Card mode | Write BW (MBps) | Read BW (MBps) | +=================+===========+=================+=================+ | DDR | source | ```` | ```` | +-----------------+-----------+-----------------+-----------------+ | DDR | target | ```` | ```` | +-----------------+-----------+-----------------+-----------------+ | HBM | source | ```` | ```` | +-----------------+-----------+-----------------+-----------------+ | HBM | target | ```` | ```` | +-----------------+-----------+-----------------+-----------------+ | ```` | source | ```` | ```` | +-----------------+-----------+-----------------+-----------------+ | ```` | target | ```` | ```` | +-----------------+-----------+-----------------+-----------------+ .. _memory_pre-canned-test-checklist: ===================================================== ``memory`` pre-canned test ===================================================== Attach here your xbtest logs (ZIP file): * :download:`memory.zip <./attachments/memory.zip>` Remove/add tables according to the actual on-board memory available in your platform. DDR and HBM tables have been given as example/placeholder, but a generic template is also present for any other type of memory (e.g. PS_DDR, PL_DDR ...). .. table:: +-----------------+------------------------+-----------------+-----------------+--------------------+-------------------+ | Memory | Test mode | Write BW (MBps) | Read BW (MBps) | Write Latency (ns) | Read Latency (ns) | +=================+========================+=================+=================+====================+===================+ | | ``alternate_wr_rd`` | ```` | ```` | ```` | ```` | + +------------------------+-----------------+-----------------+--------------------+-------------------+ | | ``only_wr`` | ```` | **N/A** | ```` | **N/A** | + DDR +------------------------+-----------------+-----------------+--------------------+-------------------+ | | ``only_rd`` | **N/A** | ```` | **N/A** | ```` | + +------------------------+-----------------+-----------------+--------------------+-------------------+ | | ``simultaneous_wr_rd`` | ```` | ```` | ```` | ```` | +-----------------+------------------------+-----------------+-----------------+--------------------+-------------------+ .. table:: +-----------------+------------------------+-----------------+-----------------+--------------------+-------------------+ | Memory | Test mode | Write BW (MBps) | Read BW (MBps) | Write Latency (ns) | Read Latency (ns) | +=================+========================+=================+=================+====================+===================+ | | ``alternate_wr_rd`` | ```` | ```` | ```` | ```` | + +------------------------+-----------------+-----------------+--------------------+-------------------+ | | ``only_wr`` | ```` | **N/A** | ```` | **N/A** | + HBM +------------------------+-----------------+-----------------+--------------------+-------------------+ | | ``only_rd`` | **N/A** | ```` | **N/A** | ```` | + +------------------------+-----------------+-----------------+--------------------+-------------------+ | | ``simultaneous_wr_rd`` | ```` | ```` | ```` | ```` | +-----------------+------------------------+-----------------+-----------------+--------------------+-------------------+ .. table:: +-----------------+------------------------+-----------------+-----------------+--------------------+-------------------+ | Memory | Test mode | Write BW (MBps) | Read BW (MBps) | Write Latency (ns) | Read Latency (ns) | +=================+========================+=================+=================+====================+===================+ | | ``alternate_wr_rd`` | ```` | ```` | ```` | ```` | + +------------------------+-----------------+-----------------+--------------------+-------------------+ | | ``only_wr`` | ```` | **N/A** | ```` | **N/A** | + ```` +------------------------+-----------------+-----------------+--------------------+-------------------+ | | ``only_rd`` | **N/A** | ```` | **N/A** | ```` | + +------------------------+-----------------+-----------------+--------------------+-------------------+ | | ``simultaneous_wr_rd`` | ```` | ```` | ```` | ```` | +-----------------+------------------------+-----------------+-----------------+--------------------+-------------------+ .. _memory_host_pre-canned-test-checklist: ===================================================== ``memory_host`` pre-canned test ===================================================== Attach here your xbtest logs (ZIP file): * :download:`memory_host.zip <./attachments/memory_host.zip>` Fill the following table: .. table:: +-----------------+------------------------+-----------------+-----------------+--------------------+-------------------+ | Memory | Test mode | Write BW (MBps) | Read BW (MBps) | Write Latency (ns) | Read Latency (ns) | +=================+========================+=================+=================+====================+===================+ | | ``alternate_wr_rd`` | ```` | ```` | ```` | ```` | + +------------------------+-----------------+-----------------+--------------------+-------------------+ | | ``only_wr`` | ```` | **N/A** | ```` | **N/A** | + HOST +------------------------+-----------------+-----------------+--------------------+-------------------+ | | ``only_rd`` | **N/A** | ```` | **N/A** | ```` | + +------------------------+-----------------+-----------------+--------------------+-------------------+ | | ``simultaneous_wr_rd`` | ```` | ```` | ```` | ```` | +-----------------+------------------------+-----------------+-----------------+--------------------+-------------------+