Merge branch 'dev' into gpiod

Author: ew1abz

CHANGES.md

@@ -2,15 +2,36 @@
 # Revision History #
 
 
-## Version 1.6  --  Under Development ##
+## Version 1.7  --  Under Development ('dev' branch) ##
 
 
+### New Features: ###
+
+- Improved Layer 2 Protocol [(IL2P)](https://en.wikipedia.org/wiki/FX.25_Forward_Error_Correction).  Use "-I 1" on command line to enable transmit for first channel.  Compatible with Nino TNC for 1200 and 9600 bps.
+
+- Limited support for CM109/CM119 GPIO PTT on Windows.
+
+- Dire Wolf now advertises itself using DNS Service Discovery.  This allows suitable APRS / Packet Radio applications to find a network KISS TNC without knowing the IP address or TCP port.    Thanks to Hessu for providing this.  Currently available only for Linux and Mac OSX.  [Read all about it here.](https://github.com/hessu/aprs-specs/blob/master/TCP-KISS-DNS-SD.md)
+
+- The transmit calibration tone (-x) command line option now accepts a radio channel number and/or a single letter mode:  a = alternate tones, m = mark tone, s = space tone, p = PTT only no sound.
+
+- The BEACON configuration now recognizes the SOURCE= option.  This replaces the AX.25 source address rather than using the MYCALL value for the channel.  This is useful for sending more than 5 analog telemetry channels.  Use two, or more, source addresses with up to 5 analog channels each.
+
+- For more flexibility, the FX.25 transmit property can now be set individually by channel, rather than having a global setting for all channels.  The -X on the command line applies only to channel 0.  For other channels you need to add a new line to the configuration file.
+
+    > After:   "CHANNEL 1"   (or other channel)
+    >
+    > Add:     "FX25TX 1" (or 16 or 32 or 64)
+
+
+## Version 1.6  --  October 2020 ##
+
 ### New Build Procedure: ###
 
 
-- Rather than trying to keep a bunch of different platform specific Makefiles in sync, "cmake" is now used for greater portability and easier maintenance.
+- Rather than trying to keep a bunch of different platform specific Makefiles in sync, "cmake" is now used for greater portability and easier maintenance.  This was contributed by Davide Gerhard.
 
-- README.md has a quick summary of the process.  More details in the User Guide.
+- README.md has a quick summary of the process.  More details in the ***User Guide***.
 
 
 ### New Features: ###
@@ -45,15 +66,21 @@
 
 - ***AX.25 + FEC = FX.25***
 
+- ***AIS Reception***
+
 - ***AX.25 Throughput: Why is 9600 bps Packet Radio only twice as fast as 1200?***
 
-- [***Ham Radio of Things - IoT over Ham Radio***](https://github.com/wb2osz/hrot)
+- [***Ham Radio of Things (HRoT) - IoT over Ham Radio***](https://github.com/wb2osz/hrot)
+
+- [***EAS SAME to APRS Message Converter***](https://github.com/wb2osz/eas2aprs)
 
-- Power Point slide show in separate repository.  [https://github.com/wb2osz/direwolf-presentation ](https://github.com/wb2osz/direwolf-presentation)
+- [***Dire Wolf PowerPoint Slide Show***](https://github.com/wb2osz/direwolf-presentation)
 
 ### Notes: ###
 
-Windows binary distribution now uses gcc (MinGW) version 7.4.0.
+The Windows binary distribution now uses gcc (MinGW) version 7.4.0.
+The Windows version is built for both 32 and 64 bit operating systems.
+Use the 64 bit version if possible; it runs considerably faster.
 
 
 

CMakeLists.txt

@@ -4,12 +4,13 @@ project(direwolf)
 
 # configure version
 set(direwolf_VERSION_MAJOR "1")
-set(direwolf_VERSION_MINOR "6")
+set(direwolf_VERSION_MINOR "7")
 set(direwolf_VERSION_PATCH "0")
-set(direwolf_VERSION_SUFFIX "")
+set(direwolf_VERSION_SUFFIX "Development")
 
 # options
-option(FORCE_SSE "Compile with SSE instruction only" OFF)
+# See Issue 297.
+option(FORCE_SSE "Compile with SSE instruction only" ON)
 option(FORCE_SSSE3 "Compile with SSSE3 instruction only" OFF)
 option(FORCE_SSE41 "Compile with SSE4.1 instruction only" OFF)
 option(OPTIONAL_TEST "Compile optional test (might be broken)" OFF)
@@ -71,6 +72,7 @@ set(CUSTOM_SRC_DIR "${CMAKE_SOURCE_DIR}/src")
 set(CUSTOM_EXTERNAL_DIR "${CMAKE_SOURCE_DIR}/external")
 set(CUSTOM_MISC_DIR "${CUSTOM_EXTERNAL_DIR}/misc")
 set(CUSTOM_REGEX_DIR "${CUSTOM_EXTERNAL_DIR}/regex")
+set(CUSTOM_HIDAPI_DIR "${CUSTOM_EXTERNAL_DIR}/hidapi")
 set(CUSTOM_GEOTRANZ_DIR "${CUSTOM_EXTERNAL_DIR}/geotranz")
 set(CUSTOM_DATA_DIR "${CMAKE_SOURCE_DIR}/data")
 set(CUSTOM_SCRIPTS_DIR "${CMAKE_SOURCE_DIR}/scripts")
@@ -86,13 +88,21 @@ set(CUSTOM_SHELL_SHABANG "#!/bin/sh -e")
 set(CPACK_GENERATOR "ZIP")
 set(CPACK_STRIP_FILES true)
 set(CPACK_PACKAGE_NAME "${CMAKE_PROJECT_NAME}")
-set(CPACK_PACKAGE_FILE_NAME "${CMAKE_PROJECT_NAME}-${direwolf_VERSION}_${CMAKE_SYSTEM_PROCESSOR}")
+# This has architecture of the build machine, not the target platform.
+# e.g. Comes out as x86_64 when building for i686 target platform.
+#set(CPACK_PACKAGE_FILE_NAME "${CMAKE_PROJECT_NAME}-${direwolf_VERSION}_${CMAKE_SYSTEM_PROCESSOR}")
+# We don't know the target yet so this is set after FindCPUflags.
 set(CPACK_PACKAGE_CONTACT "https://github.com/wb2osz/direwolf")
-set(CPACK_PACKAGE_DESCRIPTION_SUMMARY "Dire Wolf is a software soundcard AX.25 packet modem/TNC and APRS encoder/decoder")
+SET(CPACK_PACKAGE_DESCRIPTION_SUMMARY "Dire Wolf is an AX.25 soundcard TNC, digipeater, APRS IGate, GPS tracker, and APRStt gateway")
 set(CPACK_PACKAGE_DESCRIPTION_FILE "${CMAKE_SOURCE_DIR}/README.md")
 set(CPACK_RESOURCE_FILE_README "${CMAKE_SOURCE_DIR}/README.md")
 set(CPACK_RESOURCE_FILE_LICENSE "${CMAKE_SOURCE_DIR}/LICENSE")
 set(CPACK_SOURCE_IGNORE_FILES "${PROJECT_BINARY_DIR};/.git/;.gitignore;menu.yml;.travis.yml;.appveyor.yml;default.nix;.envrc;TODOs.org;/.scripts/")
+SET(CPACK_PACKAGE_VERSION "${direwolf_VERSION}")
+SET(CPACK_PACKAGE_VERSION_MAJOR "${direwolf_VERSION_MAJOR}")
+SET(CPACK_PACKAGE_VERSION_MINOR "${direwolf_VERSION_MINOR}")
+SET(CPACK_PACKAGE_VERSION_PATCH "${direwolf_VERSION_PATCH}")
+SET(CPACK_DEBIAN_PACKAGE_DEPENDS "libasound2,libgps23")
 
 # if we don't set build_type
 if(NOT DEFINED CMAKE_BUILD_TYPE OR "${CMAKE_BUILD_TYPE}" STREQUAL "")
@@ -114,10 +124,16 @@ include(FindCompiler)
 # find cpu flags (and set compiler)
 include(FindCPUflags)
 
+if(${ARCHITECTURE} MATCHES "x86")
+  set(CPACK_PACKAGE_FILE_NAME "${CMAKE_PROJECT_NAME}-${direwolf_VERSION}_i686")
+else()
+  set(CPACK_PACKAGE_FILE_NAME "${CMAKE_PROJECT_NAME}-${direwolf_VERSION}_${ARCHITECTURE}")
+endif()
+
 # auto include current directory
 set(CMAKE_INCLUDE_CURRENT_DIR ON)
 
-# set OS dependant variables
+# set OS dependent variables
 if(${CMAKE_SYSTEM_NAME} STREQUAL "Linux")
   set(LINUX TRUE)
 
@@ -129,6 +145,10 @@ elseif(${CMAKE_SYSTEM_NAME} STREQUAL "FreeBSD")
   configure_file("${CMAKE_SOURCE_DIR}/cmake/cpack/${CMAKE_PROJECT_NAME}.desktop.in"
     "${CMAKE_BINARY_DIR}/${CMAKE_PROJECT_NAME}.desktop" @ONLY)
 
+elseif(${CMAKE_SYSTEM_NAME} STREQUAL "OpenBSD")
+  set(OPENBSD TRUE)
+  set(HAVE_SNDIO TRUE)
+
 elseif(APPLE)
   if("${CMAKE_OSX_DEPLOYMENT_TARGET}" STREQUAL "")
     message(STATUS "Build for macOS target: local version")
@@ -142,6 +162,10 @@ elseif(APPLE)
   set(CMAKE_MACOSX_RPATH ON)
   message(STATUS "RPATH support: ${CMAKE_MACOSX_RPATH}")
 
+  # just blindly enable dns-sd
+  set(USE_MACOS_DNSSD ON)
+  set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -DUSE_MACOS_DNSSD")
+
 elseif (WIN32)
   if(NOT VS2015 AND NOT VS2017 AND NOT VS2019)
     message(FATAL_ERROR "You must use Microsoft Visual Studio 2015 | 2017 | 2019 as compiler")
@@ -181,10 +205,16 @@ if (C_CLANG OR C_GCC)
   # I also took out -Wextra because it spews out so much noise a serious problem was not noticed.
   # It might go back in someday when I have more patience to clean up all the warnings.
   #
+
+  # TODO:
+  # Try error checking -fsanitize=bounds-strict -fsanitize=leak
+  # Requires libubsan and liblsan, respectively.
+
   ###set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -Wall -Wextra -Wvla -ffast-math -ftree-vectorize -D_XOPEN_SOURCE=600 -D_DEFAULT_SOURCE ${EXTRA_FLAGS}")
   if(FREEBSD)
     set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -Wall -Wextra -Wvla -ffast-math -ftree-vectorize -D_DEFAULT_SOURCE ${EXTRA_FLAGS}")
   else()
+    #set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -Wall -Wvla -ffast-math -ftree-vectorize -D_GNU_SOURCE -fsanitize=bounds-strict ${EXTRA_FLAGS}")
     set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -Wall -Wvla -ffast-math -ftree-vectorize -D_GNU_SOURCE ${EXTRA_FLAGS}")
   endif()
   #
@@ -232,6 +262,20 @@ else()
 endif(WIN32 OR CYGWIN)
 
 # requirements
+
+include(CheckSymbolExists)
+# Some platforms provide their own strlcpy & strlcat. (BSD, MacOSX)
+# Others don't so we provide our own. (Most, but not all Linux)
+# Define the preprocessor macro so libgps does not supply its own version.
+check_symbol_exists(strlcpy string.h HAVE_STRLCPY)
+if(HAVE_STRLCPY)
+    add_compile_options(-DHAVE_STRLCPY)
+endif()
+check_symbol_exists(strlcat string.h HAVE_STRLCAT)
+if(HAVE_STRLCAT)
+    add_compile_options(-DHAVE_STRLCAT)
+endif()
+
 set(THREADS_PREFER_PTHREAD_FLAG ON)
 find_package(Threads REQUIRED)
 
@@ -270,6 +314,17 @@ if(LINUX)
     set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -DUSE_CM108")
   endif()
 
+  find_package(Avahi)
+  if(AVAHI_CLIENT_FOUND)
+    set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -DUSE_AVAHI_CLIENT")
+  endif()
+
+elseif (HAVE_SNDIO)
+  find_package(sndio REQUIRED)
+  if(SNDIO_FOUND)
+    set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -DUSE_SNDIO")
+  endif()
+
 elseif (NOT WIN32 AND NOT CYGWIN)
   find_package(Portaudio REQUIRED)
   if(PORTAUDIO_FOUND)
@@ -281,8 +336,12 @@ else()
   set(ALSA_LIBRARIES "")
   set(UDEV_INCLUDE_DIRS "")
   set(UDEV_LIBRARIES "")
+  # Version 1.7 supports CM108/CM119 GPIO PTT for Windows.
+  set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -DUSE_CM108")
   set(PORTAUDIO_INCLUDE_DIRS "")
   set(PORTAUDIO_LIBRARIES "")
+  set(SNDIO_INCLUDE_DIRS "")
+  set(SNDIO_LIBRARIES "")
 endif()
 
 # manage and fetch new data
@@ -291,6 +350,7 @@ add_subdirectory(data)
 # external libraries
 add_subdirectory(${CUSTOM_GEOTRANZ_DIR})
 add_subdirectory(${CUSTOM_REGEX_DIR})
+add_subdirectory(${CUSTOM_HIDAPI_DIR})
 add_subdirectory(${CUSTOM_MISC_DIR})
 
 # direwolf source code and utilities

Makefile

@@ -0,0 +1,36 @@
+
+all:
+	@echo "The build procedure has changed in version 1.6."
+	@echo "In general, it now looks like this:"
+	@echo " "
+	@echo "Download the source code:"
+	@echo " "
+	@echo "	cd ~"
+	@echo "	git clone https://www.github.com/wb2osz/direwolf"
+	@echo "	cd direwolf"
+	@echo " "
+	@echo "Optional - Do this to get the latest development version"
+	@echo "rather than the latest stable release."
+	@echo " "
+	@echo "	git checkout dev"
+	@echo " "
+	@echo "Build it.  There are two new steps not used for earlier releases."
+	@echo " "
+	@echo "	mkdir build && cd build"
+	@echo "	cmake .."
+	@echo "	make -j4"
+	@echo " "
+	@echo "Install:"
+	@echo " "
+	@echo "	sudo make install"
+	@echo "	make install-conf"
+	@echo " "
+	@echo "You will probably need to install additional applications and"
+	@echo "libraries depending on your operating system."
+	@echo "More details are in the README.md file."
+	@echo " "
+	@echo "Questions?"
+	@echo " "
+	@echo " - Extensive documentation can be found in the 'doc' directory."
+	@echo " - Join the discussion forum here:   https://groups.io/g/direwolf"
+	@echo " "