library/jesd204/xgt_wizard: Update XCVR wizard doc

Signed-off-by: Elena-Hadarau_adi <[email protected]>

Author: hadarauelena

docs/library/jesd204/xgt_wizard/index.rst

@@ -39,23 +39,104 @@ The following features are required for a JESD204B interface:
 - Tx configurable driver
 - Polarity control
 
-There are 2 flows for generating transceivers using the wizard
+There are 3 flows for generating transceivers using the wizard
 -------------------------------------------------------------------------------
 
-The first one is using the GT wizard manually as explained below:
+The first one is an automated flow integrated in the HDL build system. It uses
+project-defined parameters to generate and extract only the necessary transceiver
+settings, with no user interaction required. The second one is using the GT
+wizard manually as explained below:
 :ref:`Using_the_GUI_of_the_Wizard <xgt_wizard_gui_of_the_wizard>` ,
-and a second one that uses a script to generate one or more configurations:
+and a third one that uses a script to generate one or more configurations:
 :ref:`Using_the_generator_script <xgt_wizard_generator_script>` .
-Please keep in mind that the script is capable of generating only configurations
-where the TX ad RX lane rates are even. For more customization, you can use the
-script to generate the configurations, then edit them manually as u please.
+Please keep in mind that the script is capable of generating only **configurations
+where the TX ad RX lane rates are even and supports only JESD204B**. For more
+customization, you can use the script to generate the configurations, then edit
+them manually as you please.
 
 If you used the script method, there is another script that parses the generated
 configurations and generates a list containing only the parameters that are
 different from the default, the ones that you will have to change/add in your
 system_bd.tcl: Parsing_script. This script does not work at the moment for the
 configurations that are not generated by the script.
 
+.. _xgt_wizard_automated_flow:
+
+Using the Automated Transceiver Configuration Flow
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+To simplify and streamline the configuration of transceivers in FPGA designs,
+the HDL build system supports an automated flow using **xcvr_wizard** project and
+supporting Tcl scripts.
+
+The automated transceiver configuration flow is currently integrated into the
+following projects:
+
+- DAQ2
+- DAQ3
+- ADRV9009
+- ADRV9371x
+- ADRV9026
+
+xcvr_wizard
+*******************************************************************************
+
+The :git-hdl:`xcvr_wizard HDL project <projects/xcvr_wizard>` is used internally
+to generate transceiver configuration files based on a set of parameters:
+
+- LANE_RATE: lane speed in Gbps
+- REF_CLK: reference clock frequency in MHz
+- PLL_TYPE: the type of PLL used (CPLL or QPLL)
+
+It builds a Vivado project for a specific carrier and configuration, producing
+files such as GT_Type_cfng.txt and, for GTXE2 devices,
+gtxe2_<plltype>_<rate>_<refclk>_common.v. These files are later parsed by automation
+scripts to extract only the required configuration parameters.
+
+adi_xcvr_project
+*******************************************************************************
+
+This function builds the `xcvr_wizard` using user-defined parameters. These values
+define the configuration for which the transceiver settings will be generated.
+The function returns a dictionary (`xcvr_config_paths`) with the paths to the
+generated files.
+
+In the HDL build flow, it is called from `system_project.tcl`, located in the
+carrier-specific folder (e.g., `projects/<carrier>/system_project.tcl`).
+
+**Example:**
+
+.. code-block:: tcl
+
+   global xcvr_config_paths
+
+   set xcvr_config_paths [adi_xcvr_project [list
+     LANE_RATE 10
+     REF_CLK 500
+     PLL_TYPE QPLL
+   ]]
+
+adi_xcvr_parameters
+*******************************************************************************
+
+This function takes `xcvr_config_paths` and optionally a list of overrides. It
+extracts only the transceiver parameters that differ from defaults and returns
+them to be passed to `ad_ip_instance`.
+
+It is called from the block design script `<project_name>_bd.tcl`, located in the
+`common/` folder (e.g., `projects/<project_name>/common/<design>_bd.tcl`).
+
+**Example:**
+
+.. code-block:: tcl
+
+   global xcvr_config_paths
+
+   set util_adxcvr_parameters [adi_xcvr_parameters $xcvr_config_paths [list
+     RX_NUM_OF_LANES $MAX_RX_NUM_OF_LANES
+     TX_NUM_OF_LANES $MAX_TX_NUM_OF_LANES
+   ]]
+
 .. _xgt_wizard_gui_of_the_wizard:
 
 Using the GUI of the Wizard