diff options
Diffstat (limited to 'pkgs/applications/radio/uhd')
| -rw-r--r-- | pkgs/applications/radio/uhd/3.5.nix | 160 | ||||
| -rw-r--r-- | pkgs/applications/radio/uhd/default.nix | 40 | ||||
| -rwxr-xr-x | pkgs/applications/radio/uhd/update.sh | 27 |
3 files changed, 58 insertions, 169 deletions
diff --git a/pkgs/applications/radio/uhd/3.5.nix b/pkgs/applications/radio/uhd/3.5.nix deleted file mode 100644 index 5f34597ea27..00000000000 --- a/pkgs/applications/radio/uhd/3.5.nix +++ /dev/null @@ -1,160 +0,0 @@ -{ lib -, stdenv -, fetchurl -, fetchFromGitHub -, cmake -, pkg-config -# See https://files.ettus.com/manual_archive/v3.15.0.0/html/page_build_guide.html for dependencies explanations -, boost -, enableLibuhd_C_api ? true -# requires numpy -, enableLibuhd_Python_api ? false -, python3 -, enableExamples ? false -, enableUtils ? false -, enableLiberio ? false -, liberio -, libusb1 -, enableDpdk ? false -, dpdk -# Devices -, enableOctoClock ? true -, enableMpmd ? true -, enableB100 ? true -, enableB200 ? true -, enableUsrp1 ? true -, enableUsrp2 ? true -, enableX300 ? true -, enableN230 ? true -, enableN300 ? true -, enableN320 ? true -, enableE300 ? true -, enableE320 ? true -}: - -let - onOffBool = b: if b then "ON" else "OFF"; - inherit (lib) optionals; -in - -stdenv.mkDerivation rec { - pname = "uhd"; - # UHD seems to use three different version number styles: x.y.z, xxx_yyy_zzz - # and xxx.yyy.zzz. Hrmpf... style keeps changing - version = "3.15.0.0"; - - src = fetchFromGitHub { - owner = "EttusResearch"; - repo = "uhd"; - rev = "v${version}"; - sha256 = "0jknln88a69fh244670nb7qrflbyv0vvdxfddb5g8ncpb6hcg8qf"; - }; - # Firmware images are downloaded (pre-built) from the respective release on Github - uhdImagesSrc = fetchurl { - url = "https://github.com/EttusResearch/uhd/releases/download/v${version}/uhd-images_${version}.tar.xz"; - sha256 = "1fir1a13ac07mqhm4sr34cixiqj2difxq0870qv1wr7a7cbfw6vp"; - }; - - cmakeFlags = [ - "-DENABLE_LIBUHD=ON" - "-DENABLE_USB=ON" - "-DENABLE_TESTS=ON" # This installs tests as well so we delete them via postPhases - "-DENABLE_EXAMPLES=${onOffBool enableExamples}" - "-DENABLE_UTILS=${onOffBool enableUtils}" - "-DENABLE_LIBUHD_C_API=${onOffBool enableLibuhd_C_api}" - "-DENABLE_LIBUHD_PYTHON_API=${onOffBool enableLibuhd_Python_api}" - "-DENABLE_LIBERIO=${onOffBool enableLiberio}" - "-DENABLE_DPDK=${onOffBool enableDpdk}" - # Devices - "-DENABLE_OCTOCLOCK=${onOffBool enableOctoClock}" - "-DENABLE_MPMD=${onOffBool enableMpmd}" - "-DENABLE_B100=${onOffBool enableB100}" - "-DENABLE_B200=${onOffBool enableB200}" - "-DENABLE_USRP1=${onOffBool enableUsrp1}" - "-DENABLE_USRP2=${onOffBool enableUsrp2}" - "-DENABLE_X300=${onOffBool enableX300}" - "-DENABLE_N230=${onOffBool enableN230}" - "-DENABLE_N300=${onOffBool enableN300}" - "-DENABLE_N320=${onOffBool enableN320}" - "-DENABLE_E300=${onOffBool enableE300}" - "-DENABLE_E320=${onOffBool enableE320}" - ] - # TODO: Check if this still needed - # ABI differences GCC 7.1 - # /nix/store/wd6r25miqbk9ia53pp669gn4wrg9n9cj-gcc-7.3.0/include/c++/7.3.0/bits/vector.tcc:394:7: note: parameter passing for argument of type 'std::vector<uhd::range_t>::iterator {aka __gnu_cxx::__normal_iterator<uhd::range_t*, std::vector<uhd::range_t> >}' changed in GCC 7.1 - ++ [ (lib.optionalString stdenv.isAarch32 "-DCMAKE_CXX_FLAGS=-Wno-psabi") ] - ; - - # Python + mako are always required for the build itself but not necessary for runtime. - pythonEnv = python3.withPackages (ps: with ps; [ mako ] - ++ optionals (enableLibuhd_Python_api) [ numpy setuptools ] - ++ optionals (enableUtils) [ requests six ] - ); - - nativeBuildInputs = [ - cmake - pkg-config - ] - # If both enableLibuhd_Python_api and enableUtils are off, we don't need - # pythonEnv in buildInputs as it's a 'build' dependency and not a runtime - # dependency - ++ optionals (!enableLibuhd_Python_api && !enableUtils) [ pythonEnv ] - ; - buildInputs = [ - boost - libusb1 - ] - # However, if enableLibuhd_Python_api *or* enableUtils is on, we need - # pythonEnv for runtime as well. The utilities' runtime dependencies are - # handled at the environment - ++ optionals (enableLibuhd_Python_api || enableUtils) [ pythonEnv ] - ++ optionals (enableLiberio) [ liberio ] - ++ optionals (enableDpdk) [ dpdk ] - ; - - doCheck = true; - - # Build only the host software - preConfigure = "cd host"; - # TODO: Check if this still needed, perhaps relevant: - # https://files.ettus.com/manual_archive/v3.15.0.0/html/page_build_guide.html#build_instructions_unix_arm - patches = if stdenv.isAarch32 then ./neon.patch else null; - - postPhases = [ "installFirmware" "removeInstalledTests" ] - ++ optionals (enableUtils) [ "moveUdevRules" ] - ; - - # UHD expects images in `$CMAKE_INSTALL_PREFIX/share/uhd/images` - installFirmware = '' - mkdir -p "$out/share/uhd/images" - tar --strip-components=1 -xvf "${uhdImagesSrc}" -C "$out/share/uhd/images" - ''; - - # -DENABLE_TESTS=ON installs the tests, we don't need them in the output - removeInstalledTests = '' - rm -r $out/lib/uhd/tests - ''; - - # Moves the udev rules to the standard location, needed only if utils are - # enabled - moveUdevRules = '' - mkdir -p $out/lib/udev/rules.d - mv $out/lib/uhd/utils/uhd-usrp.rules $out/lib/udev/rules.d/ - ''; - - meta = with lib; { - broken = (stdenv.isLinux && stdenv.isAarch64) || stdenv.isDarwin; - description = "USRP Hardware Driver (for Software Defined Radio)"; - longDescription = '' - The USRP Hardware Driver (UHD) software is the hardware driver for all - USRP (Universal Software Radio Peripheral) devices. - - USRP devices are designed and sold by Ettus Research, LLC and its parent - company, National Instruments. - ''; - homepage = "https://uhd.ettus.com/"; - license = licenses.gpl3Plus; - platforms = platforms.linux ++ platforms.darwin; - maintainers = with maintainers; [ bjornfor fpletz tomberek ]; - }; -} diff --git a/pkgs/applications/radio/uhd/default.nix b/pkgs/applications/radio/uhd/default.nix index 23c0a728586..c3f7b58fa1b 100644 --- a/pkgs/applications/radio/uhd/default.nix +++ b/pkgs/applications/radio/uhd/default.nix @@ -8,13 +8,19 @@ , boost , ncurses , enableCApi ? true -# requires numpy +# Although we handle the Python API's dependencies in pythonEnvArg, this +# feature is currently disabled as upstream attempts to run `python setup.py +# install` by itself, and it fails because the Python's environment's prefix is +# not a writable directly. Adding support for this feature would require using +# python's pypa/build nad pypa/install hooks directly, and currently it is hard +# to do that because it all happens after a long buildPhase of the C API. , enablePythonApi ? false , python3 , buildPackages , enableExamples ? false -, enableUtils ? false +, enableUtils ? true , libusb1 +# Disable dpdk for now due to compilation issues. , enableDpdk ? false , dpdk # Devices @@ -43,9 +49,11 @@ in stdenv.mkDerivation (finalAttrs: { pname = "uhd"; - # UHD seems to use three different version number styles: x.y.z, xxx_yyy_zzz - # and xxx.yyy.zzz. Hrmpf... style keeps changing - version = "4.4.0.0"; + # NOTE: Use the following command to update the package, and the uhdImageSrc attribute: + # + # nix-shell maintainers/scripts/update.nix --argstr package uhd --argstr commit true + # + version = "4.6.0.0"; outputs = [ "out" "dev" ]; @@ -53,14 +61,24 @@ stdenv.mkDerivation (finalAttrs: { owner = "EttusResearch"; repo = "uhd"; rev = "v${finalAttrs.version}"; - sha256 = "sha256-khVOHlvacZc4EMg4m55rxEqPvLY1xURpAfOW905/3jg="; + # The updateScript relies on the `src` using `hash`, and not `sha256. To + # update the correct hash for the `src` vs the `uhdImagesSrc` + hash = "sha256-9ZGt0ZrGbprCmpAuOue6pg2gliu4MvlRFHGxyMJeKAc="; }; # Firmware images are downloaded (pre-built) from the respective release on Github uhdImagesSrc = fetchurl { url = "https://github.com/EttusResearch/uhd/releases/download/v${finalAttrs.version}/uhd-images_${finalAttrs.version}.tar.xz"; - sha256 = "V8ldW8bvYWbrDAvpWpHcMeLf9YvF8PIruDAyNK/bru4="; + # Please don't convert this to a hash, in base64, see comment near src's + # hash. + sha256 = "17g503mhndaabrdl7qai3rdbafr8xx8awsyr7h2bdzwzprzmh4m3"; + }; + passthru = { + updateScript = [ + ./update.sh + # Pass it this file name as argument + (builtins.unsafeGetAttrPos "pname" finalAttrs.finalPackage).file + ]; }; - # TODO: Add passthru.updateScript that will update both of the above hashes... cmakeFlags = [ "-DENABLE_LIBUHD=ON" @@ -123,7 +141,7 @@ stdenv.mkDerivation (finalAttrs: { ]; postPhases = [ "installFirmware" "removeInstalledTests" ] - ++ optionals (enableUtils && stdenv.targetPlatform.isLinux) [ "moveUdevRules" ] + ++ optionals (enableUtils && stdenv.hostPlatform.isLinux) [ "moveUdevRules" ] ; # UHD expects images in `$CMAKE_INSTALL_PREFIX/share/uhd/images` @@ -144,6 +162,10 @@ stdenv.mkDerivation (finalAttrs: { mv $out/lib/uhd/utils/uhd-usrp.rules $out/lib/udev/rules.d/ ''; + disallowedReferences = optionals (!enablePythonApi && !enableUtils) [ + python3 + ]; + meta = with lib; { description = "USRP Hardware Driver (for Software Defined Radio)"; longDescription = '' diff --git a/pkgs/applications/radio/uhd/update.sh b/pkgs/applications/radio/uhd/update.sh new file mode 100755 index 00000000000..e52fb059041 --- /dev/null +++ b/pkgs/applications/radio/uhd/update.sh @@ -0,0 +1,27 @@ +#!/usr/bin/env nix-shell +#!nix-shell -i bash -p jq nix nix-prefetch-github + +set -euo pipefail +echoerr() { echo "$@" 1>&2; } + +fname="$1" +echoerr got fname $fname +shift +latest_release=$(curl --silent https://api.github.com/repos/EttusResearch/uhd/releases/latest) +version=$(jq -r '.tag_name' <<<"$latest_release" | cut -c2-) +# Update version, if needed +if grep -q 'version = "'$version $fname; then + echoerr Current version $version is the latest available + exit 0; +fi +echoerr got version $version +sed -i -E 's/(version = ").*(";)/\1'$version'\2/g' $fname +# Verify the sed command above did not fail +grep -q $version $fname +# Update srcHash +srcHash="$(nix-prefetch-github EttusResearch uhd --rev v${version} | jq --raw-output .hash)" +sed -i -E 's#(hash = ").*(";)#\1'$srcHash'\2#g' $fname +grep -q $srcHash $fname +imageHash="$(nix-prefetch-url https://github.com/EttusResearch/uhd/releases/download/v${version}/uhd-images_${version}.tar.xz)" +sed -i -E 's#(sha256 = ").*(";)#\1'$imageHash'\2#g' $fname +grep -q $imageHash $fname |