Skip to content

Commit bff2dce

Browse files
committed
projects/adrv9026:Add READMEs
Signed-off-by: Capota Bianca <[email protected]>
1 parent 007976f commit bff2dce

File tree

4 files changed

+92
-0
lines changed

4 files changed

+92
-0
lines changed

projects/adrv9026/README.md

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# ADRV9026 HDL Project
2+
3+
- Evaluation board product page: [EVAL-ADRV9026/ADRV9029](https://www.analog.com/eval-adrv9026)
4+
- System documentation: https://wiki.analog.com/resources/eval/user-guides/adrv9026/quickstart
5+
- HDL project documentation: https://analogdevicesinc.github.io/hdl/projects/adrv9026/index.html
6+
7+
## Supported parts
8+
9+
| Part name | Description |
10+
|---------------------------------------------|-----------------------------------------------------------|
11+
| [ADRV9026](https://www.analog.com/ADRV9026) | Integrated, Quad RF Transceiver with Observation Path |
12+
| [ADRV9029](https://www.analog.com/ADRV9029) | Integrated, Quad RF Transceiver with Observation Path |
13+
14+
## Building the project
15+
16+
Please enter the folder for the FPGA carrier you want to use and read the README.md.

projects/adrv9026/a10soc/README.md

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# ADRV9026/A10SOC HDL Project
2+
3+
## Building the project
4+
5+
```
6+
cd projects/adrv9026/a10soc
7+
make
8+
```
9+
10+
Corresponding device tree: [socfpga_arria10_socdk_adrv9025.dts](https://github.com/analogdevicesinc/linux/blob/main/arch/arm/boot/dts/intel/socfpga/socfpga_arria10_socdk_adrv9025.dts)

projects/adrv9026/vcu118/README.md

+33
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# ADRV9026/VCU118 HDL Project
2+
3+
## Building the project
4+
5+
```
6+
cd projects/adrv9026/vcu118
7+
make
8+
```
9+
10+
All of the RX/TX link modes can be found in the [ADRV9026 data sheet](https://www.analog.com/media/radioverse-adrv9026/adrv9026.pdf). We offer support for only a few of them.
11+
12+
The overwritable parameters from the environment:
13+
14+
- JESD_MODE - link layer encoder mode used;
15+
- 8B10B - 8b10b link layer defined in JESD204B, uses ADI IP as Physical layer
16+
- 64B66B - 64b66b link layer defined in JESD204C, uses Xilinx IP as Physical layer
17+
- [RX/TX]_LANE_RATE - lane rate of the [RX/TX] link (RX: MxFE to FPGA/TX: FPGA to MxFE)
18+
- [RX/TX]_NUM_LINKS - [RX/TX] number of links, which matches the number of MxFE devices
19+
- [RX/TX]_JESD_M - [RX/TX] number of converters per link
20+
- [RX/TX]_JESD_L - [RX/TX] number of lanes per link
21+
- [RX/TX]_JESD_S - [RX/TX] number of samples per converter per frame
22+
23+
### Example configurations
24+
25+
#### JESD204B subclass 1, TX mode 17, RX mode 18 (default)
26+
27+
This specific command is equivalent to running `make` only:
28+
29+
```
30+
make JESD_MODE=8B10B RX_LANE_RATE=9.83 TX_LANE_RATE=9.83 RX_JESD_M=8 RX_JESD_L=4 RX_JESD_S=1 TX_JESD_M=8 TX_JESD_L=4 TX_JESD_S=1
31+
```
32+
33+
Corresponding device tree: [vcu118_adrv9025.dts](https://github.com/analogdevicesinc/linux/blob/main/arch/microblaze/boot/dts/vcu118_adrv9025.dts)

projects/adrv9026/zcu102/README.md

+33
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# ADRV9026/ZCU102 HDL Project
2+
3+
## Building the project
4+
5+
```
6+
cd projects/adrv9026/zcu102
7+
make
8+
```
9+
10+
All of the RX/TX link modes can be found in the [ADRV9026 data sheet](https://www.analog.com/media/radioverse-adrv9026/adrv9026.pdf). We offer support for only a few of them.
11+
12+
The overwritable parameters from the environment:
13+
14+
- JESD_MODE - link layer encoder mode used;
15+
- 8B10B - 8b10b link layer defined in JESD204B, uses ADI IP as Physical layer
16+
- 64B66B - 64b66b link layer defined in JESD204C, uses Xilinx IP as Physical layer
17+
- [RX/TX]_LANE_RATE - lane rate of the [RX/TX] link (RX: MxFE to FPGA/TX: FPGA to MxFE)
18+
- [RX/TX]_NUM_LINKS - [RX/TX] number of links, which matches the number of MxFE devices
19+
- [RX/TX]_JESD_M - [RX/TX] number of converters per link
20+
- [RX/TX]_JESD_L - [RX/TX] number of lanes per link
21+
- [RX/TX]_JESD_S - [RX/TX] number of samples per converter per frame
22+
23+
### Example configurations
24+
25+
#### JESD204B subclass 1, TX mode 17, RX mode 18 (default)
26+
27+
This specific command is equivalent to running `make` only:
28+
29+
```
30+
make JESD_MODE=8B10B RX_LANE_RATE=9.83 TX_LANE_RATE=9.83 RX_JESD_M=8 RX_JESD_L=4 RX_JESD_S=1 TX_JESD_M=8 TX_JESD_L=4 TX_JESD_S=1
31+
```
32+
33+
Corresponding device tree: [zynqmp-zcu102-rev10-adrv9025.dts](https://github.com/analogdevicesinc/linux/blob/main/arch/arm64/boot/dts/xilinx/zynqmp-zcu102-rev10-adrv9025.dts)

0 commit comments

Comments
 (0)