Merge branch 'mmajoral-fpga_signal_sources' into next

CMakeLists.txt

@@ -45,6 +45,10 @@ option(ENABLE_AD936X_SDR "Enable the use of AD936X front-ends using libiio, requ
 
 option(ENABLE_AD9361 "Enable the use of AD9361 direct to FPGA hardware, requires libiio" OFF)
 
+option(ENABLE_MAX2771 "Enable the use of MAX2771 direct to FPGA hardware, requires the spidev driver" OFF)
+
+option(ENABLE_DMA_PROXY "Enable the use of the DMA direct to FPGA hardware, requires the DMA Proxy driver" OFF)
+
 option(ENABLE_RAW_UDP "Enable the use of high-optimized custom UDP packet sample source, requires libpcap" OFF)
 
 option(ENABLE_FLEXIBAND "Enable the use of the signal source adater for the Teleorbit Flexiband GNU Radio driver" OFF)
@@ -3353,6 +3357,107 @@ endif()
 
 
 
+#####################################################################
+# Check signal sources related to FPGA only.
+#####################################################################
+if(ENABLE_MAX2771 AND NOT ENABLE_FPGA)
+    message(STATUS "The SPIdev driver is enabled, but the FPGA is not enabled. The FPGA is required when using the SPIdev driver.")
+    if(ENABLE_PACKAGING)
+        set(ENABLE_MAX2771 OFF)
+    else()
+        message(FATAL_ERROR "ENABLE_MAX2771 can only be set when ENABLE_FPGA is also set.")
+    endif()
+endif()
+if(ENABLE_DMA_PROXY AND NOT ENABLE_FPGA)
+    message(STATUS "The DMA Proxy driver is enabled, but the FPGA is not enabled. The FPGA is required when using the DMA Proxy driver.")
+    if(ENABLE_PACKAGING)
+        set(ENABLE_DMA_PROXY OFF)
+    else()
+        message(FATAL_ERROR "ENABLE_DMA_PROXY can only be set when ENABLE_FPGA is also set.")
+    endif()
+endif()
+
+
+
+#####################################################################
+# spidev driver - OPTIONAL
+# Linux kernel driver that provides user-space access to Serial
+# Peripheral Interface)
+#####################################################################
+if(ENABLE_MAX2771)
+    if(DEFINED ENV{SDKTARGETSYSROOT})
+        set(TARGET_ROOTFS_PATH $ENV{SDKTARGETSYSROOT})
+    else()
+        set(TARGET_ROOTFS_PATH "")
+    endif()
+    find_program(STRINGS_EXECUTABLE strings)
+    if(NOT STRINGS_EXECUTABLE)
+        message(STATUS "The 'strings' command could not be found. See https://www.gnu.org/software/binutils/")
+        message(STATUS " You can try to install it by typing:")
+        if(${CMAKE_SYSTEM_NAME} MATCHES "Linux|kFreeBSD|GNU")
+            if(${LINUX_DISTRIBUTION} MATCHES "Fedora" OR ${LINUX_DISTRIBUTION} MATCHES "Red Hat")
+                message(STATUS " sudo yum install binutils")
+            elseif(${LINUX_DISTRIBUTION} MATCHES "openSUSE")
+                message(STATUS " sudo zypper install binutils")
+            else()
+                message(STATUS " sudo apt-get install binutils")
+            endif()
+        endif()
+        message(FATAL_ERROR "Binutils are required to build GNSS-SDR for SoC FPGA devices using the MAX2771 option.")
+    endif()
+    set(DTB_FILE "${TARGET_ROOTFS_PATH}/boot/devicetree/system-top.dtb")
+    if(EXISTS "${DTB_FILE}")
+        message(STATUS "Found DTB file: ${DTB_FILE}")
+        # Run the strings command and grep for "spidev"
+        execute_process(
+            COMMAND ${STRINGS_EXECUTABLE} ${DTB_FILE}
+            COMMAND grep "spidev"
+            OUTPUT_VARIABLE GREP_OUTPUT
+            RESULT_VARIABLE GREP_RESULT
+            OUTPUT_STRIP_TRAILING_WHITESPACE
+        )
+        if(GREP_RESULT EQUAL 0)
+            message(STATUS "Found spidev-compatible peripheral in ${DTB_FILE}.")
+        else()
+            message(STATUS "SPIdev driver not found, its installation is required.")
+            if(ENABLE_PACKAGING)
+                set(ENABLE_MAX2771 OFF)
+            else()
+                message(FATAL_ERROR "SPIdev driver is required for building gnss-sdr with -DENABLE_MAX2271=ON.")
+            endif()
+        endif()
+    else()
+        message(FATAL_ERROR "The device tree (DTB) file ${DTB_FILE} cannot be found.")
+    endif()
+endif()
+
+
+
+#####################################################################
+# DMA Proxy driver - OPTIONAL
+# Simplified and efficient interface for user-space applications
+# to leverage DMA capabilities  for Xilinx FPGA and SoC systems
+#####################################################################
+if(ENABLE_DMA_PROXY)
+    if(DEFINED ENV{SDKTARGETSYSROOT})
+        set(TARGET_ROOTFS_PATH $ENV{SDKTARGETSYSROOT})
+    else()
+        set(TARGET_ROOTFS_PATH "")
+    endif()
+    set(DMA_PROXY_FILE "${TARGET_ROOTFS_PATH}/lib/modules/5.10.0-xilinx-v2021.2/extra/dma-proxy.ko")
+    if(EXISTS "${DMA_PROXY_FILE}")
+        message(STATUS "Found dma-proxy.ko file: ${DMA_PROXY_FILE}")
+    else()
+        if(ENABLE_PACKAGING)
+            set(ENABLE_DMA_PROXY OFF)
+        else()
+            message(FATAL_ERROR "DMA Proxy driver is required for building gnss-sdr with -DENABLE_DMA_PROXY=ON.")
+        endif()
+    endif()
+endif()
+
+
+
 ##############################################
 # TELEORBIT FLEXIBAND FRONTEND - OPTIONAL
 ##############################################
@@ -3557,6 +3662,8 @@ add_feature_info(ENABLE_LIMESDR ENABLE_LIMESDR "Enables Limesdr_Signal_Source. R
 add_feature_info(ENABLE_FMCOMMS2 ENABLE_FMCOMMS2 "Enables Fmcomms2_Signal_Source for FMCOMMS2/3/4 devices. Requires gr-iio and libad9361-dev.")
 add_feature_info(ENABLE_PLUTOSDR ENABLE_PLUTOSDR "Enables Plutosdr_Signal_Source for using ADALM-PLUTO boards. Requires gr-iio.")
 add_feature_info(ENABLE_AD9361 ENABLE_AD9361 "Enables Ad9361_Fpga_Signal_Source for devices with the AD9361 chipset. Requires libiio and libad9361-dev.")
+add_feature_info(ENABLE_MAX2771 ENABLE_MAX2771 "Enables FPGA_MAX2771_EVKIT_Signal_Source for devices with the MAX2771 chipset. Requires the spidev driver")
+add_feature_info(ENABLE_DMA_PROXY ENABLE_DMA_PROXY "Enables DMA Signal_Source. Requires the DMA Proxy driver")
 add_feature_info(ENABLE_AD936X_SDR ENABLE_AD936X_SDR "Enables Ad936x_Iio_Signal_Source to access AD936X front-ends using libiio. Requires libiio and libad9361-dev.")
 add_feature_info(ENABLE_RAW_UDP ENABLE_RAW_UDP "Enables Custom_UDP_Signal_Source for custom UDP packet sample source. Requires libpcap.")
 add_feature_info(ENABLE_FLEXIBAND ENABLE_FLEXIBAND "Enables Flexiband_Signal_Source for using Teleorbit's Flexiband RF front-end. Requires gr-teleorbit.")

docs/CHANGELOG.md

@@ -21,6 +21,25 @@ All notable changes to GNSS-SDR will be documented in this file.
   wideband device (HackRF/LimeSDR/USRP). Demonstration:
   https://www.youtube.com/watch?v=ZQs2sFchJ6w
   https://www.youtube.com/watch?v=HnZkKj9a-QM
+- Add the following signal sources for use when GNSS-SDR is operating on SoC
+  FPGA boards (`-DENABLE_FPGA=ON`):
+
+  - `ADRV9361_Z7035_Signal_Source_FPGA`: Analog Devices ADRV9361-Z7035 board.
+  - `FMCOMMS5_Signal_Source_FPGA`: FMCOMMS5 analog front-end.
+  - `MAX2771_EVKIT_Signal_Source_FPGA`: MAX2771 evaluation kit analog front-end.
+  - `DMA_Signal_Source_FPGA`: FPGA DMA working in post-processing mode.
+
+  When building GNSS-SDR for the SoC FPGA, the following options can be passed
+  to CMake with possible values of `ON` or `OFF`, and their default value is
+  `OFF`:
+
+  - `-DENABLE_AD9361`: Checks if the IIO driver is installed and builds the
+    `ADRV9361_Z7035_Signal_Source_FPGA` and the `FMCOMMS5_Signal_Source_FPGA`
+    sources.
+  - `-DENABLE_MAX2771`: Checks if the SPIdev driver is installed and builds the
+    `MAX2771_EVKIT_Signal_Source_FPGA` source.
+  - `-DENABLE_DMA_PROXY`: Checks if the DMA proxy driver is installed for
+    controlling the DMA in the FPGA and enables its usage.
 
 ### Improvements in Portability:
 

src/algorithms/acquisition/adapters/galileo_e1_pcps_ambiguous_acquisition_fpga.h

@@ -66,11 +66,11 @@ class GalileoE1PcpsAmbiguousAcquisitionFpga : public AcquisitionInterface
     }
 
     /*!
-     * \brief Returns "Galileo_E1_PCPS_Ambiguous_Acquisition_Fpga"
+     * \brief Returns "Galileo_E1_PCPS_Ambiguous_Acquisition_FPGA"
      */
     inline std::string implementation() override
     {
-        return "Galileo_E1_PCPS_Ambiguous_Acquisition_Fpga";
+        return "Galileo_E1_PCPS_Ambiguous_Acquisition_FPGA";
     }
 
     /*!

src/algorithms/acquisition/adapters/galileo_e5a_pcps_acquisition_fpga.h

@@ -66,11 +66,11 @@ class GalileoE5aPcpsAcquisitionFpga : public AcquisitionInterface
     }
 
     /*!
-     * \brief Returns "Galileo_E5a_Pcps_Acquisition_Fpga"
+     * \brief Returns "Galileo_E5a_Pcps_Acquisition_FPGA"
      */
     inline std::string implementation() override
     {
-        return "Galileo_E5a_Pcps_Acquisition_Fpga";
+        return "Galileo_E5a_Pcps_Acquisition_FPGA";
     }
 
     /*!

src/algorithms/acquisition/adapters/galileo_e5b_pcps_acquisition_fpga.h

@@ -65,7 +65,7 @@ class GalileoE5bPcpsAcquisitionFpga : public AcquisitionInterface
     }
 
     /*!
-     * \brief Returns "Galileo_E5b_Pcps_Acquisition_Fpga"
+     * \brief Returns "Galileo_E5b_Pcps_Acquisition_FPGA"
      */
     inline std::string implementation() override
     {

src/algorithms/acquisition/adapters/gps_l1_ca_pcps_acquisition_fpga.h

@@ -67,11 +67,11 @@ class GpsL1CaPcpsAcquisitionFpga : public AcquisitionInterface
     }
 
     /*!
-     * \brief Returns "GPS_L1_CA_PCPS_Acquisition_Fpga"
+     * \brief Returns "GPS_L1_CA_PCPS_Acquisition_FPGA"
      */
     inline std::string implementation() override
     {
-        return "GPS_L1_CA_PCPS_Acquisition_Fpga";
+        return "GPS_L1_CA_PCPS_Acquisition_FPGA";
     }
 
     /*!

src/algorithms/acquisition/adapters/gps_l2_m_pcps_acquisition_fpga.h

@@ -60,11 +60,11 @@ class GpsL2MPcpsAcquisitionFpga : public AcquisitionInterface
     }
 
     /*!
-     * \brief Returns "GPS_L2_M_PCPS_Acquisition_Fpga"
+     * \brief Returns "GPS_L2_M_PCPS_Acquisition_FPGA"
      */
     inline std::string implementation() override
     {
-        return "GPS_L2_M_PCPS_Acquisition_Fpga";
+        return "GPS_L2_M_PCPS_Acquisition_FPGA";
     }
 
     inline size_t item_size() override

src/algorithms/acquisition/adapters/gps_l5i_pcps_acquisition_fpga.h

@@ -69,11 +69,11 @@ class GpsL5iPcpsAcquisitionFpga : public AcquisitionInterface
     }
 
     /*!
-     * \brief Returns "GPS_L5i_PCPS_Acquisition_Fpga"
+     * \brief Returns "GPS_L5i_PCPS_Acquisition_FPGA"
      */
     inline std::string implementation() override
     {
-        return "GPS_L5i_PCPS_Acquisition_Fpga";
+        return "GPS_L5i_PCPS_Acquisition_FPGA";
     }
 
     /*!

src/algorithms/signal_source/adapters/CMakeLists.txt

@@ -37,8 +37,26 @@ if(ENABLE_AD9361)
     ###############################################
     # AD9361 DIRECT TO FPGA Hardware
     ###############################################
-    list(APPEND OPT_DRIVER_SOURCES ad9361_fpga_signal_source.cc)
-    list(APPEND OPT_DRIVER_HEADERS ad9361_fpga_signal_source.h)
+    list(APPEND OPT_DRIVER_SOURCES adrv9361_z7035_signal_source_fpga.cc)
+    list(APPEND OPT_DRIVER_HEADERS adrv9361_z7035_signal_source_fpga.h)
+    list(APPEND OPT_DRIVER_SOURCES fmcomms5_signal_source_fpga.cc)
+    list(APPEND OPT_DRIVER_HEADERS fmcomms5_signal_source_fpga.h)
+endif()
+
+if(ENABLE_MAX2771)
+    ###############################################
+    # MAX2771 EVKIT DIRECT TO FPGA Hardware
+    ###############################################
+    list(APPEND OPT_DRIVER_SOURCES max2771_evkit_signal_source_fpga.cc)
+    list(APPEND OPT_DRIVER_HEADERS max2771_evkit_signal_source_fpga.h)
+endif()
+
+if(ENABLE_DMA_PROXY)
+    ###############################################
+    # FPGA DMA source
+    ###############################################
+    list(APPEND OPT_DRIVER_SOURCES dma_signal_source_fpga.cc)
+    list(APPEND OPT_DRIVER_HEADERS dma_signal_source_fpga.h)
 endif()
 
 if(ENABLE_FLEXIBAND AND TELEORBIT_FOUND)