###############################################################################
## Copyright (C) 2019-2023 Analog Devices, Inc. All rights reserved.
### SPDX short identifier: ADIBSD
###############################################################################

source ../../../scripts/adi_env.tcl
source $ad_hdl_dir/projects/scripts/adi_project_xilinx.tcl
source $ad_hdl_dir/projects/scripts/adi_board.tcl

# The get_env_param procedure retrieves parameter value from the environment if exists,
# other case returns the default value specified in its second parameter field.
#
#   How to use over-writable parameters from the environment:
#
#    e.g.
#      make JESD_MODE=8B10B  RX_JESD_L=4 RX_JESD_M=8 TX_JESD_L=4 TX_JESD_M=8
#      make JESD_MODE=64B66B RX_JESD_L=2 RX_JESD_M=8 TX_JESD_L=4 TX_JESD_M=16
#      make JESD_MODE=64B66B RX_LANE_RATE=24.75 TX_LANE_RATE=24.75 REF_CLK_RATE=250 RX_JESD_M=4 RX_JESD_L=4 RX_JESD_S=2 RX_JESD_NP=12 TX_JESD_M=4 TX_JESD_L=4 TX_JESD_S=2 TX_JESD_NP=12 RX_PLL_SEL=1 TX_PLL_SEL=1
#
#  RX_LANE_RATE,TX_LANE_RATE,REF_CLK_RATE used only in 64B66B mode
#
# Parameter description:
#   JESD_MODE : used link layer encoder mode
#      64B66B - 64b66b link layer defined in JESD 204C, uses Xilinx IP as Physical layer
#      8B10B  - 8b10b link layer defined in JESD 204B, uses ADI IP as Physical layer
#
#    RX_LANE_RATE :  Line rate of the Rx link ( MxFE to FPGA ) used in 64B66B mode
#    TX_LANE_RATE :  Line rate of the Tx link ( FPGA to MxFE ) used in 64B66B mode
#    [RX/TX]_PLL_SEL :  used in 64B66B mode,
#                     0 - CPLL   for lane rates 4-12.5 Gbps and integer sub-multiples
#                     1 - QPLL0  for lane rates 19.6–32.75 Gbps and integer sub-multiples (e.g. 9.8–16.375;)
#                     2 - QPLL1  for lane rates 16.0–26.0 Gbps and integer sub-multiple (e.g. 8.0–13.0;)
#                     For detail see JESD204 PHY v4.0 pg198-jesd204-phy.pdf  and ug578-ultrascale-gty-transceivers.pdf
#    REF_CLK_RATE : Frequency of reference clock in MHz used in 64B66B mode
#    [RX/TX]_JESD_M : Number of converters per link
#    [RX/TX]_JESD_L : Number of lanes per link
#    [RX/TX]_JESD_S : Number of samples per frame
#    [RX/TX]_JESD_NP : Number of bits per sample, only 16 is supported
#    [RX/TX]_NUM_LINKS : Number of links, matches number of MxFE devices
#    [RX/TX]_KS_PER_CHANNEL : Number of samples stored in internal buffers in kilosamples per converter (M)
#

adi_project ad_quadmxfe1_ebz_vcu118 0 [list \
  JESD_MODE            [get_env_param JESD_MODE       64B66B ] \
  RX_LANE_RATE         [get_env_param RX_LANE_RATE      16.5 ] \
  TX_LANE_RATE         [get_env_param TX_LANE_RATE      16.5 ] \
  RX_PLL_SEL           [get_env_param RX_PLL_SEL           2 ] \
  TX_PLL_SEL           [get_env_param TX_PLL_SEL           2 ] \
  REF_CLK_RATE         [get_env_param REF_CLK_RATE       250 ] \
  RX_JESD_M            [get_env_param RX_JESD_M            8 ] \
  RX_JESD_L            [get_env_param RX_JESD_L            2 ] \
  RX_JESD_S            [get_env_param RX_JESD_S            1 ] \
  RX_JESD_NP           [get_env_param RX_JESD_NP          16 ] \
  RX_NUM_LINKS         [get_env_param RX_NUM_LINKS         4 ] \
  TX_JESD_M            [get_env_param TX_JESD_M           16 ] \
  TX_JESD_L            [get_env_param TX_JESD_L            4 ] \
  TX_JESD_S            [get_env_param TX_JESD_S            1 ] \
  TX_JESD_NP           [get_env_param TX_JESD_NP          16 ] \
  TX_NUM_LINKS         [get_env_param TX_NUM_LINKS         4 ] \
  RX_KS_PER_CHANNEL    [get_env_param RX_KS_PER_CHANNEL   32 ] \
  TX_KS_PER_CHANNEL    [get_env_param TX_KS_PER_CHANNEL   16 ] \
  DAC_TPL_XBAR_ENABLE  [get_env_param DAC_TPL_XBAR_ENABLE  0 ] \
]

adi_project_files ad_quadmxfe1_ebz_vcu118 [list \
  "system_top.v" \
  "system_constr.xdc" \
  "timing_constr.xdc" \
  "../common/quad_mxfe_gpio_mux.v" \
  "../../../library/common/ad_3w_spi.v" \
  "$ad_hdl_dir/library/common/ad_iobuf.v" \
  "$ad_hdl_dir/projects/common/vcu118/vcu118_system_constr.xdc" ]

set_property strategy Performance_RefinePlacement [get_runs impl_1]

adi_project_run ad_quadmxfe1_ebz_vcu118