Infrastructure update

[IstvanZsSzekely]

PR Description

Updated the infrastructure to be more standardized and have a better structured system.
Updated the IP and project level testbenches.

PR Type

• Bug fix (change that fixes an issue)
• New feature (change that adds new functionality)
• New test (change that adds new test program and/or testbench)
• Breaking change (has dependencies in other repositories/testbenches)
• Documentation (change that adds or modifies documentation)

PR Checklist

• I have followed the code style guidelines
• I have performed a self-review of changes
• I have ran all testbenches affected by this PR
• I have commented my code, at least hard-to-understand parts
• I have signed off all commits from this PR
• I have updated the documentation (wiki pages, ReadMe files, Copyright etc)
• I have not introduced new Warnings/Errors on compilation/elaboration/simulation
• I have set the verbosity level to none for the test program

[IstvanZsSzekely]

CI run finished, fixed the issues that surfaced and disabled the data_offload_2 tests, as the block design, test environment and test stimulus must be updated.

[gastmaier]

So as we discussed earlier, here is a patch to apply on top of any of the chain of the prs.

0001-review-formatting-infra-update.patch
0002-review-add-todos-on-long-commented-out-code.patch

Below is a bash script to patch the licenses, while preserving the dates

#!/bin/bash

line1="//      https://github.com/analogdevicesinc/hdl/blob/master/LICENSE_ADIBSD"
line2="//      https://github.com/analogdevicesinc/hdl/blob/main/LICENSE_ADIBSD"

line3="// freedoms and responsabilities that he or she has by using this source/core."
line4="// freedoms and responsibilities that he or she has by using this source/core."

# From $(git diff [--cache] --names-only), grep, etc.
files=(
        "..."
)

for f in "${files[@]}"; do
  if [ "$(sed -n '29p' "$f")" == "$line1" ]; then
    sed -i "29s|.*|$line2|" "$f"
  fi

  if [ "$(sed -n '27p' "$f")" == "$line3" ]; then
    sed -i "27s|.*|$line4|" "$f"
  fi

  line=$(sed -n '3p' "$f")
  if [[ $line =~ "// Copyright " ]]; then
    if [[ $line =~ ([0-9]{4})[^0-9]*([0-9]{4}) ]]; then
      var1=${BASH_REMATCH[1]}
      var2=${BASH_REMATCH[2]}
      line3="// Copyright (C) $var1-$var2 Analog Devices, Inc. All rights reserved."
      sed -i "3s|.*|$line3|" "$f"
    elif [[ $line =~ ([0-9]{4}) ]]; then
      var1=${BASH_REMATCH[1]}
      line3="// Copyright (C) $var1 Analog Devices, Inc. All rights reserved."
      sed -i "3s|.*|$line3|" "$f"
    fi
  fi

done

[IstvanZsSzekely]

Checked the 2 patch files as well as the bash script.

The 0001 patch would affect a lot of the chained PRs, causing many conflicts that will need to be solved. It will be reviewed and applied after the main links of the chained PRs are reviewed.

The 0002 patch is partially applied in certain chained PRs, while some others require another review later on. This is true for the PRs in the chain as well.
Note: a thorough review is required for all library and testbenches files.

The licenses are updated in #165, more or less. Will review it once its dependencies are reviewed, updated and merged.

[gastmaier]

Yep, let's get the chain merged first then do the fixes. The identation is partially automated as a vim macro anyway, not so timeconsuming