;;; GNU Guix --- Functional package management for GNU
;;; Copyright © 2017, 2018, 2019 Arun Isaac <arunisaac@systemreboot.net>
;;;
;;; This file is part of GNU Guix.
;;;
;;; GNU Guix is free software; you can redistribute it and/or modify it
;;; under the terms of the GNU General Public License as published by
;;; the Free Software Foundation; either version 3 of the License, or (at
;;; your option) any later version.
;;;
;;; GNU Guix is distributed in the hope that it will be useful, but
;;; WITHOUT ANY WARRANTY; without even the implied warranty of
;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;;; GNU General Public License for more details.
;;;
;;; You should have received a copy of the GNU General Public License
;;; along with GNU Guix.  If not, see <http://www.gnu.org/licenses/>.

(define-module (gnu packages ham-radio)
  #:use-module ((guix licenses) #:prefix license:)
  #:use-module (guix packages)
  #:use-module (guix download)
  #:use-module (guix git-download)
  #:use-module (gnu packages algebra)
  #:use-module (gnu packages check)
  #:use-module (gnu packages gtk)
  #:use-module (gnu packages libusb)
  #:use-module (gnu packages pkg-config)
  #:use-module (gnu packages python)
  #:use-module (gnu packages python-xyz)
  #:use-module (gnu packages qt)
  #:use-module (gnu packages xml)
  #:use-module (guix build-system cmake)
  #:use-module (guix build-system python))

(define-public rtl-sdr
  (package
    (name "rtl-sdr")
    (version "0.5.3")
    (source
     (origin
       (method url-fetch)
       (uri (string-append "https://cgit.osmocom.org/rtl-sdr/snapshot/rtl-sdr-"
                           version ".tar.xz"))
       (sha256
        (base32
         "08awca3v28sa4lxym4r81pzf0la0j86wbmpyhv3xd53an9gkpjy9"))))
    (build-system cmake-build-system)
    (inputs
     `(("libusb" ,libusb)))
    (native-inputs
     `(("pkg-config" ,pkg-config)))
    (arguments
     `(#:configure-flags '("-DDETACH_KERNEL_DRIVER=ON")
       #:tests? #f)) ; No tests
    (home-page "https://osmocom.org/projects/sdr/wiki/rtl-sdr")
    (synopsis "Software defined radio driver for Realtek RTL2832U")
    (description "DVB-T dongles based on the Realtek RTL2832U can be used as a
cheap software defined radio, since the chip allows transferring the raw I/Q
samples to the host.  @code{rtl-sdr} provides drivers for this purpose.")
    (license license:gpl2+)))

(define-public chirp
  (package
    (name "chirp")
    (version "20181205")
    (source
     (origin
       (method url-fetch)
       (uri (string-append "https://trac.chirp.danplanet.com/chirp_daily/daily-"
                           version "/chirp-daily-" version ".tar.gz"))
       (sha256
        (base32
         "1cp280b95j39xaxs50zn55jigg7pyfpm9n098hmsyxrplqn8z43c"))))
    (build-system python-build-system)
    (inputs
     `(("python2-libxml2" ,python2-libxml2)
       ("python2-pygtk" ,python2-pygtk)
       ("python2-pyserial" ,python2-pyserial)))
    (arguments
     `(#:python ,python-2))
    (home-page "https://chirp.danplanet.com")
    (synopsis "Cross-radio programming tool")
    (description "Chirp is a cross-radio programming tool.  It supports a
growing list of radios across several manufacturers and allows transferring of
memory contents between them.")
    (license (list license:gpl3+
                   license:lgpl3+)))) ; chirp/elib_intl.py

(define-public hackrf
  (package
    (name "hackrf")
    (version "2018.01.1")
    (source
     (origin
       (method url-fetch)
       (uri (string-append "https://github.com/mossmann/hackrf/releases/download/v"
                           version "/hackrf-" version ".tar.xz"))
       (sha256
        (base32
         "054x08y02gfwax2yb95ajg7gdm8ab1sckcmkcy1s2bqxkb0av6x8"))))
    (build-system cmake-build-system)
    (inputs
     `(("fftwf" ,fftwf)
       ("libusb" ,libusb)))
    (native-inputs
     `(("pkg-config" ,pkg-config)))
    (arguments
     `(#:tests? #f ; no tests
       #:phases
       (modify-phases %standard-phases
         (add-before 'configure 'chdir-to-source
           (lambda _
             (chdir "host")
             #t)))))
    (home-page "https://github.com/mossmann/hackrf")
    (synopsis "Driver for HackRF, a general purpose software defined radio")
    (description "@code{hackrf} provides drivers for HackRF, a general purpose
software defined radio (SDR).")
    (license license:gpl2+)))

(define-public urh
  (package
    (name "urh")
    (version "2.5.7")
    (source
     (origin
       (method git-fetch)
       (uri (git-reference
             (url "https://github.com/jopohl/urh")
             (commit (string-append "v" version))))
       (file-name (git-file-name name version))
       (sha256
        (base32
         "110fwlj2fw8jgrsgqfkha7lx8f06w0ymh51mgpckx8a0wycznhcy"))))
    (build-system python-build-system)
    (inputs
     `(("hackrf" ,hackrf)
       ("python-numpy" ,python-numpy)
       ("python-psutil" ,python-psutil)
       ("python-pyqt" ,python-pyqt)
       ("python-pyzmq" ,python-pyzmq)
       ("rtl-sdr" ,rtl-sdr)))
    (native-inputs
     `(("python-cython" ,python-cython)
       ("python-pytest" ,python-pytest)))
    (arguments
     `(#:phases
       (modify-phases %standard-phases
         (add-after 'unpack 'configure-compiler
           (lambda _
             ;; Use gcc as compiler
             (substitute* "src/urh/dev/native/ExtensionHelper.py"
               (("compiler = ccompiler\\.new_compiler\\(\\)\n" all)
                (string-append
                 all "    compiler.set_executables(compiler='gcc',"
                 " compiler_so='gcc', linker_exe='gcc', linker_so='gcc -shared')\n")))
             #t))
         (replace 'build
           (lambda _
             (invoke "python" "setup.py" "build" "build_ext")
             (invoke "python" "src/urh/cythonext/build.py")))
         (replace 'check
           (lambda _
             ;; Run X server tests offscreen in headless mode
             (setenv "QT_QPA_PLATFORM" "offscreen")
             (setenv "HOME" "/tmp")
             ;; Fix permissions
             (with-directory-excursion "tests/data"
               (for-each (lambda (file)
                           (chmod file #o755))
                         (list "decode.py" "encode.py")))
             ;; Run tests
             (invoke "pytest"))))))
    (home-page "https://github.com/jopohl/urh")
    (synopsis "Investigate unknown wireless protocols")
    (description "The Universal Radio Hacker (URH) is a software for
investigating unknown wireless protocols.  Features include hardware
interfaces for common software defined radios, easy demodulation of signals,
assigning participants to keep an overview of your data, customizable
decodings to crack even sophisticated encodings like CC1101 data whitening,
assigning labels to reveal the logic of the protocol, a fuzzing component to
find security leaks, modulation support to inject data back into the system
and a simulation environment to perform stateful attacks.")
    (license license:gpl3+)))