projects/xcvr_wizard: Add xcvr_wizard READMEs

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

Author: hadarauelena

projects/xcvr_wizard/README.md

@@ -0,0 +1,11 @@
+# XCVR-WIZARD HDL Project
+
+- HDL project documentation: https://analogdevicesinc.github.io/hdl/library/jesd204/xgt_wizard/index.html
+
+## Building the project
+
+This project is used internally to generate transceiver configuration files for
+Xilinx carriers. The generated configuration files are later parsed and used by
+other HDL projects (e.g., ADRV9009, DAQ2, DAQ3).
+Please enter the folder for the FPGA carrier you want to use
+and read the README.md.

projects/xcvr_wizard/kc705/README.md

@@ -0,0 +1,27 @@
+<!-- no_build_example, no_dts, no_no_os -->
+
+# XCVR-WIZARD/KC705 HDL Project
+
+- Transceiver type: GTXE2
+
+## Building the project
+
+```
+cd projects/xcvr_wizard/kc705
+make
+```
+
+If other configurations are desired, then the parameters from the HDL project
+(see below) need to be changed.
+
+The overwritable parameters from the environment:
+
+- LANE_RATE: Value of lane rate [gbps]
+- REF_CLK: Value of the reference clock [MHz] (usually LANE_RATE/20 or LANE_RATE/40)
+- PLL_TYPE: The PLL used for driving the link [CPLL/QPLL]
+
+Note: When running make with parameters, a new folder specific to the chosen
+configuration is created under the project directory. The generated IPs and
+the corresponding configuration files (e.g. *_cfng.txt) will be placed there.
+
+- Generated files: `<config_folder>/<project_name>.gen/sources_1/ip/*_cfng.txt`

projects/xcvr_wizard/kcu105/README.md

@@ -0,0 +1,26 @@
+<!-- no_build_example, no_dts, no_no_os -->
+
+# XCVR-WIZARD/KCU105 HDL Project
+
+- Transceiver type: GTHE3
+
+## Building the project
+
+```
+cd projects/xcvr_wizard/kcu105
+make
+```
+
+If other configurations are desired, then the parameters from the HDL project (see below) need to be changed.
+
+The overwritable parameters from the environment:
+
+- LANE_RATE: Value of lane rate [gbps]
+- REF_CLK: Value of the reference clock [MHz] (usually LANE_RATE/20 or LANE_RATE/40)
+- PLL_TYPE: The PLL used for driving the link [CPLL/QPLL]
+
+Note: When running make with parameters, a new folder specific to the chosen
+configuration is created under the project directory. The generated IPs and
+the corresponding configuration files (e.g. *_cfng.txt) will be placed there.
+
+- Generated files: `<config_folder>/<project_name>.gen/sources_1/ip/*_cfng.txt`

projects/xcvr_wizard/vcu118/README.md

@@ -0,0 +1,26 @@
+<!-- no_build_example, no_dts, no_no_os -->
+
+# XCVR-WIZARD/VCU118 HDL Project
+
+- Transceiver type: GTYE4
+
+## Building the project
+
+```
+cd projects/xcvr_wizard/vcu118
+make
+```
+
+If other configurations are desired, then the parameters from the HDL project (see below) need to be changed.
+
+The overwritable parameters from the environment:
+
+- LANE_RATE: Value of lane rate [gbps]
+- REF_CLK: Value of the reference clock [MHz] (usually LANE_RATE/20 or LANE_RATE/40)
+- PLL_TYPE: The PLL used for driving the link [CPLL/QPLL]
+
+Note: When running make with parameters, a new folder specific to the chosen
+configuration is created under the project directory. The generated IPs and
+the corresponding configuration files (e.g. *_cfng.txt) will be placed there.
+
+- Generated files: `<config_folder>/<project_name>.gen/sources_1/ip/*_cfng.txt`

projects/xcvr_wizard/zc706/README.md

@@ -0,0 +1,26 @@
+<!-- no_build_example, no_dts, no_no_os -->
+
+# XCVR-WIZARD/ZC706 HDL Project
+
+- Transceiver type: GTXE2
+
+## Building the project
+
+```
+cd projects/xcvr_wizard/zc706
+make
+```
+
+If other configurations are desired, then the parameters from the HDL project (see below) need to be changed.
+
+The overwritable parameters from the environment:
+
+- LANE_RATE: Value of lane rate [gbps]
+- REF_CLK: Value of the reference clock [MHz] (usually LANE_RATE/20 or LANE_RATE/40)
+- PLL_TYPE: The PLL used for driving the link [CPLL/QPLL]
+
+Note: When running make with parameters, a new folder specific to the chosen
+configuration is created under the project directory. The generated IPs and
+the corresponding configuration files (e.g. *_cfng.txt) will be placed there.
+
+- Generated files: `<config_folder>/<project_name>.gen/sources_1/ip/*_cfng.txt`

projects/xcvr_wizard/zcu102/README.md

@@ -0,0 +1,26 @@
+<!-- no_build_example, no_dts, no_no_os -->
+
+# XCVR-WIZARD/ZCU102 HDL Project
+
+- Transceiver type: GTHE4
+
+## Building the project
+
+```
+cd projects/xcvr_wizard/zcu102
+make
+```
+
+If other configurations are desired, then the parameters from the HDL project (see below) need to be changed.
+
+The overwritable parameters from the environment:
+
+- LANE_RATE: Value of lane rate [gbps]
+- REF_CLK: Value of the reference clock [MHz] (usually LANE_RATE/20 or LANE_RATE/40)
+- PLL_TYPE: The PLL used for driving the link [CPLL/QPLL]
+
+Note: When running make with parameters, a new folder specific to the chosen
+configuration is created under the project directory. The generated IPs and
+the corresponding configuration files (e.g. *_cfng.txt) will be placed there.
+
+- Generated files: `<config_folder>/<project_name>.gen/sources_1/ip/*_cfng.txt`