Files
b210-k7-fpga/tools/scripts/shared-ip-loc-manage.sh
+18 6b67702ad7 Merge FPGA repository back into UHD repository
The FPGA codebase was removed from the UHD repository in 2014 to reduce
the size of the repository. However, over the last half-decade, the
split between the repositories has proven more burdensome than it has
been helpful. By merging the FPGA code back, it will be possible to
create atomic commits that touch both FPGA and UHD codebases. Continuous
integration testing is also simplified by merging the repositories,
because it was previously difficult to automatically derive the correct
UHD branch when testing a feature branch on the FPGA repository.

This commit also updates the license files and paths therein.

We are therefore merging the repositories again. Future development for
FPGA code will happen in the same repository as the UHD host code and
MPM code.

== Original Codebase and Rebasing ==

The original FPGA repository will be hosted for the foreseeable future
at its original local location: https://github.com/EttusResearch/fpga/

It can be used for bisecting, reference, and a more detailed history.

The final commit from said repository to be merged here is
05003794e2da61cabf64dd278c45685a7abad7ec. This commit is tagged as
v4.0.0.0-pre-uhd-merge.

If you have changes in the FPGA repository that you want to rebase onto
the UHD repository, simply run the following commands:

- Create a directory to store patches (this should be an empty
  directory):

    mkdir ~/patches

- Now make sure that your FPGA codebase is based on the same state as
  the code that was merged:

    cd src/fpga # Or wherever your FPGA code is stored
    git rebase v4.0.0.0-pre-uhd-merge

  Note: The rebase command may look slightly different depending on what
  exactly you're trying to rebase.

- Create a patch set for your changes versus v4.0.0.0-pre-uhd-merge:

    git format-patch v4.0.0.0-pre-uhd-merge -o ~/patches

  Note: Make sure that only patches are stored in your output directory.
  It should otherwise be empty. Make sure that you picked the correct
  range of commits, and only commits you wanted to rebase were exported
  as patch files.

- Go to the UHD repository and apply the patches:

    cd src/uhd # Or wherever your UHD repository is stored
    git am --directory fpga ~/patches/*
    rm -rf ~/patches # This is for cleanup

== Contributors ==

The following people have contributed mainly to these files (this list
is not complete):

Co-authored-by: Alex Williams <alex.williams@ni.com>
Co-authored-by: Andrej Rode <andrej.rode@ettus.com>
Co-authored-by: Ashish Chaudhari <ashish@ettus.com>
Co-authored-by: Ben Hilburn <ben.hilburn@ettus.com>
Co-authored-by: Ciro Nishiguchi <ciro.nishiguchi@ni.com>
Co-authored-by: Daniel Jepson <daniel.jepson@ni.com>
Co-authored-by: Derek Kozel <derek.kozel@ettus.com>
Co-authored-by: EJ Kreinar <ej@he360.com>
Co-authored-by: Humberto Jimenez <humberto.jimenez@ni.com>
Co-authored-by: Ian Buckley <ian.buckley@gmail.com>
Co-authored-by: Jörg Hofrichter <joerg.hofrichter@ni.com>
Co-authored-by: Jon Kiser <jon.kiser@ni.com>
Co-authored-by: Josh Blum <josh@joshknows.com>
Co-authored-by: Jonathon Pendlum <jonathan.pendlum@ettus.com>
Co-authored-by: Martin Braun <martin.braun@ettus.com>
Co-authored-by: Matt Ettus <matt@ettus.com>
Co-authored-by: Michael West <michael.west@ettus.com>
Co-authored-by: Moritz Fischer <moritz.fischer@ettus.com>
Co-authored-by: Nick Foster <nick@ettus.com>
Co-authored-by: Nicolas Cuervo <nicolas.cuervo@ettus.com>
Co-authored-by: Paul Butler <paul.butler@ni.com>
Co-authored-by: Paul David <paul.david@ettus.com>
Co-authored-by: Ryan Marlow <ryan.marlow@ettus.com>
Co-authored-by: Sugandha Gupta <sugandha.gupta@ettus.com>
Co-authored-by: Sylvain Munaut <tnt@246tNt.com>
Co-authored-by: Trung Tran <trung.tran@ettus.com>
Co-authored-by: Vidush Vishwanath <vidush.vishwanath@ettus.com>
Co-authored-by: Wade Fife <wade.fife@ettus.com>


Original-commit: bafa9d95453387814ef25e6b6256ba8db2df612f
2020-01-28 09:35:36 -08:00

120 lines
2.6 KiB
Bash
Executable File

#!/bin/bash
function help {
cat <<EOHELP
Usage: shared-ip-loc-manage.sh [--help|-h] [--timeout=<TIMEOUT>] --path=<PATH> <ACTION>
--path : Path to IP location
--timeout : Timeout in seconds for the operation to complete [Optional]
(Default: 1200)
--force : Force operation
--help -h : Shows this message.
ACTION : Choose from reserve, release
EOHELP
}
function wait_for_lock {
if [ -d "$ip_dir" ]; then
remaining=$(($timeout))
trap 'echo"";echo "BUILDER: Waiting for concurrent IP build to finish... (skipped)";break;' SIGINT; \
while [ -f "$ip_dir/.build_lock" ]; do
if [ $remaining -gt 0 ]; then
echo -ne "Waiting for concurrent IP build to finish... (${remaining}s [Ctrl-C to proceed])\033[0K\r"
sleep 1
: $((remaining--))
else
break
fi
done
trap - SIGINT; \
if [ $remaining -eq 0 ]; then
echo "BUILDER: Waiting for concurrent IP build to finish... (timeout)"
fi
fi
}
function lock {
if [ -d "$ip_dir" ]; then
touch $ip_dir/.build_lock
fi
}
function unlock {
rm -f $ip_dir/.build_lock
}
function reserve {
if [ -d "$ip_dir" ]; then
wait_for_lock
if [ $remaining -eq 0 ]; then
echo "Force creating new IP location: $ip_dir"
unlock
rm -rf $ip_dir
mkdir -p $ip_dir
fi
fi
if [ ! -d "$ip_dir" ]; then
mkdir -p $ip_dir
fi
echo "BUILDER: Reserving IP location: $ip_dir"
lock
}
function release {
echo "BUILDER: Releasing IP location: $ip_dir"
unlock
}
# Parse options
ip_dir=""
action=""
timeout=1800
remaining=0
force=0
for arg in "$@"; do
if [[ $arg == "--help" ]]; then
help
exit 0
elif [[ $arg == "--force" ]]; then
force=1
elif [[ $arg =~ "--path="(.+) ]]; then
ip_dir=`readlink -m ${BASH_REMATCH[1]}`
elif [[ $arg =~ "--timeout="(.+) ]]; then
timeout=${BASH_REMATCH[1]}
else
action=$arg
break
fi
done
# Validate inputs
if [ -z $ip_dir ]; then
echo "ERROR: Please specify a valid path using the --path option."
exit 1
fi
case $action in
reserve)
if [ $force -eq 1 ]; then
echo "Force creating new IP location: $ip_dir"
rm -rf $ip_dir
mkdir -p $ip_dir
lock
else
reserve
fi
;;
release)
release
;;
*)
echo "ERROR: Please specify a valid action (reserve, release)"
exit 1
;;
esac